Chat now with support
Chat with Support

Identity Manager 9.2.1 - Configuration Guide

About this guide One Identity Manager software architecture Customizing the One Identity Manager default configuration Customizing the One Identity Manager base configuration One Identity Manager schema basics
Overview of the One Identity Manager schema Table types and default columns in the One Identity Manager data model Notes on editing table definitions and column definitions Table definitions Column definitions Table relations Dynamic foreign key Supporting file groups
Editing the user interface
Object definitions for the user interface User interface navigation Forms for the user interface Statistics in One Identity Manager Extending the Launchpad Task definitions for the user interface Applications for configuring the user interface Icons and images for configuring the user interface Using predefined database queries
Localization in One Identity Manager Process orchestration in One Identity Manager
Mapping processes in One Identity Manager Setting up Job servers
The One Identity Manager Service functionality Tracking changes with process monitoring Conditional compilation using preprocessor conditions Scripts in One Identity Manager
Visual Basic .NET scripts usage Notes on message output Notes on using date values Tips for using PowerShell scripts Using dollar ($) notation Using base objects Calling functions Pre-scripts for use in processes and process steps Using session services Using #LD notation Script library Support for processing scripts in the Script Editor Creating and editing scripts in the Script Editor Copying scripts in the Script Editor Testing scripts in the Script Editor Testing script compilation in the Script Editor Overriding scripts Permissions for running scripts Editing and testing script code with the System Debugger Extended debugging in the Object Browser
One Identity Manager query language Reports in One Identity Manager Adding custom tables or columns to the One Identity Manager schema Web service integration One Identity Manager as SCIM 2.0 service provider Processing DBQueue tasks One Identity Manager Service configuration files

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. For more information about configuring the email notification, see the One Identity Manager Installation Guide.

To configure mail notification for a process step

  1. In the Designer, select the process in the Process Orchestration category.

  2. Start the Process Editor with the Edit process task.

  3. Click on the element for the process step in the process document.

  4. Select the Process step properties view.

  5. On the General tab, enable the Notification (success) and Notification (error) options.

  6. 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]"

Related topics

Running processes automatically

Set up process plans to run cyclical processes to put into effect, for example, regular synchronization with a target system environment. Process plans are connected to schedules and can therefore be run at regular intervals.

The following steps are necessary to run processes automatically:

  1. Creating a process plan

    A process plan contains the basic configuration for automatically running a process.

  2. Setting up and configuring a schedule

    A schedule includes the configuration of activation times for running processes regularly. For more information about schedules, see the One Identity Manager Operational Guide.

Detailed information about this topic

Displaying process plan status

To display the status of process plans

  1. In the Designer, select the Process Orchestration > Process automation category.

  2. Start the editor using the Edit process plans task.

    The list view of the process plan editor shows all process plans with their status.

    Table 85: Meaning of list view icons
    Icon Meaning

    The process plan schedule is not enabled.

    The process plan was run according to plan.

    The process plan was not run. This state can occur if the task could not be run to plan or if the schedule was re-enabled and the time had not been reached for the initial run.

    The current time (server time) does not lie between the start and end times of the schedule.

TIP: To reload the start times of all process plans, use the Process plan > Refresh menu item.

Related topics

Starting a process plan immediately

Process plans are connected to schedules and can therefore be run at regular intervals. If necessary, you can start a process plan immediately.

To start a process plan immediately

  1. In the Designer, select the Process Orchestration > Process automation category.

  2. Start the editor using the Edit process plans task.

  3. Select the process plan and select the Run context menu.

Related topics
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating