1. Siebel CRM Desktop for Microsoft Outlook Administration Guide
  2. Parameters You Can Use with the General Log

Parameters You Can Use with the General Log

The following describes the parameters that you can use with the General Log with Siebel CRM Desktop.

Parameter Description

enable

You can use one of the following values:

  • 1. General Log is enabled.

  • 0. General Log is disabled.

To disable the general log, you must use the Windows Registry. You cannot use the Logging Configuration dialog box. For more information, see Assigning Logging Profiles for Siebel CRM Desktop.

log_level

Defines logging verbosity. You can use one of the following integers:

  • 4294967295. Disable all.

  • 0. Enable all

  • 1000. Debug.

  • 2000. Information messages

  • 3000. Warnings.

  • 4000. Errors

  • 5000. Fatal errors

For more information, see Setting Logging Verbosity.

out_file

You can include a string that identifies the file name for the general log. For example, assume you use the following value:

log.txt

In this example, the first file name is log.0000.txt, the second file name is log.0001.txt, and so on. If you do not include the out_file parameter, then Siebel CRM Desktop uses log.txt as the default value.

enable_dbg_window

You can use one of the following values:

  • 1. Enables output through the OutputDebugString that Siebel CRM Desktop displays in the VS Debug Output window during a debugging session. The OutputDebugString is a string that Siebel CRM Desktop sends to the debugger for display. The VS Debug Output window is a window in Microsoft Visual Studio that displays debugging results. For more information about Visual Studio, see the documentation at the Microsoft TechNet Web site.

  • 0. Disables the General Log

enable_cout

You can use one of the following values:

  • 1. Enables logging in the console.

  • 0. Disables logging in the console.

max_size_bytes

You can use an integer that sets the maximum number of bytes that a single log file can contain. For example, if you set max_size_bytes to 10485760 bytes, and if the current log reaches 10485760 in size, then Siebel CRM Desktop creates a new log file. This behavior is similar to setting the rotate_on_start_only parameter to 0.

reuse_not_exceeded

Determines the file that Siebel CRM Desktop uses when a new logging session starts. You can use one of the following values:

  • 1. If the size of the most current log file is less than the value that the max_size_bytes parameter sets, then Siebel CRM Desktop reuses this file. 1 is the default value.

  • 0. Siebel CRM Desktop does not reuse the most current log file.

rotate_on_start_only

Log file rotation is a configuration that Siebel CRM Desktop uses to prevent log files from growing indefinitely. You can use one of the following values:

  • 1. Examines the log file size that exists when Outlook starts. If this log file size is larger than the value that the max_size_bytes parameter specifies, then Siebel CRM Desktop creates a new log file and then logs all subsequent entries to this new file. The log file size can exceed the value that the max_size_bytes parameter specifies. Siebel CRM Desktop stores all log entries for one Outlook session to one file. 1 is the default value.

  • 0. Examines the log file size every time Siebel CRM Desktop writes to the log. If this log file size is larger than the value that the max_size_bytes parameter specifies, then Siebel CRM Desktop creates a new log file. Multiple log files can exist for a single Outlook session.

file_count

An integer that specifies the maximum number of rotated log files.

initial_erase

You can use one of the following values:

  • 1. Deletes the contents of all general log files when Siebel CRM Desktop starts.

  • 0. Does not delete the contents of any general log file when Siebel CRM Desktop starts.

time_format

A string that specifies the date and dime format in the log files. You can use one of the following values:

  • $nano. Nanoseconds.

  • $micro. Microseconds

  • $mili. Milliseconds.

  • $ss. A 2 digit second

  • $mm. A 2 digit minute.

  • $hh. A 2 digit hour

  • $dd. A 2 digit day.

  • $MM. A 2 digit month

  • $yy. A 2 digit year.

  • $yyyy. A four digit year

Nanoseconds or microseconds are available only if the system clock allows nanoseconds or microseconds. If the system clock does not allow nanoseconds or microseconds, and if you specify nanoseconds or microseconds, then Siebel CRM Desktop pads the value that it creates for the log entry with zeros.

log_format

A string that specifies the logging message format. You can use one of the following values:

  • %index%. Sequential message index.

  • %time%. Time in the format that the time_format parameter sets.

  • %thread%. Thread ID that Siebel CRM Desktop uses to log the message.

  • %level%. Message logging level in human readable format.

  • %level_num%. Message logging level in numeric format.

  • %log_src%. Source of the logging message. This source can be a Siebel CRM Desktop internal component. For example, a connector or application manager.

starter

A string that specifies the first message that Siebel CRM Desktop adds to the log file when it starts logging. For example:

--- logging is initialized ---

finisher

A string that specifies the last message that Siebel CRM Desktop adds to the log file when it stops logging. For example:

--- logging is finished ---

If a log does not include the finisher message, then it indicates that Siebel CRM Desktop stopped logging abnormally.