Authentication method for displaying the log file
Use the HTTP authentication module to specify how authentication on the HTTP server works to access the services, for example, to display the log file or status display.
The following module types may be selected:
- BasicHttpAuthentication
With this authentication type, enter a specific user account and the corresponding password for accessing the HTTP server.
- WindowsHttpAuthentication
Use this authentication type to specify an Active Directory group, whose users can be authenticated on the HTTP server. A security ID (SID) or the Active Directory group name in the domain of the Job server can be specified. If Active Directory is not located in the domain of the Job server, the SID must be used.
NOTE: If a module is not specified, authentication is not required. In this case, all users can access the services.
For more detailed information about configuring the One Identity Manager Service, see the One Identity Manager Configuration Guide.
Advanced logging in the One Identity Manager Service
To use advanced logging for the One Identity Manager Service, configure the storage of log files in the One Identity Manager Service configuration file in the Connection module.
NOTE: The given directory must exist and the One Identity Manager Service user account must have write permissions to the directory.
Following parameters are available:
For more detailed information about configuring the One Identity Manager Service, see the One Identity Manager Configuration Guide.
Extended debugging in One Identity Manager Service
The Configuration module of the One Identity Manager Service configuration file provides two parameters for advanced debugging:
- DebugMode
- ComponentDebugMode
If the Debug mode (DebugMode) parameter is enabled, the One Identity Manager Service writes more extensive information into the log file, such as all parameters transferred to a component and the results of the process handling and their Out parameters.
Individual One Identity Manager Service process components can output additional process data to the One Identity Manager Service log file. For this purpose, you can enable the Component debug mode (ComponentDebugMode) parameter in the configuration module. Use this debug mode only for localizing errors because the effect on performance means that it is not recommended for normal use.
For more detailed information about configuring the One Identity Manager Service, see the One Identity Manager Configuration Guide.
Outputting custom messages in the One Identity Manager Service log file
You can use the RaiseMessage and AppData.Instance.RaiseMessage script engine tasks from within process steps to write custom messages to the One Identity Manager Service log file. Use the ScriptComponent process component to run the scripts.
The messages in the log file are marked in color depending on the specified severity (MsgSeverity parameter).
Figure 8: Example output of custom messages to the 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
The output is issued immediately during processing regardless of whether processing of the process step has ended.
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.
