Workflow Definition Schema Reference
Tag
| Tag Name | Parent Element | Description | Req. |
|---|---|---|---|
| system-workflow-definition | The root tag for Workflow Definitions. | Yes |
Attribute(s)
| Attribute Name | Values | Description | Req. |
|---|---|---|---|
| name | [string] | The name of the Workflow Definition. | Yes |
| initial-step | [step identifier] | The first step in the workflow process – the value here is the identifier for a step. | Yes |
Tag
| Tag Name | Parent Element | Description | Req. |
|---|---|---|---|
| triggers | system-workflow-definition | Used to declare workflow triggers to be used later on by actions in the workflow. | No |
Tag
| Tag Name | Parent Element | Description | Req. |
|---|---|---|---|
| trigger | triggers, action | Used to execute a process in the CMS pertaining to the content in the workflow process. Available triggers include the following: AssignStepIfUser, AssignToGroupOwningAsset, AssignToWorkflowOwner, CreateNewWorkflowsTrigger, Delete, DeleteAndUnpublish, EmailProvider, Merge, PreserveCurrentUser, Publisher, PublishSetTrigger, and Version. | No |
Attribute(s)
| Attribute Name | Values | Description | Req. |
|---|---|---|---|
| name | [string] | The name of the trigger. | Yes |
| class | [package name] | The name of the Java class invoked by the trigger. This value is only needed in the initial declaration and not in subsequent invocations. | Yes |
Tag
| Tag Name | Parent Element | Description | Req. |
|---|---|---|---|
| steps | system-workflow-definition | Used to denote the start of the steps section in the workflow. | Yes |
Tag
| Tag Name | Parent Element | Description | Req. |
|---|---|---|---|
| step | steps, non-ordered-steps | An individual step in the workflow. Typical steps include edit, approval, and publish. | Yes |
Attribute(s)
| Attribute Name | Values | Description | Req. |
|---|---|---|---|
| identifier | [string] | An identifying name for the step. | Yes |
| label | [string] | The text displayed on the screen as the title of the step. | Yes |
| type | transition, edit, system | The type of step in the system. | Yes |
| default-user | [user] | A default user to be supplied for this step. | No |
| default-group | [user] | A default group to be supplied for this step. | No |
| restrict-to-type | group, role | Restriction for the user chooser option associated with the step. | No |
| restrict-to-value | [group], Contributor, Approver, Publisher, Administrator | The actual filter for the restrict-to-type. | No |
| allow-user-group-change | true, false | If enable, this feature allows the user or group assignment for the step to be changed when the workflow is started. | No |
Tag
| Tag Name | Parent Element | Description | Req. |
|---|---|---|---|
| actions | step | Available actions for the step. Typical actions included approve, reject, make further changes, and publish. | Yes |
Tag
| Tag Name | Parent Element | Description | Req. |
|---|---|---|---|
| action | actions | A specific action item for the step. | Yes |
Attribute(s)
| Attribute Name | Values | Description | Req. |
|---|---|---|---|
| identifier | [string] | The unique name identifying the action. | Yes |
| label | [string] | The text displayed on the screen as the link a user can click. | Yes |
| type | auto | The type of action being performed. | Yes |
| move | forward, backward | The direction for the step to move. | No |
| next-id | [identifier] | The identifier of the next step in which to move. | No |
Tag
| Tag Name | Parent Element | Description | Req. |
|---|---|---|---|
| non-ordered-steps | system-workflow-definition | Used to organize steps that are not part of the standard order in the workflow. | No |
Attribute(s)
| Attribute Name | Values | Description | Req. |
|---|---|---|---|
| identifier | [string] | The name of the step used to refer to in other actions. | Yes |