OutputSystem[].Url*

Base address (HTTPS) of the xSuite Archive web service

When specifying the base address, include the port number but not the sub-paths.

OutputSystem[].Keycloak*

Properties for authentication towards the xSuite Helix Cloud via a Keycloak service

Syntax: see Keycloak Authentication.

OutputSystem[].ProxyServer

Proxy server used for communication with the web services (optional)

Syntax: see Proxy Server Connection

OutputSystem[].RequestTimeout

Timeout value in seconds, determining how long to wait for a response from the web service before throwing an error

Default value: 100

OutputSystem[].TraceRequests

Boolean value determining whether, when trace logging is active, the contents of the HTTP requests and HTTP responses to/from the archive server are logged (property Logging.Level: "Trace")

Default value: FALSE

OutputSystem[].ConveyorServiceAppName

Name of the target application for which the conveyor service provides the transferred data for processing

Default value: ArchiveBackendV2

OutputSystem[].ConveyorServiceRetryDelay

If the conveyor service rejects the transfer of a new document from the outset due to a system overload, this document will automatically transition to the "Deferred" status for a subsequent transfer attempt.

Specify the waiting time in the syntax described in Miscellaneous.

Default value: 30m

OutputSystem[].Archive*(%)

Name of the target archive

OutputSystem[].SchemaKey(%)

Name of the JSON schema that the index data corresponds to

If no schema is defined, no index data is set.

OutputSystem[].IsIndexed(%)

Boolean value determining whether Wahrheitswert, whether the archive documents and file attachments are indexed

Default value: TRUE

OutputSystem[].IsVersioned(%)

Boolean value determining whether the archive documents are versioned

Default value: TRUE

OutputSystem[].Comment[](%)

Content of comment texts (optional)

OutputSystem[].Tag[](%)

Tags that are applied to the document (optional)

RetentionDateMacro

Field macro expression for creating a retention date (optional)

LitigationHoldRefMacro

LitigationHoldDateMacro

Field macro expression for setting a reference key and field macro expression for setting a validity date for a legal hold.

To use this option, both values must be specified.

OutputSystem[].DoUpdate(%)

Boolean value determining whether existing documents are updated

Default value: FALSE (Documents are always created anew)

OutputSystem[].DoUpdateFiles(%)

Boolean value determining whether the system attempts to identify and replace existing file attachments based on their names during the update.

Default value: FALSE (new attachments are always appended to an existing document)

OutputSystem[].DoUpdateAllHits(%)

Boolean value determining whether all documents found during a search for existing documents are updated

Default value: FALSE (only the first document found is updated)

OutputSystem[].OnUpdateKeyNotFound(%)

Mode for proceeding with a search for existing documents when no document is found:

OutputSystem[].ReplaceIndex(%)

Boolean value determining whether the existing JSON document with the index data will be completely replaced by the index data of the update document.

If this property is disabled, the existing JSON document is loaded and extended with the new index data. Header fields that already exist are overwritten with the new values. Table rows are appended to the existing tables.

Default value: FALSE

OutputSystem[].UpdateDocKey(%)

Key of an archive document that is to be updated

If the key is known, the document can be addressed directly. No additional search is necessary. If this property is set, it takes precedence over the OutputSystem[].UpdateQueryMeta and OutputSystem[].UpdateQueryIndex properties.

OutputSystem[].UpdateQueryMeta(%)

Search expression for identifying documents to be updated based on metadata

The expression must be formulated in the syntax of the Archive API and may only contain the pure filter expression after the WHERE keyword. The rest of the filter expression is added implicitly.

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

Field variables can only be inserted dynamically as %VariableName% text and not as typed variables. Ensure that the syntax is correct, especially for date values (see Archive API documentation).

OutputSystem[].UpdateQueryIndex(%)

OutputSystem[].DocKeyField(%)

Name of a field from the field catalog to which the key of the generated archive document is written to (optional)

If multiple keys exist (only when updating with multiple matches), an array containing the references is written to the field.