Description
The Cancel Process workflow is an out-of-the-box Workflow Definition that is triggered when a process is cancelled. It will notify the configured roles of the cancellation.
Which roles are involved?
| Role | Task | Required |
|---|---|---|
| Steward (default) | Notified of Cancellation | No |
Any role or multiple roles can be notified of the cancellation.
Who can start the workflow?
This workflow is automatically triggered when a process is cancelled.
What status transformations happen in this workflow?
None
Walk Through
Diagram
Start the Workflow
This workflow is automatically triggered when a process is cancelled. There are two ways to cancel a workflow:
- The Data Stewardship Manager
- The Task Notification Ribbon
1) Data Stewardship Manager > Tasks
2) Task Notification Ribbon > Other > Cancel
Result
The result of the the workflow is an email to the configured roles notifying them of the cancellation.
Configuration
Settings > Workflows > Definitions > Cancel Process
Description
Settings > Workflows > Definitions > Cancel Process > Description
This process will be triggered when a process is cancelled. It will notify the configured roles of the cancellation.
Applies To
This Workflow Definition applies at the Global level. This workflow is set to global, but it will not be started from a dashboard. It is only started with a start event.
Settings > Workflows > Definitions > Cancel Process > Applies To
Applies To: Global
Configuration Variables
Settings > Workflows > Definitions > Cancel Process > Variables
Important Variables to Configure:
| Variable | Title | Description |
|---|---|---|
| rolesToNotify | Roles to notify (Comma separated) | Add the roles that need to be notified |
Start Label
The start label is configured in the upper right corner of the page.This is the label that is shown to the users when they are allowed to start the workflow. The name can be changed by pressing the Edit button and filling in a new label.
Settings > Workflows > Definitions > Cancel Process > Start Label
Start Label: Cancel
Start Events
This workflow starts when a workflow is cancelled.
Settings > Workflows > Definitions > Cancel Process > Start Events
Start Events: Workflow Cancelled
Roles
Roles for the workflow are assigned here.
Settings > Workflows > Definitions > Cancel Process > Roles
| Setting | Value | Description |
|---|---|---|
| Start Workflow | Sysadmin | Only the Sysadmin can start the workflow * |
| Stop Workflow | Sysadmin | Only the Sysadmin can stop the workflow once it is started * |
| Reassign Tasks | Sysadmin | Only the Sysadmin can Reassign Tasks once it is started * |
*Because this workflow is triggered with a start event, these roles actually don't determine anything." No Roles Assigned" would have the same result.
Other
There are currently no users assigned in this section either. They do not need to be assigned because this workflow starts based only on a start event.
Settings > Workflows > Definitions > Cancel Process > Other
| Setting | Value |
|---|---|
| Any guest user can start the workflow | No |
| Any signed in user can start the workflow | No |
| Demand exclusivity on resource | No |
| Perform candidate user check on workflow start | Yes |
Attachments:
image2014-5-2 9:34:58.png (image/png)
image2014-5-2 9:49:15.png (image/png)
image2014-5-2 9:52:45.png (image/png)
image2014-5-2 9:53:56.png (image/png)
image2014-5-2 10:6:35.png (image/png)
image2014-5-2 10:8:53.png (image/png)
image2014-5-2 10:9:24.png (image/png)
image2014-5-2 10:10:4.png (image/png)
image2014-5-2 10:12:25.png (image/png)
image2014-5-2 10:12:42.png (image/png)
image2014-5-2 10:13:15.png (image/png)
image2014-5-2 10:16:17.png (image/png)