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 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 CRM Desktop displays in the VS Debug Output window during a debugging session. The OutputDebugString is a string that 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 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 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 CRM Desktop reuses this file. 1 is the default value.
• 0. CRM Desktop does not reuse the most current log file.

rotate_on_start_only

Log file rotation is a configuration that 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 IBM Notes starts. If this log file size is larger than the value that the max_size_bytes parameter specifies, then 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. CRM Desktop stores all log entries for one IBM Notes session to one file. 1 is the default value.
• 0. Examines the log file size every time CRM Desktop writes to the log. If this log file size is larger than the value that the max_size_bytes parameter specifies, then CRM Desktop creates a new log file. Multiple log files can exist for a single IBM Notes 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 CRM Desktop starts.
• 0. Does not delete the contents of any general log file when 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 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 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 CRM Desktop internal component. For example, a connector or application manager.

starter

A string that specifies the first message that 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 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 CRM Desktop stopped logging abnormally.

enable

You can use one of the following values:

• 1. Exception Log is enabled.
• 0. Exception Log is disabled.

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 exception log files when CRM Desktop starts.
• 0. Does not delete the contents of any exception log file when CRM Desktop starts.

max_size_bytes

An integer that sets the maximum number of bytes that a single log file can contain. For more information, see the description for the max_size_bytes parameter in Parameters You Can Use with the General Log.

out_file

A string that specifies the base file name that CRM Desktop uses for logging.

enable

You can use one of the following values:

• 1. Crash log is enabled.
• 0. Crash log is disabled.

count

An integer that specifies the maximum of old log files that CRM Desktop preserves in the output logging directory.

on_top

A string that specifies the filtering condition for the crash log. CRM Desktop applies this filtering only if the item you specify resides at the start of the stack trace when the failure occurs. For example, you can use the following value:

CRMDesktop3D.dll

If you do not specify a value, then CRM Desktop ignores this parameter.

on_top_op

You can use one of the following values:

• 0. Combine the item that the on_top parameter filters with the item that the any_in_trace parameter specifies or with the item that the all_in_trace parameter specifies. Use an OR logic operation.
• 1. Combine the item that the on_top parameter filters with the item that the any_in_trace parameter specifies and with the item that the all_in_trace parameter specifies. Use an AND logic operation.
• 2. Combine the item that the on_top parameter does not filter with the item that the any_in_trace parameter specifies or with the item that the all_in_trace parameter specifies. Use an OR logic operation.
• 3. Combine the item that the on_top parameter does not filter with the item that the any_in_trace parameter specifies and with the item that the all_in_trace parameter specifies. Use an AND logic operation.

any_in_trace

A string that specifies a list of items. If the stack trace includes an item you specify, then CRM Desktop saves a crash log for this item. For example, you can use the following value:

Ntdll.dll,Kernel32.dll

In this example, if the stack trace includes an entry for Ntdll.dll or Kernel32.dll, then CRM Desktop saves a crash log for this item.

all_in_trace

A string that specifies a list of items. If the stack trace includes all the items you specify, then CRM Desktop saves a crash log for these items. For example, you can use the following value:

Ntdll.dll,Kernel32.dll

In this example, if the stack trace includes an entry for Ntdll.dll and an entry for Kernel32.dll, then CRM Desktop saves a crash log for these items.

delay_ms

An integer that specifies a delay in milliseconds. If the time that elapses after a previous exception exceeds the value you specify, then CRM Desktop saves a crash log.

The default value is 0. This default makes sure that CRM Desktop always saves a crash log.

ex_white_list

A string that specifies a list of C++ exception names. If an exception occurs for an exception name you specify, then CRM Desktop creates a minilog for this exception.

ex_black_list

A string that specifies a list of C++ exception names that CRM Desktop uses to not create a minilog. If the white_list parameter is empty, then CRM Desktop creates a log for all exceptions except the exceptions that the black_list parameter lists.

sigabrt

SIGABRT is a signal that CRM Desktop sends to a process to tell it to end. You can use one of the following values:

• 1. Intercept the SIGABRT signal to save a crash log. You must use this parameter only for troubleshooting. Do not enable it permanently.
• 0. Do not intercept the SIGABRT signal to save a crash log.

minidump_type

An integer that specifies the minilog type. The default value is 1 (MiniDumpNormal|MiniDumpWithDataSegs).

Use this parameter with caution because other values could increase log size significantly. For more information, see documentation about the DumpType parameter of the MiniDumpWriteDump function at the Microsoft MSDN web site.

enable

You can use one of the following values:

• 1. SOAP log is enabled.
• 0. SOAP log is disabled.

enable_dbg_window

You can use one of the following values:

• 1. Enables output through the OutputDebugString. The SOAP log displays in the VS Debug Output window during a debugging session.
• 0. Disables output through the OutputDebugString. The SOAP log does not display in the VS Debug Output window during a debugging session.

enable_cout

You can use one of the following values:

• 1. Enables logging to the console.
• 0. Disables logging to the console.

file_count

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

root_tag_name

A string that specifies the root XML tags that CRM Desktop uses in generated XML files. The default value is soap_comm_log. If you use the following value, then it does not write the opening or closing root tags:

""

file_extension

A string that specifies the file extension that CRM Desktop uses for generated log files. The default value is xml.

bin_mode

You can use one of the following values:

• 1. CRM Desktop uses the \n format for new line termination.
• 0. CRM Desktop uses the \r\n format for new line termination.

enable

You can use one of the following values:

• 1. Synchronization log is enabled.
• 0. Synchronization log is disabled.

file_count

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

out_file

A string that specifies the base file name that CRM Desktop uses for logging.