Link Search Menu Expand Document

Dashboard

Feb 6 2023 at 12:00 AM

  1. Overview
    1. What to expect from this section
  2. Add a chart to an empty dashboard
  3. Add a chart to a dashboard from the chart configuration page
  4. Add/delete a chart to the dashboard with the dashboard editing function
  5. Dashboard options
    1. Dashboard options - dashboard page
    2. Dashboard options - dashboard editing page
      1. Editing dashboard properties
    3. Chart options in dashboard view mode
    4. Editing the dashboard’s layout
      1. Adding dashboard tabs
      2. Inserting a row
      3. Inserting a column
      4. Adding a header
      5. Writing in markdown
      6. Adding a divider
    5. Dashboard filtering
      1. Accessing the filter configuration window
      2. Value filter type
      3. Numerical range filter type
      4. Time range filter type
      5. Time column filter type
      6. Time grain filter type
      7. Scoping filters

Overview

BI Navigator’s dashboard is the focus point of the BI Navigator data visualisation experience. Once at least one chart has been created, generated charts can be exported and saved onto the dashboard. The dashboard allows the user to set up filters, cross filters, and tabs to enhance insights gained from the data.

What to expect from this section

The following sections will show how to:

  • Create an empty dashboard and add a chart.
  • Save and add a chart to a dashboard from the chart’s configuration page.
  • Add/delete a saved chart to a dashboard using the dashboard editing function.

Add a chart to an empty dashboard

Clip 1 - Add a chart to a new dashboard

As shown in the clip above:

  1. From the BI Navigator landing page, click on the + button (found at the top right of the page) to expand the dropdown.
  2. Select “Dashboard” from the dropdown’s options.
  3. Once the empty dashboard page has opened, name the new dashboard by replacing [untitled dashboard] with the new dashboard’s name.
  4. Navigate to the right-hand side of the page. Select a chart (found under the “Charts” tab) and drag it onto the dashboard. In this example the “Internal Ambient Temperature” chart has been dragged onto the empty dashboard.
  5. Save the dashboard by clicking on the SAVE button found at the top right of the page.

Add a chart to a dashboard from the chart configuration page

To add a chart to a dashboard when saving it, navigate to the chart configuration page:

Clip 2 - Add a saved chart to a dashboard

  1. Click on SAVE (found at the top right-hand of the page).
  2. This will open a dialog box. Choose to either overwrite an existing chart’s properties with new properties (by selecting “Save (Overwrite)”) or to save a new chart with “Save As”.
  3. Give the chart a name.
  4. Select the “Add to Dashboard” dropdown and choose the dashboard within which the chart should appear (if the dashboard already exists). If a new dashboard needs to be created, specify the dashboard name.
  5. Click on SAVE to save the chart.

Add/delete a chart to the dashboard with the dashboard editing function

One can add/delete a chart to a dashboard by selecting the “Edit Dashboard” function on the dashboard page:

Clip 3 - Add/delete a chart using the dashboard editing function

  1. From the selected dashboard’s page, click on EDIT DASHBOARD (found at the top right-hand of the page).
  2. This will open the dashboard’s editing page. To add a chart to the dashboard, select the relevant chart (found on the right side of the page under the “Charts” tab) and drag it onto the dashboard.
  3. Click on SAVE (found at the top right-hand of the page) to save the dashboard’s new settings.
  4. To delete a chart from the dashboard, navigate to the selected dashboard’s page. Click on EDIT DASHBOARD.
  5. Once the dashboard’s editing page opens, hover over the top right of the chart you want to delete. This will show a bin icon.
  6. Click on the bin icon to delete the chart from the dashboard.
  7. Click on SAVE to save the dashboard’s new settings.

Dashboard options

Dashboards have certain settings that can be configured according to the user’s preference. These options can be found when clicking on the ellipsis found at the top right of the page on either the dashboard page or the dashboard editing page. The following sections will discuss these options in more detail.

Dashboard options - dashboard page

Click on the ellipsis found at the top right of the dashboard page:

Clip 4 - Dashboard options on the dashboard page

This will expand a dropdown with the following options:

  1. Refresh dashboard - refresh all dashboard charts (i.e. retrieve all data).
  2. Enter fullscreen - reload the dashboard without the top Toolbar. Re-select “Exit Fullscreen” to return to the default view.
  3. Save as - save the dashboard to a different filename.
  4. Download as image - download an image of the entire dashboard in JPEG format.
  5. Share:
    • Copy permalink to clipboard - copy the file’s link to the user’s local drive.
    • Share permalink by email - launch the system’s default email client. This composes a new message featuring the dashboard’s URL.
  6. Set up an email report - set up an automated email which provides a report of the dashboard’s data.
  7. Set auto-refresh interval - specify an automatic refresh rate for the dashboard. Options include seconds (10 or 30), minutes (1, 5 or 30) or hours (1, 6, 12, 24). Note this is only applicable for the current session.

Dashboard options - dashboard editing page

Navigate to the selected dashboard and click on EDIT DASHBOARD. Once in the dashboard view mode, click on the ellipsis (at the top right-hand of the page):

Clip 5 - Dashboard options on the dashboard editing page

This will expand a dropdown with the following options:

  1. Edit properties - activate editing mode. This will open a window with dashboard properties that the user can configure (see more below).
  2. Edit CSS - load the Live CSS Editor to make ad hoc stylesheet changes in a live editing environment (i.e. changes applied in real time).
  3. Save as - save the dashboard to a different name.
  4. Share:
    • Copy permalink to clipboard - copy the file’s link to the user’s local drive.
    • Share permalink by email - launch the system’s default email client. This composes a new message featuring the dashboard URL.
  5. Set filter mapping - enable configuration of filter scopes.
  6. Set auto-refresh interval - specify an automatic refresh rate for the dashboard. Options include seconds (10 or 30), minutes (1, 5 or 30) or hours (1, 6, 12, 24). Note this is only applicable for the current session.

Editing dashboard properties

Click on “Edit properties” in the dropdown described above to open “Dashboard properties”:

Clip 6 - Edit dashboard properties

This window allows the user to configure the following properties:

  1. Title - edit the title of the dashboard.
  2. URL Slug - customise the end of the URL (Slug) to a more memorable name.
  3. Owners - assign/remove access to the dashboard. Click here for more information.
  4. Roles - contains a list of access constraints imposed on the dashboard. Granting role access to a dashboard will bypass dataset level checks. If no roles are defined, the dashboard will be available to all roles. Click here for more information.
  5. Colour Scheme - select the colour scheme of the dashboard.
  6. Certified by - contains the name of the person or group that has certified the dashboard.
  7. Certification details - any additional certification information can be included here, for example “approved as a proof of concept only”.
  8. JSON Metadata - click on the ADVANCED button to open the JSON Metadata panel. This section is for power users who may wish to alter specific advanced dashboard parameters.

Chart options in dashboard view mode

While on the dashboard page (in dashboard view mode), click on the ellipsis found at the top right of the chart:

Clip 7 - Chart options in dashboard view mode

This will expand a dropdown with the following options:

  1. Force refresh - refresh the chart’s data. The dropdown also shows the time that has passed since the last cache.
  2. Enter fullscreen - this will open the chart in full screen mode.
  3. Edit chart - launch the chart in the “Explore” page.
  4. View query - launch the “View Query” panel, which displays the SQL query used to create the chart. Select the Copy icon to copy the SQL code to your clipboard. See Clip 8 below.
  5. View as table - this shows the underlying data of the chart in a table. The data can be copied to the clipboard using the Copy icon. See Clip 9 below.
  6. Share:
    • Copy permalink to clipboard - copy a shareable chart link to the system’s clipboard.
    • Share chart by email - launch the system’s default email client which composes a new message featuring the chart URL.
  7. Download:
    • Export to .CSV - download the chart’s data in CSV format.
    • Download as image - download the chart in the form of an image in JPEG format.

The “View query” option will open an SQL query that can be used to create a chart:

Clip 8 - View query

The “View as table” option shows the underlying data of the chart in a table:

Clip 9 - View as table

Editing the dashboard’s layout

While in dashboard view mode, a user can click on the EDIT DASHBOARD button to edit the layout of the dashboard:

Clip 10 - Dashboard layout options

  1. Click on EDIT DASHBOARD (found at the top right of the page in dashboard view mode).
  2. Click on the “Layout Elements” tab. This will open a tab with elements that the user can configure to customise the dashboard’s layout. To use these elements, simply drag and drop the component onto the dashboard.

The following elements can be configured and will be discussed in more detail in the sections below:

  • Tabs
  • Columns and Rows
  • Header
  • Markdown
  • Divider

Adding dashboard tabs

From the “Layout Elements” tab (EDIT DASHBOARD -> LAYOUT ELEMENTS):

Clip 11 - Adding dashboard tabs

  1. Click on the Tabs icon.
  2. Drag the icon onto the top part of the dashboard (drag it close to the “Documentation” heading at the top of the dashboard view).
  3. An input box will open. Give the tab a title.
  4. Click on the + button to add the tab.
  5. Once a new tab has been created, a + sign will show next to the tab’s title. To add new tabs, click on the + button. You can also click on the x button to delete a tab.
  6. To add charts to a tab, navigate to the “Charts” tab found at the right hand of the page. Drag the selected chart onto the dashboard under the preferred tab.
  7. To ensure the chart is shown under the correct tab, drag the chart onto the tab’s title and then click SAVE (at the top right of the page).

Inserting a row

While in dashboard view mode, navigate to the “Charts” tab (EDIT DASHBOARD -> CHARTS) found at the right hand of the page:

Clip 12 - Adding dashboard rows

  1. Select a chart and drag it onto the dashboard. The chart can be resized by dragging its borders to make it bigger or smaller.
  2. To add a row, navigate to the “Layout Elements” tab at the right of the page. Select the Row option and drag it to the bottom border of the lowest chart on the dashboard. This creates an empty row that can be populated with more charts.
  3. Select the “Charts” tab and chose a chart with which to populate the empty row.
  4. Drag and drop the chart onto the empty row.
  5. Multiple charts can be added to one row. To add a new chart to the same row, drag and drop the chart to the right border of the already existing chart in the row.
  6. Charts inside rows can also be resized by dragging their borders to make them bigger or smaller.
  7. Once the dashboard has been configured with rows, click on SAVE (at the top right of the page).

Inserting a column

While in dashboard view mode, click on EDIT DASHBOARD (found at the top right of the page) to open the dashboard editing options:

Clip 13 - Adding dashboard columns

  1. Navigate to the “Charts” tab and drag and drop a chart onto the dashboard.
  2. Click on “Layout Elements” and select the Column icon.
  3. Drag the Column icon and drop it where you would like to create a column on the dashboard. If the column should be next to the existing chart on the dashboard, drag the Column icon to the right border of the existing chart until the border highlights, then drop the column.
  4. Populate the empty column with selected charts. Resize the charts to customise the dashboard view.
  5. The column can be deleted (or settings can be configured) by clicking on icons that show up at the top center when the user is hovering over the column.
  6. Once the column layout has been configured, click on SAVE (at the top right of the page).

Adding a header

While in dashboard view mode, click on EDIT DASHBOARD (found at the top right of the page) to open the dashboard editing options:

Clip 14 - Adding a header

  1. Navigate to the “Layout Elements” tab and drag and drop the Header icon onto the top of the dashboard.
  2. Place the cursor in the input box that says “New header” and replace the text with the name of the dashboard.

Writing in markdown

This icon allows the user to write in markdown.

While in dashboard view mode, click on EDIT DASHBOARD (found at the top right of the page) to open the dashboard editing options:

Clip 15 - Add a markdown block

  1. Navigate to the “Layout Elements” tab and drag and drop the Markdown icon onto the dashboard.
  2. Click on the “Click here to edit markdown” link.
  3. This will open the markdown editing block. To toggle between the markdown text editor and markdown preview mode, click on the “Edit” dropdown found at the top right of the block. Click on Edit to write in markdown or on Preview to see the preview of your edits.

Adding a divider

Users can create a divider between charts on the dashboard.

While in dashboard view mode, click on EDIT DASHBOARD (found at the top right of the page) to open the dashboard editing options:

Clip 16 - Add a divider

Navigate to the “Layout Elements” tab and drag and drop the Divider icon to the position on the dashboard where you would like to divide the charts.

Dashboard filtering

Navigator’s dashboard filters offer powerful data filtering functionality coupled with an intuitive interface. All dashboards have a “Filters” sidebar that can be expanded so that the user can easily apply a variety of filters to all charts linked to that dashboard.

Value filter types enable the user to specify any value for any column within the dataset. This provides considerable freedom in terms of filtering options. Numerical range filters offer a simple way to define a numeric value range within categories such as pricing data or years. Additionally, Navigator offers several time-based filters (i.e., Time Range, Time Column and Time Grain) that enable the user to filter all charts using a selected dataset’s time column.

Both basic and advanced configuration settings empower the user to expand on filtering capability, enhancing filtration options and usability.

Accessing the filter configuration window

All dashboards have a “Filters” sidebar that can be expanded. To access the filter configuration window, go to the selected dashboard (in dashboard view):

Clip 17 - Accessing Filter configuration options

  1. Click on the right-arrow expand button.
  2. Once the “Filters” sidebar has opened, click on + ADD/EDIT FILTERS.

The “Add and edit filters” window will open, providing a variety of filter configuration options:

Figure 1 - Add and edit filters window

  1. Add filters and dividers - a divider in the filter window allows the user to split the filters and write a comment for each filter group. Click on the + icon next to ADD/EDIT FILTERS on the left of the page to open the window. See Clip 18 below.
  2. Filter type - select a filter type. Options include Value, Numerical range, Time range, Time column, and Time grain.
  3. Filter name - provide a descriptive name for the new filter. The name should generally correlate with the selection made in the “Column” field.
  4. Dataset - select the dataset that should be applied to the charts in the dashboard. By default the user will be able to select all datasets associated with the dashboard’s charts. This field appears when any one of the Value, Numerical range, Time column or Time grain filter types are selected.
  5. Column - select a column to which the filter should be applied. This field appears when either the Value or Numerical range field types are selected.
  6. Pre-filter available values - select this option to implement an additional layer of filtering. The filters added here will act on the underlying data before any user-selected filter options are set.
  7. Sort filter values - this option allows the user to control how filter options will be sorted in the dropdown. Filter options can be sorted in ascending or descending order.
  8. Filter Settings - this provides additional control over the behaviour of selected filters.
  9. Filter has default value - provide a default filter value. For example, a user can set the dashboard to filter to a particular time range or geographical region by default.
  10. Filter value is required - this setting requires the user to select a value before applying the filter (the filter cannot be left blank). A default filter has to be selected before this setting can be configured.
  11. Select first filter value by default - select this setting if the first filter value in the list should be used. When using this option the default value setting cannot be used.
  12. Can select multiple values - this setting allows the user to select multiple values to which the filter can be applied. If this is not enabled the user will only be able to select a single value to which the filter can be applied.
  13. Dynamically search all filter values - by default each filter loads at most 1000 choices at the initial page load. Check this box if there are more than 1000 filter options/values and the user wants to enable dynamic searching that loads filter values while the user types.
  14. Title placeholder - the title of the filter (provided under “Filter name”) will appear here. You can also click on the bin icon to remove a filter.
  15. Save - Once all relevant filter settings have been configured, click on the SAVE button to save the filter.
NOTE
Applying “Dynamically search all filter types” may add stress to the database.

Additional filter configuration options:

Figure 2 - Inverse selection

Scroll down the options under “Filter Settings” to see the “Inverse selection” option. Clicking on this option will exclude selected values.

To add a filter divider:

Clip 18 - Add a filter divider

  1. Click on the + icon next to ADD/EDIT FILTERS on the left of the page to open the “Add and edit filters” window.
  2. Click on the + icon (at the top left of the window) next to “Add filters and dividers”.
  3. In the dropdown that opens, click on “Divider”.
  4. In the input boxes provided, add a title and description of the divider.
  5. You can change the order of the divider list on the left by selecting and dragging dividers to the preferred position.
  6. Once all dividers have been configured, click on SAVE.

The sections below will discuss the following configuration elements in more detail:

  • Value filter type
  • Numerical range filter type
  • Time range filter type
  • Time column filter type
  • Time grain filter type
  • Scoping filters

Value filter type

To create a Value filter type:

Expand the “Filters” sidebar on the right and click on + ADD/EDIT FILTERS:

Clip 19 - Create a value filter

  1. Provide a filter name in the “Filter name” input box.
  2. Select a platform from the dropdown under “Column”.
  3. Select Value from the dropdown under “Filter type”.
  4. Click on the SAVE button.

To apply the newly created value filter:

While still on the dashboard’s page (in dashboard view), expand the “Filters” sidebar. The newly created filter will be listed in the sidebar with a dropdown that contains all the filtering options related to that filter:

Clip 20 - Apply a value filter

  1. Click on the filter options that need to be applied to the charts on the dashboard. They will be added to the input box under the filter’s name.
  2. Click on APPLY FILTERS. This will apply the selected filters to all the charts in the dashboard (on the right).

Numerical range filter type

This filter type creates a range slider that enables the user to specify a range’s upper and lower limits.

To create a numerical range filter:

Clip 21 - Create a numerical range filter

While on the dashboard page (in dashboard view mode), expand the “Filters” sidebar on the left and click on + ADD/EDIT FILTERS:

  1. When the “Add and edit filters” window opens, choose Numerical range from the dropdown under “Filter type” and name the filter under “Filter name”.
  2. Choose the type of data to be applied from the dropdown under “Column” (in this case it is Ambient Internal Temperature).
  3. Click on the SAVE button.

To apply a numerical range filter:

While on the dashboard page (in dashboard view mode), expand the “Filters” sidebar on the left:

Clip 22 - Apply a numerical range filter

  1. The expanded sidebar will include the newly created numerical range filter, represented as a slider.
  2. Slide the left and right side of the slider to set the range’s upper and lower limits.
  3. Click on APPLY FILTERS to apply the range limits to the charts in the dashboard (on the right).
NOTE
The user can view the upper and lower limits of the range by hovering on the leftmost/rightmost anchor points on the slider.

Time range filter type

This filter type launches Navigator’s Edit Time Range functionality.

To create a time range filter:

While on the dashboard page (in dashboard view mode), expand the “Filters” sidebar and click on + ADD/EDIT FILTERS:

Clip 23 - Create a time range filter

  1. Under the “Filter type” dropdown, select Time range.
  2. Name the filter. Best practice is to make the name correlate with the “Filter type”.
  3. Click on the SAVE button to save the filter.
  4. The filter can now be seen in the “Filters” sidebar on the left of the page.

To apply the time range filter:

While on the dashboard page (in dashboard view mode):

Clip 24 - Apply a time range filter

  1. Expand the “Filters” sidebar on the left side of the page.
  2. Click on the No filter button under the newly created filter’s title to edit the time range.
  3. In the “Edit” window that opens, select the range type from the dropdown. Options include “Last”, “Previous”, “Custom” and “Advanced”.
  4. Depending on which option is chosen, new configuration options will appear. For example, if “Last” is chosen as the range type, the new configurations will include options like “Last day”, “Last week”, and so on. Select the relevant option.
  5. Click on the APPLY button to apply the new time range settings.
  6. Once the window has closed, the button under the filter’s title will represent the settings that were configured in the “Edit” window.
  7. Click on APPLY FILTERS to apply the filter to all the charts in the dashboard on the right.
NOTE
The Time Range filter configuration is identical to the Time Range configuration when creating a new chart.

Time column filter type

This filter type creates a dropdown menu that enables the user to select a new dashboard-level time column that will overwrite any existing time columns defined at the chart level.

To create a time column filter:

While on the dashboard’s page (in dashboard view mode), expand the “Filters” sidebar on the left of the page:

Clip 25 - Create a time column filter

  1. Click on + ADD/EDIT FILTERS to open the “Add and edit filters” window.
  2. Select Time column from the dropdown under “Filter type”.
  3. Name your filter. Best practice is to make the name correlate with the “Filter type”.
  4. Click on the SAVE button to save the filter.

To apply a time column filter:

While on the dashboard page (in dashboard view mode), expand the “Filters” sidebar to see the newly created time column filter:

Clip 26 - Apply a time column filter

  1. Open the dropdown found under the newly created filter’s title. This dropdown contains a list of available time columns that can be selected to overwrite existing time columns defined at the chart level.
  2. Select the relevant time column from the list.
  3. Click on the APPLY FILTERS button to apply the filter to the dashboard’s charts on the right side of the page. The charts will refresh and display the new applied filter.

Time grain filter type

This filter type creates a dropdown that enables the user to select a time granularity. When applied, all timestamps are grouped based on the selected time grain.

To create a time grain filter:

While on the dashboard page (in dashboard view mode), expand the “Filters” sidebar and click on + ADD/EDIT FILTERS:

Clip 27 - Create a time grain filter

  1. In the “Add and edit filters” window, select Time grain from the dropdown options under “Filter type”.
  2. Name your filter. Best practice is to make the name correlate with the “Filter type”.
  3. Click on the SAVE button to save the filter.

To apply a time grain filter:

Navigate back to the dashboard page (in dashboard view mode). Expand the “Filters” sidebar on the left:

Clip 28 - Apply a time grain filter

  1. The newly created filter will be listed in the expanded “Filters” sidebar on the left side of the page. Open the dropdown to select a time grain option for the filter. Options include “Second”, “Minute”, “Hour”, “Day”, and so on.
  2. Select the relevant time grain option and click on APPLY FILTERS to apply the chosen time grain filter configuration.
  3. The charts on the right of the page will refresh and display the new applied filter.

Scoping filters

Users can configure filters on a dashboard to be scoped (limited) to specific charts, tables, and tabs.

To use scoping filters:

While on the dashboard page (in dashboard view mode), expand the “Filters” sidebar and click on + ADD/EDIT FILTERS:

Clip 29 - Using scoping filters

  1. Once the “Add and edit filters” window has opened, select the filter you want to configure and navigate to the “Scoping” tab (found at the top right).
  2. Select “Apply to all panels” or “Apply to specific panels”. This will depend on the application’s requirements. To limit the filter’s scope, select “Apply to specific panels” and select the panels to which the filter should apply.