Cancel Tasks activity

An activity that cancels the activities that are active in a process.


Cancel Tasks activity

Configure the Cancel Tasks activity

To configure the Cancel Tasks activity, do the procedure in this topic.

Good to Know

How to Start

  1. On the App Explorer screen, do one of these:
  2. In the Process Builder, in the Activity Library, open the Utilities tab.

    Open Utilities tab
  3. On the Utilities tab, drag the Cancel Tasks activity onto your process.

    Drag Cancel Tasks activity

Procedure

  1. Complete the fields on the General Configuration screen.

    For more information, refer to Configure General Options for a System Activity.

  2. Click Cancel Tasks Configuration Cancel Tasks Configuration icon
  3. Complete the fields on the Cancel Tasks Configuration screen.

    For more information, refer to Cancel Activities in a Process that are Active.

  4. (Optional) Click Advanced Advanced icon > Email Notifications E-mail Notifications icon.

    For more information, refer to Configure E-mail Notifications for Any Activity.

General Configuration

Specifies the basic settings for the Cancel Tasks activity.

Figure: General Configuration screen

General Configuration screen

Fields

Field Name Definition

Display Name

Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Function:
Specifies an optional text description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

Cancel Tasks Configuration

Specifies the activities to cancel.

Figure: Cancel Task Configuration screen

Cancel Task Configuration screen

Fields

Field Name Definition

All Activities

Function:
Cancels the activities that are active in a process.
Accepted Values:
  • Selected - Specifies that all the activities are cancelled.
  • Deselected - Does not specify to cancel all the activities. You must select any combination of these fields to specify activities to cancel:
    • All Human Tasks
    • All System Activities
    • Specific Activities
Default Value:
Selected

All Human Tasks

Function:
Cancels all the human task activities that are active in a process instance.
Accepted Values:
  • Selected - Specifies that the incoming human task activities are cancelled.
  • Deselected - Does not specify to cancel all human task activities. You select Specific Activities to specify human task activities to cancel.
Default Value:
Deselected

All System Activities

Function:
Cancels all the system activities that are active in a process instance.
Accepted Values:
  • Selected - Specifies that all active system activities are cancelled.
  • Deselected - Does not specify to cancel all system activities. You select Specific Activities, to specify system activities to cancel.
Default Value:
Deselected

Specific Activities

Function:
Cancels the selected activities if they are active in a process instance.
Accepted Values:
  • Selected - Specifies that the selected activities are cancelled if they are active.
  • Deselected - Does not specify to cancel the selected activities. You must select any of the fields to specify activity types to cancel:
    • All Human Tasks
    • All System Activities
Default Value:
Deselected

Activity Name

Function:
Shows the list of activities that can be canceled.
To Open this Field:
  1. On the Configuration window, click Specific Activities.
Accepted Values:
Read only.

Type

Function:
Shows the type of activities that can be canceled.
To Open this Field:
  1. On the Configuration window, click Specific Activities.
Accepted Values:
Read only.

Filter Filter icon

Function:
Shows the items in the list based on the values you enter.
To Open this Field:
  1. On the Configuration window, click Specific Activities.
  2. Click Filter Filter icon.
  3. On the filter screen, select your operator.
  4. Enter the values to show in your list.
Accepted Values:
  • Is equal to
  • Is not equal to
  • Starts with
  • Contains
  • Does not contain
  • Ends with
Default Value:
Is equal to