[Index]

Model: data/Dashboard

Dashboards

Full HTML Help

Overview

Dashboards are customizable pages made up of widgets that provide quick access to frequently used tasks and data visualizations. They can serve as default landing pages or be added to user menus.

Widget types

Dashboards can include:

• Counters: Show numerical data

• Tables: Display structured data

• Charts: Visualize trends and metrics

• Links: Provide quick navigation to other pages

• Text: Add notes or instructions using Markdown or HTML.

  Note

  Text widgets may also use dynamic content, allowing them to display data-driven information. See Text widgets.

Related topics

• Text widgets

Data filtering and sync behavior

• Widget data values and counts are filtered based on the hierarchy level where the dashboard is viewed.
• Dashboard fields showing the item hierarchy (similar to "Located At") update only after a full sync and not during real-time refreshes. For example, if users are added and moved to a site, any dashboards (at system or site level) won't reflect the change until a full sync is run. Refer to Dashboard Refresh.

Standalone reporter resources (time-series data)

Some Insights reporter resources (data/ReporterResource) are configured as standalone resources (standalone_resource: true) and read from dedicated MongoDB collections. For example, Microsoft Teams Room Calendar (device/msgraph/CalendarView) and Webex Workspace Metrics (device/spark/WorkspaceMetrics) models represent frequently collected, time-series data that is append-only in the database (and therefore updates vs new rows in the database), for dashboards and calculated fields. The population of data for these resources is driven by the sync-check schedule (typically once per day, configurable), which means the data won't appear immediately after it's collected.

Syncs relevant to standalone resources:

• insights-voss-sync: Creates and updates the database tables
• sync-check: Populates the database

Configuring these models as standalone reporter resources enables:

• Efficient ingestion of high-volume time-series data
• Faster dashboard performance (due to partitioning)
• Simpler sync logic (append-only)
• Cleaner separation between standard resources and collected metrics

This functionality is especially useful for:

• Meeting room calendar events
• Webex workspace utilization
• Any time-based telemetry

Requirements

• Collecting data from device/msgraph/CalendarView requires a Microsoft tenant configured.
• Collecting data from device/spark/WorkspaceMetrics requires a Webex app configured.

Related topics

• Introduction to Meeting Rooms Management

Dashboard access

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

Manage dashboards and widgets

Full HTML Help

Overview

Administrators can manage dashboards via the Dashboards link on the Role Based Access dashboard.

Add or edit a dashboard

Automate provides several configuration options for working with dashboards.

• 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.

  When the time picker is visible, widgets that support date filtering, including dynamic text widgets, update their content based on the selected date range.

• 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.

  This default range applies to any widget that supports date-based filtering, including dynamic text widgets.

• 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 that support refresh - such as charts, tables, counters, and dynamic text widgets - update their content when the dashboard is refreshed. A widget Refresh option displays only for widgets that can be refreshed (for example, dynamic text widgets).

• 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. See also Dashboard export and scheduling

• 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.

• Export Dashboard Data: Used to export the data available in the widgets of a dashboard: in CSV or MS Excel format. The exported data contain header rows labelled with the friendly names of the data field names and is then available for off-line use.

  Where multiple widgets are available on a dashboard, widget data is exported as either a CSV file or as a sheet in a MS Excel workbook. All the CSV files are archived in a .zip file. The export filenames follow the following convention:

  Export_<dashboard-name>_data_<all|displayed>_<timestamp>.<zip|xlsx>

  The available export options are determined by the Data Source of the widgets on the selected dashboard:

  • If there is a widget with Data Source as Automate present, only two export options will be available:

    • CSV - Displayed records
    • Excel - Displayed records

    This means that exported data will reflect the displayed records as per current Time Picker interval.

  • If all widgets have Data Source set to Automate Analyzed , Netflow or Assurance, there will be four export options:

    • CSV - Displayed records
    • CSV - All records
    • Excel - Displayed records
    • Excel - All records

    Selecting an "All records" option will include all available data, regardless of the selected Time Picker interval.

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.
  • Dynamic text widgets support data export.
  • For 24.2 installations where the "Insights Netflow" deployment option was selected, widget Data Source dropdown fields also show Netflow. For details, contact VOSS.

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.

The widget edit interface also provides a Use widget date range option so that the date range selected in the widget is applied and overrides the general dashboard date range setting.

Fields common to widgets

A number of fields are available across widget types. Details of some common field types are provided here.

• Custom Fields

  Custom or calculated fields can be defined and added to chart, table and text widgets.

  • For chart and table widgets, fields from the resource can be used as input for custom fields.
  • For text widgets, if Dynamic Content is enabled, a Data Source and Resource can be selected so that fields from this resource can be used as input for custom fields.
  • Note that these fields are calculated or created on the fly and are not stored.

  For number columns, numeric operations available on the input fields are:

  • Sum (column)
  • Average (column)
  • Max (column)
  • Min (column)
  • Add (A + B)
  • Subtract (A - B - C)
  • Multiply
  • Divide (A / B)
  • Format (complex SQL expression)

  Where an additional value can be selected for the operation (B, C, ...), a Parameters option is available to enter this value as Constant (arithmetic).

  In the example below, the milliseconds value of the maxDeskPickupWaitTime field divided by 1000 shows as seconds, using Divide (A / B) (with Constant of 1000).

  The example below illustrates the use of the Format (complex SQL expression) option. A duration field with Number as Value Type is used as a source to render a calculated field test:

  case
  when sum(case when duration >=0 then 1 else 0 end) = 0
  then 0
  else (sum(duration)::dec / sum(case when duration >= 0 then 1 else 0 end))::dec(10,3)
  end
  

  For string columns, string operations available on the input fields are:

  • Substring
  • Length
  • Regex Extract
  • Split Part
  • Prefix
  • Suffix
  • Concat
  • Replace
  • Format (complex SQL expression)

  In the example below, the Site name contains a prefix in capital letters (e.g. GLGC) that is extracted as a custom value Code using the Regex Extract operation with:

  • Pattern (regex_extratc): ([A-Z]+)(.*)
  • Group (regex_extract): 1

Related topics

• Chart Widgets
• Table Widgets
• Text widgets

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.

Value mapping

The Value Mappings page defines a list of value mappings used when retrieving data for dashboard widgets. This allows a dashboard designer to substitute a stored value with a friendlier value that will be displayed to the user.

Value mappings 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 Value Mappings 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

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.

Color mapping

The Color Mappings page defines a list of color mappings used to style data in dashboard widgets.

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 designing 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 Color Mappings page (data model: data/DashboardColorMapping) or Color Mappings link on the MVS-RoleManagement-Dashboard dashboard is available to provider administrators and higher to add, delete and manage mappings.

Examples:

1. 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, acording the selected Dashboard Color Mode (Light/Dark) of the theme that is applied - see: Create a Theme in the Business Admin Portal. The example below shows the Light theme applied.

2. 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 (example below for Light theme):

Field Groupings

The Field Groupings page defines groups of similar data to facilitate common analysis and drill-down functions on a single dashboard.

Custom Reporter Resource fields

Automate provides an options to allow for the custom creation of calculated fields for a reporter resource. The customizations are added to a resource model called data/CustomResourceModel, where they can be grouped by a name and the calculated fields can be mapped to a selected resource in the reporter resources.

The screenshot below illustrates the creation of a custom field for to be used as the name_1 field as well as its selection in the design of a table widget.

Chart widgets

Full HTML Help

Overview

The dashboard widgets support the following chart types:

• 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

The list of data settings for chart widgets follow:

• Title

  The text to display above the chart.

• Description

  This text displays as an informational pop-up when hovering over the circled i icon adjacent 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 is configured. See Arbitrators.

• Data Source Instance

  Displays if Assurance is selected as the data source as multiple instances can be configured. A selection of these can also be made if Allow Data Source Selection is enabled.

• Resource

  Depends on the selected data source, a drop-down list of resource items 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
  • Based on the selected hierarchy when working with a dashboard, the real-time display of data updates according to the current hierarchy, so that a widget that for example shows a count of users, displays values relevant to the selected hierarchy.

  Important

  For charts, 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

  Depending on the selected Resource, one or more fields from the resource can be selected as items for the chart.

  • Field Name

    A drop-down of fields belonging to the Resource. For example, for Chord Diagram Chart (Sankey type in the example image 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 indicating the data type of the selected Field Name. For example, if the Data Source is Arbitrator, a Resource instance may show the Field Type as Calculated - Text.

  • 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

  • Minimum and maximum values

    Where values on a chart range across a minimum and maximum, this range will be used on the y-axis in order to improve the display of the chart, as seen in the example image below:

• Custom Fields

  See: Fields common to widgets

• Filters

  Data referenced in widgets can also be filtered by selecting:

  • 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 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

• Drill-down options

  See Reference: Drilldown Options and Conditional Syntax

• Dashboard chart background colors

  Managed by the theme Panel Color. See Administration GUI Theme Customization Color Reference

Numeric precision

Chart widgets support a numericPrecision setting to control the number of decimal places in chart data labels and tooltips.

• Default: 0 (unless overridden)
• Maximum: 10 (values above 10 are capped)
• Behavior: Formats are applied per chart type (e.g., {y:,.Xf}, {point.weight:,.Xf}, or {point.sum:,.Xf}), and are injected or replaced where {y} tokens are used.

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

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.

• 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. Counters support a numericPrecision setting that controls how many decimal places are shown for the counter value:

  • Default: 0
  • Maximum: 10 (higher values are capped)
  • Behavior: Applied when formatting counter values in the dashboard.

  If no precision is specified, integer formatting (0 decimals) is used.

Links widgets

Full HTML Help

Overview

Links on widgets provide shortcuts to data or external URLs. They can be customized with icons, display text, and conditional logic to control visibility.

Link widget configuration

• Type: Choose a data model from Automate to link to.

• Link text and icon: Customize the display label and icon.

• Condition: Use a system macro to set a condition that controls whether the link displays. The condition evaluates to either True or False based on enabled features. If the condition evaluates to false, the widget is hidden and the dashboard layout adjusts automatically.

  Example macro syntax:

  {{ 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 }}
  

• Display As:

  • External Link: Requires a URL in the Href field.

  • Form and List: Display format of data when type is selected.

  • Dashboard: Links to another dashboard. Select the target dashboard from the drop-down.

    Note

    • When linking to a dashboard, Href and Type are hidden.
    • A dashboard link can launch another dashboard and up to 3 linked dashboards can show in the "breadcrumbs" navigation bar, allowing for easy navigation. For example: Dashboard1 > Dashboard2 > Dashboard3.

  • Field Display Policy and Configuration Template: Can be applied based on the selected type.

• See also the topic Fixed and Configurable Filters in Counters and Links.

Related topics

• Text widgets

Global Settings in the Core Feature Guide

• Filters in counters and links

Filters in counters and links

Links widgets contain fixed and configurable filters.

• Fixed filters
• Configurable filters

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.

  • From the Fields to Display dropdown, select either All Fields, Summary Attributes or Clear All.

  • Filters: filter field values from the table

  • Sorts: order the table (ascending, descending) by a selected field value

• Automate

  • Model Type, Field Display Policy and Configuration Template can be selected.
  • A Fields multiselect list allows for the selection of columns to show.

• 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 Arbitrators.

• Custom Fields

  See: Fields common to widgets

• 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).

    For fields that represent a date, such as a timestamp, the Format Type can also be adjusted to be a DATE STRING, allowing for a user friendly format.

• 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.

Text widgets

Full HTML Help

Overview

Text widgets let you place custom HTML or Markdown content on a dashboard. Text widgets can be:

• Static, displaying fixed content such as headings, notes, or instructions
• Dynamic, rendering content from query results and updating automatically based on dashboard filters and the selected date range.

Use text widgets to provide context, summaries, or supporting information alongside charts and tables.

Related topics

• Links widgets

Global Settings in the Core Feature Guide

When to use a text widget

Common scenarios:

• Section headers / calls-to-action that frame groups of charts
• Contextual notes (for example, definitions, caveats, data freshness)
• Data-aware summaries (for example: totals, KPIs, "no issues detected") using dynamic templates
• Compact tables or lists that you want to fully control in HTML/Markdown

Static vs dynamic text widgets

Choose static text widgets for fixed notes, headings, and instructions; choose dynamic content text widgets to turn the Content field into a template that renders your query data and responds to dashboard filters and the date picker.

Static text widgets:

• Do not use a data source
• Display exactly the content entered
• Best suited for headings, explanations, and fixed instructions

Dynamic text widgets:

• Use a data source and render query results
• Update automatically based on dashboard filters and the date picker
• Suitable for short summaries or data-driven messages

Dynamic content

When Dynamic Content is enabled, the Content field is treated as a template that renders data returned by the selected data source.

The rendered output:

• Reflects the dashboard's filters
• Responds to the selected date range

Static text widgets do not use a data source and do not respond to filters or date changes.

Conditional display

Admins can optionally use a system macro to attach a condition so that a text widget only appears on a dashboard when the condition evaluates to either True or False, based on whether certain features, services, or devices are available and enabled in the Global Settings. See for example the macros listed in Links widgets.

Exporting text widgets

Export behavior depends on the text widget type:

• Static text widgets typically export with no data.
• Dynamic text widgets export the rendered output of the widget.

If no data is returned, the export indicates that no data is available.

Configure a text widget

This procedure adds and configures a text widget.

1. Add a widget and select Text as the widget type.

2. Choose HTML or Markdown.

   Note

   Default is HTML. Markdown is recommended for most use cases.

3. Fill out widget content.

4. (Optional). Enable Dynamic content to render query data.

5. Select the required data source and fields.

6. Use Preview to verify the output.

7. Save the widget and place it on your dashboard.

Configuration fields

Text widgets support standard chart configuration fields:

• Data Source (datasource): Data source identifier (where the data comes from)
• Resource (resource): Resource name (for example, Hierarchy, Microsoft Teams Users)
• Fields (fields): Array of field definitions for the query
• Custom fields: see Fields common to widgets.
• Filters (filters): Array of filter definitions
• _lowerTs, _upperTs: Time range boundaries
• _limit, _offset: Pagination parameters
• interval: Time interval
• timezone: Timezone setting

Template data structure (dynamic content)

When Dynamic Content is enabled, the following objects are available to the template.

headers

An array of header objects describing the query columns.

Each header includes:

• name: Original header name (for example, action)
• displayName: Display name (for example, Action)
• index: Column index (0-based)

rows

An array of objects, one per result row.

Property names are derived from the query headers. Access values using either:

• row[header.name]
• row[header.displayName]

data

Available only when exactly one row is returned.

Provides direct access to values:

• data[header.name]
• data[header.displayName]

metadata

Provides information about the query result set.

Available properties:

• numRows: Number of rows returned
• numHeaders: Number of columns returned

Text widget examples

Static text widget

The image shows an example of a text widget using static HTML:

<h1>Dashboard Notes</h1>

Dynamic Markdown text widget

| Field | Value |
|------|-------|
{% for row in rows %}
{% for header in headers %}
| **{{ header.displayName }}** | {{ row[header.name] }} |
{% endfor %}
{% endfor %}

Best practice for text widget use

• Use Markdown for simplicity: Create headings, lists, and simple tables.
• Use dynamic text sparingly for short, timely summaries. For example, "5 new requests in the selected period." Keep the main analysis in charts/tables.
• Preview before saving to verify the layout and wording.
• Keep it readable. Aim for concise headlines and one to two lines of supporting text.
• Plan for exports. Static text usually exports as "No data available for this widget." If you need exportable values, use a dynamic text widget or a table widget.

Dashboards for a Business Admin role

Full HTML Help

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

Dashboard management reference

Full HTML Help

Automate dashboard trends resources

For the data source Automate Analyzed, Automate provides additional list of Resource instances that can be used to represent trends on a widget.

This reference applies to Insights widget behavior, including charts, tables, counters, and dynamic text widgets where relevant.

Properties of trends resources:

• Frequency: Defines how often data is recorded, for example, Daily or Weekly.
• Retention period: Defines 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, multi vendor users would include Microsoft Licensed Users, Cisco UCM Users, Webex Calling in Webex App Users and so on.

Available trends resources and their properties

• Cisco UCM Phone Trend Metrics
  • frequency: daily
  • retention period: 3 months
  • filters:
    • Total Phones
• Multi vendor user 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

Trends and standalone

This section compares trends resources and standalone ReporterResources:

• Trends resources: Derived metrics recorded daily/weekly with a 3‑month retention window; cannot be modified; require underlying domain data to exist.
• Standalone ReporterResources: Raw time-series records appended via sync-check, typically retained for 13 months, partitioned monthly, with configurable flattened fields and a canonical date field for charting and filtering.

Related topics

• For details on configuring text widgets, see Text widgets

Filter options availability and definitions

The operators discussed in the following subsections are available as filter options for Insights resource field types. These filter options apply to widgets that use Insights-based data sources, including charts, tables, counters, and dynamic text widgets.

Data model for user dashboards.

Model Details: data/Dashboard