You have the possibility to send a message when a process step has succeeded or when it has failed. Prerequisite for using the notification system is an SMTP host, set up for sending mail and activation of the configuration parameter for mail notification. Use the various configuration parameters for mail notifications for setting up notifications. For more information about configuring the email notification, see the One Identity Manager Installation Guide.
To configure mail notification for a process step
-
In the Designer, select the process in the Process Orchestration category.
-
Start the Process Editor with the Edit process task.
-
Click on the element for the process step in the process document.
-
Select the Process step properties view.
-
On the General tab, enable the Notification (success) and Notification (error) options.
-
Enter the data for sending notifications on the Notification on success and Notification on error tabs.
NOTE: You must enter all data in VB.NET syntax. Use #LD notation for language-dependent formatting of the information.
Table 84: Properties for notifications Property Meaning Sender email address
Email address of the notification sender.
Recipient email address
Email address of the notification recipient.
Subject
Subject line.
Message
The message to be sent.
NOTE: Email notifications are only sent during processing if all the data is entered for a case (failure or success).
Example for configuring an email message
|
Sender email address |
Value = Connection.GetConfigParm("Common\MailNotification\DefaultSender") |
|
Recipient email address |
Value = Connection.GetConfigParm("Common\MailNotification\DefaultAddress") |
|
Subject |
Value = #LD("Error updating the Active Directory user account {0}.", $CanonicalName$)# |
|
Message |
Value = #LD("The user account {0} could not be updated.)# |
The process VID_SendMail (DialogDatabase table) is used to send email notifications from the process handling. This process uses the parameters of the vid_InsertForSendMail database procedure. To customize this process, create a copy of the process and edit it.
TIP:
To send the error messages logged by the One Identity Manager Service in case of an error by email notification, the vid_InsertForSendMail database procedure supplies the pcAdditionalMessage parameter.
To access this functionality, use the variable [AdditionalMessage] when you set up your failure notification message.
Example of a message:
Value = "Process failed." & vbcrlf _
& vbcrlf _
& "------------------------------------------------------------------------" & vbcrlf _
& "[AdditionalMessage]"
