Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

Output System "XSuiteBus2"

The "XSuiteBus2" output system is used to transfer documents to xSuite Bus Prism 2.x.

Property

Description

OutputSystem[].Url*

Base address (HTTPS) of the xSuite Bus web service

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

OutputSystem[].User

OutputSystem[].Password(§)

Username and password for logging into xSuite Bus Prism, if user authentication is enabled there

OutputSystem[].ProxyServer

Proxy server for communication to the xSuite Bus web service (optional)

Syntax: see Proxy Server Connection

OutputSystem[].Client(%)

OutputSystem[].Customer(%)

OutputSystem[].Owner(%)

Parameter for the definition of the context in which a document is generated along with its job item in xSuite Bus Prism

The default value for the .Owner property is xSuiteInterface.

OutputSystem[].Workflow(*%)

OutputSystem[].Action(*%)

OutputSystem[].ActionType(*%)

Identifier of a workflow or, alternatively, an action and its action type, which is started in xSuite Bus Prism for the continued processing of a transferred document

One single specification of the two is required.

OutputSystem[].DocKeyMacro

OutputSystem[].DocKeyType(*)

Macro expression for generating an external document key (optional)

If a document key such as this is sent to xSuite Bus Prism, specify the type in .DocKeyType as well:

  • None (default value)

  • XFlowBusDocumentID

  • XFlowInterfaceRecordID

  • XFlowWFLWorkItemID

  • SAPInterfaceRecordID

  • OTRISInterfaceRecordID

OutputSystem[].FileType[]

Subparameters for defining the logical file type, dependant on the name of a file attachment that is transmitted to xSuite Bus Prism:

  1. FileName*: file name pattern

  2. Value*: logical file type

The following file types can be assigned to a file name pattern:

  • RawFile (default value if .AttachFileType[] is missing)

  • MainFile

  • AttachmentFile

  • RawAttachmentFile

OutputSystem[].DocIdField

OutputSystem[].JobItemIdField

Names of fields of a field from the field catalog (optional)

The IDs generated by xSuite Bus Prism for the job item and the document are written back into these fields.

In .OutputName, specify the target fields as they are in the xSuite Bus field catalog. If names of fields of different groups are ambiguous, a prefix with the field name can be added the group name (syntax: {group name}.{field name}).

The definition of an .OutputFormat is usually not necessary for this output system, because xSuite Bus Prism supports a typed transfer of the field values. In case of a discrepancy between the data types of the source field and the target field, a type conversion is implicitly performed. If an .OutputFormat is explicitly specified, it has priority and overrides the data type specification from the xSuite Bus field definition.