AgilePart

This is a generic AgileShape that can be associated with any AgilePart that is registered in AgilePoint Envision. The user will be prompted to select a specific AgilePart when this AgileShape is added to a process template.

Note: Custom AgilePart components must be registered in AgilePoint Envision before they can be used in a process template.

AgilePart Properties

Note: The following properties are always available for all instances of the AgilePart AgileShape. However, additional design-time properties will often be available for specific instances of the AgilePart AgileShape. The names, purposes, effect, and availability of these additional design-time properties will depend upon the specific .NET class associated with the AgilePart AgileShape instance

Field Name	Definition
(Name)	Read Only Default value: AgilePart.xxx, AgileWork The display name of the AgileShape.
(UID)	Read Only Default value: AgilePart.xxx or AgileWork The ID that uniquely identifies this AgileShape from all others within the same process template.
Description	Optional Note: This property is ignored at runtime. A free text description. This property is primarily used as a means of recording additional notes, comments, and details about this AgileShape in order to make the process template more understandable to process modelers. You can use Custom Attributes in this field.
Debug	Default value: False This property enables you to monitor the performance of and troubleshoot a particular AgileShape. Setting this property to True adds information to the AgilePoint Server log regarding this shape – for example, data being passed to or from the shape, or database connection information. You can use this data to monitor the performance of particular AgileShapes. This property can be set to the following specific values: False - This value indicates that the AgileShape will not log additional progress and debugging messages to the AgilePoint Server log file at runtime. True - This value indicates that the AgileShape will log additional progress and debugging messages to the AgilePoint Server log file at runtime. 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.
TimeSpan	Default value: 10 Minute(s) 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.
BusinessTime	Default value: False Determines whether the time span represents normal time, or business hours only. This property can be set to the following specific values: True - When set to this value, the time span represents a span of business hours only. E.g. 5 Days of business time would normally be equivalent to 7 Days of normal time, and 8 hours of business time would normally be equivalent to 24 hours of normal time. As an example, if business hours are configured as 9am to 5pm and a Manual AgileShape activity with a TimeSpan of 6 Business Hours is entered at 4pm on Tuesday, then the activity must be completed by 2pm on Wednesday. False - When set to this value, the time span represents a normal (absolute) time span, and is unaffected by any business time configuration settings.
Length	Default value: 10 The number of time units represented by the time span.
Time Unit	Default value: Minute The type of time unit represented by the time span. This property can be set to the following specific values: Second Minute Hour Day Week Month
Activity Entry Email	Optional The name of an Email Template that should be used to generate an automatic email notification when this AgileShape is entered at runtime. If this property is left blank, then an email notification will not be sent automatically when the AgileShape is entered at runtime. If this property is not blank, then an email notification will be dynamically constructed and sent at runtime (when the AgileShape is entered) using the specified Email Template.
Activity Exit Email	Optional The name of an Email Template that should be used to generate an automatic email notification when this AgileShape is exited at runtime. If this property is left blank, then an email notification will not be sent automatically when the AgileShape is exited at runtime. If this property is not blank, then an email notification will be dynamically constructed and sent at runtime (when the AgileShape is exited) using the specified Email Template.
Audit Level	Default value: High This property determines the amount of process related data that is recorded to the workflow database. This property can be set at either the Process Template Properties layer or at the individual AgileShape layer. This property allows you to control the level of granularity in terms of the amount of process related data that is recorded to the workflow database. This property can be set to the following specific values: High - This value indicates that AgilePoint will record all data about the activity or process to the database. Low - This value indicates that AgilePoint will only allow a certain amount of data to be recorded to the database. This option provides a level of control over the granularity of AgilePoint process-related data that is stored in the AgilePoint workflow database, giving some flexibility in the audit trail records by filtering out unnecessary data. Audit level at Process Template level Manual activity (Generic manual activity and AgileWork) - After the process is completed (reaches \'91STOP' activity): If audit level is set to high all records will be kept at the movement of process completion. If audit level is set to low, the records for manual work items with status of 'Removed' and 'New' will be deleted from the database. After leaving the manual activity, the manual work items with status of 'Removed' will be deleted first, then after the whole process is completed, the manual work items with status of 'New' will be deleted. Also the records for unreached activity instances will be deleted from the database. For example, this is useful if you assign a group to this manual activity. Manual work items with status of 'Removed' and 'New' are not meaningful data after the process completed. Automatic activity - Not supported for now. No action will be taken. Audit level at AgileShape level - Manual activity (Generic manual activity and AgileWork) - If audit level is set to high, all records will be kept at the movement of leaving the activity. Note that one manual activity can have multiple work items at a time. Automatic activity (AgilePart only, not including AgileStub) - If audit level is set to high, all records will be kept at the movement of leaving the activity. If audit level is set to low, the record of auto work item will be deleted from database after leaving the activity. No record will be kept for this particular activity. For example, this is useful if you have a 'Delay' AgilePart that goes through a large number of loops. Usually customers are not interested in the information about the 'Delay' AgilePart, so setting the audit level for 'Delay' AgilePart to low, will delete the record immediately and the database size will not grow as fast.
SessionMode	Default value: Single This property can be set to the following specific values: Single - If it is set to single, then ONLY one session is effective, meaning that in a loop scenario as shown below, the engine would cancel a task from the previous session automatically. Multiple - If it is set to multiple, then multiple sessions can be effective in a loop scenario, and the process will wait for all tasks to complete and not cancel any previous tasks.
Wait All Incoming	Note: This property is ignored at runtime unless the AgileShape has multiple In-Connectors. Default value: False When an AgileShape has multiple direct predecessors (i.e. it has multiple In-Connectors leading directly from other AgileShapes), this property determines how many of the predecessor AgileShapes must be exited (at runtime) before this AgileShape can be entered (at runtime). This property can be set to the following specific values: False - This value indicates that the AgileShape will be entered (at runtime) as soon as any one of the AgileShape's direct predecessors are exited (at runtime). Note: This value is functionally equivalent to using the Or AgileShape (with Exclusive property set to False) between this AgileShape and its direct predecessors. True (Dynamic) - This value indicates that the AgileShape will be entered (at runtime) only after all of the AgileShape's "enterable" direct predecessors are exited (at runtime). If any of the direct predecessors are un-enterable (e.g. they will never be entered in this process instance because conditional logic in the process bypassed them) and therefore un-exitable, then those predecessors are not required to be exited before this AgileShape is entered. Note: This value is functionally equivalent to using the And AgileShape (with the Dynamic property set to True) between this AgileShape and its direct predecessors. True (Static) - This value indicates that the AgileShape will be entered (at runtime) only after all of the AgileShape's direct predecessors are exited (at runtime). Note: This value is functionally equivalent to using the And AgileShape (with the Dynamic property set to True) between this AgileShape and its direct predecessors. Note: If any of the direct predecessors are un-enterable (see above), then this AgileShape will never be entered, and the process instance may be permanently delayed at this AgileShape.
AssemblyName	Read Only Default value: Automatically determined (based upon the user's input) when the AgileShape is first added to the process template. The name of the .NET assembly containing the specific AgilePart component that this AgileShape instance is associated with.
ClassName	Read Only Default value: Automatically determined (based upon the user's input) when the AgileShape is first added to the process template. The fully qualified Type name (including the namespace) of the .NET class (in the .NET assembly specified by the AssemblyName property) that represents the specific AgilePart component that this AgileShape instance is associated with.
Method	Read Only Default value: Automatically determined (based upon the user's input) when the AgileShape is first added to the process template. The name of the method (in the .NET class specified by the ClassName property) that will be invoked at runtime (when the AgileShape is entered).
ConfigureAttachments	Allows you to attach documents to the activity that are accessed from the process repository. (For more information, see Process Repository.) If you select the View check box and you are using SharePoint Integration, you can the attachments also display in the process model in SharePoint.
Reference URL	Allows you to associate an URL to the shape that is used in the process repository. For more information, see Process Repository.
ExceptionHandlerScope	Default value: Local Specifies the value which determines how AgilePoint Server will handle an AgilePart exception. Two options are available: Local or Global. Local - This value indicates the exception handling (i.e., error message and status) information for an AgilePart within a single process instance will be saved to the custom attribute defined in the SaveErrorMessageTo and SaveStatusTo properties. Global - This value indicates the exception handling (i.e., error message and status) information is handled the same as the Local option, but includes the extended ability to call on a custom AgileConnector to handle the exception as desired.
SaveErrorMessageTo	Default value: ErrorMessage Specifies the name of a custom process attribute that should be updated if the AgileShape causes an error at runtime. If such an error occurs, a message containing information about the error will be stored in the custom process attribute specified by this property.
SaveStatusTo	Default value: Success Specifies the name of a custom process attribute that should be updated when the AgileShape is exited. When the AgileShape is exited at runtime, the value of the AgileShape's Status property will be stored (as a String) in the custom process attribute specified by this property.

Parent topic: Generic BPM