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

• The Configuration Module
• One Identity Manager Service Configuration
• One Identity Manager Configuration Files

Output of Extended Return Values from Individual Process Components

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

• Displaying OUT Parameters

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:

Example:

AppData.Instance.RaiseMessage

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

Syntax:

Example:

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.

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

• EventLogLogWriter
• One Identity Manager Service Configuration