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

Object definition properties

Table 32: Object definition properties
Property	Description
Exclusive	Objects labeled with this option are considered exclusive. That means, all other possible matching object definitions are not accepted as valid. If several object definitions of one table are labeled as exclusive, the object definition with the lowest sort order applies.
Display template	The display template specifies the form in which the data sets in the administration tool result lists are displayed.
Display name	The object's display name is used, for example, to identify the table in a database search or for error output. Display names can be given in more than one language.
List caption	Caption used to display the list title in the user interface.
Form caption	Caption used to display the form title in the user interface.
Selection script	Selection script as a VB.Net term, to determine during runtime whether the database object passed down belongs to this object definition. NOTE: The database needs to be complied after changing modifying the selection script.
Processing status	Object processing status. The processing status is used for creating custom configuration packages.
Condition	Condition required for the object definition to be used for displaying in lists. You define the condition as a valid WHERE clause for database queries. NOTE: The selection script and the condition must match. If one of the properties is given then the other one also has to be given!
Remarks	Text field for additional explanation.
Disabled by preprocessor	If an object definition is excluded through a preprocessor condition, this option is set by the Database Compiler.
Insert values	Default settings for fields that are assigned when a new data set is added. The input is in VB.Net syntax. NOTE: The database needs to be complied after changing modifying the values.
Background color	Color, with which the control for this object is displayed in the schema overview.
Object name	Name of the object.
Preprocessor condition	Object definitions can have preprocessor conditions added. This means, an object definition is only available when the preprocessor condition is fulfilled.
Sort order	The sort order is used for displaying the form title when an object is selected. The smaller the sort order magnitude, the stronger the restrictions defined for the object.
Icon	Icon for displaying the object definition.
Table	Table for which the object definition is created.

Related topics

User interface navigation

One Identity Manager administration tools with their own user interface are given their own navigation view. The navigation defines specific entry points into the One Identity Manager tool's user interface and controls the user oriented navigation down to the selection of an object in the result list. You can set up the structure of the user interface navigation through a menu. There are different types of menu items with specific uses. You can design a multifaceted navigation by combining different types of menu items.

In the Designer, the navigation is displayed and edited in the User interface > User interface navigation category. The type of menu item determines the availability and editability of the properties.

Detailed information about this topic

Navigation elements

Table 33: Types of menu items
Type	Description
Menu category	Menu categories are displayed at the navigation top level and provide a method of grouping the data to be managed from different viewpoints. Menu categories constitute entry points into the interface navigation view. Menu categories are displayed as categories in the user interface.
Fixed menu item	Fixed menu items are used to organize data more clearly within menu categories. These menu items are always shown in the navigation view. List properties can only be defined for fixed menu items. These specify how the table entries are displayed in the user interface result list.
Data-Dependent Menu Item	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. List properties can be defined for data-dependent menu items. These specify how the table entries are displayed in the user interface result list.
Detached Menu Item	Detached menu items are used to group other menu items or to define a main menu item for an application. For example, you can specify a web interface home page with a detached menu item. Detached menu items should always be created at the navigation top level. However, they do not appear in the administration tools navigation view.
Link	Links support the navigation configuration. They are used to reference frequently accessed menu items. Parts of the navigation interface that require an application several times, only need to be set up once. The referenced menu items are always shown in navigation interface as opposed to the links.
Main Form Element	Main form elements are not menu items in the navigation view, but are used as the main elements in object overview forms. All child menu items are assigned to the main element.
Task category	Task categories are displayed at the navigation top level and are used to group together action-based processes. Task categories are not mapped in the navigation view but on a special form in the administration tools.
Task	Tasks are used to map single tasks within a task category. They are used, for example, as starting points for administration tool wizards. Tasks are always listed under a task category menu item. Task categories and their tasks are not displayed in the navigation view but on a special form.
Statistics	This menu item is used to display statistics. Statistics are typically displayed in the info system. All statistics that are defined in one menu level can be displayed on one form or as individual menu items. Statistics can also be included as form elements.

Related topics

Recommendations for editing menu navigation

For fixed and database-dependent menu items you can specify list properties like display templates or object definition to be used. These properties determine how the table entries are displayed in the user interface result list.
TIP: You can define display templates for menu item, object definition, and table lists.

The display template is determined by the following in order:
1. List display template for the menu item
2. Object definition display template
3. Table display template
Create menu items you can use as references (links). Thus, the parts of the navigation interface an application uses several times, only need to be created once. The referenced menu items are always shown in navigation interface as opposed to the links.
Utilize variables in designing menu item names and display templates as well as in insert values and database queries.

TIP: Define the required variables in the menu item for the menu category. Variables are inherited within a hierarchical navigation. This means that variables in deeper levels of a hierarchy can be reused or overwritten. At run-time the actual value is passed to the variables.
To display menu items in the user interface, assign the menu items to the program. For example, the Manager.
Assign the menu items to permissions groups for non role-based and role-based login.

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