Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

Output System "XSuiteWorkflow"

The "XSuiteWorkflow" output system is used to create new work items in the xSuite Helix Cloud workflow service. Unlike the "XSuiteArchiveHelix" output system, for example, the xSuite Helix Cloud does not require an asynchronous status query. The "XSuiteWorkflow" output system therefore does not need to be combined with a subsequent "XSuiteConveyorResult" output system.

Property

Description

OutputSystem[].Url*

HTTPS base address of the xSuite Helix web service

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

OutputSystem[].Keycloak*

Properties for authentication against the web services 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[].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[].Application*

Name of the application for which new workflow work elements are created

OutputSystem[].FileType[]

Subarameters for defining the document type depending on the name of a file attachment belonging to the work element:

  1. FileName*: file name pattern

  2. Value*: document type

The following document types of the workflow service can be used:

  • Unknown

  • OriginalDocument

  • Attachment

At least one file attachment of the type OriginalDocument must be transferred. The default value for an unset configuration property is FileName: *, Value: OriginalDocument.

OutputSystem[].Comment[](%)

Comment texts attached to the work element (optional)

Each individual value of the configuration property is transferred as a separate comment.

OutputSystem[].WorkItemIdField

Name of a field from the field catalog into which the ID of the created work element is written back (optional)

The index data is transferred as a JSON document in accordance with the JSON schema linked to the work item of the configured application. For information on the syntax of the target fields in .OutputName, see Index data transfer as JSON documents.