Chat now with support
Chat with Support

Identity Manager 8.0 - Configuration Guide

One Identity Manager Software Architecture Working with the Designer Customizing the One Identity Manager Default Configuration Checking Data Consistency Compiling a One Identity Manager Database Working with Change Labels Basic System Configuration Data
One Identity Manager Authentication Module Database Connection Data Configuration Parameters for System Configuration Setting up the Mail Notification System Enabling More Languages for Displaying and Maintaining Data Displaying Country Information Setting Up and Configuring Schedules Password Policies in One Identity Manager Reloading Changes Dynamically TimeTrace Databases Machine Roles and Server Functions Files for Software Update Operating Systems in Use System Configuration Reports Using Predefined Database Queries Managing Custom Database Objects within a Database
The One Identity Manager Data Model Granting One Identity Manager Schema Permissions Working with the User Interface
Object definitions for the User Interface User Interface Navigation Forms for the User Interface Statistics in the 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 Language Dependent Data Representation
Process Orchestration in One Identity Manager
Declaring the Job Server One Identity Manager Service Configuration Handling Processes in the One Identity Manager
Tracking Changes with Process Monitoring Conditional Compilation using Preprocessor Conditions One Identity Manager Scripts Maintaining Mail Templates Reports in the One Identity Manager Custom schema extensions Transporting One Identity Manager Schema Customizations Importing Data Web Service Integration SOAP Web Service One Identity Manager as SPML Provisioning Service Provider Searching for Errors in the One Identity Manager Processing DBQueue Tasks One Identity Manager Configuration Files

Extended Debugging in the One Identity Manager Service

Extended Debugging in the One Identity Manager Service

There are two parameters available in the One Identity Manager Service configuration module that you can use to extend debugging functionality:

  • DebugMode
  • Component debugging mode (ComponentDebugMode)

One Identity Manager Service writes more detailed data into the log file if the parameter "DebugMode" is set, for example, all parameters that are passed to a component as well as the processing results together with OUT parameters.

Individual One Identity Manager Service process components can output additional process data to the One Identity Manager Service log file. To do this you set the parameter "ComponentDebugMode" in the configuration module. You should only use "ComponentDebugMode" for localizing errors because the effect on performance means that it is not recommended for normal use.

Related Topics

Output of Extended Return Values from Individual Process Components

Table 361: Configuration Parameter for Outputting Extended Return Values
Configuration parameter Meaning
Common\Jobservice\DoReturnOutput The entire output of the parameter is written to the One Identity Manager Service log file when a error occurs in the case of process task that supply an extended return value.

Individual process components have process tasks with parameters that supply extended return values (OUT). The entire output of the parameter is written to the One Identity Manager Service log file when a error occurs. For example, when a command or program is executed using the process component "CommandComponent", the output text for the command or program can be returned.

To log return values

  • Set the configuration parameter "Common\Jobservice\DoReturnOutput" in the Designer.
Related Topics

Outputting Custom Messages in the One Identity Manager Service Log File

Outputting Custom Messages in the One Identity Manager Service Log File

You can use the script engine methods RaiseMessage and AppData.Instance.RaiseMessage from within process steps to write output messages to the One Identity Manager Service log file. Use the process component "ScriptComponent" to run the script.

Messages are marked in color in the log file depending on the severity level (parameter "MsgSeverity").

Figure 65: Example Output of Messages to a One Identity Manager Service Log File

RaiseMessage:

The output is consolidated with other messages and logged at the end of processing the process step.

Syntax:

RaiseMessage (MsgSeverity, "string")

Example:

RaiseMessage (MsgSeverity.Warning, "Example warning message")

RaiseMessage (MsgSeverity.Info, "Example Info message")

RaiseMessage (MsgSeverity.Serious, "Example error marked message")

AppData.Instance.RaiseMessage

This output is written immediately during processing; not taking into account the end of the process step.

Syntax:

AppData.Instance.RaiseMessage (MsgSeverity, "string")

Example:

AppData.Instance.RaiseMessage (MsgSeverity.Warning, "Example warning message")

AppData.Instance.RaiseMessage (MsgSeverity.Info, "Example Info message")

AppData.Instance.RaiseMessage (MsgSeverity.Serious, "Example error marked message")

For more examples of One Identity Manager Service log file output, see the script example on the installation medium in the directory QBM\dvd\AddOn\SDK\ScriptSamples.

IMPORTANT: You should never use the VB.Net functions Msgbox and Inputbox on servers. Use the functions VID_Write2Log, RaiseMessage or AppData.Instance.RaiseMessage.

Logging Messages in the Event View

To write One Identity Manager Service messages in the server’s event view, the module "EventLogLogWriter" has to modified in the One Identity Manager Service configuration file.

Following parameters are available:

  • Event log (EventLog)

    Enter the name for the event log to which the messages should be written. The messages are written to the application log if the default value "Application" is used.

    NOTE: If several One Identity Manager Service write event logs on a server, ensure that the first 8 letters of the log name are unique.

  • Severity level (LogSeverity)

    Specifies the warning level for logging messages. By default, only warnings and serious errors are logged.

    Table 362: Warning Levels for Logging
    Severity level Description
    Info All messages are written to the event log. The event log quickly becomes large and confusing.
    Warning Only warnings and exception errors are written to the event log (default).
    Serious Only exception errors are written to the event log (exceptions).
  • Event ID

    Define an ID with which messages are written in the event log.

  • Category

    Define a category with which messages are written to the event log.

  • Source

    Define a name for the source with which messages are written to the event log.

Process handling error can also be written to a server’s result log. To do this use the process component "LogComponent".

Related Topics
Related Documents