Report Suite Configuration
Adobe Analytics supports up to 75 custom traffic variables and Stackchat uses many of these, so we recommend creating a new report suite to use with Stackchat. If you were to connect Stackchat to one of your existing Report Suites, we may populate with chat data the props and eVars that you've configured to track user behaviours on your company's other channels, such as websites or apps.
Every call Stackchat makes to Adobe Analyitcs has the pageName variable populated with your bot's name, so you can use the same report suite for all your Stackchat bots, allowing you to run reports that only display data for one bot at a time by splitting your reports based on page. Alternatively, you could configure a new report suite for each of your bots.
Creating a New Report Suite
First, you will need to create a new Report Suite for your Stackchat data.
Go to Adobe Analytics and log in with your Adobe ID.
From the menu at the top go to Admin > Report Suites.
Click Create New and then Report Suite.
At the Create Report Suite page, fill out all the required fields, starting with the template, for which you can select Default.
Click Create Report Suite. It may take some time for your new Report Suite to appear, as they are subject to Adobe approval. Once your suite has appeared, proceed to configure your props.
Configuring Custom Traffic Variables
Stackchat uses Custom Traffic Variables, also called props (s.prop) or property variables to log user chat behaviour. A detailed breakdown of the props, evars and events that Stackchat uses is available here.
First we need to enable and name the props used by Stackchat. Inside Adobe Analytics, use the top navigation to go to Admin > Report Suites. Find the Edit Settings button and go to Traffic > Traffic Variables.
Below is a table showing all the props that need to be set.
|2||User Input Group||YES|
|6||NLP Intent Name||YES|
|7||NLP Intent Type||YES|
|9||NLP Entities Extracted||YES||YES|
|10||NLP User Query||YES|
|14||Clear Slots Action||YES||YES|
|15||Set Slots Action||YES||YES|
|16||Analytics Event Action||YES||YES|
|19||Incoming User Message||YES|
|21||Cloud Function Error||YES||YES|
|23||NLP Confidence Range||YES|
|24||Sentiment Score Range||YES|
Below is an image of how the table above is converted into Adobe Analytics.
Click the Save button to complete prop configuration.
If a modal is displayed warning about list support changing the way data is processed, just hit "OK" - this is normal.
Configuring Conversion Variables
Conversion Variables (eVars) are used to track user behaviour within the conversation engine. We can use these to understand how many times a Logic Branch resolves as "true" vs "false" or how many times a User Input Group was started and then actually completed.
eVars need to be set in a manner similar to Props. Return to the Report Suite Manager in Adobe Analytics by going to Admin > Report Suites in the main navigation. Then go to Edit Settings > Conversion > Conversion Variables.
There may be preexisting Conversion Variables in your Report Suite. If so, you will need to overwrite them.
Replace these values with those in the table below.
|2||User Input Group||YES|
After replacing pre-existing eVars, create additional eVars to fill all five slots used by Stackchat as shown below.
Click the Save button to complete configuration of eVars.
If you see the modal below, just click OK.
Configuring Custom Success Events
Events are sent for many actions in the conversation engine and are used in conjunction with eVars (Conversion Variables) to track user behavior. They provide the different states that to which our eVars can resolve.
Still in the Report Suite Manager found at Admin > Report Suites in Adobe Analytics, go to Edit Settings > Conversion > Success Events.
Below is the table of Success Events to be inputted.
|Event #||Event Name||Type|
|15||Quick Nav Sent||Counter|
|17||Cloud Function Postback Received||Counter|
Click Save to complete configuration of Success Events.
You may see the modal below. Just click OK and continue on your way.
At this point, you should have configured all Custom Traffic Variables, Conversion Variables, and Success Events, and Adobe Analytics is ready to accept your data.