Siebel System Administration Guide > Structure of the eapps.cfg File >

Parameter Descriptions of the eapps.cfg File

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.

[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 Business Applications.

DisableNagle

This parameter, when set to TRUE, disables the Nagling algorithm feature of Microsoft IIS Web server. The default value is FALSE. This is an optional parameter that, if required, must be manually input into the [swe] section of the file.

Language

This parameter defines the language version of Siebel Business Applications. For example, enu stands for U.S. English.

LogDirectory

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

\SWEApp\LOG (WINDOWS)

$SWEAPP_ROOT/log (UNIX)

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

MaxQueryStringLength

This parameter controls the size of HTTP POST requests from the SWSE plugin. The default value is 500000 bytes (approximately 500 KB). Values for this parameter include:

• -1 to use the default value
• > 0 to set the limit of this parameter, in bytes, to the indicated value (for example, 250000)

NOTE:  The HTTP GET method has a 2 MB request limit, which is defined by the HTTP protocol.

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 the Logout command, 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.

For further information on configuring and viewing the SWSE stats page, see Siebel System Monitoring and Diagnostics Guide.

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 512 byte blocks. For example, if you set this parameter to 5, the log segment will be 2.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 high 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 Business 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 applications (such as /esales) in the [xxx] section. If such a parameter is set for a particular Siebel Business Application, it overrides the value listed in [defaults].

DoCompression. Specifies whether the SWSE will compress HTTP traffic.

Compressing HTTP traffic, where it is feasible to do so, substantially reduces bandwidth consumption. This feature is supported on HTTP 1.1, and is not supported on HTTP 1.0.

• When this parameter is set to FALSE, HTTP traffic will not be compressed. Use this setting if HTTP traffic should never be compressed. For example, you might use this setting if your proxy servers only support HTTP 1.0, or if the overhead of compression/decompression is of more concern to you than bandwidth constraints.
• When this parameter is set to TRUE, HTTP traffic will be compressed if no proxy server is detected. However, if any proxy server is detected, it will be assumed not to support HTTP 1.1, and HTTP traffic will not be compressed. Use this setting if you want to compress HTTP traffic where feasible, but cannot be certain that proxy servers that do not support HTTP 1.1 may be used.
• When this parameter is set to CompressProxyTraffic, HTTP traffic will always be compressed. Use this setting for Siebel applications only if you are certain that any proxy server that resides in front of your Siebel application users supports HTTP 1.1.

You can set this parameter for individual Siebel applications, or set it for multiple applications by defining it in the [defaults] section. For example, you might set this parameter to CompressProxyTraffic for employee applications accessed on an intranet.if you know that any proxy servers that are deployed support HTTP 1.1. Otherwise, set this parameter to either FALSE or TRUE (such as in the [defaults] section).

NOTE:  Because it is impossible to know what type of proxy server an external user (that is, a partner or customer) may be using, the setting CompressProxyTraffic should be used for employee applications only, not for customer or partner applications.

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 Siebel System Monitoring and Diagnostics Guide.

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.oracle.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.oracle.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.oracle.com/callcenter.

EnableFQDN = TRUE

FQDN = ebiz.oracle.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 Siebel Security Guide.

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.

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 Business 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

Security-related eapps.cfg Parameters

For information on security-specific eapps.cfg parameters, such as AnonUserName, AnonPassword, GuestSessionTimeout, SessionTimeout, and EncryptedPassword, see Siebel Security Guide.

[/xxx] Section

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

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.

ConnectString

A connect string exists for each Siebel Web Client application. Each connect string reflects the language-specific Application Object Manager (AOM) for every language supported by Siebel Business Applications in the current release for every supported Siebel application, and contains information you entered during setup.

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:\\siebel1:2321\Siebel\eEventsObjMgr\

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)

NOTE:  This parameter must be set in the application-specific section of the eapps.cfg file.

SiebEntSecToken

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