Creating approval notifications to notify approvers
The following image illustrates the end-to-end process of creating an approval process and approval flows:
You can create notifications to inform the approvers when a new approval request is created, approved, rejected, reassigned, when an error exists in the approval signature, and so on.
To create an approval notification
- Log in to BMC Helix Innovation Studioand navigate to the Administration tab.
- Select Approvals > Notification configuration.
- On Approval notifications, click New.
In the New approval notification window, enter the following details:
Field
Details
Record Definition Name
Select the appropriate record definition.
Notification Name
Enter a name for the notification.
Notify on
Select one of the following approval cycle events that triggers the notification:
- New Signature—A new signature line is added to the approval request.
- Approve—The approval request is approved.
- Reject—The approval request is rejected.
- Reassign—An approval is reassigned to a different approver.
- Error—An error exists in the approval signature.
- Cancel—An approval request is canceled.
- More Info Return—A request for more information is fulfilled.
- Hold—An approval request is put on hold.
- More Info—More information is requested by an approver.
Notification Expression
To specify additional conditions when a notification is sent, click Select to Build an Expression.
The Approval Service uses these conditions in addition to the option you have selected in the Notify On field.
You can use the Foundation data to create the Notification Expression.Approval Flows
Select one or more approval flows that define how the request gets approved.
Send To
Specify the users to whom the notification must be sent by selecting one of the following options:
- All Approvers—The approval service sends notifications to the default recipients for the selected approval cycle
event.
When a request is approved or rejected, the notification is sent based on the Completion Criteria setting in the
selected Wait for Approval Definition.- All Must Approve—The notification is sent to the defined approver and all the other approvers for whom
signature lines have been created. - One Can Approve—The notification is sent only to that approver and not to the other approvers in the
signature line.
- All Must Approve—The notification is sent to the defined approver and all the other approvers for whom
- Other—The approval service sends notifications to the individual or a group that you specify.
Global Notification
Select this field if you want to send the same notification for all the flows configured for that record definition. For a record definition, if both regular notification and global notification are configured, a regular notification is sent.
Notification Method
Select the option that you want to use to send notifications to the users.
- (Default) Email—Use this option to send notifications to a group alias, or an email address. For more information about how to configure email notifications to approve the request, see To configure an email notification.
- Process—Use this option to select the process that triggers the notification when the record instance, condition, and event for the notification is met.
This option provides you the flexibility to plug in any custom notification mechanism and not depend on the process defined by the Approval service.
Important: Make sure that you use the following values while designing your process to trigger the approval notification:- In the Properties section, click Add/Remove Variables.
- Click Add Variable to add the approval event (New Signature, Approve, Reject, and so on) for which the notification will be triggered.
- From Variable Type, select Input/Output Parameter > Input.
- In Data Type, select Text.
- In Variable ID, enter 57040.
- Click Add Variable to add the three-way join record definition for an approval request.
A three-way join record definition contains data from the record definition that is used to determine the status of a request and the record definition is used to review responses to a request.
For example, if the record definition used to determine the status of a request is Approval Detail, the three-way join record definition is Approval Detail Signature.
- From Variable Type, select Input/Output Parameter > Input.
- In Data Type, select Record.
- In Record Definition, select Approval Detail Signature record definition.
- In Variable ID, enter 57000.
- Click Save.
For more information, see Adding-variables-to-processes.
Use Email based Approval template
Select the check box to use an email template for the notification.
This check box is displayed only if you select the Email notification method and New Signature as the value for the Notify On field.(Optional) Subject
Type a subject line for the notification message. You can use this option if you do not want to use the existing approval templates to send email notifications.
Alternatively, click Select to Build an Expression to include record instance variables in the subject line of the notification message.(Optional) Message
Type the message text for the notification. You can use this option if you do not want to use the existing approval templates to send email notifications.
Alternatively, click Select to Build an Expression to include record instance variables in the message text.(Optional) Process Name
Select the process that triggers the notification to the users. This option is displayed only after you select Process option from the Notification Method field.Important: Only the processes for which you have permissions are displayed in the Process Name field.
(Optional) Email Outgoing Profile
Select the profile that uses the corresponding outgoing mailbox to send email notifications. This field is displayed only if you select the Use Email based Approval template checkbox and New Signature as value for the Notify On field.
(Optional) Template
Select the text or HTML templates that can be used to send an email notification. This field is displayed only if you select the Use Email based Approval template checkbox and New Signature as value for the Notify On field.Important: If you do not select any templates, the out-of-the-box approval templates are used to send the notification.
- To activate this notification configuration, select the Enabled box.
- Click Save.
To configure an email notification
For an approve to receive email notifications to approve or reject the requests, as an administrator, you must perform the following configurations:
Configure incoming and outgoing mailbox—Configure the incoming and outgoing mailbox to receive email notifications for approval requests or to send a reply to recipients.
To receive email notifications with the correct approval template, make sure that you update the following fields with specific values while configuring your incoming and outgoing mailbox:
Incoming Mailbox Configuration:Tab
Field
Value
Action Configuration
Email Action
Parse
Use Original Template Format
No
Reply with Result
Yes
Reply with Entry
No
Enable Modify Actions
Yes
Force Default Workflow Form
No
Outgoing Mailbox Configuration:
Tab
Field
Value
Basic Configuration
Associated Mailbox Name
The incoming mailbox that is used to receive replies to the outgoing emails.
Advanced Configuration
Reply To Address
The email address to which the replies must be sent.
- Configure the email profiles—Configure the outgoing profile to select from multiple outgoing mailboxes.
Configure the email templates—Create text or HTML templates that can be used to send notifications in an email.
To avoid errors, do not use the following keywords in an email template. Because these keywords are reserved, their behavior might not be as intended.
- Action
- Form
- Schema
- Login
- User
- User Name
- Name
- Login Name
- Password
- Server
- Language
- Authentication
- TCP Port
- TCP
- RPC Number
- RPC
- Qualification
- Query
- Search
- QueryBar
- Key
- Encryption Key
- Encryption
- Template
- Request ID
- RequestID
- Entry ID
- EntryID
- Header Template
- HeaderTemplate
- Header
- Footer Template
- FooterTemplate
- Footer
- Status Template
- StatusTemplate
- Status
- Result
- TemplateResult
- ResultTemplate
- Format
- Create approval notifications to notify approvers—Notify approvers when a new signature is generated, an approval request is approved, rejected, reassigned, or when an error exists in an approval signature.
To receive approval email notifications, make sure that you update the following fields with specific values while configuring the approval notifications:
Field | Value |
---|---|
Notify On | New Signature |
Notification Method | |
Email Outgoing Profile | Profile that uses the corresponding outgoing mailbox to send email notifications. |