...
| Field | Description / idea behind |
|---|---|
| id | DB auto incremented ID |
| workflow | defines to which workflow the action belongs. So only the actions for the workflow configured in the task are triggered. Currently the class inheritance hierarchy is reflected here. So for a Workflow class "foo" extending "default" all actions with both values are considered. This behavior will change in the future to enable the possibilty to disable extended default actions by child classes. |
| trigger | The named event trigger to react on. See list of available triggers below. |
| inStep | In step filter: the action is executed only if the tasks workflow is in the configured step. NULL means no filter. |
| byRole | By role filter: the action is executed only if the initiator of the trigger is in the configured role. NULL means no filter. |
| userState | userState filter: the action is executed only if the initiator of the trigger has the configured job status. NULL means no filter. |
| actionClass | the class where the to be called action is contained. Must inherit from "editor_Workflow_Actions_Abstract" class. |
| action | the action to be called |
| parameter | optional additional parameters, which are passed to the executed action. For example Mail notifications can be configured. See details below! |
| position | Order of execution for entries with the same trigger configuration. |
| description | Contains a human readable description for the row |
...
- TODO List all in the core available workflow actions and notifications and explain them (from editor_Workflow_Actions)
- TODO Explain that more Actions can be added by custom Plugins or in the core code
Workflow Mail parameters
Each notification which sends an e-mail can be configured with CC and BCC receivers. They have to be added into the parameters field as JSON.
The JSON may look like:
| Code Block |
|---|
{
"cc": {
"*": ["visiting"],
"reviewing": ["translation", "reviewing"]
},
"bcc": {
"byUserLogin": ["testlector", "testapiuser"]
}
} |
The structure under CC and BCC is basically equal, it is always a string key, pointing to an array.
Basically the key is either the target workflow step name, * for matching all workflow step names, or the special keys "byUserLogin" to provide directly some user logins as additional mail receivers.
The array is containing either the steps which should receive the e-mail, or in the case of byUserLogin just a user login of single users.
Default activated Actions
...