Background
Search Sets and Search Criteria are two of the most fundamental and important concepts in Variphy Webex Calling Analytics, as they shape all reports, dashboard widgets, alerts, and history search results.
Search Set
A Search Set is just a set of 1 or more Search Criteria, along with some settings for how to apply the Criteria:
- Name – used just for display and descriptive purposes
- Filter By Call Duration Or Status – whether or not to also apply additional filtering based upon call duration
- Match All Criteria – how to apply multiple criteria values together, essentially using “AND” vs “OR” logic when possible (with Match All enabled, “AND” will be used)
- Search Criteria – one or more search types with one or more values to query for
Search Criteria
Each Search Criteria defines what specific values to match with Webex Calling data.
In Variphy, Search Criteria are comprised of the following:
<Search Type> <Conditional Type> <Value>
Every Search Criteria has a Search Type – this defines which Webex Calling property or properties to match against.
Webex Calling call data has a multitude of search properties to choose from, such as.
- The callers location for which a call originated from (“Calling Party Location”)
- The Queue which a call was received on (“Called Queue”)
- directory/phone number which originated the call (“Calling Number”)
- directory/phone number which was received the call (“Called Party Number”)
The Search Criteria Conditional Type defines what type of condition to apply, such as “equals 911”, “starts with 9”, or “does not contain 911”.
Text Conditional Types
- equals
- starts with
- ends with
- contains
- does not equal
- does not start with
- does not end with
- does not contain
Numeric Conditional Types
- equals
- greater than
- great than or equal to
- less than
- less than or equal to
Search Value
The Search Value is the specific text or numeric value to be queried for, using the Conditional Type, for example “1000” or “Steve” .
Wildcards
For text-based Search Types, a capital “X” digit can be used to represent a wildcard digit. Multiple wild card digits can be used in the same Value, which allows you to specify lengths of values.
For example, the following Search Criteria will yield all Webex Calling call activity from a 4 digit Caller Number, which begins with a “2”.
Caller Number equals 2XXX
Pre-Populated Drop Down lists
Certain search criteria will contain a list of available meta data from your Webex Calling Organization. Different than call data, meta data includes things like Calling or Called User, Calling or Called Department or Called Queue, etc… Meta data search criteria will provide a drop down list of available information to choose from. This information can be searched as current meta information (Show Historical Options toggled off) or historical meta information (Show Historical Options toggled on).
Show Historical Options
Meta data search’s have the ability to query both what is currently active in your Webex Calling Organization but also information for users or departments no longer in your Webex Calling Organization. For Example:
If searching for Calling or Called users with “Show Historical Options toggled = OFF” the pick list will only display users currently in your Webex Calling Organization. If Bruce Wayne was an employee but is no longer with your organization he will not appear in the picklist of available users as he no longer has an account.
If searching for Caller or Called users with “Show Historical Options toggled = ON” the pick list will display a list of users currently in your Webex Calling Organization but also that no longer have Webex Calling accounts. If Bruce Wayne was an employee but is no longer with your organization he still appear in the list as an available search option.
Show Historical Options gives you the ability to search for specific meta data that is no longer in your Webex Calling Organization but was at one time.
Meta Data can only be provided based on the date of Variphy’s installation and first data sync. Meta Data from prior to the Variphy installation is not available.
Webex Calling Search Set Examples
Example 1 – Single Search Type and Value
The following example Search Criteria defines Calling Number equals 1234, which means all calls originating only from directory/phone number 1234.
Since there is only 1 Search Type (Calling Number) and Value (1234), the Match All Criteria field is not applicable.
Example 2 – Multiple Search Types With Match Any
In this example, there are 2 different Search Types and 3 unique Values, which will be combined using a “Match Any” approach.
Since the Match All Criteria is toggled OFF in the below example, this Search Set will find all call to 911, all calls to 9911 and all calls greater than 1 second in duration.
Using Match All Criteria toggled ON the below example would show all calls to 911 and all calls to 9911 but only if they have a duration greater than 1 second.
Example 3 – Multiple Search Types With Match All
In this example, there are 2 different Search Types and Values, which will be combined using a “Match All” approach.
Since the Match All Criteria is toggled on, this Search Set will find all calls which match both/all of the following Search Criteria values:
- Caller Number equals 1000
- Called Number equals 2000
With the following settings, this Search Set will only find calls which originated from Calling Party Number 1000 and were received by Called Party Number 2000.
Example 4 – Multiple Search Types With Match All And Wildcards
In this example, this Search Set will result in all call activity which matches all of the following:
- Originated from devices with installed on a Windows OS
- Originated from 4-digit Calling Party Numbers beginning with “2”
- Terminating to 11-digit phone numbers beginning with “011”
This type of Search Set would identify help identify internationally dialed number from a particular DN range (2000 – 2999).
The Called Number starts with 011XXXXXX contains 6 wild card digits using the “starts with” condition. This would match all Called Numbers at least 9 digits in length and begin with “011”, which is a typical dialing pattern for US based outbound international calling.
Webex Calling Search Type Dictionary
Originating Party
| Search Type Name | Description |
|---|---|
| Calling Party Number | Caller ID or DN of a person placing a call. |
| Calling Party User | The username of a Webex Calling user placing a call. |
| Calling Party Manager User | The manager associated to the user placing a call. |
| Calling Party Location | The location of the Webex Calling user placing a call. |
| Calling Party Client Type | The type of device the call came from. |
| Calling Party Client Version | The version of the device the call came from. This value will only be populated for Webex Calling users. |
| Calling Party OS Type | The operating system of the user the call was placed from. This value will only be populated for Webex Calling users. *ios *Linux *MAC *NA *Windows |
| Calling Party Device MAC Address | The MAC Address of the device the call was placed from. |
| Calling Party User Type | The type of user placing the call. *Automated Attendant Video *Anchor *Broadworks Anywhere *Voice Mail Retrieval *Local Gateway *Hunt Group *Group Paging *User *Voice Mail Group *Call Centers Standard *Voice XML *Route Point |
Terminating Party
| Search Type Name | Description |
|---|---|
| Called Party Number | Number which answered a call. |
| Called Party User | The username of a Webex Calling user receiving a call. |
| Called Party Manager User | The manager associated to the user receiving a call. |
| Called Party Location | The location of the Webex Calling user receiving a call. |
| Called Party Client Type | The type of Webex Calling device receiving a call. |
| Called Party Client Version | The version of the device receiving the call. This value will only be populated for Webex Calling users. |
| Called Party OS Type | The operating system of the user receiving the call. This value will only be populated for Webex Calling users. *ios *Linux *MAC *NA *Windows |
| Called Party Device MAC Address | The MAC Address of the device receiving a call. |
| Called Party User Type | The type of user receiving a call. *Automated Attendant Video *Anchor *Broadworks Anywhere *Voice Mail Retrieval *Local Gateway *Hunt Group *Group Paging *User *Voice Mail Group *Call Centers Standard *Voice XML *Route Point |
| Called Queue | The name of a call queue receiving a call |
Originating or Terminating Party
| Search Type Name | Description |
|---|---|
| Calling or Called Party Number | The Caller ID or DN of a person placing or receiving a call. |
| Calling or Called Party User | The username of a Webex Calling user placing or receiving a call. |
| Calling or Called Party Manager User | The manager associated to the user placing or receiving a call. |
| Calling or Called Party Location | The location of the Webex Calling user placing or receiving receiving a call. |
| Calling or Called Party Client Type | The type of Webex Calling device placing or receiving a call. |
| Calling or Called Party Client Version | The version of the device placing or receiving the call. This value will only be populated for Webex Calling users. |
| Calling or Called Party OS Type | The operating system of the user placing or receiving the call. This value will only be populated for Webex Calling users. *ios *Linux *MAC *NA *Windows |
| Calling or Called Party Device MAC Address | The MAC Address of the device placing or receiving a call. |
| Calling or Called Party User Type | The type of user placing or receiving a call. *Automated Attendant Video *Anchor *Broadworks Anywhere *Voice Mail Retrieval *Local Gateway *Hunt Group *Group Paging *User *Voice Mail Group *Call Centers Standard *Voice XML *Route Point |
Duration
| Search Type Name | Description |
|---|---|
| Call Duration (seconds) | The time duration during which the call was connected, in seconds |
| Ring Time (seconds) | The time duration during which the call was in the ringing state, in seconds |
| Queue Time (seconds) | Amount of time in a call queue in seconds |
Signaling
| Search Type Name | Description |
|---|---|
| Direction | The direction of the call. The possible values are *Originating *Terminating |
| Calling or Called Party Result | The end result of the calling or receiving side of the call. |
| Calling Party Result | The end result of the calling side of the call. |
| Called Party Result | The end result of the receiving side of the call. |
Call Identifier
| Search Type Name | Description |
|---|---|
| Call Identifier | The unique call identity value assigned to the call. |
Miscellaneous/Other
| Search Type Name | Description |
|---|---|
| Call Type | The call type per Webex Calling *SIP Meeting *SIP International *SIP Shortcode *SIP Inbound *Unknown *SIP Emergency *SIP Premium *SIP Enterprise *SIP Tollfree *SIP National *SIP Mobile |
Call Quality
| Search Type Name | Description |
|---|---|
| Audio Packet Loss | The percentage of audio packets lost during the call. |
| Audio Latency | The average audio latency of the call in milliseconds. |
| Audio Jitter | The average jitter of the call in milliseconds. |
| Video Packet Loss | The percentage of video packets lost during the call. |
| Video Latency | The average video latency of the call in miliseconds. |
Analytics
| Search Type Name | Description |
|---|---|
| Audio Packet Loss | The percentage of audio packets lost during the call. |
| Audio Latency | The average audio latency of the call in milliseconds. |
| Audio Jitter | The average jitter of the call in milliseconds. |
| Video Packet Loss | The percentage of video packets lost during the call. |
| Video Latency | The average video latency of the call in miliseconds. |
| Search Type Name | Description |
|---|---|
| Call Scenario Types | The type of record as defined by Variphy’s Call Scenarios. Additional information about Call Scenarios can be found here. |
