- Home
- /
- Article
Cisco Webex Contact Center Analyzer User Guide
Cisco Webex Contact Center Analyzer User Guide provides instructions on how to access Analyzer, use stock reports, generate real-time reports, and create custom reports and dashboards.
Introduction
Webex Contact Center Analyzer
Webex Contact Center Analyzer mines real-time and historical data from multiple data sources and systems to generate specific business views of the data. The Analyzer visually displays trends to help you discern patterns and gain insights for continuous improvement.
The Analyzer’s standard visualizations tie business data to traditional operational metrics, with visibility across both operational and business performance indicators in a single consolidated view.
You can customize your Analyzer experience by creating dashboards that display your choice of visualizations and schedule production of historical reports for automatic distribution to email recipients.
System Requirements
The Webex Contact Center Analyzer supports the browser versions listed in the following table.
Browser |
Microsoft Windows 10 |
Microsoft Windows 11 |
Mac OS X |
Chromebook |
---|---|---|---|---|
Google Chrome |
76.0.3809 |
103.0.5060.114 |
76.0.3809 or higher |
76.0.3809 or higher |
Mozilla Firefox |
ESR 68 or higher ESRs |
ESR 102.0 or higher ESRs |
ESR 68 and higher ESRs |
NA |
Edge Chromium |
79 or higher |
103.0.1264.44 or higher |
79 or higher |
73 or higher |
Chromium |
NA |
NA |
NA |
73 or higher |
Complete the following task:
-
Enable browser pop-ups.
Access the Webex Contact Center Analyzer
Before you begin
1 |
Open your Web browser and navigate to the URL provided by your administrator. |
2 |
On the login page, enter your email address and password. |
3 |
Click Login. The Webex Contact Center Analyzer home page displays four repositories containing summaries of all the session and activity data captured for both agents and customers. You can expand a repository tile by clicking its More details button to display the details for today, yesterday, this week, last week, this month, and last month. While you're on the homepage of the current Analyzer, you can conveniently access the new Analyzer. To explore the new Analyzer, select either Launch or Try Now. Seamless navigation between the two Analyzer versions is possible using browser tabs. |
Access Control
The Reporting and Analytics module controls access to Analyzer. You use the Management Portal to configure the Reporting and Analytics module.
You configure the access privileges (view, edit, or none) to the Analyzer utilities (Folders, Visualizations, and Dashboards) in the Reports and Dashboard Permissions area under .
You can configure access privileges to other entities also, as summarized in the following table.
Configurable Items |
Configurable Entities |
Remarks |
---|---|---|
User Profiles > Access Rights | Entry Points , Queues, Sites, Teams |
If the site is restricted, you can choose only Teams. |
Agent Profiles > Agent Viewable Statistics | Queues, Teams |
You must apply the restrictions manually in accordance with the restrictions that are configured for the User Profiles. |
User > Agent Settings | Site, Teams |
Agent access privileges cannot be greater than those of the selected Site. |
For more information about configuring access privileges, see Provisioning in the Cisco Webex Contact Center Setup and Administration Guide.
When you create or edit a visualization, the record type you choose produces results based on restrictions applied to specific entities, as shown in the following table.
Record Type |
Applied Entity Restrictions |
---|---|
Customer Activity Record |
Entry Points, Queues, Sites, Teams |
Customer Session Record |
Entry Points, Queues, Sites, Teams |
Agent Activity Record |
Queues, Sites, Teams |
Agent Session Record |
Sites, Teams |
For more information on the type of records, see Type of Records Available in Each Repository.
The following table lists the resources on which the access privileges apply, and describes how restrictions apply based on roles.
Resources |
Roles |
Restrictions |
---|---|---|
|
Administrators and supervisors with Cisco Contact Center disabled or with no associated Agent Profiles |
Restrictions applied are based on the User Profiles |
|
Administrators, supervisors with associated Agent Profiles and all agents |
Restrictions applied for:
Management portal reports always use user profiles irrespective of the user role. |
|
All administrators and supervisors |
Restrictions applied are based on the User Profiles |
SPP admin user isn't supported.
Analyzer Title Bar Buttons
Click the Home button on the Analyzer title bar to display the navigation bar options: Visualization, Dashboard, and Variables.
For more information, see Tasks to Perform on Visualization and Dashboard Pages.
The following options are available on the title bar:
-
Threshold Alerts—Click the bell icon to display the latest four unread realtime alerts highlighted in red.
For more information, see Threshold Alerts.
-
User drop-down list shows these options:
-
Support
-
Feedback
-
Help
-
Log Out
-
If you resize your browser window to make it narrow, your user account name isn’t displayed on the button label.
Threshold Alerts
See Cisco Webex Contact Center Setup and Administration Guide for information about configuring Threshold Rules.
Managing the alerts involves the following steps:
-
Click the Threshold Alerts icon to open the Realtime Alerts window which displays a list of real-time alerts, if present in the system.
By default, Analyzer displays read and unread real-time alerts for all entity types.
The following table describes the information displayed in each real-time alert.
Table 1. Real-time Alerts Date
Alert Time
Entity Type
Entity Name
Alert Type
Threshold Value
Actual Value
Displays the date on which the alert is raised.
Displays the time at which the alert is raised.
Displays the source from which the alert is raised.
Displays the name of the alert.
Displays the type of alert.
Displays the value which if exceeded raises the alert.
Displays the actual value.
-
(Optional) Use the Notification Type and Entity Type drop-down lists to alter the data source selection and produce a customized list of real-time alerts.
-
Notification Type: From the the drop-down list, choose All to list all the alerts. Choose Read to list the read alerts and Unread to list the unread alerts.
-
Entity Type: From the drop-down list, choose the Entity Type. The available options are: All, Entry Point, Agent, Site, Team, or Queue.
-
-
(Optional) Choose from the following actions:
-
Click the Stop Auto Refresh toggle button to disable the default system behavior which refreshes the real-time alerts list every three minutes and provides a count-down to the next refresh, in MM:SS format.
The label on the toggle button changes to Start Auto Refresh and a counter displays the duration since the last refresh, in MM:SS format.
-
Click the Start Auto Refresh to re-enable default system behavior which refreshes the real-time alerts list every three minutes. The toggle button label reverts to Stop Auto Refresh and the count-down to the next refresh begins.
If an auto-refresh happens at the same time you select a single alert or multiple alerts in the Realtime Alerts page, the selection is retained in the next auto-refresh window.
The notifications on the Threshold alerts bell icon are also automatically refreshed every three minutes. The auto-refresh functionality is enabled by default.
-
-
(Optional) The Mark as Read button on the top-left corner of the page allows you to acknowledge the alerts. Select multiple alerts or a single alert and click Mark as Read. A "Read" alert appears in gray.
If new alerts are raised on the already "Read" alerts, the new alerts appear as "Unread" alerts.
-
(Optional) Use the drop-down list at the top-left corner of the page to switch between Realtime Alerts and Historical Alerts windows.
Some controls in the Historical Alerts window are identical to those in the Realtime Alerts window. An additional control, Duration, is provided to specify the timeframe for which historical alert records are displayed.
-
In the Historical Alerts window, use the Mark as Read button and the Notification Type, Entity Type, and Duration drop-down lists to manipulate the data source selection and produce a customized list of historical alerts.
Options for the Duration drop-down list are Yesterday, This Week, Last Week, Last 7 Days, This Month, Last Month, This Year, and Custom. For the Custom option, the start date has to be within three years of the current date.
The following table describes the information displayed in each Historical alert.
Table 2. Historical Alerts Date Alert Time Entity Type Entity Name Alert Type Threshold Value Actual Value Displays the date on which the alert is raised.
Displays the time at which the alert is raised.
Displays the source from which the alert is raised.
Displays the name of the alert.
Displays the type of alert.
Displays the value which if exceeded raises the alert.
Displays the actual value.
Email alerts for threshold breaches include the updated time stamp for each threshold breach, and the time zone displayed corresponds to the Tenant time zone.
Time Zone
Time zone is a user setting in the Analyzer title bar. Choose the Browser time zone or the Tenant time zone from the time zone drop-down list. The Tenant time zone is the default time zone.
The data query and the data displayed in the Analyzer report depend on the selected time zone.
After you run a report or a dashboard, the report or the dashboard displays the selected time zone at the top-right corner of the report page.
The exported reports in Excel or CSV format display the data in the time zone that is displayed on the report in the Report UI.
While running a report or a dashboard, if you change the time zone setting in the Analyzer title bar, the updated time zone displays on the running reports or dashboards only after you manually refresh the page.
Scheduled jobs always run in the Tenant time zone.
You cannot modify the time zone for Agent Performance Statistics (APS) reports in Agent Desktop. APS reports are always displayed in the Browser time zone.
Dashboards in the Management Portal are always displayed in the Browser time zone.
Tasks to Perform on Visualization and Dashboard Pages
The Visualization and Dashboard pages display all the directories of visualizations or dashboards and enable you to perform the following tasks:
-
Create, rename, and delete folders or subfolders under the parent directory.
There are two types of folders:
-
View only folders appear as in Stock Reports.
-
Custom folders (user created) appear as in Custom Reports.
-
-
Create, run, edit, search, filter, delete, and schedule a visualization or dashboard.
You cannot run, edit, or schedule a visualization that has a long duration and less interval. Reset the Duration and Interval fields as required for real-time and historical reports to proceed further. For more information, see Create a Visualization.
-
Export visualization Historical Reports either to Microsoft Excel or CSV file.
-
When you change a date format of a report and export it to a CSV file, and then open that CSV file in Microsoft Excel, the date format is displayed according to the user's preference in Excel. To see the exact date format that you applied for a report, open the report in a text editor.
-
You cannot export a visualization Historical Report if it has more than 2000 columns.
-
-
Change the view to either a list or a grid.
Procedure to perform each task:
-
To add a new folder:
-
On the Home page, click the Visualization or Dashboard icon.
-
Select the folder within which you need to create a new folder.
-
Click Create New > Folder.
-
In the dialog box, enter the folder name and click OK.
-
-
To filter either by Folders, Visualizations, or Compounds:
-
On the Home page, click the Visualization or Dashboard icon.
-
Select the required option from the Show drop-down list.
-
-
To Search:
-
On the Home page, click the Visualization or Dashboard icon.
-
In the Search Folders & Visualizations field, enter the name of the visualization or dashboard.
-
-
To perform other tasks in the Visualization or Dashboard page, click on the respective folder, visualization, or a dashboard:
Action
Appears In
Description
Rename Folder Folder Rename a folder. Delete Folder Folder Delete a folder. You can delete only an empty folder. Run Visualization Dashboard
Runs the selected report or dashboard. You can individually filter data based on the parameters displayed for visualizations and dashboards.
After running a Stock Dashboard, you can use global filters (at the top-right corner) to filter the data.
Create a Copy Visualization
Dashboard
Creates a copy of the Stock Reports in the visualization or dashboard. Details Visualization
Dashboard
Displays more details about the selected item, such as the title, date range, and number of scheduled jobs for a visualization. Export as Excel Visualization
Dashboard
Opens a dialog box where you can save the selected historical visualization as a Microsoft Excel or CSV file. The export option is not available for real-time or compound visualizations. The export option is not available for a Drill Down report with real-time data.
Export as CSV Visualization
Dashboard
Schedule Job(s) Visualization Opens a page where you can schedule the selected visualization to run on a periodic basis and associate it with an email list for automatic distribution. Edit Custom Reports Opens the selected visualization or dashboard on a page where you can edit it. Delete Custom Reports Deletes the selected visualization or dashboard. You cannot delete a visualization that is used in a dashboard. -
Stock Report and Custom Report columns are localized. An exported Excel file also shows localized columns in Stock Reports and Custom Reports. If the respective language bundle key for localization is missing in the columns, the columns are shown in default English language. User-specified values are not localized.
Share Browser Links to Reports and Dashboards
1 |
Log in to the Webex Contact Center Analyzer. For more information, see Accessing the Webex Contact Center Analyzer. |
2 |
Run the visualization or dashboard that you need to share. For more information, see Run a Visualization and Run a Dashboard. |
3 |
Copy the URL displayed on the browser. You can share this URL with the agents.
|
Access Reports and Dashboards through Browser Links
1 |
Click the browser link that is provided by your administrator. The Sign In page to the report or dashboard appears.
|
2 |
Enter your email address and password. |
3 |
Click Sign In. The report or dashboard appears.
|
4 |
If you have accessed a dashboard, click Launch at the top-right corner of the dashboard to view a report. |
Visualizations
Run a Visualization
To run a visualization:
1 |
Click the Visualization icon on the navigation bar. |
2 |
To find a report, you may use either the Search function or the When you click on a folder or a report, the exact location of the folder or the report is displayed on the breadcrumb. |
3 |
On the report, click the By default, you can view a set of stock reports. To edit a report, you can create a copy of the report by clicking Save As to save it in your folder. For more information, see Stock Reports.
|
4 |
After the visualization is rendered, click the You can see the last refreshed time of the visualization data in the Data Summary tab. If you’re running a visualization with multiple modules (compound visualization), the Data Summary tab displays a drop-down list of all the modules in the visualization so that you can display the details of each individual module. |
5 |
Click the Details tab to display the following settings and panels. Click a panel title to expand or collapse the panel. If you are running a compound visualization, the details are displayed separately, depending on which module is selected in the drop-down list at the top of the tab.
Compute specifies the compute interval and the number of records to be considered in a time-based historical visualization. Compute specifies the frequency, band, and whether the calculations are cumulative for a sample-based visualization. For more information, see Create a Visualization. If filters are applied to any field, an extra panel is displayed for each field so that you can see the values that have been filtered in or out of the visualization. |
6 |
Click Settings to display the segments and variables associated with the visualization. You can also change the Output Type. For more information, see Change the Visualization Output Format. |
7 |
If the visualization is in a chart format:
|
8 |
If the visualization is historical, you can click the Export button on the title bar to export the visualization as a Microsoft Excel or CSV file. Real-time and compound visualizations cannot be exported. You cannot export a visualization Historical Report if it has more than 2000 columns. |
Change Report Column Width
By default, the column width in tabular reports is aligned with the column title length. You can change the column width dynamically while running reports. If you change the column width, the updated width is saved in your computer for your user ID. The column width remains the same even if you refresh the browser or log out and log back in using the same browser. You can reset the column width to the default width by clearing the browser cache.
If the changed column width is lesser than that of the column title, an ellipsis icon is shown.
If you change the column width, the updated width is not saved for Threshold Alerts.
Drill Down to a Portion of the Visualization
After you run a visualization in table format, you can drill down into a specific visualization component to see all the records that were involved in the computation of that portion of the visualization and perform further analytics on the data set.
The Drill Down functionality is not available for reports that are accessed through browser links and for the APS reports in the Agent Desktop.
1 |
Click on a table cell and then click the Drill Down icon.
|
2 |
To add a field or a profile variable, click an entry from the Fields or Measures drop-down list to append a new column. If you select a Field or Measure that already exists in the table, then it will not add the field again. |
3 |
To export the report data as a Microsoft Excel or CSV file, click Export. The export option is not available for a Drill Down report with real-time data. |
4 |
To view the Drill Down panel in a separate window, click the Launch icon. |
Modify Visualization Attributes
After running a visualization, you can modify its attributes and rerun it:
1 |
Click Settings. |
2 |
To show or hide the summary of column values at the table level and the top-level row segment, select the values from the Show Summary drop-down list. |
3 |
If you want the visualization to be updated immediately, select Redraw instantly. Otherwise, the visualization will be updated only when you click the Apply button. |
4 |
To show or hide a profile variable, click the eye icon. |
5 |
To hide a segment, drag it to the Hidden Segments box. This capability is not available for compound visualizations. |
6 |
To reposition a segment, drag it to a different location either within its current Segments box or to a different Segments box. This capability is not available for compound visualizations. |
7 |
To filter a segment:
Changes are always rendered immediately when you filter a segment and when you show or hide a profile variable. |
8 |
If the visualization is a chart, select the Settings icon to modify the visualization. |
Change the Visualization Output Format
1 |
Click Settings. | ||||||||||||||||||||
2 |
Select a format from the drop-down list. The possible formats are:
Motion Charts are no longer supported.
|
Visualization Creation Overview
This chapter describes how to create visualizations using an intuitive drag-and-drop interface.
1 |
Select the type of visualization:
|
2 |
Specify the time period that you want the visualization to cover. This constrains the number of records that will be considered during execution of the visualization. |
3 |
The compute interval for a historical report can be either time-based or sample-based.
|
4 |
Specify what you are trying to compare as part of the visualization. This can be to compare the performance of the different agents or entry points. The Analyzer allows segmentation only by fields and not by measures. For example, segmentation by Termination Type or Agent Name is allowed, segmentation by Call Count is not allowed. |
5 |
Define the metrics you want to see in the visualization to compare the different segments. Profiling variables are always numeric values and can be created from either fields, measures, or other profiling variables.
|
6 |
This step further limits the population set to include only the records that meet the conditions you specify. |
7 |
A visualization can be displayed as a table or chart. The chart types currently supported are Bar, Pie, Line, Area, and Motion. Additionally, you can specify display options such as titles, colors, and border widths and styles. |
8 |
Visualizations can be executed on demand, scheduled for a one-time execution, or scheduled to run periodically. Scheduled executions post their results to the specified email recipients as a CSV or a Microsoft Excel file attachment. The following limits are applicable for scheduled reports:
You can define the execution schedule in one of the following ways:
|
Create a Visualization
To create a visualization:
1 |
Select Visualization > Create New > Visualization. The visualization creation page appears. The Modules tab displays two panels that you can expand or collapse by clicking a panel title. | ||||||||||
2 |
Select an option from the Type drop-down list. The possible values are Customer Session Record, Customer Activity Record, Agent Activity Record, or Agent Session Record. You can add variables and segments to the reports. | ||||||||||
3 |
Specify the visualization time period by selecting an option from the Start Time drop-down list in the Modules tab.
| ||||||||||
4 |
To edit a module label, select the label text and type a new label.click the Edit ( | ||||||||||
5 |
You can filter the date range by selecting an option from the Including drop-down list. The possible values are Days of a Week, Days of the Month, Weeks of the Month, or Months of the Year. Select the weekdays, days of the month, weeks, or months that you want the visualization to include. | ||||||||||
6 |
If you are creating a time-based visualization, select a time interval from the Interval drop-down list in the Compute panel. The possible values are: None, 15 Minutes, 30 Minutes, Hourly, Daily, Weekly, or Monthly. The available options vary depending on the length of the date range. Small compute intervals (such as 15 Minutes, 30 Minutes, or Hourly) are not available if the specified date range is lengthy (such as Last Month). | ||||||||||
7 |
If you are creating a sample-based visualization, select First or Last from the Records drop-down list in the Compute panel, and in the text box, enter the total number of records to be considered in the visualization. You can also define the following: | ||||||||||
8 |
If you selected Realtime as the visualization time period, select values from the drop-down lists that become available in the Compute panel.
| ||||||||||
9 |
To specify either Row Segments or Column Segments, click the Add Row Segments or Column Segments icon. Drag and drop a field or an enhanced field listed in the canvas area. Repeat this step for each segment you want to add. Fields can be added as either Row Segments or Column Segments. For charts, only the first segment is used. High cardinality fields such as Contact Session ID and Agent Session ID contain a large set of unique values. When you select these fields as row or column segments while creating a new report or modifying an existing report, a large amount of data is fetched. To avoid this, a pop-up prompts you to add specific filters to decrease the amount of data fetched. You can also ignore the message and continue to save the visualization. The prompt appears when you select the high cardinality fields as row or column segment. You can resolve it by adding more filters to decrease the amount of data. | ||||||||||
10 |
To combine multiple values of the segmentation variable into one group, you can create an enhanced field: | ||||||||||
11 |
To create a profile variable:
You can also create a new formula based on a profile variable that exists in the visualization.
| ||||||||||
12 |
To specify the format for the profile variable, right-click the profile variable and select the Number Format option from the context menu. For more information, see Format a Profile Variable. For example, if you created a Conversion Rate profile variable, you could select Percentage as the format. | ||||||||||
13 |
Continue creating as many profile variables as you want. In the following example, three profile variables have been created and the data is segmented under Queue ID and Agent Name header rows. If you are creating a motion chart, you must include at least three profile variables. | ||||||||||
14 |
To show or hide the summary of column values at the table level and the top-level row segment, select the values from the Show Summary drop-down list. | ||||||||||
15 |
To define the summary of column values at the table level and the top-level row segment, click Customize. For more information on Customize Report Summary, see Customize Report Summary. | ||||||||||
16 |
To find out approximately how large the visualization will be when it is run, save the visualization and click More and select the Info button. | ||||||||||
17 |
You can create a filter to limit the number of records that the visualization considers by default. To create a filter: | ||||||||||
18 |
Specify a visualization output format. For more information, see Change the Visualization Output Format | ||||||||||
19 |
If you are creating a compound visualization, add at least one additional module before you save the visualization. | ||||||||||
20 |
To save the visualization, click the Save button, and in the dialog box that appears: | ||||||||||
21 |
Click Preview to view the visualization. If you are creating visualization of the Customer Session Record type, where Interval is used as Row Segment and Contact Start Timestamp and Contact End Timestamp are used as Profile Variables from the Measures drop-down list, select the following values from the Formula drop-down list:
|
Create a Compound Visualization
A compound visualization includes two or more modules that are displayed alongside. All modules within a visualization must have identical rows or series segments, column segments, and profile variables, but can have different date ranges, intervals, and filters.
You can create a compound visualization as follows:
-
While creating a new visualization, by adding at least one additional module (Historical or Realtime module) before you save the visualization.
-
Edit an existing visualization which has only one module by adding new modules (Historical modules only).
However, if you save a visualization with more than one module, you can later delete all but one module, save the visualization and add more modules (Historical modules only).
Realtime modules can be added to a compound visualization only while creating it and before saving the visualization. You cannot edit an existing visualization to add a Realtime module.
Compound visualizations cannot be scheduled or exported and do not have pivoting capability in execution mode.
1 |
To add a module during visualization creation, click Add at the top of the Modules tab. In the dialog box that appears, enter a name for the module and click OK. Click Add again for each additional module you want to add. After adding a module, the visualization creation page displays the constituent visualizations side by side. You can select different date ranges, intervals, and filters for each module. Choose an interval value other than None. If None is chosen, the interval values are displayed as belonging to the year 1970. |
2 |
To display the settings that can be customized for each module, select a module from the drop-down list at the top of the Modules tab. |
3 |
To edit a module label, select the label text and type a new label.click the Edit ( The drop-down list in the Modules tab reflects the label changes. |
Create a Visualization Displaying Actual Values
To display the actual values in the database without aggregation, the visualization cannot include a time interval or segmentation, and all profile variables must be configured with Value of as the formula.
The Value of option is not available in a visualization that already includes a time interval or segmentation.
To create a visualization displaying actual database values without aggregation:
-
Click Visualization > Create New > Visualization.
-
Select a Type. The possible values are Customer Session Record, Customer Activity Record, Agent Activity Record, or Agent Session Record.
-
Specify the visualization time period.
-
To add a profile variable:
-
Click the Add Profile Variables, and drag and drop a field or measure in the New Profile Variable dialog box.
-
In the Formula drop-down list, select the Value. Repeat for each additional profile variable you want to add.
-
-
Click Save to save the visualization. Then you can click Preview.
Create an Enhanced Field
-
Right-click a segment in the visualization and select Create Enhanced Field.
-
Specify the settings for the group as described in the following table:
Setting
Description
Default Group
Enter a name (for example, Other Entry Points) for the group that includes all the variables not included in the defined groups.
Groups
To define a group, enter a name in the Group Name:
-
Select values from the drop-down list.
-
Type a value and then press Enter.
-
-
Click Save.
Delete a Shared Enhanced Field
To delete a shared enhanced field:
-
Click the Add button to add the Column Segments or Row or Series Segments box to display the New Segment dialog box.
- Select the enhanced field you want to delete and click the Deletebutton.
If the enhanced field is not currently in use, it is deleted.
Share an Enhanced Field
To make an enhanced field available for future use:
-
Click the enhanced field segment that has been added to the visualization and select Save from the context menu.
-
Enter a name for the enhanced field and click OK.
The saved enhanced field will now be listed in the New Segment dialog box for selection when you and other visualization designers create or edit a visualization.
Select a Formula for a Measure
The following table describes the formulas available when you use a measure to create a profile variable.
Formula |
Calculates |
---|---|
Average |
The average value. |
Sum |
The total value. |
Count |
The number of values. When you select this formula, the dialog box displays settings for specifying a condition for including records in the count. For more information, see Filter Using a Measure. |
Minimum |
The smallest value. |
Maximum |
The largest value. |
Value of |
The actual value in the database without aggregation. |
Geometric Mean of |
The nth root (where n is the count of numeric values within the specified range) of the product of the values. |
Kurtosis of | The measure of whether the data are peaked or flat relative to a normal distribution. |
Median | The middle value. |
Population Variance of |
Variance of the set of unique values. |
Skewness of | How far the median is from the mean. |
Standard Deviation of | The square root of the variance. |
Sum of Squares | The sum of the squares of the values. |
Variance of |
The average of the squared differences between each value and the mean value. |
Define Filters
Filter using a Field
When you run a visualization, the settings panel displays controls for specifying which records to include or exclude from the visualization.
These controls are displayed while creating or editing a visualization, when you do the following tasks:
-
Drag a field into the Filters area of the dialog box that appears when you create or edit a profile variable.
-
Click Add Filter and select a listed field in the dialog box that appears.
-
Right-click a segment in the visualization and select Create Filter.
-
To specify which field values to include or exclude, do one of the following:
-
Click the regular expression radio button, and then enter a regular expression in the text box to specify the values to include or exclude. Click Save.
The following examples describe regular expressions:
-
agent.* includes all field values starting with the phrase
agent
. -
agent.*h includes all field values starting with the phrase
agent
and ending with the letterh
.
For more information about standard regular expressions, see https://www.elastic.co/guide/en/elasticsearch/reference/current/regexp-syntax.html.
-
-
Click the is in or is not in radio button, select the values in the list that you want to include or exclude, and then click Save. Also, you can type a name of a value in the text box and click Save.
-
-
To filter the list of available values, type one or more characters in the text box. As you type, the values that match your text appear in the list for your selection. You can use * as a wildcard to represent one or more characters.
-
To specify an empty (blank) value, click Add.
-
To remove a specified value, select the value and click Delete.
Filter Using a Measure
The Analyzer displays controls for specifying which records to include in or exclude from the visualization based on the value of a measure when you do the following:
-
Drag a field into the Filters area of the dialog box that appears when you create or edit a profile variable.
-
Click Add Filter in the Modules panel (or, if you are editing a single-module visualization, the Details panel) and select a listed measure in the dialog box that appears.
-
To set a condition for a measure, do one of the following:
-
To restrict the data to values between a minimum and maximum value, select Between from the Comparator drop-down list, and then enter a minimum and maximum value in the Min and Max text boxes.
<
less than
<=
less than or equal to
=
equal to
!=
not equal to
>=
greater than or equal to
>
greater than
The minimum value is inclusive, but the maximum value is non-inclusive.
-
To restrict the data based on a single-sided comparison, select an operator from the Comparator drop-down list and enter a value in the Value text box.
In the following example, a condition (greater than 0) is applied to a Total Revenue measure to create a Converted profile variable.
-
Filters in the Run Mode
The Analyzer UI offers filtering capabilities while executing a report in the run mode.
You can choose filters while creating or editing a visualization, and also while creating a copy of the visualization.
When you run a visualization, the filters appear at the top-right corner of the visualization page. You can filter the visualization by selecting the appropriate filters without editing the report.
To add a filter to a report that shows up in run mode while creating a visualization:
-
Go to the Analyzer home page. Click the Visualization icon in the navigation bar.
-
To create a new visualization, choose
. -
In the create visualization page, select and drag the required fields to the Row Segments pane. The added fields are displayed as filters in the Show filter on Run Mode check box list, along with the default filters. The default filters are:
-
Duration and Interval field for a Historical Report. The Interval field appears as a filter only if it is selected as a Row Segment.
-
Duration field for a Real-time Report.
-
-
Select the required filter in the Show filter on Run Mode check box list by selecting the corresponding check box.
By default, all filters in the Show filter on Run Mode check box list are unchecked.
-
Select the required Profile Variables and Column fields, and save the new visualization in the appropriate folder.
The filters are displayed at the top-right corner of the visualization. You can now filter the visualization by selecting the appropriate filters, without editing the report.
For more information on creating a visualization, see the section Create a Visualization.
To add a filter in run mode while creating a copy of the visualization:
-
Navigate to Create a Copy option.
. Select the appropriate Stock Report and click the ellipsis button to display the report options. Choose -
Select the appropriate filter from the Show filter on Run Mode check box list that appears on the left pane of the visualization page.
By default, all filters in the Show filter on Run Mode check box list are checked.
-
Save the new report in an appropriate folder.
-
When you run the visualization, the filters are displayed at the top-right corner of the visualization.
For more information on creating a copy of the visualization, see the section Tasks to Perform on Visualization and Dashboard Pages.
To add a filter in run mode while editing the visualization:
-
Go to the visualization page. Click the ellipsis button and then select the Edit option to edit the visualization.
-
Select the required filter in the Show filter on Run Mode check box list that appears on the left pane of the visualization page.
By default, all filters in the Show filter on Run Mode check box list are selected.
-
Save the new report in an appropriate folder.
-
When you run the visualization, the filters are displayed at the top-right corner of the visualization.
For more information on editing a visualization, see the section Tasks to Perform on Visualization and Dashboard Pages.
A maximum of five filters can be added to be displayed in a report in the run mode.
Filters at the top-right corner of the visualization page are not supported for compound visualizations (which has two or more modules). If you edit an existing report with one module to add another module, the Show filter during run mode check box list grays out.
Create a Formula Based on a Profile Variable
You can create a new formula by applying a mathematical formula to an existing profile variable.
To create a formula based on an existing profile variable:
Formulae should not be applied on text-based fields in the value-based reports since it is not a valid operation for report generation.
-
Right-click a profile variable in the visualization and select New Formula from the context menu.
-
In the New Formula dialog box that appears, enter a name for the profile variable in the Name text box.
-
Select a mathematical symbol: +, –, × or ÷.
-
Do one of the following in the text box to the right of the mathematical symbol:
-
Type a numeric value.
-
Select the name of an existing profile variable from the drop-down list.
-
Creating and Using Shared Formulas
After you create a profile variable, you can make its formula available in the Formulas panel for use by yourself and other visualization designers.
Create a Shared Formula
To create a shared formula:
-
Create a Profile Variable. For more information, see Create a Visualization.
-
Right-click the profile variable and select Save.
-
Enter a name for the formula and click OK.
The formula is saved in the Formulas panel.
Edit a Shared Formula
To edit a shared formula:
-
Click Add Profile Variables and then double-click the name of a formula listed in the Formulas panel.
-
You can edit the values or add additional Fields and Measures.
-
Click Save.
Delete a Shared Formula
To delete a shared formula:
-
Click the Addbutton in the Profile Variables box, and then double-click the name of a formula listed in the Formulas panel.
-
Click delete.
If the formula is not currently in use, it is deleted.
Create and Format a Visualization Title
To create and format a visualization title while creating or editing a visualization:
-
Click the text Click to add title in the visualization canvas and enter a new title.
-
To edit the title, select it and enter a new title.
-
In Formatting, select Title from drop-down and enter the title text.
-
-
To customize the format of the title, select Title from the drop-down list in the Formatting tab to display the formatting options that you can customize, such as border size, style, and color; text alignment and color; margins; padding; and font size, family, style and weight.
Format a Table
To customize the format of a table:
-
Select Formatting, and then select Table from the drop-down list.
-
Change any of the following options to customize the table format:
Option
Description
Back Color
Select the background color from the color selector or enter the HTML (hexadecimal) code for a color.
Border Size
Enter a value in pixels to change the border width.
Border Style
Select a value from the drop-down list to specify the style of the border around the table or select None if you do not want a border around the table.
Border Color
Select the border color from the color selector or enter the HTML code for a color.
Format a Profile Variable
To change the text alignment, number format, or caption of a profile variable:
-
Do one of the following:
-
Right-click a profile variable to display the context menu.
-
Select a profile variable from the drop-down list in Formatting to display the number format and caption options in the tab.
-
-
Change any of the options described in the following table:
Option
Description
Caption
To change the caption, click the caption text that's displayed in the Formatting tab to select it, and enter the required caption.
This setting is available only in the Formatting tab.
Number Format
Right-click to specify whether you want the data to be formatted as Integer, Number, Currency, Percentage, Date Time, or Duration, and within that category, specify how you want the data to be displayed.
For example, when you select Percentage, you can select one of the following format options:
-
##.##% (12.34%)
-
##% (12%)
Text Align
To change the alignment of the column text, select a value from the drop-down list: Left, Center, or Right.
This setting is available only from the context menu.
-
Change Date Format of the Interval Field
You can edit the default date format (mm/dd/yyyy) of the Interval field while creating or editing a visualization.
1 |
Right click the Interval field to display the Select Date Format context menu. |
2 |
Select the required date format from the following list:
|
3 |
Click Save. If you export a report in the .csv format and open it in Microsoft Excel, the date is displayed according to the date format that is set in Microsoft Excel. To display the dates in the exact date format that you applied for the Interval field in the visualization, open the exported CSV report in a text editor. |
Format a Chart
To customize the format of a chart:
-
Choose Formatting > Chart.
-
Change any of the following options to customize the chart format:
Option
Description
Back Color
Select the background color from the color selector or enter the HTML code for a color.
Border Size
Enter a value in pixels to change the width of the border around the chart.
Border Style
Choose a value from the drop-down list to specify the style of the border around the chart or select None if you do not want a border.
Border Color
Select the border color from the color selector or enter the HTML code for a color.
Gradient Fill
To add a shade pattern to the lines, areas, or bars in a line, area, or bar chart, select the direction of the color gradient from the drop-down list.
Stacking
To display data values stacked on top of each other in a line, area, or bar chart, select Normal to stack by the data values or Percent to stack by percentages.
Axis Labels
Select a value from the drop-down list to specify whether to show or hide axis labels.
Invert Axes
Select either True or False from the drop-down list to specify whether or not to invert the axes.
Data Labels
Select a value from the drop-down list to specify whether to show or hide the data labels.
Data Labels Rotation
Select a value from the drop-down list to specify the data label rotation angle: None, 45°, 90°, or -90°.
Edit the Visualization Name
To edit the visualization name, do one of the following:
-
Click Visualization > > Edit from the context menu.
-
Click Edit Visualization Name and in the Formatting tab, select Visualization from the drop-down list to edit fields.
Customize Report Summary
You can customize a report summary at both the table level and top-level row segment group when creating or editing a visualization. The Customize option is available for visualizations that have only profile variables set as column segments. For more information about row and column segments, see Create a Visualization.
You can define following summary formulas for each of the columns in a report in the Customize Report Summary dialog box.
Formula |
Calculation |
---|---|
NONE |
No formulas are defined for the column summary. If you select NONE for all the columns in a visualization, you cannot see the table level or group level summary. |
AVG |
The average of the values in the column. |
COUNT |
The count of records in the column with values other than null. |
MIN |
The smallest value in the column. |
MAX |
The largest value in the column. |
SUM |
The sum total of all the values in the column. |
You can also select the predefined formula to calculate only the table level summary for the column that has a formula field. |
-
You can view the customized report summary on the Analyzer UI and exported reports in the MS Excel format. The customized report summary is not shown on Exported reports in the CSV format.
-
You can see the defined formula for a column summary by hovering the mouse over the Summary cells of the column on the Analyzer UI.
-
You can see the defined formula for a column summary in the Summary cells of the column on the exported MS Excel reports. Summary cells contain the <Summary Value>(<Summary formula>) text format.
-
You can customize only the table level summary for the value-based reports. If a column in a value-based report has the String type field, you can define the summary formula for the column as NONE or COUNT. If the column has Integer (Measures) type field, you can define formulas as shown in the table.
Table Level Summary
This is the footer summary of the report. You can show the summary by selecting the Table level checkbox in the Show Summary drop-down list. By default, this checkbox is selected when you create a new visualization.
For the segmented reports, when you select the Table level checkbox but do not define the summary formulas, by default the aggregation type of a column field is set as the summary formula for that column except for the following scenarios:
-
If a column has the formula field, by default the table level summary formula for the column is defined as CUSTOM.
-
If a column has the duration field, by default the table level summary formula for the column is defined as NONE.
-
If a column has a field of the COUNT aggregation type, by default the table level summary formula for the column is defined as SUM, which is the sum of all individual counts.
For the value based reports, when you select the Table level checkbox but do not define the summary formulas, by default the table level summary formula is set as NONE.
Group Level Summary
This is the column summary that is defined at the top-level row segment group. The group level summary option is available for visualizations that have minimum two row segments.You can show the group level summary by selecting the checkbox that shows the name of the top-level row segment in the Show Summary drop-down list. By default, this checkbox is cleared when you create a new visualization.
When you select the group level summary checkbox but do not define the summary formulas, by default the group level summary formula is defined as NONE for all columns.
Group level summary is not applicable for the value based reports.
Report Summary in Agent Details Reports
You can see the table level and group level summary in the Agent Details reports. Both table and group level summary formulas are defined based on the column aggregation type except for the following scenarios:
-
If a column has the formula field, by default the table level summary formula for the column is defined as CUSTOM and the group level summary formula is defined as NONE.
-
If a column has the duration field, by default the table level summary and group level summary formulas for the column are defined as NONE.
-
If a column has a field of the COUNT aggregation type, by default the table level summary and group level summary formulas for the column are defined as SUM, which is the sum of all individual counts.
Export Report Templates
You can export report templates as a single file or as folders containing multiple files. The file or folders are exported from the Analyzer to your computer. Exporting report templates helps in reusability across multiple tenants.
Export a File
To export a template file from the Analyzer server:
-
On the Home page, click the Visualization icon.
-
Select the template file that you want to export.
-
Click the ellipsis button.
-
Select Export Template from the drop-down list. If the file is exported successfully, the following message is displayed:
The report template was succesfully exported and placed in the Downloads folder.
You cannot export a report that has a long duration and less interval. Reset the Duration and Interval fields as required for real-time and historical reports to proceed further. For more information, see Create a Visualization.
The file is saved in the
.JSON
format. -
Click Close.
Export a Folder
To export a folder from the Analyzer server:
-
On the Home page, click the Visualization icon.
-
Select the folder that you want to export.
-
Click the ellipsis button.
-
Click Export Templates from the drop-down list.
-
You can export up to 25 templates at a time.
-
When you export a folder, subfolders are not exported. You must export the subfolders separately.
-
If filters are applied to the report templates, the associated values and variables are removed during export. However, filter names are retained.
-
-
Click Export. If the file is exported successfully, the following message is displayed:
All the report templates in the folder are saved successfully and placed in the Downloads folder as a .zip file.
Import Report Templates
You can import report templates as a single file or as a folder containing multiple files. The file or folder can be imported from your computer to Analyzer. The import feature is available only to administrators who log in to the Analyzer UI.
When you import a single template file, a corresponding visualization is created based on the template.
Import a File
To import a template file to Analyzer:
-
On the Home page, click the Visualization icon.
-
Click Import.
-
Click Browse to select the file (.CSV format) to be imported.
-
Click Import. If the file was imported successfully, the following message is displayed:
The file was imported successfully . -
Click Close.
Import a Folder
To import a template folder to Analyzer:
-
On the Home page, click the Visualization icon.
-
Click Import.
-
Click Browse to select the folder (.zip format) to be imported.
The total number of templates in the.zip
file cannot exceed 25. -
Click Import. If the folder was imported successfully, the following message is displayed:
The folder was imported successfully. -
Click Close.
Schedule reports during migration
With this feature, you can efficiently migrate from Webex Contact Center 1.0 to 2.0 without disrupting report scheduling. This feature ensures operational and business continuity for reporting during migration, providing access to reports for both older and newer versions. Throughout the migration process, the following scheduled jobs will remain unaffected:
- Schedules created in 1.0 will continue to run from the 1.0 application
- Schedules created in 2.0 will seamlessly run from the 2.0 application
Dashboard
Introduction
Dashboard is a combination of reports that is used to visualize on a single screen.
You can perform the following tasks in the Dashboard:
Run a Dashboard
To run a dashboard:
Ensure that the dashboards have at least one visualization. For more information, see Design Dashboards.
-
Click the Dashboard icon on the navigation bar.
-
To find a report, you may use either the Search function or the tree icon. When you click on the tree icon all files in that folder are displayed. Search displays all the matching reports from the subfolders as well. Click the button and select Run from the context menu.
When you click on a folder or a report, the exact location of the folder or the report is displayed on the breadcrumb.
-
To view the visualization, click launch.
Once it renders the visualization, click the Setting button to view the Profile Variables and Segments used in the visualization data.
The filtering capability is not available when you run compound reports in a dashboard.
View Stock Report Dashboard
Business Metrics
Abandoned Contacts
The Abandoned Contacts Dashboard displays the number of contacts that were Abandoned during a specific period. You can filter the data in the Dashboard according to Interval and Duration as mentioned here:
-
Interval—Shows intervals, such as 10 Minutes, 30 Minutes, Hourly, Daily, Weekly, and Monthly.
-
Duration—Shows durations, such as Today, Yesterday, This Week, Last Week, Last 7 days, This Month, Last Month, and This Year.
Parameter | Description |
---|---|
Total Abandoned Contacts | The total number of contacts that are Abandoned. The number of contacts Abandoned for different channels (Chat & Voice) is also displayed. Contacts can get abandoned in the following scenarios:
|
Leading Abandonment Reason |
The percentage of total contacts that got abandoned in Queue Waiting Time (QWT). For example, in a day total contacts are 1000 and in that 100 contacts were Abandoned, the QWT for these 100 contacts that were Abandoned can fall in the following categories:
For the above example, the Leading Abandonment Reason shows 65% (looking at maximum period calls that got abandoned) and QWT as more than 5 minutes. |
Call Back / Renewed Chat Rate |
Total percentage of customers who have contacted back either through voice calls or chat. |
Customer Journey | The Sankey diagram shows at which stage the contact was abandoned. This diagram shows a vertical bar for the different Entry Points, Queues, Wait Time, and Agents. The view depends on the selected Channel Type. Hovering over the stages shows more information, like the number of abandoned contacts and number of contacts that are handled by each agent. |
Contacts Trend | The Area chart shows the Trend of contacts that are handled and abandoned for each channel type for the selected duration. |
Abandoned Contacts By Stage |
The Donut diagram shows in which stage the contacts got abandoned. |
Abandoned Contact Details | The tabular view displays the details of each abandoned contact for the selected duration.
|
Historical Reports
These reports are not available for Cloud Connect users.
Agent Reports
Agent Performance Dashboard
This report shows Average Connected Duration and Maximum Connected Duration for Agents in their team.
Report Path: Dashboard > Stock Reports > Historical Reports > Agent Reports
Output Type: Bar Chart
You can filter using Deployment Name, Agent Name, Team Name, Interval (Daily by default), and Channel Type.
Contact Center Overview
Contact Handled Performance for Teams
This report shows Total Contacts Handled per channel type for each team in that deployment so you can compare teams.
Report Path: Dashboard > Stock Reports > Historical Reports > Contact Center Overview
Output Type: Line Chart
You can filter using Deployment Name, Interval (Daily by default), Team Name, and Channel Type.
Real-Time Reports
These dashboards are not available for Cloud Connect users.
To refer all the report details that are used in these dashboards, see the appropriate report in the View Stock Report Dashboard section.
Design Dashboards
1 |
Click Dashboard > Create New Dashboard. |
2 |
Drag and drop a visualization on to the canvas area. You can add as many visualizations as you want the dashboard to display. |
3 |
To reposition a visualization, drag it to a new position. To format a visualization, select the Formatting panel and then select visualization from the drop-down list to modify. |
4 |
To resize a visualization:
|
5 |
To remove a visualization from the dashboard, select X. |
6 |
To enter a name for your visualization, click Click to add title. To edit the title, enter a new title and click checkmark symbol. |
7 |
To format the visualization title, select Formatting and choose the title from the drop-down list in the tab to display the format options you can customize, such as border style, text alignment, and font size, color, and weight. |
8 |
To save the dashboard, click Save, and select a folder. To create a new folder, click the New Folder, enter a name for the folder. Enter a name for the dashboard and then click OK |
9 |
You can preview the dashboard, click Preview. |
10 |
To edit the dashboard name, click the Edit Dashboard Name to select the existing text; then enter a new name and click the Apply button. |
Variables
Introduction
Variables are used in report filters while generating reports. You can create a Variable by defining a set of values. A Variable once created can be reused as a filter for a specific field and the related Record Type.
Create, Edit, View, and Delete Variables
To create a new variable:
1 |
Click Variables > New. |
2 |
Enter a name for the variable. |
3 |
Select a value from the Associated Column drop-down list. |
4 |
Define Values and add a Description. |
5 |
Define the Scope of the variable. The scope can be:
|
6 |
Click Save. Click the to view, edit, copy, or delete the variable. |
Appendix
Type of Records Available in Each Repository
The following table describes the type of records aggregated in each customer and agent activity and session repository.
Record Type |
Description |
Examples |
---|---|---|
Customer Activity Record |
Represents an atomic step in the customer workflow |
|
Customer Session Record |
Represents the customer workflow, consisting of a sequence of customer activities |
|
Agent Activity Record |
Represents an atomic step in the agent workflow |
|
Agent Session Record |
Represents the agent workflow, consisting of a sequence of agent activities |
|
When an agent uses consult operations (consult to DN, agent, or queue), once the consulted party answers, the agent completes the call transfer and wraps up. The customer and consulted party then continue the call, and the Customer Session Record (CSR) continues updating until either the customer or consulted party disconnects.
The following sections provide more detail about record contents:
Standard CSR and CAR Fields and Measures
Customer Session Repository (CSR)
The standard fields and measures aggregated in the CSR are described in the following sections:
Column Name | Description | Field or Measure | Data Type |
---|---|---|---|
Abandoned SL Count |
Number of calls that got terminated while in queue within the Service Level threshold provisioned for the queue or skill. |
Measure | Integer |
Abandoned Type |
The Abandoned Type is set when the call is abandoned. The following values show the states of the call when abandoned.
Checks the previous event before the ended event and sets the value accordingly. For instance, if the previous event before the ended event is parked, the Abandoned Type is set to 'queue'. |
Field | Integer |
Abandonment Reason | Reason for the call abandonment. The abandonment reason can be
one of the following:
|
Field |
String |
Activity Span | The amount of time, in milliseconds, that a customer was engaged in the session. | Measure |
Long |
Agent Endpoint (DN) | The endpoint (number, email, or chat handle) on which an agent receives calls, chats, or emails. | Field |
String |
Agent Hangup Count | Number of times an agent hung up a call. | Measure |
Integer |
Agent ID | A string that identifies an agent. | Field |
String |
Agent Leg Blob ID | String identifier for the blob that contains the recording of the agent's side of the call. | Field |
String |
Agent Login | Login name using which an agent signs in to the Agent Desktop. | Field |
String |
Agent Name | The name of the agent who answers customer calls, chats, and emails. | Field |
String |
Agent Session ID | A string that identifies an agent’s login session. | Field |
String |
Agent System ID | A string that identifies an agent. | Field |
String |
Agent To Agent Transfer Count | The number of times an agent transferred inbound contacts to another agent after consult. | Measure |
Integer |
Agent To Entrypoint Transfer Count | Number of times a call was transferred from an agent to an EP. | Measure |
Integer |
Agent To Queue Transfer Count | Number of times a call was transferred from an agent to a queue. | Measure |
Integer |
Agent Transfered In Count | Number of times a call was transferred to an agent. | Measure |
Integer |
Automatic Number Identification (ANI) |
ANI digits delivered with a call. ANI is a service provided by the phone company that delivers the caller’s phone number along with the call. |
Field |
String |
BargedIn Count | Barged in count. The count is incremented across callLeg for Barged In event until barge-ended event is received. | Measure |
Integer |
BargedIn Duration | Duration (in milli-seconds) between barged-started and ended events. | Measure |
Long |
BargedIn Failed Count | Count of barged-failed events. | Measure |
Integer |
Blind Transfer Count |
The number of times a call was transferred by an agent to another agent or an external DN (Dial Number) via a blind transfer. |
Measure |
Integer |
Bot Name | Name of the bot. | Field |
String |
Callback Agent Name | Name of the agent making the callback. |
Field |
String |
Callback Connected Time |
Time at which the callback was connected between the agent and the customer. |
Measure |
Long |
Callback Number |
Number based on the ANI or the number that was configured in the workflow. |
Field |
String |
Callback Queue Name | Name of the queue used for callback. |
Field |
String |
Callback Request Time |
Time at which the customer opted for the callback. |
Measure |
Long |
Callback Team Name | Name of the team to which the agent who does the callback, belongs to. |
Field |
String |
Call Completed Count | Number of calls that were completed. |
Measure |
Integer |
Call Direction | Indicates whether the call is an inbound call or an outbound call. |
Field |
String |
Caller Leg Blob ID | String identifier for the blob that contains the recording of the caller side of the call. | Field |
String |
Call Escalated to Queue | Indicates whether the call was escalated to queue. |
Measure |
Integer |
Call Paused Count | Number of times a call was in paused state. |
Measure |
Integer |
Call Progress Detection | Represents the call progress detection (CPD) value returned from telephony for outdial call. | Field |
String |
Call Resumed Count | Number of times a call was resumed. |
Measure |
Integer |
Campaign Id | ID of the campaign. |
Measure |
Integer |
Campaign Name |
Name of the campaign created. |
Measure |
String |
Campaign Status |
Status of the campaign call—either success or failure. |
Measure |
String |
Chained In To Entrypoint Count | Calls transferred from one EP to another. | Measure |
Integer |
Chained In To Queue Count | Calls moved from EP to Queue. | Measure |
Integer |
Channel ID | ID assigned to the media channel to which the agent is logged in. | Field |
String |
Channel Type | Number of media channels to which agents are currently logged in. | Field |
String |
Chat Exit Reason | Reason to leave the customer chat. | Measure |
String |
Chat Note | Summarizes the customer conversation with an agent. | Field |
String |
Chat Priority | Priority for chat. | Field |
String |
Chat Reason | Reason why the customer is in chat with the support team. | Field |
String |
Conference Count | Number of times an agent established a conference call with the caller and another agent. | Measure |
Integer |
Conference Duration | The amount of time an agent spent in conference with a caller and another agent. | Measure |
Integer |
Connected Count | Number of times the contact was in connected state (that is, talking). | Measure |
Integer |
Connected Duration | Duration of connected (talking) state within this interaction. | Measure |
Long |
Consult Count | Number of times an agent initiated a consult call with another agent or someone at an external number while handling a call. | Measure |
Integer |
Consult Duration | The amount of time an agent spent consulting with another agent while handling a call. | Measure |
Integer |
Consult Ep Count |
Number of calls that went for consult to EP. |
Measure |
Integer |
Consult Ep Duration | Duration in milli-seconds, for consult to EP. | Measure |
Long |
Contact Count | Number of contacts. | Measure |
Integer |
Contact End Timestamp | Time when the contact ended. | Measure |
Long |
Contact Reason | Reason why the customer is contacting the call center. | Field |
String |
Contact Session ID | A unique string that identifies the contact session. | Field |
String |
Contact Start Timestamp | Time when the contact started. | Measure |
Long |
CSAT Score | Customer satisfaction score. | Measure |
Integer |
CTQ Count | Number of consult-to-queue within an interaction. | Measure |
Integer |
CTQ Duration | Total duration spent on consult-to queue within an interaction. | Measure |
Integer |
Current State | Current state of the contact. | Field |
String |
Customer Email Address | Email address of the customer. | Field |
String |
Customer Name | Name of the customer. | Field |
String |
Customer Phone Number | Phone number of the customer. | Field |
String |
Dialed Number Identification Service (DNIS) |
DNIS digits delivered with the call. DNIS is a service provided by the phone company to deliver a digit string indicating the number that the caller dialed from, along with the call. |
Field |
String |
Email BCC List | List of BCC for the email. | Field |
String |
Email Body | Body of the email. | Field |
String |
Email CC List | List of CC for the email. | Field |
String |
Email Content | Content of the email. | Field |
String |
Email Content Type | Content type of the email. | Field |
String |
Email Date | Date on which the email was received. | Field |
String |
Email Disposition | Indicates that the email message doesn't require retention or are kept as long as needed by the agent, but can be deleted any time. | Field |
String |
Email Full Message | Full message of the email. | Field |
String |
Email Message Deleted | Email message that was deleted. | Field |
String |
Email Message Id | A unique string that identifies the email message. | Field |
String |
Email Meta Data | Additional information attached to an email message that contains details about the message and its transmission. | Field |
String |
Email Ref | Reference of the email. | Field |
String |
Email Reply Body | Body of the reply to the email. | Field |
String |
Email Reply Content | Content type of the reply to an email. | Field |
String |
Email Reply To | Reply to the sender of the email. | Field |
String |
Email Sent Flag | Flag that indicates whether email was sent. | Field |
String |
Email Subject | Subject of the email. | Field |
String |
Email To List | List of recipients of the email. | Field |
String |
Entrypoint (EP) ID | ID assigned to an entry point. | Field |
String |
Entrypoint Name | Name of the EP, which is the landing place for customer calls on the Webex Contact Center system. One or more toll-free or dial numbers can be associated with a given EP. IVR call treatment is performed while a call is in the EP. Calls are moved from the EP into a queue and are then distributed to agents. | Field |
String |
Entrypoint System ID | ID assigned to an EP. | Field |
String |
Entrypoint To Entrypoint Transfer Count | Number of times a call was transferred from an EP to another EP. | Measure |
Integer |
External ID | This is a reference to the call in an external system. | Field |
String |
Failed Callback Retry Count | The number of times a callback retry failed. | Measure |
Integer |
Feedback Comment | Customer feedback. | Field |
String |
Feedback Survey OptIn | Indicates whether the customer has opted for feedback. | Field |
String |
Feedback Type | The type of survey that the customers have opted for (Inline survey or Deferred survey). | Field |
String |
Final Queue ID | ID of the the queue to which the call was queued to in the Webex Contact Center system. | Field |
String |
Final Queue Name | Name of the the queue to which the call was queued to in the Webex Contact Center system. | Field |
String |
Final Queue System ID | ID of the queue in which the task is lined up. | Field |
String |
First Queue ID | ID of the first queue in which the task is lined up. | Field |
String |
First Queue Name | Name of the the first queue parked in the Webex Contact Center system. | Field |
String |
First Queue System ID | ID of the first queue in which the task is lined up. | Field |
String |
Full Monitoring Count | Number of calls that were completely monitored. | Measure |
Integer |
Global_FeedbackSurveyOptIn | Indicates whether the customer has opted to participate in (opt-in) or not participate in (opt-out) a post call survey. | Field |
String |
Global_Language | Indicates the language that a customer uses in the flow. The default value is en-US. |
Field |
String |
Global_VoiceName | Indicates the output-recorded name used in the flow. The default value is Automatic. When the
value is Automatic, dialogflow chooses the voice name for a
given language. |
Field |
String |
Handle Type | Shows how the call was handled: short, abandoned, or normal. | Field |
String |
Has Callback | Indicates whether the customer has requested for a call back. | Measure |
Integer |
Hold Count | Number of times an agent put an inbound caller on hold. | Measure |
Integer |
Hold Duration | Total duration for which a call was on hold. | Measure |
Integer |
Inbound Transcript | Entire chat transcript or inbound email transcript. | Field |
String |
Is Barged |
Indicates whether the call was monitored. Supported values are 0 and 1. 1 indicates that the call was monitored. |
Field |
Integer |
Is Campaign | Indicates whether the call was a campaign call. | Measure |
Integer |
Is Coached | Indicates whether an agent is being coached. | Measure |
Integer |
Is Contact Handled | Flag that indicates whether the contact was handled by an
agent. Supported values are 0 and 1. |
Measure |
Integer |
Is Current Session | Flag that indicates whether the session is an active
session. Supported values are 0 and 1. The value 1 indicates that the session is active. |
Measure |
Integer |
Is Handled By Preferred Agent | Indicates whether the contact was handled by preferred agent. | Measure |
Integer |
Is Monitored | Flag indicates whether the call is being monitored. Supported values are 0 and 1. |
Measure |
Integer |
Is Offered | Indicates whether the call was offered to an agent. Supported values are 0 and 1. 1 indicates that the call was offered to an agent. | Measure |
Integer |
Is Outdial | Flag that indicates whether this was an outdial contact or
not. Supported values are 0 and 1. |
Measure |
Integer |
Is Recorded | Flag that indicates whether the contact was recorded. Supported values are 0 and 1. |
Field |
Integer |
Is Recording Deleted | Flag that indicates whether the recording has been deleted. | Measure |
Integer |
Is Within Service Level |
Flag that indicates whether the call is within the service level threshold. Supported values are 0 and 1. Service level threshold for each queue is configured when creating or editing a queue via the Provisioning module in the Management Portal, under the Advanced Settings section of the Queue window. The call is considered within the service level when the call is connected to an agent within the service level threshold specified for that queue. In this scenario, Is Within Service Level is set to 1. The call is considered within the service level when the call is connected to the agent directly (straight transfer) without being parked in a queue. In this scenario, Is Within Service Level is set to 1. The call is considered outside the service level if the queue (plus ringing) duration is greater than the service level threshold specified for that queue. In this scenario, Is Within Service Level is set to 0. The self-service call (a call that has not reached any queue) (with termination type = self_service or short) will also have Is within Service Level set to 0. Is Within Service Level is calculated on the last queue before the call is connected to an agent, abandoned, or sent to overflow. |
Measure |
Integer |
IVR Count | Number of times the contact was in IVR state. | Measure |
Integer |
IVR Duration | The amount of time, in minutes, during which a call was in IVR state. | Measure |
Integer |
IVR Ended Count | Number of times the contact was ended in IVR state. | Measure |
Integer |
IVR Script ID | A string that identifies IVR. |
Field |
String |
IVR Script Name | The name of the flow in the Call Control section of the routing strategy configuration. |
Field |
String |
IVR Script Tag ID | A string that identifies the IVR's flow tag. |
Field |
String |
IVR Script Tag Name |
The name of the flow tag in the Call Control section of the routing strategy configuration. |
Field |
String |
IVR Summary |
Summary of the number of contacts in the IVR. |
Field |
String |
Last Callback Status |
Status of the callback—either success or not processed. |
Field |
String |
LCM Contact | List and Campaign Manager (LCM) contact details. | Field |
String |
Midcall Monitoring Count | Number of calls for which monitoring started midcall. | Measure |
Integer |
Monitor End TimeStamp |
Timestamp at which the supervisor ended the monitoring. |
Measure |
Long |
Monitor Full Name |
Name of the supervisor who is monitoring the call. |
Field |
String |
Monitoring Duration |
Duration in milli-seconds for which a call is monitored. |
Measure |
Long |
Monitoring Error Count |
Count of monitoring-error events. |
Measure |
Integer |
Monitoring Hold Count |
Count is incremented in case of a monitoring-hold event. This count is incremented across callLeg until monitoring-unhold event is received. |
Measure |
Integer |
Monitoring Hold Duration |
Duration in milli-seconds for which a call is on hold during monitoring. |
Measure |
Long |
Monitoring URI |
URI of the supervisor |
Field |
String |
Monitor Status |
Indicates if call is being monitored. The status of the monitoring session could be one of the following:
|
Field |
String |
Monitor TimeStamp |
Timestamp at which the supervisor started the monitoring. |
Measure |
Long |
Monitor Type |
Type of monitoring. |
Field |
String |
Monitor User Id |
ID of the supervisor who monitors the call. |
Field |
String |
Monitor User System Id |
ID of the supervisor who monitors the call. |
Field |
String |
Monitor Visibility |
Indicates whether the monitoring session is being displayed on the Management Portal for other users. To prevent the monitoring session from being displayed on the Management Portal for other users, check the Use Invisible Mode check box. |
Measure |
Integer |
Name of Activity |
Shows the name of the activity such as CVA, Play Prompt, Menu, and Queue. |
Field |
String |
Number of Opt-outs |
The number of customer contacts that opted out of a particular queue on the given date. |
Measure |
Integer |
Outbound Transcript | Outbound email transcript. | Field |
String |
Outbound Type |
Indicates whether the call is an inbound call or an outbound call. |
Field |
String |
Outdial Consult Count |
Number of times the call had any kind of consult within an outdial interaction. |
Measure |
Integer |
Outdial Consult Ep Count |
Number of times the call had a consult to Entry Point within an outdial interaction. |
Measure |
Integer |
Outdial Consult Ep Duration |
Duration in milli-seconds for consult to EP-DN in case of outdial call. |
Measure |
Long |
Outdial CTQ Count |
Number of times the call had a consult-to-queue within an outdial interaction. |
Measure |
Integer |
Overflow Count |
Count of calls overflown in queue. |
Measure |
Integer |
Paused Duration |
The amount of time in milli-seconds during which a call was in pause state. |
Measure |
Integer |
Preferred Agent Name |
Name of the preferred agent who made the callback to the contact in queue. |
Field |
String |
Preferred Agent System Id |
A string that identifies preferred agent. |
Field |
String |
Previous Agent ID | A string that identifies an agent. | Field |
String |
Previous Agent Name | Name of an agent, that is, a person who answers customer calls. | Field |
String |
Previous Agent Session ID |
A string that identifies an agent’s login session. |
Field |
String |
Previous Queue ID | ID of the queue associated with the interactions. | Field |
String |
Previous Queue Name | Name of the queue associated with the interactions. | Field |
String |
Questions Answered |
Number of questions answered as part of IVR post call survey. |
Measure |
Integer |
Questions Presented |
Total number of questions posted to the customer as a part of IVR post call survey. |
Measure |
Integer |
Queue Count | Number of queues that the contact entered in its entirety. | Measure |
Integer |
Queue Duration | The amount of time, in seconds, that a contact spent in queue waiting. | Measure |
Integer |
Queue To Entrypoint Transfer Count | Number of times a call was transferred from a queue to an EP. | Measure |
Integer |
Queue To Queue Transfer Count | Number of times a call was transferred from a queue to another queue. | Measure |
Integer |
Realtime Update Timestamp | The time when the realtime process updated the record. | Measure |
Long |
Reason |
Reason for ending the call. The reason can be one of the
following:
|
Field |
String |
Recording Count |
The number of times a call was recorded. |
Measure |
Integer |
Recording Deleted Timestamp | Time when the recording was deleted. | Measure |
Long |
Recording Error Count |
Count of recording error events. |
Measure |
Integer |
Recording File ID | Unique ID of the recording file. | Field |
String |
Recording File Size | Represents the size of the recorded file. | Measure |
Long |
Recording Location |
Location of the conversation record file. |
Field |
String |
Routing Type |
The routing type used to route the contacts to the agent.The routing type can be skillBased or Longest Available. |
Field |
String |
Sequence of Activity |
A string with the sequence of flow activities the interaction went through separated by comma. |
Field |
String |
Short in IVR Count |
Indicates if a call was terminated as short while in IVR state. A call is considered short if terminated within the configured Short Call Threshold, calculated from the start of the call. |
Measure |
Integer |
Short In Queue Count |
Indicates if a call was terminated as short while in parked state. A call is considered short if terminated within the configured Short Call Threshold, calculated from the start of the call. |
Measure |
Integer |
Silent Monitoring Count | Number of times a contact was silently monitored. | Measure |
Integer |
Site ID | ID assigned to a call center location. The field displays N/A until the call is connected to an agent. |
Field |
String |
Site Name | Call center location to which a call was distributed. The field displays N/A until the call is connected to an agent. |
Field |
String |
Site System ID |
The ID assigned to a call center location. The field displays N/A until the call is connected to an agent. |
Field |
String |
Source of Callback |
The source of the callback. The source of a callback can be web, chat, or IVR. |
Field |
String |
Stereo Blob ID | String identifier for the blob that contains recording of the call in stereo. | Field |
String |
Sub Channel Type |
The Social Channels (Facebook and SMS) are displayed with statistics. |
Field |
String |
Sudden Disconnect Count |
Indicates if the call was terminated with a sudden disconnect. A call is considered suddenly disconnected if it is terminated within the configured sudden disconnect threshold after connecting to an agent (timer starts on agent connect) |
Measure |
Integer |
Survey Completed |
Indicates if the survey was completed during the interaction. |
Measure |
Integer |
Team ID | ID assigned to a team. The field displays N/A until the call is connected to an agent. |
Field |
String |
Team Name | A group of agents at a specific site who handle a particular type of call. | Field |
String |
Team System ID | The ID of the team that the agent handled the contact belongs
to. The field displays N/A until the call is connected to an agent. |
Field |
String |
TenantId |
Id assigned to the tenant. |
Field |
String |
Terminated By | Indicates the party that terminated the interaction. The
terminating end can be one of the following:
|
Field |
String |
Termination Type | A text string specifying how a call was terminated. | Field |
String |
Total Monitoring Count | Number of times a contact was monitored. | Measure |
Integer |
Total Outdial CTQ Time |
Total duration spent on consult-to queue within an outdial interaction. |
Measure |
Long |
Total Ringing Duration |
The amount of time in milli-seconds spent by the agent in the ringing state, during the session. |
Measure |
Long |
Transcription Available |
Indicates whether transcription available(true) or not available(null). |
Measure |
Integer |
Transcript Requested |
Flag that indicates whether the customer has requested the chat transcript. Supported values are 0 and 1. The value 1 indicates that the customer has requested the chat transcript |
Field |
String |
Transfer Count | The number of times a call was transferred by an agent. | Measure |
Integer |
Transfer Error Count |
Count of transfer error failures. |
Measure |
Integer |
Transfer In To Entrypoint Count | Count of calls transferred by agents to EP. | Measure |
Integer |
Type of Callback |
The type of the callback. The callback type can be either Courtesy or Web UI . |
Field |
String |
Whisper Coach Count |
Indicates the number of times whisper coaching is initiated during a call. |
Measure |
Integer |
Whisper Coach Duration |
Duration in milli-seconds, between coach-started and ended. |
Measure |
Long |
Whisper Coach Failed Count |
Count of CoachFailed events. |
Measure |
Integer |
Wrapup Code Name | Wrapup code that the agent gave for the interaction. | Field |
String |
Wrapup Code System ID | A string that identifies a Wrapup code. | Field |
String |
Wrapup Duration | Total time the agents spent in the Wrapup state after handling interactions. | Measure |
Integer |
Customer Activity Repository (CAR)
The standard fields and measures aggregated in the CAR are described in the following sections:
Column Name | Description | Field or Measure |
Data Type |
---|---|---|---|
Activity Count |
The count of the activity (CAR) record. Note: The value of this field is always set to 1. |
Measure |
Integer |
Activity Duration |
The amount of time between the start of an activity and the end of the activity. Note: This value is not populated in real-time, it is recorded after the completion of the activity. |
Measure |
Integer |
Activity End Timestamp | The timestamp when the activity was terminated. | Measure |
Long |
Activity Name |
Name of the activity executed in the flow. For example, QueueContact_5g0 . |
Field |
String |
Activity Span | The amount of time, in seconds, that an agent was engaged in the activity during the specified interval. | Measure |
Long |
Activity Start Timestamp | The timestamp when the activity started. | Measure |
Long |
Activity State | Represents state of an activity. | Field |
String |
Activity Type |
Type of the activity executed in the flow. For example, queue-contact. |
Field |
String |
Agent Endpoint (DN) | The endpoint (number, email, or chat handle) on which an agent receives calls, chats, or emails. | Field |
String |
Agent ID | A string that identifies an agent. | Field |
String |
Agent Login | Login name with which an agent logs in to Agent Desktop. | Field |
String |
Agent Name | The name of an agent, that is, a person who answers customer calls, chats, and emails. | Field |
String |
Agent Session ID | A string that uniquely identifies an agent’s login session. | Field |
String |
Agent System ID | A string that identifies an agent. | Field |
String |
ANI |
ANI digits delivered with a call. Automatic Number Identification (ANI) is a service provided by the phone company that delivers the caller’s phone number along with the call. |
Field |
String |
Call Paused Count |
Number of times a call was in the Paused state. |
Measure |
Integer |
Call Resumed Count |
Number of times a call was resumed. |
Measure |
Integer |
Callback Request Time |
The time at which the customer opted for the callback. |
Measure |
Long |
Channel ID |
The Channel ID of the agent associated with the contact. |
Field |
String |
Channel Type | The type of media assigned to a media channel. | Field |
String |
Child Contact Id |
The ID of the call in the case of consult to EP-DN. |
Field |
String |
Child Contact Type |
The type of the call in the case of consult to EP-DN. |
Field |
String |
Consult EntryPoint Id |
Entry point ID in the event of consult to EP-DN. |
Field |
String |
Consult EntryPoint Name |
Name of the entry point in the event of consult to EP-DN. |
Field |
String |
Consult EntryPoint System Id |
Entry point System ID in the event of consult to EP-DN. |
Field |
String |
Contact Session ID | A unique string that identifies the contact session. | Field |
String |
Customer Email Address | The email address of the customer. | Field |
String |
Customer Name | The name of the customer. | Field |
String |
Destination Queue Id |
Queue ID to which the call was transferred. |
Field |
String |
Destination System Id |
Queue System ID to which the call was transferred. |
Field |
String |
DNIS |
DNIS digits delivered with the call. Dialed Number Identification Service (DNIS) is a service provided by the phone company to deliver a digit string indicating the number that the caller dialed from, along with the call. |
Field |
String |
Email BCC List |
List of BCC for the email. |
Field |
String |
Email Body |
Body of the email. |
Field |
String |
Email CC List |
List of CC for the email. |
Field |
String |
Email Content |
Content of the email. |
Field |
String |
Email Content Type |
Content type of the email. |
Field |
String |
Email Date |
Date on which the email was received. |
Field |
String |
Email Disposition |
Indicates that the email message doesn't require retention or are kept as long as needed by the user, but can be deleted any time. |
Field |
String |
Email Full Message |
Full message of the email. |
Field |
String |
Email In Reply To |
Reply to the sender of the email. |
Field |
String |
Email Message Deleted |
Email message that was deleted. |
Field |
String |
Email Message Id |
A unique string that identifies email message. |
Field |
String |
Email Meta Data |
Additional information attached to an email message that contains details about the message and its transmission. |
Field |
String |
Email Ref |
Reference of the email. |
Field |
String |
Email Reply Body |
Body of the reply to an email. |
Field |
String |
Email Reply Content |
Content type of the reply to an email. |
Field |
String |
Email Reply To |
Reply to the sender of the email. |
Field |
String |
Email Sent Flag |
Flag that indicates whether email was sent. |
Field |
String |
Email Subject |
Subject of the email. |
Field |
String |
Email To List |
List of recipients of the email. |
Field |
String |
Entrypoint ID | The ID assigned to an entry point (EP). | Field |
String |
Entrypoint Name | The name of the EP, which is the landing place for customer calls on the Webex Contact Center system. One or more toll-free or dial numbers can be associated with a given EP. IVR call treatment is performed while a call is in the EP. Calls are moved from the EP into a queue and are then distributed to agents. | Field |
String |
Entrypoint System ID | The ID assigned to an EP. | Field |
String |
Failed Callback Retry Count |
The number of times a callback retry failed. |
Field |
String |
Is Current Activity | Flag that indicates whether the activity is a current activity, and that activity hasn't ended. Supported values are 0 and 1. |
Measure |
Integer |
Is Outdial | Flag that indicates whether this activity occurred while making an outdial call. Supported values are 0 and 1. |
Measure |
Integer |
IVR Script ID |
A string that identifies an IVR. |
Field |
String |
IVR Script Name | The name of the flow in the Call Control section of the routing strategy configuration. | Field |
String |
IVR Script Tag ID |
A string that identifies an IVR's tag. |
Field |
String |
IVR Script Tag Name |
The name of the flow tag in the Call Control section of the routing strategy configuration. |
Field |
String |
Next State | If this isn’t a current activity, this field shows the state of the following activity. | Field |
String |
Paused Duration |
The amount of time in mill-seconds, during which a call was in pause state. |
Measure |
Integer |
Preferred Agent Name |
Name of the preferred agent. |
Field |
String |
Preferred Agent System Id |
A string that identifies preferred agent. |
Field |
String |
Previous Agent ID |
A string that identifies an agent. |
Field |
String |
Previous Agent Name |
The name of an agent who answers customer calls. |
Field |
String |
Previous Agent Session ID |
A string that identifies an agent session. |
Field |
String |
Previous Channel ID |
ID of the previous channel. |
Field |
String |
Previous Queue ID |
ID of the previous queue. |
Field |
String |
Previous Queue Name |
Name of the previous queue. |
Field |
String |
Previous State | This field shows the state of the previous activity. | Field |
String |
Queue ID | The ID assigned to a queue. The field displays N/A until the call is connected to an agent. |
Field |
String |
Queue Name | The name of a queue, which is the holding place for calls while they await handling by an agent. Calls are moved from an EP into a queue and are then distributed to agents. | Field |
String |
Queue System ID |
The ID assigned to a queue The value of the field displays as N/A until the call is connected to an agent. |
Field |
String |
Realtime Update Timestamp | The time when the realtime process updated the record. | Measure |
Long |
Record Unique ID | Unique string that identifies this activity record. | Field |
String |
Routing Type |
The routing type used to route the contacts to the agent.The routing type can be skillBased or Longest Available. |
Field |
String |
Second Agent Endpoint (DN) | This field is the endpoint of the second agent, for instance in case of transfers. | Field |
String |
Second Agent ID | This field is the ID of the second agent, for instance in case of transfers. | Field |
String |
Second Agent Name | This field is the name of the second agent, for instance in case of transfers. | Field |
String |
Second Agent Session ID | This is the agent session ID of the second agent, for instance in case of transfers. | Field |
String |
Second Channel ID | This field is the channel ID of the second agent, for instance in case of transfers. | Field |
String |
Second Team ID | This field shows the name of the second team. | Field |
String |
Second Team Name | This field shows the ID of the second team. | Field |
String |
Site ID | The ID assigned to a call center location. The field displays N/A until the call is connected to an agent. |
Field |
String |
Site Name | The call center location to which a call was distributed. The field displays N/A until the call is connected to an agent. |
Field |
String |
Site System ID |
The ID assigned to a call center location. The value of the field displays as N/A until the call is connected to an agent. |
Field |
String |
Source of Callback |
The source of the callback. The source of a callback can be web, chat, or IVR. |
Field |
String |
Sub Channel Type |
The Social Channels (Facebook and SMS) are displayed with statistics. |
Field |
String |
Team ID | The ID assigned to a team. The field displays N/A until the call is connected to an agent. |
Field |
String |
Team Name | A group of agents at a specific site who handle a particular type of call. | Field |
String |
Team System ID |
The ID assigned to a team. The value of the field displays as N/A until the call is connected to an agent. |
Field |
String |
tenantId |
ID assigned to the tenant. |
Field |
String |
Termination Reason |
The reason for ending the contact. The reason can be one of the following:
|
Field |
String |
Transferred to Queue |
The queue name to which the call was trasferred. |
Field |
String |
Transfer Type |
The type of transfer such as Blind Transfer and Consult Transfer. |
Field |
String |
Type of Callback |
The type of the callback. The callback type can be Courtesy or Web UI. |
Field |
String |
Wrapup Code Name | The Wrapup code that the agent gave for the interaction. | Field |
String |
Wrapup Code System ID | A string that identifies a Wrapup code. | Field |
String |
Standard ASR and AAR fields and measures
Agent Session Repository (ASR)
The standard fields aggregated in the ASR are described in the following table:
The Disconnected Count field is currently not used and not populated in the ASR.
Column Name |
Description |
Field or Measure |
Data Type |
---|---|---|---|
Activity Span |
The amount of time in seconds that an agent was engaged in the activity during the specified interval. | Measure | Long |
Agent Channel ID |
The ID assigned to the media channel to which the agent is logged in. | Field | String |
Agent Endpoint (DN) |
The endpoint (number, email, or chat handle) on which an agent receives calls, chats, or emails. | Field | String |
Agent ID | A string that identifies an agent. | Field | String |
Agent Login | The login name using which an agent logs in to the Agent Desktop. | Field | String |
Agent Name | Name of an agent, that is, a person who answers customer calls or chats or emails. | Field | String |
Agent Session ID | A string that identifies an agent’s login session. | Field | String |
Agent Skills | The skill of an agent, such as language fluency or product expertise. The column shows multiple skills mapped to the corresponding skill profile, in the format:skill_name1=skill_value1,skill_name2=skill_value2 | Field | Object |
Agent System ID | A string that identifies an agent. | Field | String |
Agent To Agent Transfer Count | The number of times an agent transferred inbound contacts to another agent after consult. | Measure | Integer |
Agent Transfer To Queue Request Count | The number of times an agent requested transfer to queue (inbound only). | Measure | Integer |
Available Count | The number of times an agent went into the Available state. | Measure | Integer |
BlindTransfer Count | The number of times an agent transferred without consulting first. | Measure | Integer |
Call Back Count | The count of callbacks done. | Measure | Integer |
Channel ID | The channel ID of the channel type such as telephony, email, or chat. | Field | String |
Channel Type | The media type of the contact, such as telephony, email, or chat. | Field | String |
Conference Count | The number of times an agent established a conference call with the caller and another agent (inbound only). | Measure | Integer |
Connected Count | The number of times an agent was in a Connected state, that is, talking to the customer, during this session (inbound only). | Measure | Integer |
Consult Answer Count | The number of times an agent answered a consult request (inbound calls). | Measure | Integer |
Consult Answer Duration | The amount of time an agent spent answering consult requests (for inbound calls). | Measure | Long |
Consult Count | The number of times an agent consulted with another agent (inbound only). | Measure | Integer |
Consult Request Count | The number of times an agent initiated a consult request (inbound calls). | Measure | Integer |
Consult To EntryPoint Answered Count | The count of the number of calls answered to EP-DN for a call-leg. | Measure | Integer |
Consult To EntryPoint Answered Duration | The answered duration of consult to EP-DN for a call-leg. | Measure | Long |
Consult To EntryPoint Requested Count | The number of times consult was requested to EP-DN Field for a call-leg. | Measure | Integer |
Consult To EntryPoint Requested Duration | The request duration of consult to EP-DN for a call-leg. | Measure | Long |
CTQ Answer Count | The number of times an agent answered a consult-to-queue request (inbound calls). | Measure | Integer |
CTQ Count | The number of consult-to-queue in a session. | Measure | Integer |
CTQ Request Count | The number of times an agent initiated a consult-to-queue request (inbound). | Measure | Integer |
Current State | The current state of an agent. | Field | String |
Disconnected Count | The number of calls that were answered (that is, connected toan agent or distributed to and accepted by a destination site), but that were then immediately disconnected within the Sudden Disconnect threshold provisioned for the enterprise. | Measure | Integer |
Disconnected Hold Calls Count | The number of calls that got disconnected while on hold during an agent session. | Measure | Integer |
Email Handled Count | The number of emails handled through the channel type as email. | Measure | Integer |
Email Wrapup Count | The number of times an agent was in email wrap-up state. | Measure | Integer |
Historical Update Timestamp | The time when the historical process updated the record. | Measure | Long |
Hold Count | The number of times calls were put on hold (inbound). | Measure | Integer |
Idle Count | The number of times an agent went into an Idle state. | Measure | Integer |
Is Current Session | Flag that indicates whether the session is active. Supported values are 0 and 1. The value 1 indicates that the session is active. | Measure | Integer |
Login Timestamp | The time when an agent logged in. | Measure | Long |
Logout Timestamp | The time when an agent logged out. | Measure | Long |
Multi Media Profile Type |
Thetype of blended profile configured for the agent. The blended profile types are Blended, Blended Real-time, and Exclusive. | Field | String |
Not Responded Count | The number of times an agent failed to respond to an incomingrequest due to which the contact couldn’t be connected to the agent. | Measure | Integer |
Outdial Agent To Agent Transfer Count | The number of times an agent transferred to another agent (outdial only). | Measure | Integer |
Outdial Agent Transfer To Queue Request Count | The number of times an agent requested transfer to queue (outdial only). | Measure | Integer |
Outdial Blind Transfer Count | The number of times an agent transferred a call without consulting first while in an outdial call. | Measure | Integer |
Outdial Conference Count | The number of times an agent established a conference callwith the caller and another agent while in an outdial call. | Measure | Integer |
Outdial Connected Count | The number of times an agent was in the Connected state while in an outdial call. | Measure | Integer |
Outdial Consult Answer Count | The number of times an agent answered a consult request (outdial calls). | Measure | Integer |
Outdial Consult Count | The number of times an agent consulted with another agent (outdial only). | Measure | Integer |
Outdial Consult Request Count | The number of times an agent initiated a consult request (outdial calls). | Measure | Integer |
Outdial Consult To EntryPoint Answered Count | The count of calls answered for Outdial Consult To EntryPoint. | Measure | Integer |
Outdial Consult To EntryPoint Answered Duration | The total duration of answered calls for Outdial Consult To EntryPoint. | Measure | Long |
Outdial Consult To EntryPoint Requested Count | The total count of requests for Outdial Consult To EntryPoint. | Measure | Integer |
Outdial Consult To EntryPoint Requested Duration | The total duration of requests for Outdial Consult To EntryPoint. | Measure | Long |
Outdial Consult Transfer Count | The number of times an agent transferred an outbound call after consult. | Measure | Integer |
Outdial Count | The number of calls an agent made (dialed out) during this session. | Measure | Integer |
Outdial CTQ Answer Count | The number of times an agent answered a consult-to-queue request while handling an outdial call. | Measure | Integer |
Outdial CTQ Request Count | The number of times an agent initiated a consult-to-queue request while handling an outdial call. | Measure | Integer |
Outdial Hold Count | The number of times calls were put on hold (outdial). | Measure | Integer |
Outdial Not Responded Count | The number of times contact couldn’t be connected to the agent while making an outdial request. | Measure | Integer |
Outdial Ringing Count | The number of times an agent was in the Outdial Reserved state, a state indicating that the agent has initiated an outdial call, but the call isn’t connected yet. | Measure | Integer |
Outdial Transfer Count | The number of outdial calls an agent transferred during this session. | Measure | Integer |
Outdial Wrapup Count | The number of times agents went into the wrap-up state after an outdial call. | Measure | Integer |
Realtime Update Timestamp | The time when the real-time process updated the record. | Measure | Long |
Reason |
The reason for the agent logout. The logout reason can be one of the following:
| Field | String |
Ringing Count | The number of times an agent was in a ringing state in this session (inbound only). | Measure | Integer |
Session Count | The number of agent sessions. | Measure | Integer |
Site ID |
The ID assigned to a call center location. The field displays the N/Avalue until the call is connected to an agent. | Field | String |
Site Name |
The call center location to which a call was distributed. The field displays the N/Avalue until the call is connected to an agent. | Field | String |
Site System ID |
The ID assigned to a call center location. Thefield displays the N/Avalue until the call is connected to an agent. | Field | String |
Skill Profile | The name of the skill profile associated with an agent. | Field | String |
Sub Channel Type |
The Social Channels (Facebook and SMS) are displayed with statistics. Filter: Channel Type Field: Social Used As: Row Segment | Field |
String |
Team ID | The ID assigned to a team. The field displays the N/A value until the call is connected to an agent. | Field |
String |
Team Name | A group of agents at a specific site who handle a particular type of call. | Field |
String |
Team System ID | The ID assigned to a team. The field displays the N/A value until the call is connected to an agent. | Field |
String |
TenantId |
The unique identification ID of a tenant. | Field |
String |
Total Available Duration |
The total amount of time in millli-seconds, the agent spent in the Available state. | Measure |
Long |
Total Conference Duration |
The amount of time in milli-seconds, an agent spent in a conference call with the caller and another agent (inbound only). | Measure |
Long |
Total Connected Duration |
The amount of time in milli-seconds, an agent spent in connected state, that is, talking to the customer, during this session (inbound only). | Measure |
Long |
Total Consult Answer Duration |
The amount of time in milli-seconds, an agent spent on answering consult requests (for inbound calls). | Measure |
Long |
Total Consult Duration |
The amount of time in milli-seconds, an agent spent in answering or making consult requests (for inbound calls). | Measure |
Long |
Total Consult Request Duration |
The amount of time in milli-seconds, an agent spent on making consult requests (for inbound calls). | Measure |
Long |
Total CTQ Answer Duration |
The amount of time in mill-seconds, an agent spent on answering consult-to-queue requests from an agent (for inbound calls). | Measure |
Long |
Total CTQ Duration |
Total duration in milli-seconds, spent on consult-to queue within an interaction. | Measure |
Long |
Total CTQ Request Duration |
The amount of time in milli-seconds, an agent spent on making consult-to-queue requests from an agent (for inbound calls). | Measure |
Long |
Total Hold Duration |
The amount of time in milli-seconds, spent on hold (inbound). | Measure |
Long |
Total Idle Duration |
The amount of time in milli-seconds, spent by an agent in Idle state. | Measure |
Long |
Total Not Responded Duration |
The amount of time in milli-seconds, an agent spent in the Not Responding state (inbound). | Measure |
Long |
Total Outdial Conference Duration |
The amount of time in milli-seconds, an agent spent in a conference call with the caller and another agent while in an outdial call. | Measure |
Long |
Total Outdial Connected Duration |
The amount of time in milli-seconds, an agent spent in the Connected state while in an outdial call. | Measure |
Long |
Total Outdial Consult Answer Duration |
The amount of time in milli-seconds, an agent spent on answering consult requests (outdial calls). | Measure |
Long |
Total Outdial Consult Duration |
The amount of time in milli-seconds, an agent spent on answering or making consult requests (for outdial calls). | Measure |
Long |
Total Outdial Consult Request Duration |
The amount of time in milli-seconds, an agent on spent making consult requests for outdial calls. | Measure |
Long |
Total Outdial CTQ Answer Duration |
The amount of time in milli-seconds, an agent spent on answering consult-to-queue requests from an agent while handling an outdial call. | Measure |
Long |
Total Outdial CTQ Request Duration |
The amount of time in milli-seconds, an agent on spent making consult-to-queue requests to an agent while handling an outdial call. | Measure |
Long |
Total Outdial Hold Duration |
The duration in milli-seconds, for which calls were placed on hold after an outdial call. | Measure |
Long |
Total Outdial Not Responded Duration |
The amount of time in milli-seconds, an agent spent in the Not Responding state after an outdial call. | Measure |
Long |
Total Outdial Ringing Duration |
The duration in milli-seconds, an agent was in the Outdial Reserved state, a state indicating that the agent has initiated an outdial call, but the call isn’t connected yet. | Measure |
Long |
Total Outdial Wrapup Duration |
The amount of time in milli-seconds, agents spent in the Wrap-up state after an outdial call. | Measure |
Long |
Total Ringing Duration |
The amount of time in milli-seconds, spent by the agent in the Ringing state, during the session (inbound only). | Measure |
Long |
Total Wrapup Duration |
The amount of time in milli-seconds, an agent was in the Wrap-up state after a call (inbound only). | Measure |
Long |
Wrapup Count | The number of agents in the wrap-up state after a call. | Measure |
Integer |
Agent Activity Repository (AAR)
The standard fields aggregated in the AAR are described in the following table:
Column Name | Description | Field or Measure |
Data Type |
---|---|---|---|
Activity Count | The number of activities. | Measure |
Integer |
Activity Duration | The amount of time between when the agent activity started and when the agent
activity ended. Note: This value is not populated in real time, it is recorded after completion of the activity. | Measure |
Integer |
Activity End Timestamp | The time when the agent activity ended. | Measure |
Long |
Activity Span | The amount of time in seconds that an agent was engaged in the activity during the specified interval. | Measure |
Long |
Activity Start Timestamp | The time when the agent activity started. | Measure |
Long |
Activity State | The state of an agent activity. Eg: Connected, Idle, Available, Ringing, etc. | Field |
String |
Agent Endpoint (DN) | The endpoint (number, e-mail, or chat handle) on which an agent receives calls,
chats, or emails. Eg: +9189797990 | Field |
String |
Agent ID | A string that identifies an agent. | Field |
String |
Agent Login | Login name with which an agent logs into the Agent Desktop. | Field |
String |
Agent Logged Out Due to Pending Logout |
If an agent is on a call when their WebSocket connection is lost and their desktop fails to reconnect, they will be logged out once the call concludes. | Field | String |
Agent Name | Name of an agent, that is, a person who answers customer calls or chats or emails. | Field |
String |
Agent Session ID | A string that identifies an agent’s login session. | Field |
String |
Agent Skills |
The skills associated with an agent. | Field |
String |
Agent System ID | A string that identifies an agent. | Field |
String |
Agent-WSS-Disconnect |
The agent has been moved to Idle status due to a disconnection in their WebSocket. This action prevents any calls from being allocated to the agent during this disconnected state. | Field | String |
Call Back Type | The type of the callback. The callback type can be courtesy or web. | Field |
String |
Channel ID | The channel ID of the channel type, such as telephony, email, or
chat. Note: If the agent has multiple channels assigned of the same type, each channel will have a unique ID. | Field |
String |
Channel Type | The media type of the contact, such as telephony, email, or chat. | Field |
String |
Child Contact Id | The child interaction ID is the subsequent leg in each call that has a consult to EP-DN. | Field |
String |
Child Contact Type | Determines the type of consult. | Field |
String |
Consult EntryPoint Id | Entry point ID in the event of consult to EP-DN. | Field |
String |
Consult EntryPoint Name | Entry point Name in the event of consult to EP-DN. | Field |
String |
Consult EntryPoint System Id | Entry point System ID in the event of consult to EP-DN. | Field |
String |
Contact Session ID | Unique identifier that identifies the contact session. | Field |
String |
Email Handled Count |
The number of emails handled through the channel type as email. | Measure |
Integer |
Email Wrapup Count |
The number of times an agent was in email wrap-up state. | Measure |
Integer |
Idle Code ID | A string that identifies an idle code. | Field |
String |
Idle Code Name | The name of the idle code. | Field |
String |
Idle Code System ID | A system-generated ID that identifies an idle code.. | Field |
String |
Is Current Activity | Flag that indicates whether the activity is a current activity, that is,
activity hasn’t ended. Supported values are 0 and 1. | Measure |
Integer |
Is Login Activity | Flag that indicates whether the activity is a current activity, that is,
activity hasn’t ended. Supported values are 0 and 1. | Measure |
Integer |
Is Logout Activity | Flag that indicates whether this activity was the logout activity. Supported values are 0 and 1. | Measure |
Integer |
Is Outdial | Flag that indicates whether this activity occurred while making an outdial call. | Measure |
Integer |
Maximum Invite Failed Exceeded Limit |
When an agent's device encounters issues and fails three consecutive invite requests, the agent will be transitioned to the Idle state with this error message. | Field | String |
Multi Media Profile Type |
Shows the type of blended profile configured for the agent. The blended profile types are Blended, Blended Real-time, and Exclusive. | Field |
String |
Outbound Type |
Identifies the call direction type - outbound or inbound. | Field |
String |
Queue ID | A string that identifies a queue. The field displays the N/A value until the call is connected to an agent. | Field |
String |
Queue Name | A string that identifies the name of a queue. | Field |
String |
Queue System ID | A string that identifies a queue. The field displays the N/A value until the call is connected to an agent. | Field |
String |
Realtime Update Timestamp | Last timestamp when the agent activity record was updated. | Measure |
Long |
Record Unique ID | Unique string that identifies this activity record. | Field |
String |
Site ID | The ID assigned to a call center location. The field displays the N/A value until the call is connected to an agent. | Field |
String |
Site Name | The call center location to which a call was distributed. The field displays the N/A value until the call is connected to an agent. | Field |
String |
Site System ID | The ID assigned to a call center location. The field displays the N/A value until the call is connected to an agent. | Field |
String |
Sub Channel Type |
The Social Channels (Facebook and SMS) are displayed with statistics. Filter: Channel Type Field: Social Used As: Row Segment | Field |
String |
Team ID | The ID assigned to a team. The field displays the N/A value until the call is connected to an agent. | Field |
String |
Team Name | A group of agents at a specific site who handle a particular type of call. | Field |
String |
Team System ID | The ID assigned to a team. The field displays the N/A value until the call is connected to an agent. | Field |
String |
TenantId |
The unique identification ID of a tenant. | Field |
String |
Wrapup Code Name | The wrap-up code that the agent assigns for an interaction. | Field |
String |
Wrapup Code System ID | A system-generated string that identifies a wrap-up code. | Field |
String |
Agent States
State | Description |
---|---|
available |
Generated when the agent is ready to accept and respond to the routed contact requests. After the agent signs in, the agent must select Available from the drop-down list to accept voice call, chat, email, and social messaging conversation requests. |
available-consulting |
Generated when the destination agent, who is in the Available state, accepts the consult request and is added to the call. |
AvailableConsultReserved |
Generated when a consult request to an agent is initiated, and the destination agent is in the Available state. |
conference-done |
Generated when the conference call ends. This status is generated for both the agents—the one who initiated the consult request and the one who receives the call. The Conference Done state is displayed when the destination agent exits the conference call, until the agent who initiated the conference request clicks Resume to take the customer off hold. |
conferencing |
Generated when the conference call is in progress. |
connected |
Generated when the agent accepts the request and is connected with the customer. |
connected-consulting |
Generated when the destination agent accepts the consult request and the consult call is connected. |
ConnectedConsultReserved |
Generated when a consult request is forwarded to the media to perform call associated operations initiating a consult call. |
consult-done |
Generated when the consult call ends. This status is generated for both the agents—the one who initiated the consult request and the one who was consulted. The Consult Done state is displayed when the destination agent exits the consult call, until the agent who initiated the consult request clicks Resume to take the customer off hold. |
consulting |
Generated when the consult call is in progress. |
ctq-ready/ctq-reserved/ctq-accepted |
Generated after a consult-to-queue request is initiated, when the destination agent is available for the queued consult call. |
hold-done |
Generated when the agent removes the call on hold and the call is then moved back to in-progress. |
idle |
Generated when the agent signs in but is not ready to accept any routed requests. When the agent signs in to the desktop, the state is set to Idle by default. |
idle-consulting |
Generated when the destination agent, who is in the Idle state, accepts the consult request and is added to the call. |
IdleConsultReserved |
Generated when a consult request to an agent is initiated, and the destination agent is in the Idle state. |
logged-out |
Generated when the agent signs out from the desktop. |
not-responding |
Generated when the agent does not respond to the routed contact requests, and goes into the RONA state. |
on-hold |
Generated when the agent places the customer on hold by clicking the Hold button. The Call on Hold state is displayed next to the timer. Agent can click Resume to take a call off hold |
ringing |
Generated when the incoming call popover is being displayed at the bottom-right corner of the desktop. |
wrapup |
Generated when the agent clicks End or Transfer or Send button during an active interaction with a customer. The Wrap Up state is displayed until the wrap-up reasons are submitted. |
vt-transfer |
Generated after an agent transfers a call to an entry point or a queue through blind transfer. |
skillUpdate |
Generated when the management portal notifies about the skill profile or skills update for an agent. |
Call States
Event |
Purpose | Next Event Expected: Y= Accepted, N= Not Accepted | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
new |
ivr- conn ected |
ivr- done |
parked |
connect |
conn ected |
on- hold |
hold- done |
consu lting |
consu lt-done |
confer encing |
confe rence- done |
ended |
recor ding- started |
transf erred |
monit oring- reque sted |
moni toring- started |
moni toring- ended |
wrapup -done |
update -csr-attr ibutes | |
no contact |
No interaction with the customer |
Y | N | N | N | N | N | N | N | N | N | N | N | N | N | N | N | N | N | N |
new |
New interaction starts with the customers |
N | Y | Y | Y | Y | N | Y | Y | N | N | N | Y | N | N | N | N | N | N | Y |
ivr- connected |
ivr instance is connected |
N | N | Y | N | N | N | N | N | N | N | N | N | N | N | N | N | N | N | Y |
ivr- done |
ivr instance is completed |
N | Y | N | Y | Y | N | N | N | N | N | N | Y | Y | N | N | N | N | N | Y |
parked |
Call is kept in parked state |
N | Y | Y | Y | Y | N | N | N | N | N | N | Y | Y | N | N | N | N | N | Y |
connect |
New call starts with the customer |
N | N | N | Y | Y | N | N | N | N | N | N | Y | Y | N | N | N | N | N | Y |
connected |
Call in-progress with the customer |
N | N | N | N | N | Y | N | N | N | Y | N | Y | Y | Y | Y | N | N | Y | Y |
on-hold |
Call is on-hold with the customer |
Y | N | N | Y | Y | N | Y | Y | N | Y | N | Y | N | Y | N | N | N | Y | Y |
hold-done |
Call is put back to in-progress state from on-hold state |
Y | N | N | N | N | Y | N | N | N | Y | N | Y | Y | Y | Y | N | N | Y | Y |
consulting |
Call is put in consulting state |
N | N | N | N | N | N | N | N | Y | Y | N | N | N | Y | N | N | N | Y | Y |
consu lt-done |
Call is put back to in-progress state from consulting state |
N | N | N | Y | Y | N | Y | Y | N | Y | N | Y | N | Y | N | N | N | Y | Y |
confer encing |
Call is put in conference state |
N | N | N | N | N | N | N | N | N | Y | Y | N | N | N | N | N | N | Y | Y |
confer ence-done |
Call is put back to in-progress state from conference state |
N | N | N | N | N | N | Y | N | N | N | N | Y | N | Y | N | N | N | Y | Y |
ended |
Call with the customer is ended |
N | N | N | N | N | N | N | N | N | N | N | N | N | N | N | N | N | Y | Y |
recor ding- started |
Call reco rding started |
N | N | N | Y | Y | N | N | N | N | N | N | N | N | N | N | N | N | N | Y |
transf erred |
Call is trans ferred |
N | N | N | N | Y | N | N | N | N | N | N | Y | N | N | N | N | N | Y | Y |
moni toring -reque sted |
Call monitoring is requested |
N | N | N | N | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | N | Y | N | N | Y |
moni toring- started |
Call monitoring is started |
N | N | N | N | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | N | N | Y | N | Y |
moni toring- done |
Call monitoring is ended |
N | N | N | N | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | N | Y |
wrap -up done |
Wrapup done by the agent |
N | N | N | N | Y | N | N | N | N | N | N | N | N | N | N | N | N | Y | Y |
update -csr-attri butes |
update csr-attr ibutes |
N | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y |
Flow Developer uses the Flow Designer UI to create and publish call control scripts to manage the inbound telephony contacts. The administrator maps the published flow scripts against the routing strategy. When an inbound call lands at the entry point, the flow control engine identifies the routing strategy and executes the corresponding flow script, invoking the individual flow control activities that are part of the flow script.
Call Reason Codes
Reason Codes | Reason | Description |
---|---|---|
400 |
Bad Request |
The server cannot understand the request due to malformed syntax. |
401 |
Unauthorized |
The request requires user authentication. |
403 |
Forbidden |
The server understands the request, but refuses to fulfill it. Authorization does not help. Do not repeat the request. |
404 |
Not Found |
The user ID does not exist at the domain specified in the Request-URI or the domain in the Request-URI does not match any of the domains that are handled by the recipient of the request. |
405 |
Method Not Allowed |
The specified method in the Request-Line is understood, but not allowed for the address identified by the Request-URI. The response must include an Allow header field containing a list of valid methods for the indicated address. |
406 |
Not Acceptable |
The resource identified by the request generates response entities with content characteristics that are not acceptable according to the Accept header field sent in the request. |
407 |
Proxy Authentication Required |
This code is similar to 401 (Unauthorized), but indicates that the client must first authenticate itself with the proxy. |
408 |
Request Timeout |
The server cannot produce a response within the timeout duration set by the administrator. |
410 |
Gone |
The requested resource is no longer available at the server and no forwarding address is known. |
413 |
Request Entity Too Large |
The server cannot process the request because the body of the request entity exceeds the value that the server is able to process. The server may close the connection to prevent the client from continuing with the request. |
414 |
Request-URI Too Long |
The server cannot process the request because the request-URI is longer than the value that the server is able to interpret. |
415 |
Unsupported Media Type |
The server cannot process the request because the message body of the request is in a format that is not supported by the server for the requested method. |
416 |
Unsupported URI Scheme |
The server cannot process the request because the scheme of the URI in the Request-URI is unknown to the server. |
420 |
Bad Extension |
The server cannot understand the protocol extension specified in a Proxy-Require or Require header field. |
421 |
Extension Required |
The User Agent Server (UAS) needs a particular extension to process the request, but this extension is not listed in the Supported header field in the request. |
423 |
Interval Too Brief |
The server cannot process the request because the expiration time of the requested resource is too short. This response can be used by a registrar to reject a registration whose Contact header field expiration time was too small. |
480 |
Temporarily Unavailable |
User's end system is contacted successfully, but the user is currently unavailable (for example, the user is not logged in, or the Do not Disturb feature is activated.) |
481 |
Call/Transaction Does Not Exist |
The UAS received a request that does not match with any existing dialog or transaction. |
482 |
Loop Detected |
The server has detected a loop. |
483 |
Too Many Hops |
The server cannot process the request because the request contains a Max-Forwards header field with the value zero. |
484 |
Address Incomplete |
The Request-URI is incomplete. Additional information should be provided in the reason phrase. |
485 |
Ambiguous |
The Request-URI is ambiguous. |
486 |
Busy here |
User's end system is contacted successfully, but the user is currently not willing or able to take calls at this end system. |
487 |
Request Terminated |
The request is terminated by the BYE or CANCEL request. |
488 |
Not Acceptable Here |
The response has the same meaning as the reason code 606 (Not Acceptable), but only applies to the specific resource addressed by the Request-URI and the request may succeed elsewhere. |
491 |
Request Pending |
The request is received by a UAS that has a pending request within the same dialog. |
493 |
Undecipherable |
The request is received by a UAS that contains an encrypted Multipurpose Internet Mail Extensions (MIME) body for which the recipient does not possess or does not provide an appropriate decryption key. |
500 |
Server Internal Error |
The server encountered an unexpected condition that prevented it from fulfilling the request. |
501 |
Not Implemented |
The server does not support the functionality that is required to fulfill the request. |
502 |
Bad Gateway |
The server, while acting as a gateway or proxy, receives an invalid response from the downstream server that it accessed to fulfill the request. |
503 |
Service Unavailable |
The server is temporarily unable to process the request due to a temporary overloading or maintenance of the server. |
504 |
Server Time-out |
The server did not receive a timely response from an external server it accessed to process the request. |
505 |
Version Not Supported |
The server does not support, or refuses to support the SIP protocol version that is used in the request. |
513 |
Message Too Large |
The server cannot process the request because the message length exceeded its capabilities. |
600 |
Busy Everywhere |
User's end system is contacted successfully, but the user is busy and does not wish to accept the call currently. |
603 |
Decline |
User's machine is contacted successfully, but the user does not wish to or cannot participate. |
604 |
Does Not Exist Anywhere |
The user who is indicated in the Request-URI does not exist anywhere. |
606 |
Not Acceptable |
User's agent is contacted successfully, but some aspects of the session description such as the requested media, bandwidth, or addressing style are not acceptable. |
mCCG |
Timeout at mCCG |
The timeout occurs when the voice controller sends a request to the dependent services and does not receive a response within a specified time. |
Call Progress Analysis (CPA) - Condition Detect Reasons
CPA is used to detect call progress, for example, busy and operator intercept, and analyze a call after it is connected. The call progress conditions can be attributed to the following reasons:
-
Pre-Connect Reasons
-
busy1: The called line is detected as busy.
-
busy2: The called line is detected as busy.
-
no_answer/no-answer: The called line did not answer.
-
no_ringback/no-ringback: No ringback received on the line.
-
sit_no_circuit/sit-no-circuit: The no circuit tone is detected in the Special Information Tones (SIT) in the called line.
-
sit_operator_intercept/sit-operator-intercept: The operator intercept tone is detected in the SIT in the called line.
-
sit_vacant_circuit/sit-vacant-circuit: The vacant circuit tone is detected in the SIT in the called line.
-
sit_reorder/sit-reorder: The reorder tone is detected in the SIT in the called line.
-
-
Post-Connect Reasons
-
voice: A voice is detected in the called line.
-
answering_machine/answer-machine: An answering machine is detected in the called line.
-
cadence_break/cadence-break: The connection to the called line is lost due to cadence break.
-
ced: A fax machine or modem is detected in the called line.
-
cng: A fax machine or modem is detected in the called line.
-