Chat now with support
Chat with Support

Identity Manager 9.1.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 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 Windows 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

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:

  • Visual Studio 2017 with the current service pack

  • Microsoft .NET Framework Version 4.8 Developer Pack or later

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

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

  1. Run the SystemLibrary.sln file in the One Identity Manager installation directory.

  2. Check whether SystemDebugger is entered in Visual Studio as the start project.

  3. Start the solution with F5 in Visual Studio.

  4. Connect to the database.

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

  6. Click OK.

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

  7. Confirm reloading of each project in Visual Studio.

  8. Start the solution with F5 in Visual Studio.

    The source code generated for the solution is compiled.

  9. Reconnect to the database.

    Starts the System Debugger.

Related topics
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating