Jump to: navigation, search


Section: client-file-transfer
Default Value: windows
Valid Values: none, path, windows
Changes Take Effect: Immediately

Specifies how filename must be verified during file transfer. Possible values:

  • none: do not verify filename.
  • path: check if filename does not contain path controlling symbols.
  • windows: check if filename complies with naming rules on windows platform.


Section: transcript-cleanup
Default Value: false
Valid Values: true, false
Changes Take Effect: Immediately
Introduced: 8.5.301.06

Allows bot participants to unmask sensitive data in chat session messages when transcript cleanup is enabled.


Section: settings
Default Value: major
Valid Values: none, major, major2, typing, all
Changes Take Effect: Immediately
Introduced: (Restricted); 8.5.301.06 (Generally Available)
Modified: 8.5.310.09

Specifies which notifications count as async chat session activity for the purpose of inactivity control.

  • all: All user notifications are included (custom, push URL, typing on/off, update nickname).
  • major: Only major notifications are included (push URL, file uploaded, file deleted).
  • major2: Extends the major value with custom notifications.
  • none: All notifications are excluded.
  • typing: Only major and "typing on" notifications are included.


Section: settings
Default Value: 3600
Valid Values: Any integer from 1-1728000
Changes Take Effect: Immediately
Introduced: (Restricted); 8.5.301.06 (Generally Available)

Specifies, in seconds, a timeout that starts after "async-idle-alert" (enabled only for async chat sessions). If any qualifying activity occurs, (see "async-idle-alert" for a description of what qualifies as activity), the timeout stops and "async-idle-alert" timer is reset. If no qualifying activity is detected during this timeout, Chat Server:

  • Sends the IDLE_CONTROL_CLOSE notice with a message specified by the value of the "message-close" option (in the section [inactivity-control]).
  • Closes the chat session.


Section: settings
Default Value: 86400
Valid Values: Any integer from 1-1728000
Changes Take Effect: Immediately
Introduced: (Restricted); 8.5.301.06 (Generally Available)

Specifies an inactivity alert timeout (in seconds) which is enabled only for async chat sessions. The inactivity timeout is set (or reset) for a session after any of the following activities: agent joined or left, any chat participant sent a message or a notice (as defined by "async-idle-notices"). If no qualifying activity is detected during this timeout, Chat Server:

  • Sends the IDLE_CONTROL_ALERT notice with a message specified by the value of the "message-alert" option (in the section [inactivity-control]).
  • Updates the interaction properties: GCTI_Chat_AsyncStatus=3 and GCTI_Chat_AsyncCheckAt={time to check interaction at}.
  • Starts the timeout specified by the value of the "async-idle-close" option.


Chat Server Release Notes

Chat Server is part of 9.x starting in

Release Date Release Type Restrictions AIX Linux Solaris Windows
08/22/18 General X X

Helpful Links

Releases Info

Product Documentation


Genesys Products

List of Release Notes

What's New

This release contains the following new features and enhancements:

  • Chat Server now supports asynchronous mode for chat sessions:
    • Chat sessions can now be declared as "async" where Chat Server applies a specific method for handling such sessions:
      • For async chat sessions, Chat Server now detects when a chat session is placed on hold (in other words, is placed in a "dormant" state).
      • For dormant chat sessions, Chat Server now signals the workflow when a customer replies or an async idle timeout expires.
      • Chat Server closes an async chat session if no activity is detected for the configured amount of time.
        Note: The following new options, async-idle-alert , async-idle-close , async-idle-notices were introduced in this release. Please see the Chat Server page in the eServices Options Reference Guide for information on all Chat Server-related options.
    • The Chat Server IP provides a sample IRD/URS workflow which demonstrates the integration for an async chat session.
    • The reporting statistic calculation for async chat sessions now considers the nature of async communication between a customer and an agent.
  • Chat Server now supports UCS 9.1 in compatibility mode only (in other words, configured as pairs of primary and backup applications).
  • Support for CentOS Linux 7 operating system. See the eServices page in the Genesys Supported Operating Environment Reference Guide for more detailed information and a list of all supported operating systems.
  • Additional improvements provided:
    • A special mandatory key-value pair csg_MediaType has been added to Chat Server Reporting Data.
    • A special key-value pair GCTI_Chat_UnmaskPII can be provided by the chatbot when joining the chat session if the configuration option allow-bot-unmask is enabled. This forces Chat Server to suppress sensitive data masking for the chatbot, while keeping it masked for all other participants and in the contact history transcript.
      Note: Chatbots are a part of Bot Gateway Server which is a restricted product at the time of this release of Chat Server. For more information on chatbots, contact your Genesys representative.
    • Use the file-name-check configuration option for files being uploaded by a customer. This enables filename verification against path and Windows naming validation rules.
    • Chat Server now allows you to use any locale when running in HA mode with Cassandra. Previously, only the UTF-8 locale was supported.
    • Chat Server now includes security improvements as a fix for vulnerability CVE-2017-9765.

Resolved Issues

This release contains the following resolved issues:

Chat Server now allows Genesys Mobile Services (GMS) to specify the cluster node name when unsubscribing from flex-push notifications in CometD mode. Supported GMS versions are GMS, and GMS and later. (CHAT-3160)

Upgrade Notes

No special procedure is required to upgrade to release 8.5.301.06.

This page was last edited on September 18, 2020, at 13:42.
Comments or questions about this documentation? Contact us for support!