Chat now with support
Chat with Support

Identity Manager 8.0 - Configuration Guide

One Identity Manager Software Architecture Working with the Designer Customizing the One Identity Manager Default Configuration Checking Data Consistency Compiling a One Identity Manager Database Working with Change Labels Basic System Configuration Data
One Identity Manager Authentication Module Database Connection Data Configuration Parameters for System Configuration Setting up the Mail Notification System Enabling More Languages for Displaying and Maintaining Data Displaying Country Information Setting Up and Configuring Schedules Password Policies in One Identity Manager Reloading Changes Dynamically TimeTrace Databases Machine Roles and Server Functions Files for Software Update Operating Systems in Use System Configuration Reports Using Predefined Database Queries Managing Custom Database Objects within a Database
The One Identity Manager Data Model Granting One Identity Manager Schema Permissions Working with the User Interface
Object definitions for the User Interface User Interface Navigation Forms for the User Interface Statistics in the 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 Language Dependent Data Representation
Process Orchestration in One Identity Manager
Declaring the Job Server One Identity Manager Service Configuration Handling Processes in the One Identity Manager
Tracking Changes with Process Monitoring Conditional Compilation using Preprocessor Conditions One Identity Manager Scripts Maintaining Mail Templates Reports in the One Identity Manager Custom schema extensions Transporting One Identity Manager Schema Customizations Importing Data Web Service Integration SOAP Web Service One Identity Manager as SPML Provisioning Service Provider Searching for Errors in the One Identity Manager Processing DBQueue Tasks One Identity Manager Configuration Files

Support for Scripting

Additional input aids are provided for creating script code.

Syntax Highlighting

The input fields support syntax highlighting depending on the syntax type.

Auto-Completion

Auto-completion can be used when creating script code. The amount of scripted code to enter is reduced by displaying the names of properties or functions that can be used. Automatic completion is called with the key combination CTRL + SPACE at the appropriate point in the editor. The contents of the list is determined by the key words in the code.

Entering Code Snippets

Input fields that required data in VB.Net syntax support code snippets. Standard code snippets are available in the option "Visual Basic". The option "Object layer" contains special code snippets for the One Identity Manager object layer.

You can insert code snippets using the following options:

  1. Using the icon
    • Select the in the menu bar.
    • Select the option "Object layer" or "Visual Basic".
    • Select the code snippet.
  2. Using a shortcut
    • Press the F2 key.
    • Select the option "Object layer" or "Visual Basic".
    • Select the code snippet.
  3. Using an aliases
    • Enter an alias.
    • Use Tab to insert the code snippet.

      NOTE: Remember that the connection name is case sensitive.

NOTE: If you select the code snippet using a shortcut or the icon, a short description and the shortcut name is displayed in a tooltip.

TIP: You can use custom code snippets. To do this, create a directory CustomSnippets in the One Identity Manager installation directory to store the code snippets. Use Visual Studio documentation to develop your own code snippets.

Editing Scripts

Scripts are displayed in the category Script Library in the Designer. Scripts are organized into the subcategories custom, product dependent and general usage scripts. You can gather all the information about usage, for example, in column definitions, processes or other scripts, in the script overview.

Use the Script Editor to create and edit your scripts.

IMPORTANT: After creating and editing the script, you should test compiling the script. Compile the scripts in the script library for this script to take effect.

To create a new script

  1. Select the category Script Library in the Designer.
  2. Start the Script Editor using the task Create a new script.
  3. Edit the master data.
    Table 272: Script Master Data
    Property Description
    Script

    Name of script. Label custom scripts with the prefix "CCC_".

    Description Detailed description of the script's funcionality.
    Script code One Identity Manager scripts are written in VB.Net syntax, which allows all VB.Net functions to be used. The values to be edited are given as preprocessor instructions. You can find detailed examples for syntax and usage of scripts on the installation medium in the directory QBM\dvd\AddOn\SDK\ScriptSamples.

To edit a script

  1. Select the script in the category Script Library in the Designer
  2. Select the task Edit script 'name of script'.
  3. Edit the script master data.

To copy an existing script

  1. Select the script you want to copy in the category Script Library in the Designer.
  2. Select the task Copy script 'name of script'.

    This starts the Script Editor and opens the dialog box "Copy script".

  3. Verify the following data and it necessary.

    Table 273: Copying a Script
    Old script name Name of the copied script.
    Script The name of the new script is made up of the prefix "CCC_" and the name of the old script. You can change the name. Label custom scripts with the prefix "CCC_".
    Script code The script code from the original is copied over. If necessary, you can modify the script code of the script to copy beforehand.
  4. To create the copy, click OK.
  5. Edit the script master data.
Detailed information about this topic

Overriding Scripts

You might want to label scripts for overriding if there are limits to how much you can modify default scripts. Scripts, which can be overridden are labeled with the property "overridable".

NOTE: Only the default scripts that are supplied can be overriden. Custom scripts cannot be overridden because these are saved in the script class 'Custom scripts'.

To override a script

  1. Select the script to override in the category Script Library | Overridable scripts in the Designer.
  2. Select the task Copy script 'name of script'.
  3. This starts the Script Editor and opens the dialog box "Copy script".
  4. Modify the following data:
    • Script name

      The new script name is made up of the old script name. You can change the name.

  5. To create the copy, click OK.
  6. Replace the property "overridable" with "overrides" in the script header.
  7. Modify the other script code accordingly to suit your requirements.

IMPORTANT: After creating and editing the script, you should test compiling the script. Compile the scripts in the script library for this script to take effect.

Syntax example

Public overridable Function My_Function() as Boolean

'script code of the original version

End Function

Public overrides Function My_Function() as Boolean

'Custom script code

End Function

Related Topics

Testing Script Compilation

If you have created a new script, you need to compile it. The script is not executable until it has been compiled. You can test script compilation in the Script Editor.

To test compiling scripts

  • Select the script in the category Script Library in the Designer
  • Select the task Edit script 'name of script'.
  • Start compilation with the icon , menu item Script | Compile script or F9.

All scripts are converted during compilation. The assemblies are created and placed on the workstation where generating will take place. During the conversion, the script code is tested for validity. This process may required some time.

Error messages are sent to the "Compiler error" view. A double-click on the error message takes you straight to the corresponding line in the script code view where you can edit it. It can be modified at this point.

IMPORTANT: Once you have tested the script it needs to be added to the One Identity Manager database and compiled with the Database Compiler.

Related Topics
Related Documents