1. Oracle CRM On Demand Desktop Administration Guide
  2. What’s New in This Release

14Windows Registry Parameters You Can Use With Oracle CRM On Demand Desktop

Windows Registry Parameters You Can Use With Oracle CRM On Demand Desktop

This chapter describes Windows registry parameters that you can use with Oracle CRM On Demand Desktop. It includes the following topics:

Windows Registry Parameters That Affect Oracle CRM On Demand Desktop Behavior

The following table describes the Windows Registry parameters that you can modify to change Oracle CRM On Demand Desktop behavior. In the Registry Editor (regedit), you can modify these parameters in the following path: 

HKEY_CURRENT_USER\Software\Oracle\CRM Desktop

Table Windows Registry Parameters That Affect Behavior of the Oracle CRM On Demand Desktop Add-In

Windows Registry Parameter Description

AppLanguageID

The ID of the current installation package of Microsoft Outlook.

ConnectorCfgPath

The path to the connector_configuration.xml file in the customization package.

DestinationProfile

The name of the Microsoft Outlook profile where Oracle CRM On Demand Desktop is installed.

DestinationStore

The location of the profile identified in the DestinationProfile.

DisableSyncConfirmation

Suppresses the confirmation for deleting an object. The following values are valid:

  • 1. Suppress confirmation for deleting an object.

  • 0. Confirmation for deleting an object, which is the default value.

The corresponding attribute in the connector_configuration.xml file of the customization package automatically overwrites the DisableSyncConfirmation key.

FiltersEstimateOnTimer

Sets the interval in milliseconds for an automatic estimate of the records after the filters are changed in the control panel. The following values are valid:

  • 0. Do not estimate automatically.

  • 1. Estimate automatically.

This entry is not accessible through the administrative interface.

HTTPClient:AcceptCompression

A flag that instructs the Web service connector to accept compressed HTTP content. This parameter is not accessible through the administrative interface.

HTTPClient:CompressOutgoing

A flag that instructs the Web service connector to send zipped HTTP content. This parameter is not accessible through the administrative interface.

HTTPClient:ConnectTimeout

The timeout period in milliseconds for the connection.

HTTPClient:ReceiveTimeout

The timeout period in milliseconds for receiving requests.

HTTPClient:SendRetryCount

The number of connection retries for a period of time in milliseconds.

HTTPClient:SendTimeout

The timeout period in milliseconds for sending requests.

Page:Feedback:AttachLog

Specifies the log file for the feedback form. The following values are valid:

  • 0. Do not attach a log file to the feedback form.

  • 1. Attach a log file to the feedback form.

ProxyLogin

The login name for the proxy server.

ProxyPassword

The password for the proxy server.

ProxyServer

The host name for the proxy server.

ProxyServerPort

The port number for the proxy server.

ProxyUsage

The flag that specifies a proxy server. The following values are valid:

  • 0. Do not use a proxy server.

  • 1. Use a proxy server.

RunPeriodicalSyncAlways

Determines if Oracle CRM On Demand Desktop starts a scheduled synchronization at the scheduled time or waits until Microsoft Outlook is idle. The following values are available:

  • 0. Wait until Microsoft Outlook is idle to start the scheduled synchronization.

  • 1. Start the scheduled synchronization immediately when the synchronization is scheduled to occur. This value is the default.

SessionsKeepAliveAmount

Defines the number of synchronization sessions to store in the internal database as history. Oracle CRM On Demand Desktop stores statistical information for each synchronization session. The user can use the list control in the Sync Issues tab of the Synchronization Control Panel to view information about synchronization issues.

SharedByDefault:NewItems

The SharedByDefault:NewItems registry key determines how Oracle CRM On Demand Desktop shares newly created Microsoft Outlook items. For more information, see Overview of How Oracle CRM On Demand Desktop Handles an Activity.

Connector:HideSavePasswordOption

Determines how Oracle CRM On Demand Desktop displays the Save Password check box on the login screen. The following values are valid:

  • 0. Display the Save Password check box. By default, the check box is displayed.

  • 1. Do not display the Save Password check box.

Connector:MetaInfoFilePath

Describes the path to the od_meta_info.xml file in the customization package.

Connector:Protocol

Defines the URL protocol. The default is http. The following values are valid:

  • http

  • https

Note: Only https protocol is allowed in production environments.

Connector:RequestSuffix

Defines the suffix of the URL that points to the Oracle CRM On Demand server. The following is the default value:

Services/Integration

Connector:Server

Defines the host name of the URL. The default is empty.

Connector:ServerPort

Defines the port of the URL. The default is 80 for http protocol and 443 for https protocol. Only https protocol is allowed in production environments.

SuppressSyncEstimating

At the beginning of the synchronization, this parameter determines how Oracle CRM On Demand Desktop gets an estimate of the number of all the object types that are visible to the current user. The following values are valid:

  • 0. Counts of all the object types.

  • 1. Do not count all the object types.

SwitchToAutoCompleteChoiceLimit

Limits the number of items that Oracle CRM On Demand Desktop displays in the box in the Filters tab when the user creates rules.

SyncDumpBaseFname

Defines the full path and file name for the synchronization dump file that Oracle CRM On Demand Desktop creates separately for each synchronization. Oracle CRM On Demand Desktop stores synchronization history information in this file. Oracle CRM On Demand Desktop uses it for investigation purposes.

Connector:SOAPDumpBaseFname

Describes the path to where Oracle CRM On Demand Desktop stores information about SOAP activity. This information describes the requests and replies of the Web Service Connector.

Windows Registry Parameters That Affect Local Synchronization

The following table describes the options in the Windows Registry that control local synchronization behavior. For more information, see Modifying the Windows Registry Parameters That Affect Local Synchronization.

Table Windows Registry Parameters That Affect Local Synchronization

Windows Registry Parameter Description

EnablePeriodicUpstreamSync

Enables or disables local synchronization. The following values are valid:

  • 0. Synchronization is disabled.

  • 1. Synchronization is enabled.

UpstreamSyncIsDefault

Sets the default synchronization type. The following values are valid:

  • 0. Full synchronization

  • 1. Local synchronization

CustomSyncPeriodsUpstream

Specifies the intervals for local synchronization. The default values are:

  • 120 = page-sync-periods-2-hours

  • 240 = page-sync-periods-4-hours

  • 360 = page-sync-periods-6-hours

  • 1440 = page-sync-periods-1-day

You must describe these values in the package_res.xml file as resource strings:

  • <str key="page-sync-periods-2-hours">Once in two hours</str>

  • <str key="page-sync-periods-4-hours">Once in four hours</str>

  • <str key="page-sync-periods-6-hours">Once in six hours</str>

  • <str key="page-sync-periods-1-day">Once a day</str>

SyncPeriodUpstream

Specifies the default value for the local synchronization interval in milliseconds. The default value is 00dbba00 (4 hours).

UpstreamSyncMinThreshold

Disables local synchronization if the general synchronization occurs more frequently than the specified value. The default value is 60000 milliseconds (6 hours).

Windows Registry Parameters That You Can Use with Log Files and Dump Files

This topic describes parameters that you can use with log files and dump files. It includes the following information:

An integer that you can use with a parameter represents a DWORD value in the registry in Windows 7 or a 32-bit DWORD value in the registry in Windows Vista.

    Windows Registry Parameters That You Can Use with the General Log File

    The following table describes the parameters that you can use with the general log.

    Table Parameters That You Can Use with the General Log File

    Parameter Description

    enable

    You can use one of the following values:

    • 1. The general log is enabled.

    • 0. The general log is disabled.

    To disable the general log file, you must use the registry. You cannot use the Logging Configuration dialog box. For more information, see Assigning a Logging Profile to Oracle CRM On Demand Desktop.

    log_level

    Defines the level of detail in the log files. You can use one of the following integers:

    • 4294967295 — Disables all.

    • 0 — Enables all.

    • 1000 — Shows debug information.

    • 2000 — Shows information messages.

    • 3000 — Shows warnings.

    • 4000 — Shows errors.

    • 5000 — Shows fatal errors.

    out_file

    You can include a string that identifies the file name of the general log file. 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 forth. If you do not include the out_file parameter, then Oracle CRM On Demand 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 Oracle CRM On Demand Desktop displays in the VS Debug Output window during a debugging session.

      The OutputDebugString is a string that Oracle CRM On Demand 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 file.

    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 bytes, then Oracle CRM On Demand Desktop creates a new log file. This behavior is similar to setting the rotate_on_start_only parameter to zero (0).

    Note: Log rotation does not occur until Microsoft Outlook is restarted.

    reuse_not_exceeded

    Determines the file that Oracle CRM On Demand 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 Oracle CRM On Demand Desktop reuses this file. The default value is one.

    • 0. Oracle CRM On Demand Desktop does not reuse the most current log file.

    rotate_on_start_only

    Log file rotation is a configuration that Oracle CRM On Demand Desktop uses to limit the size of log files. You can use one of the following values:

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

    • 0. Examines the size of the log file every time Oracle CRM On Demand Desktop writes to the log file. If this log file size is larger than the value that the max_size_bytes parameter specifies, then Oracle CRM On Demand 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 Oracle CRM On Demand Desktop starts.

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

    time_format

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

    • $nano. Nanoseconds.

    • $micro. Microseconds.

    • $mili. Milliseconds.

    • $ss. The seconds expressed as two digits.

    • $mm. The minutes expressed as two digits.

    • $hh. The hour expressed as two digits.

    • $dd. The day expressed as two digits.

    • $MM. The month expressed as two digits.

    • $yy. The year expressed as two digits.

    • $yyyy. he year expressed as four digits.

    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 Oracle CRM On Demand Desktop adds zeros to the value that it creates for the log entry.

    log_format

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

    • %index%. Sequential message index.

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

    • %thread%. The thread ID that Oracle CRM On Demand Desktop uses to log the message.

    • %level%. The logging level for messages in human-readable format.

    • %level_num%. The logging level for messages in numeric format.

    • %log_src%. The source of the logging message. This source can be an internal component of Oracle CRM On Demand Desktop, for example, a connector or application manager.

    starter

    A string that specifies the first message that Oracle CRM On Demand Desktop adds to the log file when it starts logging, for example:

    --- logging is initialized ---

    finisher

    A string that specifies the last message that Oracle CRM On Demand Desktop adds to the log file when it stops logging, for example:

    --- logging is finished ---

    If a log file does not include the last message, then the log file indicates that Oracle CRM On Demand Desktop stopped logging abnormally.

      Windows Registry Parameters That You Can Use with the Exception Log File

      The following table describes the Windows parameters that you can use with the exception log file.

      Table Parameters That You Can Use With the Exception Log File

      Parameter Description

      enable

      You can use one of the following values:

      • 1. The exception log file is enabled.

      • 0. The exception log file 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 general log files when Oracle CRM On Demand Desktop starts.

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

      max_size_bytes

      An integer that sets the maximum number of bytes that a single log file can contain.

      out_file

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

        Windows Registry Parameters That You Can Use with the Crash Dump File

        The following table describes the Windows parameters that you can use with the crash dump file. You can use the following parameters:

        • any_in_trace

        • all_in_trace

        • ex_white_list

        • ex_black_list

        To separate the values in these parameters, you can use the following symbols:

        • , (comma)

        • ; (semicolon)

        • | (vertical bar)

        • / (slash)

        • \t (backslash with a t)

        • (single space)

        Table Parameters That You Can Use with the Crash Dump File

        Parameter Description

        enable

        You can use one of the following values:

        • 1. The general log is enabled.

        • 0. The general log is disabled.

        Count

        An integer that specifies the maximum number of old dump files that Oracle CRM On Demand Desktop preserves in the output logging directory.

        on_top

        A string that specifies the filtering condition for the crash dump file. Oracle CRM On Demand Desktop applies this filtering only if the item you specify resides on top 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 Oracle CRM On Demand Desktop ignores this parameter.

        on_top_op

        You can use one of the following values:

        • 0. Combines 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 the OR logical operator.

        • 1. Combines 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 the AND logical operator.

        • 2. Combines 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 the OR logical operator.

        • 3. Combines 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 the AND logical operator.

        any_in_trace

        A string that specifies a list of items. If the stack trace includes an item that you specify, then Oracle CRM On Demand Desktop saves a crash dump file 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 Oracle CRM On Demand Desktop saves a crash dump file 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 Oracle CRM On Demand Desktop saves a crash dump file 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 Oracle CRM On Demand Desktop saves a crash dump file 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 Oracle CRM On Demand Desktop saves a crash dump file.

        The default value is 0. This default makes sure that Oracle CRM On Demand Desktop always saves a crash dump file.

        ex_white_list

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

        ex_black_list

        A string that specifies a list of C++ exception names that Oracle CRM On Demand Desktop uses but does not create a minidump file. If the white_list parameter is empty, then Oracle CRM On Demand Desktop creates a dump file for all exceptions except the exceptions that the black_list parameter lists.

        sigabrt

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

        • 1. Intercepts the SIGABRT signal to save a crash dump file. You must use this parameter only for troubleshooting. Do not enable it permanently.

        • 0. Does not intercept the SIGABRT signal to save a crash dump file.

        minidump_type

        An integer that specifies the mindump type. The default value is 1 (MiniDumpNormal|MiniDumpWithDataSegs). Use this parameter with caution because other values might increase the size of the crash dump file significantly. For more information, see the documentation about the DumpType parameter of the MiniDumpWriteDump function at the Microsoft MSDN Web site.

          Windows Registry Parameters That You Can Use with the SOAP Dump File

          The following table describes the Windows parameters that you can use with the SOAP dump file.

          Table Parameters That You Can Use with the SOAP Dump File

          Parameter Description

          enable

          You can use one of the following values:

          • 1. The SOAP dump is enabled.

          • 0. The SOAP dump is disabled.

          enable_dbg_window

          You can use one of the following values:

          • 1. Enables output through the OutputDebugString. The SOAP dump displays in the VS Debug Output window during a debugging session.

          • 0. Disables output through the OutputDebugString. The SOAP dump 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 Oracle CRM On Demand 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 Oracle CRM On Demand Desktop uses for generated log files. The default value is xml.

          bin_mode

          You can use one of the following values:

          • 1. Oracle CRM On Demand Desktop uses the \n format to terminate a new line.

          • 0. Oracle CRM On Demand Desktop uses the \r\n format to terminate a new line.

            Windows Registry Parameters That You Can Use with the Synchronization Dump File

            The following table describes the Windows parameters that you can use with the synchronization dump file.

            Table Parameters That You Can Use with the Synchronization Dump File

            Parameter Description

            enable

            You can use one of the following values:

            • 1. The synchronization log is enabled.

            • 0. The 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 Oracle CRM On Demand Desktop uses for logging.