1. CTI Administration Guide
  2. Parameters for Application Object Manager and Siebel Developer Web Client

Parameters for Application Object Manager and Siebel Developer Web Client

This topic describes the parameters for the Application Object Manager (for Siebel Web Client) and Siebel Developer Web Client. These parameters are described in the following table.

Note: The Siebel Developer Web Client is supported for administration, development, and troubleshooting usage scenarios only.

The type of client that you use determines how the parameters are specified:

  • For deployments of the Siebel Web Client, parameters are specified as server component parameters for the Application Object Manager that is to support communications users.

  • For deployments of the Siebel Developer Web Client (where applicable), parameters are specified in the [Communication] section of the application configuration file, such as uagent.cfg for Siebel Call Center, for each communications user’s Siebel client.

Note: For the parameters listed in the following table, if the parameter value is changed while the Application Object Manager is running, then the changed value affects communications sessions for all users who log in subsequently.
Parameter Name Display Name Default Value Description

CommConfigCache

Communication Configuration Cache

False

Enables or disables the caching of communications configuration data on the Application Object Manager.

Note: This parameter applies to the Siebel Web Client only, not to the Siebel Developer Web Client.

  • When this parameter is False, communications configuration data is loaded separately for each agent session, with no caching on the Object Manager.

  • When this parameter is True, the Application Object Manager loads and caches communications configuration data.

When CommConfigCache is True, after the first agent logs in, subsequent agent logins for the same configuration download the configuration data from the cache. This speeds up the login process and reduces memory usage for each agent session.

This parameter can be used with or without the Communications Configuration Manager component and the CommConfigManager parameter.

For more information, see the description of the CommConfigManager parameter.

CommConfigManager

Communication Configuration Manager

False

Enables or disables use of the Communications Configuration Manager (CommConfigMgr) for loading and caching communications configuration data to reduce configuration downloads.

  • When this parameter is False, communications configuration data is loaded separately for each agent session, with no caching.

  • When this parameter is True, Communications Configuration Manager is employed to load and cache communications configuration data. After the first agent logs in, subsequent agents using the same configuration download the configuration data from the cache, thereby speeding up the login process.

For more information, see Administering Communications Configuration Manager.

CommConfigManager Name

Communication Configuration Manager Name

CommConfigMgr

Specifies the name of the Communications Configuration Manager server component to use when the parameter CommConfigManager is True.

A global deployment might, for example, use different components for different languages within the same enterprise.

CommEnable

Enable Communication

False

Enables or disables session-based communications for agents.

  • When this parameter is True, the communications toolbar and menu elements are displayed and activated for agents who are associated with a configuration.

  • When this parameter is False, the communications toolbar and menu elements are not displayed.

If an agent is not associated with a configuration, then the communications toolbar is not displayed, even if CommEnable is True.

Enabling communications has many additional requirements, which are described in Configuring Siebel CTI

CommLocalDriver

Local Communication Driver

False (as component parameter)

True (as configuration file parameter for Siebel Developer Web Client)

Specifies on which computer interactive communications drivers are loaded by the channel manager for each agent communications session:

  • For either the Siebel Web Client or the Siebel Developer Web Client: when this parameter is False, interactive drivers are loaded on the Siebel Server computer where Communications Session Manager is running.

  • For the Siebel Developer Web Client: if this parameter is True in the configuration file, then interactive drivers are loaded on each agent’s Siebel client.

  • For the Siebel Web Client: if this parameter is True on the Application Object Manager, then interactive drivers are loaded on the Application Object Manager.

For more information, see Administering Communications Session Manager.

CommLogDebug

Log Debug Message

False

Specifies whether the log file specified with the CommLogFile parameter must contain extra detail.

CommLogFile

Log File

SComm.log

Specifies the name of the log file to create for each agent’s communications session.

For example, where the parameter is set to SComm.log, files named SComm_user.log are created, where user is each agent’s Siebel login name.

These files are written in the log subdirectory of the Siebel Server or Siebel Developer Web Client installation directory.

CommMaxLogKB

Maximum Log Size (KB)

1024

Specifies the maximum size, in Kilobytes, of log files specified using CommLogFile.

CommMaxMsgQ

Maximum Message Queue

64

The maximum number of messages to be queued for the agent’s communications toolbar.

If the number of messages exceeds the maximum, then the oldest message is discarded. For example, with the default value of 64, the most recent 64 messages are queued. If a 65th message arrives, then the oldest message in the queue is discarded in order for the new message to be received.

It is recommended that you use the default setting unless you require changing it.

If you set this value too low, then older messages might be deleted in some cases, such as in a slow network environment.

If you set this value too high, then server resources might be overused, by storing many messages for agents who experience browser problems that interrupt the session.

The behavior is also subject to the general session timeout defined for Siebel Web Client deployments. If an agent’s session times out, then all toolbar messages for the session are cleared.

CommReleaseLogHandle

Release Log Handle

True

True indicates that the log file handle for each agent is released after logs have been generated.

The default setting of True provides better scalability because the handles are released, but it can slow down performance in some cases.

When CommReleaseLogHandle is True, some log files might not be generated if the number of concurrent users exceeds the file-handle capacity provided by the operating system.

CommReqTimeout

Request Timeout

600

Specifies the number of seconds to wait for a response from the Communications Session Manager for a particular communications interaction.