Siebel CTI Administration Guide > Configuring Advanced Communications Features >

Using the Push Keep Alive Driver for Session Connections


The Push Keep Alive communications driver provides a heartbeat message that is useful in maintaining connections for your communications sessions in some environments. You use this driver with Communications Session Manager, such as when you are using Siebel CTI.

The Push Keep Alive driver helps to solve problems that might be experienced in some environments, where push communications sessions between the Application Object Manager and a user's Web browser are sometimes dropped. A connection might be dropped if messages have not been pushed to an agent for a particular length of time.

The Push Keep Alive driver sends a heartbeat message to the Application Object Manager and to each agent user's browser, at a regular interval. This heartbeat message allows the push connection applicable to each agent's communications toolbar not to be dropped in such cases. The heartbeat interval is specified using a driver parameter.

NOTE:  When you use the Push Keep Alive driver, you must also set the ChannelCleanupTimer configuration parameter to make sure that abandoned connections for communications sessions are dropped promptly. For more information about the ChannelCleanupTimer configuration parameter, see Parameters for Communications Configurations. For information about how to set this parameter, see Specifying Parameters for a Communications Configuration.

Configuring the Push Keep Alive Driver

The following procedure describes how to configure the Push Keep Alive driver. Descriptions of the driver settings and the default driver parameter values follow.

To use the Push Keep Alive driver

  1. Start the Siebel application, such as Siebel Call Center, logging in as the system administrator (for example, as the user SADMIN).
  2. Navigate to the Administration - Communications screen, then the Communications Drivers and Profiles view.
  3. Click the Profiles tab and enter a new record with a name that identifies the profile with the Push Keep Alive communications driver. For example, enter Push Keep Alive.
  4. In the Profile Parameter Overrides child applet, create records with values similar to those listed in the following table.
    Parameter
    Value

    Name

    Select PushKeepAliveTimer from the drop-down list.

    Value

    Enter the time interval (in seconds) between the Push Keep Alive driver sending messages. For example, enter 180 to have the driver send a heartbeat message every 180 seconds.

  5. Click All Configurations in the application link bar and select your configuration in the displayed list.
  6. Click the Profiles screen tab.

    The list of profiles currently associated with your configuration appears.

  7. Click New.

    The Add Communications Profiles dialog box appears. This dialog box displays the list of currently available profiles.

  8. Select Push Keep Alive, then click OK.

    This associates the Push Keep Alive communications driver with your configuration. It means that a heartbeat message is sent at the interval that you specify (for example, every 180 seconds).

  9. Do one of the following:
    • If you use the Communications Configuration Manager server component to cache your configuration, then shut down and restart your Siebel Server to apply the changes made in steps Step 1 to Step 8.
    • If you do not use the Communications Configuration Manager server component, then log out and log into the application for these changes to take effect.

      For more information about the Communications Configuration Manager component, see Administering Communications Configuration Manager.

Push Keep Alive Driver Settings

Table 32 lists the settings for the driver record for the Push Keep Alive driver. These settings appear in the Communications Drivers and Profiles view in the Administration - Communications screen.

CAUTION:  The values shown in Table 32 are presented for reference only. Do not modify the predefined values for this driver.

Table 32. Push Keep Alive Driver Settings
Field Name
Value

Name

Push Keep Alive

Channel Type

Push Keep Alive

Inbound

Off

Outbound

Off

Interactive

On

Channel String

Push Keep Alive

Library Name

sscmimed

Push Keep Alive Driver Parameters

Table 33 lists the supported parameters for the Push Keep Alive communications driver.

Table 33. Push Keep Alive Driver Parameters
Name
Required
Default Value
Description

LogDebug

No

False

True or False

If True, then data output to the log file is more detailed.

LogFile

No

push_{@UserName}.log

The name of the file where logging information is written. If this parameter is empty, then no log file is generated. Logging data is always appended to this file.

Log files are created in the log subdirectory of the Siebel Server installation directory.

Optionally, if you want to use a single log file in a multichannel environment, then you can specify the same log file name for all of the interactive drivers that you are using.

MaxLogKB

No

128

Specifies the maximum size of the log file, in kilobytes (KB).

When the log file is full, it is emptied completely, then logging begins again.

PushKeep
AliveTimer

Yes

0

Specifies the interval, in seconds, for the heartbeat message sent by the Keep Push Alive driver to the Application Object Manager and to each agent's Web browser.

For example, if this parameter is set to 180, then the heartbeat message is sent every 180 seconds.

The default value, 0, specifies that no heartbeat message is sent.

Typically, this parameter is defined as a parameter override in a driver profile that has been associated with the communications configuration.

ReleaseLogHandle

No

True

Indicates that the log file handle for each agent is released periodically, after logs have been generated.

The default setting of True provides better performance.

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

Siebel CTI Administration Guide Copyright © 2016, Oracle and/or its affiliates. All rights reserved. Legal Notices.