[Index]
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: Access Profile Permissions and Operations.
Landing Page Dashboards and Generic Solution Dashboards
Upon upgrading to release 24.1, user landing pages have been converted to dashboards containing the matching landing page data. Users would thus see these dashboards as:
For details on these converted dashboards, see: Landing Page Conversion to Dashboards.
In addition to the dashboards converted from landing pages, VOSS Automate also provides an additional set of default dashboards that are available from default menus.
Note
For these generic solution dashboards and any new dashboards to show data prior to the sync schedule, an initial manual sync step is required - see: Dashboard Refresh.
Menu: Subscriber Service Details
A dashboard with:
Counter widgets showing subscriber counts. The sources of the counts are the following models:
Tables showing multi-vendor subscriber services by vendor. Users in the tables can for example be filtered by hierarchy
The following tables of subscribers are available:
Summary of Services: User and hierarchy details.
Microsoft Service Details: User and hierarchy details, Teams features, Line, Number, Voice enabled, Exchange User Principal Name.
Cisco Service Details: User and hierarchy details, Phone, Line, EM Profile details, SNR details, Voicemail details, Contact Center Agent details.
Cisco Webex Service Details: User and hierarchy details, Cisco Webex Email.
Menu: Transaction Overview - a transaction analysis dashboard with counter, chart and table widgets showing for example such transaction metrics per user, hierarchy, entity and average duration.
Note
This dashboard therefore provides a good usage overview of the platform.
Managing Dashboards
Administrators can manage dashboards from the Dashboards link that is a part of the Role Configuration on the Role Management dashboard.
When adding or editing a dashboard, a number of menu items are available to carry out dashboard related tasks.
Add or Edit:
Clone: Use the Clone icon from the dashboard toolbar. 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: use 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: lock the arrangement of widgets
Dashboard Settings: a toggle menu item to show or hide the dashboard name, description and properties as listed above.
Undo: revert 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, an Undo will lock it, forcing the user to unlock and create a snapshot point. This snapshot is the same as the uploaded dashboard. (Note: the undo functionality is currently under review.)
Export: Use the Export icon from the dashboard toolbar to export one or more instances - for details, see: Bulk Export of Model Data. Exported dashboards can then be modified and imported at a required hierarchy using the Import menu.
Compact Grid: automatically optimize the arrangement of widgets on the dashboard, give their current size.
Paste Widget: Use the Paste Widget icon from the dashboard toolbar menu to paste a widget selected with the Copy Widget option on the widget menu into the current dashboard. Widgets can therefore be copied between dashboards.
JSON Edit: Use the JSON Edit icon from the dashboard toolbar to edit the dashboard data in JSON. For details, see: Manage Items.
When a dashboard is created or maintained, widgets can be added, removed or edited.
To add a widget, select Add (+) from the toolbar and 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:
Clone:
Delete:
Copy Widget:
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.
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.
The following chart types are supported by the widgets.
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.
Resource: Charts access the Automate Analyze resource. In accordance with configured devices and services, a dropdown list of resource items are available to be referenced in the chart, for example: Number Inventory, Cisco CUC User, Cisco UCM Phone, Microsoft O365 User.
Note
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 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
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:
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:
For a detailed reference of chart options, see: Reference: Chart Options Availability and Definitions.
Drilldown options: see Reference: Drilldown Options and Conditional Syntax
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:
Filter:
Filter:
Sorts:
Chart Options:
The examples below show the chart with settings on some of the properties as not set or set in the example above:
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:
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:
The Subscriber 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:
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":
Settings:
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.
Settings:
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.
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 are typically used to offer shortcuts to targets: data or URLs. The data is available from Automate models in the Type dropdown.
Link Text and Icon can be entered to display the link
Condition : a condition that evaluates to true or false, in VOSS 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.
Note
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:
|
| 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
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 Insights 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 drilldown
The example below shows a table widget configuration using an Insights resource, the resultant output display and also a drilldown result.
Configuration
Output
The table shows 2 columns:
Drilldown result
Selecting a row link from the table shows the item as listed in the selected Drilldown Options.
A widget is available to show 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.
Example Text widgets (HTML):
Example Text widgets (Markdown):
Text widgets can be used to create headings, for example:
Design:
Display:
A real-time sync process is running to maintain VOSS and Insights databases in sync. After upgrade to release 24.2, and if 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
VOSS 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.
A menu Role Management > Dashboard Value Mapping (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
More than one original field value can be mapped to a single mapping key.
Examples:
The operators below are available as filter options for Insights resource field types:
Text
Integer
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 |
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 widget during drilldown. A Dashboards dropdown shows to select the other dashboard.
Launch Third-party URL
Conditional Drilldown
Provides a Conditional Drilldown input box into which a JSON formatted condition can be entered. For details on the format, see Drilldown Conditional below.
Drilldown Fields:
Drilldown Conditional
When selecting the Drilldown Conditional 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.
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"
value: value of the field; according to fieldType: "text", "integer" or "float"
actions:
List of actions:
drilldown: "integer"
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:
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:
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:
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
]
}
Dashboards for a Business Admin Role
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 - 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
Data model for user dashboards.
| Title | Description | Details | |||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Dashboard Settings | Group Assigned by FDP |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Name * |
|
||||||||||||||||||||||||||||||||||||||||||||||||
| Description |
|
||||||||||||||||||||||||||||||||||||||||||||||||
| Read Only |
|
||||||||||||||||||||||||||||||||||||||||||||||||
| Hide Time Picker |
|
||||||||||||||||||||||||||||||||||||||||||||||||
| Hide Datasource Selector |
|
||||||||||||||||||||||||||||||||||||||||||||||||