Chat now with support

Get Live Help
Complete Registration

Sign In

Request Pricing

Contact Sales

Identity Manager 9.2 - Configuration Guide

Table of Contents

About this guide One Identity Manager software architecture

Working with objects in One Identity Manager Inserting, modifying, and deleting an object in One Identity Manager

Customizing the One Identity Manager default configuration

Reloading changes dynamically Locking and unlocking individual properties for editing System configuration reports

Customizing the One Identity Manager base configuration

Overview of the database settings Changing database connection data Database configuration for a test, development, or productive environment

Changing the database staging level

Language settings for displaying and maintaining the data

Setting login languages

Default country for determining working hours and public holidays Configuration parameters for system configuration

Editing configuration parameters Creating custom configuration parameters Configuration parameter properties Configuration parameter options

One Identity Manager schema basics

Overview of the One Identity Manager schema

Displaying data models in the Designer Displaying the column dependencies based on templates

Table types and default columns in the One Identity Manager data model Notes on editing table definitions and column definitions Table definitions

Table types in One Identity Manager

Database views of the View type Database views of the proxy type Database views of the Union type Database views of the Read-only type

Table scripts Working with a globally unique identifier module Defining unique columns for tables Specifying deferred deletion for objects Editing table definitions Table definition properties Displaying the table definition Customizer

Column definitions

Templates for generating values

Selecting templates from the configuration library Editing value templates Preventing a change to a column Restricting performance of value templates Example of local value templates within an object Example of cross-object value templates

Limiting column lengths Defining decimal places for displaying values Using predefined formatting types Creating formatting scripts Column dependencies for setting values Permitted column values Specifying requirements for MVP columns Defining bitmasks Configuring columns for full-text search Scripts for conditionally displaying and editing columns Editing column definitions Column definition properties

Table relations Dynamic foreign key Supporting file groups

Editing the user interface

Object definitions for the user interface

Selection criteria for object definitions Using the captions for object definitions Creating and editing object definitions Object definition properties

User interface navigation

Navigation elements Recommendations for editing menu navigation Tips for working with the User Interface Editor Selecting the user interface navigation view for editing

Loading a complete user interface navigation Loading menu navigation using an application Direct loading of menu items Loading menu items using permissions groups Loading menu navigation using a where clause

Simulating user interface navigation during editing Copying existing user interface navigation for new permissions groups Creating a new user interface navigation Copying menu items Creating new menu items Creating new menu categories Assigning menu items to applications Assigning menu items to permissions groups General menu item properties Creating database queries for data-dependent menu items

Recursive data-dependent menu items

Display template for displaying a list Defining insert values

Using links in the navigation Using variables in the navigation

Creating and displaying variables

Forms for the user interface

Recommendations for editing forms Editing user interface forms

Tips for working with the Form Editor Disabling user interface forms Copying user interface forms Creating user interface forms Assigning user interface forms to applications Assigning user interface forms to permissions groups Assigning user interface forms to object definitions Effects of object definitions when displaying interface forms Assigning user interface forms to menu items Displaying custom columns and tables on main data forms Forms for custom extensions Hierarchical display of data on assignment forms User interface form properties Form definitions and form templates

Form templates Form definitions Configuration data for displaying many-to-many and object relations on forms

Working with overview forms

Creating overview forms Adding more form elements to overview forms Special features of editing overview forms Customizing the form elements layout Previewing an overview form during editing Disabling overview forms and form elements Deleting form elements Deleting overview forms

Statistics in One Identity Manager

Creating and editing statistic definitions

General properties statistic definitions Querying statistic measurements

Disabling statistics definition Including statistics in the user interface

Using reports in statistics Using simple reports in statistics

Diagram types for visualizing statistics Examples of statistic definitions

Extending the Launchpad

Recommendations for extending the Launchpad Actions for the Launchpad Creating new menu items and actions for the Launchpad

Task definitions for the user interface

Creating and editing task definitions Disabling task definitions Script for conditional displaying of tasks Properties of task definitions

Applications for configuring the user interface

Program properties

Icons and images for configuring the user interface Using predefined database queries

Localization in One Identity Manager

Working in different time zones Determining working hours Editing country information

Setting countries and states Specifying the standard hours for countries and states/provinces/counties Displaying public holidays for countries and states Editing countries Editing states Country properties State properties Public holiday properties

Language-dependent data representation

Basic rules for using language-dependent data Flagging columns for translation Using the text memory for translation Displaying translations in the Language Editor Showing usage of a translation Editing translations of a single table Editing all translations Changing translation keys Importing translations from the language pack

Process orchestration in One Identity Manager

Mapping processes in One Identity Manager

Editing processes with the Process Editor Defining processes

Creating and editing processes Copying processes Creating and editing process steps Copying single process steps Copying process steps within a process Searching for entries within processes Comparing processes Exporting and importing processes Process properties Process step properties Process step parameters

Editing process step parameters Properties of process step parameters Allocating parameter values

Events for processes

Creating events for processes

Permissions for triggering processes

Simulating process generation Checking the validity of a process Compiling processes Using process-specific and global variables for the process definition Thresholds for handling processes Specifying the executing server

Selecting servers with server functions Selecting servers with selection scripts

Notifications about process step handling Running processes automatically

Displaying process plan status Starting a process plan immediately Creating and editing process plans Process plan properties

Overview of process components

Displaying and editing process task exe types Changing the maximum number of instances for process tasks and process components Properties of process components, process tasks, and parameter templates

Setting up Job servers

Editing the Job server Job server properties Machine roles and server functions

Overview of server functions Overview of machine roles

Job server statistics Connection data for process generation

Entering connection data for the application server Entering Job server connection data

Installing the One Identity Manager Service with the Job Server Editor Configuring the Job server for connecting to the application server

The One Identity Manager Service functionality

Handling processes with the One Identity Manager Service Parallel processing of processes by the One Identity Manager Service Running external processes with the StdioProcessor Configuring the One Identity Manager Service

One Identity Manager Service configuration files Customizing the One Identity Manager Service configuration for a Job server

Template for the configuration file Selecting module types and editing parameters Validating the configuration file

Process collection module

MSSQLJobProvider FileJobProvider FTPJobProvider HTTPJobProvider AppServerJobProvider

Job destination module

JobServiceDestination FileJobDestination FTPJobDestination HTTPJobDestination

Configuration module Logwriter module

EventLogLogWriter FileLogWriter

Dispatcher module Connection module HTTP authentication module Module plug-ins

HTTPLogPlugin ScheduleCommandPlugin RequestWatchDogPlugin PerformanceCounterPlugin DebugMailPlugin ShareInfoPlugin RemoteConnectPlugin DatabaseAgentPlugin

File module with private key

Tracking changes with process monitoring

Basic rules for process monitoring Logging data changes

Labeling columns for recording changes to data

Logging process information during process handling

Editing process information for processes Editing process information for process steps Editing process information for events

Recording messages in the process history Process tracking for DBQueue Processor operations

Example of replacing the GenProcID

Archiving and deleting records

Deleting log entries in the One Identity Manager database without archiving Specifying log retention times Optimizing performance by deleting log entries

Conditional compilation using preprocessor conditions

Preprocessor-relevant configuration parameters Preprocessor conditions in objects Preprocessor conditions in VB.Net expressions Evaluation of preprocessor conditions during compilation

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

Accessing local object columns Accessing columns of an object connected by a relation Accessing the old column value Accessing the display value of a column Accessing references in comments Accessing metavalues of the local object Accessing objects' display values

Using base objects Calling functions Pre-scripts for use in processes and process steps Using session services

Querying configuration parameters Testing for the existence of certain database entries Querying session object global variables

Using #LD notation

Using #LD notation in process tracking Example of specifying the language or language code

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

Loading the script library Tips for editing script code in the System Debugger Logging database queries and object actions Testing script code in the System Debugger

Testing scripts in the System Debugger Testing templates and formatting scripts in the System Debugger Testing methods in the System Debugger Testing table scripts in the System Debugger

Saving changes to the database

Extended debugging in the Object Browser

Creating local debug assemblies Debugging in the Object Browser Troubleshooting debugging in the Object Browser

One Identity Manager query language

Language elements of the One Identity Manager query language

Comments Identifier Literal values

String values Integer values Decimal values Date and time values

Parameter references Preformatted Where clauses

Formulating queries in the One Identity Manager query language

Query header Where clauses Search clauses Select clauses Order by clauses Paging clauses Display value clauses Query parameter clauses Query hints Conditions

Special conditions

Comparing columns Comparison by means of IN and NOT IN clauses Compare date differences Compare date ranges Compare fixed values Comparing parameters Using preformatted Where clauses

Reports in One Identity Manager

Working with the Report Editor

Menu items in Report Editor Views in the Report Editor Report Editor program settings Logging database queries

Creating and editing reports in the Report Editor Editing general report properties Creating and editing data sources

Data retrieval using SQL queries Data retrieval using database views Data retrieval using an object Data retrieval using single object history Data retrieval using multiple object history Data retrieval using historical assignments Data query for simulation data

Report parameters

Editing report parameters General parameter settings Parameter value definitions Settings for calculating values

Using virtual data sources Editing the report form

Adding data fields to report forms Tips for entering dates in reports

Example of a simple report with data grouping Embedding reports in the user interface Translating reports Generating and exporting reports

Adding custom tables or columns to the One Identity Manager schema

Creating new tables Extending tables Defining columns

Creating simple columns Creating foreign key columns Creating dynamic foreign keys Creating new columns for database views with type view Advanced configuration of columns

Creating database views with read-only type

Using Common Table Expressions in read-only database views

Creating database views with Union type Creating new assignment tables Creating indexes Removing custom schema extensions

Possible error messages due to custom schema extensions

Permissions for schema extensions Change labels for the schema extensions Adding schema extensions to the database Recommendations for advanced configuration of custom schema extensions Notes for custom functions, triggers, or database procedures Managing custom database objects within the database

Web service integration

Binding a web service

Generic web service call Direct web service call Self-defined web service call Creating web service solutions with the Web Service Integration Wizard

Modifying a web service solution Deleting a web service solution

One Identity Manager as SCIM 2.0 service provider

Endpoints and base URL SCIM plug-in features Authenticating SCIM clients Authenticating SCIM plug-ins in One Identity Manager Special features of generating the SCIM schema SCIM plug-in requests

Processing DBQueue tasks

DBQueue Processor configuration for test, development, or productive environments Configuring notification behavior for DBQueue Processor initialization Reinitializing the DBQueue Processor Bulk processing in the DBQueue Processor Processing DBQueue Processor tasks by the Database Agent Service

Controlling processing of DBQueue Processor tasks Processing DBQueue Processor tasks How the central dispatcher communicates with individual slots

Example of communication during processing

One Identity Manager Service configuration files

Jobservice.cfg viNetworkService.exe.config

Creating new menu categories

Use this task to create a new menu category in an existing user interface navigation.

To create a new category

In the Designer, select User interface > User interface navigation category.

The menu items are loaded and displayed in the User Interface Editor for editing.
Select the Menu item > New navigation category menu item.
Edit the main data of the menu category. Enter at least the name of the menu item.

NOTE: If the entry is to represent a task category, change the entry type of the menu item to Task category.
Assign an application and the permissions groups.
Select the Database > Commit to database and click Save.

NOTE: After inserting, editing, or deleting a menu item, you must compile the database.

Related topics

Assigning menu items to applications

All menu items to be displayed in an application user interface must be assigned to an application.

To assign a menu item to an application

In the Designer, select User interface > User interface navigation category.

The menu items are loaded and displayed in the User Interface Editor for editing.
Select the menu item in the navigation overview.
In the edit view, select the Application view and then the application.
Select the Database > Commit to database and click Save.

TIP: Use the Recursively assign application context menu to assign the application to the selected menu item and its child menu items. Use the Recursively remove application context menu to remove the application’s assignment to the selected menu item and its child menu items.

Related topics

Assigning menu items to permissions groups

All menu items to be displayed in an application user interface must be assigned to a permissions group. Assign the menu items to permissions groups for non role-based and role-based login. The menu items are available to system users depending on their permissions group memberships. For more information about permissions groups, see the One Identity Manager Authorization and Authentication Guide.

To assign a menu item to a permissions group

In the Designer, select User interface > User interface navigation category.

The menu items are loaded and displayed in the User Interface Editor for editing.
Select the menu item in the navigation overview.
In the edit view, select the Permissions group view and select the permissions groups.
Select the Database > Commit to database and click Save.

TIP: Use the Assign permissions group recursively context menu to assign the permissions group to the selected menu item and its child menu items. Use the Remove permissions group recursively context menu to remove the permissions group assignment to the selected menu item and its child menu items.

Related topics

Assigning menu items to applications

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

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating

© 2024 One Identity LLC. ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center