AgileWork - Common Setup

Name

Definition:

The display name for the AgileShape. The name is defined within the source code for the AgileShape. It is visible in the design time properties for information only.

Allowed Values:

Read only.

Property Group:

Basic

(UID)

Definition:

An ID that uniquely identifies this AgileShape from all others within the same process template. The UID is defined within the source code for the AgileShape. It is visible in the design time properties for information only.

Allowed Values:

Read only.

Property Group:

Basic

Description

Definition:

Specifies a free text description of the AgileShape. This property is primarily used as a means of recording additional notes, comments, and details about an AgileShape to make the process model more understandable. This property is ignored at runtime.

Allowed Values:

A free text description.

Default Value:

None

Custom Attributes:

Yes

Property Group:

Basic

Mobile Support

Definition:

Specifies whether users can view the task associated with the AgileWork on a mobile device.

Allowed Values:

• True - Features are enabled to support mobile devices.

  If you select True, you must also set up the mobile view using the Configure Mobile View option.

• False - Features are not enabled to support mobile devices.

Default Value:

False

Property Group:

Basic

Optional

Definition:

Specifies whether the activity represented by this AgileShape can be manually canceled using AgilePoint Enterprise Manager.

Allowed Values:

• True - The activity can be manually canceled.
• False - The activity cannot be manually canceled.

Default Value:

False

Property Group:

Basic

Time Span

Definition:

Specifies the maximum amount of time that should be allowed for the completion of the activity associated with this AgileShape before it is considered overdue. This is an combination of the Length and Time Unit fields.

Allowed Values:

Read Only.

Property Group:

Basic

Business Time

Definition:

Determines whether the time span represents actual time, or business hours only.

Allowed Values:

• True - The time span represents a span of business hours only. For example, 5 days of business time might be equivalent to 7 days of actual time. 8 hours of business time might be equivalent to 24 hours of actual time.
• False - The time span represents actual time. It is unaffected by any business time configuration settings.

Default Value:

False

Example:

The Business Time property is set to True, and business hours are configured as 9 a.m. to 5 p.m. A Manual AgileShape with a Time Span of 6 business hours is entered at 4 p.m. on Tuesday, then the activity must be completed by 2 p.m. on Wednesday.

Property Group:

Basic

Length

Definition:

The number of time units represented by the time span.

If you use a custom attribute in this property, the value can be a number, or a specific date. The value is dynamically determined by the data type of the input field — Integer or DateTime.

If the value is in DateTime format, the Time Unit must be set to Day. Otherwise, the Time Span, and thus the and Length, are ignored at runtime.

Allowed Values:

Any positive integer.

Default Value:

10

Custom Attributes:

Yes

Example:

If the Length is set to 10, and the Time Unit is set to minutes, this indicates 10 minutes. For example, this is determined to determine the deferred time for an email, or to set a delay.

Property Group:

Basic

Time Unit

Definition:

The type of time unit represented by the Time Span property.

Allowed Values:

• Second
• Minute
• Hour
• Day
• Week
• Month

Default Value:

Minute

Property Group:

Basic

Work to Perform

Definition:

Specifies the name of the task that appears 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 AgileShape, this property does not determine the file names for the web form. Instead, use the Web Form URL Window.

Allowed Values:

The values for this property vary, depending on the type of process model you are using:

• Generic - Does the following:
  • Specifies the name that appears in the participant's Task List for this activity.
  • If you create an ASP.NET project for this process in AgilePoint Developer, a new .aspx page is created for each manual activity with the file name equivalent to the value of the Work to Perform property.
• SPList and SPDoc - Specifies the name that appears in the participant's Task List for this activity.
• InfoPath - Does the following:
  • Specifies the name that appears in the participant's Task List for this activity.
  • Specifies the view from the InfoPath form that is associated with the process model. These values are loaded from the InfoPath form.

    It is possible to add a new work performer name. However, this is not recommended. A new name would indicate a different type of form, such as an ASP.NET form. This functionality is technically supported, but you would need to write code to implement it.

• AgileForms - Specifies the name that appears in the participant's Task List for this activity.

  The default value for this field is FormRender. It is recommended to change this value.

Default Value:

None, except for AgileForms process models.

Property Group:

Basic

Activity Entry Message (Email)

Definition:

Specifies the name of an email template used to generate an automatic email notification when this AgileShape is entered at runtime.

Allowed Values:

• An existing email template name - Applies the selected, predefined template to the email.
• Add Mail Template - Opens the Email Template Wizard, where you can add a new email template.
• None - Specifies that no email is sent.

Default Value:

None

Property Group:

Email Notification

Reminder Message (Email)

Opens the Following Window:

Reminding Mail Window

Purpose of this Window:

Specifies the email template and schedule for a reminder email.

Property Group:

Email Notification

Task Completed Message (Email)

Definition:

Specifies the name of an email template used to send a message when a task is completed.

Allowed Values:

• An existing email template name - Applies the selected, predefined template to the email.
• Add Mail Template - Opens the Email Template Wizard, where you can add a new email template.
• None - Specifies that no email is sent.

Default Value:

None

Property Group:

Email Notification

Task Reassigned Message (Email)

Definition:

Specifies the name of an email template used to generate an automatic email notification when this AgileShape is reassigned to new participants at runtime.

Allowed Values:

• An existing email template name - Applies the selected, predefined template to the email.
• Add Mail Template - Opens the Email Template Wizard, where you can add a new email template.
• None - Specifies that no email is sent.

Default Value:

None

Property Group:

Email Notification

Max. Participant

Definition:

Specifies the number of group members who need to be assigned as participants for a work item.

Allowed Values:

• Any positive integer - Specifies a specific number of participants within a group that are required to complete an activity.
• Maximum - Specifies that all members of a group are required to participate.

Default Value:

1

Custom Attributes:

If the Participants property is set to a group of users, and Max. Participant is 2, then 2 members of the group actually are required to participate in the activity.

Property Group:

Participants

Participants

Specifies the users who can be assigned to complete the task.

This property can be set to a specific user, group of users, or a user role. To specify multiple participants, separate the user names with a semicolon (;).

The actual assignments may be determined by the rules defined in your process, or other factors at the time the process is running － for example, participants' current workloads using the Workload Balance AgileShape.

For more information, see Adding Participants to an Activity.

Opens the Following Window:

Participants Window

Purpose of this Window:

Specifies the participants for an activity.

Reuse Participant

Definition:

Specifies whether, if an AgileShape is entered multiple times at runtime, the same participants must complete the activity each time.

Allowed Values:

• True - If an AgileShape is entered multiple times at runtime, the same participants who took assignment the first time are also assigned the activity each subsequent time.
• False - If an AgileShape is entered multiple times at runtime, any participants can take assignment each time.

Default Value:

True

Example:

A review activity, has participants Ann, Bob, Carol, and Don. Max. Participant is set to 2, and Reuse Participant is set to True. Ann and Don are assigned as the participants for the review activity, and they reject the input. Because Reuse Participant is True, the next time the same incoming input routes back to the review activity, the same users, Ann and Don, are again assigned to work on the activity.

Property Group:

Participants

Audit Level

Definition:

Specifies the amount of detailed process-related data that is recorded to the AgilePoint workflow database. This property can be set at either the Process Template Properties level or at the individual AgileShape level.

Allowed Values:

• High - Specifies that AgilePoint will record all data about the activity or process to the database.
  • At the process model level, or at the AgileShape level for manual or automatic activities, all records for manual activities are kept when the process completes.
• Low - Specifies that AgilePoint will only allow a certain amount of data to be recorded to the database. This option enables you to selectively filter out unnecessary data.
  • At the process model level, the records for manual work items with status of Removed and New are deleted from the database. After leaving the manual activity, the manual work items with status of Removed are deleted first, then after the whole process is completed, the manual work items 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 automatic activities at the process model level.

  • At the AgileShape level for automatic activities, the records are deleted from database after leaving the activity. No record are kept 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 manual activity. Manual work items with status of Removed and New are not meaningful data after the process completed.

Setting the Audit Level to Low at the AgileShape level is useful for a Delay AgilePart that goes through a large number of loops. Usually organizations are not interested in the information about the Delay AgilePart, so setting the audit level for Delay AgilePart to Low deletes the records immediately, and the database size will not grow as fast.

Property Group:

Advanced

Auto Complete

Definition:

Specifies whether the status of a work item is set to completed.

Allowed Values:

• True - The first time a work item is entered at runtime, it is automatically marked as completed.

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

• False - A work item is not automatically marked as completed.

Default Value:

False

Property Group:

Advanced

Debug

Definition:

Troubleshoots and monitors the performance of an AgileShape.

Allowed Values:

• True - Indicates that the AgileShape will log 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 AgileShape, or database connection information.

  These messages are often helpful in verifying that the AgileShape is functioning properly and/or with troubleshooting any problems or suspected problems with the AgileShape's runtime behavior or configuration.

• False - Indicates that the AgileShape will not log additional progress and debugging messages to the AgilePoint Server log file at runtime.

Default Value:

False

Custom Attributes:

No

Property Group:

Basic

Priority

Definition:

Specifies the priority level for the task to be shown in the user's task list at runtime.

Allowed Values:

• High - Shows a red icon in the users task list next to the task.
• Normal - Shows a green icon in the users task list next to the task.
• Low - Shows a yellow icon in the users task list next to the task.
• Custom attribute - Sets the priority to a value you specify using a custom attribute.

Default Value:

Normal

Custom Attributes:

Yes

Property Group:

Advanced

SessionMode

Definition:

Specifies how to handle open tasks if the same AgileShape is entered multiple times within a process instance.

Allowed Values:

• Single - If the same AgileShape is entered more than once in a process model, any task that is not complete from a previous iteration are canceled, and a new task is created.
• Multiple - If the same AgileShape is entered more than once in a process model, a new task is created, but any tasks that are not open from previous iterations are not canceled.

Default Value:

Single

Property Group:

Advanced

Wait All Incoming

Definition:

Specifies which direct predecessor AgileShapes to wait for before entering the AgileShape at runtime.

Allowed Values:

• False - Specifies that the AgileShape is entered as soon as any one of the AgileShape's direct predecessors is exited.
• True (Static) - Specifies that the AgileShape is entered only after all of the AgileShape's direct predecessors are exited.
  Note: If any of the direct predecessors are un-enterable, this AgileShape will never be entered, and the process instance may be permanently delayed at this AgileShape.

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

• True (Dynamic) - Specifies that the AgileShape is entered only after all of the AgileShape's direct predecessors are exited that are not bypassed because of the process's logic. If any of the direct predecessors are bypassed, they are ignored by the WaitAllIncoming property. This prevents the process from becoming delayed indefinitely by an AgileShape that cannot be entered.

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

Default Value:

False

Property Group:

Advanced

Wait Work Performed

Definition:

Specifies whether data entry is required before a work item can be completed in Enterprise Manager.

Allowed Values:

• True - Specifies that some data entry is required before an activity can be Complete. If there is a form for a task, then data must be entered in the form.
• False - Specifies that data entry is optional before an activity can be completed in Enterprise Manager.

Default Value:

True

Example:

This property might be set to False if an activity requires some work that does not include data entry, such as delivering items to the post office.

Property Group:

Advanced

Enable Lync

Definition:

Specifies whether the Lync is enabled to send a message.

Allowed Values:

• False - The Lync feature is disabled.
• True - The Lync feature is enabled. This value must be set to True, even if messaging templates are enabled.

Default Value:

False

Reminder Message (Lync)

Definition:

Specifies a reminder message for an overdue task sent via Lync.

Allowed Values:

• Add Mail Template - Opens the Lync Template Wizard, where you can add a new Lync template.
• None - Specifies that no message is sent.

Default Value:

None

Property Group:

Lync

Task Assigned Message (Lync)

Definition:

Specifies the name of a Lync template used to send a message to one or more participants when the task is assigned to them.

Allowed Values:

• Add Mail Template - Opens the Lync Template Wizard, where you can add a new Lync template.
• None - Specifies that no message is sent.

Default Value:

None

Property Group:

Lync

Task Cancelled Message (Lync)

Definition:

Specifies the name of a Lync template used to send a message when a task is cancelled.

Allowed Values:

• Add Mail Template - Opens the Lync Template Wizard, where you can add a new Lync template.
• None - Specifies that no message is sent.

Default Value:

None

Property Group:

Lync

Task Completed Message (Lync)

Definition:

Specifies the name of a Lync template used to send a message when a task is completed.

Allowed Values:

• Add Mail Template - Opens the Lync Template Wizard, where you can add a new Lync template.
• None - Specifies that no message is sent.

Default Value:

None

Property Group:

Lync

Task Reassigned Message (Lync)

Definition:

Specifies the name of a Lync template used to send a message to one or more participants when the task is assigned to them after previously being assigned to another participant.

Allowed Values:

• Add Mail Template - Opens the Lync Template Wizard, where you can add a new Lync template.
• None - Specifies that no message is sent.

Default Value:

None

Property Group:

Lync

Configure Mobile View

Opens the Following Window:

• Mobile View Configuration Window - Form Data Tab - Specifies the non-repeating data fields that appear in a task on a mobile device.
• Mobile View Configuration Window - Repeating Data Tab - Specifies repeating data items to display on a mobile device. Repeating data groups are repeating parent XML nodes with child nodes. A common example would be a parent node called User, with child nodes called First Name, Last Name, Email Address, and so on.
• Mobile View Configuration Window - Task Options Tab - Specifies the user input options for a task on a mobile device.

Property Group:

Mobile

ConfigureAttachments

Opens the Following Window:

Configure Attachments Window

Purpose of this Window:

Specifies files to attach to an AgileShape from a process repository.

Property Group:

Process Repository

Reference URL

Definition:

Associates a URL with an AgileShape or process model in the Process Viewer. Users can click the URL in the Process Viewer to access additional information or resources.

Note: This functionality is not currently supported for AgileXRM.

Allowed Values:

Any URL.

Default Value:

None

Custom Attributes:

Yes

Property Group:

Process Repository

Enable SMS

Definition:

Determines whether the SMS is enabled to send a message.

Allowed Values:

• False - The SMS feature is disabled.
• True - The SMS feature is enabled. This value must be set to True, even if messaging templates are enabled.

Default Value:

False

Reminder Message (SMS)

Definition:

Specifies a reminder message for an overdue task sent via SMS.

Allowed Values:

• Add Mail Template - Opens the SMS Template Wizard, where you can add a new SMS template.
• None - Specifies that no message is sent.

Default Value:

None

Property Group:

SMS

Task Assigned Message (SMS)

Definition:

Specifies the name of an SMS template used to send a message to one or more participants when the task is assigned to them.

Allowed Values:

• Add Mail Template - Opens the SMS Template Wizard, where you can add a new SMS template.
• None - Specifies that no message is sent.

Default Value:

None

Property Group:

SMS

Task Cancelled Message (SMS)

Definition:

Specifies the name of an SMS template used to send a message when a task is cancelled.

Allowed Values:

• Add Mail Template - Opens the SMS Template Wizard, where you can add a new SMS template.
• None - Specifies that no message is sent.

Default Value:

None

Property Group:

SMS

Task Completed Message (SMS)

Definition:

Specifies the name of an SMS template used to send a message when a task is completed.

Allowed Values:

• Add Mail Template - Opens the SMS Template Wizard, where you can add a new SMS template.
• None - Specifies that no message is sent.

Default Value:

None

Property Group:

SMS

Task Reassigned Message (SMS)

Definition:

Specifies the name of an SMS template used to send a message to one or more participants when the task is assigned to them after previously being assigned to another participant.

Allowed Values:

• Add Mail Template - Opens the SMS Template Wizard, where you can add a new SMS template.
• None - Specifies that no message is sent.

Default Value:

None

Property Group:

SMS

Configure Yammer Credentials

Opens the Following Window:

Connecting to Server Window

Yammer Credentials Window

Purpose of this Window:

Specifies the unique identifiers for the Yammer application.

Property Group:

Yammer

Enable Yammer

Definition:

Specifies whether Yammer is enabled to send a message.

Allowed Values:

• False - The Yammer feature is disabled.
• True - The Yammer feature is enabled. This value must be set to True, even if messaging templates are enabled. ​

Default Value:

False

Reminder Message (Yammer)

Definition:

Specifies a reminder message for an overdue task sent via Yammer.

Allowed Values:

• Add Mail Template - Opens the Yammer Template Wizard, where you can add a new Yammer template.
• None - Specifies that no message is sent.

Default Value:

None

Property Group:

Yammer

Task Assigned Message (Yammer)

Definition:

Specifies the name of Yammer template used to send a message to one or more participants when the task is assigned to them.

Allowed Values:

• Add Mail Template - Opens the Yammer Template Wizard, where you can add a new Yammer template.
• None - Specifies that no message is sent.

Default Value:

None

Property Group:

Yammer

Task Cancelled Message (Yammer)

Definition:

Specifies the name of a Yammer template used to send a message when a task is cancelled.

Allowed Values:

• Add Mail Template - Opens the Yammer Template Wizard, where you can add a new Yammer template.
• None - Specifies that no message is sent.

Default Value:

None

Property Group:

Yammer

Task Completed Message (Yammer)

Definition:

Specifies the name of an SMS template used to send a message when a task is completed.

Allowed Values:

• Add Mail Template - Opens the Yammer Template Wizard, where you can add a new Yammer template.
• None - Specifies that no message is sent.

Default Value:

None

Property Group:

Yammer

Task Reassigned Message (Yammer)

Definition:

Specifies the name of Yammer template used to send a message to one or more participants when the task is assigned to them after previously being assigned to another participant.

Allowed Values:

• Add Mail Template - Opens the Yammer Template Wizard, where you can add a new Yammer template.
• None - Specifies that no message is sent.

Default Value:

None

Property Group:

Yammer

AssemblyName

Definition:

The name of the .NET assembly containing the specific AgilePart component with which this AgileShape instance is associated.

Allowed Values:

Read only.

Property Group:

AgilePart

ClassName

Definition:

The fully qualified Type name, including the namespace, of the .NET class (in the .NET assembly specified by the AssemblyName property) that represents the AgilePart component with which this AgileShape instance is associated.

Allowed Values:

Read only.

Property Group:

AgilePart