PDF(1.5 MB) View with Adobe Reader on a variety of devices
ePub(1.5 MB) View in various apps on iPhone, iPad, Android, Sony Reader, or Windows Phone
Mobi (Kindle)(1.2 MB) View on Kindle device or Kindle app on multiple devices
Updated:June 30, 2020
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
This document describes in detail the configuration, call flow, and Unified Contact Center Express (UCCX) script configurations needed to provide for inline survey integration between UCCX and the Webex Experience Management (WxM) platform.
Cisco recommends that you have knowledge of these topics:
UCCX 12.5 Engineering Special (ES) 01
The information in this document was created from the devices in a specific lab environment. All of the devices used in this document started with a cleared (default) configuration. If your network is live, make sure that you understand the potential impact of any command.
WxM is Cisco's next generation Customer Experience Management (CEM) platform. It enables improved customer experiences by giving businesses the ability to analyze and consolidate customer journey information and customer surveys from different touch points, and then view them in real-time after Contact Center interactions.
Inline Survey Voice Call Flow
The caller calls into the Contact Center through the voice gateway.
The voice gateway forwards the call to Cisco Unified Communications Manager (CUCM) for call processing.
CUCM sends the call to a computer telephony integration (CTI) route point which is associated with the UCCX Java Telephony API (JTAPI) user.
UCCX identifies the agent to route call to, reserves the agent on Finesse, and sends the request to CUCM to route the call to agent phone.
The agent answers the call from the Finesse desktop and the call is connected between the agent and the caller.
When the agent ends the call on the Finesse desktop, an end call notification is sent to UCCX.
If the application has a WxM questionnaire associated, UCCX invokes the REST client and sends the call details to the cherrypoint container running in the Cloud Connect component.
The cherrypoint container makes an API request to push the call details to WxM cloud securely using an auth token. WxM cloud sends a SIP URI back to UCCX. This is the pattern to which UCCX has to send call to for inline survey.
When UCCX receives the SIP URI dialing, it sends the pattern to CUCM as a redirect request.
CUCM sends the request to voice gateway.
Voice gateway, with its dial-peer configuration, will forward the call to WxM Twilio gateway to play the inline survey.
In order to integrate WxM with UCCX, a WxM license needs to be purchased. The WxM team performs the onboarding after the purchase and an email with essential configuration details is then sent to the registered email address provided.
The email contains this essential information:
Desktop user and API key
System user and API key
SIP URI domain
Web URI prefix
Voice PIN prefix
The Cloud Connect and cherrypoint configurations are done through the CLI within UCCX.
Once the email is received, you then need to SSH into the UCCX CLI and enter the command set cloudconnect cherrypoint config in order to initiate the configuration.
The UCCX server requires access to the Internet in order to connect to WxM. If your server is not in a DMZ, configure a proxy server and specify the proxy server details when filling out the required configuration items within the set cloudconnect cherrypoint config command.
In order to verify that your UCCX is able to reach WxM, enter the utils cloudconnect cherrypoint test-connectivity command within the CLI. Enter the proxy server host and port information when prompted, and your UCCX system will test its connectivity. You will see a success message as shown here if the connection was successful.
Browse to the UCCX appadmin page, choose Applications > Application Management, and choose the application to which the inline survey needs to be enabled.
Check the Enable Cisco Webex Experience Management post-call survey checkbox within the application setup.
Click the IVR radio button.
From the IVR drop-down list, choose the survey questionnaire you want to play to the caller after the agent disconnects the call from the customer.
Click Update for the changes to take effect.
UCCX Scripting Configuration
Note: This document describes steps to collect customer ID information by prompting the caller to input their ID. There are multiple ways to achieve this task.
In the UCCX script, create an ECC variable called POD.ID.
This variable stores the customer ID which is needed for WxM to work.
Since WxM filters the response based on customer ID, this value needs to be unique.
This is a mandatory variable for the customer survey to work.
Create a string variable which can store the customer ID information provided by the caller.
Create a Get Digit String step to prompt a caller and request that their customer ID be entered, receive the DTMF digits entered by the caller and then store the digits entered within a string variable created in the previous step.
In this example, the variable custID will store the input digit string from the caller.
Associate the value of the string variable (which stores the digit string from caller) to the POD.ID ECC variable using a Set Enterprise Call Info step.
By default, all callers will be transferred to WxM for the survey.
If you require callers to opt in/out of the survey, you will need to create a session variable ccx_survey_opt_in.
A Boolean value of ‘true’ in this session variable represents that the caller is interested in participating in a post-call survey.
A Boolean value of ‘false’ indicates that the caller would like to opt out of survey.
If you would like to provide this survey opt in/out option to the caller, complete these steps:
Note: There are multiple ways to achieve this task. One option is documented here.
Create a new session variable.
Create two Boolean variables.
A Menu step will be created and play a prompt asking the caller if they are willing to participate in a survey after agent disconnect.
If the caller inputs option 1, the session variable will be updated with true.
And if the caller inputs option 0, the session variable will be updated with false.
Under each of the connections, create a Get Contact Info step.
This step extracts information from particular type of object and stores it in a script variable to make the information about the contact available for subsequent steps in the script.
Depending on which path the call is taking, set the ccx_survey_opt_in session variable with value ‘true’ or ‘false’.
Complete the rest of the script configuration to route the call to CSQ and the agent.
Upload the script to UCCX script management and associate the script with the application which has WxM enabled for inline-survey.
A screenshot of a sample script with the steps/variables outlined is shown here:
As a first step in integrating the Finesse component with WxM, you need to add the Cloud Connect server FQDN and login credentials in the Finesse server. This step is crucial in getting the Finesse WxM gadgets to work within the Finesse agent and supervisor desktops.
When the agent logs in to the desktop, the gadget uses the auth token received from the Finesse server to communicate with the cloud to pull gadget data. For this to work, the Finesse server should have the Cloud Connect server information to fetch the auth token. Since the Cloud Connect and Finesse components both reside within the UCCX box, you do not have to exchange any server certificates.
In order to configure Cloud Connect information in Finesse, launch and log in to the cfadmin page.
In the Settings tab, look for Cloud Connect Server Settings.
Configure the Publisher and Subscriber addresses as your UCCX Pub and Sub FQDN.
Provide the server Username and Password.
WxM enables two different types of WxM gadgets for you to display within call center agents and supervisors.
Customer Experience Analytics Gadget:
For agents, the Customer Experience Analytics (CEA) gadget gadget displays industry standard metrics such as NPS (Net Promoter Score), CSAT (Customer Satisfaction score), and CES (Customer Effort Score) specific to the agent that uses the gadget.
For supervisors, this gadget displays industry standard metrics such as NPS, CSAT, and CES specific to their team.
Customer Experience Journey Gadget
The Customer Experience Journey (CEJ) gadget displays all the past survey responses from the calling customer as an agent answers the call.
In order to add the CEJ gadgets to the Finesse desktops, complete these steps:
Log in to WxM with the admin account.
Go to Overall Experience.
Choose the 3 vertical button or vertical ellipsis.
Click the Export Cisco Contact Center Gadget.
Copy the URL from the page.
Add the CEJ gadget XML reference to the Finesse layout(s):
Browse to the Finesse cfadmin page.
Go into the desktop layout where you want to add this new gadget.
Paste the URL copied from previous step. You can place the gadget under existing tab or create a new tab for WxM and paste the URL there.
Paste the URL under Agent and Supervisor section.
This screenshot below shows an example with a new tab configured.
In order to add the CEA gadgets to the Finesse desktops, complete these steps:
Log in to WxM admin portal.
Go to the Agent Dashboard space.
Under Metrics, choose Customer Experience Analytics.
Choose the 3 vertical button or vertical ellipsis.
Click Export Cisco Contact Center Gadget.
Copy the URL from the page.
In order to configure the CEA gadget for use within the Agent desktops, complete these steps:
Browse to the Finesse cfadmin page.
Go into the desktop layout where you want to add this new gadget. You can place this just below the CEJ gadget.
Add &filterTags=cc_AgentId to the end of the URL for the agent. This will filter the results per agent ID in the agent desktop.
When UCCX receives the SIP URI response from WxM, UCCX sends a redirect request to CUCM to route the call to SIP URI. In order to accomplish this, configure a SIP trunk in CUCM that points to your voice gateway.
Within the CUCM administration interface:
Navigate to Call Routing > SIP Route Pattern.
Configure a SIP route pattern for cloudcherry.sip.twilio.com.
Voice Gateway Configuration
Configure a standard incoming dial-peer from CUCM.
Configure an outgoing dial-peer to cloudcherry.sip.twilio.com. The gateway needs to have internet access to reach Twilio gateway.
Use this section in order to confirm that your configuration works properly.
Log in to Agent/Supervisor desktop and verify the CEA gadget loads with NPS and CSAT data.
Next, place a test call and verify the CEJ gadget loads up with previous customer surveys for the specific customer ID.
There is currently no specific troubleshooting information available for this configuration.