Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

xSuite Archive Output Systems

The properties required for configuration of the output interfaces to xSuite Archive Prism and to xSuite Archive Helix are for the most part the same.

However, a few properties do differ, in particular those relating to 1) the authentication procedures used by the two programs and 2) the upstream conveyor service that xSuite Archive Helix uses.

Caution

The following information applies only to the output systems “XSuiteArchivePrim,” "XSuiteArchiveHelix," and "XSuiteArchiveHelixLegacy." The configuration properties for the latest Archive API version 2 of xSuite Helix Cloud are described under the output system "XSuiteArchiveHelix2".

Property

Description

.Url*

Base address (HTTPS) of the xSuite Archive web service

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

.ProxyServer

Proxy server for connecting to the web services (optional)

Syntax: see Proxy Server Connection

.RequestTimeout

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

Default value: 100

.Keycloak(*)

Authentication properties for access to xSuite Helix Cloud via a Keycloak service

Syntax: see Keycloak Authentication.

This property only applies to the archive interfaces "XSuiteArchiveHelix" and "XSuiteArchiveHelixLegacy."

.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: TRUE

.Archive*(%)

Name of the target archive

.ArchiveIndex(%)

Alternative name of the archive index to be used if the name of the index is not identical to the name of the target archive

.DocumentType(%)

Subparameters for defining a document type to be used (optional).

If the latest version is not implicitly to be used, specify the version number used.

  1. Name*: name of document type

  2. Version: version of the document type (optional)

.Note[](%)

Content of a textual note (optional)

Multiple individual values are combined to form text separated by a line break.

.MetaData[]

Subparameters with key/value pairs for definition of metadata (optional)

The metadata is set at the document level.

  1. Name*: metadatum name

  2. Value*: field macro expression to create the value

Notice

For information about the names available for metadata, see the xSuite Archive Helix and xSuite Archive Prism documentation.

The macro used to create the value must return a data type that matches the metadatum in question.

.BlobProperty[]

.BlobMetaData[]

Subparameters for defining properties and metadata (optional)

The properties and metadata are assigned to the individual file attachments of the documents.

  1. FilePattern: file name pattern defining the file attachments (optional)

  2. Name*: name of the property or metadata

  3. Value*: field macro expression to create the value

Notice

For information about the names available for properties and metadata, see the xSuite Archive Helix and xSuite Archive Prism documentation.

The macro used to create the value must return a data type that matches the element in question.

For a single property or piece of metadata, alternative entries can be defined. Use differing file name patterns for these entries, specified with the parameters FilePattern and Value. Depending on the property or metadatum, the name of a file attachment will be compared with the patterns in the defined sequence. The sequence in which the patterns are defined in configuration determines the sequence in which the file attachment is compared with the patterns. The first entry found with a matching pattern is the one that will be used.

.StorageState(%)

Status in which the documents are stored in the archive:

  • Stored: "living" document

  • Archived: final archived document (default value)

.IndexMode(%)

Mode determining whether the documents are indexed directly when transferred:

  • None: no indexing

  • Index: direct indexing (default value)

  • IndexAsync: asynchronous indexing (only relevant for xSuite Archive Prism)

.DoUpdate(%)

Boolean value determining whether an update of existing documents is performed

Default value: false (documents are always created anew)

.DoUpdateBlobs(%)

Boolean value determining whether the update also attempts to identify and replace existing file attachments by name

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

.OutputEmptyFields(%)

Boolean value determining whether empty fields are transferred to the archive

Default value: TRUE

.UpdateDocRef(%)

Reference to an existing archive document, if the concrete document ID is known when .DoUpdate is active

.UpdateKeyField(%)

.UpdateKeyValueMacro

Alternative to .UpdateDocRef, used when the documents to be updated are determined via an archive search

.UpdateKeyField is for specification of the name of the search field. .UpdateKeyValueMacro is for specification of a field macro expression that returns the value that is searched for in the field. The data type of the value must correspond to the data type of the search field. A simple search for an equality is performed for the value.

The name of a metadatum can also be specified for the search field. The program automatically determines whether an index search or a metadata search must be performed.

.DoUpdateAllHits(%)

Boolean value determining whether, in the case of multiple hits, all found documents are updated when searching for existing documents via .UpdateKeyField

Default value: false (only the first document found will be updated)

This functionality is only available for the archive interfaces "XSuiteArchivePrism" and "XSuiteArchiveHelixLegacy."

.OnUpdateKeyNotFound(%)

Mode that determines what happens if the search for an existing document via .UpdateKeyField turns up empty:

  • Error: throw error (default value)

  • CreateNew: create new document

When updating via a concrete .UpdateDocRef, an error is always thrown if the document does not exist.

.DeleteStoredVersion(%)

Boolean value determining whether the original document is explicitly deleted during an update

Default value: TRUE

This property only applies when the status is transitioning from "Stored" to "Archived" since the document is not deleted automatically by the archive system during this status transition.

This functionality is only available for the archive interfaces "XSuiteArchivePrism" and "XSuiteArchiveHelixLegacy."

.DocRefField(%)

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

In the case of multiple references – only when updating with multiple hits – it is an array of these references.

This functionality is only available for the archive interfaces "XSuiteArchivePrism" and "XSuiteArchiveHelixLegacy."

When defining target field names for the property OutputSystem[].Field[].OutputName of the xSuite archive output systems, you can use the field names of the respective .DocumentType property. If the fields are not predefined, you can use any name.

For table fields, the target field name is composed of {table field name}.{column field name}. A predefined document type is essential for table fields, because the name of the assigned table definition is read from the document type.

Multiple output to the same target field is supported for header data fields if the field is declared with a corresponding MaxCount value on the archive page. For multiple output, either different source fields from the field catalog can address the same .OutputName, or an array can transfer multiple values to a target field. With the output system "XSuiteArchivePrism", multiple transfer of fields with the same name actually takes place in the first case. The output system "XSuiteArchiveHelix" does not support this transfer. With this output system, an array of multiple values is formed implicitly instead.

For tables, only the transfer of simple values is supported. Therefore, if a single table field contains an array, only the first element of the array will be included. xSuite Interface does not check whether the transferred number of values matches the MinCount and MaxCount properties defined for the field in the document type. This kind of check is carried out by the archive itself when a document is saved. If there is an error, a corresponding message will be displayed.

The data type that is transferred is that of the source field at the time of the transfer. If an .OutputFormat has been defined, then a string value of corresponding format will be transferred. If there is a discrepancy between the data types of the source field and a predefined target field, a type conversion will implicitly be performed.

In this section: