Chat now with support

Get Live Help
Complete Registration

Sign In

Request Pricing

Contact Sales

Identity Manager 8.1.5 - 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

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 Editing table definitions Table definition properties Displaying the table definition Customizer

Column definitions

Templates for generating values

Editing value templates Preventing a change to a column Restricting the execution of value templates Example of local value templates within an object Example of cross-object value templates

Limiting column length Defining decimal places for displaying values Using predefined formatting types Creating formatting scripts Column dependencies for setting values Permitted values for a column 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 Editing object definitions Object definition properties

User interface navigation

Navigation elements Recommendations for editing menu navigation Notes on 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 through permissions groups Loading menu navigation using a where clause

Simulating user interface navigation during editing Copying existing UI 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 an application Assigning menu items to a permissions group 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 Using variables

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 a new user interface form 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 a menu items Displaying custom columns and tables on master data forms Forms for custom extensions

Hierarchical display of data on assignment forms Replacing default forms with custom 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 the overview form 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

Editing statistic definitions

General properties of a statistic definition 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

Editing task definitions Disabling task definitions Properties of task definitions

Applications for configuring the user interface

Application 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 the key text of a translation Importing the translation.

Process orchestration in One Identity Manager

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 on a Job server remotely

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

File module with private key

Handling 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 Properties of a process 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 a process 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 Executing processes automatically

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

Overview of process components

Properties of process components, process tasks and parameter templates

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 data retention periods 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

Using scripts Notes on message output Notes on using date values 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

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 variant

Script library Support for processing of scripts in 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 executing scripts Editing and testing script code with the System Debugger

Loading the script library Tips on 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

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 a data source

Data retrieval using a SQL query Data retrieval using a database view 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 Editing general parameter settings Editing 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 Translating reports Embedding reports in the user interface Creating and exporting reports on a cyclical basis

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

SOAP Web Service

Installing and configuring the SOAP Web Service

Installing the SOAP Web Service Configuring the SOAP Web Service Displaying the SOAP Web Service‘s status Uninstalling SOAP Web Service

Examples of calls

One Identity Manager as SPML provisioning service provider

SPML web service Installing and configuring the SPML web service

Installing the SPML Web Service Configuring the SPML web service Uninstalling the SPML Web Service

Configuring the One Identity Manager schema

Preparing the One Identity Manager schema for export to the SPML schema Creating schema files

Testing SPML web service functionality

Configuring the SPML test front-end Using the SPML test front-end

Processing DBQueue tasks

Configuring the DBQueue Processor for test and development environments Initializing the DBQueue Processor Configuring notification behavior for DBQueue Processor initialization Reinitializing the DBQueue Processor Controlling processing of DBQueue Processor tasks Processing DBQueue Processor tasks Reactivating DBQueue Processor tasks Bulk processing in the DBQueue Processor How the central dispatcher communicates with individual slots

Communication during processing

One Identity Manager Service configuration files

Jobservice.cfg viNetworkService.exe.config

Loading the script library

When you call the System Debugger, a SystemLibrary.sln solution template with the SystemLibrary solution is loaded in theVisual Studio for editing and testing the scripts.

The following projects are defined in the solution.

Table 142: Solution project files
Project	Script File	Description
Methods	Methods.vb	This script file contains all methods.
Scripts	VIScripts.vb	This script file contains all predefined scripts from the model components.
	VIDScripts.vb	This script file contains all predefined scripts from the system components.
	CustomerScripts.vb	This script file contains custom scripts. Add new scripts here.
SystemDebugger	Main.vb	Start up project.
Tables	Tables.vb	This script file contains all the table scripts.
Templates	Templates.vb	This script file contains all templates and formatting scripts.

To load the system library

Run the SystemLibrary.sln file in the One Identity Manager installation directory.
Check whether SystemDebugger is entered in Visual Studio as the start project.
Start the solution with F5 in Visual Studio.
Connect to the database.

Check the solution file directory and the options for creating the script library.

Options	Meaning
Export system scripts	Specifies whether predefined scripts are loaded into the system library.
Export custom scripts	Specifies whether custom scripts are loaded into the system library.
Export locked scripts	Specifies whether only active scripts or also locked scripts are loaded from the script library.
Update project references	Specifies whether references used in scripts are also loaded.
Create backups of existing files	Specifies whether backups of existing files are made.

Click OK.

The script library files are filled with data from the database.
Confirm reloading of each project in Visual Studio.
Start the solution with F5 in Visual Studio.

The source code generated for the solution is compiled.
Reconnect to the database.

Starts the System Debugger.

Related topics

Testing script code in the System Debugger

Tips on editing script code in the System Debugger

After loading the system library, you can edit scripts, templates, formatting scripts, methods, and table scripts in the System Debugger and test them.

Note the following:

You are not permitted to edit VI-Key comments in the source code or to delete them because they label each code block and are needed for backing up scripts in the database.
When templates and formatting scripts are loaded, the $ notation is converted into a GetTriggerValue method call. All GetTriggerValue methods calls are converted into $ notation when the changes are saved in the database.

Example:

$FK(UID_Person).IsExternal:Bool$ is converted into GetTriggerValue("FK(UID_Person).IsExternal").Bool when it is loaded
In the Designer, you can use the Script Editor to create scripts. Enter the name of the script in the Script Editor and a skeleton script body. This you can export to the script library where you can edit the script with the System Debugger.
In the Designer, you can created templates, formatting scripts, methods, and table scripts. You can edit these elements with the System Debugger after you have exported them to the system library.

Related topics

Logging database queries and object actions

Use database query and object action logging in the System Debugger to look for errors and optimize scripts during development. The execution time and the command that was run are logged.

SQL log

Open the log dialog box by selecting the View | SQL log menu item.
Object log

Open the log dialog box by selecting the View | Object log menu item.

Table 143: Functions for logging database queries and object actions
Icon	Meaning
	Starts recording.
	Stops recording.
	Copies logged data to the clipboard.
	Save logged data in a file.
	Deletes the logged data.

Testing script code in the System Debugger

The System Debugger gives you the opportunity to test scripts, templates, formatting rules, methods, and table scripts. Visual Studio debug and edit options are available to you.

Detailed information about this topic

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