Enhance the Flex Queues View with Custom Data Tiles

People working on enhance flex queues

Time to read: 6 minutes

June 28, 2023
Written by
Ludo Vlieger
Twilion
Reviewed by
Matija Vrzan
Twilion
Abby Ford
Twilion

The Flex Real Time Queues View provides a few standard Data Tiles that aggregate the Queue data at the contact center level:

  • Active Tasks: The number of tasks that are currently being handled.
  • Waiting Tasks: The number of tasks that are waiting to be handled.
  • Longest Wait: The amount of time in seconds for the longest waiting task.

These three Data Tiles are contained within the AggregatedDataTiles component at the top of the Queues View page. This rectangular box also contains the bar chart with the breakdown of the agents by status (unavailable, available, or offline).

The Queues View also provides SLA Metrics per Queue, but not at the contact center level.

As shown in our Flex documentation, you can add custom DataTiles to display custom metrics and KPIs. Twilio documentation provides an example that uses the existing AggregatedDataTile Flex UI component to calculate and display the total number of wrapping Tasks in a new Data Tile.

Having additional Data Tiles available with useful aggregated metrics or KPIs gives the contact center supervisor better visibility into the traffic levels and performance per Channel as well as per Queue. Using tiles with color-coded backgrounds provides better visual cues and improve the overall UI.

In this blog post, I will provide sample code for several custom Data Tiles in order to demonstrate how you could display KPIs such as Active Chats, Active Calls, or SLA % per Channel (Chat or Voice).

Prerequisites

To be able to implement the plugin code in this blog post you should be familiar with Flex Plugin development as well as JavaScript, React (JavaScript UI framework), and Redux (for application state management). We also recommend that you review our Flex Plugin development documentation.

To create this Flex plugin you will need the following:

Flex Queues View data

As you can see from this example in our Flex documentation, you can connect a custom Data Tile to the Flex Redux application store using connect from React-Redux. You need to provide the equivalent of a mapStateToProps function and return an object with props. Alternatively, in Flex v2 you can now leverage the useFlexSelector wrapper method to extract the real time queues data from the Flex Redux store for use in a React component.

Before we can build custom Data Tiles, we need to better understand the Queue data that is available in the Flex Redux store. You can either use the Redux Dev Tools in Chrome or use this command in the Chrome console to inspect the real-time Queue data in the Flex Redux store via the Flex Manager:

Twilio.Flex.Manager.getInstance().store.getState().flex.realtimeQueues

Below is a condensed summary of the important Queue data properties and data types.

Queue data attributes

NameTypeDescription
friendly_namestringQueue Name
keystringQueue Sid (WQ…)
total_available_workersnumberAvailable Workers in this queue
total_eligible_workersnumberTotal Number of Workers associated with this queue
activity_statisticsArray of { sid: string,friendly_name: string,workers: number }Count of workers in each Activity
tasks_by_statusObject: {reserved: number, pending: number, assigned: number, wrapping: number}Breakdown of Task Counts by State: Pending (Waiting), Reserved, Assigned and Wrapping.
total_tasksnumberTotal Tasks in this Queue
longest_task_waiting_sidstring | nullTask Sid of longest waiting task
longest_task_waiting_fromstring | null
channelsArray of Breakdown of Queue stats by Task Channel. See Channel object definition below
sla_30_minsObject: See SLA Metrics
sla_todayObject: See SLA Metrics

Data available in each Channel Object.

NameTypeDescription
unique_namestringvoice, chat, sms etc
sidstringTask Channel Sid (TC…)
sla_30_minObject: See SLA Metrics
sla_todayObject: See SLA Metrics
tasks_nowObject: { reserved_tasks: number, active_tasks: number,pending_tasks: numberwaiting_tasks: number, assigned_tasks: number, wrapping_tasks: numbertotal_tasks: number }Breakdown of Task Counts by State: See Task LifeCycle for more details.

Data available in each SLA Metrics Object.  

NameType
abandoned_tasks_countnumber
abandoned_tasks_percentagenumber between 0 and 1 (100%).  -1 if not available
handled_tasks_countnumber
handled_tasks_within_sl_threshold_countnumber
handled_tasks_within_sl_threshold_percentagenumber between 0 and 1 (100%).  -1 if not available
short_abandoned_tasks_countnumber
short_abandoned_tasks_percentagenumber between 0 and 1 (100%).  -1 if not available
sla_percentagenumber between 0 and 1 (100%).  -1 if not available
total_tasks_countnumber

Now that you have a good understanding of the Queue data available for aggregation, you can start working on the Flex Plugin code for the data aggregation functions, and the new React Components for the custom Data Tiles.  

In the remainder of this blog post we will provide a few different examples of custom Data Tiles to display Metrics/KPIs that may be useful to contact center supervisors.

Building our Flex Plugin

Active and waiting tasks by channel Data Tiles

To be able to display the Active and Waiting Tasks for a specific Task Channel (e.g voice, chat, sms), we would first need to calculate these totals by aggregating the Channels data for all Queues.  

Step 1. Task count aggregation function

The utility method to accomplish this could be as follows:


 getTaskCountsByChannel = (queues = []) => {
   const initCounts = { activeTasks: 0, waitingTasks: 0 };
   let taskCounts = {
     chat: { ...initCounts },
     sms: { ...initCounts },
     voice: { ...initCounts }
   };
   if (queues.length === 0) return taskCounts;
   queues.forEach(q => {
     if (q.channels) {
       q.channels.forEach(ch => {
         //Only aggregate counts for configured channels
         if (channelList.includes(ch.unique_name) && (ch.tasks_now)) {
           taskCounts[ch.unique_name].activeTasks += ch?.tasks_now?.active_tasks;
           taskCounts[ch.unique_name].waitingTasks += ch?.tasks_now?.waiting_tasks;
         }
       })
     }
   })
   return taskCounts;
 }

Note that the Channels array per Queue may not contain data for each possible channel so we use the Optional Chaining operator (?.) while extracting the task data.

Step 2. Create channel task count Data Tile component

Leveraging the getTaskCountsByChannel utility method from above, we can create our custom Channel Data Tile component. This component is similar to the AggregatedDataTile component available in Flex with the a small enhancement to be able to change the tile background color:


const ChannelTaskCountTile = connect((state) => {
 const queues = Object.values(state.flex.realtimeQueues.queuesList);
 return QueueDataUtil.getTaskCountsByChannel(queues);
 //object returned from connect is merged into component props
 //See https://react-redux.js.org/api/connect
})((props) => {
 const { channelName, className, bgColor } = props;
 let taskCounts = props[channelName];

 return (
   <TileWrapper className={cx("Twilio-AggregatedDataTile", className)} bgColor={bgColor}>
     <Title className="Twilio-AggregatedDataTile-Title">
       {channelName + " Active"}
     </Title>
     <Content className="Twilio-AggregatedDataTile-Content">
       {taskCounts.activeTasks}
     </Content>
     <Description className="Twilio-AggregatedDataTile-Description">
       {"Waiting: " + taskCounts.waitingTasks}
     </Description>
   </TileWrapper>
 );
});

export default ChannelTaskCountTile;

Step 3. Add new channel task count Data Tile component to Queues View

And finally, we can add three new tiles (one each for the voice, chat, and sms channels) to the AggregatedDataTiles component on the QueuesStatsView.


const tileColors = {
 "voice": '#ADD8E6',
 "chat": '#87CEFA',
 "sms": '#4682B4'
}

 Flex.QueuesStats.AggregatedQueuesDataTiles.Content.add(
   <ChannelTaskCountTile key="voice-tasks" channelName="voice" bgColor={tileColors.voice} />,
   { sortOrder: -6 }
 );
 Flex.QueuesStats.AggregatedQueuesDataTiles.Content.add(
   <ChannelTaskCountTile key="chat-tasks" channelName="chat" bgColor={tileColors.chat} />,
   { sortOrder: -5 }
 );
 Flex.QueuesStats.AggregatedQueuesDataTiles.Content.add(
   <ChannelTaskCountTile key="sms-tasks" channelName="sms" bgColor={tileColors.sms} />,
   { sortOrder: -4 }
 );

Adding all the above code in a Flex plugin and running this locally (or deploying the plugin to your Flex account), the Flex Real-Time Queues View now shows these additional Data Tiles with the Active Task Count and Waiting Task Count per channel. Optional background colors can be applied as a visual cue and to enhance the UI.

Image of three queues including voice Active, chat Active, sms Active with an bar graph showing number of agents available, unavailable, and offline. The three tiles are all in different colors for visual differentiation all in different colors for visual differentiation.

Complete Flex Plugin source code can be found here: https://github.com/ldvlgr/queues-view-data-tiles 

Channel SLA Data Tile

The Flex Real Time Queues View shows the SLA % for each Queue (and further broken down by Channel, if available). If there are a large number of Queues, it may be preferable to display the SLA % aggregated by Channel.

Step 1. Channel service level aggregation function

Here is the code for a utility method to calculate the Service Level metrics per Channel (across all queues):

 
 getSLTodayByChannel = (queues = []) => {
   const initSLMetrics = { handledTasks: 0, handledTasksWithinSL: 0, serviceLevelPct: 0 }
   let slMetrics = {
     chat: { ...initSLMetrics },
     sms: { ...initSLMetrics },
     voice: { ...initSLMetrics }
   };
   if (queues.length === 0) return slMetrics;
   queues.forEach(q => {
     if (q.channels) {
       q.channels.forEach(ch => {
         if (channelList.includes(ch.unique_name) && (ch.sla_today)) {
           slMetrics[ch.unique_name].handledTasks += ch?.sla_today?.handled_tasks_count;
           slMetrics[ch.unique_name].handledTasksWithinSL +=
                ch?.sla_today?.handled_tasks_within_sl_threshold_count;
         }
       })
     }
   })
   channelList.forEach(ch => {
     if (slMetrics[ch].handledTasks > 0)
       slMetrics[ch].serviceLevelPct = Math.floor((slMetrics[ch].handledTasksWithinSL /
            slMetrics[ch].handledTasks) * 100);
   })
   return slMetrics;
 }

Step 2. Create Channel SLA Data Tile component

Leveraging this utility method, we can now create our custom Channel SLA Data Tile:


const ChannelSLATile = connect((state) => {
 const queues = Object.values(state.flex.realtimeQueues.queuesList);
 return QueueDataUtil.getSLTodayByChannel(queues);
 //object returned from connect is merged into component props
 //See https://react-redux.js.org/api/connect
})((props) => {
 const { channelName, className } = props;
 let sla = props[channelName];

 let content = "-";
 if (sla.handledTasks && sla.handledTasks > 0) {
   content = sla.serviceLevelPct + "%";
 }

 return (
   //Pass value to TileWrapper for changing color
   <TileWrapper
       value={sla.serviceLevelPct}
       count={sla.handledTasks}
       className={cx("Twilio-AggregatedDataTile", className)}>
     <Channel>
     <ChannelIcon>
       {channelName == "voice" && <Icon icon='Call' />}
       {channelName == "chat" && <Icon icon='Message' />}
       {channelName == "sms" && <Icon icon='Sms' />}
       </ChannelIcon>
       <Title className="Twilio-AggregatedDataTile-Title">{channelName + " SLA"}</Title>
       </Channel>
     <Content className="Twilio-AggregatedDataTile-Content">{content}</Content>
     <Description className="Twilio-AggregatedDataTile-Description">
       {sla.handledTasksWithinSL + " / " + sla.handledTasks}
     </Description>
   </TileWrapper>
 );
});

export default ChannelSLATile;

Step 3. Customize threshold levels and colors

To implement dynamic background colors (red, yellow, green) based on configurable SL Threshold values, we can enhance the styled component with a function that returns the background color:


export const TileWrapper = styled("div")`
   background-color: ${(props) => getColor(props)};
  `;

function getColor(props) {
 let {value, count, greenLine, yellowLine, theme} = props;
 //No color if handled tasks count = 0 (N/A)
 if (!count) return theme.tokens.backgroundColors.colorBackgroundBody;
 if (!greenLine) greenLine = 90;
 if (!yellowLine) yellowLine = 60;
 if (value >= greenLine) {
   return "#d0f4d1";
 } else if (value > yellowLine) {
   return "#ffe3b9";
 } else {
   return "#feced3";
 }
}

With this code, SLA Values >= 90 are rendered with a green background, values between 61 and 90 are shown with a yellow background and values <= 60 are displayed with a red background. These levels can be customized as needed.

Step 4. Add new Channel SLA Data Tile component to Queues View

And finally, let’s add these three Channel SLA Tiles to the AggregatedDataTiles component on the QueuesStatsView.


 Flex.QueuesStats.AggregatedQueuesDataTiles.Content.add(
   <ChannelSLATile key="voice-sla-tile" channelName="voice" />,
   { sortOrder: -2 }
 );
 Flex.QueuesStats.AggregatedQueuesDataTiles.Content.add(
   <ChannelSLATile key="chat-sla-tile" channelName="chat" />,
   { sortOrder: -2 }
 );
 Flex.QueuesStats.AggregatedQueuesDataTiles.Content.add(
   <ChannelSLATile key="sms-sla-tile" channelName="sms" />,
   { sortOrder: -1 }
 );

After combining all the above code in a Flex plugin and running the plugin locally (or deploying to your Flex account), the Flex Real-Time Queues view should now show all six new Data Tiles:

Image of six queues including voice Active, chat Active, sms, Active, voice SLA, chat, SLA, and SMS SLA, all in different colors for visual differentiation.

 

Complete Flex Plugin source code can be found here: https://github.com/ldvlgr/queues-view-data-tiles 

Custom pie chart Data Tiles

Since there is limited screen space at the top of the Queues View to add new Data Tiles, it may make sense to combine several metrics into a single data tile. The Flex plugin includes an example for creating a combined pie chart Data Tile that displays the Channel SLA metrics for all three channels (voice, chat, and sms):

An image showing three tiles voice Active, chat Active, sms Active, and a pie chart with title "SLA Today."

 

This pie chart Data Tile is just one possible visualization of this data. Other options include vertical bar charts or donut charts. There are a variety of chart libraries available in npm for inclusion in your plugin.

Furthermore, for large Flex implementations with dozens or even 100s of Queues, it may make sense to aggregate the data across a group of related Queues and calculate the SLA % for this group of Queues. To be able to aggregate the data across all Queues into groups, you would need to have a consistent Queue naming format where the group is a predetermined part of the Queue name (for example sales.mobile.voice.en). The sample Flex plugin provides additional code to show how you can accomplish this grouping. Here is an example of what this view could look like:

Image pie chart grouping 4 types of SLA % together including sales, services, care, and fraud.

Customize your Twilio Flex Queues View

In this blog post I demonstrated how you can leverage the programmability of Flex and more specifically, of the Real-Time Queues View within Flex, to quickly create additional KPI Data Tiles to give Flex supervisors better operational visibility into their contact center. We can’t wait to see what you do with the sample code and make even better or more insightful custom Data Tiles, charts, or other data visualizations.

If your team would like assistance with any aspect of your solution, Twilio Professional Services is here to help. Reach out to learn more about our offerings.

Ludo Vlieger is a Staff Solutions Architect at Twilio’s NAMER Professional Services Team. Ludo enjoys enabling & educating Twilio customers & partners and building the best possible Flex Contact Centers.  He can be reached at lvlieger [at] twilio.com.

Related Posts

Related Resources

A newspaper article

Twilio Docs

From APIs to SDKs to sample apps

API reference documentation, SDKs, helper libraries, quickstarts, and tutorials for your language and platform.
An Open book

Resource Center

The latest ebooks, industry reports, and webinars

Learn from customer engagement experts to improve your own communication.
User group reactions

Ahoy

Twilio's developer community hub

Best practices, code samples, and inspiration to build communications and digital engagement experiences.