Options are used to define various settings required for an individual process. They must always be passed as XML wide strings. The structure of the XML string resembles the result XML of the function Process_GetInfo and reflects the internal object structure of the MWS. For additional information, see Info XML.
When setting options, only attributes that are explicitly declared as attributes in this section can be set. As an XML wide string is used, it is possible to include a number of different settings at once.
Refer to the following list for available settings:
-
Set the start command
For more information, refer to Function Process_Create, element mwsprocessmngr, attribute onstart.
Possible attribute values: Actions, commands and their results
-
Set process title and description
For more information, refer to Function Process_Close or Options When Closing a Process.
-
Set general settings of actions
-
Every action of a process can be configured.
-
There are actions that require a configuration and actions that do not necessarily have to be configured.
-
For all actions (element mwsaction), the attributes state and configured can be set.
-
Setting the action property state from finished to the value ready, means the action can be repeated.
Note: In doing so, any already existing results of this action (for example, documents) and the results of all subsequent actions are deleted. -
Setting the action property configured to true stipulates that configuration of this action is complete.
-
-
Set parameters for data retrieval
-
Parameters for data retrieval belong to the DATASELECTION action and must therefore be defined as a child element of this action.
-
The name of the set element for all data retrieval parameters is selparams.
-
Parameters are addressed by the attribute name. The value must be passed as CDATA.
Example
... <selparams> <selparam name="Partner-Nr">0815</selparam> </selparams> ...
-
-
Set manual variables
-
Manual variables belong to the CREATEDOCUMENTS action and must therefore be defined as a child element of this action.
-
The name of the set element for all manual variables of a bundle is manvars.
-
The name of the set element for all manual variables of a document is docref.
-
The document must be addressed by the attribute reference. For more information, refer to Address of an Object in a Bundle
-
The actual manual variable is described by the name manvar in the element and must also be addressed by the attribute reference.
The value must be passed as CDATA.
Example
... <manvars> <docref reference="790B817A-B2C3-475E-86E5-08118150EA94"> <manvar reference="DocumentCollection.790B817A-B2C3-475E-86E5- 08118150EA94:308DFBC5-F520-414E-ACBD-0A4495C33301_E4437CCD-E71A-4181-9C6E-0691B26E0C8FValue1/manvar <manvar reference="DocumentCollection.790B817A-B2C3-475E-86E5-08118150EA94:308DFBC5-F520-414E-ACBD-0A4495C33301_EAAC39D9-81BA-476B-A003-039ABF3618AAValue2/manvar </docref> </manvars> ...
-
-
Set parameters for output management
Parameters for output management belong to the PRINTANDARCHIVE action and must therefore be defined as attributes of this action.
For more information, refer to Special Attributes of the Action PRINTDOCUMENTS.
-
Set variables in the pool SYSTEMPOOL
Pool variables are independent of actions and can therefore be defined directly below the process element.
For more information, refer to Get and Set Pool Variables.
As a general rule, the following attributes cannot be set:
-
process_status
-
lastaction
-
lastactionname
-
lasterrorcode
-
lasterrormessage
-