Input System "XSuiteWorkflow"
The "XSuiteWorkflow" input system is used to read work elements from the xSuite Helix Cloud workflow service.
Property | Description |
|---|---|
InputSystem.Url* | HTTPS base address of the xSuite Helix web service When specifying the base address, include the port number but not the sub-paths. |
InputSystem.Keycloak* | Properties for authentication against the web services via a keycloak service Syntax: see Keycloak Authentication. |
InputSystem.ProxyServer | Proxy server used for communication with the web services (optional) Syntax: see Proxy Server Connection |
InputSystem.RequestTimeout | Timeout value in seconds, determining how long to wait for a response from the web service before throwing an error Default value: |
InputSystem.SearchDefinition(*) | Name of a search query used to determine work elements waiting to be exported The search query must be defined on the server side. |
InputSystem.WorkflowName(*) InputSystem.ActivityName(*) | Obsolete variant for determining the work elements waiting to be exported These properties are an alternative to searching via the The search query used is permanently stored in the program and is supplemented by the following filter values:
|
InputSystem.FileFilter | Name filter for the file attachments of the work elements to be read in Default value: |
InputSystem.FileTypeFilter | Filter for the document type of the file attachments of the work elements to be read in Syntax: see Name Filter Syntax In addition to
|
InputSystem.FileNameMacro | Field macro expression returning a user-defined file name for a file attachment (optional) The general file variables can be used here (e.g., |
Notice
The xSuite Helix status update services operate asynchronously. Therefore, work elements ready for export should be queried at sufficiently large intervals (see property Worker[].Timer).
If the interval between the queries is too small, a given export element might respond to more than the one query for which it is intended. This results is an error when the attempt to export is repeated, as well as a warning message in logging.
The respective web service will return the index data of a working element as a JSON structure. This JSON structure corresponds to the data schema of the workflow. In order for the data in the processing step to be read at a later point, the index data will be added to the xSuite Interface document as an artificially generated file attachment index.json. This file attachment can be processed with the general JSON index data reader.
The work elements are generally not deleted after complete processing in xSuite Interface on the workflow side, regardless of backup settings in xSuite Interface. The work elements move to the next workflow step directly after the successful import. This processing in xSuite Interface is asynchronous to further workflow execution. The workflow will not receive any feedback regarding the processing status.