[Index]

Model: data/Dashboard

Dashboards

Full HTML Help

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

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.

Note

By default, administrators have permissions to modify their own menu layouts and dashboards. If the assigned menu layout or dashboard is at a higher hierarchy, it can be cloned and modified at the administrator's hierarchy.

Related topics

Conversion of landing pages to dashboards in v24.1

When upgrading to Automate release v24.1, existing landing pages in Automate are converted to dashboards; new data/Dashboard records are created from data/LandingPage records. Additionally:

These dashboards allow for the same functionality as existing landing pages, but have an enhanced editing interface where for example a wide variety of chart widgets can be added to enrich dashboards. It is recommended that the dashboard conversions be inspected and edited if needed.

For details on dashboards, their maintenance and initial sync requirements after the addition of dashboard widgets, see: Automate Dashboards.

A new database and resource model for its data has also been added: Insights reporter resources (data/ReporterResource).

As a part of the landing page to dashboard conversion during upgrade, the following related elements are also migrated:

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

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.

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:

Note

Examples:

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:

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:

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:

  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):

Chart widgets

Full HTML Help

Tip

Use the Action search to navigate Automate

Overview

The dashboard widgets support the following chart types:

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 table describes the common list of data settings for chart widgets:

System Message: ERROR/3 (<string>, line 38)

Malformed table.

+-------------------------------------------+-------------------------------------------------------------------+
| Setting                                   | Description                                                       |
+===========================================+===================================================================+
| **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:                                    |
|                                           | Voss Assurance Arbitrators.                                |
+-------------------------------------------+-------------------------------------------------------------------+
| **Data Source Instance**                  | Displays if **Assurance** is selected as the data source as       |
|                                           | multiple instances can be configured. A selection of these can    |
|                                           | then 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.       |
|                                           |                                                                   |
+-------------------------------------------+-------------------------------------------------------------------+

System Message: ERROR/3 (<string>, line 96)

Malformed table.

+---------------------------------------+----------------------------------------------------------------------+
| Setting                               | Description                                                          |
+=======================================+======================================================================+
| **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                                     |
+---------------------------------------+----------------------------------------------------------------------+
| **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                |
+---------------------------------------+----------------------------------------------------------------------+

Chart widget example

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

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

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.

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.

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.

Note

Fixed and configurable filters in counters and links

Table widgets

Full HTML Help

Overview

Available menus and fields upon Data Source selection:

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

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:

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

Text widgets

Full HTML Help

Text widgets display text on a dashboard.

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.

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

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

Dashboards: MenuSiteAdmin

Dashboards: MenuCustomerAdmin

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.

Note

Trends resources have the following properties:

The available trends resources and their properties are indicated below:

Filter options availability and definitions

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

Text

Integer

Chart options availability and definitions

Note

By default, a number of chart colours are matched with the current GUI theme. For details on these colours, see the Branding tab section under Create a Theme in the Business Admin Portal.

In particular:

Chart Option Definitions:

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

Drill-down options and conditional syntax

Drill-down options

Conditional drill-down 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.

Examples

Data model for user dashboards.

Model Details: data/Dashboard

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