Output System "XSuiteConveyorResult"
"XSuiteConveyorResult" is not a conventional output system; it is a special work step that fits into the sequence of normal output systems. Therefore, the standard properties for configuring an output system do not apply here.
Downstream from an output system that transmits documents via the xSuite conveyor service to a service in the xSuite Helix Cloud for processing, "XSuiteConveyorResult" waits asynchronously for a status feedback. "XSuiteConveyorResult" periodically sends active queries against the conveyor service to check whether the documents have transitioned to a final status (i.e., have been successfully processed or have run into an error). If successful, the processing of the document in xSuite Interface will continue. If there is an error, the document will transition to error status.
In practice, this output step is only used in conjunction with the “XSuiteArchiveHelix” output system. The successor to this output system, “XSuiteArchiveHelix2,” is available and addresses a newer archive API in version 2. This API does not require asynchronous status queries.
Property | Description |
|---|---|
OutputSystem[].Url* | HTTPS base address of the conveyor web service When specifying the base address, include the port number but not the sub-paths. |
OutputSystem[].Keycloak* | Properties for authentication against the conveyor web service via a Keycloak service Syntax: see Keycloak Authentication. |
OutputSystem[].ProxyServer | Proxy server for communication to the conveyor web service (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: |
OutputSystem[].ImportItemKeyField | Name of a field from the field catalog (optional) The ID of the object generated by the xSuite Helix service will be written back to this field. In the case of xSuite Archive, this could be the ID of an archive document. |