This appendix lists and describes the content of the eapps.cfg file.The eapps.cfg file is divided into sections that can be used to configure a selection of Siebel eBusiness Applications from a global standpoint or at the application level. These sections are described in the following pages. A number of parameters can also be manually input to control security, the ports used for Web server communications, and other operations.

The file includes language-specific Application Object Manager connect strings for every language supported by Siebel eBusiness Applications in the current release for every supported Siebel application. The format for the connect string is as follows:

ConnectString = siebel.transport.encryption.compression://server:server_port/enterprise/AppObjMgr

where:

transport = Networking transport protocol.

encryption = Encryption type. Make sure the value chosen here is the same as that for the Encryption Type parameter. See Siebel Server Parameters for further information on this parameter.

compression = Data compression method. Make sure the value chosen here is the same as that for the Compression Type parameter. See Siebel Server Parameters for further information on this parameter.

server = IP address or hostname of the Siebel Server (or in the load-balanced case, the virtual IP address).

server_port = Port number on which the Siebel Connection Broker component (alias SCBroker) runs (or in the load-balanced case, the virtual port number). By default, this port number is 2321.

enterprise = Siebel Enterprise Server name.

AppObjMgr = Relevant Application Object Manager.

For example:

ConnectString=siebel.TCPIP.none.None:\\SiebSrvr1:2321\Siebel\SalesCEObjMgr_sve\

Parameter Descriptions

These parameters appear in the eapps.cfg file, located in the \BIN subdirectory of your \SWEApp installation directory ($SWEAPP_ROOT/bin on UNIX). The values you see are a combination of default settings and the values that you selected during the installation and configuration process. You can edit these parameters post-installation, as described in the following subsection.

[swe] Section

The parameters that follow can be found in this section of the eapps.cfg file. These parameters apply to all the selected Siebel eBusiness Applications.

Language

This is the language version of Siebel eBusiness Applications. For example, enu stands for U.S. English.

NOTE:  To configure SWSE logging, set the appropriate environment variables. For information on this procedure, see System Monitoring and Diagnostics Guide for Siebel eBusiness Applications.

Log Directory

This is the location of the log directory, whose default location is

\SWEApp\LOG (WINDOWS)

$SWEAPP_ROOT/log (UNIX)

ClientRootDirectory

This is the location of SWSE plug-in installation, whose default location is SWEAPP_ROOT

SessionMonitor

Use this parameter to determine whether to gather statistics on all current sessions and report them in the SWSE stats page. To enable session monitoring, set SessionMonitor to TRUE. When this parameter is set to TRUE, the SWSE stats page contains information on sessions of users who have logged in to the system. If a user exits properly, using file->logout, this information is removed from the stats page. If a user exits out of the application by closing the application or if the session times out, the session information remains on the stats page until the Web server is restarted.

Session data includes each user's Username and unencrypted Session ID, so it is important to restrict visibility to the SWSE stats page when SessionMonitor is enabled. To prevent non-administrators from viewing the SWSE stats page, you can change the StatsPage parameter to a value known only to administrators.

If SessionMonitor is disabled (set to FALSE), sessions remain unmonitored and do not appear on the application SWSE stats page.

NOTE:  The collection of session information results in a slight degradation in performance.

AllowStats

This parameter enables or disables application-specific statistics reporting in the SWSE stats page. To enable the collection of application-specific statistics, set AllowStats to TRUE. AllowStats set to FALSE disables statistics gathering. The default is TRUE (enable statistics collection).

NOTE:  If set to FALSE, only system-level statistics are displayed on the SWSE stats page.

LogSegmentSize

This parameter determines how large a segment of the log file is in kilobytes. If you set this parameter to 5, the log segment will be 5 KB in size. A value of 0 turns off segmentation.

LogMaxSegments

This parameter determines the number of log segments that will be kept. If you set this parameter to 1, only one segment is kept. When this segment reaches the size specified by the Log Segment Size parameter, the segment is overwritten. In general, you should set this parameter to a higher value, such as 20. In this case, the twenty-first segment overwrites the first segment, and so forth.

A value of 0 turns segmentation off.

SessionTracking

The Siebel Web Engine maintains user session information through cookies or information contained in Web page URLs. The SessionTracking parameter sets the preferred method of maintaining session information.

SessionTracking has three values:

• Automatic (Default). Detects whether the client is capable of supporting cookies. If so, session information is maintained through cookies. If not, it is maintained through URLs.
• URL. Forces session information to be passed through the URL.
• Cookie. Forces session information to be passed through cookies. This selection is known as cookieless session mode. Web browsers with cookies disabled cannot maintain a Siebel user session.

[defaults] Section

The parameters that follow apply to all the Siebel eBusiness Applications whose connect strings are referenced in this file. Any of the settings that can be specified under [defaults] can be also specified for individual eApplications (such as /esales) in the [xxx] section. If such a parameter is set for a particular Siebel eBusiness Application, it overrides the value listed in [defaults].

AnonUserName

This parameter specifies the user name required for anonymous browsing and initial access to the login pages. The user name selected should have access to views intended for anonymous browsing, but it should otherwise be the name of a restricted user.

AnonPassword

The password corresponding to the value entered for AnonUserName.

StatsPage

This is the URL (relative to the application's virtual directory) of the page that administrators can access to view statistics on how the Web server is being used. Statistics include the number of active users, the number of requests, and the average speed of request processing.

For information on the SWSE Stats Page, see System Monitoring and Diagnostics Guide for Siebel eBusiness Applications.

HTTPPort

The HTTP port used for Web browser communications. The default setting is the standard port of the Web server in use (80).

HTTPSPort

The HTTPS port used for secure Web browser connections. The default setting is the standard port of the Web server in use (443).

EnableFQDN

This setting enables the processing of requests to Web sites even if the user does not provide the fully qualified domain name, such as http://ebiz.siebel.com.

Example:

EnableFQDN = TRUE

The corollary parameter is FQDN, which must also be set appropriately for the request to be processed correctly. See also FQDN.

FQDN

Stands for Fully Qualified Domain Name. An example of a fully qualified domain name would be http://ebiz.siebel.com.

If the Web server receives a request for a URL that does not contain the full domain name, the FQDN setting causes the browser to reissue the request and to add the domain name.

In the example below, the eapps.cfg file is edited so that a Web site is accessed as
http://ebiz/callcenter. The FQDN setting converts the request to
http://ebiz.siebel.com/callcenter.

EnableFQDN = TRUE

FQDN = ebiz.siebel.com

One possible application for this is in a Single Sign-On environment, in which cookies with FQDN must be passed to different servers in the same domain. For information about Single Sign-On, see Security Guide for Siebel eBusiness Applications.

NOTE:  If using software to block pop-up windows, you must enable FQDN. For further information on configuring for pop-up blockers, see Configuring Siebel Applications for Pop-Up Blocker Compatibility.

See also EnableFQDN.

GuestSessionTimeout

The time, in seconds, that a connection open for anonymous browsing can remain idle before it times out. The default is 300 seconds (5 minutes).

Guest sessions are used for anonymous browsing. They permit users to navigate portions of the site without logging in. In contrast to anonymous sessions, guest sessions are associated with an individual Siebel Web Client. These sessions are opened when an unregistered user starts navigating the site, and they remain open until the Web client logs out or times out due to inactivity.

When deciding how long guest user timeout should be, your primary consideration should be whether or not anonymous browsing is being used. If so, guest user timeouts should be greater than the average time users would need to deliberate their next action. In other words, this is the time allowed between user actions.

Both guest and anonymous sessions use the AnonUserName and AnonPassword parameters to log in.

For more information on setting this parameter, see Performance Tuning Guide.

SessionTimeout

The time, in seconds, from the user's last browser request until the user's connection times out. The default is 900 seconds (15 minutes).

Standard sessions are those where users log in using their registered user name and password. Otherwise, they share many of the same characteristics as guest sessions.

Table 25 offers guidelines for setting this parameter.

NOTE:  All the session timeouts mentioned above deal with the session inactivity. In other words, if they are set to 3600 seconds, then it requires one hour of session inactivity for that session to time out. The session inactivity means there should be no request made to the Siebel Server on that session. Any act pinging the Siebel Server, such as message broadcasting, resets the session timeout period. If the update interval is less than the SessionTimeout set in the eapps.cfg file, the session never times out.

For more information on setting this parameter, see Performance Tuning Guide.

Enabled

The Siebel Web Engine stops responding to user requests if this flag is set to FALSE. The default is TRUE, or enabled. A particular Siebel eBusiness Application (for example, /marketing) stops responding to user requests if this flag is set to FALSE.

This is an optional parameter that, if required, must be manually input in either the [defaults] section of the file, or at the application [/xxx] level, depending on whether you want to disable all applications or just some.

In the example below, the first line has been manually input to disable the Marketing application. All applications are enabled by default.

[marketing]

enabled = FALSE

In the following example, the parameter has been set to disable all applications, because it has been entered in the [defaults] section.

[defaults]

Enabled = FALSE

[/xxx] Section

This section of the file contains connect strings for each Siebel Web Client application, as well as the parameters WebPublicRootDir and WebUpdatePassword.

Each connect string is preceded by a bracketed heading as illustrated below:

[/xxx]

where:

xxx = the name of the Siebel Web Client application you want to edit.

Any parameter you set for a particular eApplication overrides any opposite value listed under [defaults].

ConnectString

A connect string exists for each Siebel Web Client application. Each connect string reflects the individual object manager for that application and contains information you entered during setup.

The following sample connect string contains descriptions within parentheses of the string components.

[/eevents]
AnonUserName = User1
AnonPassword = Password1
ConnectString = siebel.TCPIP.none.NONE:\\siebel1:2321\Siebel\eEventsObjMgr\

where:

siebel.TCPIP = the networking transport protocol.

none (first instance) = the encryption type chosen.

NONE (second instance) = data compression method chosen.

siebel1 = Siebel Server host name.

2321 = Port number on which the Siebel Connection Broker component (alias SCBroker) runs (or in the load-balanced case, the virtual port number).

Siebel = Siebel Enterprise Server name chosen.

eEvents = relevant object manager (in this example, the eEvents object manager).

StartCommand

This value is the assumed command if your session starts and a command (query) is not explicitly specified in the URL. For example, for eservice the StartCommand is SWECmd=GotoView&SWEView=Home+Page+View+(eService). When you first bring up eservice in a new browser, it will be understood that your first query is a GotoView to your home page view. Normally you do not need to modify the StartCommand parameter specified in eapps.cfg.

WebPublicRootDir

This is the location for Web image caching, whose default location is

\SWEApp\PUBLIC\language (WINDOWS)

$SWEAPP_ROOT/public/language (UNIX)

WebUpdatePassword

This is the password used by the Siebel Administrator to refresh application images from the Siebel Server on the Web server without restarting.