AgilePart - 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

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

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

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

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

Method

Definition:

The name of the method (in the .NET class specified by the ClassName property) that will be invoked when the AgileShape is entered at runtime.

Allowed Values:

Read only.

Property Group:

AgilePart

Optimizing

Definition:

Specifies the action to take when an exception occurs.

Allowed Values:

• Performance - A message from an AgilePart is sent directly to a third-party system without a message queue.

  When this is set, the Retries property is always treated as if the value were 0.

• Scalability - A message from an AgilePart goes through the internal message queue within AgilePoint Server.
• Connectivity - A message from an AgilePart goes through the Azure message queue in the cloud. This requires the AgilePoint Broker to be running in your internal environment.
• Configuration - The value is set based on the value of the process attribute, QueuebaseAgilePartOptimizing. You can set the value of this attribute at the process model, application, or global level to one of the following values:
  • Performance
  • Scalability
  • Connectivity

  To determine the value the process attribute to use, AgilePoint checks QueuebaseAgilePartOptimizing in the following context:

  • [Application].[process model Name].QueuebaseAgilePartOptimizing - The process attribute within the context of a specific process model within a specific application.
  • [Application].QueuebaseAgilePartOptimizing - The process attribute within the context of a specific application.
  • Global.Setting.QueuebaseAgilePartOptimizing - The global process attribute.

Even if this process attribute is set, individual AgileParts can have a different property if desired.

Default Value:

Configuration, or Performance.

If the process attribute QueuebaseAgilePartOptimizing has a value, that value is used, and Configuration is considered the default setting.

If the value of QueuebaseAgilePartOptimizing is not defined, this property is treated as if Performance were the default value.

Custom Attributes:

No, but the Configuration option uses a process attribute to determine its behavior.

Property Group:

AgilePart (Queue Based AgileParts Only)

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

Activity Exit Email

Definition:

Specifies the name of an email template used to generate an automatic email notification when this AgileShape is exited 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

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

ExceptionHandlerScope

Definition:

Specifies whether AgilePoint Server has the ability to call a custom AgileConnector to handle exceptions.

Allowed Values:

• Local - Specifies the exception handling information for an AgileShape is saved to the custom attribute defined in the SaveErrorMessageTo and SaveStatusTo 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

Property Group:

Status and Error Message

SaveErrorMessageTo

Definition:

Specifies a custom process attribute that is updated when the AgileShape throws an error at runtime. A message containing information about the error is stored as the value of the specified custom process attribute.

Allowed Values:

An error message.

Default Value:

ErrorMessage

Property Group:

Status and Error Message

SaveStatusTo

Definition:

Specifies a custom process attribute that is updated when the AgileShape is exited at runtime. The AgileShape's Status property is stored as a String as the value of the specified custom process attribute.

Allowed Values:

The text of a custom process attribute name, without $ or ${. For example, Success is a valid value, but $Success is not.

Default Value:

Success

Example:

A process has a Manual with Timeout AgileShape where SaveStatusTo is set to TimerStatus. At runtime, if the Manual activity is completed before the timer expires, TimerStatus will be set to Complete when the activity exists successfully. If the Manual activity is not completed before the timer expires, TimerStatus will be set to Canceled.

The data from the TimerStatus property could be used to populate other data fields in the process, or for reporting purposes.

Property Group:

Status and Error Message

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

Retries

Definition:

Specifies the number of times to retry an action for a Queue Based AgilePart if it fails.

Allowed Values:

Any integer.

Default Value:

0

Custom Attributes:

No

Property Group:

Status and Error Message (Queue Based AgileParts Only)

HandleException

Definition:

Specifies the action to take when an exception occurs.

Allowed Values:

• Ignore - Writes an error to the error log, and moves the process forward.
• SuspendProcess - Writes an error to the error log and suspends the process.
• UserDefined - Uses a custom dll you provide to determine the appropriate action.

Default Value:

Ignore

Custom Attributes:

No

Property Group:

Status and Error Message (Queue Based AgileParts Only)