Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

Output System "OtrisDocumentsSoap"

The "OtrisDocumentsSoap" output system is used to create new folders or update existing folders in the otris Documents application via the SOAP proxy interface.

Property

Description

OutputSystem[].http*

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.

OutputSystem[].User*

OutputSystem[].Password*(§)

OutputSystem[].Principal*

OutputSystem[].Locale

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

OutputSystem[].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.

OutputSystem[].ProxyServer

Proxy server for communication to the web service (optional)

Syntax: see Proxy Server Connection

OutputSystem[].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

OutputSystem[].RequestTimeout

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

Default value: 100

OutputSystem[].FileType(*%)

Name of the folder type for which new folders are created or existing folders are updated

This specification is mandatory only if only one script (property .ScriptName) is executed.

OutputSystem[].GenTableField[]

Subparameters for defining the mapping of tabular output fields to a target field in that otris Documents folder that accepts a "GenTable" content in XML format:

  1. Name*: name of GenTable field

  2. FieldName: table name of the source fields in the field catalog (optional)

If no restrictive FieldName is specified, the GenTable target field will apply to all source tables.

OutputSystem[].DocRegister[]

Subparameters for definition of the names of tabs in the Documents folder type where file attachments sent are placed depending on their type (optional):

  1. FileName: file name pattern (default value: *)

  2. Register*: name of register

For each file attachment, in the order in which they are defined, the entries are checked for whether the name pattern matches. The tab name of the first matching entry is used.

OutputSystem[].DirectEas

Boolean value determining whether folders will be created and updated directly in an EAS archive instead of in otris Documents

If the new creation/update is performed in the EAS archive, extend the above .FileType property with the technical name of the archive server. The syntax for this is {FileType}@{Archive Server}.

Default value: TRUE

OutputSystem[].UpdateMode

Mode for creating or updating folders:

  • None: no update, but new creation

  • First: update of only the first folder found

  • All: update all folders found

The All mode is only applicable in the following constellation: a key term (properties .UpdateKeyField and .UpdateKeyValueMacro) is used to search for existing folders and the .UpdateExistCheckMode property is not set to None.

OutputSystem[].UpdateDocsMode

Mode for handling eponymous file attachments when updating folders:

  • Append: file attachments are always added (default value)

  • Replace: eponymous file attachments are replaced

  • ReplaceVer: eponymous file attachments are replaced and versioned

The modes only set the switches in the otris Documents API. The actual functionality depends on further settings in otris Documents.

OutputSystem[].UpdateExistCheckMode

Mode for existence check of folders to be updated:

  • None: no explicit check (default value)

  • Error: error thrown if not found

  • Create: creation if not found

In None mode, the default behavior of otris Documents takes effect (i.e., if a folder to be updated does not exist, either a new folder is implicitly created or an error is thrown, depending on the version). In addition, when searching via a keyword (properties .UpdateKeyField and .UpdateKeyValueMacro), only the first folder found will generally be updated, regardless of the .UpdateMode above.

In the other modes, xSuite Interface will explicitly perform its own search for existing folders in advance. In Error mode, an error is thrown if the folder does not exist, and in Create mode, a new folder is created. This only applies to the search via a keyword, because if a concrete folder ID is specified (property .UpdateFileId), the folder in question is always assumed to exist; if it does not exist, an error will be thrown.

OutputSystem[].UpdateFileId(%)

OutputSystem[].UpdateKeyField(%)

OutputSystem[].UpdateKeyValueMacro

Definition of the identification feature of a folder to be updated

Identification can proceed either directly via the unique folder ID (.UpdateFileId) or via a search to be performed using a search field name (.UpdateKeyField) and a search value (.UpdateKeyValueMacro).

The value is to be specified here in the form of a field macro expression. The field macro expression must return a string which, in the case of typed search fields (e.g., date fields) syntactically complies with the requirements of otris Documents.

OutputSystem[].SendFileUser(%)

OutputSystem[].SendFileTaskDescr(%)

Specification of a receiving user and a task description if a folder is sent directly after creation or update

OutputSystem[].WorkflowName(%)

Name of a workflow to be started directly after a folder has been created or updated

OutputSystem[].ScriptName(%)

OutputSystem[].ScriptParam[]

Name of a portal script to be executed after a folder is created or updated

As a special case, pure execution of a script without a folder reference is also possible if a .FileType has not been specified.

The .ScriptParam[] property consisting of partial values can be used to define call parameters for the script:

  1. Name*: name of script parameter

  2. Value*: value of the script parameter

Analogous to normal index fields, parameter values are also always passed as strings, so make sure to use suitable syntax for typed values (e.g., a date).

OutputSystem[].FileIdField

Name of a field from the field catalog (optional)

If a generated folder ID or folder ID was changed after an update, it is written back to this field.

In .OutputName, specify the target fields according to their naming in the relevant otris Documents folder type. For tabular fields to be passed to a GenTable element, the output names must match the "title" attribute of the GenTable field definitions.

Field values are always passed as strings, so define a suitable syntax in .OutputFormat for typed values that meets the requirements of the target system. For a login in German, for example, date values are typically expected in the format dd.MM.yyyy.