Skip to main content

xSuite Interface Windows Prism 5.x – Online-Hilfe

xSuite-Archive-Ausgabesysteme

Die Konfigurationseigenschaften für die Ausgabeschnittstellen zu xSuite Archive Prism und zu xSuite Archive Helix stimmen zum Großteil überein.

Die wesentlichen Unterschiede zwischen xSuite Archive Prism und xSuite Archive Helix liegen in den Authentifizierungsverfahren. xSuite Archive Helix arbeitet außerdem asynchron über einen vorgeschalteten Conveyor Service, wodurch sich eine funktionale Einschränkung ergibt.

Achtung

Die folgenden Ausführungen gelten nur für die Ausgabesysteme "XSuiteArchivePrim", "XSuiteArchiveHelix" und "XSuiteArchiveHelixLegacy". Die Konfigurationseigenschaften für die neueste Archive-API-Version 2 der xSuite Helix Cloud sind unter Ausgabesystem "XSuiteArchiveHelix2" beschrieben.

Eigenschaft

Beschreibung

.Url*

HTTPS-Basisadresse des xSuite-Archive-Webservices

Die Basisadresse muss inklusive Portnummer, aber ohne Unterpfade angegeben werden.

.ProxyServer

Proxy-Server, der optional für die Verbindung zu den Webservices genutzt wird

Syntax: siehe Proxy-Server-Verbindung

.RequestTimeout

Timeout-Wert in Sekunden, wie lange auf eine Antwort der Webservices gewartet wird, bevor ein Fehler geworfen wird

Standardwert: 100

.Keycloak(*)

Eigenschaften für die Authentifizierung gegenüber der xSuite Helix Cloud über einen Keycloak-Dienst

Syntax: siehe Keycloak-Authentifizierung

Diese Eigenschaft ist nur relevant für die Archivschnittstellen "XSuiteArchiveHelix" und "XSuiteArchiveHelixLegacy".

.TraceRequests

Wahrheitswert, ob bei aktivem Trace-Logging (Eigenschaft Logging.Level: "Trace") die Inhalte der HTTP-Anfragen und HTTP‑Antworten zum/vom Archivserver protokolliert werden

Standardwert: FALSE

.Archive*(%)

Name des Zielarchivs

.ArchiveIndex(%)

optional abweichender Name des Archivindexes, wenn dieser nicht identisch mit dem Namen des Zielarchivs ist

.DocumentType(%)

Teilparameter zur optionalen Definition eines zu verwendenden Dokumenttyps

Wenn nicht implizit die neueste Version genutzt werden soll, kann die konkrete Versionsnummer angegeben werden.

  1. Name*: Name des Dokumenttyps

  2. Version: optionale Version des Dokumenttyps

.Note[](%)

optionaler Inhalt einer textuellen Notiz

Mehrere Einzelwerte werden durch einen Zeilenumbruch getrennt zu einem Gesamttext zusammengefügt.

.MetaData[]

Teilparameter mit Schlüssel-/Wert-Paaren zur optionalen Definition von Metadaten

Die Metadaten werden auf Dokumentebene gesetzt.

  1. Name*: Name des Metadatums

  2. Value*: Feldmakroausdruck zur Erstellung des Wertes

Hinweis

Informationen zu den verfügbaren Namen für Metadaten finden Sie in der Dokumentation von xSuite Archive Helix und xSuite Archive Prism.

Das Makro zur Erstellung des Wertes muss einen Datentyp zurückliefern, das zu dem jeweiligen Metadatum passt.

.BlobProperty[]

.BlobMetaData[]

Teilparameter zur optionalen Definition von Eigenschaften und Metadaten

Die Eigenschaften und Metadaten werden den einzelnen Dateianlagen der Dokumente zugeordnet.

  1. FilePattern: optionales Dateinamensmuster für die Gültigkeit eines Eintrags

  2. Name*: Name der Eigenschaft oder des Metadatums

  3. Value*: Feldmakroausdruck zur Erstellung des Wertes

Hinweis

Informationen zu den verfügbaren Namen für Eigenschaften und Metadaten finden Sie in der Dokumentation von xSuite Archive Helix und xSuite Archive Prism.

Das Makro zur Erstellung des Wertes muss einen Datentyp zurückliefern, das zu dem jeweiligen Element passt.

Für dieselben Eigenschaften oder Metadaten können mehrere alternative Einträge definiert werden, die sich im Dateinamensmuster des Parameters FilePattern und Value unterscheiden. Abhängig von der Eigenschaft oder dem Metadatum wird dann der Name einer Dateianlage mit den Mustern in der Reihenfolge ihrer Definition verglichen. Der erste gefundene Eintrag, dessen Muster passt, wird genutzt.

.StorageState(%)

Status, in dem die Dokumente im Archiv abgelegt werden:

  • Stored: "lebendes" Dokument

  • Archived: final archiviertes Dokument mit Versionierung (Standardwert)

.IndexMode(%)

Modus, ob und wie Dokumente bei der Übergabe indexiert werden:

  • None: keine Indexierung

  • Index: direkte Indexierung (Standardwert)

  • IndexAsync: asynchrone Indexierung (nur relevant für xSuite Archive Prism)

.DoUpdate(%)

Wahrheitswert, ob eine Aktualisierung bestehender Dokumente durchgeführt wird

Standardwert: false (Dokumente werden immer neu angelegt)

.DoUpdateBlobs(%)

Wahrheitswert, ob beim Update auch versucht wird, bestehende Dateianlagen anhand des Namens zu identifizieren und zu ersetzen

Standardwert: false (neue Anlagen werden immer an ein bestehendes Dokument angehängt)

.OutputEmptyFields(%)

Wahrheitswert, ob auch Felder mit leerem Inhalt an das Archiv übergeben werden

Standardwert: TRUE

.UpdateDocRef(%)

Referenz auf ein bestehendes Archivdokument, wenn bei aktivem .DoUpdate die konkrete Dokument-ID bekannt ist

.UpdateKeyField(%)

.UpdateKeyValueMacro

Alternative zu .UpdateDocRef, wenn die zu aktualisierenden Dokumente über eine Archivsuche ermittelt werden

In .UpdateKeyField ist der Name des Suchfeldes anzugeben. In .UpdateKeyValueMacro ist ein Feldmakroausdruck anzugeben, der den Wert zurückliefert, nach dem in dem Feld gesucht wird. Der Datentyp des Wertes muss dem Datentyp des Suchfelds entsprechen. Für den Wert wird eine einfache Gleichheitssuche durchgeführt.

Für das Suchfeld kann auch der Name eines Metadatums angegeben werden. Das Programm ermittelt automatisch, ob eine Indexsuche oder eine Metadatumssuche durchgeführt werden muss.

.DoUpdateAllHits(%)

Wahrheitswert, ob bei einer Suche nach bestehenden Dokumenten via .UpdateKeyField alle gefundenen Dokumente aktualisiert werden, wenn das Ergebnis mehrere Treffer liefert

Standardwert: false (nur das erste gefundene Dokument wird aktualisiert)

Diese Funktionalität ist nur für die Archivschnittstellen "XSuiteArchivePrism" und "XSuiteArchiveHelixLegacy" verfügbar.

.OnUpdateKeyNotFound(%)

Modus, wie bei einer Suche nach einem bestehenden Dokument über .UpdateKeyField verfahren wird, wenn das Dokument nicht gefunden wird:

  • Error: Fehler werfen (Standardwert)

  • CreateNew: neues Dokument erstellen

Beim Update über eine konkrete .UpdateDocRef wird grundsätzlich ein Fehler geworfen, wenn das Dokument nicht existiert.

.DeleteStoredVersion(%)

Wahrheitswert, ob bei einer Aktualisierung das ursprüngliche Dokument explizit gelöscht wird

Standardwert: FALSE

Diese Eigenschaft ist nur bei einem Statusübergang von "Stored" auf "Archived" relevant, weil die Löschung dann nicht automatisch durch das Archivsystem erfolgt.

Diese Funktionalität ist nur für die Archivschnittstellen "XSuiteArchivePrism" und "XSuiteArchiveHelixLegacy" verfügbar.

.DocRefField(%)

optionaler Name eines Feldes aus dem Feldkatalog, in das die Referenz auf das generierte Archivdokument zurückgeschrieben wird

Im Fall von mehreren Referenzen – nur bei Aktualisierung mit mehreren Treffern – handelt es sich um ein Array dieser Referenzen.

Diese Funktionalität ist nur für die Archivschnittstellen "XSuiteArchivePrism" und "XSuiteArchiveHelixLegacy" verfügbar.

Als Zielfeldnamen OutputSystem[].Field[].OutputName der xSuite-Archive-Ausgabesysteme sind die Feldnamen des jeweiligen .DocumentType nutzbar. Wenn dies keine vordefinierten Felder sind, können auch frei wählbare Namen genutzt werden.

Bei Tabellenfeldern wird der Zielfeldname zusammengesetzt aus {Tabellenfeldname}.{Spaltenfeldname}. Bei Tabellenfelder muss mit einem vordefinierten Dokumenttyp gearbeitet werden, weil aus dem Dokumenttyp der Name der zugeordneten Tabellendefinition gelesen wird.

Für Kopfdatenfelder wird eine mehrfache Ausgabe an das gleiche Zielfeld unterstützt, wenn das Feld auf Archivseite mit einem entsprechenden Wert MaxCount deklariert ist. Für die mehrfache Ausgabe können entweder unterschiedliche Quellfelder aus dem Feldkatalog den gleichen .OutputName ansprechen oder ein Array kann mehrere Werte an ein Zielfeld übergeben. Bei dem Ausgabesystem "XSuiteArchivePrism" findet in ersterem Fall tatsächlich eine mehrfache Übergabe gleichnamiger Felder statt. Das Ausgabesystem "XSuiteArchiveHelix" unterstützt diese Übergabe nicht. Bei diesem Ausgabesystem wird stattdessen implizit ein Array der multiplen Werte gebildet.

Bei Tabellen wird grundsätzlich nur die Übergabe einfacher Werte unterstützt. Wenn ein einzelnes Tabellenfeld ein Array enthält, wird daher nur das erste Element des Arrays berücksichtigt. xSuite Interface überprüft nicht, ob die übergebene Anzahl von Werten mit den Eigenschaften MinCount und MaxCount übereinstimmt, die im Dokumenttyp für das Feld definiert sind. Eine solche Prüfung wird beim Speichern eines Dokuments vom Archiv selbst durchgeführt. Wenn ein Fehler vorliegt, wird eine entsprechende Meldung angezeigt.

Prinzipiell erfolgt eine typisierte Übergabe als der Datentyp, den das Quellfeld zum Zeitpunkt der Übergabe hat. Wenn ein .OutputFormat definiert ist, wird ein entsprechend formatierter String-Wert übergeben. Bei einer Diskrepanz zwischen den Datentypen des Quellfeldes und eines vordefinierten Zielfeldes wird implizit eine Typkonvertierung vorgenommen.

In diesem Abschnitt: