Condition

Condition for execution of the output scenarios that can also be transferred in the input scenario.

xSuite Interface can only process documents if the parameter is set to 1 or true. It is possible to create variables that result in one of the two values as output value. (e.g.: %<;InternalName>%)

MacroPre

MacroPost

Macros can be defined in xSuite Interface as pre or post. Depending on definition, the respective macro will be executed before or after processing by xSuite Interface.

A description of available macros is examined in greater detail in the xSuite Interface Prism documentation.

FileFilter

The file filter defines the files that are to be processed. This works either by means of a wild card and the file ending (*.PDF) or with a field variable (<InternalName>).

Files that have been defined this way will be processed and, as in this case, transferred to xSuite Bus. No other files will be included in processing.

If this parameter is not filled, then processing will proceed for all files.

To ensure that all input and output interfaces have been provided for, you may need to store this parameter multiple times when configuring xSuite Interface.

FileFilterExclude

This file filter defines the files that are NOT to be processed. This works either by means of a wildcard and the file ending  (*.TIF) or with a field variable (<InternalName>).

Files that have been defined this way will not be processed.

To ensure that all input and output interfaces have been provided for, you may need to store this parameter multiple times when configuring xSuite Interface.

WebserviceURL

HTTP address of the xSuite Bus Service.

This web address can be traced in the IIS.

The structure is always HTTP://localhost:Port/XFlowBusWebServiceHost/XFlowBusWebService.svc/basic.

Example: http://WMDS31.wmd.local:8090/XFlowBusWebServiceHost/XFlowBusWebService.svc/basic

Client

Customer

Parameter that assigns an Interface configuration to a client or customer set up in xSuite Bus.

This allows xSuite Interface configuration to specify which xSuite Bus client or customer was assigned and which workflows or actions are to be executed.

When using the xSuite Mailroom, the customer and client defined here are also included and must be entered during the installation.

Owner

When the Owner is specified, it is possible to map different xSuite Interface scenarios in an xSuite Bus instance.

Workflow

Action

ActionType

These parameters can specify certain workflows, actions, and action types that are provided in xSuite Bus.

When one of these parameters is maintained (e.g., Workflow=WFL_Capture), the workflow for the data extraction will be started in xSuite Bus as soon as the work item has reached xSuite Bus.

A workflow in xSuite Bus is a collection of multiple actions. Therefore, either a workflow, an action or an action type can be specified.

DocKeyField

Optional field for transfer of a field in the field catalog that is to be set as the document key and transferred as such to xSuite Bus (e.g., DOCDKEY).

DocKeyType

Descriptive numeric value for the field DocKeyField. The number of digits to be had in the DocKeyField is defined here.

TrackingIDField

TrackingKeyField

Optional internal name of field-catalog fields that contain a global ID and/or key to be transferred to xSuite Bus in order to be able to identify a document across systems and monitor its processing.

The ID must be available in the syntax UUID (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx), whereas a numeric counter is normally used for the key.

If it is to be generated as an initial name in xSuite Interface, then the field macro UUID() or GlobalCount() can be used — or, for the purposes of managing the counter value in a database — better yet, the ExecDBCommand() macro, with a user-defined SQL command.

For example, a GlobalCountDB can be set up on the database, or a sequence can be set up using the following function: UPDATE [Counter] SET [Sequence]= (SELECT [Sequence]+1 FROM [Counter]) OUTPUT [inserted].[Sequence].

DocumentIDField

JobItemIDField

Optional internal name of the field-catalog field in which the document ID (DocumentFieldID) and/or the Job-Item ID (JobItemIDField) generated by xSuite Bus are to be written.

The JobItemID is used in the xSuite Bus system as the order key (UUID).

FileType

Logical file type of the file attachment(s) to be transferred to xSuite Bus:

If multiple files of different types are to be transferred, the key can be re-iterated any number of times with a prepended file-name pattern that restricts the validity of the key to those output files corresponding to the pattern.

Syntax: <file name pattern>|<logical file type>

Example: FileType=attach*.pdf|AttachmentFile FileType=*.pdf|MainFile

The analysis of the name patterns proceeds from the top down until a fit has been found. In the example, all files that have names not explicitly containing the term attach are typed as MainFile.