Chat now with support
Chat with Support

Identity Manager 8.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 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 Windows 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 SOAP Web Service One Identity Manager as SPML provisioning service provider Processing DBQueue tasks One Identity Manager Service configuration files

Specifying the executing server

You specify which server should handle each process step. You can select the executing server using the server function or a selection script. Server selection should always end with a unique result. The selection script is evaluated first to determine the server. If a server cannot be determined in this way, the server function is analyzed. The first server that is found is used for running the process step.

Detailed information about this topic

Selecting servers with server functions

The most common server functions are predefined, for example, domain controller or SQL processing server. Enter a server function directly if you can determine the server uniquely.

To specify a server using a server function

  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. In the Process step properties view, on the Generation tab in the Server function menu, select the server function.

Related topics

Selecting servers with selection scripts

If it is not possible to decide which server should be used based on the server function (for example, because several SMTP servers exist), you can use a server script for more a detailed evaluation.

To find the server with a selection script, use a VB.Net expression, which:

  • Returns a string with the Job server UID

  • Returns a string with data for a WHERE clause for database queries. The selection must return a string, which begins with WHERE and contains a logical condition. The WHERE clause is applied to the QBMServer table.

Alternatively, you can enter the queue to be handled by the process step directly into the selection script. Each One Identity Manager Service within the network has a unique queue name. Only process steps that have this exact queue name are requested from the Job queue.

Syntax for direct queue input:

DIRECT:<queue>

Example:

Value = "DIRECT:\Server01"

To specify a server using a selection script

  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. In the Process step properties view on the Generation tab in the Script for server selection property, enter the selection script.

Related topics

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 detailed 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
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating