Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

Input System "OtrisDocumentSoap"

The "OtrisDocumentsSoap" input system is used to read folders from the otris Documents application via the SOAP proxy interface.

Property

Description

InputSystem.Url*

HTTP(S) base address of otris Documents SOAP proxy web service

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

InputSystem.User*

InputSystem.Password*(§)

InputSystem.Principal*

InputSystem.Locale

User name, password, tenant ID and language (default: de) for logging in to otris Documents

InputSystem.AsUser

Second user name, used if the login is performed via "trusted login" in the context of another user

For this, assign the trustedLoginAccount=1 property to the above .user account in otris Documents.

InputSystem.ProxyServer

Proxy server for communication to the web service (optional)

Syntax: see Proxy Server Connection

InputSystem.MaxConnectionsPerUser

Maximum number of simultaneous logins (sessions) for the same user on the SOAP proxy

This number is limited by otris Documents. When using multiple interfaces to the SOAP proxy in parallel, the use of different user accounts is recommended. Otherwise, xSuite Interface has to artificially serialize the requests and thus minimize the throughput.

Default value: 3

InputSystem.RequestTimeout

Timeout value in seconds, determining how long to wait for a response from the web service before throwing an error

Default value: 100

InputSystem.FileType[]*

Names of the folder types that are read in

When querying against an EDA archive, use the syntax {folder type}@{archive server}.

InputSystem.StatusField*

Name of the field in the folder-type definition that contains a status value signaling that the folders are to be read in ("Waiting" status)

The field is subsequently also used for status update by xSuite Interface via a folder update. The following status types are available:

  • Working

  • Finished

  • Error

  • Suspended

InputSystem.StatusValue[]

Subparameter for defining the concrete value specifications for the different statuses in the .StatusField property, as follows:

  1. Type*: status type Waiting, Working, Finished, Canceled, Error or Suspended

  2. Value: value specification to be used in the folders for the respective status

By default, the value specifications are identical to the status types listed under Type. Thus, the system searches for folders that have the value "Waiting" in the .StatusField. After reading, this value is set to "Working."

If you are making custom .StatusValue entries, always define them in full for all desired statuses. The Value parameter can be left blank if, for example, new folders in "Waiting" status are identified by an empty status value. Individual status types can also be omitted if no value is to be set for them.

Notice

An entry should always be defined for the Waiting and Working statuses so that folders that have already been read in can be identified and are not read in repeatedly.

InputSystem.ErrorField

Name of a field in the folder-type definition (optional)

In the case of an error (status Error or Suspended) the error message from xSuite Interface processing is written into this field.

InputSystem.SearchFilter

Filter expression in otris Documents syntax (see SOAP proxy documentation) (optional)

This filter expression further restricts the selection of folders to be read by one user-defined characteristic. The expression is combined with the implicit search in the .StatusField property via an AND operation.

InputSystem.FileFilter

Name filter for optional restriction of file attachments that are transferred from a folder

Only the file attachments that match the specified name pattern will be accepted.

Default value: * (adoption of all attachments)

The index data extracted from an otris Documents folder is added to the xSuite Interface document as an artificially generated file attachment index.json. With this, the index data can be read in the processing step via an index data reader of type "Json." The properties contained in the JSON object correspond to the fields of the folder type definition by name. Tabular data that is stored in a folder XML-structured as "GenTable" is automatically converted to an equivalent JSON construct.

For example, a GenTable field contains the following XML string:

<table>
   <tr>
      <td title="Column1">Hello</td>
      <td title="Column2">World</td>
   </tr>
</table>

When converting to JSON, an array with one object per table row is created under the name of the GenTable field (called "GenTableField" in the example), which contains the column names as properties:

{
   "GenTableField": [
      {
         "Column1": "Hello",
         "Column2": "World",
      }
   ]
}

In the JSON index data reader, the .InputName properties for the two table fields can be defined as JSONPath expressions GenTableField[*].Column1 and GenTableField[*].Column2. The asterisk (*) in the JSONPath syntax represents the selection of all array elements (i.e., all table rows). If an explicit mapping between JSON array and target table field is made in the field catalog via the ProcessReadIndex[].ItemProperty[] property, the expressions will be shortened to the relative paths Column1 and Column2.

Field values are always passed as string types by otris Documents, so if the target fields have a different type, explicitly define an .InputFormat for correct parsing in the index data reader.

Independent of the backup settings and deviating from the default, otris Documents folders are generally not deleted after processing has been completed in xSuite Interface.

In this section: