Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

Upgrading chat functionality to Pega Customer Service 8.2 and later

Updated on September 10, 2021

Starting with Pega Customer Service 8.2, the chat functionality has undergone fundamental changes to improve the text-based interaction experience and to centralize the chat configuration and administration. For example, Pega Customer Service 8.2 and later chat functionality offers self-service capabilities where all new customer interactions pass through a web chatbot as the first resolution path. Customers can then choose to escalate the chat to a CSR. If you are upgrading to Pega Customer Service 8.2 from an earlier version, you must reconfigure the chat functionality to work in the new framework.

If you are on Pega Customer Service 8.5 or earlier versions, it is recommended to upgrade to Web Messaging to leverage the React-based chat widget. For more information, see Migrating from Legacy Webchat to Web Messaging (Pega Customer Service)

    Before you begin

    • Ensure that all the relevant product hotfixes are installed for the Pega Customer Service version you are using.
    • Run the Pre-Upgrade Checker to evaluate the health of your application, identify the list of overridden critical rules, and fix the overwritten critical rules before you upgrade. For more information about the Pre-Upgrade Checker, see Pega Customer Service and Pega Sales Automation 8.3 Upgrade Guide on the Pega Customer Service Product Page.

    Configuration differences between legacy Pega Chat and Pega Customer Service Chat in 8.2 or later

    The following table shows the major configuration differences between legacy Pega Chat and Pega Customer Service 8.2 and later Chat:

    Configuration

    Legacy Pega Chat

    Pega Customer Service 8.2 and later Chat

    Chat servers

    Supports multiple chat servers

    Supports one chat server per Pega Customer Service instance

    For more information, see Setting up your existing chat server in the upgraded version.

    Chat queues

    Exclusive chat queues that do not support any other channels

    Omni-channel queues that support both chat and Facebook Messenger requests

    For more information, see Configuring chat and messaging queues.

    Chat Client

    A JavaScript snippet added to your web page that allows customers to chat with a CSR

    A web chatbot self-service configuration deployed on your website that supports chatbot functionality and CSR chats

    For more information, see Configuring and deploying the Web Chatbot.

    Configuring Chat Capabilities in Pega Customer Service 8.2 and later

    To configure chat capabilities in Pega Customer Service 8.2 or later, complete the following tasks:

    Setting up your existing chat server in Pega Customer Service 8.2 or later

    Many chat settings from Pega Customer Service 8.1 or earlier are moved to the Chat and messaging settings page in App Studio. You must configure a chat server with the Pega Customer Service application so that the application can connect to the chat server and process the chat messages.

    Unlike the previous versions that supported unlimited chat servers, Pega Customer Service 8.2 or later supports only one chat server per Pega Customer Service instance. If you have configured multiple chat servers previously, you must configure any one of them as the exclusive chat server in the current Pega Customer Service application.

    To configure the chat server in Pega Customer Service 8.2 or later, complete the following steps:

    You need the hostname and server configuration key of the existing chat server that you want to configure in Pega Customer Service 8.2 and later. To get this information, in the header of Dev Studio, click Configure > Channel Services > Pega Chat > Administration & Configuration (deprecated), and then copy the required information of the selected chat server.

    1. In the navigation panel of App Studio, click Settings > Chat and messaging.
    2. On the Configuration tab and go to the Chat section.
    3. Select the Type aheadcheck box. By selecting this check box, the CSR can see what the customer is typing in the chat window before the customer sends the chat entry. The CSR can use the extra time to plan an appropriate response or search for the predefined content to send as a response.
    4. Complete the server configuration as follows:
      1. In the Chat server hostname field, enter the hostname of the existing chat server.
      2. In the Configuration protocol list, select Http or Https.
      3. To configure the chat server with your application, ensure that the Port field is auto-populated with the value 443.
      4. In the Server configuration keyfield, enter the configuration key of the selected chat server.
    5. To ensure that the connection is established between the Pega Customer Service application and the provisioned chat server, click Verify.
      On successful verification, Key Verified message appears below the Server configuration key field.

    Migrating the legacy chat queues

    After configuring the chat server, you must migrate the legacy chat queues to the new omni-channel queues. Pega Customer Service uses omni-channel queues to handle conversations from chat and Facebook Messenger. To migrate the legacy chat queues to the omni-channel queues, Pega Customer Service provides a utility that completes the migration by auto-populating the new properties of the omni-channel queues with default values. Administrators can modify the default values after migrating the legacy chat queues to the omni-channel queues.

    1. In the header of Dev Studio, click Configure Dev Studio > Channel Services > Pega Chat > Migrate to Omni- Channel Queues.
    2. In the Select Chat Server list, select a chat server whose chat queues you want to migrate.
    3. Select the Legacy chat queues to migratecheck box.
    4. Click Migrate.
    5. Verify the selected queues and click Submit.

    For more information about how to modify the default values that are assigned to the new properties in the omni-channel queues, see Configuring chat and messaging queues.

    Building the self-service application

    To support the Web Chatbot channel, you need to build a self-service application in Pega Customer Service. One single self-service application supports all the self-service channels such as Facebook Messenger bot.

    Pega Customer Service includes a CS Self-Service application which consists of several self-service application components. Follow these major steps to build your own customer self-service application by using the CS Self-Service application:

    1. Create a ruleset for handling the self-service assets, for example, MyCS-SelfService:01-01-01.
    2. Create your customer self-service application by copying the CS Self-Service application:
      1. Replace the existing applications in the Built-on Applications section and update it with your customer service implementation application and Theme-Clarity.
      2. Add the customer self-service ruleset that you created to the top of the application ruleset stack and leave it unlocked.
    3. Update the CSSelfServiceAdmin and CSSelfServiceUser access groups to point to your newly created customer self-service application. Update the workpools of these access groups to point to the exact same workpools of Pega Customer Service implementation.

    For more information about creating a customer self-service application, see Creating a self-service application (Steps 1-3).

    Creating the ChatWithAgent case

    Pega Customer Service 8.2 introduces the PegaCA-Work-ChatWithAgent case type that the web chatbot uses to support chat escalations to CSRs. While running the application wizard on a new installation of Pega Customer Service 8.2 or later, the necessary cases are automatically created in the implementation layer of your application. However, in the case of an upgrade from Pega Customer Service 8.1 or earlier, this does not happen automatically.

    To learn how to add the ChatwithAgent case to your customer self-service application, see the Adding Necessary Case Type, Work Pools step in Creating a self-service application.

    Configuring and deploying the Web Chatbot

    After creating the self-service application, configure a Web Chatbot channel so that users can chat from an external website. As a part of the configuration, you define various chatbot responses to user inputs and actions along with other channel configurations such as interaction timeout. You can apply various styles to the chat window based on your branding requirements before deploying it on your website.

    For more information on how to build and deploy the chatbot, see Configuring and deploying the Web Chatbot.

    1. Copy the classes in the appropriate class groups to your implementation layer. Set the corresponding directed parent classes of the three classes as follows:
      ClassParent class
      PegaCA-Work-ChatWithAgentPegaCA-Work-ChatWithAgent
      PegaCA-Work-ChatWithAgent-SelectQueuePegaCA-Work-ChatWithAgent-SelectQueue
      PegaCA-Work-ChatWithAgent-PreChatQuestionsPegaCA-Work-ChatWithAgent-PreChatQuestions

      The following properties are added to the data transforms that populate the Declare_CAApplicationSettings data page:

      • .ChatAgentClass
      • .SelectQueueClass
      • .PreChatClass
    2. Update the three new parameter values to the newly created classes in the relevant data transforms of your Pega Customer Service implementation layer. The values should display in the order that is detailed in the following table.

      ParameterValue
      .ChatAgentClassPegaCA-Work-ChatWithAgent
      .SelectQueueClassPegaCA-Work-ChatWithAgent-SelectQueue
      .PreChatClassPegaCA-Work-ChatWithAgent-PreChatQuestion
    3. After the ChatwithAgent case is created, add it to your customer self-service application to include this new case type in the Cases and Data tab.

    Have a question? Get answers now.

    Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

    Did you find this content helpful?

    Want to help us improve this content?

    We'd prefer it if you saw us at our best.

    Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

    Close Deprecation Notice
    Contact us