Model: data/Dashboard

Dashboards

Tip

Use the Action search to navigate Automate

Overview

Dashboards are a collection of configurable widgets on a single page that can serve as a default landing page and can also be made available on a user menu. The widgets can allow for the easy access of frequently used tasks and for a quick view - as a counter, table or chart - of data in the system.

Note

Where dashboard widgets show data, the hierarchy at which the dashboard containing the widget is displayed, will filter data values and counts accordingly in the respective widgets.
Dashboard fields showing the item hierarchy (similar to Located At) are updated only when a full sync runs. For example, if you've added users to the system and then moved them to a site, any charts, counters, or tables showing a count of users (at that site or at the system level), will only reflect the correct number of users once a full sync runs and not when simply refreshing the dashboard or widget in a real-time sync. In this case, until you run the full sync, the hierarchy fields for these users display on dashboard charts, tables, or widget counters as with no (empty) hierarchy value. See Dashboard Refresh.
Dashboards can also be accessed by URL links containing the dashboard name - in the following format:

/portal/#/admin/dashboard;name=<dashboard_name>

If <dashboard_name> contains spaces, use URL encoded spaces, e.g. :

/portal/#/admin/dashboard;name=Dashboard%20Call%20Groups

This link format allows support for cross-launching from portals where the name of the dashboard is known.

Administrator users with roles referring to access profiles that allow for the creation and update of dashboards, can design and add dashboards to menus. For details, see: the Dashboard Permissions section in Access Profiles.

Manage dashboards and widgets

Full HTML Help

Tip

Use the Action search to navigate Automate

Overview

Administrators can manage dashboards via the Dashboards link that is a part of the Role Configuration on the Role Management dashboard.

Add or edit a dashboard

Automate provides several configuration options for working with dashboards.

Add or edit

Name: Display name of the dashboard
Description: Provide a description for the dashboard for the Dashboards list view.
Hide Time Picker: By default, a time picker is available to filter dashboard data by start and end date. Any selected dates are reset when you log out. You can't specify a date in the future. Select the checkbox to hide the time picker.
Hide Datasource Selector: This setting applies in the case where multiple instances of a dashboard data type is available. Not enabling the setting on a widget allows for selection of a data source instance and updates widget data based on the selected data source. Enabling the setting implies that the data source set on the widget is always used. Also used with "Insights Netflow" deployment option. For details, contact VOSS.
Default Date Range: Select this option to open the date range picker and to set up a default date range for the dashboard. This range will then apply to widgets on the dashboard that use the date range picker.
Clone: Use the toolbar Clone icon to create a copy of the dashboard you're viewing. The cloned dashboard opens with the breadcrumb name appended with the text, [CLONE], and contains all the widgets of the source dashboard. The cloned dashboard name is the same as the original source dashboard name and can be modified as required.

Note

Dashboards with the same name can be available at different hierarchies. When such a dashboard is referenced, this first one found higher up from the administrator user's login hierarchy is selected.
Refresh Dashboard: Used to update synced data on the dashboard to reflect any system data changes.

Note

Dashboard widgets each also provide a similar Refresh button when hovering over the top bar of the widget - similarly to refresh individual widget data.
Lock: Used to lock the arrangement of widgets
Dashboard Settings: Toggles (shows/hides) the dashboard name, description, and properties.
Undo: Reverts the dashboard to the state of the last unlock. So, if the lock has been used even once on the dashboard, the unlock will always return the dashboard to the state it was after it was unlocked, even if multiple changes were done since. If the dashboard was never locked, Undo will lock it, forcing the user to unlock and create a snapshot point. This snapshot is the same as the uploaded dashboard. Note that the Undo functionality is currently under review.
Export: Exports one or more instances. Refer to Bulk Export of Model Data. Exported dashboards can then be modified and imported at a required hierarchy via the Import menu.
Compact Grid: Automatically optimizes the arrangement of widgets on the dashboard, given their current size.
Paste Widget: Pastes a widget you have selected, using the Copy Widget option on the widget menu, into the current dashboard. This allows you to copy widgets between dashboards.
JSON Edit: Used for editing the dashboard data in JSON. For details, refer to Manage Items.

Add or edit widgets

When a dashboard is added or updated, widgets can be added, removed or edited.

To add a widget, click the Add Widget toolbar icon; then, on the design form, either select the widget from the toolbar or from the provided list of icons:

To edit a widget on a dashboard, select the dashboard from the list and choose Edit from the widget's menu. The widget menu provides a number of operations.

Edit:
- Use the Edit icon from the widget menu to edit the current widget. refer to the details below on available edit options.
Clone:
- Use the Clone icon from widget menu to clone the widget on the dashboard. The clone can then be edited as required.
Delete:
- Use the Delete icon from the widget menu to remove the widget from the dashboard.
Copy Widget:
- Use the Copy Widget icon to copy the current widget in order to paste it into a dashboard using the dashboard Paste Widget menu item.
Export data:

Where a widget offers data in a compatible format, the Export data on the widget menu allows for a MS-Excel or comma-separated value (CSV) export to a file, as in the Number Status example below:
```
Status,Count
Used-Utility,6
Cooling,35
Used,63
Reserved,106
Available,3850
```
Note
- For widgets where the Resource is an Insights resource, the option to export All Records is not available.
- For 24.2 installations where the "Insights Netflow" deployment option was selected, widget Data Source dropdown fields also show Netflow. For details, contact VOSS.

Note

Not all widget options and possible combinations are covered in this document. The widget refresh option can be used to inspect the impact of an option. For assistance in creating widgets, you can also contact VOSS support.

Where a widget resource references data over a time period (such as transactions), the widget interface provides a time picker control to indicate and change the interval for the data shown on the widget.

Dashboard sync and refresh

A real-time sync process is running to maintain Automate and Insights databases in sync. After upgrade to release 24.2, dashboard management is available after 30 minutes, since the scheduled delta-sync process initially carries out a full sync and thereafter an incremental resource sync.

See: Insights Analytics in the Platform Guide.

Important

Dashboard fields showing the item hierarchy (similar to Located At) are updated only when a delta sync runs. For example, if you've added users to the system and then moved them to a site, any charts, counters, or tables showing a count of users (at that site or at the system level), will only reflect the correct number of users once a delta sync runs and not when simply refreshing the dashboard or widget in a real-time sync. Until the delta sync runs, the hierarchy fields for these users display on dashboard charts, tables, or widget counters as with no (empty) hierarchy value. See Dashboard Refresh.

Manage value mapping

Automate provides options to allow for custom, alternative field values of resources to be displayed in chart widgets by using the Value Mapping field.

This optional value is applied during the design of a widget and is typically used to present a more user-friendly field value in a chart widget, for example, to map the value of Cisco Codec Mappings originally: 0 to mapped: No Media Established.

The Dashboard Value Mapping page (data model: data/DashboardValueMapping) is available to provider administrators and higher to add, delete and manage mappings. The model contains the default individual mapping value: NO MAPPING.

The design of a mapping allows for the selection of an evaluation operator to apply to the original value as an input condition and then to provide the replaced value in accordance with the evaluation operator test result.

Evaluation operators that can be applied to the original field values are:

Regex
Greater than
Less than
Range (with "Max" and "Min" parameters)
Equals

Note

More than one original field value can be mapped to a single mapping key.
Updating existing mapping confurations have a refresh delay of 30 minutes.

Examples:

If name: Cisco Codec Mappings Equals 0, then the mapping key is No Media Established.
Microsoft 365 service plan mappings by matching Microsoft Entra ID values:
- If string ID Regex (^SPB$) matches, then mapping key is Microsoft 365 Business Premium.
- If string ID Regex (^O365_BUSINESS_PREMIUM$) matches, then mapping key is Microsoft 365 Business Standard.

Manage color mapping

Automate provides options to allow for custom, alternative display colors and icons of Automate Analyze resources to be displayed in table widgets by modifying the Field Type of the resource and by creating instances of a Dashboard Color Mapping. The mapping instance name is then selected in the Text Color Mapping and/or Cell Color Mapping dropdown lists under Table Options > Renderers when desiging a table widget.

The Field Type of the field needs to be set to one of:

Text
Traffic Light: an icon

Refer to the Format Type of the field in the Table topic above.

This optional mapped value is applied during the design of a widget and is typically used to present a more user-friendly color or icon in a table widget, for example, to map a range of field values to have a specified color.

The design of a mapping allows for the selection of an evaluation operator to apply to the original value as an input condition and then to render the replaced color in accordance with the evaluation operator test result.

Evaluation operators that can be applied to the field values are:

Regex : for fields with text or numeric values
Greater than : for fields with numeric values
Less than for fields with numeric values
Range (with "Max" and "Min" parameters): for fields with numeric values

The Dashboard Color Mapping page (data model: data/DashboardColorMapping) or Color Mapping link on the MVS-RoleManagement-Dashboard dashboard is available to provider administrators and higher to add, delete and manage mappings.

Examples:

If a Dashboard Color Mapping instance exists that matches the Regex .*00.*, then render the text as color: #ff0011.

The Render section of a table widget has a field with Field Type set to "Text" and the Text Color Mapping dropdown selection is the created Dashboard Color Mapping.

The table then displays the text the matching text accordingly.

If a Dashboard Color Mapping instance exists that maps the Regex value Ani, with the color: #fff200 and this instance is applied (selected under Chart Options) to a chart showing user first names that start with An, then names starting with Ani will be rendered in the chart mapping color:

Chart widgets

Full HTML Help

Tip

Use the Action search to navigate Automate

Overview

The following chart types are supported by the widgets.

Column Chart
Gauge Chart
Line Chart
Pie Chart
Chord Diagram Chart

When a chart widget is selected, it is also possible to switch to another widget format during the edit and design process.

The chart type can be updated from the Widget Type drop down. Changes are reflected in real-time during the design of a widget or by using the widget's Refresh icon.

Chart widget data settings

A common list of Data Settings are available for chart widgets:

Title: This text will display above the chart
Description: This text will show as a information pop-up when hovering over the circled i icon next to the Title.
Condition: The display of the widget on the dashboard can be controlled by entering a condition that resolves to boolean True or False, for example in accordance with enabled features, services, and devices as in the Global Settings. The conditions are in the form of system macros. See for example the macros listed under the Links topic below.
Data Source: Charts can access the Automate Analyzed and Assurance sources.
The Assurance data source is also available if an Arbitrator has been configured. See: Voss Assurance Arbitrators. If Assurance is selected, options are available to choose a Data Source Instance, since multiple instances can be configured. A selection of these can then also be made if Allow Data Source Selection is enabled.
Resource: In accordance with the selected Data Source, a dropdown list of resource items are available to be referenced in the chart, for example, for Automate Analyzed: Number Inventory, Cisco CUC User, Cisco UCM Phone, Microsoft O365 User.
Note
- Where the Data Source is Automate Analyzed, Automate provides an additional list of Resource instances that can be used to represent trends on a widget. For details, see Automate Dashboard Trends Resources.
- In accordance with the selected hierarchy during dashboard management, the real-time display of data will update according to the current hierarchy, so that a widget that for example shows a count of users, will show values in accordance with the selected hierarchy.
Important

For charts, the Resource data is accessed from an Automate Analyze database: reporter resources (data/ReporterResource). When creating charts for the first time prior to the first scheduled full sync, it will be necessary that a manual sync of the Automate Analyze database is carried out with the Automate database. This requires the execution of a Platform Command Line Interface command. Refer to the Dashboard Refresh section below.
Fields: In accordance with the selected Resource, one or more fields from the resource can be selected as items for the chart.
- Field Name: a dropdown of fields that belong to the Resource
For example, for Chord Diagram Chart (Sankey type in example below), the Transactions resource status and username field names can be selected to show the transaction success/fail breakdown by user:
- Friendly Name: a text field to provide the Field Name with a custom name
- Field Type: a read-only field that indicates the data type of the selected Field Name
- Operation: select the operation to be carried out on the Field Name. Refer to the example below showing: Grouping Count.
  
  Note
  
  A different operation can be applied to the same field. In the example below, average, minimum and maximum is applied to the transaction duration field:
  - Value Mapping: default is NO MAPPING, otherwise a selected value mapping to display the value on the chart widget. See Manage Value Mapping.
Filters:

Data referenced in widgets can also be filtered by selecting a:
- Field Name of the Resource
- Operation to be used to filter the values of the field selected by Field Name.
  
  The availability and function of the operators depends of the data type of the selected field name: text or integer. Select the required operation. For details on the filter options, see: Reference: Filter Options Availability and Definitions.
- Filter Value: value to be used by the selected Operation to carry out the filter.
Such filters this provide options to make use of a selection of the resource data in the widget.
Sorts: One or more Field Name entries can be added and used to carry out sorting by Sort Type: Ascending or Descending

Chart Options:

Available Chart Options can vary according to the selected chart widget type. For a detailed reference of chart options, see: Reference: Chart Options Availability and Definitions.
Drilldown options: see Reference: Drilldown Options and Conditional Syntax
Dashboard chart background colours are managed by the theme Panel Colour - see: Administration GUI Theme Customization Color Reference.

Chart widget example

As an example, consider the following column chart values, with charts illustrating various data and chart settings:

Title: CUCM User Departments
Resource: Cisco UCM User
Field Name: Department
Operation: Grouping Count

Shows a column chart with counts of grouped Cisco UCM User departments in columns.
Filter:
- Field name: department
- Operation: Exclude Regex (Case sensitive)
- Filter Value: SITE
Filter:
- Field name: department
- Operation: Exclude Regex (Case sensitive)
- Filter Value: LOC
Filter:
- Field name: department
- Operation: !=
- Filter Value:
Sorts:
- Field Name: department
- Sort Type: Ascending
Chart Options:
- Series Limit: All
- Stack Type: Normal

The examples below show the chart with settings on some of the properties as not set or set in the example above:

Unfiltered, unsorted (related settings above are not set):
Filtered, sorted, stacked (related settings above are set):

Counter widgets

Full HTML Help

Tip

Use the Action search to navigate Automate

Counters are typically used to provide a quick count of a resource, and have the option to display a list view of the values when selecting the counter.

Note

Counter values reflect the hierarchy at which the counter is viewed.

Condition: The display of the widget on the dashboard can be controlled by entering a condition that resolves to boolean True or False, for example in accordance with enabled features, services, and devices as in the Global Settings. The conditions are in the form of system macros. See for example the macros listed under the Links topic below.
Data Source: Insights or Automate
Resource: only available for Insights
Fields: For Insights resources, one or more instances of Field Name can be selected in counters. These field names will then be shown as individual counters in a set of counters. An Operation can be selected for these in order to modify the counter.

For example, if a Field Type is "Text" and has duplicate values, and the Operation on the field is:
- Grouping Count, then counters will be shown grouping the duplicate fields into separate totals.
Alternatively, where Resource provides values for Field that have a Field Type of "Integer", additional Operation options are available that apply to integers, for example:
- Avg: a ratio of the current field over a total, for example, users with MS Teams Voice over total users
- Sum: for example, the sum total users with MS Teams Voice
The User Overview dashboard counters can for example be inspected to see the application of operations on integer fields.

Counters can also for example show a count that is grouped by additional fields. Consider a counter with:
- Data Source: Insights
- Resource: Multi vendor user count view
- Field Name, Field Type, Operation: count_data_users, Integer, Count
- Field Name, Field Type, Operation: Provider, Text, Group By
- Field Name, Field Type, Operation: Customer, Text, Group By
The counter displays the number of users as grouped by each Provider-Customer

When a counter widget is selected, it is also possible to switch to another widget format during the edit and design process. The Widget Type can be updated from the dropdown. Changes are reflected in real-time during the design of a widget or by using the widget's Refresh icon.
One or more Filters can be applied to a selected Field Name, using an Operation and Filter Value.

Examples for Resource = "Cisco UCM User":
1. Settings:
  - Fields - Field Name: "firstName", Operation: "Grouping Count"
  - Filters - Field Name: "firstName", Operation: "Regex (Case sensitive)", Filter Value: ^An.
  The resulting counter shows grouped counts of the first names of Cisco UCM users where the first name starts with "An" (case-sensitive).
  
  If for Fields above, the Operation was "Count", then a single value of the total of all users with first name starting with "An" (case-sensitive) would display in the counter.
2. Settings:
  - Fields - Field Name: "userid", Operation: "Count"
  Then:
  - Filters - Field Name: "userid", Operation: "LIKE (Case sensitive)", Filter Value: alf%.
    
    The resulting counter shows a count (4 - see image below) of the userid's that start with "alf" (case-sensitive).
  Or:
  - Filters - Field Name: "userid", Operation: "ILIKE (Case insensitive)", Filter Value: alf%.
    
    The resulting counter shows a count (5 - see image below) of the userid's that start with "alf" (case-insensitive), which is larger, given data as in the example image of userids below.
Note

The Filter Value can contain % characters, indicating variable string values at the position of the % character. For example: %alf% will match norman.alfred; alf% will match alfred.norman and %alf will match norman.fredalf.
Type: only available for Automate resources. This is the selected model type (e.g. data/Countries). A Title, Icon, Field Display Policy, Condition and Configuration Template can also be applied to the selected model type.
Filters: For Insights resources, field names can be selected and a matching operator selected to apply to the name in order to filter a counter value (as in the example under Fields above). For Automate resources, see the topic Fixed and Configurable Filters in Counters and Links - that will then be applied when the counter is selected to open the filtered list view.
Counter Settings: a limit on the value can be specified, prefix and suffix text can be inserted for the value, as well as default values for empty groups.

Links widgets

Full HTML Help

Links are typically used to offer shortcuts to targets: data or URLs. The data is available from Automate models in the Type drop-down.

Link Text and Icon can be entered to display the link

Condition : a condition that evaluates to true or false, in Automate macro syntax, for example, for enabled features:

{{ macro.is_avaya_enabled }}
{{ macro.is_cisco_ccx_enabled }}
{{ macro.is_cisco_cucm_enabled }}
{{ macro.is_cisco_cucx_enabled }}
{{ macro.is_cisco_microsoft_enabled }}
{{ macro.is_cisco_webex_enabled }}
{{ macro.is_cisco_webex_teams_enabled }}
{{ macro.is_cisco_zoom_enabled }}
{{ macro.is_microsoft_enabled }}
{{ macro.is_pexip_enabled }}
{{ macro.is_session_border_control_enabled }}
{{ macro.is_voss_phones_enabled }}
{{ macro.is_zoom_enabled }}

Where widgets are not shown in accordance with the Condition evaluation of the widget, the dashboard arrangement is updated accordingly to auto compact the visible widgets.

Display As:
- External Link - then Href is an URL
- Form and List - when Type is selected, this indicates the display format
- Dashboard - when a dashboard is selected from the Dashboard dropdown, Href and Type are hidden and a Dashboard drop-down list is available to select a target dashboard for the link.
Field Display Policy and Configuration Template can be applied to the selected Type.
See also the topic Fixed and Configurable Filters in Counters and Links.

Note

A dashboard link cannot launch another dashboard.
For long lists of links, scroll bars show on the form to show all items within the widget. It is recommended to split such long lists into separate Link widgets in order to remove the need for scroll bars.

Fixed and configurable filters in counters and links

Fixed Filters

High-level administrators can add and modify pre-defined Fixed Filters to Counters and Links. This option also shows on design input forms and presents the same interface options as Configurable Filters.

These filters will always apply when the widget is used. Fixed filter results can however be filtered further by Configurable Filters.

Configurable Filters

When configuring a widget open the filter configuration dialog, where you can add one or more configurable filters.

Adding more than one filter using the Add option results in a logical AND of the filter application.

The table describes the Configurable Filters fields:

Filter By	Attributes of the selected Type can be selected from the drop-down list.
Filter Type	Select the matching operator to apply when the attribute is matched to the Filter String value: Contains Does Not Contain Starts With Ends With Equals Not Equal
Filter String	Select the value that the matching operator should match by.
Ignore Case	This checkbox defines whether to ignore the case of the Filter String value.

Once you've applied the configurable filters, selecting the counter or link in the GUI triggers a pop up Filter dialog before rendering the list view, where you can apply or modify the filter before displaying the page related to the counter or link.

If a Filter String value is entered on Configurable Filters, this value can also then be accepted or modified in the Filter dialog.

The list view of the results footer row indicates that a filter has now been applied to the list and this filter can then be further modified and removed from the list view as usual. See Ordering Lists

Table widgets

Full HTML Help

Overview

Condition: The display of the widget on the dashboard can be controlled by entering a condition that resolves to boolean True or False, for example in accordance with enabled features, services, and devices as in the Global Settings. The conditions are in the form of system macros. See for example the macros listed under the Links topic.
Data Source: Automate, Automate Analyzed and Assurance sources can be accessed.

Available menus and fields upon Data Source selection:

Automate Analyzed
- Resource options available in accordance with the Insights database
  
  Automate provides an additional list of Resource instances that can be used to represent trends on a widget. For details, see Automate Dashboard Trends Resources.
- Fields: select fields from the resource to show in the table
- Filters: filter field values from the table
- Sorts: order the table (ascending, descending) by a selected field value
Automate: Model Type, Field Display Policy, Configuration Template
Assurance: if selected, options are available to choose a Data Source Instance, since multiple instances can be configured. A selection of these can then also be made if Allow Data Source Selection is enabled. For Arbitrator configuration, see: Voss Assurance Arbitrators.
Table Options are available for both data sources.
- Options to limit, show, hide or format table data and elements
- Additional field display customization using Renderers for fields, including a Hide Column option (if the column is for example only used for filtering purposes).
Drilldown options: see Reference: Drilldown Options and Conditional Syntax

Besides standard menu options, a displayed table can also show additional menu options in accordance with enabled features such as:

Description (circled i icon)
Drill-down (lightning bolt)
Filter (funnel icon)

When a table widget is selected, it is also possible to switch to another widget format during the edit and design process. The Widget Type can be updated from the dropdown. Changes are reflected in real-time during the design of a widget or by using the widget's Refresh icon.

Table widget example with Select Query and Partition By

The example below shows a table widget configuration using an Automate Analyzed resource, with Select Query and Partition By operations on fields, as well as a Filter on one of the fields. Consider the following Data Settings:

Resource: Cisco UCM User
Fields:
- Site. Operation: Select Query
- firstName. Operation: Partition By
- firstName. Operation: Select Query
Filters
- firstName. Operation: Regex (Case sensitive), Filter Value: ^Be

In this case, sites and user first names are selected where first names are used to

Table widget example with drill-down

The example below shows a table widget configuration using an Automate Analyzed resource, the resultant output display and also a drill-down result.

Configuration

Resource: Cisco CUC User
Fields:
- Playback volume (integer) is selected as a table column and similar values are grouped using Operation: Grouping Count
- The user's DisplayName is as a table column
Filters
- DisplayName values containing regex CFT are excluded with a filter.
Sorts: no sorting is done on any column.
Table Options
- Series Limit: left at default All so no restriction on the number of values to show.
- Over Time: For table data containing timestamp columns, this option can be enabled to expose a Use Over Time Day Pagination checkbox and an Interval dropdown so that table paging of data can be grouped and the paging range can be shown according to the selected interval.
- Hide Count Column: enabled so an additional column containing the Count is not shown.
- Hide Index Column: enabled so an additional first column containing an index value (row number) is not shown.
- Selection Type: left at default so that a table entry selection selects an entire row.
- Renderers: the Volume field configured so that its integer value has Suffix: %.
Other Renderers options:

A field on a table can also be modified if the Resource is Automate Analyze:
- Format Type = Default: field type remains as defined (default)
- Format Type = Text: field value rendered as text - allows for a default theme-related color mapping of text (Text Color Mapping) and table cell (Cell Color Mapping) to apply.
  
  Contact VOSS if a custom color mapping is required.
- The Font Size and Font Weight can also be set here if the Format Type of a field is Text.
- Column Alignment: for text - to override the table alignment for the selected field.
- Prefix and Suffix: for text and numbers - options to add a string prefix or suffix to the field value.
- Format Type = Traffic Light: field value replaced by a "traffic light" colored icon - allows for default theme-related color mapping.
- Format Type = Tick Cross: field value replaced by a "cross" (X) colored icon - does not allow for color mapping.
- Format Type = Number: number-specific options are available:
  - Number Type:
    - Default: standard value: 2 decimals
    - Abbreviation: no decimal
    - Bandwidth and Throughput: additional options to specify Bit/Bite type
    - No Format: e.g. no thousands comma
  - Float Precision: for float numbers, the decimal precision (default = 2)
  - Factor: multiply the value by a factor (default = 1)
- Hide Column: hide the field column on a table (e.g. if the field is used for calculation, other purposes)

Drill-down options
- Filter Options: set to IN so that a drill-down display contains DisplayName.
- Drilldown Options: selecting a row - the choice will Link to Automate Resource specified as Type
- Type: the Automate resource type: selected the related Automate resource: relation/Voicemail.
- Drilldown Fields: the field to highlight in the table as a drill-down link: selected DisplayName.
Output

The table shows 2 columns:
- Volume values with % suffix
- DisplayName with drill-down link
Drill-down result

Selecting a row link from the table shows the item as listed in the selected Drilldown Options.

Text Widgets

Full HTML Help

A widget is available to show text on a dashboard.

Condition: The display of the widget on the dashboard can be controlled by entering a condition that resolves to boolean True or False, for example in accordance with enabled features, services, and devices as in the Global Settings. The conditions are in the form of system macros. See for example the macros listed under the Links topic.

The input format can be either HTML or Markdown. The editor Preview menu option allows for a formatted preview of the text format in the Content input box.

Example Text widgets (HTML):
Example Text widgets (Markdown):
Text widgets can be used to create headings, for example:

Design:

Display:

Dashboards for a Business Admin Role

Full HTML Help

VOSS Automate provides a set of dashboards, menu layouts, and field display policies that are used in two sample menu layouts - for use or customization as a Business Administration Portal menu layout to be added to a user's role.

Example dashboards - Business Admin Role

Example - Call Groups setup and display

Example - display of Number Management dashboard

Dashboard names grouped by sample menu layout names The following lists are the dashboard names grouped by the provided sample menu layout names.

Field Display Policies

Field display policies with customer_admin in their names are also provided and used for some of the links in the dashboards.
Field display policies with BusinessAdmin in their names are also provided and used for some of the links in the dashboards.

Dashboards: MenuSiteAdmin

Dashboard Number Management
Dashboard MV Subscribers
Dashboard Phones
Dashboard Headsets
Dashboard Voicemail
Dashboard Collaboration
Dashboard Conferencing
Dashboard Contact Center
Dashboard Call Groups
Dashboard MS Exchange
Dashboard Tools

Dashboards: MenuCustomerAdmin

Dashboard Site Management
Dashboard Number Management
Dashboard MV Subscribers
Dashboard Phones
Dashboard Headsets
Dashboard Voicemail
Dashboard Collaboration
Dashboard Conferencing
Dashboard Contact Center
Dashboard Call Groups
Dashboard MS Exchange
Dashboard Tools

Dashboard Reference

Full HTML Help

Automate Dashboard Trends Resources

For the Data Source: Automate Analyzed, VOSS provides additional list of Resource instances that can be used to represent trends on a widget.

Note

Currently, trends resources themselves cannot be managed (added, modified). Only existing, provided trends resources can be used on a dashboard.
A trend resource requires associated data to be available in the system. For example, to use the Cisco UCM Phone Trend Metrics resource, Cisco UCM phones need to be present on your system.

Trends resources have the following properties:

Frequency: how often data is recorded, for example: Daily or Weekly.
Retention period: how long data is retained in the database for trend purposes. The retention period for all provided trend resources is: 3 months.
Filters: a list of data resources processed. For example, Multivendor Subscribers would include Microsoft Licensed Users, Cisco UCM Users, Webex Calling in Webex App Users and so on.

The available trends resources and their properties are indicated below:

Cisco UCM Phone Trend Metrics
- frequency: daily
- retention period: 3 months
- filters:
  - Total Phones
Multivendor Subscriber View Trend Metrics
- frequency: daily
- retention period: 3 months
- filters:
  - Total Users
  - Licensed Users
  - Voice Users
  - Microsoft Licensed Users
  - Microsoft Teams Collaboration Only Users
  - Microsoft Teams Phone System Users
  - Microsoft Teams Users with LineURI configured
  - Microsoft Email Exchange Users
  - Webex Calling in Webex App Users
  - Webex Calling in Webex App (Unified CM) Users
  - Cisco UCM Users
  - Cisco Extension Mobility Users
  - Cisco Unity Connection Users
Number Inventory Trend Metrics
- frequency: daily
- retention period: 3 months
- filters:
  - Total Numbers
  - Available Numbers
  - Used Numbers
  - Reserved Numbers
  - Cooling Numbers
  - Cisco Numbers
  - Microsoft Numbers
  - Webex Numbers
  - Non-vendor Numbers
Site Trend Metrics
- frequency: weekly
- retention period: 3 months
- filters:
  - Total Sites

Filter Options Availability and Definitions

The operators below are available as filter options for Insights resource field types:

Text

LIKE (Case Sensitive) - based on the pattern entered in the filter field, will return the data that matches the pattern from the extracted string. This function is case sensitive. An underscore (_) in the pattern indicates matches any single character while a percentage sign (%) indicates matches any sequence of zero or more characters.
NOT LIKE (Case Sensitive) - based on the pattern entered in the filter field, will return the data that does not match the pattern from the extracted string. This function is case sensitive. An underscore (_) in the pattern indicates matches any single character while a percentage sign (%) indicates matches any sequence of zero or more characters.
ILIKE (Case Insensitive) - based on the pattern entered in the filter field, will return the data that matches the pattern from the extracted string. It is not case sensitive. An underscore (_) in the pattern indicates matches any single character while a percentage sign (%) indicates matches any sequence of zero or more characters.
NOT ILIKE (Case Insensitive) - based on the pattern entered in the filter field, will return the data that does not match the pattern from the extracted string. This function is not case sensitive. An underscore (_) in the pattern indicates matches any single character while a percentage sign (%) indicates matches any sequence of zero or more characters.
Equals (=) - based on the pattern entered in the filter field, will return the data that is equal to the pattern from the extracted string.
Not Equal (!=) - based on the pattern entered in the filter field, will return the data that is not equal to the pattern from the extracted string.
IN - based on the pattern entered in the filter field, will return the data that exists within a comma separated list, i.e. 1, 2, 3, 4.
NOT IN - based on the pattern entered in the filter field, will return the data that does not exist within a comma separated list, i.e. 1, 2, 3, 4.
REGEX (Case Sensitive) - utilizes POSIX Regular Expressions to extract data. It is case sensitive.
REGEX (Case Insensitive) - utilizes POSIX Regular Expressions to extract data. It is not case sensitive.
EXCLUDE REGEX (Case Sensitive) - utilizes POSIX Regular Expressions to extract the data that does not match the pattern. It is case sensitive.
EXCLUDE REGEX (Case Insensitive) - utilizes POSIX Regular Expressions to extract the data that does not match the pattern. It is not case sensitive.

Integer

Less Than (<) - based on the value entered in the filter field, will return the data that is less than the value from the extracted string.
Greater Than (>) - based on the value entered in the filter field, will return the data that is greater than the value from the extracted string.
Less Than or Equal (<=) - based on the value entered in the filter field, will return the data that is less than or equal to the value from the extracted string.
Greater Than or Equal (>=) - based on the value entered in the filter field, will return the data that is greater than or equal to the value from the extracted string.
Equals (=) - based on the value entered in the filter field, will return the data that is equal to the value from the extracted string.
Not Equal (!=) - based on the value entered in the filter field, will return the data that is not equal to the value from the extracted string.
IN - based on the values entered in the filter field, will return the values that exists within a comma separated list, i.e. 1,2,3,4.
NOT IN - based on the values entered in the filter field, will return the values that does not exist within a comma separated list, i.e. 1,2,3,4.
REGEX (Case Sensitive / Insensitive) - utilizes POSIX Regular Expressions to extract data.
EXCLUDE REGEX (Case Sensitive / Insensitive) - utilizes POSIX Regular Expressions to extract the data that doesn't match the pattern.

Chart Options Availability and Definitions

Chart Option Definitions:

Series Limit: Maximum number of groups to display on a chart.
- All: (default) show all values
- <number>: show maximum <number> values
Description: Allows you to enter a description of the chart to be displayed along the top portion of the chart.
Chart Color Mapping: Available when a Chord Diagram Chart widget type is selected.
Label and Legend font weight and size: font formatting is available for chart labels and legends.
Chord Diagram Type: Available when a Chord Diagram Chart widget type is selected. Sankey (chords in a flat diagram) or Dependency Wheel (chords in circular diagram) are available as diagram types for this widget.
Over Time: By selecting this check box the chart will display the data over the specified time based on the Interval, i.e. Minute, Hour, Daily, Weekly and Monthly.
Interval: Used by Over Time: Minute, Hour, Daily, Weekly and Monthly.
X Title: Text label displayed along the bottom of the X axis of column and line charts.
Y Title: Text label displayed along the bottom of the Y axis of column and line charts.
Is Stacked: By selecting this check box the chart will stack values by Stack Type.
Stack Type: Only for column charts. By selecting this box the chart will stack the values based on the type selected:
- None: (default) no stacking; individual columns for data
- Normal: data stacked into a single column, color coded with values
- Percentage: data stacked into a single column, color coded with percentages
Numeric Precision: Select the decimal precision displayed for each point.
Is Horizontal: By selecting this check box, the chart will display the columns/bars horizontally across the chart.
Is 3D: By selecting this check box, column charts and pie charts will be displayed in a 3D representation.
Show Labels: By selecting this check box, each value that defines the chart will be labeled on the chart.
Show Legend: By selecting this check box, the Field Definition for the values being charted will be displayed in the selected position on the chart with the associated color representation.
Gauge Label: Labels the middle of the gauge with value from field extraction.
Min and Max: Place the starting value (Min) and the ending value (Max) for the gauge needle to traverse, e.g. start at 0 and end at 60,000.
Label Inside: By selecting this check box the value will be labeled with the definition based on the field extraction.
Show Bands: By selecting this check box then the gauge will have a maximum of 3 colored bands indicating certain severity levels. These are user defined thus a good, minor and major severity can be easily defined based on the data elements extracted. Simply place values for each color in the associated box to represent the percentage of the gauge band that color is to occupy. Tip: Make your major issue (Red) 100 thus simply modifying the good and minor automatically recalculates the major.
Is Doughnut: A pie chart is displayed with a hole in the middle.
Show Numbers: A pie chart by default shows slices as a percentage. Use this option to instead show the values of the percentage.

Available Chart Options vary according to the chart type:

Chart Option	Column Chart	Gauge Chart	Line Chart	Pie Chart
Series Limit	X		X	X
Description		X	X	X
Over Time	X		X
Interval	X		X
X Title	X		X
Y Title	X		X
Is Stacked			X
Stack Type	X
Numeric Precision	X
Is Horizontal	X
Is 3D	X			X
Show Labels	X		X	X
Show Legend	X		X	X
Gauge Label		X
Min		X
Max		X
Label Inside		X
Show Bands		X
Is Doughnut				X
Show Numbers				X

Drilldown Options and Conditional Syntax

Drilldown Options

Filter Options: apply to field value match of a selection of the chart or table data (IN, REGEX)

For example, if Filter Other Widgets is selected, then IN will match "Ann" exactly in other widgets and REGEX will match "Ann", "Anne", "Annie".
Drilldown Options: the behavior when selecting an item in a chart or table
- None (default)
- Filter Other Widgets: a selected drilldown item will update any other widget that also references the same data instance.
  
  For example a drilldown on a CUC user table where this is enabled, will similarly impact widgets such as charts, counters and tables related to CUC users, so that these widgets will then reflect data from only the single user from the drilldown.
  
  In the example below, the chart widget called CUCM User count by Dept has the Filter Other Widgets drilldown filter enabled, so that for example selecting a department from the chart also filters the CUCM Users count per site chart to only show users at sites belonging to the selected department. The department filter (here: department contains 'Cats Beauty') is also displayed when the filter is active.
- Link to Another Dashboard
  
  Used to open another existing dashboard during drilldown. A Dashboards dropdown shows to select the other dashboard. Navigation can then be carried out from the linked dashboard to the parent dashboard:
- Launch Third-party URL
  - Launch a system URL in the system portal. The format of the input is an endpoint relative to the portal: https://<hostname>/portal/. For example, if the value entered is #/admin, then the drilldown will launch the admin home page dashboard: https://<hostname>/portal/#/admin.
  - Launch an external, non-system URL in the system portal (if allowed). The format of the input is the full external URL: https://<eternal-host>
- Conditional Drilldown
  
  Provides a Conditional Drilldown input box into which a JSON formatted condition can be entered. For details on the format, see Conditional Drilldown Format below.
Drilldown Fields:
- Field Name: if multiple Field values were added for a Resource, select a field for the drilldown.

Conditional Drilldown Format

When selecting the Conditional Drilldown option, the condition needs to be entered in JSON format into the input box. This section provides syntax details and examples for this configuration.

If an item matching the condition is selected from the dashboard, the conditional drilldown is then carried out.

The JSON format is outlined below.

If conditions are all met
then carry out actions
else Defaults ("default...")

Structure:

{
  "conditions": [],
  "actions": [],
  "defaultDrilldown": 1,
  "defaultDashboardId": "",
  "defaultUrl": "",
  "defaultFilterFields": []
}

conditions:

conditions: list of conditions on rules.
- id: "integer" - zero-based
- name: "text" - condition name
- type : "OR" or "AND"
  - conditions.type: "AND" means action will be taken when all conditions are met.
  - conditions.type: "OR" means action will be taken when one condition is met.
rules:

rules: list of rules:
- ruleid: "integer" - zero-based
- field: "integer" - zero-based
  
  Field order in the drilldown tab (0 base)
- fieldType: "text", "integer" or "float"
- operator: "==", "!=", "<=", ">=", "<", ">" or "regex"
- operator: "==", "!=", "<=", ">=", "<", ">" or "regex"
  - fieldType text operator choices: "==", "!=", "regex"
  - fieldType integer and float operator choices: "==", "!=", "<=", ">=", "<", ">"
- value: value of the field; according to fieldType: "text", "integer" or "float"
actions:

List of actions:
- drilldown: "integer"
  - Drilldown type:
    - 1 (drilldown to other widgets)
    - 2 (drilldown to other dashboard: dashboardid)
    - 4 (drilldown to external link: url)
- dashboardid: "text"
  
  The ID is available as dashboard_id URL parameter value when on a dashboard.
- url: "text"
  
  The value is a URL containing position variables for filterFields references, whose values in turn are substituted into the URL. The position variables are one based, for example:
  
  "url": "https://{1}/ui/index.html?{2}"
  
  refers to the first and second filterFields list entries, which in turn take the format
  
  "filterFields": [0,1]
  
  The value of the first filterFields entry is therefore for example substituted into the URL variable {1} above.
- filterFields: list of fields ("integer" = index number)
  
  Field order in the drilldown tab (0 base)
Defaults:
- defaultDrilldown: "integer"
- defaultDashboardid: "text"
- defaultUrl: "text"
- defaultFilterFields: list of fields ("integer" = index number)
  
  Field order in the drilldown tab (0 base)

Examples

Drilldown to other widgets

Explanation:

If 7th field ("field": 6) data != 0 and 6th field ("field": 5) <= 0 then
- run action drilldown to other widgets ("drilldown": 1)
  - using filter values of first, second and 4th field ("filterFields": [0,1,3]).
If the condition is not met, then
- run default action which is drilldown to other widgets ("defaultDrilldown": 1)
  - using filter values of first and second field.

JSON:

{
  "conditions": [
    {
      "id": 0,
      "name": "first_condition",
      "type": "AND",
      "rules": [
        {
          "ruleid": 0,
          "field": 6,
          "fieldType": "integer",
          "operator": "!=",
          "value": "0"
        },
        {
          "ruleid": 1,
          "field": 5,
          "fieldType": "float",
          "operator": "<=",
          "value": "0"
        }
      ],
      "actions": [
        {
          "drilldown": 1,
          "dashboardid": "",
          "url": "",
          "filterFields": [
            0,
            1,
            3
          ]
        }
      ]
    }
  ],
  "defaultDrilldown": 1,
  "defaultDashboardId": "",
  "defaultUrl": "",
  "defaultFilterFields": [
    0,
    1
  ]
}

Drilldown to other dashboard

Explanation:

If second field data is "keller, texas" or 5th field is "TX" then
- run action drilldown to other dashboard ("drilldown": 2, "dashboardid":...)
  - using filter values of first, second and 4th field.
If the condition is not met, then
- run default action which is drilldown to other widgets
  - using filter values of first and second field.

JSON:

{
  "conditions": [
    {
      "id": 0,
      "name": "first_condition",
      "type": "OR",
      "rules": [
        {
          "ruleid": 0,
          "field": 1,
          "fieldType": "text",
          "operator": "==",
          "value": "keller, texas"
        },
        {
          "ruleid": 1,
          "field": 4,
          "fieldType": "text",
          "operator": "==",
          "value": "TX"
        }
      ],
      "actions": [
        {
          "drilldown": 2,
          "dashboardid": "M2OQQMVN3IWI1O2P1686581558847Y2FRT98M8V24GS",
          "url": "",
          "filterFields": [
            0,
            1,
            3
          ]
        }
      ]
    }
  ],
  "defaultDrilldown": 1,
  "defaultDashboardId": "",
  "defaultUrl": "",
  "defaultFilterFields": [
    0,
    1
  ]
}

Drilldown to external link

Explanation:

If second field data is "keller, texas" or 5th field is "TX" then
- run action drilldown to other external link
  - using filter values of first and second field.
If the condition is not met, then
- run default action which is drilldown to other widgets
  - using filter values of first and second field.

JSON:

{
  "conditions": [
    {
      "id": 0,
      "name": "first_condition",
      "type": "OR",
      "rules": [
        {
          "ruleid": 0,
          "field": 1,
          "fieldType": "text",
          "operator": "==",
          "value": "keller, texas"
        },
        {
          "ruleid": 1,
          "field": 4,
          "fieldType": "text",
          "operator": "==",
          "value": "TX"
        }
      ],
      "actions": [
        {
          "drilldown": 4,
          "dashboardid": "",
          "url": "https://{1}/ui/index.html?{2}",
          "filterFields": [
            0,
            1
          ]
        }
      ]
    }
  ],
  "defaultDrilldown": 1,
  "defaultDashboardId": "",
  "defaultUrl": "",
  "defaultFilterFields": [
    0,
    1
  ]
}

Data model for user dashboards.

Model Details: data/Dashboard

An asterisk * in the title indicates the field is mandatory.
If a field has a default value, it is shown in the Description column.
If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
Object and array field names are listed to provide context. If a field belongs to an object or an array, the full field name is shown in dot separated notation.

Title		Description	Details
Dashboard Settings		Group Assigned by FDP	Field Name: Dashboard Settings Type: Object
	Name *		Field Name: Dashboard Settings.name Type: String
	Description		Field Name: Dashboard Settings.description Type: String
	Hide Time Picker		Field Name: Dashboard Settings.hide_time_picker Type: Boolean
	Hide Datasource Selector		Field Name: Dashboard Settings.hide_datasource_selector Type: Boolean