Chat now with support
Chat with Support

Identity Manager 8.1 - Configuration Guide

About this guide One Identity Manager software architecture Customizing the One Identity Manager default configuration Adjusting 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
Setting up Job servers in Designer Configuring the One Identity Manager Service Handling processes in One Identity Manager
Tracking changes with process monitoring Conditional compilation using preprocessor conditions Scripts in One Identity Manager Reports in One Identity Manager Adding custom tables or columns to the One Identity Manager schema Web service integration SOAP Web Service One Identity Manager as SPML provisioning service provider Processing DBQueue tasks Appendix: Configuration files of the One Identity Manager Service

Support for processing of scripts in Script Editor

A special input field is used for editing scripts. It has an advanced edit mode which provides additional actions.

To switch to advanced mode

  • Press Ctrl + Alt + Enter or click the button at the bottom right.

Figure 34: Directly Entering a Database Query

Table 151: Meaning of icon in advanced edit mode
Icon Meaning

Quitting advanced edit mode.

Undoes last change.

Redoes last change.

Cuts selected code.

Copies selected code into clipboard.

Inserts code from clipboard.

Deletes selected code.

Decreases insert.

Increases insert.

Shows/hides line numbers.

Inserts code snippet.

Word wrap automatically.

Search within code.

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. To use auto-completion, use the shortcut Ctrl + SPACE in the relevant positions within the input fields. 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. In the Visual Basic category, general code snippets are provided. The Object Layer category 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 icon.
    • Select Object Layer or Visual Basic.
    • Select the code snippet.
  2. Using a shortcut
    • Press F2.
    • Select Object Layer or Visual Basic.
    • Select the code snippet.
  3. Using an aliases
    • Enter an alias.
    • Use Tab to insert the code snippet.

      NOTE: Case sensitivity applied when you enter the alias.

NOTE: If you select a code snippet directly using a shortcut or the icon, a short description and the shortcut name are 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.
Inputting Values using Dollar ($) Notation

In input fields where a VB.NET term is expected, a help list opens when you enter $. All properties of the current object are displayed. You can also see a tooltip with a detailed description of the property. When you select a foreign key (FK) column, you can navigate to the columns in the relevant table using the arrow keys. To end selection in the target column, press Enter or double-click. The complete $ notation for your selection should now be shown in the input column. To close the help list without copying any data, press Esc or leave the input field.

Figure 35: Help List for Dollar Notation

Table 152: Meaning of the symbols used in the help list
Icon Meaning

Property of current object.

Primary key (PK).

Foreign key (FK).

Dynamic foreign key

Table

Special properties

Script

Table 153: Help list functions
Shortcut Action

Down arrow

Opens the help list.

Up arrow, down arrow

Navigate to previous or next entry.

Left arrow, right arrow

Use the foreign key to switch to the parent object or back to the child object.

Enter

Accepts the value in dollar notation.

Creating and editing scripts with the Script Editor

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.

NOTE: You can find detailed examples for syntax and usage of scripts on the installation medium in the directory QBM\dvd\AddOn\SDK\ScriptSamples.

To create a new script

  1. In Designer, select Script Library.
  2. Start the Script Editor using the task Create a new script.
  3. Edit the master data.
    Table 154: Script master data
    Property Description
    Script

    Name of script Label custom scripts with the prefix CCC_.

    Description Detailed description of the script’s function
    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.

    Locked

    Indicates if the script is locked and therefore may not be used. Locking the script is useful, for example, if it is currently being edited.

To edit a script

  1. In Designer, select the script from the Script Library.
  2. Select the task Edit script.
  3. Edit the script master data.
Detailed information about this topic

Copying scripts in the Script Editor

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 copy an existing script

  1. In Designer, select the script that you want to copy from the Script Library.
  2. Select the task Copy script.
  3. In the Copy script dialog, check the following information and correct if necessary.

    Table 155: Copying a Script

    Property

    Description

    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. In the Script Editor, edit the master data of the script.
Related Topics

Testing a script in the Script Editor

You can use the Script Editor to test a script.

To test a script

  1. Select the script in the Script Library in Designer.
  2. Select the task Edit script.
  3. Select the menu item View | Test script.
  4. In the Test script view, select the script from the menu and modify the parameters as required.

    All the parameters to be passed to the script are displayed with their data types. You can edit the values. You can also predefine values for the script base class variables Base and Value as input parameters and use these in the script.

  5. Select one or more options for running the test from Options.
    Table 156: Options for script tests
    Option Description
    Use master connection This option specifies whether the script test is tested against the main database or an internal SQLite database. Scripts that relate to the application part of the One Identity Manager data model should always be tested with the main database. Scripts for system parts can be test with against the main database or the internal SQLite database.
    Use transaction Specifies whether the script is executed within a transaction with subsequent rollback or whether the script is executed immediately against the database.
    Record SQL log Specifies whether the database actions should be recorded in an SQL log while the script is running. The output is displayed in a separate dialog window. The execution time of the script is output in addition to the statement executed.
  6. Select the Start button to run the script test.

    The test results are displayed in the Result field after the script has been run.

Related Topics
Related Documents