Parameter Descriptions of the eapps.cfg File

These parameters appear in the eapps.cfg file, located in the bin subdirectory of the SWSE_ROOT installation directory. The values that you see are a combination of default settings and the values that you specified during the initial configuration process. You can edit these parameters after installation. This topic contains the following topics, representing sections of the eapps.cfg file:

• "[swe] Section"

• "[defaults] Section"

• "[/xxx] Section"

[swe] Section

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

DisableNagle

This parameter, when set to True, disables the Nagling algorithm feature of Microsoft IIS Web server. The default value is False. This parameter is optional and, 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

SWSE_ROOT\LOG (Windows)

SWSE_ROOT/log (UNIX)

Note: To configure SWSE logging, set the appropriate environment variables. For more information, see Siebel System Monitoring and Diagnostics Guide.

MaxQueryStringLength

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

• -1 to use the default value.

• Any value greater than 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 parameter defines the location of the SWSE installation, whose default location is referred to as SWSE_ROOT. For more information about the SWSE installation, see the Siebel Installation Guide for the operating system you are using.

SessionMonitor

Use this parameter to determine whether to gather statistics on all of the 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 about sessions of users who have logged in to the system. If a user exits properly, using the Logout command, then 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, then the session information remains on the stats page until the Web server is restarted.

Session data includes each user's user name 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), then 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 more information about 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 it is set to False, then 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, then 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, then only one segment is kept. When this segment reaches the size specified by the LogSegmentSize parameter, the segment is overwritten. In general, 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.

[defaults] Section

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

DoCompression

This parameter 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 in order to never compress HTTP traffic. For example, use this setting if your proxy servers only support HTTP 1.0, or if the overhead of using compression and 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, then 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 might be used.

• When this parameter is set to CompressProxyTraffic, HTTP traffic will always be compressed. Use this setting for Siebel Business 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 DoCompression for individual Siebel Business 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 that an external user (that is, a partner or customer) might be using, use the setting CompressProxyTraffic for employee applications only, not for customer or partner applications.

StatsPage

This parameter specifies 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 more information about the SWSE statistics page, see Siebel System Monitoring and Diagnostics Guide.

HTTPPort

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

HTTPSPort

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

EnableFQDN

This parameter enables the processing of requests to Web sites even where the user does not provide the fully qualified domain name, such as http://ebiz.example.com. For example:

EnableFQDN = True

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

FQDN

This parameter specifies the fully qualified domain name. An example of a fully qualified domain name is http://ebiz.example.com. If the Web server receives a request for a URL that does not contain a full domain name, then the FQDN setting causes the browser to reissue the request and to add the domain name specified using this parameter. In the following example, the eapps.cfg file is edited so that a Web site is accessed as http://ebiz/callcenter. If EnableFQDN is True, then the FQDN setting converts the request to http://ebiz.example.com/callcenter.

EnableFQDN = TrueFQDN = ebiz.example.com

One possible application for this parameter is in a Single Sign-On environment, in which cookies with FQDN must be passed to different servers in the same domain. For more information about Single Sign-On, see Siebel Security Guide. See also the description of the EnableFQDN parameter.

Note: If you are using software to block pop-up windows, then you must enable FQDN. For more information about configuring for pop-up blockers, see "Configuring Siebel Business Applications for Pop-Up Blocker Compatibility".

Enabled

This parameter indicates whether the Siebel Web Engine will respond to user requests. The default is True, or enabled. If Enabled is False, then the applicable Siebel application stops responding to user requests.

This parameter is optional. If you want to use it, then you must add it manually in either the [defaults] section of the file or at the application [/xxx] level, depending on whether you want to disable all applications or a particular application. For example, if Enabled is False in the [/marketing_fra] section, then Siebel Marketing for French stops responding to user requests. In the example below, the parameter has been set to disable the application:

[/marketing_fra]Enabled = False

In the next example, the parameter has been set to disable all applications:

[defaults]Enabled = False

SessionTracking

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

• Automatic (Default). Detects whether the client is capable of supporting cookies. If so, then session information is maintained through cookies. If not, then it is maintained through URLs, except for applications deployed using Siebel Open UI.

• URL. Forces session information to be passed through the URL. This setting is known as cookieless session mode. Siebel Open UI requires the use of cookies and does not support cookieless mode.

• Cookie. Forces session information to be passed through cookies. Web browsers with cookies disabled cannot maintain a Siebel user session. When using this setting, you must also set URLSession to False and CookieSession to True. For more information about these parameters and about using cookies for Siebel Business Applications, see Siebel Security Guide.

Security-related eapps.cfg File Parameters

For information about security-specific eapps.cfg file parameters, such as AnonUserName, AnonPassword, GuestSessionTimeout, SessionTimeout, and EncryptedPassword, see Siebel Security Guide. See also the Siebel Installation Guide for the operating system you are using, Integration Platform Technologies: Siebel Enterprise Application Integration, and other relevant guides.

[/xxx] Section

This section of the file, such as [/callcenter_enu], contains connection strings for each Siebel application, as well as the parameters WebPublicRootDir and SiebEntSecToken. Each connection string is preceded by a bracketed heading resembling the following:

[/xxx]

where xxx is the virtual directory name of the Siebel application that you want to edit, such as callcenter_jpn for Siebel Call Center for Japanese.

ConnectString

This parameter specifies a language-specific connection string for each Application Object Manager. The connection string contains information that was specified during initial configuration. The format for the connection string is as follows:

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

where:

• transport is the networking transport protocol.

• encryption is the encryption type. Make sure that the ConnectString parameter value includes the same encryption type that is specified using the Encryption Type parameter. For more information about this parameter, see "Siebel Server Parameters". For more information about encryption, see Siebel Security Guide.

• compression is the data compression method. Make sure that the ConnectString parameter value includes the same compression method that is specified using the Compression Type parameter. For more information about this parameter, see "Siebel Server Parameters".

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

• server_port is the 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 is the Siebel Enterprise Server name.

• AppObjMgr is the relevant Application Object Manager.

For example:

ConnectString = siebel.TCPIP.none.NONE:\\siebel1:2321\Siebel\eEventsObjMgr\

StartCommand

This parameter specifies the assumed command if your session starts and a command (query) is not explicitly specified in the URL. For example, for Siebel eService for French, the StartCommand value is SWECmd=GotoView&SWEView=Home+Page+View+(eService_fra). When you first bring up the Siebel eService application in a new browser, the first query is a GotoView to your home page view. Normally, you do not have to modify the StartCommand parameter specified in the eapps.cfg file.

WebPublicRootDir

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

SWSE_ROOT\PUBLIC\language (Windows)

SWSE_ROOT/PUBLIC/language (UNIX)

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

SiebEntSecToken

This parameter specifies the Siebel Enterprise security token, which is used by the Siebel Administrator to refresh application images from the Siebel Server on the Web server without restarting. For more information about the Siebel Enterprise security token, see Siebel Security Guide and the Siebel Installation Guide for the operating system you are using.