IMPORTANT: You should never use the VB.NET functions Msgbox and Inputbox on servers. Use the functions VID_Write2Log, RaiseMessage or AppData.Instance.RaiseMessage.
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 7: 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: Using RaiseMessage output
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: Using AppData.Instance.RaiseMessage output
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.
To log One Identity Manager Service messages in the server's event log, modify the EventLogLogWriter module in the One Identity Manager Service's configuration file. To view the event log, you can use the results display in the Microsoft Management Console, for example.
Table 21: EventLogLogWriter parameters
|
EventID |
The ID of the messages written to the event log. |
|
EventLog |
Name of the event log to which the messages are written. The messages are written to the application log with Application as the default value.
NOTE: If more than one One Identity Manager Service write event logs on a server, make sure that the first eight letters in the log name are unique on the server. |
|
Category |
The category of the messages written to the event log. |
|
Source |
The name of the source of the messages written to the event log. |
|
LogSeverity |
Severity levels of the logged messages.
Permitted values are:
-
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 messages are written to the event log. |
Process handling errors can also be written to a server’s result log. To do this, use the LogComponent process component.
For more information about configuring the One Identity Manager Service, see the One Identity Manager Configuration Guide.
By default, the One Identity Manager Service only logs messages in the event log Application.
To use an event log with a different name
-
On the Job server, manually add the file for theOne Identity Manager Service to write to. You can use PowerShell, for example, to do this.
-
Run PowerShell as administrator on the Job server.
-
Run the following CmdLet:
New-EventLog -Source "Foobar" -LogName "<file name>"
-
Enter this file name in the One Identity Manager Service configuration file, in the module EventLogWriter as the name for the event log.
-
Restart the computer.
-
Restart the One Identity Manager Service.
If the HTTPLogPlugin plug-in is configured in the One Identity Manager Service configuration file, a log file is generated with the HTTP queries of the One Identity Manager Service. The file is written in Apache HTTP Server Combined Log Format.
Example: HTTPLogPlugins log entries
172.19.2.18 - - [03/Feb/2005:14:55:48 +0100] "GET /resources/JobService.css HTTP/1.x" OK - "http://<server name>:<port>/status/LogWriter/Config""Mozilla/5.0 (Windows; U; 5.1; en-US; rv:1.7.5) Gecko/20041108Firefox/1.0"
Table 22: Meaning of each entry
|
172.19.2.18 |
IP address that sent the request. |
|
- |
Client user name using IDENT protocol (RFC 1413)- |
|
- |
User name of the client according to HTTP authentication. |
|
[03/Feb/2005:14:55:48 +0100] |
Time that the request is processed on the server |
|
GET /resources/JobService.css HTTP/1.x |
Request |
|
OK |
Status code- |
|
- |
Size of data sent back to the browser |
|
"http://<server name>:<port>/status/LogWriter/Config" |
URL from which the page can be accessed |
|
"Mozilla/5.0 (Windows; U; Windows NT 5.1; de-DE; rv:1.7.5) Gecko/20041108Firefox/1.0" |
Browser name |
For more information about configuring the One Identity Manager Service, see the One Identity Manager Configuration Guide.
