A Web service process is comprised of a number of actions, a process manager that controls the processes, and variable pools. Each of these objects has properties that can change during the course of a process.
An application that integrates the MWS can access information on a process to display it or to determine which subsequent actions have to be executed. To keep network data traffic to a minimum, it is possible to request this information selectively. To do this, the type of information must be specified.
The properties of the process manager are always returned, irrespective of the information type requested.
The mwsprocessmngr element is located below the process element .
Example
... <mwsprocessmngr lasterrorcode="0" lasterrormessage="" lastactionname="" onstart=""> ...
| Attribute | Description |
|---|---|
| lasterrorcode | Number of the last error |
| lasterrormessage | Description of the last error |
| onstart | Name of the action to be started directly after a process is
created. Note: Setting this property at a
point in time after the process was created has no effect.
|
| lastactionname | Name of the last action executed |
Another important piece of information is the last error that occurred. This information is always returned when an error was thrown, irrespective of the information type requested. The information is located directly below the mws element .
... <error errorcode="6000">error text</error> ...
The following information types are currently supported.
PROCESSINFO
| Attribute | Description |
|---|---|
| Title | Title of the process |
| Description | Description of the process |
Actions are listed directly below the process manager in the mwsaction element .
Each action has the following attributes.
| Attribute | Description |
|---|---|
| name | Name of the action |
| lasterrorcode | Number of the last error |
| lasterrormessage | Description of the last error |
| state | See Action Property state |
| configured | See Action Property configured |
Extended attributes of the action DATASELECTION. Refer to Special Attributes of the Action DATASELECTION
Extended attributes of the action PRINTANDARCHIVE. Refer to Special Attributes of the Action PRINTDOCUMENTS
POOLVARS
Returns variables SYSTEMPOOL. Refer to Get and Set Pool Variables
MANVARS, MANVARS2
Return manual variables of a bundle.
As manual variables belong to the CREATEDOCUMENTS action , they are listed below the corresponding element.
Example
...
<mwsaction name="CREATEDOCUMENTS" lasterrorcode="0" lasterrormessage="" state="0" configured="0">
<manvars>
<docref name="Partner_Application_ManVar" title="Partner_Application_ManVar" reference="790B817A-B2C3-475E-86E5-08118150EA94">
<manvar name="Agent_Forename" reference="DocumentCollection.790B817A-B2C3-475E-86E5-08118150EA94:308DFBC5-F520-414E-ACBD-0A4495C33301_E4437CCD-E71A-4181-9C6E-0691B26E0C8F" title="Agent_Forename" mask="" vh_name="" vh_id="" vh_system="" vh_type="2" input_enabled="Y" data_link="MODUSUSER" data_attribute="Forename" input_required="0"/>
<manvar name="Agent_Surname" reference="DocumentCollection.790B817A-B2C3-475E-86E5-08118150EA94:308DFBC5-F520-414E-ACBD-0A4495C33301_EAAC39D9-81BA-476B-A003-039ABF3618AA" title="Agent_Surname" mask="" vh_name="" vh_id="" vh_system="" vh_type="0" input_enabled="Y" data_link="MODUSUSER" data_attribute="Surname" input_required="0"/>Doe
</docref>
</manvars>
<manvars2>
<docref name="Partner_Application_ManVar" title="Partner_Application_ManVar" reference="790B817A-B2C3-475E-86E5-08118150EA94">
<manvar2 name="Agent_Forename" reference="DocumentCollection.790B817A-B2C3-475E-86E5-08118150EA94:308DFBC5-F520-414E-ACBD-0A4495C33301_E4437CCD-E71A-4181-9C6E-0691B26E0C8F" title="Agent_Forename" mask="" vh_name="Forename" vh_id="" vh_system="" vh_type="2" input_enabled="Y" data_link="MODUSUSER" data_attribute="Forename" input_required="0"/><valuehelp><combobox xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
sorted="true">
<items>
<item>Martin</item>
<item>Hugo</item>
<item>Ernest</item>
<item>Max</item>
<item>John</item>
</items>
</combobox></valuehelp>Doe</manvar2>
<manvar2 name="Agent_Surname" reference="DocumentCollection.790B817A-B2C3-475E-86E5-08118150EA94:308DFBC5-F520-414E-ACBD-0A4495C33301_EAAC39D9-81BA-476B-A003-039ABF3618AA" title="Agent_Surname" mask="" vh_name="" vh_id="" vh_system="" vh_type="0" input_enabled="Y" data_link="MODUSUSER" data_attribute="Surname" input_required="0"/>
</docref>
</manvars2>
</mwsaction>
...
The manvars and manvars2 elements are collector nodes for all manual variables. The manual variables of a document are listed under the docref collector node.
The manvars and manvars2 elements each have the following attributes.
| Attribute | Description |
|---|---|
| name | Name of the document |
| title | Document title |
| reference | See Address of an Object in a Bundle |
The elements manvar and manvar2 each describe a manual variable as follows.
| Attribute | Description |
|---|---|
| name | Name of the manual variable |
| reference | See Address of an Object in a Bundle |
| title | Title for the prompt |
| mask | Input mask (see the Studio documentation) |
| vh_name | Name of the value help (optional) |
| vh_id | Object ID of the value help (optional) |
| vh_system | System ID of the value help (optional) |
| vh_type | Type of the value help Possible values 0: No value help assigned to variable 1: Textbox 2: Combobox 3: Calendar 4: SpinEdit 7: MultiLineTextBox |
| input_enabled | 0 when no manual input should be possible (for example, if only value selection should be possible). This attribute only exists if no manual input should be possible. |
| Data | Current value of the manual variable |
When specified in the appropriate AppSettings, the manvar2 element is to be returned by the MWS if manual variables info is requested. This is the case for
- the returned warning Configuration for action CREATEDOCUMENTS required.
- a call to Process_GetInfo with infoType MANVARS
In case a value help is assigned to the variable described by the manvar2 element , an additional child element, <valuehelp>, will be included, containing the according serialized value help definition.
SELPARAMS
Returns parameters for data retrieval. As these parameters belong to the DATASELECTION action , they are listed below the corresponding element.
Example
...
<mwsaction name="DATASELECTION" lasterrorcode="0" lasterrormessage="" state="0" configured="0">
<selparams>
<selections>
<selection name="Partner_Letter" title="Partner_Letter" active="True">
<selparam name="Partnernumber" displayname="PartnerNumberTest" mask=""/>0815</selparam>
</selection>
</selections>
</selparams>
</mwsaction>
A data retrieval parameter is described by the selparam element .
| Attribute | Description |
|---|---|
| name | Name of the parameter |
| displayname | Name used for display. If empty, name is used. |
| mask | Input mask for this parameter. If empty, no input mask s used. |
| data | Parameter value |
OUTPARAMS
Returns parameters for output management. Since these parameters belong to the PRINTDOCUMENTS action, they are listed below the corresponding element.
Example
...
<mwsaction name="PRINTDOCUMENTS" lasterrorcode="0" lasterrormessage="" state="0" configured="0">
<objects>
<object title="ApplicationPack" type="D" name="ApplicationPack" index="07102009-289-tdr-dm1" reference="933110B7-0485-4C62-A50C-0B9D7FC62DB1"/>
</objects>
</mwsaction>
...
All objects are listed where print definitions are still to be completed by the Obj_SetStructure method .