Properties for System Activities

Configures the activity properties for system activities.

Screen



Good to Know

How to Start

  1. Do one of these:
  2. On the Application Explorer screen, do one of these:
  3. On the Process Builder, select a system activity.
  4. Click Properties Properties icon > Agile Properties Agile Properties icon.

Show Properties

Field Name Definition

Show Properties

Function:
Specifies which activity properties to show.
Accepted Values:
  • All - Shows all the activity properties.
  • Common - Shows the commonly used activity properties.
  • Configured - Shows the activity properties that are configured for the activity.
  • Required - Shows the activity properties that are mandatory.
Default Value:
All

Basic

Field Name Definition

Name

Function:
Shows the name of the activity.

The name is defined within the source code for the activity. It shows the name for your information only.

Accepted Values:
Read only.
Default Value:
The name of the activity.

Display Name

Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.

Click the Ellipses button to open the General Configuration screen. Use this screen to complete the Display Name field.

Default Value:
None
Accepts Process Data Variables:
No

Description

Function:
Specifies an optional text description for your activity.
Accepted Values:
More than one line of text.

Click the Ellipses button to open the General Configuration screen. Use this screen to complete the Description field.

Default Value:
None
Accepts Process Data Variables:
No

Notification

Field Name Definition

Incoming E-mail

Function:
Specifies the name of an activity initiation e-mail used to generate an automatic e-mail notification when the activity starts at runtime.
Accepted Values:
  • An existing e-mail template - Applies the selected, predefined e-mail template.
  • Add new e-mail template - Opens the E-mail Notifications screen, where you can create a new e-mail template.

Click the Ellipses button to open the E-mail Notifications screen.

Default Value:
None
Accepts Process Data Variables:
No

Outgoing E-mail

Function:
Specifies the name of an activity completion e-mail used to send a message when a task is Completed.
Accepted Values:
  • An existing e-mail template - Applies the selected, predefined e-mail template.
  • Add new e-mail template - Opens the E-mail Notifications screen, where you can create a new e-mail template.

Click the Ellipses button to open the E-mail Notifications screen.

Default Value:
None
Accepts Process Data Variables:
No

Advanced

Field Name Definition

Debug

Function:
Tracks the performance of an activity for the purpose of troubleshooting.
Accepted Values:
  • True - Shows that the activity logs the additional progress and debugging messages to the AgilePoint Server log file at runtime. Debugging information includes, for example, data being passed to or from the activity, or database connection information.

    These messages help in verifying that the activity is functioning properly and/or with troubleshooting any problems or suspected problems with the activity's runtime behavior or configuration.

  • False - Shows that the activity does not log additional progress and debugging messages to the AgilePoint Server log file at runtime.
Default Value:
False
Accepts Process Data Variables:
No

Ignore Errors

Function:
Specifies whether to ignore error messages from a PowerShell command.
Accepted Values:
  • True - Ignores error messages from a PowerShell command, and moves to the next command.
  • False - Stops the script execution at the point an error occurs.
Default Value:
False

Wait All Incoming

Function:
Specifies which direct predecessor activities to wait for before starting the activity at runtime.
Accepted Values:
  • False - Specifies that the activity starts as soon as any one of the activity's direct predecessors is Completed.
  • True (Static) - Specifies that the activity starts only after all of the activity's direct predecessors are Completed.All other activities process are ignored.

    This setting is the logically the same as having an And activity with Dynamic set to False.

  • True (Dynamic) - Specifies that the activity starts only after all of the activity's direct predecessors are Completed, along with all preceding activities in the process branch. This setting ignores activities that are skipped or bypassed because of the process logic or manual action in the Manage Center.

    If any of activities in the process branch is delayed or does not start, this activity will not start, the process instance can be delayed indefinitely at this activity.

    This setting is the logically the same as having an And activity with Dynamic set to True.

Example:
This topic gives details and examples for this property's configuration:
Default Value:
False

Audit Level

Function:
Specifies the amount of process related data that is stored to the AgilePoint NX workflow database. You can set this property at either the process template properties level or at the individual activity level.
Accepted Values:
  • High - Specifies that AgilePoint NX stores all data about the activity or process to the database.
  • Low - Specifies that AgilePoint NX will only store limited data to the database. This option enables you to selectively filter out unnecessary data.
    • At the process model level, the records for tasks with status of Removed and New are deleted from the database. After leaving the human task activity, the human task with the status of Removed are deleted first, then after the whole process completes, the tasks with status of New are deleted. Also the records for unreached activity instances are deleted from the database.

      Setting the Audit Level to Low has no effect on system activities at the process model level.

    • At the activity level for system activities, the records are deleted from database after the activity completes. No records are stored for the activity.
Default Value:
High
Example:
Setting the Audit Level to Low at the process model level is useful if you assign a group to a task. Tasks with status of Removed and New are not meaningful data after the process completes.

Setting the Audit Level to Low at the activity level is useful for an activity with a timer that goes through a large number of loops. Usually organizations are not interested in the information about the Timer activity, so setting the audit level for a Timer activity to Low deletes the records now, and the database size does not grow as fast.

Session Mode

Function:
Specifies how to manage an open tasks if the same human task activity runs more than one time within a process instance.
Accepted Values:
  • Single - If the same activity runs more than one time in a process instance, any task that is not complete from a previous iteration are Cancelled, and a New task is created.
  • Multiple - If the same activity runs more than one time in a process instance, a new task is created, but any tasks that are not open from previous iterations are not cancelled.
Default Value:
Single

Dynamic

Function:
Specifies which direct predecessor activities to wait for before starting the activity at runtime.
Accepted Values:
  • True - Specifies that the activity starts only after all of the activity's direct predecessors are Completed, along with all preceding activities in the process branch. This setting ignores activities that are skipped or bypassed because of the process logic or manual action in the Manage Center.

    This setting is the logically the same as setting the Wait All Incoming property for a system activity to True (Dynamic).

  • False - Specifies that the activity starts only after all of the activity's direct predecessors are Completed.All other activities process are ignored.

    If any of activities in the process branch is delayed or does not start, this activity will not start, the process instance can be delayed indefinitely at this activity.

    This setting is the logically the same as setting the Wait All Incoming property for a system activity to True (Static).

Default Value:
True
Accepts Process Data Variables:
No
Example:
These topics give detailed procedures and examples for this property's configuration:

Configuration

Function:
Specifies the process activities to cancel when the process enters the Or activity.
Accepted Values:
Read-only.
Default Value:
Nearest Incoming Activity
Accepts Process Data Variables:
No

Configuration

Function:
Specifies if you can configure the activities to cancel once the process enters the Or activity.
Accepted Values:
  • True - You have the option to cancel the activities you specify.

    However, if this property is set to True, and you do not configure the Or Configuration screen, the activity behaves the same as if this property were set to False.

  • False - You do not have the option to cancel the activities you specify. The activity will continue to handle all the incoming activities.
Default Value:
True
Accepts Process Data Variables:
No

Status And Error Message

Field Name Definition

On Exception Occurred

Function:
Specifies the action to take when an exception occurs.
Accepted Values:
  • Suspend - Writes an error to the error log and suspends the process.
  • Continue - Writes an error to the error log, and moves the process forward.
Default Value:
Suspend.
Accepts Process Data Variables:
No

Save Status To

Function:
Specifies a process data variable that is updated when the activity is exited at runtime. The activity's Status property is stored as a String as the value of the specified custom process attribute.
Accepted Values:
The text of a process data variable name, without $ or ${. For example, Success is a valid value, but $Success is not.
Default Value:
Success

Save Error Message To

Function:
Specifies a custom process attribute that is updated when the activity throws an error at runtime. A message containing information about the error is stored as the value of the specified custom process attribute.
Accepted Values:
An error message.
Default Value:
ErrorMessage

Exception Handler Scope

Function:
Specifies whether AgilePoint Server has the ability to call a custom AgileConnector to handle exceptions.
Accepted Values:
  • Local - Specifies the exception handling information for an activity is saved to the custom attribute defined in the Save Error Message To and Save Status To properties for the process instance.
  • Global - Specifies the exception handling information is handled the same as the Local option, but includes the extended ability to call a custom AgileConnector to handle the exception as desired.
Default Value:
Local

AgilePart

Field Name Definition

Assembly Name

Function:
The name of the .NET assembly that holds the specific system activity component with which this activity instance is associated.
Accepted Values:
Read only.

Class Name

Function:
The fully qualified Type name, including the namespace, of the .NET class (in the .NET assembly specified by the Assembly Name property) that represents the system activity component with which this activity instance is associated.
Accepted Values:
Read only.

Method

Function:
The name of the method that will be invoked when the activity is entered at runtime. The name of the method specified by the Class Name property in the .NET class.
Accepted Values:
Read only.