WorkflowDefinition
Properties
System Property |
Type |
Description |
Changeable |
Identity |
Required for creation |
---|---|---|---|---|---|
system_application | Reference [type= Application] | Reference to the application in an application workflow | Yes [group=g1] | ||
system_workflow | Reference [type= Workflow] | Reference to the workflow | Yes [group=g1] | ||
system_workflow_definition | String, XML |
XML fragment (see below) with a list of any number of Automation Engine folders and their content Note: See below for details Important! The field is empty if you export the workflow definition as CSV |
Note: Properties belonging to the same group have to be defined as multi-value (which consists of different CSV values separated by #: value1#;#value2#;#value3).
system_workflow_definition
Each of these folder elements of the XML in system_workflow_definition consists of the following parameters:
Name | Type | Multiplicity | Description |
---|---|---|---|
folderName | String | Mandatory | Name of the folder in the Automation Engine. Sub-Folders are separated by slashes, for example, "/RM/BOND/RM.DESIGNERS.BOND.INSTALL.DATABASE." |
exportData | String, base64 encoded | Mandatory | Contains the export XML of all Automation Engine objects in the folder. Because this XML can contain CDATA-sections its encoded using base64 format. |
The XML fragment for system_workflow_definition has the following structure (example):
<folders>
<folder>
<folderName>/RM/BOND</folderName>
<!-- Base64 encoded XML export of the Automation Engine objects -->
<exportData>...</exportData>
</folder>
<folder>
<folderName>/RM/BOND/RM.DESIGNERS.BOND.INSTALL.DATABASE.</folderName>
<exportData>...</exportData>
</folder>
<folder>
<folderName>/RM/BOND/RM.DESIGNERS.BOND.INSTALL.WEB_APP.</folderName>
<exportData>...</exportData>
</folder>
</folders>
Export
Export of WorkflowDefinition is possible using the Export method of the Webservice API and CLI.
The process exports the workflow definition itself including all objects of this workflow in the same folder (identified by their name). Additionally it exports all sub folders of the workflow and their objects (if there are any) recursively.
Import
The import of a WorkflowDefinition is possible using the Import method of the Webservice API and CLI.
For each folder in the Automation Engine it is verified whether it does already exist. If it does not exist, its created, otherwise the existing folder is used.
Each XML object definition is imported to its corresponding Automation Engine folder while existing folder links and objects are overwritten.
Reporting
The entity is not available for reports.