13Reference Information for Siebel CRM Desktop
Reference Information for Siebel CRM Desktop
This chapter describes reference information for Siebel CRM Desktop. It includes the following topics:
Registry Keys You Can Use with Siebel CRM Desktop
This topic describes Windows Registry keys you can use with Siebel CRM Desktop. It includes the following topics:
For more information, see Using the Windows Registry to Control Siebel CRM Desktop.
Registry Keys That Affect Siebel CRM Desktop Behavior
The following table describes the Windows Registry keys that you can modify to change Siebel CRM Desktop behavior. In the Registry Editor (regedit), you can modify these keys in the following path:
HKEY_CURRENT_USER\Software\Oracle\CRM Desktop for IBM Notes
Windows Registry Key | Description |
---|---|
AppLanguageID |
ID of the current installation package of IBM Notes. |
customization_path |
Path to the customization package files. |
DestinationLocation |
Name of the IBM Notes location where the add-in is installed. |
DestinationStore |
Name of the IBM Notes location where the add-in is installed. |
DisableLiveUpdate |
Specifies if the live update feature is allowed. The following values are valid:
|
DisableSyncConfirmation |
Suppresses confirmation for deleting an object. The following values are valid:
The corresponding attribute in the Ln_connector_configuration.xml file of the customization package automatically overwrites the DisableSyncConfirmation key. |
FiltersEstimateOnTimer |
Sets the interval in milliseconds for an automatic estimation of records after the filters are changed in the control panel. The following values are valid:
This entry is not accessible through the administrative interface. |
HTTPClient:AcceptCompression |
A flag that instructs the Web Service Connector to accept zipped HTTP content. This key is not accessible through the administrative interface. |
HTTPClient:CompressOutgoing |
A flag that instructs the Web Service Connector to send zipped HTTP content. This key is not accessible through the administrative interface. |
HTTPClient:ConnectTimeout |
The timeout for the connection in milliseconds. |
HTTPClient:ReceiveTimeout |
The timeout for the receiving requests in milliseconds. |
HTTPClient:SendRetryCount |
The count for the connection retries in milliseconds. |
HTTPClient:SendTimeout |
The timeout for the sending requests in milliseconds. |
LogoutTimeout |
The time to wait in milliseconds after Siebel CRM Desktop sends the log out request. This parameter stops the session without waiting for the reply from the server. |
Page:Feedback:AttachLog |
Specifies a log for the feedback form. The following values are valid:
|
ProxyLogin |
The login 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 |
Flag that specifies a proxy server. The following values are valid:
|
RunPeriodicalSyncAlways |
Determines if Siebel CRM Desktop starts a scheduled synchronization at the scheduled time or waits until IBM Notes is idle. The following values are available:
|
SessionsKeepAliveAmount |
Defines the number of synchronization sessions to store in the internal database as history. Siebel CRM Desktop stores statistical information for each synchronization session. To view information about synchronization issues, the user can use the list control in the Sync Issues tab of the Synchronization Control Panel. |
SharedByDefault:NewItems |
Determines how Siebel CRM Desktop shares newly created IBM Notes items. The SharedByDefault:NewItems registry key controls the following option: Always share with Siebel new: Calendar Entry, Contacts, To Do items To access this option, the user right-clicks the CRM Desktop icon in the system tray, chooses Options, and then clicks the Advanced tab in the CRM Desktop - Options dialog box. |
Siebel:HideSavePasswordOption |
Determines how Siebel CRM Desktop displays the Save Password check box on the login screen. The following values are valid:
|
Siebel:MetaInfoFilePath |
Describes the path to the siebel_meta_info.xml file in the customization package. |
SuppressSyncEstimating |
Estimates the number of objects that Siebel CRM Desktop will synchronize for the current user. The following values are valid:
|
SuppressSyncIssues |
If a synchronization problem occurs, then this key determines if Siebel CRM Desktop changes the application icon in the system tray to an exclamation point and displays a message. The following values are valid:
|
Registry Keys That Affect Credentials
The following table describes the Windows Registry keys that you can modify to change how Siebel CRM Desktop handles credentials. In the Registry Editor (regedit), you can modify these keys in the following path:
HKEY_CURRENT_USER\Software\Oracle\CRM Desktop for IBM Notes\Credentials
Windows Registry Key | Description |
---|---|
RememberPassword |
Determines how Siebel CRM Desktop remembers the password. You can use one of the following values:
|
Siebel:ComponentName |
Siebel Server component name that processes incoming requests. The following value is the default value: eai/enu The Siebel:ComponentName key is appended to the URL. For more information, see Overriding Windows Registry Keys That Locate the Siebel Server. |
Siebel:LoginName |
The name of the Siebel CRM Desktop user who is currently logged in. |
Siebel:Password |
Stores the user password in binary format. |
Siebel:Protocol |
Defines the URL protocol. The default is http. The following values are valid:
|
Siebel:RequestSuffix |
Sets the suffix of the URL to the Siebel Server. The following is the default value: ?SWEExtSource=WebService&SWEExtCmd=Execute&WSSOA P=1 For more information, see Overriding Windows Registry Keys That Locate the Siebel Server. |
Siebel:Server |
Sets the host name of the URL. The default value is empty. |
Siebel:ServerPort |
Sets the port of the URL. The default value is 80. |
Registry Keys That Affect Siebel 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, Siebel 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 Siebel CRM Desktop SSO
The following table describes command-line parameters that you must use with the msiexec.exe installer. Each command-line parameter modifies a Windows Registry key that Siebel 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
Command Line Parameter | Description |
---|---|
SSOENABLE |
Specifies to enable Siebel CRM Desktop SSO. You can use one of the following values:
If disabled, then Siebel CRM Desktop SSO it is not active when Siebel CRM Desktop communicates with Siebel CRM. Siebel CRM Desktop copies the value that the SSOENABLE parameter contains to the |
SSOSCRIPTFILENAME |
Specifies the name of the JavaScript file that implements the Siebel 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 Siebel CRM Desktop copies the value that the SSOSCRIPTFILENAME parameter contains to the For more information about the entry point, see Request Handler Function. |
SSOSCRIPTINCLUDEPATH |
Specifies the directory path where the Siebel 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. Siebel CRM Desktop copies the value that the SSOSCRIPTINCLUDEPATH parameter contains to the For autoupdate, you must use the SSOSCRIPTINCLUDETEMPLATE parameter instead of the SSOSCRIPTINCLUDEPATH parameter. For more information, see Installing Siebel CRM Desktop SSO If You Use Autoupdate. |
SSOUPDATEDISABLE |
Specifies to enable autoupdate. You can use one of the following values:
Siebel CRM Desktop copies the value that the SSOUPDATEDISABLE parameter contains to the |
SSOURL |
Specifies the URL or UNC path that Siebel CRM Desktop uses to download autoupdate information. The default value is an empty string. Siebel CRM Desktop copies the value that the SSOURL parameter contains to the 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 Siebel CRM Desktop SSO If You Use Autoupdate. |
SSOCHECKINTERVAL |
Specifies the timestamp value that Siebel 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 Siebel CRM Desktop ignores this smaller value and sets the interval to 36000000000. The default value is 864000000000 (24 hours). Siebel CRM Desktop copies the value that the SSOCHECKINTERVAL parameter contains to the |
SSOSCRIPTINCLUDETEMPLATE |
Specifies the template that Siebel 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 Siebel CRM Desktop copies the value that the SSOSCRIPTINCLUDETEMPLATE parameter contains to the |
Registry Keys That Control SSO for Siebel CRM Desktop
The following table 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
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:
You can set this default value externally before the first time Siebel 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:
|
EndpointRegExp |
Sets the regular expression that Siebel 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 Siebel 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 Siebel 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 Siebel 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
The following table 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
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:
|
Parameters You Can Use with Log Files
This topic describes parameters that you can use with log files. It includes the following topics:
An integer that you can use with a parameter represents a DWORD value in the registry in Windows XP or a 32-bit DWORD value in the registry in Windows Vista. For more information, see Using the Windows Registry to Control Siebel CRM Desktop.
Parameters You Can Use with the General Log
The following table 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:
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:
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 |
enable_dbg_window |
You can use one of the following values:
|
enable_cout |
You can use one of the following values:
|
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:
|
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:
|
file_count |
An integer that specifies the maximum number of rotated log files. |
initial_erase |
You can use one of the following values:
|
time_format |
A string that specifies the date and dime format in the log files. You can use one of the following values:
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:
|
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. |
Parameters You Can Use with the Exception Log
The following table describes the parameters that you can use with the Exception Log.
Parameter | Description |
---|---|
enable |
You can use one of the following values:
|
file_count |
An integer that specifies the maximum number of rotated log files. |
initial_erase |
You can use one of the following values:
|
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 Siebel CRM Desktop uses for logging. |
Parameters You Can Use with the Crash Log
The following table describes the parameter that you can use with the crash log. You can use the following parameters:
any_in_trace
all_in_trace
ex_white_list
ex_black_list
To separate values in these parameters, you can use the following symbols:
, (comma)
; (semicolon)
| (vertical bar)
/ (forward slash)
\t (backward slash with a t)
(single space)
Parameter Description 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 Siebel CRM Desktop preserves in the output logging directory.
on_top
A string that specifies the filtering condition for the crash log. Siebel 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 Siebel 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 Siebel 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 Siebel 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 Siebel 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 Siebel 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 Siebel CRM Desktop saves a crash log.
The default value is 0. This default makes sure that Siebel 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 Siebel CRM Desktop creates a minilog for this exception.
ex_black_list
A string that specifies a list of C++ exception names that Siebel CRM Desktop uses to not create a minilog. If the white_list parameter is empty, then Siebel CRM Desktop creates a log for all exceptions except the exceptions that the black_list parameter lists.
sigabrt
SIGABRT is a signal that Siebel 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.
Parameter You Can Use with the SOAP Log
The following table describes the parameters that you can use with the SOAP log.
Parameter | Description |
---|---|
enable |
You can use one of the following values:
|
enable_dbg_window |
You can use one of the following values:
|
enable_cout |
You can use one of the following values:
|
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 Siebel CRM Desktop uses in generated XML files. The default value is "" |
file_extension |
A string that specifies the file extension that Siebel CRM Desktop uses for generated log files. The default value is |
bin_mode |
You can use one of the following values:
|
Parameters You Can Use with the Synchronization Log
The following table describes the parameters that you can use with the synchronization log.
Parameter | Description |
---|---|
enable |
You can use one of the following values:
|
file_count |
An integer that specifies the maximum number of rotated log files. |
out_file |
A string that specifies the base file name that Siebel CRM Desktop uses for logging. |
Filters in the CRM Desktop Filter - Edit Criterion Dialog Box
The following table describes the filters that the user can specify in the CRM Desktop Filter - Edit Criterion dialog box. The user chooses values in the Condition field and the Value field to specify a filter. It is recommended that the user use the = (equal) operator or the <> (not equal) operator only for the Exact Date filter. For more information, see Controlling the Date Range in the Filter Records Tab.
Filter | Description |
---|---|
Days From Today |
Sets a date range that includes a specific number of days before or after today. The user can enter one of the following values:
For example, the user can specify one of the following filters:
|
Exact Date |
The user can choose an exact date from the calendar in the CRM Desktop Filter - Edit Criterion dialog box. Siebel CRM Desktop only synchronizes records for the date that the user chooses. For example, the following condition synchronizes activities that are due only for January 1, 2012:
|
Month Ago |
Sets a date range that is related to 30 days prior to today. For example, the user can specify one of the following filters:
|
Month Ahead |
Sets a date range that is related to 30 days after today. For example, the user can specify one of the following filters:
|
Today |
Sets a date range that is related to today. For example, the user can specify one of the following filters:
|
Tomorrow |
Sets a date range that is related to tomorrow. For example, the user can specify one of the following filters:
|
Yesterday |
Sets a date range that is related to yesterday. For example, the user can specify one of the following filters:
|
Threshold That Siebel CRM Desktop Uses to Display the Confirm Synchronization Tab
The following table lists the minimum number of records that the user must delete to cause Siebel CRM Desktop to display the Confirm Synchronization tab. For information on how to configure this behavior, see Specifying the Type of Object the User Can Confirm for Deletion.
Object | Number of Deleted Records |
---|---|
Account |
3 |
Account.Account_Note |
10 |
Account.Assignment_Group.Association |
5 |
Account.Business_Address (HOR) |
10 |
Account.Business_Address.Association (SIA) |
10 |
Account.Contact.Association |
20 |
Account.Industry.Association |
5 |
Account.Position.Association |
20 |
Action |
20 |
Action.Contact.Association |
100 |
Action.Employee.Association |
100 |
Assignment_Group |
Not applicable |
Attachment |
10 |
Business_Address (SIA) |
10 |
Contact |
10 |
Contact.Business_Address.Association (SIA) |
10 |
Contact.Contact_Note |
10 |
Contact.Contact_Sync_Owner |
Not applicable |
Contact.Personal_Address (HOR) |
10 |
Contact.Position.Association |
20 |
Currency |
Not applicable |
Defaults |
Not applicable |
Employee |
Not applicable |
Employee.Position.Association |
Not applicable |
Industry |
Not applicable |
Internal_Division |
Not applicable |
Internal_Product |
Not applicable |
Opportunity |
5 |
Opportunity.Assignment_Group.Association |
5 |
Opportunity.Contact.Association |
20 |
Opportunity.Internal_Division.Association |
5 |
Opportunity.Opportunity_Note |
10 |
Opportunity.Opportunity_Product |
5 |
Opportunity.Position.Association |
20 |
Position |
Not applicable |
Sales_Method.Sales_Cycle_Def |
Not applicable |
Files That the Metadata and Customization Package Contains
This topic describes Files in the Metadata and Customization Package. It includes the following topics:
Files in the Metadata
This topic describes the files in the metadata.
Metadata File Types
The following information lists each of the metadata file types that you must add in the Metadata Files view of the Administration - CRM Desktop screen. You must add only one type in the Metadata File Types view of the Administration - CRM Desktop screen. For example, Metadata Type = LN3.2_package, Metadata File Name = package. If you must support a language other than English, then see Metadata File Types That Support Languages.
For more information, see Files in the Customization Package.
Metadata File Name | Metadata File Type | Customizable |
---|---|---|
action_support.js |
JavaScript |
No |
application_script.js |
JavaScript |
Yes |
autoresolve_helpers.js |
JavaScript |
No |
autoresolver.js |
JavaScript |
Yes |
business_logic.js |
JavaScript |
Yes |
code_pages.xml |
XML |
No |
data_model.js |
JavaScript |
No |
data_sources.xml |
JavaScript |
Yes |
dialogs.xml |
JavaScript |
Yes |
dxl_config.xml |
JavaScript |
Yes |
form_helpers.js |
JavaScript |
No |
info.xml |
XML |
Yes |
ln_connector_configuration.xml |
XML |
Yes |
ln_package_res.xml |
XML |
Yes |
ln_siebel_basic_mapping.xml |
XML |
Yes |
mvg_dialogs.js |
JavaScript |
No |
online_lookup.js |
JavaScript |
No |
online_lookup_sbl.js |
JavaScript |
Yes |
platform_configuration.xml |
XML |
Yes |
recurrence_processing.js |
JavaScript |
NO |
security_manager.js |
JavaScript |
No |
siebel_meta_info.xml |
XML |
Yes |
views.xml |
XML |
Yes |
SD3.Lib.Interfaces.dxl |
Script library |
No |
SD3.Lib.Utils.dxl |
Script library |
No |
SD3.Lib.Errors.dxl |
Script library |
No |
SD3.Lib.Strings.dxl |
Script library |
No |
SD3.Lib.RegistryHelpers.dxl |
Script library |
No |
SD3.Lib.Constants.dxl |
Script library |
No |
SD3.Lib.MQ.dxl |
Script library |
No |
SD3.Lib.BMProvider.dxl |
Script library |
No |
SD3.Lib.Tools.2.dxl |
Script library |
No |
SD3.Lib.HandlerHelpers.dxl |
Script library |
No |
SD3.Lib.DataModel.dxl |
Script library |
No |
SD3.Lib.Validator.dxl |
Script library |
No |
SD3.Lib.Translator.dxl |
Script library |
No |
SD3.Lib.FormHelpers.dxl |
Script library |
No |
SD3.Lib.Actions.dxl |
Script library |
No |
SD3.Lib.ProgressBar.dxl |
Script library |
No |
SD3.Lib.iCalendar.dxl |
Script library |
No |
SD3.Lib.NativePIM.dxl |
Script library |
No |
SD3.Lib.iCalendarUtil.dxl |
Script library |
No |
SD3.Lib.Handlers.dxl |
Script library |
No |
SD3.Lib.PickListDialogs.dxl |
Script library |
No |
SBL.Lib.Constants.dxl |
Script library |
Yes |
SBL.Lib.Strings.dxl |
Script library |
Yes |
SBL.Lib.Helpers.dxl |
Script library |
Yes |
SBL.Lib.SecurityRules.dxl |
Script library |
Yes |
SBL.Lib.Recurrence.dxl |
Script library |
Yes |
SBL.Lib.ActivityHandlers.dxl |
Script library |
Yes |
SBL.Lib.BusinessLogic.dxl |
Script library |
Yes |
SBL.Lib.Actions.dxl |
Script library |
Yes |
SBL.Lib.Handlers.dxl |
Script library |
Yes |
SBL.Lib.PickListDialogs.dxl |
Script library |
Yes |
SBL.Lib.Forms.dxl |
Script library |
Yes |
SD3.Lib.ProductAdapter.dxl |
Script library |
Yes |
SD3.View.AssociationsByLeftId.dxl |
View |
No |
SD3.View.AssociationsByRightId.dxl |
View |
No |
SD3.View.AssociationSearch.dxl |
View |
No |
SD3.View.CRMDocuments.dxl |
View |
No |
SD3.View.MirrorDirectSearch.dxl |
View |
No |
SD3.View.SettingsDefaults.dxl |
View |
No |
SD3.View.ActivityHandlingSrc.dxl |
View |
No |
SBL.View.Accounts.dxl |
View |
Yes |
SBL.View.Activities.dxl |
View |
Yes |
SBL.View.ActivitySearchByParams.dxl |
View |
Yes |
SBL.View.ActivitySearchByPIMObjectId.dxl |
View |
Yes |
SBL.View.ContactsByEmail.dxl |
View |
Yes |
SBL.View.ElementByID.dxl |
View |
Yes |
SBL.View.ActionByAccount.dxl |
View |
Yes |
SBL.View.ActionByOpportunity.dxl |
View |
Yes |
SBL.View.AttachmentsByParent.dxl |
View |
Yes |
SBL.View.NotesByParent.dxl |
View |
Yes |
SBL.View.OpportunityByAccount.dxl |
View |
Yes |
SBL.View.ProductsByParent.dxl |
View |
Yes |
SBL.View.EmployeesByEmail.dxl |
View |
Yes |
SBL.View.PicklistCurrency.dxl |
View |
Yes |
SBL.View.PicklistOpportunitySalesStage.dxl |
View |
Yes |
SBL.View.PicklistsAccount.dxl |
View |
Yes |
SBL.View.PicklistsActivity.dxl |
View |
Yes |
SBL.View.PicklistsAddress.dxl |
View |
Yes |
SBL.View.PicklistsNote.dxl |
View |
Yes |
SBL.View.PicklistsOpportunity.dxl |
View |
Yes |
SBL.View.SalesbookAccounts.dxl |
View |
Yes |
SBL.View.SalesbookAddress.dxl |
View |
Yes |
SBL.View.SalesbookAssignmentGroup.dxl |
View |
Yes |
SBL.View.SalesbookContacts.dxl |
View |
Yes |
SBL.View.SalesbookEmployees.dxl |
View |
Yes |
SBL.View.SalesbookIndustry.dxl |
View |
Yes |
SBL.View.SalesbookInternalDivision.dxl |
View |
Yes |
SBL.View.SalesbookOpportunities.dxl |
View |
Yes |
SBL.View.SalesbookPositions.dxl |
View |
Yes |
SBL.View.SalesbookProducts.dxl |
View |
Yes |
SBL.View.SaleSearch.dxl |
View |
Yes |
SBL.View.SettingsSyncOwner.dxl |
View |
Yes |
SBL.View.Opportunities.dxl |
View |
Yes |
SBL.View.ActivityProcessingSrc.dxl |
View |
Yes |
SBL.Folder.Account.dxl |
Folder |
Yes |
SBL.Folder.AccountAddresses.dxl |
Folder |
Yes |
SBL.Folder.AccountContactWithNew.dxl |
Folder |
Yes |
SBL.Folder.Action.dxl |
Folder |
Yes |
SBL.Folder.Address.dxl |
Folder |
Yes |
SBL.Folder.Contact.dxl |
Folder |
Yes |
SBL.Folder.Employee.dxl |
Folder |
Yes |
SBL.Folder.Industry.dxl |
Folder |
Yes |
SBL.Folder.Opportunity.dxl |
Folder |
Yes |
SBL.Folder.OpportunityContactWithNew.dxl |
Folder |
Yes |
SBL.Folder.Organization.dxl |
Folder |
Yes |
SBL.Folder.Position.dxl |
Folder |
Yes |
SBL.Folder.Territory.dxl |
Folder |
Yes |
SBL.Folder.AccountsFiltered.dxl |
Folder |
Yes |
SBL.Folder.AccountsSelected.dxl |
Folder |
Yes |
SBL.Folder.AddressesFiltered.dxl |
Folder |
Yes |
SBL.Folder.AddressesSelected.dxl |
Folder |
Yes |
SBL.Folder.ContactsFiltered.dxl |
Folder |
Yes |
SBL.Folder.ContactsSelected.dxl |
Folder |
Yes |
SBL.Folder.EmployeesFiltered.dxl |
Folder |
Yes |
SBL.Folder.EmployeesSelected.dxl |
Folder |
Yes |
SBL.Folder.IndustriesFiltered.dxl |
Folder |
Yes |
SBL.Folder.IndustriesSelected.dxl |
Folder |
Yes |
SBL.Folder.OpportunitiesFiltered.dxl |
Folder |
Yes |
SBL.Folder.OpportunitiesSelected.dxl |
Folder |
Yes |
SBL.Folder.OrganizationsFiltered.dxl |
Folder |
Yes |
SBL.Folder.OrganizationsSelected.dxl |
Folder |
Yes |
SBL.Folder.PositionsFiltered.dxl |
Folder |
Yes |
SBL.Folder.PositionsSelected.dxl |
Folder |
Yes |
SBL.Folder.ProductsFiltered.dxl |
Folder |
Yes |
SBL.Folder.ProductsSelected.dxl |
Folder |
Yes |
SBL.Folder.TerritoriesSelected.dxl |
Folder |
Yes |
SD3.Subform.ForwardInvocation.dxl |
Subform |
No |
SBL.Subform.Contact.dxl |
Subform |
Yes |
SBL.Subform.CRMContact.version7.dxl |
Subform |
Yes |
SBL.Subform.CRMContact.version8.dxl |
Subform |
Yes |
SBL.Subform.ActivitySubform.dxl |
Subform |
Yes |
SD3.Form.PickListDialog.dxl |
Form |
No |
SD3.Form.PickListDialogEx.dxl |
Form |
No |
SD3.Form.PickListDialogNarrow.dxl |
Form |
No |
SD3.Form.StartSync.dxl |
Form |
No |
SD3.Form.MVG.dxl |
Form |
No |
SBL.Form.Account.dxl |
Form |
Yes |
SBL.Form.Activity.dxl |
Form |
Yes |
SBL.Form.Address.dxl |
Form |
Yes |
SBL.Form.Note.dxl |
Form |
Yes |
SBL.Form.Opportunity.dxl |
Form |
Yes |
SBL.Form.Product.dxl |
Form |
Yes |
SBL.Form.Attachment.dxl |
Form |
Yes |
SBL.Form.ContactDialog.dxl |
Form |
Yes |
SD3.Agent.NoteCreatedHandler.dxl |
agent |
No |
SD3.Agent.NoteDeletingHandler.dxl |
agent |
No |
SD3.Agent.NoteUpdatedHandler.dxl |
agent |
No |
SD3.Agent.PreSynchronizeProcessor.dxl |
agent |
No |
SD3.Agent.PostSynchronizeProcessor.dxl |
agent |
No |
SD3.Agent.CleanUp.dxl |
agent |
No |
SD3.Agent.SyncNow.dxl |
agent |
No |
SBL.Agent.ShowHelp.dxl |
agent |
Yes |
SBL.Agent.ShareContact.dxl |
agent |
Yes |
SBL.Agent.ShareObject.dxl |
agent |
Yes |
SBL.Outline.ShareBar.dxl |
outline |
Yes |
SD3.Resources.dxl |
image resources |
Yes |
resources.dxl |
image resources |
Yes |
toolbar_images.dxl |
image resources |
Yes |
Metadata File Types That Support Languages
If Siebel CRM Desktop must support a language other than English, then you must add the required language files.
The following table lists each of the metadata file types that you must add to the customization package. For all languages except Japanese, you add only one file for each language that you must support. For example, if you must support only German, then add only the Ln_package_res.de_DE file. For example, if you must support Japanese, then you must add the Ln_package_res.ja_JPfile.
Siebel CRM Desktop includes support for English, by default. You do not need to include a metadata file type for English.
Metadata Type | Metadata File Name |
---|---|
LN Resource Bundle ENG |
Ln_package_res.xml |
LN Resource Bundle SA |
Ln_package_res.ar_SA.xml |
LN Resource Bundle CZ |
Ln_package_res.cs_CZ.xml |
LN Resource Bundle DK |
Ln_package_res.da_DK.xml |
LN Resource Bundle DE |
Ln_package_res.de_DE.xml |
LN Resource Bundle ES |
Ln_package_res.es_ES.xml |
LN Resource Bundle FI |
Ln_package_res.fi_FI.xml |
LN Resource Bundle FR |
Ln_package_res.fr_FR.xml |
LN Resource Bundle IL |
Ln_package_res.he_IL.xml |
LN Resource Bundle IT |
Ln_package_res.it_IT.xml |
LN Resource Bundle JP |
Ln_package_res.ja_JP.xml |
LN Resource Bundle KR |
Ln_package_res.ko_KR.xml |
LN Resource Bundle NL |
Ln_package_res.nl_NL.xml |
LN Resource Bundle PL |
Ln_package_res.pl_PL.xml |
LN Resource Bundle BR |
Ln_package_res.pt_BR.xml |
LN Resource Bundle PT |
Ln_package_res.pt_PT.xml |
LN Resource Bundle RU |
Ln_package_res.ru_RU.xml |
LN Resource Bundle SE |
Ln_package_res.sv_SE.xml |
LN Resource Bundle TH |
Ln_package_res.th_TH.xml |
LN Resource Bundle TR |
Ln_package_res.tr_TR.xml |
LN Resource Bundle CN |
Ln_package_res.zh_CN.xml |
LN Resource Bundle TW |
Ln_package_res.zh_TW.xml |
Files in the Customization Package
To customize some Siebel CRM Desktop features, you can modify XML files and JavaScript files in the customization package. Siebel CRM Desktop includes the following basic customization capabilities:
Adjusting the business logic to suit the business environment
Customizing the user interface
Specifying security and data validation rules
For more information, see Where Siebel CRM Desktop Stores Data in the File System.
Files in the Customization Package
The following table describes the XML files that Siebel CRM Desktop includes in the customization package. For more information, see About the Customization Package.
File Name | Description |
---|---|
Ln_connector_configuration.xml |
This XML file provides the following capabilities:
For more information, see Customizing Synchronization. |
info.xml |
This XML file provides the following capabilities:
You can use it to track the package version. You can use the product name and version to check compatibility. For more information, see How Siebel CRM Desktop Determines Compatibility. |
Ln_package_res.xml |
Defines various resources for the customization package. |
platform_configuration.xml |
Defines the configuration for the platform. For example, the platform_configuration.xml file defines how to do the following:
|
Ln_siebel_basic_mapping.xml |
This XML file provides the following capabilities:
For more information, see Customizing Field Mapping. |
siebel_meta_info.xml |
This XML file provides the following capabilities:
For more information, see Customizing Meta Information. |
JavaScript Files in the Customization Package
The following table describes the JavaScript files that Siebel CRM Desktop includes in the customization package.
JavaScript File Name | Description |
---|---|
autoresolver.js |
Defines functions to resolve conflicts. |
autoresolve_helpers.js |
An internal Siebel CRM Desktop file. You must not modify this file. |
application_script.js |
Defines entry points for scripts and to call scripts from other files. |
business_logic.js |
Defines logic for the following items:
|
data_model.js |
Defines the data model and functions for objects. |
recurrence_processing.js |
Defines patterns for recurrence processing. For more information, see How Siebel CRM Desktop Transforms Objects Between Siebel CRM Data and IBM Notes Data. |
JavaScript Files That Siebel CRM Desktop Uses Internally
Siebel CRM Desktop uses the following files internally. You must not modify these files:
autoresolve_helpers.js
data_model.js
IBM Notes Field Types and Equivalent Convertor Classes
This topic includes example IBM Notes field types and their equivalent convertor classes. Siebel CRM Desktop defines IBM Notes field types in the Ln_siebel_basic_mapping.xml file.
Example of a String Field
The following code is an example of a string field:
<field id="First Name" ver="1"> <reader> <lotus_std> <lotus_field id="FirstName"/> <convertor> <string/> </convertor> </lotus_std> </reader> <writer> <lotus_std> <lotus_field id="FirstName"/> <convertor> <string/> </convertor> </lotus_std> </writer> </field>
Example of a Double Field
The following code is an example of a double field:
<field id="Primary Revenue Amount" ver="1"> <reader> <lotus_std> <lotus_field id="Revenue"/> <convertor> <double/> </convertor> </lotus_std> </reader> <writer> <lotus_std> <lotus_field id="Revenue"/> <convertor> <double/> </convertor> </lotus_std> </writer> </field>
Example of a Binary Hex String Field
The following code is an example of a Binary hex string field:
<field id="CurrentUser" ver="1"> <reader> <lotus_std> <lotus_field id="CRMDSibelCurrentUser"/> <convertor> <binary_hexstring/> </convertor> </lotus_std> </reader> <writer> <lotus_std> <lotus_field id="CRMDSibelCurrentUser"/> <convertor> <binary_hexstring/> </convertor> </lotus_std> </writer> </field>
Example of a Boolean Field
The following code is an example of a Boolean field:
<field id="PersonAccountEnabled" ver="1"> <reader> <lotus_std> <lotus_field id="CRMDSibel_PA_Enabled"/> <convertor> <string_boolean/> </convertor> </lotus_std> </reader> <writer> <lotus_std> <lotus_field id="CRMDSibel_PA_Enabled"/> <convertor> <string_boolean/> </convertor> </lotus_std> </writer> </field>
Example of a Datetime Field
The following code is an example of the datetime field:
<field id="Planned" ver="1"> <reader> <lotus_std> <lotus_field id="StartDateTime"/> <convertor> <datetime/> </convertor> </lotus_std> </reader> <writer> <lotus_std> <lotus_field id="StartDateTime"/> <convertor> <datetime/> </convertor> </lotus_std> </writer> </field>
Example of a Date Field
The following code is an example of a date field:
<field id="Primary Revenue Close Date" ver="1"> <reader> <lotus_std> <lotus_field id="CloseDate"/> <convertor> <date/> </convertor> </lotus_std> </reader> <writer> <lotus_std> <lotus_field id="CloseDate"/> <convertor> <date/> </convertor> </lotus_std> </writer> </field>
Example of a Number Field
The following code is an example of a number field:
<field id="SortOrder" ver="1"> <reader> <lotus_std> <lotus_field id="SortOrder"/> <convertor> <number/> </convertor> </lotus_std> </reader> <writer> <lotus_std> <lotus_field id="SortOrder"/> <convertor> <number/> </convertor> </lotus_std> </writer> </field>
Example of a Double String Field
The following code is an example of a double string field:
<field id="Primary Revenue Win Probability" ver="1"> <reader> <lotus_std> <lotus_field id="Probability"/> <convertor> <double_string/> </convertor> </lotus_std> </reader> <writer> <lotus_std> <lotus_field id="Probability"/> <convertor> <double_string/> </convertor> </lotus_std> </writer> </field>
Example of an Integer Field
The following code is an example of an integer field:
<field id="ObjectState" ver="1"> <reader> <lotus_std> <lotus_field id="ObjectState"/> <convertor> <int_string/> </convertor> </lotus_std> </reader> <writer> <lotus_std> <lotus_field id="ObjectState"/> <convertor> <int_string/> </convertor> </lotus_std> </writer> <writer> <lotus_std> <lotus_field id="ObjectStateString"/> <convertor> <flags mask="-IS-P--------------------------V"/> </convertor> </lotus_std> </writer> </field>