Siebel CRM Desktop for IBM Notes Administration Guide > Reference Information for Siebel CRM Desktop > Registry Keys You Can Use with Siebel CRM Desktop >

Registry Keys That Affect CRM Desktop SSO


This topic describes the Windows registry keys that affect CRM Desktop SSO. It includes the following topics:

You must not modify the following Windows registry keys:

  • UpdateLastCheck. A timestamp value in 100 UTC nanosecond units that stores the time and date of the last successful or unsuccessful update attempt.
  • UpdateZipTimestamp. A timestamp value in 100 UTC nanosecond units that stores the time and date of the last successful update.

To establish an outgoing HTTP connection, CRM Desktop SSO also uses the following registry keys:

  • HTTPClient keys
  • Proxy keys

For more information, see Overview of Customizing Authentication.

Windows Registry Keys You Must Set to Enable CRM Desktop SSO

Table 22 describes command-line parameters that you must use with the msiexec.exe installer. Each command-line parameter modifies a Windows Registry key that CRM Desktop SSO requires. For more information, see Using the Windows Command Line to Set Optional Parameters.

In the Registry Editor (regedit), you can modify these keys in the following path:

HKEY_CURRENT_USER\Software\Oracle\CRM Desktop\SSO

Table 22. Windows Registry Keys You Must Set to Enable CRM Desktop SSO
Command Line Parameter
Description

SSOENABLE

Specifies to enable CRM Desktop SSO. You can use one of the following values:

  • 0. Disable CRM Desktop SSO. The default value is 0.
  • 1. Enable CRM Desktop SSO.

If disabled, then CRM Desktop SSO it is not active when CRM Desktop communicates with Siebel CRM.

CRM Desktop copies the value that the SSOENABLE parameter contains to the SSO\Enable registry key.

SSOSCRIPTFILENAME

Specifies the name of the JavaScript file that implements the CRM Desktop SSO logic. This file must define the entry point for SSO scenario handling. The file name must be relative to the directory that the SSOSCRIPTINCLUDEPATH parameter specifies.

The default value is sso.js.

CRM Desktop copies the value that the SSOSCRIPTFILENAME parameter contains to the SSO\ScriptFileName registry key.

For more information about the entry point, see Request Handler Function.

SSOSCRIPTINCLUDEPATH

Specifies the directory path where the CRM Desktop SSO script file resides. This directory must also contain any files that this script references. For example:

C:\users\user1\AppData\Roaming\Oracle\CRM Desktop\bin

The default value is an empty string.

CRM Desktop copies the value that the SSOSCRIPTINCLUDEPATH parameter contains to the SSO\ScriptIncludePath registry key.

For autoupdate, you must use the SSOSCRIPTINCLUDETEMPLATE parameter instead of the SSOSCRIPTINCLUDEPATH parameter. For more information, see Installing CRM Desktop SSO If You Use Autoupdate.

SSOUPDATEDISABLE

Specifies to enable autoupdate. You can use one of the following values:

  • 0. Enable autoupdate. The default value is 0.
  • 1. Disable autoupdate.

CRM Desktop copies the value that the SSOUPDATEDISABLE parameter contains to the SSO\UpdateDisable registry key. For more information, see Installing CRM Desktop SSO If You Use Autoupdate.

SSOURL

Specifies the URL or UNC path that CRM Desktop uses to download autoupdate information.

The default value is an empty string.

CRM Desktop copies the value that the SSOURL parameter contains to the SSO\UpdateZIPURL registry key.

You must make sure you set this parameter during deployment. If you do not, then autoupdate will not work.

If you use external provisioning, then the SSOURL parameter is not required. For more information, see Installing CRM Desktop SSO If You Use Autoupdate.

SSOCHECKINTERVAL

Specifies the timestamp value that CRM Desktop uses as the minimum time interval between update attempts. It measures this value in 100 nanosecond units. If this value is smaller than 36000000000 (1 hour), then CRM Desktop ignores this smaller value and sets the interval to 36000000000.

The default value is 864000000000 (24 hours).

CRM Desktop copies the value that the SSOCHECKINTERVAL parameter contains to the SSO\UpdateCheckInterval registry key.

SSOSCRIPTINCLUDETEMPLATE

Specifies the template that CRM Desktop uses to create a unique directory name. It uses this directory to store the scripts that it downloads from the URL that the SSOURL parameter identifies. You must use the following format:

%path%

For example:

%appdata%

The default value is %appdata%\InvisibleSSO\Script.

CRM Desktop copies the value that the SSOSCRIPTINCLUDETEMPLATE parameter contains to the SSO\ScriptIncludeTemplate registry key.

Registry Keys That Control SSO for Siebel CRM Desktop

Table 23 describes the Windows Registry keys that you can modify to control SSO for Siebel CRM Desktop. For more information, see the topic about Regular Expression Syntax for JavaScript at the Microsoft Developer Network web site. You can modify these keys in the following path in the Registry Editor (regedit):

HKEY_CURRENT_USER\Software\Oracle\CRM Desktop

Table 23. Windows Registry Keys That Control SSO for Siebel CRM Desktop
Windows Registry Key
Description

AuthType

Determines the authentication type that the CRM Desktop-Login dialog box displays, by default. You can set it to one of the following values:

  • DIRECT
  • NTLM
  • SSO

You can set this default value externally before the first time CRM Desktop runs. If you do this, then you must make sure the external value you provide is the same value that the following key contains:

HKEY_CURRENT_USER\Software\Oracle\CRM Desktop\SSO\Enable

You must set this Enable key to one of the following values:

  • 1 for NTML or SSO
  • 0 for DIRECT

EndpointRegExp

Sets the regular expression that CRM Desktop uses to evaluate the rule that stops the interactive authentication. It must match the URL of the last web page that the interactive authentication displays.

If you do not set EndpointRegExp, then CRM Desktop compares the URL that displays the login dialog box to the URL that displays the last web page.

SuccessLoginRegExp

Sets the regular expression that CRM Desktop uses to evaluate the rule that stops the interactive authentication. It must match the body of the last web page that the interactive authentication displays.

If you do not set SuccessLoginRegExp, then CRM Desktop compares the page contents to the following regular expression:

FAULTSTRING.*?10944629

This expression matches the response that the Siebel EAI server returns in reply to an empty GET request. It is a SOAP FAULT response that includes a message that indicates that it passed the empty request body. This is the default value.

Registry Keys That Control SSO for Credentials

Table 24 describes the Windows Registry keys that you can modify to control SSO for credentials. You can modify these keys in the following path in the Registry Editor (regedit):

HKEY_CURRENT_USER\Software\Oracle\CRM Desktop\Credentials

Table 24. Windows Registry Keys That Control SSO for Credentials
Windows Registry Key
Description

Siebel:SSOUser

Specifies the value for the user name that Siebel CRM SSO enforces for installation.

Applicable only if the authorization type is SSO.

If you:

  • Set Siebel:TrustToken. The User name field is read-only and Siebel CRM SSO automatically populates a value in this field.
  • Do not set Siebel:TrustToken. The user can enter a value in the User name field.
Siebel CRM Desktop for IBM Notes Administration Guide Copyright © 2018, Oracle and/or its affiliates. All rights reserved. Legal Notices.