Workflow XML Reference - Triggering Events and Parameters
The following lists the types of events that can trigger actions, and the properties that are used in the XML Workflow definition.
In most cases, the property is a child element of the triggering event element. There are cases where the property requires its own block of child elements.
Triggering Event: Transition
Event Properties (in required order) | Property Requirement | Notes |
Name | Required | - 24-character name maximum
- maximum 10 Transitions per State
- must be connected to two States
|
Triggers | Optional | - the event's triggered actions
- each action is represented by its own
<Trigger> child-element block - maximum 10 Triggers per event
|
FromState | Required | - indicates the originating State
|
ToState | Required | - indicates the destination State
|
PermissionGroups | Optional | - restricts the Transition trigger to a specific set of users
- contains the following child-element structure:
<Group>
<Name>UserGroup1Name</Name>
</Group>
<Group>
<Name>UserGroup2Name</Name>
</Group>
<Group>
<Name>UserGroupnName</Name>
</Group>
|
SkipPermissionChanges | Optional | - when included with a value of
true, the aforementioned groups are not required to have the Transition trigger the action
|
Triggering Event: PropertyChange
Event Properties (in required order) | Property Requirement | Notes |
Name | Optional | - not required by the Workflow definition, but useful for XML readability
|
Triggers | Required | - the event's triggered actions
- maximum 10 Triggers per event
|
PropertyName | Required | - the name of a standard artifact property
- when this property changes, the action is triggered
|
StateCondition | Optional | - an optional condition placed on the above event parameter
- when the aforementioned artifact property changes, the action is triggered the artifact is in this State
- contains the following child-element structure:
<StateCondition>
<State>StateName</State>
</StateCondition>
|
Triggering Event: NewArtifact
Event Properties (in required order) | Property Requirement | Notes |
Name | Optional | - not required by the Workflow definition, but useful for XML readability
|
Triggers | Required | - the event's triggered actions
- maximum 10 Triggers per event
|
