Properties for Human Task Activities

Configures the activity properties for human task activities.

Screen



Good to Know

How to Start

  1. Do one of these:
  2. On the Application Explorer screen, do one of these:
  3. Select a human task 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

Work To Perform

Function:
Specifies the name of the task that shows in a participant's task list.

In most cases, for processes that use ASP.NET forms, this value also determines the file names for the .aspx form pages.

For the Web Form activity, this property does not set the file names for the web form. Instead use the Web Form URL. For more information, refer to Web Form Task (External Forms) activity.

Accepted Values:
The values for this property change with the type of process model you use:
  • Generic - Does this:
    • Specifies the name that shows in the participant's task list for this task.
    • If you create an ASP.NET project for this process in AgilePoint NX Developer, a new .aspx page is created for each human task with the same file name as the value of the work to perform property.
  • SPList and SPDoc - Specifies the name that shows in the participant's task list for this task
  • InfoPath - Does this:
    • Specifies the name that shows in the participant's task list for this task
    • Specifies the view from the InfoPath form for this process. These values are loaded from the InfoPath form.

      You can add a new work performer name. But AgilePoint does not recommend this. A new name indicates a different type of form, such as an ASP.NET form. This functionality is technically supported, but you must write code to use it.

  • eForms - Specifies the name that shows in the participant's task list for this task
Default Value:
None
Accepts Process Data Variables:
No

Optional

Function:
Specifies whether the task can be Cancelled in Manage Center.

For more information, refer to Cancel an Activity from the Manage Center.

Accepted Values:
  • True - The task can be cancelled.
  • False - The task cannot be cancelled.
Default Value:
False

Expected Duration

Function:
Specifies the maximum amount of time that should be allowed for the completion of the task associated with this activity before it is considered Overdue. This is a combination of a number of minutes, hours, days, or weeks.
Accepted Values:
A number of minutes, hours, days, or weeks..

Click the Ellipses button to open the General Configuration screen. Use this screen to complete the Time To Complete field.

Default Value:
1 Day
Accepts Process Data Variables:
No

User Defined Properties

Function:
Specifies ClientData process data variable values that are associated with a human task activity when a process runs. You can specify a set of variables as name/value pairs that are sent to your web forms. This is an alternative to sending data with URL parameters.
Accepted Values:
Click the Ellipses button to open the User Defined Properties screen. Use this screen to complete the fields.
Default Value:
None
Accepts Process Data Variables:
No

Enable Mobile

Function:
Specifie show a human task activity on a mobile device with a special template for mobile view.
Accepted Values:
  • Selected - Features are enabled to support mobile devices.
  • Deselected - Features are not enabled to support mobile devices.

    If you have set up a mobile view, and then deselect this option, your options are saved.

Default Value:
False

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

Reassigning E-mail

Function:
Specifies the name of an activity reassignment e-mail used to generate an automatic e-mail notification when this activity is reassigned to new participants 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

Timeout E-mail

Function:
Specifies the name of an activity overdue e-mail used to create an e-mail notification to send the participant if a task is in Overdue status.
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

Reminding E-mail

Function:
Specifies the name of an e-mail template used to send a message when a task is Overdue.
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

Participants

Field Name Definition

Participant

Function:
Specifies the participants who can be assigned to complete the task.

This property can be set to a specified user, group, or a role.

Accepted Values:
  • Add Participant - Opens the Participants screen, where you can add a participant.
Default Value:
None
Accepts Process Data Variables:
No

Max Participant

Function:
Specifies the number of group members who need to be assigned as participants for a task.
Accepted Values:
  • An integer that specifies a number of participants within a group required to complete a task.
  • Maximum Participants - Specifies that all members of a group are required to participate.

Click the Ellipses button to open the Participants screen. Use this screen to complete the The maximun number of participant to complete this task or Unlimited Participants field.

Default Value:
1
Example:
If the participant is set to a group of users, and Max number of people to complete this task is 2, then 2 members of the group actually are required to participate in the task.

Reuse Participant

Function:
Specifies if, when a activity runs more than one time during a process, the same participants must complete the task each time.
Accepted Values:
  • True - If an activity is runs more than one time, the same participants who took assignment the first time are also assigned the task each time after.
  • False - If an activity is runs more than one time, any participants can take assignment each time.
Default Value:
True
Example:
Ann is part of a group, and takes assignment for a task. She rejects the task. If this field is selected, the next time the process starts this task, the same user, Ann is assigned the task. If this field is deselected, the task goes back into the pool, and anyone in the group can take assignment.

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

Update Custom Attribute

Function:
Specifies a value for a process data variable based on a specified type of event.
Accepted Values:
Click the Ellipses button to open the Update Process Instance Variable screen. Use this screen to complete the fields.
Default Value:
None
Accepts Process Data Variables:
No

Auto Complete

Function:
Specifies whether the status of a task is set to Completed.
Accepted Values:
  • True - The first time a task is entered at runtime, it is automatically marked as Completed.

    If the task is entered again at runtime, it is not automatically marked as Completed. This helps to avoid an infinite loop.

  • False - A task is not automatically marked as Completed.
Default Value:
False
Accepts Process Data Variables:
No

Wait Work Performed

Function:
Specifies whether data entry is required before a task can be completed in Manage Center.
Accepted Values:
  • True - Specifies that some data entry is required before a task can be Completed. If there is a form for a task, then data must be entered in the form.
  • False - Specifies that data entry is optional before a task can be completed in Manage Center.
Default Value:
True
Example:
This property might be set to False if a task requires some work that does not include data entry, such as delivering items to the post office.

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

Priority

Function:
Specifies the importance of a task.
Accepted Values:
  • High - Specifies a high priority task. A high priority task shows High High icon icon.
  • Normal - Specifies a normal priority task. A normal priority task shows Normal Normal icon icon.
  • Low - Specifies a low priority task. A low priority task shows Low Low icon icon.
Default Value:
Normal
Accepts Process Data Variables:
Yes

AgileWork

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.

Mobile

Field Name Definition

Mobile View

Function:
Specifies whether users can view the task associated with the human task activity on a mobile device.
Accepted Values:
Click the Ellipses button to open the Mobile View screen. Use this screen to complete the fields.
Default Value:
None
Accepts Process Data Variables:
No

Yammer

Field Name Definition

Enable Yammer

Function:
Specifies whether Yammer is enabled to send a message.
Accepted Values:
  • True - The Yammer feature is enabled. This value must be set to True, even if messaging templates are enabled.
  • False - The Yammer feature is disabled.
Default Value:
True

Reassigned Message

Function:
Specifies the name of a Yammer template used to send a message when the task is Assigned to new participants.
Accepted Values:
  • An existing Yammer template - Applies the selected, predefined Yammer template.
  • Add New Yammer Template - Opens the Yammer Configuration screen, where you can add a new Yammer template.

Click the Ellipses button to open the Yammer Configuration screen.

Default Value:
None
Accepts Process Data Variables:
No

Assigned Message

Function:
Specifies the name of a Yammer template used to send a message when the task is Assigned.
Accepted Values:
  • An existing Yammer template - Applies the selected, predefined Yammer template.
  • Add New Yammer Template - Opens the Yammer Configuration screen, where you can add a new Yammer template.

Click the Ellipses button to open the Yammer Configuration screen.

Default Value:
None
Accepts Process Data Variables:
No

Completed Message

Function:
Specifies the name of a Yammer template used to send a message when a task is Completed.
Accepted Values:
  • An existing Yammer template - Applies the selected, predefined Yammer template.
  • Add New Yammer Template - Opens the Yammer Configuration screen, where you can add a new Yammer template.

Click the Ellipses button to open the Yammer Configuration screen.

Default Value:
None
Accepts Process Data Variables:
No

Cancelled Message

Function:
Specifies the name of a Yammer template used to send a message when a task is Cancelled.
Accepted Values:
  • An existing Yammer template - Applies the selected, predefined Yammer template.
  • Add New Yammer Template - Opens the Yammer Configuration screen, where you can add a new Yammer template.

Click the Ellipses button to open the Yammer Configuration screen.

Default Value:
None
Accepts Process Data Variables:
No

Overdue Message

Function:
Specifies the Yammer template and schedule for a reminder message.
Accepted Values:
  • An existing Yammer template - Applies the selected, predefined Yammer template.
  • Add New Yammer Template - Opens the Yammer Configuration screen, where you can add a new Yammer template.

Click the Ellipses button to open the Yammer Configuration screen.

Default Value:
None
Accepts Process Data Variables:
No

Chatter

Field Name Definition

Enable Chatter

Function:
Specifies whether Salesforce Chatter is enabled to send a message.
Accepted Values:
  • True - The Chatter feature is enabled. This value must be set to True, even if messaging templates are enabled.
  • False - The Chatter feature is disabled.
Default Value:
True

Cancelled Chatter Template

Function:
Specifies the name of a Chatter template for a message that sends when a task is Cancelled.
Accepted Values:
  • An existing Chatter template - Applies the selected, predefined Yammer template.
  • Add New Chatter Template - Opens the Chatter Configuration screen, where you can add a new Chatter template.

Click the Ellipses button to open the Chatter Configuration screen.

Default Value:
None
Accepts Process Data Variables:
No

Reassigned Chatter Template

Function:
Specifies the name of a Chatter template used to send a message when this activity is assigned to new participants.
Accepted Values:
  • An existing Chatter template - Applies the selected, predefined Yammer template.
  • Add New Chatter Template - Opens the Chatter Configuration screen, where you can add a new Chatter template.

Click the Ellipses button to open the Chatter Configuration screen.

Default Value:
None
Accepts Process Data Variables:
No

Assigned Chatter Template

Function:
Specifies the name of a Chatter template for the message that sends when this activity starts.
Accepted Values:
  • An existing Chatter template - Applies the selected, predefined Yammer template.
  • Add New Chatter Template - Opens the Chatter Configuration screen, where you can add a new Chatter template.

Click the Ellipses button to open the Chatter Configuration screen.

Default Value:
None
Accepts Process Data Variables:
No

Completed Chatter Template

Function:
Specifies a Chatter template for a message that sends when a task is Completed.
Accepted Values:
  • An existing Chatter template - Applies the selected, predefined Yammer template.
  • Add New Chatter Template - Opens the Chatter Configuration screen, where you can add a new Chatter template.

Click the Ellipses button to open the Chatter Configuration screen.

Default Value:
None
Accepts Process Data Variables:
No

Overdue Chatter Template

Function:
Specifies the Chatter template and schedule for a reminder message.
Accepted Values:
  • An existing Chatter template - Applies the selected, predefined Yammer template.
  • Add New Chatter Template - Opens the Chatter Configuration screen, where you can add a new Chatter template.

Click the Ellipses button to open the Chatter Configuration screen.

Default Value:
None
Accepts Process Data Variables:
No