Chat now with support
Chat with Support

Identity Manager 9.3 - 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 The full-text search in One Identity Manager 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 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 Displaying messages in the user interface Referencing packages and files in scripts 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 Committing and compiling script changes 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 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
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 Processor tasks Structure of the Jobservice.cfg configuration file

Overriding scripts

You might want to label scripts for overriding if there are limits to how much you can modify default scripts. Scripts that can be overwritten are labeled with the overridable property.

NOTE: Only the default scripts that are supplied can be overriden. Custom scripts cannot be overridden because these are saved in a Custom scripts script class.

To override a script

  1. In the Designer, select the script to override in Script Library > Overridable scripts.

  2. Select the Copy script task.

  3. In the Copy script dialog, edit the following information.

    • Script: The name of the new script is made up of the prefix CCC_ and the name of the old script. You can change the name. Prefix custom scripts with CCC_.

  4. To create the copy, click OK.

  5. In the Script Editor, replace the overridable property with overrides in the script header.

  6. Modify the other script code accordingly to suit your requirements.

IMPORTANT: After creating and editing the script, you should test compiling the script. Compile the scripts in the script library for this script to take effect.

Syntax example

Public overridable Function My_Function() as Boolean

'script code of the original version

End Function

Public overrides Function My_Function() as Boolean

'Custom script code

End Function

Related topics

Permissions for running scripts

The basic permissions for running scripts are granted to the logged in user by the Common_StartScripts program function.

If a script is assigned a program function (QBMScriptHasFeature table), users can only run this script if they have the necessary permissions groups. An error occurs if the user does not own this program function and tries to run it.

Detailed information about managing permissions and running scripts through program functions can be found in the One Identity Manager Authorization and Authentication Guide.

Editing and testing script code with 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.

The following software must be installed to use the System Debugger:

  • .NET 8.0 SDK with the current service pack

  • Visual Studio with the current service pack or Visual Studio Code

NOTE: To use the System Debugger with privileges without starting Visual Studio, you must install the One Identity Manager components in a local directory which is not controlled through user accounts.

Detailed information about this topic

Creating and loading the system library in the System Debugger

When the System Debugger starts up, it uses the SystemLibrary to create and load a Visual Studio SystemLibrary.sln file for editing and testing scripts.

The following projects are defined within the project solution.

Table 97: SystemLibrary project files
Project File Description

DlgMth

DlgMth.vb

Contains all task definitions.

ProductScripts

ProductScripts.vb

Contains all predefined scripts.

Scripts

Scripts.vb

Contains customized scripts. Add new scripts here.

This project is used as the initial project.

Tables

Tables.vb

Contains all table scripts.

Tmpl

Tmpl.vb

Contains all templates and formatting scripts.

TypedWrappers

TypedWrappers.vb

Contains the type-safe classes from the table definitions and column definitions.

WebServices

WebServices.vb

Contains the proxy code of the web service.

To create a system library

  1. Start the Launchpad and log in to the One Identity Manager database.

  2. In the Tools > One Identity Manager section, select the System Debugger entry and click Run.

  3. Confirm the prompt with Yes.

  4. Select a directory the project solutions file.

    • Click the ... button.

    • Select a directory and click Select folder.

  5. In the System Debugger, in the Create System library files dialog, run the following steps.

    1. (Optional) Enable the Export locked scripts option to load locked scripts from the script library in addition to the enabled scripts.

    2. (Optional) Use the Create backups of existing files option to specify whether backups of existing files are created. (Default)

    3. Click OK.

    This generates the file. The script library files are filled with data from the database.

  6. Confirm the prompt with OK.

    This ends the System Debugger.

To load the system library

  1. Run the SystemLibrary.sln file.

  2. Check whether the Scripts project is entered in Visual Studio as the startup project.

  3. Use F5 to start debug process in Visual Studio.

    This compiles the generated sources and project solution.

  4. Reconnect to the database.

    Starts the System Debugger.

TIP: To pass the database connection data and the authentication data to the System Debugger, enter /Conn and /Auth parameters as arguments in the initial project properties. This means System Debugger does not prompt for the information each time it starts.

Related topics
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating