Go to primary content
Siebel CRM System Administration Guide
Siebel 2018
E24823-01
  Go to Documentation Home
Home
Go To Table Of Contents
Contents
Go To Index
Index

Previous
Previous
 
Next
Next
    View PDF

Data Source Parameters

This section describes parameters that pertain to the [DataSources] section of the configuration file and to the individual data source sections that follow.

These parameters apply only to Siebel Mobile Web Client. For the Siebel Web Client. The parameters are defined as server parameters on the Application Object Manager.

Parameters for DataSources Section

Table B-4 lists data sources in the Siebel configuration file, which appear in the [DataSources] section. Each data source also has its own section specifying parameters that apply to this data source.

Table B-4 Data Sources

Name Function

Local

Defines parameters for connecting to the local database.

Sample

Defines parameters for connecting to the sample database.

ServerDataSrc

Defines parameters for connecting to the Siebel database.

GatewayDataSrc

Defines Siebel Gateway parameters.



Note:

If you want to prevent a data source from being displayed as a choice in the Connect To: portion of the Siebel login screen, then add two slash characters (//) in front of the data source in the [DataSources] section of the configuration file. For example: //Sample = Sample.

Parameters for Individual Data Source Sections

Table B-5 lists parameters that specify properties associated with the different data sources listed under [DataSources]. Each data source section defines the properties of the particular data source.

Table B-5 Data Source Parameters

Name Comment

CaseInsensitive

True or False. If it is True, then the client is notified to work with the database in case-insensitive mode.

See also the description of the InsensitivityFactor parameter for data sources.

Note: Queries against fields of type DTYPE_ID are always case-sensitive, even if the CaseInsensitive parameter is set to True. For more information, see Siebel Applications Administration Guide.

ConnectString

Database-dependent string that defines how to connect to the database (also referred to as the connection string).

The ConnectString parameter is also used to specify the Siebel Gateway computer in the GatewayDataSrc section. In the Siebel Mobile Web Client's configuration file, you must specify the Siebel Gateway's hostname, preferably in a fully qualified form like node.domain.xxx. Failure to specify this parameter correctly results in the server administration screens being inaccessible.

For more information about using connection strings for different server databases, see the Siebel Installation Guide for the operating system you are using.

ContactLogin

True or False. If it is True, then it indicates that the corresponding data source uses contact login, rather than employee login. Because a contact user is generally not associated one-to-one with a database account, you must use a security adapter to support contact users.

If it is False, then the data source is using employee login, rather than contact login.

DisableExecuteRetry

True or False. When set to True, this parameter prevents the client from resending a query to the database layer if an error occurs such as a network error or session kill.

DLL

Name of the DLL file to use for the database connector code. The names differ depending upon whether you are using Oracle Database, Microsoft SQL Server, IBM DB2, and so on.

Docked

Determines which database connection the application login screen for a Mobile Web Client defaults to. For example, if Docked is True in the [ServerDataSrc] section of the configuration file and Docked is False in the [LOCAL_XE] section of the configuration file, then the application login screen defaults to the server database rather than the local database. The values used in this example are the default values.

DockConnString

Name of the docking server (Siebel Remote Server). It is the computer name of the Siebel Server against which the Mobile Web Client synchronizes.

DockRecvTxnsPerCommit

Number of transactions received by the Mobile Web Client before a commit is issued to the database. The default value for this parameter is 10. Change the setting to:

  • A higher value if you have a fast network connection, such as a LAN. Increasing the value can provide better performance when synchronizing the Mobile Web Client with the server.

  • A lower value if you have a lower-bandwidth network connection, such as a modem.

DockTxnsPerCommit

Number of transactions processed before a commit is issued to the database.

EnterpriseServer

Name of the Siebel Enterprise Server.

FileSystem

Specifies how the Mobile or Siebel Developer Web Client (for administrative purposes) accesses the Siebel File System. The value of this parameter cannot exceed 2048 characters. Generally, FileSystem and other parameters identified in this table are set during the Siebel client installation.

Mobile Web Client. The following scenario for setting the FileSystem parameter applies to the Siebel Mobile Web Client. Install the Siebel File System locally on a Mobile Web Client, so that it is accessible when the client is not connected to the network and can be synchronized using Siebel Remote:

Set the following parameter, where FS_location is a UNC location or a drive-letter path to the location on the client computer where the local Siebel File System was installed:

FileSystem = FS_location

Developer Web Client. The following scenarios for setting the FileSystem parameter apply to the Siebel Developer Web Client when used for administrative purposes. Make sure that users on the Siebel Developer Web Client have physical access privileges for the Siebel File System directories:

  • If the Developer Web Client installation uses File System Manager (alias FSMSrvr), then set the following parameters:

    FileSystem = *FSM*
    GatewayAddress = Siebel_Gateway_hostname
    EnterpriseServer = Siebel_Enterprise_Server_name
    
  • If the Developer Web Client installation does not use FSMSrvr, then set the following parameter, where FS_location is a UNC location or a drive-letter path to the location on a network computer where the Siebel File System was installed:

    FileSystem = FS_location
    

If your networked Siebel File System resides on a UNIX server, then you require a cross-platform NFS file system mounting tool to connect from Siebel Developer Web Clients running on Windows computers.

GatewayAddress

Host name or IP address of the Siebel Gateway.

Hidden

True or False. Determines if the data source shows up in the login screen's picklist of data sources.

InsensitivityFactor

Set to a positive integer value (default is 2). Applies only when the CaseInsensitive parameter is True for the data source. The value controls the number of characters in each string that are treated as case-insensitive in a query. Not all database vendors support case-insensitivity efficiently, so this feature provides an approximate solution.

See also the description of the CaseInsensitive parameter for data sources.

The following is an example SQL WHERE clause generated when searching for an opportunity named New, when InsensitivityFactor is set to 2.

WHERE
((S_OPTY.NAME LIKE 'ne%' OR
S_OPTY.NAME LIKE 'Ne%'OR
S_OPTY.NAME LIKE 'nE%'OR
S_OPTY.NAME LIKE 'NE%')
AND
UPPER(S_OPTY.NAME)=UPPER('New'))

This example shows that all of the permutations of the first two letters of the string New are checked. With a higher factor, the number of permutations grows exponentially, and performance suffers.

Note: Do not set this parameter to a value higher than 13.

InsUpdAllCols

True or False. Ordinarily, when the Siebel application generates INSERT or UPDATE statements to send to the database, the actual statement contains only the columns where data is present or has changed. When there are situations where you generate many statements on a particular table, the differences in the values being updated might prevent you from using an array interface supported by the DBMS.

When this feature is set to True, all of the columns are present in all INSERT and UPDATE statements. Where two statements are issued against the same table in the same business component as part of a batch operation, this setting automatically enables the statements to use any existing array feature of the DBMS.

IntegratedSecurity

True or False. When True, the Siebel client is prevented from prompting the user for a user name and password when the user logs in. Facilities provided in your existing data server infrastructure determine whether the user is allowed to log into the database.

This parameter is set for your server data source. However, it is supported for Oracle Database and Microsoft SQL Server databases only. The default value is False.

For additional information, refer to your third-party documentation. For Oracle Database, refer to the OPS$ and REMOTE_OS_AUTHENT features. For Microsoft SQL Server, refer to Integrated Security.

MaxCachedCursors

Specifies the maximum number of SQL cursors that can be cached in memory for a database connection. The default is 16.

Caching SQL cursors can improve response time and CPU usage because an SQL cursor does not have to be prepared each time it is executed. If memory usage is not a concern, then you might consider increasing the value of this parameter.

MaxCachedDataSets

Specifies the maximum number of data sets that can be cached in memory for a database connection. The default is 16.

A data set is the set of records that has been retrieved by the execution of a business component. Data-set caching applies only to those business components for which the Cache Data property has been set in Oracle's Siebel Tools.

Caching data sets for frequently visited business components can improve response time and CPU usage. If memory usage is not a concern, then you might consider increasing the value of this parameter.

MaxConnections

Number of connections that can be made to the data source database server.

MaxCursorSize

Sets the total number of rows that can be returned in a result set. MaxCursorSize is intended for use only with IBM DB2 for OS/390 and z/OS, and must be set as described in Implementing Siebel Business Applications on DB2 for z/OS. If you are using another database, then do not set this parameter to any value other than the default value (-1), or database behavior is adversely affected. MaxCursorSize and PrefetchSize are used together, and they must be set to the same value. See also the description for the PrefetchSize parameter.

NonSQL

True or False. Setting that indicates that the data source does not use an SQL DBMS to retrieve its data. Use this parameter only in conjunction with a specialized business component that your company builds internally. Never use this parameter arbitrarily.

PrefetchSize

Sets the number of rows that the Siebel application reads initially as part of a query execution. PrefetchSize is intended for use only with IBM DB2 for OS/390 and z/OS, and must be set as described in Implementing Siebel Business Applications on DB2 for z/OS. If you are using another database, then do not set this parameter to any value other than the default value (-1), or database behavior is adversely affected. MaxCursorSize and PrefetchSize are used together, and they must be set to the same value. See also the description for the MaxCursorSize parameter.

PrimaryEnterprise

The name of the Enterprise Server that you want to administer from the client computer. Set this parameter to view or change information in the server administration views.

ReverseFillThreshold

When the current query contains many rows, it might be very inefficient for the user to click End try to display and read them all sequentially. For this reason, the customer might configure a threshold value to invert the current sort, re-execute the query, and fill the data buffers from the end. These internal operations are hidden from the user.

SqlStyle

Indicates what kind of SQL to send to the database that you are using. When generating SQL to send to a DBMS, the application constructs the SQL statement to suit the particular DBMS.

The value of this parameter is automatically set by the Siebel client installer or by initial server configuration, according to database information that you specified.

The local database or Sample Database, based on Oracle Database XE, uses OracleCBO (the same as Oracle Database Enterprise). IBM DB2 and Microsoft SQL Server use the style applicable to the particular DBMS.

TableOwner

In a database, tables are identified by both their owner and their name. When queries that reference tables are issued, the table owner must be included in those references (for example, SIEBEL.S_EVT_ACT, where SIEBEL is the table owner). Siebel Server infrastructure and system management components, such as SRBroker and SRProc, read the value of this parameter. For Application Object Manager server components, you specify the table owner by setting a value for the Datasource Table Owner (alias DSTableOwner) named subsystem parameter.

UpperCaseLogin

The default is False. If it is set to True, then the user ID, when a user logs in, is converted to uppercase before it is sent to the database for authentication. This value is applicable only if the database is used for authentication. The value of the parameter is ignored when SecurityAdapter is set to a nonempty value.

Use this parameter if you want to enforce a policy of having all of the database accounts in uppercase on a case-sensitive database, but you do not want users to worry about case when they type in their user names.

Note: The value of UpperCaseLogin does not affect the password.

UseDictionaryinTransactionLogging

To avoid the diccache.dat creation while using the Developer Web Client connected to the database server, add this parameter to the [ServerDataSrc] section in the configuration file.

UseDictionaryInTransactionLogging = False

Note: This parameter is not supported if you plan to use Siebel Remote and synchronize between client and server. If you plan to perform only testing and administration tasks connected against the database server, then you will not be affected. For Siebel Remote testing, use the Siebel Web Client and the Siebel Mobile Web Client.