Notifications about Process Step Handling
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.
To configure mail notification for a process step
- Open the process in the Process Editor.
- Click on the element for the process step in the process document.
- Set the options Notification (success) and Notification (error) on the General tab.
- Enter data for sending notifications on the Notification on success and Notification on error tabs.
Table 228: Notification Properties Property Meaning Sender email address Email address whoever sent the message. Recipient email address Email address of the recipient of the message. Subject Subject of the email. Message The message to send. NOTE: All data must be entered in VB.Net syntax. Use #LD notation for language dependent formatting of the information.
NOTE: Messages are only sent during processing if all the data is entered for a case (failure, 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 (table DialogDatabase) is used to send email notifications from the process handling. This process uses the parameters of the database procedure vid_InsertForSendMail. To customize this process, create a copy of the process and edit it.
|
|
TIP: The database procedure vid_InsertForSendMail provides the parameter pcAdditionalMessage for sending error messages by email which have been logged by the One Identity Manager Service. 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]" |
Related Topics
Process Step Parameters
When you select a process task you specify which action will be executed by the process step. The process task parameter templates are copied to the process step as parameters. This means that every process step that uses this process task can pass other parameter values. The original is not altered.
Compulsory parameters are immediately entered into the process step when the process task is selected.Then, you need to enter any optional parameters individually. When a parameter is added, the value template is copied from the parameter template. Templates for parameter values are mostly predefined, for example, procedures that evaluate object UIDs and note them accordingly.
Detailed information about this topic
Editing Process Step Parameters
To edit process step parameters
- Open the process in the Process Editor.
- Click on the element for the process in the process document.
- Select the Parameter view.
This displays all the parameters defined for the process.
- Check whether the required parameters are assigned and edit the parameters.
You can add, delete and edit parameters.
TIP: You can directly edit the parameters directly by simply clicking once on the entry.
Table 229: Meaning of Icon Used Icon Meaning Mandatory process task parameter. Optional process task parameter which is assigned to the process step. Optional process task parameter which is not assigned to a process step. Table 230: Parameter Properties Property Meaning Name Name of the parameter.
NOTE: The name of a parameter should not be changed. The parameter for the process component "HandleObjectComponent" is an exception to this.
Hidden This option specifies whether the parameter is shown in the One Identity Manager Service log file and in the program "Job Queue Info". Values for hidden parameters are shown as <HIDDEN>. Only "viadmin" system users have permission to see these parameters in Job Queue Info. Encrypted Specifies whether the parameter is encrypted when passed (assuming the database is encrypted). Encrypted parameters are shown as <HIDDEN> in the One Identity Manager Service log file and in the program "Job Queue Info".
NOTE: If the option is already set in the parameter template, the parameter should also be encrypted when it is passed.
Contains encrypted components Specifies whether encrypted sequences are contained in this value. Use this option to pass complex parameter (for example, PowerShell scripts) containing encrypted sequences (for example, passwords). Encrypted parts of a parameter are shown as <HIDDEN> in the One Identity Manager Service log file and in the program "Job Queue Info". Value template Define value templates in VB.Net syntax. When a parameter is added, the value template is copied from the parameter template.
NOTE: You can restore default value templates in the Process Editor. Select the
button in the View | Parameter menu and click in the parameter's edit view on the Template.
Type Type of parameter. The values IN, OUT and INOUT are permitted. Parameters of type OUT and INOUT are parameters which a process component can use to output a value. This value is then available to subsequent process steps in the process and can be used as a value for IN parameters.
Related Topics
Allocating Parameter Values
Define value templates in VB.Net syntax. The following statements can be used for allocating values:
- None
- Object columns or columns of a related object
Syntax:
Value = $<column name>:<data type>$
Value = ${FK(<foreign key column>).}<column name>:<data type>$
Example:
Value = $Lastname$
Value = $PasswordNeverExpires:bool$
Value = $FK(Ident_Domain).Description$
- Parameter from the optional parameter collection
Syntax:
Value = $PC(<parameter name>)$
Example:
Value = $PC(SRCUID_Application)$
- Out parameter
Parameters of type "OUT" or "INOUT" are parameters that can be used by process components to output a value. This value is then available to subsequent process steps in the process and can be used as a value for IN parameters.
When you use OUT parameters you need to take care that these contain data at runtime. Alternatively, when the text is processed "&OUT(<parameter name>)&" is entered, which means that the variable will not be replaced.
Syntax:
Value = "&OUT(<Parameter name>)&"
Example:
Value = "&Out(FileSize)&"
- Global variables owned by the set up program
Syntax:
Value = Variables("<variable name>")
Example:
Value = Variables("GENPROCID")
Value = Variables("FULLSYNC")
- Process or process step variables created locally by a pre-script
Syntax:
Value = values("Name")
Example:
Value = Values("FirstHomeServer")
- Querying Configuration Parameters
The full path for the configuration parameter always has to be entered.
Syntax:
Value = Session.Config().GetConfigParm("<full path>")
Example:
Value = Session.Config().GetConfigParm("TargetSystem\ADS\RestoreMode")
- VB.net
Enter any VB.Net statement.