We have moved to a Please visit there for updated posts

Monday, October 1, 2007

Siebel CRM - Configuration File (cfg) Disected and Explained.

Today we are going to discuss about one of the most important files for Siebel CRM. Yes, those who have worked on Siebel will know what I am talking about.
Yes, we are going to discuss ".cfg" file which stands for configuration file which largley controls siebel bhavieor. There are basically 3 important cfg files.

1. eapps.cfg
2. tools.cfg
3. cfg file for Siebel Client(Name can depend on the kind of siebel application you are using)
so for this article we will assume uagent.cfg which is used if you are using call center.

To discuss eapps.cfg is out of scope for this article so in this article we will be discussing tools.cfg and uagent.cfg file.

Tools.cfg is used for Siebel Tools and uagent exsits for Siebel Client both dedicated and thin. First of all the location of the file.

Tools.cfg exsits in :siebel installation directory\tools\bin\enu
Here enu means the language that you have choosen. It can be different if you have installed siebel tools in langauage other than english.

uagent.cfg exsits in : siebel installation directory\web client\bin\enu.
For thin client the cfg file exsits on server and the path is
/siebel install dir/siebsrvr/bin/enu if the server is Unix
siebel install dir\siebsrvr/bin/enu if the server is Windows
Now I will describe various sections of CFG file.

In CFG file anything that starts from [] is a section that contains certain Parameters to control siebel. I will list important sections that are important and we need modify them often

1. [Siebel]
2. [DataSources]
3. [Local]
4. [Sample] Only used if you have installed sample database
5. [ServerDataSrc] Very important and modified often.
6. [SWE]

Tip: If you want to comment anything in cfg file use ; a semicolon in front of any line would mean that siebel is going to ignore that line treating it as comment.
I am goint to list only the important parameters in the sections.

1. [Siebel] : This section contains important parameters related to siebel. Which are as following

RepositoryFile :Name of the SRF file to be used
ApplicationName :Name of the Application to be used
ApplicationTitle :Name that is going to appear in Title of your browser window and can be anything
ApplicationSplashText :Name that is going to appear when you start you dedicated client and can be anything
EnableScripting :Often used for debugging purposes. If set to false no script is going to execute when you start you client
LocalDbODBCDataSource :Name of the ODBC data source that is going to be used when you start dedicated client with local database (SSD Local Db default instance by default)
ServerDbODBCDataSource :Name of the ODBC data source that is going to be used when you start dedicated client with server database (SSD default instance by default)
:Name of the repository that is going to be used.
WebClientSiteDir : Path to the directory from where the browser scripts and images are going to be picked up
EnablePersonalization : To Enable or Disable personlaization for Siebel Users
EnableRuntimeEvents : To Enable or disable Runtime Events
EnableObjectCOCI : To Enable object check in check out when set to false you are not allowed to check out a single object. Remember Object checkout has to be enabled from tools also before you can do that

2. [DataSources] : This section contians the what you can see from the dropdown of you dedicated client. Default values are
Local = Local
Sample = Sample
ServerDataSrc = Server

You can specify more datasources under this section to specify more section you have to define it in the following way.

MyNewDataSource = NewDataSource
MyNewDataSource is the name of the Section that should be present in the cfg file that is going to contain parameters to be used for this datasource
'NewDataSource' is the value that is going to appear in the dropdown of dedicated siebel tools or client.
3. [Local] : In this section only one parameter is important and that we can change to our advantage
ConnectString = C:\PROGRA~1\Siebel\7.8\Tools\local\sse_data.dbf -q -m -x NONE -gp 4096 -c256m -ch256m

As you can see the value of the connection string is in the form of Path and then switches.

The path is the path to your dbf file and the switches that you can give are as following
-q : means start local database in quite mode.This prevents a SQL Anywhere window from showing up.
-m : truncate transaction log after checkpoint.
-x NONE : Do not load any network drivers.
-gp 4096 : Tells the engine that the database page size is 4,096 bytes.
-c256m : Initial cache size is 256 MB
-ch256m : Maximum cache size can be mb256.

4. [Sample] : This section is pretty similar to Local Section with exception of one parameter

FileSystem : It contains path to you file system where you attachments are stored

5. [ServerDataSrc] : This is one of the most important section and you have to change few parameter before you can actually login to server through Dedicated Client.

ConnectString : Here just like local section indicates the connection string to be used to connect to server
FileSystem : Path to you file system. Similar to local section
GatewayAddress : This will contain the name of your Siebel Gateway Server. This section has to be changed to a valid value
EnterpriseServer : This will contain the name of your Siebel Enterprise Server.This section has to be changed to a valid value

6. [SWE] : This section contains parameters related to the bitmaps and appearance of Siebel Client. But It contains an important parameter which is as following.

ClientBusinessService : This parameter is used if you want a business service to be called from browser scripts. The Business service has to be mentioned here in this section.
The format to mention the business service is

ClientBusinessServicen = "Business Service Name" where n is a incremental number one more than the number mentioned in last ClientBusinessService entry. For example
ClientBusinessService0 = "Message Bar"
ClientBusinessService1 = "Communications Client"

If I want to have one more entry in the file then I will enter
ClientBusinessService2 = "Business Service Name"

This completes the listing and explaination of important parameters of the cfg file used by siebel tools and siebel client.

Hope this post was helpful to you. If yes please post your comments and visit again for more.


John said...

This is a very good concise overview of the CFG file. Thank you!

Anonymous said...

This is very good description on cfg files.It will useful for the beginers.

You Might want to read following articles also.