Form to create and modify approval processes
Basic tab
AP:Process Definition form—Basic tab
Fields on the AP:Process Definition form—Basic tab
Field | Description |
---|---|
Process | Enter a name for this process. Process names must be unique and must have no more than 254 characters (including spaces). It is helpful to make the name descriptive of the process's function. |
Form | Select the AR System form that you are connecting to the Approval Server. This becomes the approval request form. You must add the form to the Form tab of the AP:Administration form to make it appear on this menu. |
Type | Select the process type from the available options:
For more information, see Approval-processes. |
Status | Select the process status from the available options:
You might want to set the status to Inactive during the development of the process and the associated rules. When all the appropriate rules are in place, you can modify the process and set the status to Active. Requests related to processes in the Inactive state are displayed on Approval Central, but approvers cannot act upon such requests. The following message is displayed in such an event: However, approvers can take action on requests that are related to processes in the Inactive state from the application's three-way join. To prevent approvers from acting on such requests from the three-way join, developers need to write the appropriate workflow. |
Request Owner Field | Enter a valid AR System user name or select the field that identifies the owner of the approval request from the menu. The fields in this menu are populated from the approval request form. |
First Approver Field | Enter a valid AR System user name or select the field that identifies the first approver for this process from the menu. The fields in this menu are populated from the approval request form. This field is required for Ad Hoc process type, optional if you allow ad hoc overrides, and otherwise unused. |
Generate Preview | Select generate preview setting from the available options:
If you select the On Request Only, On Start of Process, or On Generation or Change to a Signature option, the preview displayed might not be the most current information. |
Can Reassign? | Specify whether approvers should or should not be able to reassign a request of this process type to another approver. |
Full Name Form | Select a form that provides the full name of the approver to be added to the signature line. You could also enter a custom form name by using the adjacent text field. This information is pushed to the Full Name field on the AP:Signature form. |
Exclude User Field | This menu lists all the fields on the application form. Select a field that contains login names. The users from the selected field are excluded from the list of approvers and their signatures are not created for a request of this process type. If the selected field contains a role:
The values in this field are ignored in the following situations:
The check for excluding users from the list of approvers is done before signature creation, therefore it does not impact the requests for which signatures have already been created. |
Approval Success | Select the manner with which the Approval Server determines whether the approval process for a request is complete:
|
If Multiple Approvers | This field applies only if you are defining an Ad Hoc process or are going to allow ad hoc overrides. The value you select determines how many signature line records the Approval Server creates when building an approver list. Specify using the available options how to manage signature entries when a request is assigned to multiple approvers:
If an approver list includes roles, the If Multiple Approver setting for the specific role determines whether the role is expanded into individual signature lines for each member of the role or a single signature line is created for the entire role.
For information about how notifications are sent when a request is approved or rejected, see Form-to-create-and-modify-notifications-sent-by-approval-processes. |
Allow Ad Hoc Next Approver? | This field applies to Parent-Child, Level, and Rule-Based process types. Specify using the available option whether users can add approvers to the approver list for a request:
|
For Self Assignment | This field specifies how the Approval Server determines the next approver, when the requester is not the person who submitted the approval request (for example, when an assistant enters an approval request on behalf of someone else). Select from the available options:
|
Validate Approvers? | This field determines if the Approval Server should verify the value in the next approver field by running the Validate Approver rule. Select from the available options:
|
Require Password? | This field determines whether the approver must enter a password to save changes to an approval request. Select from the available options:
|
Assignee Group Permissions | The AR System populates this field with the Assignee Group for the request; the Public group is selected by default. The Approval Server uses this field to support multi-tenancy for use by application service providers. If you use this field for multi-tenancy support, create workflow to populate this field with the correct assignee group name. You do not need to change this setting when creating the rule. The ID of this field is 112, and it appears on all Approval Server forms. The value of this field is automatically used from records created in the AP:Detail form in all the other Approval Server forms, for example, AP:Signature, AP:More Information. For more information, see Error-333-and-Assignee-Group-Permission. |
Ad Hoc Settings | This field is enabled only if you select:
The options are:
|
Ad Hoc Form | This list displays all the forms in the AR System server. Select the form that you want to be displayed when an approver clicks the Adhoc button on the AP:Show-Detail form. Approvers should be able to provide data about ad hoc approvers in this form, and the form should have the necessary workflow to store this data in the AP:AdhocDetails form. If you select a custom form, make sure that application developers have added the necessary fields and workflow to it. |
Retrieving first approver failed, error? | This field determines the course of action in case the Approval Server fails to retrieve the first approver for a request.
|
Search | Appears in the Search mode; click to search the AP:Process Definition form. |
Save | Appears in the New mode; click to save the entry to the AP:Process Definition form. |
Close | Closes the window without saving. |
Request Owner Field
The setting of this field is crucial for:
- Running the Self Approval rules—The value of this field is compared with the current user's name, and if they match, the rule is executed, otherwise it is skipped.
- Finding the first approval in the approval chain—In the Parent-Child, Level, and Rule-Based process types, the first approver in the chain is completely dependent on the name of the person stored in the field mapped to AP:Process Definition > Request Owner field. The Request Owner field must contain a valid entry in the approval lookup form, for example, AP-Sample:Signature Authority is the lookup form for the Lunch Scheduler sample application. To set an appropriate value for Request Owner field, a process administrator must consider the following information:
- Does this field store the name of the person defined in the approval lookup form?
- Is the organizational structure for this user defined in the approval lookup form? The value of the Request Owner field is not considered when finding the first approver in an ad hoc process because the requester is responsible for specifying all the required approvers.
Full Name Form
If your application does not contain a User form that contains the full name of a person, you should create a custom form that provides this information. The custom form should contain the following character fields, with their input lengths set to 0:
- The field with the ID 10001 contains the login name.
- The field with the ID 10002 captures the full name, which can be generated by any means.
Create a filter on this form, which runs on a service action. This filter uses the data in the first field (10001) as input to generate the corresponding full name for the second field (10002).
Configuration tab
AP:Process Definition form—Configuration tab
Fields on AP:Process Definition—Configuration tab
Field | Description |
---|---|
Process Intervals These fields are used to determine the action date for signatures on a request pertaining to this process. For more information, see Associating-an-action-date-for-a-process-or-signature. | |
Process Due | Enter a number in the Interval field and select the Unit of measurement. This value specifies the total duration in which the process is due. |
Signature Due | Enter a number in the Interval field and the select the Unit of measurement. This value specifies the total duration in which each signature for the process is due. If you enter a value more than what is specified in Process Due, this value is ignored. The value in Process Due is then used to compute the action date, instead of the one you specify in this field. |
Buffer Period | Enter a number in the Interval field and select the Unit of measurement. This buffer period is considered as a delta to be deducted from all process intervals, except Signature Due, when computing the action date. |
Enable Preview | Select Yes to use the Preview feature in calculating the signature due date. The Preview feature is used to fetch information about the future approvers and to calculate the total number of signatures required to complete the process. The Signature Due interval is then computed as the Process Due interval divided by the total number of signatures required. Select No to avoid the use of the Preview feature. In this case, only the value specified in Signature Due is considered. This field is used only in the case of Parent-Child and Level processes. The value of this field is not considered when calculating the Signature Due interval for ad hoc requests. |
Specify menu name to list users for the following operations | |
| Select the menu from which to derive usernames for the corresponding operations. The selected menu determines the list of users that appears when a user creates a More Information request by adding a question or comment, or chooses to reassign a request, or to assign a request to an ad hoc approver. If you do not specify a menu for any of these operations, users do not have the option of selecting names from a user list; they can continue with the operation by manually entering the usernames. |
Rejection Justification | |
Require Justification | Select from the following list to approve or reject a request:
The justification reason is added to the field specified in the Justification Field menu. |
Justification Field | Select the field in which to store the rejection justification. This menu lists Character fields from the application form. Currently, this menu also displays Attachment fields along with Character fields, because of an AR System server issue. From the list of available fields, select a Character field whose length is unrestricted (0 ). Otherwise, if the approver enters a justification of more than 255 characters:* A warning is added to the approval log: The justification is not made available on the application form. If you do not select a field from this menu, the approver's input is stored in the Justification field (ID 14518) on AP:Signature and as a comment of the Justification type on AP:Question-Comment-Info. For more information, see Form-to-provide-justification-for-rejecting-approval-requests. |
Signature Escalations tabs
AP:Process Definition form—Signature Escalations (Normal) tab
The three Signature Escalation tabs (Normal, Urgent, and Low) contain identical fields.
Fields on the AP:Process Definition form—Signature Escalations tabs
Field | Description |
---|---|
Use schedules | |
Business calendar | Use the list to select a workday schedule created on one of the business time workday forms. |
Holiday calendar | Use the list to select a holiday schedule created on one of the business time holiday forms. |
Automatic action | |
After Interval | Type a numeric value to specify the interval before this action is taken. For example, type 2 for two hours or two days. The unit is determined in the next field. This is called the Automatic Action interval, which is used to compute the action date for the corresponding process. |
Unit | Select the unit of Hours or Days as the unit for the interval in the previous field. |
Change State | Use the drop-down list to select the status you want to force on this request if no activity occurs in the interval defined in the two preceding fields. Leave this field and the preceding two fields empty if you do not want the status of a request changed automatically. This reflects on AP:Show-Detail > Action Date field and Approval Central > Action Date column. For more information, see Approval-Central. |
Notifications (Notification: Still Outstanding and Notification: Still in State) are used to determine the escalation or notification mechanism for signatures on a request. | |
Notification: Still Outstanding | |
First Interval | Type a numeric value to specify the interval before this notification first occurs. This is one of the Escalation intervals, which is used to compute the action date for the corresponding process. |
Unit | Select the unit of Hours or Days for the interval in the previous field. This value reflects on Approval Central > Past Due requests > Action Date column. For more information, see Approval-Central. |
Repeat Interval | Type a numeric value for the amount of time to pass before this notification recurs. For example, type a 2 for two hours or two days. The unit is determined in the next field. |
Unit | Select the unit of Hours or Days for the interval in the previous field. |
Notification: Still in State | |
On State | Set the separate escalation and repeat intervals to occur when a form is saved with the status of Pending, Error, Hold, or More Information. |
First Interval | Type a numeric value to specify the interval before this notification first occurs. For example, type a 2 for two hours or two days. The unit is determined in the next field. This value is one of the Escalation intervals, which is used to compute the action date for the corresponding process. |
Unit | Select the unit of Hours or Days for the interval in the previous field. |
Repeat Interval | Type a numeric value for the amount of time to pass before this notification recurs. For example, type a 2 for two hours or two days. The unit is determined in the next field. |
Unit | Select the unit of Hours or Days for the interval in the previous field. |
More Information Escalations tab
You can use the fields on this tab to send a notification to the addressee of the More Information request.
AP:Process Definition form—More Information Escalations tab
Fields on the AP:Process Definition form—More Information Escalations tab
Field | Description |
---|---|
Use schedules | |
Business calendar | Use the list to select a workday schedule created on one of the business time workday forms. |
Holiday calendar | Use the list to select a holiday schedule created on one of the business time holiday forms. |
Notification: still outstanding | |
First interval | Type a numeric value for the amount of time to pass before this action first occurs. For example, type a 2 for two hours or two days. The unit is determined in the next field. |
Unit | Select the unit of Hours or Days for the interval in the previous field. |
Repeat interval | Type a numeric value for the amount of time to pass before this action recurs. For example, type a 2 for two hours or two days. The unit is determined in the next field. |
Unit | Select the unit of Hours or Days for the interval in the previous field. |
Administrative info tab
For information about the Administrative Information tab, see Form-to-create-delete-maintain-and-search-alternative-approvers.