Introduction

This lab serves as a supplement to show how to use Reportable Global Variables in your query as returned values, filters, and/or aggregations.

Pre-requisites

• Complete Getting Started
• Complete Exploring the Query
• The tenant you are querying must have Reportable Global Variables
• The Reportable Global Variables must be in a flow in order to return values
• You must know the name and type of Reportable Global Variables you are adding to your queries

Lab Objective

• Understand the types of Global Variables
• Understand how Global Variables types map between the Search API and Webex Contact Center
• Add Reportable Global Variables to a query
• Add more than one of the same type of Global Variable

Variable type mapping

GraphQL Global Variable Type	Webex Contact Center Global Variable Type
integerGlobalVariables	Integer
stringGlobalVariables	String
longGlobalVariables	DateTime
doubleGlobalVariables	Decimal
booleanGlobalVariables	Boolean

Returning a Global Variable

stringGlobalVariables(name:"nameOfVariable"){ name value }

Returning more than one of the same type of variable

nameOfVariable: stringGlobalVariables(name:"nameOfVariable"){ name value }

Note you can comment out name or omit name in the return field list as the variable type will be replaced with the alias provided

nameOfVariable: stringGlobalVariables(name:"nameOfVariable"){ # name value }

Filtering with Global Variables

Filtering with global variables is similar to using them in the returned fields section of the query without the need to use aliases.

String Global Variables

filter: { stringGlobalVariables: { name: { equals: "nameOfVariable" } value: { equals: "mySpecialValue" } } }

Numeric Global Variables

filter: { doubleGlobalVariables: { name: { equals: "nameOfDoubleVariable" } value: { gte: 17 } } }

Global Variable Aggregations

Similarly to filtering with global variables you do not need to use aliases as you will define the label of the field which is returning the aggregation.

Count of a String Global Variable

aggregations: [ { field: "id" name: "Count of nameOfVariable" type: count filter: { stringGlobalVariables: { name: { equals: "nameOfVariable" } value: { equals: "mySpecialValue" } } } } ]

Sum of an Integer Global Variable

aggregations: [ { field: "integerGlobalVariables.value" name: "Sum of nameOfVariable" type: sum predicate: { integerGlobalVariables: { name: { equals: "nameOfVariable" } } } } ]

Click Next to continue to the next lesson