.. _dashboards:
Introduction to Dashboards
-------------------------------
.. _21.3|EKB-12577:
.. _22.2|EKB-13746:
.. _23.1|VOSS-1135:
Overview
..........
In the Insights Dashboard user interface, the **DASHBOARDS** panel displays all dashboards, reports,
and their associated folders, and the following additional menus, which you can use to work
with the dashboards:
* Search
* Reports
* Data Sources
* Access Controls
.. note::
* Both default and custom dashboards display in the **DASHBOARDS** panel. Default (VOSS reference)
dashboards are read-only. To make a custom dashboard based on a default dashboard, you can
clone (copy) the default dashboard, then modify the clone and save it as a new, custom dashboard.
* An animated wave icon |insights-loading-animation| displays while the GUI is loading or refreshing data.
.. image:: /src/images/analytics-main-menu2.png
.. rubric:: Related Topics
*
.. raw:: latex
Introduction in the Dashboards Administration Guide.
.. raw:: html
Introduction
*
.. raw:: latex
VOSS Reference Dashboards in the Dashboards Administration Guide.
.. raw:: html
VOSS Reference Dashboards
*
.. raw:: latex
Custom Dashboards in the Dashboards Administration Guide.
.. raw:: html
Custom Dashboards
*
.. raw:: latex
Working with Dashboards in the Dashboards Administration Guide.
.. raw:: html
Working with Dashboards
*
.. raw:: latex
Access Controls in the Dashboards Administration Guide.
.. raw:: html
Access Controls
*
.. raw:: latex
Reports in the Dashboards Administration Guide.
.. raw:: html
Reports
Search Dashboards
.....................
Use the Search bar at the top of the **DASHBOARDS** panel to perform a quick search to find dashboards by their name.
Global Filters
..................
Selecting a dashboard in the **DASHBOARDS** panel displays configuration and display options for that
dashboard. One such option is **Global Filters**, which allows you to configure and apply global filters
based on a data element extracted from a search definition and resource defined for the dashboard.
|analytics-global-filtering|
Click **Edit Filters** to open the **Filter Wizard**, where you can
select the Resource and the Definition to apply as a filter. Once complete click
**Save Filters** to return to the dashboard.
An example of a global filter is producing a performance dashboard by customer
location. The widgets on the dashboard are all the performance statistics but the
data is filtered by the customer location.
|analytics-global-filtering-save-filters|
.. note::
Global filters (and customer filters) work as an IN function that searches for
exact string match in SQL. For example:
``IN (172.30.42.1, 172.30.42.2)``
You must type out all values in the search box (separated by commas), and then press Enter.
If you press
Enter after selecting each IP address, the search only returns data if all of the IPs are
found in the field (which is unlikely).
Dashboard Folders
...................
Dashboards are organized initially in alphabetical order.
When creating dashboards, you can organize these into folders that expand out into
trees based on the order you define.
To add a new sub-folder or top-level folder in the **DASHBOARDS** panel, click the **Folders** down-arrow
and select either **New sub folder** or **New top level folder**.
You can drag and drop a sub-folder into the relevant top-level folder, or drag the
relevant dashboard into a folder.
To remove a folder, select the folder, then select **Remove folder**
from the **Folders** drop-down.
.. note::
Dashboards with the same name can exist in different folders. The names of dashboards in
the same folder must be unique.
|analytics-dashboard-menu-options-folders|
Search, Reports, Data Sources, and Access Controls Menus
..........................................................
The table describes additional menus in the **DASHBOARDS** panel:
================= =========================================================================
Search Select **Search** to display the main Search screens, which store
all logs in a JSON index data store.
Reports Select **Reports** to open the Report Scheduler, where each report can
be scheduled based on customer, duration, repeat timeframe, and email
address.
Data Sources Select **Data Sources** to open the page where you can define multiple
data sources to extract data on which to analyze and report.
Access Controls Select **Access Controls** to open the **Access Control Editor** where
you can set up multi-tenant customers and users, configure roles,
permissions, password policy, SAML settings, and user log in
credentials.
================= =========================================================================
.. rubric:: Related Topics
* :ref:`assurance-reports`
* :ref:`VAA-access-controls`
.. |main-menu-icon| image:: /src/images/analytics-main-menu-icon.png
.. |analytics-dashboard-menu-options-folders| image:: /src/images/analytics-dashboard-menu-options-folders.png
.. |analytics-global-filtering| image:: /src/images/analytics-global-filtering.png
.. |analytics-global-filtering-save-filters| image:: /src/images/analytics-global-filtering-save-filters.png
.. |insights-loading-animation| image:: /src/images/insights-loading-animation.png