Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

Input system "XSuiteBus2"

The "XSuiteBus2" input system is used to read in documents from xSuite Bus Prism that have been fully processed. In most cases, these documents have been transferred to xSuite Bus Prism for asynchronous processing via the "XSuiteBus2" output system.

Property

Description

InputSystem.Url*

Base address (HTTPS) of the xSuite Bus web service

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

InputSystem.User

InputSystem.Password(§)

User name and password for logging into xSuite Bus Prism, if user authentication is enabled there (optional)

InputSystem.ProxyServer

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

Syntax: see Proxy Server Connection

InputSystem.Owner

Parameters for filtering the records read from xSuite Bus Prism

The only selection criterion supported is the .Owner.

Default value: xSuiteInterface

InputSystem.DocKeyType

Specification of the type of a document key (optional), if it is to be read in as well:

  • None (default value)

  • XflowBusDocumentID

  • XflowInterfaceRecordID

  • XFlowWFLWorkItemID

  • SAPInterfaceRecordID

  • OTRISInterfaceRecordID

At the time of reading in, no field catalog is assigned to the xSuite Interface document yet. Therefore, the key is not assigned to the document as a field value, but as metadatum "xSuiteBusDocKey." This metadatum can be read at a later time with the field macro function GetDocMetaData() if necessary.

InputSystem.FetchBlob[]

Subparameter for defining the selection criteria for file attachments, if these are to be read out from xSuite Bus Prism

In most scenarios, this is not relevant because xSuite Bus Prism does not generate new file attachments, but only extracts index data from files previously passed to xSuite Bus Prism.

  1. Type* (logical file type)

  2. MimeType

  3. FileName

  4. GroupName

  5. GroupIndex

The following values are allowed for the logical file type:

  • RawFile

  • MainFile

  • AttachmentFile

  • RawAttachmentFile

InputSystem.DeleteJobItem

Boolean value determining whether the job item is deleted after successful import of the document from xSuite Bus Prism

If this value is false, the job item will only receive the "OwnerEnd" status.

Default value: TRUE

For later reading of the index data in the processing step, the 2 artificially generated file attachments jobitem.json and document.json are added to the xSuite Interface document. The jobitem.json file represents the content of the job item returned by xSuite Bus Prism. The document.json file represents the content of the document record. Both files can be processed with the general JSON index data reader. However, for the document-related data comprising the relevant field contents, the specialized index data reader "XSuiteBus2" is also available (see Index Data Reader "XSuiteBus2").