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: |
OutputSystem[].TraceRequests | Wahrheitswert, ob bei aktivem Trace-Logging (Eigenschaft Standardwert: |
OutputSystem[].ConveyorServiceAppName | Name der Zielapplikation, für die der Conveyor Service die übertragenen Daten zur Verarbeitung bereitstellt Standardwert: |
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: |
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: |
OutputSystem[].IsVersioned(%) | Wahrheitswert, ob die Archivdokumente versioniert werden Standardwert: |
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: |
OutputSystem[].DoUpdateFiles(%) | Wahrheitswert, ob bei der Aktualisierung versucht wird, vorhandene Dateianlagen anhand des Namens zu identifizieren und zu ersetzen Standardwert: |
OutputSystem[].DoUpdateAllHits(%) | Wahrheitswert, ob bei einer Suche nach vorhandenen Dokumenten alle gefundenen Dokumente aktualisiert werden Standardwert: |
OutputSystem[].OnUpdateKeyNotFound(%) | Modus, wie bei einer Suche nach vorhandenen Dokumenten verfahren wird, wenn kein Dokument gefunden wird:
|
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: |
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(%) | 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: Feldvariablen können hier nur textuell als |
OutputSystem[].UpdateQueryIndex(%) | HinweisDiese 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.