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

General menu item properties

The properties described below are valid for all menu items: Other properties may be required for different menu item types.

Table 34: General menu item properties
Property Description

Menu item

Unique menu item relation. You should assign descriptive names here if possible. These are then propagated in the child structures. This makes it easier to trace the position of child menu items. The parent menu item and the hierarchy is determined by the insert position in the user interface navigation. The menu item name can contain variables in order to represent the menu items.

Entry type

Menu item entry type.

Caption

Language-dependent caption for displaying the menu item in the user interface. The caption for data-dependent menu items can contain fixed strings and variables. The caption for recursive data-dependent menu items is inherited from the parent menu item. Translate the given text using the button.

Sort order

If several menu items have the same parent menu item, the sort order of the individual menu items specifies their position in the display order.

If the configuration flag Re-sort data submenu items by caption is set for the parent menu item, the sort order specified here is invalid.

Icon

Icon for displaying the menu item in the navigation If no icon is specified for recursively data-dependent menu items, the icon from the parent menu item is inherited.

Initialization script

VB.Net expression for overwriting values of this menu item respective to the data. The script allows you to initialize variables that you can then use when designing the display texts on overview forms or for the list titles of results lists.

Example:

Initializing the variable in the script: Variables("MyNewCaptionValue") = "New caption value".

Usage: %MyNewCaptionValue%

Overlay icon definition

VB.Net expression for defining overlays for the icon. Used to display the status in the Launchpad.

Condition

Specifies the conditions under which the menu item is displayed in the navigation. The input must satisfy the WHERE clause database query syntax. You can use variables to formulate a condition.

Configuration flag

Special functions are set for menu items with the configuration flag. For more information, see Table 35.

Preprocessor condition

You can add preprocessor conditions to menu items. This means that a menu item is only available when the preprocessor condition is fulfilled.

NOTE: In the Designer, you can find an overview of existing preprocessor dependencies in the One Identity Manager Schema > Preprocessor dependencies category.

Disabled by preprocessor

If a menu item is excluded through a preprocessor condition, this option is set by the Database Compiler.

Description

 Text field for additional explanation.

Deactivated

Specifies if the menu item is displayed in the user interface or not. Disabled menu items are never displayed in the user interface.

NOTE: This change is also permitted for menu items in the default user interface and is not overwritten on schema installation.

Show under "My One Identity Manager"

This option marks the menu items in the Manager to be displayed in the My One Identity Manager category.

Table 35: Configuration flags for special functions
Configuration flag Description

Auto-reload on insert

If this configuration flag is set, the menu item is reloaded after new data is added.

Hide on empty result

If no submenu items are generated for a menu item labeled the same way during runtime, the menu item is similarly hidden in the user interface.

Not expandable by user

Menu items that are labeled with this option cannot be opened even if submenu items are available. The configuration flag is mainly used in the info system for displaying statistics.

Ignore user interface forms in result list

No forms are provided in the result list for menu items with this option. This can be useful to prevent navigating to objects in the list on an overview form. This is useful if, for example, forms are not defined for some objects in the result list. Otherwise, an empty form is displayed.

Ignore user interface forms

This configuration flag can be used for data-dependent menu items. If the configuration flag is set, no object-dependent interface forms are displayed when the menu item is selected in the user interface. This configuration flag is mainly used for structuring the user interface for Web front-ends.

Force open menu item

If this configuration flag is set, the menu item is always open. There is no test to see if the menu item is assigned to something, for example, the interface form.

Re-sort data-dependent menu item by caption

This configuration flag can be used for data-dependent menu items. The configuration flag should be set if language-dependent data is displayed. If the configuration flag is set, the data for menu navigation to be shown is sorted by language after it is loaded.

Re-sort data result by caption

This configuration flag can be used for lists. The configuration flag should be set if language-dependent data is displayed. If the configuration flag is set, the data to be shown is sorted by language in the result list after it is loaded.

Re-sort data submenu items by caption

The configuration flag should be set if language-dependent data is displayed. If the configuration flag is set, the data for all submenu items to be shown are sorted by language.

This enables all user accounts, groups, and containers in a container structure, for example, to be sorted alphabetically. The sort order not only affects data-dependent menu items but also all submenu items.

Take navigation context into account on enabling

If this configuration flag is set, the location in the navigation where the menu item is opened is taken into account when the objects are loaded. If an object appears several times within a navigation structure, the content is loaded and displayed depending on the location of the navigation structure.

If the configuration flag is not set, the data is retained, even if the object is opened again from another location in the navigation.

Related topics

Creating database queries for data-dependent menu items

Data-dependent menu items are generated by a database query that returns several data sets as output. These menu items are therefore not individual menu items, but a set of menu items depending on the output of the database query.

For more information about general properties of menu items, see General menu item properties. The following properties are necessary to put together a database query:

Table 36: Database query properties
Property Description

Table

Table that the values are read from.

Sort order

Display elements are sorted by these table columns. The input must satisfy the Order By syntax of database queries. Sorting is given by the columns of the display template if no value is entered. You should use a sort order if the data has a date or represents language-dependent data.

NOTE: For language-dependent sorting, use the Re-sort data dependent menu item by caption configuration switch.

Condition

Condition for limiting the number of results displayed. The input must satisfy the WHERE clause database query syntax. You can use variables for formulating a condition. If the menu items are recursively data-dependent then variables have to be used.

NOTE: The condition must not contain a JOIN and the query may need to be formulated as a subquery.

Unique

The query result cannot contain doubled items. By setting option, any doubt is eliminated.

Menu items that are labeled with the Unique option have to contain variables in their names to achieve uniqueness.

If, for example, all software applications (Application table) are grouped by language, the name of the corresponding menu item must contain a variable, which references the UID_DialogCulture column in the Application table.

NOTE: No interface forms are shown for objects that result from a database query.

NOTE: The option is disabled if the configuration switch Force open menu item is set.

Recursive calling

This menu item is the recursive successor of the previous menu item. If the option is not set, the results are represented by a flat structure. Set the option if the menu item is required to represent a hierarchical structure. You can only define recursive data-dependent menu items below a data-dependent item without recursion.

FK object to activate (data node)

Path to the FK object to be loaded when an entry is selected in the front-end. Enter the base object path in the VI.DB ObjectWalker notation.

Example: FK(UID_ADSGroup)

Related topics

Recursive data-dependent menu items

The heart of the hierarchy is variable replacement. Variables are passed down through the hierarchical navigation view and can therefore be used at lower levels or can be overwritten. In the case of recursive data-dependent menu items, the variable contained in a database query is initially replaced by the existing variable value from the parent level and then the query is started. The resulting value immediately determines a new value for the variable that is processed again in the parent node’s next step. The original value of the old variable is no longer available after the database query has been run. If the database query delivers an empty result, the recursion is stopped.

Figure 12: Example of data-dependent menu items with recursive calling (left) and without recursive calling (right)

Related topics

Editing lists

You can apply list properties to fixed and data-dependent menu items. These properties determine how the table entries are displayed in the user interface result list.

For more information about general properties of menu items, see General menu item properties. To define a list, you need to use the following properties:

Table 37: List properties
Property Description

Display pattern

The display template for displaying table entries in the administration tool result lists are displayed. If a customer specific display template exists it is used instead of the default display template.

Syntax: %column name%

List title

Alternative name for the title of the results list. The name can contain fixed strings and variables.

This value overwrites the List caption of the object definition list that you have set for the list.

Object

Definition of the object which determines the list items.

FK object to activate (list)

Path to the FK object to be loaded when an entry is selected in the front-end. Enter the base object path in the VI.DB ObjectWalker notation.

Example: FK(UID_ADSGroup)

Condition

Condition for limiting the number of results. The input must comply with the WHERE clause syntax of database queries. The condition relates to the given object definition. The condition is consolidated with the condition which is already stored for the object definition. The variables can be used that are available in the navigation interface.

Icon

Icon for displaying the items in the list.

Order by

Columns to use for the list order. The input must satisfy the Order By syntax of database queries. You should use a sort order if the data has a date or represents language-dependent data. For language-dependent sorting, use the configuration switch Re-sort data result by caption.

Insert values

Insert values initialize individual values when a new data set is added over the result list. Enter insert values in VB.Net syntax. When defining insert values, you can apply the variables currently available in the navigation.

Insertion in list permitted

Specifies whether you are generally allowed to insert entries in the corresponding result list Whether or not users are allowed to insert entries depends on their permissions. For more information about granting permissions, see the One Identity Manager Authorization and Authentication Guide.

Deletion from list permitted

Specifies whether you are generally allowed to delete entries in the corresponding result list. Whether or not users are allowed to delete entries depends on their permissions. For more information about granting permissions, see the One Identity Manager Authorization and Authentication Guide.

Related topics
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating