Chat now with support
Chat with Support

Identity Manager 9.2 - 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 Processing DBQueue tasks One Identity Manager Service configuration files

Using #LD notation in process tracking

For language-dependent representation of process information, a relevant template must be defined to display the captions in the active languages.

The captions for language-dependent text are entered in DialogMultiLanguage when the script is compiled. A key (column Entrykey), the language and the translation (column EntryValue) are entered into the table. The key should be in the corresponding default language. If a language caption has not been entered, the key is used as the display text. Use the Language Editor to add translations for the captions in other languages.

Example:

A change is made to an identity. The language-dependent process information could be formulated as follows:

  • Value template for the process information on the Update event

    Value = #LD("Change of properties of identity {0}.", $InternalName$)#

  • Templates for the display texts in the DialogMultiLanguage table

    Key

    Language

    Value

    Change of properties of identity {0}.

    English - United States [en-US]

    Change of properties of identity {0}.

    Change of properties of identity {0}.

    German - Germany [de-DE]

    Änderung der Daten der Person {0}.

With InternalName = UserA, the following display texts are produced in the process view.

Current user's language

Display text in the process view

English - United States [en-US]

Change of properties of identity UserA.

German - Germany [de-DE]

Änderung der Daten der Person UserA.

Related topics

Example of specifying the language or language code

#LD notation supports the specification of a language or language code. This is particularly useful in cases where users need to receive system messages in their preferred language.

Examples

  • Output in the default language:

    Value = #LD("Test: {0}", <parameter>)#

    Value = #LD[""]("Test: {0}", <parameter>)#

  • Output always in English

    Value = #LD["en-US"]("Test: {0}", <parameter>)#

    Value = #LD["english"]("Test: {0}", <parameter>)#

  • Using a variable:

    Dim lang As String = "en-US"

    Value = #LD[lang]("Test: {0}", <parameter>)#

You do not need to enter the language in square brackets, it is optional. However, it is important that the language statement is a String expression. If the language is not specified or the resulting String expression is empty or Nothing, the language currently set for the application is used for translation.

Script library

The script library contains source code for the scripts used in One Identity Manager. The default scripts that we supply cannot be edited. These scripts are overwritten during schema installation even if they are used in custom scripts.

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

Scripts are displayed under Script Library in the Designer. 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, edit, and test scripts. To use Visual Studio's more extensive debug and edit options, edit, and test the scripts in the System Debugger.

NOTE: Scripts for synchronization projects from the Synchronization Editor's script library are not available in the Designer. For more information about the Synchronization Editor script library, see the One Identity Manager Target System Synchronization Reference Guide.

Detailed information about this topic

Support for processing scripts in the Script Editor

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

To switch to advanced mode

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

Figure 30: Directly entering a database query

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

Quits 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.

Automatic text formatting.

Formats text selection automatically.

Shows/hides line numbers.

Inserts comments.

Removes comments.

Inserts or removes line numbers.

Inserts or removes automatic line breaks.

Enable or disable automatic completion of words when they are entered.

Shows or hides spaces and tabs.

Searches within code.

Inserts code snippet.

Shows list of objects properties.

Shows auto completion list.

Shows list with parameter information.

Shows additional information.

Table 137: Shortcut for editing scripts

Shortcut

Description

Ctrl + C

Copy to clipboard.

Ctl + Ins

Copy to clipboard.

Ctrl + X

Cut and copy to clipboard.

Shift + Del

Cut and copy to clipboard.

Ctrl + L

Cut row and copy to clipboard.

Ctrl + V

Paste from clipboard.

Shift + Ins

Paste from clipboard.

Ctrl + Y

Redo action.

Ctrl + Shift + Z

Redo action.

Ctrl + Z

Undo action.

Backspace

Remove character behind cursor.

Shift + Backspace

Remove character behind cursor.

Ctrl + Backspace

Remove word behind cursor.

Del

Delete character in front of cursor.

Ctrl + Shift + L

Delete row.

Ctrl + Del

Delete to end of next word.

Data

Insert line break.

Shift + Return.

Insert soft line break.

Ctrl + Return

Insert row above.

Ctrl + Shift + Return

Insert row below.

Ctrl + Space

Auto-complete.

Ctrl + Space + Space

Show list with parameter information.

Tab

Insert indent/tab.

Shift + Tab

Remove indent/tab.

Ctrl + U

Change marked characters to lowercase.

Ctrl + Shift + U

Change marked characters to uppercase.

Ins

Toggle insert mode.

Ctrl + T

Swap characters in front and behind cursor.

Ctrl + Shift + T

Swap words in front and behind cursor.

Shift + Alt + T

Swap row with previous row.

Alt + PgUp

Move row up.

Alt + PgDn

Move row down.

PgUp

Move up

PgDn

Move down.

Left arrow

Move left.

Right arrow

Move right.

Ctrl + Left arrow

Move to previous word.

Ctrl + Right arrow

Move to next word.

Home

Move to start of line.

End

Move to end of line.

Ctrl + Home

Move to start of script.

Ctrl + End

Move to end of script.

PgDn

Move up a page.

PgUp

Move down a page.

Ctrl + PgUp

Move to visible start.

Ctrl + PgDn

Move to visible end.

Ctrl + ]

Move to next bracket. (not possible on German keyboard)

Ctrl + Down arrow

Scroll down.

Ctrl + Up arrow

Scroll up

Ctrl + F

Open search dialog.

F3

Search next.

Ctrl + F3

Search forward.

Shift + F3

Search backward.

Ctrl + Shift + F3

Find previous.

Ctrl + H

Replace.

Ctrl + I

Search forward incrementally.

Ctrl + Shift + I

Search backward incrementally.

Ctrl + Shift + Num-

Reduce code block selection.

Ctrl + Shift + Num+

Extend code block selection.

Esc

Remove selection.

Shift + Down arrow

Extend selection down.

Shift + Up arrow

Extend selection up.

Shift + Left arrow

Extend selection left.

Shift + Right arrow

Extend selection right.

Ctrl + Shift + Left arrow

Extend selection to previous word.

Ctrl + Shift + Right arrow

Extend selection to next word.

Shift + Home

Extend selection to start of line.

Shift + End

Extend selection to end of line.

Shift + Alt + Home

Extend selection to start of script.

Ctrl + Shift + End

Extend selection to end of script.

Shift + PgUp

Extend selection by one page up.

Shift + PgDn

Extend selection by one page down.

Ctrl + Shift + PgUp

Extend selection to visible start.

Ctrl + Shift + PgDn

Extend selection to visible end.

Ctrl + A

Select all.

Ctrl + Shift + W

Select word.

Ctrl + Shift + ]

Select up to the next bracket. (not possible on German keyboard)

Shift + Alt + Down arrow

Extend selected block down.

Shift + Alt + Up arrow

Extend selected block up.

Shift + Alt + Left arrow

Extend selected block left.

Shift + Alt + Right arrow

Extend selected block right.

Ctrl + Shift + Alt + Left arrow

Extend selected block by one word to the left.

Ctrl + Shift + Alt + Right arrow

Extend selected block by one word to the right.

Ctrl + mouse wheel

Adjust text size.

There is additional help provided for creating script code.

Syntax highlighting

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

Auto-completion

You can use auto-completion when you write script code. You can enable automatic completion in the input fields with the button in advanced edit mode. This suggests a word to automatically complete the keyword as it is entered. If a keyword is expected at a certain position in the source code, auto-completion comes up automatically after a few letters. Although, after specific characters, such as period (.) or parenthesis ((), automatic completion is always offered. Alternatively, you can use the Ctrl + space shortcut in the relevant positions within the input fields to call up autocomplete.

The amount of scripted code to enter is reduced by displaying the names of properties or functions that can be used. The contents of the list is determined by the key words in the code.

Entering code snippets

Input fields that require 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. In the SQL Formatter category, code snippets database queries are formatted from VB.Net.

You can insert code snippets using the following options:

  1. Using the icon

    1. Select the icon.

    2. Select the Object Layer, SQL Formatter, or Visual Basic category.

    3. Select the code snippet.

  2. Using a shortcut

    1. Press F2.

    2. Select the Object Layer, SQL Formatter, or Visual Basic category.

    3. Select the code snippet.

  3. Using an aliases

    1. Enter an alias.

    2. Use Tab to insert the code snippet.

      NOTE: Be aware of case sensitivity 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.

Custom code snippets

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

To sort custom code snippets, use the following syntax to enter a sort order in the code snippet header in the code snippet file. When the code snippet is entered, the numbering is hidden.

<Title>(1) Your title for the code snippet</Title>

<Title>(2) Your title for the code snippet</Title>

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 the 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 31: Help list for dollar notation

Table 138: Meaning of icons used in the help list for dollar notation.
Icon Meaning

Property of current object.

Primary key (PK).

Foreign key (FK).

Dynamic foreign key

Table

Special properties

Script

Table 139: Help list functions for dollar notation
Shortcut Action

Arrow down key

Opens the help list.

Arrow up key, arrow down key

Navigate to previous or next entry.

Arrow left key, arrow right key

Navigate to the object above or below over the foreign key.

Data

Accepts the value in dollar notation.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating