attach-session-statistics
Section: settings
Default Value: none
Valid Values: all, fired, none
Changes Take Effect: Immediately
Enables calculating various statistics and attaching them to the interaction's user data at the end of the chat session. Possible values are:
- none: Do not attach anything.
- all: Attach all possible statistics (both encountered and non-encountered).
- fired: Attach only statistics that were encountered during the course of the chat session.
Note: Genesys recommends that you change the value of this option from the default value of "none" to "fired" if you deploy Historical Reporting for either Chat or Bot Gateway.
stop-abandoned-interaction
Section: settings
Default Value: never
Valid Values: always, never, noagents, noanswer
Changes Take Effect: Immediately
Modified: 8.5.301.06
Specifies how Chat Server handles chat interactions (in Interaction Server) when the chat session is finished. Possible values:
- always: interactions are always stopped when the chat session is finished (not recommended value).
- never: interactions are never stopped by Chat Server (recommended value).
- noagents: interactions are stopped only if there are currently no agents or supervisors in the session (use value wisely).
- noanswer: interactions are stopped only if no agents ever joined the session - in other words, the session was never answered (use value wisely).
Note: When the chat session is closing, it ignores the presence of bot participants when evaluating this option (in other words, bot participants are not considered "agents"). The legacy "true" and "false" values are also supported and converted to new values as following:
- "false" is interpreted as "never"
- "true" is interpreted as "noanswer"
By default, Chat Server does not stop any interaction after the chat session is finished. Instead, Chat Server updates the IsOnline interaction property to false and attaches reporting statistics. If your deployment includes Genesys Info Mart reporting, Genesys recommends that you set the value of this option to "noanswer", to enable accurate reporting of abandoned chats. In all other deployments, Genesys recommends that you set the value of this option to "never", and have the agent desktop and/or a workflow stop the interaction. Values other than "never" must be used cautiously, as stopping the interaction from Chat Server may lead to conflicts with updates from the agent desktop.
enable-chat
Section: agg-feature
Default Value: No default value
Valid Values: None. This option takes no values—its presence alone within the [agg-feature] section issues the described instructions to RAA.
Changes Take Effect: After restart of the aggregation process
Introduced: 8.5.003
Modified: 8.5.011.02, 8.5.011.04
Instructs RAA to enable the AGT_CHAT_STATS table. To have RAA exclude chat data, remove this option from this section.
attach-stats-rep-place
Section: settings
Default Value: 0
Valid Values: Any integer from 0-1000000
Changes Take Effect: Immediately
Introduced: 8.5.315.05
If attach-stats-rep-events is set to a non-zero value, this option must contain the DBID (numeric value) of a configured place. This parameter is required for backward comptiblity of GIM operations. Creating a simulated/fake place for this purpose is recommended. The same place can be shared between multiple instances of Chat Server.
attach-stats-rep-events
Section: settings
Default Value: 0
Valid Values: Any integer from 0-7
Changes Take Effect: Immediately
Introduced: 8.5.315.05
Enables the delivery of historical reporting data through custom reporting events. This type of delivery allows multiple updates through each chat session, versus only a single delivery at the end of a chat session through the userdata. Through this option, you can specify when the delivery of the reporting data must occur. The value of the option can be set to the sum of the following integers:
- 0: The functionality is disabled (default value).
- 1: Custom Reporting Event with reporting data is sent instead of a userdata update at the end of a chat session.
- 2: Custom Reporting Event with reporting data is sent when async chat is placed on hold (when GCTI_Chat_AsyncStatus is set to -2).
- 4: Custom Reporting Event with reporting data is sent when a message from the customer arrives during the chat session hold (when GCTI_Chat_AsyncStatus is set to 2).
For example, to force Chat Server to deliver reporting data for all possible cases, set the option to a value of 7, which is the sum of 1, 2 and 4. Attention: if this functionality is enabled, make sure that the option attach-stats-rep-place is set to the correct value.
attach-session-statistics
Section: settings
Default Value: none
Valid Values: all, fired, none
Changes Take Effect: Immediately
Enables calculating various statistics and attaching them to the interaction's user data at the end of the chat session. Possible values are:
- none: Do not attach anything.
- all: Attach all possible statistics (both encountered and non-encountered).
- fired: Attach only statistics that were encountered during the course of the chat session.
Note: Genesys recommends that you change the value of this option from the default value of "none" to "fired" if you deploy Historical Reporting for either Chat or Bot Gateway.
Integrating Chat Server with Genesys Historical Reporting
Chat session reporting relies on Interaction Server reporting events to provide session-related data to the products that enable Genesys historical reporting:
- Interaction Concentrator, which comprises the Interaction Concentrator (ICON) server and Interaction Database (IDB) -- Stores detailed reporting data from Interaction Server and other sources.
- Genesys Info Mart -- Extracts, transforms, and loads (ETLs) data from IDB into the Info Mart database, a data mart suitable for contact center reporting.
- Reporting and Analytics Aggregates (RAA) -- Aggregates Info Mart data to provide contact center activity metrics for downstream reporting applications.
- Genesys Customer Experience Insights (GCXI) -- Extracts aggregated data from the Info Mart database and presents it in readable historical reports.
This page describes the component and configuration requirements to enable historical reporting on chat session activity in your deployment.
Overview
- After a chat session is finished, Chat Server attaches reporting statistics to the user data of the interaction in Interaction Server. For more information about the attached user data key-value pairs (KVPs), see Chat Server reporting data.
- ICON stores the user data in the G_USER_DATA_HISTORY table in IDB in near real-time.
- On a regular schedule, Genesys Info Mart extracts the IDB data and transforms it into the CHAT_SESSION_FACT table and supporting dimensions in the Info Mart dimensional model. For more information about the session-related tables in the Info Mart database, see the Genesys Info Mart Physical Data Model for your RDBMS. For more information about managing the Genesys Info Mart ETL jobs, see the Genesys Info Mart Operations Guide.
- RAA summarizes and organizes the Info Mart data in ways that enable GCXI to extract meaning. For more information about RAA data, see the RAA User's Guide.
- GCXI uses the aggregated data in the Info Mart database to present out-of-box chat session reports, including:
- Chat Message Statistics Report
- Chat Termination Report
- Async Chat Dashboard
- In deployments that include Bot Gateway Server (BGS) starting with version 8.5.203.09, there are reports and dashboards on bot-related activity. Note: BGS is currently only available as a restricted release.
- In deployments where Async Chat functionality is enabled, the Async chat dashboard displays async chat metrics.
- For more information about the GCXI reports, see Chat reports in the GCXI User's Guide.
Enabling historical reporting on chat session activity
Prerequisites
The following table summarizes the minimum release requirements for the components that enable chat session historical reporting.
Component | Minimum release for chat | Minimum release for async chat |
---|---|---|
Chat Server | 8.5.203.09 (restricted release) 8.5.301.06 (general release) |
8.5.302.03 8.5.315.xx (for intermediate updates) |
ICON | 8.1.514.11 | 8.1.514.11 |
Genesys Info Mart | 8.5.011.04 | 8.5.011.14 8.5.116.20 (for intermediate updates) |
RAA | 8.5.003 | 8.5.006 |
GCXI | 9.0.005 | 9.0.007 |
WDE | No minimum requirement | 8.5.122.08 |
Setting up historical reporting
- Ensure that your deployment has been configured as required for Genesys Info Mart to support reporting on eServices activity in general. If necessary, migrate Genesys Info Mart and RAA to meet the release Prerequisites. For a summary of the configuration requirements, see Enabling Reporting on Multimedia Activity in the Genesys Info Mart Deployment Guide.
- Configure Chat Server:
- To attach the required statistics, set the Chat Server attach-session-statistics option to all (which is not the default value).
- To send intermediate updates (supported by GIM version 8.5.116.20 or higher) for an async chat session, set the required value both for attach-stats-rep-events and attach-stats-rep-place.
- In the Route Interaction properties, ensure that the workflow always provides a "Queue" in Interation Queue > Queue for Existing Interaction. If no Queue is provided, the interaction is stopped by an agent desktop, and Chat Server may not be able to update the interaction with reporting statistics.
- Configure ICON to capture the user data KVPs that Genesys Info Mart requires. Modify the ICON attached data specification file as necessary, to include the KVPs identified in Chat Server reporting data as KVPs that are used by Genesys Info Mart.
TipThe attached data specification file included in the Genesys Info Mart IP (ccon_adata_spec_GIM_example.xml) includes all the KVPs required for the reporting features supported in that Info Mart release. You might need to upload a new version of the attached-data specification file or update your existing version with additional KVPs to enable reporting enhancements.
- Enable aggregation of chat session data. (Required for GCXI reporting or other applications that use RAA aggregation.) In the [agg-feature] section on the Genesys Info Mart application object, specify the enable-chat option.
Chat Server reporting data
After a chat session is finished, Chat Server attaches the following types of reporting statistics to the user data of the interaction in Interaction Server:
- Chat session characteristics
- Chat session end reason codes
- Chat session transcript statistics
- Async chat session statistics
- Bot-related statistics
Chat Session Characteristics
The following chat session characteristics are attached at the end of a chat session. If the KVPs are required for the out-of-box chat session reporting provided by Genesys Info Mart and GCXI, the "Info Mart Database Target" column indicates the Info Mart database table and column to which the KVP is mapped.
Unless indicated otherwise, the session characteristics KVPs were introduced in Chat Server 8.5.201.
KVP | Description | Info Mart Database Target |
---|---|---|
KVP | Description | Info Mart Database Target |
ChatServerSessionClosedAt | Timestamp of chat session closure. Always attached.
Note: This KVP is mandatory for Genesys Info Mart reporting. | CHAT_ |
ChatServerSessionStartedAt | Timestamp of chat session creation. Always attached.
Note: This KVP is mandatory for Genesys Info Mart reporting. | CHAT_ |
csg_ | The ID (identifier) of chat session. Could be different from Interaction ID. Attached only if the value of attach-session-statistics is not none. | Not mapped |
csg_ | The value identifies the language specified for the chat session. Might be absent. Attached only if the initial UserData for the chat session includes the GCTI_LanguageName KVP, and the value of attach-session-statistics is not none. | CHAT_ |
csg_ | The value identifies the origination of the chat session (web chat, social media channels, sms, and so on). Might be absent. Attached only if the initial UserData for the chat session includes the MediaOrigin KVP, and the value of attach-session-statistics is not none. | CHAT_ |
csg_ Introduced: 8.5.203.09 (restricted release) / 8.5.301.06 (generally available release) | The MediaType for chat interaction. Always attached. | MEDIA_ |
csg_ | The tenant ID for the chat session. Always attached. | CHAT_ |
Chat Session End Reason Codes
The following reason codes describe what triggered the end of a chat session and how it was triggered. If the KVPs are required for the out-of-box chat session reporting provided by Genesys Info Mart and GCXI, the "Info Mart Database Target" column indicates the Info Mart database table and column to which the KVP is mapped.
KVP | Description | Info Mart Database Target |
---|---|---|
KVP | Description | Info Mart Database Target |
csg_ Introduced: 8.5.109 | The indication of agent presence in chat session.
Please note that in this reason code, only human (in other words, non-bot) agents who are visible to a customer are taken into account.
| Not mapped |
csg_ Introduced: 8.5.105 | The type of participant that triggered the chat session closure.
| CHAT_ |
csg_ Introduced: 8.5.105 | The description of how a chat session was closed.
| CHAT_ |
Chat Session transcript statistics
Chat Server attaches general and extended reporting statistics, based on the attach-session-statistics option settings.
General transcript statistics
In the general transcript statistics, an agent means both an agent and a supervisor, when either of those is visible to a customer. For example, the statistics do not count/include an activity for an agent who is coaching another agent, or for a supervisor who monitors the session silently.
The following general transcript statistics are attached at the end of a chat session. If the KVPs are required for the out-of-box chat session reporting provided by Genesys Info Mart and GCXI, the "Info Mart Database Target" column indicates the Info Mart database table and column to which the KVP is mapped.
Unless indicated otherwise, the general transcript statistics KVPs were introduced in Chat Server 8.5.101.
KVP | Description | Info Mart Database Target |
---|---|---|
KVP | Description | Info Mart Database Target |
cse_ Introduced: 8.5.301.06 | The maximum time (in seconds) a chat session has been inactive while at least one agent was connected and a configured inactivity threshold was exceeded. | Not mapped |
cse_ Introduced: 8.5.301.06 | The total number of times when an inactivity period exceeded a configured threshold while at least one agent was connected to the chat session (in other words, while the chat session was technically in an active state). | CHAT_ |
cse_ Introduced: 8.5.301.06 | The total amount of time (in seconds), exceeding configured threshold, without any activity when the chat session was in the active state (at least one Agent participated). | CHAT_ |
cse_ Introduced: 8.5.301.06 | The maximum time (in seconds) that at least one agent was connected to a chat session. | Not mapped |
cse_ Introduced: 8.5.301.06 | The total number of times a session was in an active state, that at least one agent was connected to a chat session. | CHAT_ |
cse_ Introduced: 8.5.301.06 | The total time (in seconds) that at least one agent was connected to a chat session. | CHAT_ |
csg_ | The total number of all messages sent by all agents (messages which are visible to customer). Note: There can be several agents in a chat session, for example, conferences, transfers, and others. | CHAT_ |
csg_ | The total character count (including spaces) of all messages sent by agents. | CHAT_ |
csg_ | The total number of messages sent by customers. | CHAT_ |
csg_ | The total character count (including spaces) of all messages sent by customers. | CHAT_ |
csg_ | The number of parties that participated in a session as agents. Note: Only unique parties are counted. For example, if the same party joins the session several times, it only counts as one for the purpose of this statistic. | CHAT_ |
csg_ | The number of parties that participated in a session in the coaching mode (for example, an agent joins with the VIP visibility). Note: Only unique parties are counted. For example, if the same party joins the session several times, it only counts as one for the purpose of this statistic. | Not mapped |
csg_ | The number of parties that participated in a session in the monitoring mode (for example, a supervisor join with the INT visibility). Note: Only unique parties are counted. For example, if the same party joins the session several times, it only counts as one for the purpose of this statistic. | Not mapped |
csg_ | The total duration of a chat session from the time it was created until it was completely finished/closed in Chat Server. Note: This does not include the time between Chat Session End and Mark Done, as the interaction can still be handled by an agent. | CHAT_ |
csg_ | The duration of the waiting period, or the period of time a customer waits until the first agent (visible to a customer) joined the session. Note: The 0 (zero) value has two alternative interpretations: no agents ever joined the session (if csg_PartiesAsAgentCount=0) or an agent joined immediately when the session was started (if csg_PartiesAsAgentCount > 0). | CHAT_ |
csg_ | The period of time until the first agent submits the first visible to a customer greeting/message into a chat session. | CHAT_ |
csg_ | The period of time a customer is in a chat session. | Not mapped |
Extended (wait-reply) statistics
The extended statistics provide details about customer and agent wait and reply times. As in the case of general transcript statistics, an "agent" means both an agent and a supervisor, when either of those is visible to a customer.
- Wait time - The time between a message from the reporting party (or the last message, if there were a few messages in a row) being sent and the first message from another party being received in a reply.
- Reply time - The time between a message (or the first message, for a few messages in a row) from another party being received and the message from reporting party being sent in a reply.
The following extended transcript statistics are attached at the end of a chat session. If the KVPs are required for the out-of-box chat session reporting provided by Genesys Info Mart and GCXI, the "Info Mart Database Target" column indicates the Info Mart database table and column to which the KVP is mapped.
Unless indicated otherwise, the extended transcript statistics KVPs were introduced in Chat Server 8.5.101.
KVP | Description | Info Mart Database Target |
---|---|---|
KVP | Description | Info Mart Database Target |
cse_ | The maximum time (in seconds) an agent spent on replying to a customer. Note: For async chat sessions, if a chat session was in a dormant state while a customer message was received, the time until the agent rejoins the session is excluded. | CHAT_ |
cse_ | The number of times an agent replied to a customer. | CHAT_ |
cse_ | The total time (in seconds) an agent spent on replying to a customer. Note: For async chat sessions, if a chat session was in a dormant state while a customer message was received, the time until the agent rejoins the session is excluded. | CHAT_ |
cse_ | The maximum time (in seconds) an agent spent on waiting the reply from a customer. Note: For async chat sessions, cumulative dormant time until a customer's reply is received is excluded. | CHAT_ |
cse_ | The number of times an agent waited for replies from a customer. | CHAT_ |
cse_ | The total time (in seconds) an agent spent on waiting the reply from a customer. Note: For async chat sessions, cumulative dormant time until a customer's reply is received is excluded. | CHAT_ |
cse_ | The maximum time (in seconds) a customer spent on replying to an agent. | CHAT_ |
cse_ | The number of times a customer replied to an agent. | CHAT_ |
cse_ | The total time (in seconds) a customer spent on replying to an agent. | CHAT_ |
cse_ | The maximum time (in seconds) a customer spent on waiting the reply from an agent. | CHAT_ |
cse_ | The number of times a customer waited for the reply from an agent. | CHAT_ |
cse_ | The total time (in seconds) a customer spent on waiting the reply from an agent. | CHAT_ |
Async chat session statistics
Async chat session statistics are provided only for async chat sessions (in other words, when GCTI_Chat_AsyncMode=true is specified during session creation). The calculation of these statistics takes into account the active and dormant phases of an async chat session, as well as async inactivity control (which is different from regular inactivity control).
KVP | Description | Info Mart Database Target |
---|---|---|
KVP | Description | Info Mart Database Target |
cse_ Introduced: 8.5.301.06 | The maximum time (in seconds) a chat session was staying in dormant state. | Not mapped |
cse_ Introduced: 8.5.301.06 | The total number of times session entered dormant state | CHAT_ |
cse_ Introduced: 8.5.301.06 | The total amount of time (in seconds), customer chat session was in the dormant state (with no Agent participant). Routing time is excluded from dormant time. | CHAT_ |
cse_ Introduced: 8.5.301.06 | The maximum time (in seconds) an async chat session was staying in idle state. | Not mapped |
cse_ Introduced: 8.5.301.06 | Total number of times an async session entered idle state. | CHAT_ |
cse_ Introduced: 8.5.301.06 | The total amount of time (in seconds), exceeding configured threshold, without any activity when the chat session was in the dormant state (with no Agent participant). | CHAT_ |
csg_ Introduced: 8.5.301.06 | Denotes async session. Equals "1" for async chat session or "0" for regular chat session. | CHAT_ |
In deployments that include BGS, Chat Server also attaches the following KVPs:
- csg_MessagesFromBotsCount
- csg_MessagesFromBotsSize
- csg_SessionUntilFirstBotTime
- csg_PartiesAsBotCount
For more information about the bot-related KVPs, see Bot-related reporting data in the Bot Gateway Server Quick Start Guide (accessible only to restricted release customers).
Known limitation
The following is a known limitation with async chat reporting:
- Information about a chat session running in an async mode is available only after the chat session ends.