Skip to main content

xSuite Interface Windows Prism 5.x – Online-Hilfe

Ausgabesystem "XSuiteArchiveHelix2"

Das Ausgabesystem "XSuiteArchiveHelix2" dient der Übertragung von Dokumenten an den Archive Service der xSuite Helix Cloud und ist der Nachfolger des Ausgabesystems "XSuiteArchiveHelix". Das Ausgabesystem "XSuiteArchiveHelix2" spricht die Archive-API in der Version 2 an, die keine asynchrone Statusabfrage erfordert. Aus diesem Grund entfällt die Notwendigkeit, dieses Ausgabesystem mit einem nachfolgenden Ausgabesystem "XSuiteConveyorResult" zu kombinieren.

Eigenschaft

Beschreibung

OutputSystem[].Url*

HTTPS-Basisadresse des xSuite-Archive-Webservices

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

OutputSystem[].Keycloak*

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

Syntax: siehe Keycloak-Authentifizierung

OutputSystem[].ProxyServer

Proxy-Server, der optional für die Kommunikation mit den Webservices genutzt wird

Syntax: siehe Proxy-Server-Verbindung

OutputSystem[].RequestTimeout

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

Standardwert: 100

OutputSystem[].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

OutputSystem[].ConveyorServiceAppName

Name der Zielapplikation, für die der Conveyor Service die übertragenen Daten zur Verarbeitung bereitstellt

Standardwert: ArchiveBackendV2

OutputSystem[].ConveyorServiceRetryDelay

Wenn der Conveyor Service die Übergabe eines neuen Dokumentes wegen einer Systemüberlastung von vornherein abweist, wird dieses Dokument für einen späteren Übergabeversuch automatisch in den Status "Deferred" (zurückgestellt) versetzt.

Die Wartezeit ist in der Syntax anzugeben, die unter Verschiedenes beschrieben ist.

Standardwert: 30m

OutputSystem[].Archive*(%)

Name des Zielarchivs

OutputSystem[].SchemaKey(%)

Name des JSON-Schemas, dem die Indexdaten entsprechen

Wenn kein Schema definiert ist, werden keine Indexdaten gesetzt.

OutputSystem[].IsIndexed(%)

Wahrheitswert, ob die Archivdokumente und Dateianlagen indexiert werden

Standardwert: FALSE

OutputSystem[].IsVersioned(%)

Wahrheitswert, ob die Archivdokumente versioniert werden

Standardwert: FALSE

OutputSystem[].Comment[](%)

optionaler Inhalt von Kommentartexten

OutputSystem[].Tag[](%)

optionale Tags, die am Dokument gesetzt werden

RetentionDateMacro

optionaler Feldmakroausdruck zur Erstellung eines Aufbewahrungsdatums

LitigationHoldRefMacro

LitigationHoldDateMacro

Feldmakroausdruck zum Setzen eines Referenzschlüssels und Feldmakroausdruck zum Setzen eines Gültigkeitsdatums für einen "Legal Hold".

Um diese Option zu nutzen, müssen beide Werte angegeben werden.

OutputSystem[].DoUpdate(%)

Wahrheitswert, ob vorhandene Dokumente aktualisiert werden

Standardwert: FALSE (Dokumente werden immer neu angelegt)

OutputSystem[].DoUpdateFiles(%)

Wahrheitswert, ob bei der Aktualisierung versucht wird, vorhandene Dateianlagen anhand des Namens zu identifizieren und zu ersetzen

Standardwert: FALSE (neue Anlagen werden immer an ein vorhandenes Dokument angehängt)

OutputSystem[].DoUpdateAllHits(%)

Wahrheitswert, ob bei einer Suche nach vorhandenen Dokumenten alle gefundenen Dokumente aktualisiert werden

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

OutputSystem[].OnUpdateKeyNotFound(%)

Modus, wie bei einer Suche nach vorhandenen Dokumenten verfahren wird, wenn kein Dokument gefunden wird:

  • Error: Fehler werfen (Standardwert)

  • CreateNew: neues Dokument erstellen

OutputSystem[].ReplaceIndex(%)

Wahrheitswert, ob das vorhandene JSON-Dokument mit den Indexdaten vollständig durch die Indexdaten des Update-Dokuments ersetzt wird

Wenn diese Eigenschaft deaktiviert ist, wird das vorhandene JSON-Dokument geladen und um die neuen Indexdaten erweitert. Kopfdatenfelder, die bereits existieren, werden mit den neuen Werten überschrieben. Tabellenzeilen werden an die vorhandenen Tabellen angehängt.

Standardwert: FALSE

OutputSystem[].UpdateDocKey(%)

Schlüssel eines Archivdokuments, das aktualisiert werden soll

Wenn der Schlüssel bekannt ist, kann das Dokument direkt adressiert werden. Eine zusätzliche Suche ist nicht notwendig. Wenn diese Eigenschaft gesetzt ist, hat diese Eigenschaft Vorrang vor den Eigenschaften OutputSystem[].UpdateQueryMeta und OutputSystem[].UpdateQueryIndex.

OutputSystem[].UpdateQueryMeta(%)

Suchausdruck zur Identifikation zu aktualisierender Dokumente anhand der Metadaten

Der Ausdruck muss in der Syntax der Archive-API formuliert werden und darf nur den reinen Filterausdruck hinter dem WHERE-Schlüsselwort umfassen. Der Rest des Filterausdrucks wird implizit ergänzt.

Beispiel: SELECT * FROM '<Archive>' WHERE 'TrackingKey' = '%TrackingKey%'

Feldvariablen können hier nur textuell als %Variablenname% dynamisch eingefügt werden und nicht als typisierte Variablen. Dabei ist die korrekte Syntax zu beachten, insbesondere für Datumswerte (siehe Dokumentation der Archive-API).

OutputSystem[].UpdateQueryIndex(%)

Hinweis

Diese Eigenschaft ist noch nicht implementiert.

OutputSystem[].DocKeyField(%)

optionaler Name eines Feldes aus dem Feldkatalog, in das der Schlüssel des erzeugten Archivdokumentes zurückgeschrieben wird

Wenn mehrere Schlüssel vorhanden sind (nur bei Aktualisierung mit mehreren Treffern), wird ein Array mit den Referenzen in das Feld geschrieben.

Die Indexdaten werden als JSON-Dokument gemäß JSON-Schema (Eigenschaft .SchemaKey) übergeben. Die Syntax der Zielfelder in der Eigenschaft .OutputName ist unter Indexdatenübergabe als JSON-Dokumente beschrieben.