Chat now with support
Chat with Support

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

Extended debugging in the Object Browser

The Object Browser supports debugging of scripts, templates, format scripts, table scripts, processes, and methods. You can make use of the Visual Studio debug options for this purpose. You cannot alter the scripts, templates, formatting rules, table scripts, processes, or methods. Correct the errors in the Designer.

Prerequisites
  • To use the debug function in the Object Browser, you must install the following software:

    • Visual Studio 2017 with the current service pack

    • Microsoft .NET Framework Version 4.8 Developer Pack or later

  • The user requires the Allows local debug assemblies to be created program function (Common_CompileForDebug). This provides the user with an additional compiler option in the Configuration Wizard for creating local debug assemblies.

    In the Designer, assign the program function to a custom permissions group and add the system user to this permissions group. For more information about controlling conditions with program functions, see the One Identity Manager Authorization and Authentication Guide.

  • Local debug assemblies are available on the user's local workstation.

Detailed information about this topic

Creating local debug assemblies

To generate local debug assemblies

  1. In the Database Compiler, on the Compiler settings page, set the Create debug information option.

  2. Select the Scripts including all dependencies compiler setting.

  3. Start the compiler.

    During compilation you will see more messages that refer to creating the debug assemblies locally. Some compiler steps, for example, compiling web projects, are skipped because they cannot be debugged locally.

The Database Compiler saves the assemblies and associated PDB files in the %USERPROFILE%\AppData\Local\One Identity\One Identity Manager\AssemblyCache directory on the local computer.

The source code is saved in the %USERPROFILE%\AppData\Local\One Identity\One Identity Manager\AssemblyCache\Sources directory.

Therefore, the assemblies are not transferred to the database.

Debugging in the Object Browser

NOTE: You can debug locally until assemblies without debug data are generated on the workstation or new assemblies are loaded over a database connection.

To debug in the Object Browser

  1. Start the Object Browser and select the Debug > Debugger start/stop menu item.

    Visual Studio opens and the Object Browser is connected to the debugger. This process may take a few moments. If Visual Studio connection can be established, the Manage breakpoints dialog opens.

  2. In the Manage breakpoints dialog, you can define different breakpoints for scripts, templates, format scripts, table scripts, processes, and task definitions.

    • To define a new breakpoint, click and select one of the following options:

      • Script processing: Adds a breakpoint of Script type. Under Breakpoint operation, select a script.

      • Column processing: Adds a breakpoint of Column type. Under Breakpoint operation, select a format script, template, or script for conditionally removing permissions.

      • Table processing: Adds a breakpoint of Table type. Under Breakpoint operation, select a table script.

      • Process generation: Adds a breakpoint of Process type. Under Breakpoint operation, select a process.

      • Object method: Adds a breakpoint of Object method type. Under Breakpoint operation, select a task definition.

    • To use an existing breakpoint, select it in the list.

    • To delete a breakpoint, select it in the list and click .

    • To delete all breakpoints, click .

  3. Click OK.

    This closes the Manage breakpoints dialog. The breakpoint definitions are transferred to Visual Studio.

    NOTE: You can open the Manage breakpoints dialog again from the Debug > Configure breakpoints menu.

  4. In the Object Browser, run the actions that you want to debug, for example, call a script, run a column template, or generate a process.

    The moment the action is about to be run, Visual Studio is brought into the foreground and opens the place in the source code with the selected breakpoint. From this point on, all of Visual Studio's comprehensive debugging options are available to you in full. For example, use F10 to step through the code line for line or use F5 to continue with the program.

  5. After you have completed debugging, select the Debug > Debugger start/stop menu item to

    disconnect Visual Studio from the Object Browser and close it.

Related topics

Troubleshooting debugging in the Object Browser

Problem

In the Database Compiler, the Create debug information is not shown.

Cause

The system user has not been assigned the Allows local debug assemblies to be created program function (Common_CompileForDebug) though their permissions groups.

Solution

In the Designer, assign the program function to a custom permissions group and add the system user to this permissions group. For more information about controlling conditions with program functions, see the One Identity Manager Authorization and Authentication Guide.

Problem

The Debug menu is not shown in the Object Browser.

Possible cause
  • Visual Studio is not installed with the required options.

  • The assemblies do not contain debug information.

Possible solutions
Problem

Breakpoints are shown as disabled in Visual Studio.

Cause

Breakpoints are shown as disabled if the assembly with the function to be debugged is yet not loaded into memory. For example, the assemblies for generating processes are not loaded into the application until the point of generation. From then on the breakpoint is enabled and you can jump to it.

Problem

Breakpoints in Visual Studio are always shown as disabled and you cannot jump to them.

Possible cause
  • The Object Browser still has the wrong assemblies loaded.

  • The Object Browser could not find debug information for the assemblies.

Possible solution

If Visual Studio is connected the Object Browser, switch to Visual Studio and open the Debug > Windows > Modules. Here you will find a list of all the modules that are loaded and additional information.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating