Actions
Overview
- Actions are the buttons that are on each task
- The default action button is the submit button
- Action buttons can trigger activities, enabling complex functionality and behaviours to be set up
Advanced Editor properties and what they do
Property | What does the property do (in plain english) | Possible values | How to find these values (in plain english) |
name | name of the action. Not recommended to change | any string | |
displayName | label of the button | ||
actionTypeName | Indicates the colour of the button in the frontend. Default is DianaSubmitWorkAction | DianaSubmitWorkAction
Submit
Stop | |
eventName | event name of the action | ||
simpleName | simple name of the action | ||
destination - destinationType | configures what this action will do
| Next (default: goes to the next task)
Previous
Self
ByEventName
ByStepName (a way to skip to a specific task or to go backward to a particular task
ByStepDisplayName
ByStepId
StopStep
TerminateFlow
EndFlow (the name destinationType used to end a workflow)
Close
SkipUntil | |
destination - target | The value in the target property depends on the value that you put in the destinationType | ByEventName
target: Any event name in the flow. You can find the event name by navigating to the activity (Steps > specific step > specific task > Action set > specific action > Activities > specific activity
And then copying the value from the “eventName” property
ByStepName
target: step name in the workflow. You can find the step name by navigating to the TASK (not the step) in the advanced editor and then copying the value in the “name” property
ByStepDisplayName
target: The same as ByStepName but take the value from the “displayName” instead of the “name” property
ByStepId
target: The same as ByStepName but you need to find the task ID (which is harder to find so we recommend you just use the ByStepName function)
For all the other destinationType values the respective target values are just same text as the destinationType (e.g.
”destination”: {
”destinationType”: “EndFlow”,
”target”: “EndFlow”
} | |
mode | StepMode allows the system to show one or more steps at given points in the system | 1 = Automatic, Automatic means that the step does not wait for the task or action event to move to the next step, if no action is specified then this is the default behaviour of the system.
2 = Event, Wait for an event to be raised before moving to the next step, the event can be generated by a button press or some other external event. The flow will wait for the event before it can progress.
4 = WithPrevious, Start this step with the previous step, this allows two or more steps to execute concurrently with the previous step. If only one step can move work forward then add a rule to close other steps that are open at the same level as this step. Example quotes that are open and you accept one quote, it should decline/cancel the other steps as these will not progress any further.
8 = SkipWhenGroupComplete, Skip this step if the group is complete By setting this mode the system will mark the step skipped if one of hte WithPrevious steps are completed, cancelled, or skipped
16 = StartOn, Case to start the action when another event has occurred. | |
ccRoles | |||
executeStatus | NotStarted
Created
New
InProgress
Rework
Complete
Skipped
Cancelled
Declined
Deleted
Invited
Updated | ||
skipValidation | disables validation in every components that this action sits in | true or false | |
actionInvite | |||
completedName | The name used in the step event when the step completes. | ||
expression | Hides the action button if this expression is not true | e.g. “’{$.taskOne.componentOne}’ == ‘Value’” | Operators used can either be <, >, or ==
Make sure you wrap dataPaths in curly brackets and single quotation marks |
imageName | specify this property if you want the button to be icon | … | |
tooltip | tooltip when you hover the button | ||
PanelConfig | See below |
PanelConfig
Property | What does the property do (in plain english) | Possible values |
allowedCcEmailsDataPath | ||
allowedToEmailsDataPath | ||
ccEmails | show cc email input in the action panel | true or false |
ccEmailsLabel | cc email input label | any string |
message | show message input in the action panel | true or false |
process | shows the progress ui | true or false |
quickSubmit | quick submits the action | true or false |
toEmails | show to email input in the action panel | true or false |
toEmailsLabel | to email input label |
Advanced Editor example of this set up
actionTypeName
DianaWorkAction, Submit = primary colour, Stop = Gray
Icon
Destination
ByEventName
ByStepName