This function creates a new MWS process.
To create a new process, the following actions are executed on the server:
- Load the configured process that defines the sequence of MWS process steps from the repository (if not already done).
- Create a directory for the data of the respective document creation process.
- Create a dataset for the process in the database table MWS_Processes.
- Evaluate options, if an Options XML was passed (parameter options).
- Execute the OnSetOptionsScript of the MWS process, if assigned.
- Execute the OnNewProcess script of the MWS process, if assigned.
- Execute a start command if passed to the Options XML.
If an error occurs during the execution of this method, the process data created (files and DB dataset) is deleted.
Syntax
Process_Create(string sessionId,ref string processId, string mSystem,string mType,string mTitle, string objectIndex,string objectName, string objectType,string objectData, string options,out string xmlResult)
Parameter | Description |
---|---|
sessionId | Valid session identifier (SessionId) |
processId | If the process ID is not passed in, a new one is created. |
mSystem | System OID of the system the object to be loaded resides in. |
mType | Free text to define the process type. |
mTitle | Free text to define a title for the process. |
objectIndex | Index of the object to be loaded (if this parameter is used, the name is ignored). |
objectName | Name of the object to be loaded (is ignored, if the index is specified). |
objectType | Type of object to be loaded (currently only P = bundle) |
objectData | Optional XML data for a bundle. The data will be assigned to the first passive selection in the script OnNewStart. |
options | Options XML for the MWS process. |
xmlResult | If the process was created successfully, either the bundle structure or process information is returned. The bundle structure is returned if a start command is passed to the options. |
Return Value
Value | Description |
---|---|
0 | OK |
<>0 |
Error See Error Codes. |