Chat now with support
Chat with Support

Identity Manager 8.1.5 - 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
Setting up Job servers Configuring the One Identity Manager Service Handling processes in One Identity Manager
Tracking changes with process monitoring Conditional compilation using preprocessor conditions Scripts in One Identity Manager
Using scripts Notes on message output Notes on using date values 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 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 Extended debugging in the Object Browser
Reports in One Identity Manager Adding custom tables or columns to the One Identity Manager schema Web service integration SOAP Web Service One Identity Manager as SPML provisioning service provider Processing DBQueue tasks One Identity Manager Service configuration files

Testing script compilation in the Script Editor

If you have created a new script, you need to compile it. The script is not executable until it has been compiled. You can test script compilation in the Script Editor.

To test compiling scripts

  • In the Designer, select the script in the Script Library category.

  • Select the Edit script task.

  • Start compilation with the icon , Script | Compile script menu item or F9.

All scripts are converted during compilation. The assemblies are created and placed on the workstation where generating will take place. During the conversion, the script code is tested for validity. This process may required some time.

Error messages are sent to the Compiler errors view. A double-click on the error message takes you straight to the corresponding line in the script code view where you can edit it. It can be modified at this point.

IMPORTANT: Once you have tested the script it needs to be added to the One Identity Manager database and compiled with the Database Compiler. For more detailed information, see the One Identity Manager Operational Guide.

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

The basic permissions for executing scripts are granted to the logged in user through the program feature Allow the starting of arbitrary scripts from the frontend (Common_StartScripts).

If a script is assigned a program function (QBMScriptHasFeature table), users can only execute 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 executing 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 2012 with the current service pack

  • Microsoft .NET Framework Version 4.7.2 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
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating