CH logo® Knowledge Base
Contents Search
   

 

Dashboards

Note: Dashboards are now accessed and managed via the Library.

Dashboards are viewed in the Library section of the Kentik Detect portal and provide quick access to a custom (user-defined) set of visualizations. Dashboards are covered in the following topics:

 

 
 top

About Dashboards

In the Kentik Detect portal, a dashboard is a page with one or more panels that each display a single representation (graph, table, gauge, map) of a query. The following topics provide a general overview of dashboards:

Notes:
- Any query that can be displayed in Data Explorer can be saved to a panel on a dashboard.
- The contents of any dashboard may be sent as a regularly scheduled report that is emailed to a specified list of subscribers (see Subscriptions).

 

 
 top  |  section

Dashboard Access

To open an individual dashboard, click Library on the Kentik Detect navbar to open the Library Page. Dashboards are listed on the Library tab along with other view types (saved views and reports) and are indicated with the icon shown at right. A context menu for each view in the list enables you to modify, delete, or clone a dashboard (see List Item Context Menu).

 

 
 top  |  section

Dashboard Areas

A dashboard is made up of the following main areas:

  • Display area: An area for display of individual panels. For further information, see Dashboard Panel Display.
  • Sidebar: Contains the controls used for overall Dashboard settings, as well as for settings on panels whose time range, devices, and/or filters have been specified as “Controlled by Dashboard.” For further information, see Dashboard Sidebar Controls.

 

 
 top  |  section

Dashboard Modes

The Kentik portal supports two dashboard modes:

  • Guided mode (beta): Guided mode lets users see data about a preselected dimension without setting complex query options. When enabled, the dashboard will include the prompt specified below, and the user’s response will determine the value of a predefined filter that is applied to each panel.
  • Standard mode: In standard mode, a dashboard has no prompt at the top of the display area. Each panel is independent except for panels on which the Device Behavior or Filter Behavior property is set to Controlled by Dashboard (see Panel Dialog Settings), in which case the panels tracks the current device and/or filter settings of the sidebar.

 

 
 top  |  section

Dashboard Visibility

Dashboard visibility determines which users can access to a given dashboard:

  • Private: Dashboards that you create only for your own personal use. No one else has access.
  • Shared: Dashboards created by any user in your organization. All users in your organization have access.
  • Presets: Readymade dashboards created by Kentik for common use cases. Presets can be used as-is or cloned and modified (at which point they become private or shared dashboards).

 

 
 top  |  section

Dashboard Navigation

Dashboard navigation enables users to navigate from a given dashboard panel directly to another dashboard. The destination dashboard would typically be related to the same use case, thus reducing the time spent drilling deeper into a given area.

Using dashboard navigation begins with thinking through a particular use case: what information are you going to want to start with in a given situation and what would be the next set of information you would want to see if further investigation is called for.

Once you’ve settled on a workflow through successive dashboards, and have chosen or created the individual dashboards that will be used, you can begin to designate dashboards as destinations that you reach from a panel on a source dashboard (see Adding Dashboard Navigation).

Notes:
- The Dashboard Dependencies pane of the Dashboard Properties dialog for a given dashboard shows the dashboards that are navigated to and from that dashboard.
- In addition to supporting the creation of dashboard navigation in the portal, Kentik will be introducing a library of ready-made dashboard workflows.

 

 
 top

Dashboards Page

The Dashboards page has been removed from the Kentik Detect portal. Dashboards are now accessed via the Portal Library.

 

 
 top

Dashboard Dialogs

Adding or editing a dashboard via the Kentik portal involves settings in the dialogs covered in the following topics:

 

 
 top  |  section

About Dashboard Dialogs

Dashboard dialogs are used to collect and display dashboard information. The required information is entered into the fields of the following dialogs:

  • Add Dashboard when creating a new dashboard.
  • Dashboard Properties when editing the properties of an existing dashboard.
  • New Dashboard, which appears only in Data Explorer and is used to save the current view to a panel on a new dashboard (see New Dashboard Dialog).

 

 
 top  |  section

Dashboard Dialogs UI

The Add Dashboard and Dashboard Properties dialogs share the same layout and the following common UI elements:

  • Close button: Click the X in the upper right corner to close the dialog. All elements will be restored to their values at the time the dialog was opened.
  • Remove button (Dashboard Properties dialog only): Remove the dashboard from your organization’s collection of Kentik-registered dashboards. This button is only present if the dashboard being edited was manually added.
  • Cancel button: Cancel the add dashboard or edit dashboard operation and exit the dialog. All elements will be restored to their values at the time the dialog was opened.
  • Add Dashboard button (Add Dashboard dialog only): Save settings for the new dashboard and exit the dialog.
  • Save button (Dashboard Properties dialog only): Save changes to dashboard settings and exit the dialog.

 

 
 top  |  section

Dashboard Properties

A dashboard is configured or edited using the fields of the Add Dashboard and Dashboard Properties dialogs. These fields include general settings, default query options, and guided dashboard options.

 

General Dashboard Settings

General settings are specified with the following fields:

  • Name: A string that will appear in the Library’s list of available views (see Library List) and in the Panel Display Area of the title bar.
  • Description: Optional description text that will be displayed in the dashboard’s tile in the Dashboard List.
  • Category: The category that the view will belong to in the Library (see View Categories).
  • Visibility: Sets the Dashboard Visibility, which determines who will have access:
    - Private: Visible only to the user who creates the dashboard;
    - Shared: Visible to the entire organization.

 

Default Query Settings

Default query options, which can be overridden in the panes of the Dashboard sidebar (see Dashboard Sidebar Panes), are specified with the following fields:

  • Time Range: Sets the duration of the “show last” (counting back from present) time range to which the panels on the dashboard will default.
  • Devices: Selects the devices to which the panels on the dashboard will default (the default devices can be overridden on individual panels):
    - All: All of your organization’s Kentik-registered devices.
    - Specific devices: Opens a Selected Devices Dialog that enables you to choose from your organization’s Kentik-registered devices.
  • Filters: Sets the filters to be applied by default to the panels on the dashboard (the default filters can be overridden on individual panels). Use the Edit Filters button to open the Filtering Options Dialog, from which you can access the Saved Filters Selector or the Ad-Hoc Filter Interface.

Note: Modifications made to any shared dashboard (see Dashboard Visibility) will affect that dashboard across all users in your organization.

 

Guided Mode Settings

Guided dashboards (Beta) are dashboards that enable users, guided by a prompt at top, to specify (without getting deep into filtering settings) the value of a filter that can be quickly applied to some or all of the dashboard’s panels.

Guided mode settings are specified with the following UI elements:

  • Enabled/Disabled switch: Set to enabled for guided mode or disabled (default) for standard mode.
  • Filter dimension category: A drop-down selector from which to choose the category of the dimensions that will be available for filters applied with the Guided Mode UI.
  • Prompt text: The question to use as a prompt at the top of the guided dashboard.
  • Input type: A drop-down selector from which to choose the type of values that the user will be able to enter as a value for the filter:
    - Predefined: The user will be able to choose values from a drop-down list.
    - Freeform: The user will be able to enter any text.
  • Predefined values (only shown when Input Type is “predefined”): A comma-delimited list of values for the drop-down values selector.

Note: The way that individual panels in the dashboard are affected by the guided dashboard settings above is determined by settings in the Add View Panel or Edit View Panel dialog (see Panel Dialog Settings).

 

Dashboard Dependencies

The Dashboard Dependencies pane is visible only when one of the following two types of Dashboard Navigation have been established with this dashboard:

  • Navigate From: Dashboards on which this dashboard is the destination specified for dashboard navigation from any panel.
  • Navigate To: The destination dashboards specified for any panels on this dashboard.

 

 
 top  |  section

New Dashboard Dialog

The New Dashboard dialog appears when creating a new dashboard directly from Data Explorer (see Add Panel From Explorer). The dialog is used only when saving the current Data Explorer view to a panel on a new dashboard. The settings in this dialog are generally the same as in the Add Dashboard dialog (see Dashboard Properties) but with the following differences:

  • This dialog includes a Dashboard Panel pane (upper right) with a single Title field into which you enter the name of the panel that will appear on the new dashboard.
  • This dialog does not include a Dashboard Dependencies pane.

 

 
 top

Dashboard Sidebar Controls

Dashboard-level controls are found on the Options tab of the Library sidebar. This tab is covered in the following topics:

Note: The sidebar can be collapsed by clicking on the collapse control at the top right of the sidebar; see Library General UI.

 

 
 top  |  section

Dashboard Sidebar Panes

The sidebar contains a set of panes that each includes the controls used to set dashboard-wide settings.

The following panes are found in the sidebar of a dashboard:

  • Time pane: Specifies the dashboard-wide time range covered by the queries whose results are displayed in the dashboard’s individual panels. For a description of the pane’s controls, see Time Pane Settings.
  • Filtering pane: Specifies the dashboard-wide filters that apply to any panel on the dashboard whose Filter Behavior property is set to Controlled by Dashboard (see Panel Dialog Settings). For a description of the pane’s controls, see Filtering Pane Settings.
  • Devices pane: Specifies the devices for any panel on the dashboard whose Device Behavior property is set to Controlled by Dashboard (see Panel Dialog Settings). For a description of the pane’s controls, see Devices Pane Settings.

 

 
 top  |  section

Applying Sidebar Changes

The Options tab for dashboards includes two buttons located above the individual panes of the sidebar:

  • Apply button: Applies changes made in the Time, Filtering, and Devices panes to any sidebar-controlled panels in the display area (see Dashboard Panel Display):
    - When there are changes to apply, the button will be blue and an alert will appear over the display area.
    - When there are no changes to apply the button will be grayed out.
  • Reset button: Discards any changes made to the sidebar controls since changes were last applied with the Apply button.

Note: Sidebar changes are only applied to panels on which either the Filter Behavior or Device Behavior property is set to Controlled by Dashboard.

 

 
 top  |  section

Guided Mode UI

A guided-mode dashboard includes additional controls that allow a user to quickly specify the value of a filter that is applied to some or all of the dashboard’s panels. These controls, located near the top of the Options tab (just below the Reset and Apply buttons), include the following UI elements:

  • Prompt: The prompt specified with the Prompt Text field (see Guided Mode Settings) when the dashboard was added or edited.
  • Filter value selector: Used to choose the value of the dashboard’s guided-mode filter. The selector type varies depending on the dashboard’s guided-mode input type:
    - Freeform: A field into which the value may be entered.
    - Predefined: A drop-down list from which the value must be chosen.

When the above controls are set, use the Apply button to set the current Filter value selector setting as the value of the dashboard’s predefined filter dimension (see Dimension to filter by in Guided Mode Settings), and applies the guided-mode filter to all panels on the dashboard except those whose Guided Mode Behavior is set to Ignore (see Panel Dialog Settings).

 

 
 top

Dashboard Panel Display

In each individual dashboard, the area to the right of the sidebar is the panel display area, which contains the title, display controls, and panels of the dashboard. This area is covered in the following topics:

 

 
 top  |  section

Dashboard Title Bar

The title bar stretches across the top of the dashboard’s display area, identifying the current dashboard and containing the elements described below.

The left side of the title bar contains the following indicators:

  • Breadcrumbs (shown only on dashboards arrived at via Dashboard Navigation): Indicates the nesting hierarchy (the path used to get to the dashboard from a source panel on another dashboard). The levels above the current level are links.
  • Category: The category (if any) to which the dashboard is assigned in the Library (see View Categories).
  • Title indicator: The area at the left of the title bar includes the following parts:
    - Dashboard title: The name given by the user when the dashboard is created or edited (see Dashboard Properties).
    - Dashboard mode tag: Indicates if the dashboard mode is standard or guided.
    - Visibility tag: Indicates the visibility (private, shared, or preset) of the dashboard (see Dashboard Visibility).
  • Favorites: A button (star icon) that toggles the saved view between being or not being shown in the Favorites folder at the top of the Library tab in the sidebar.
  • Description: Text that explains the dashboard’s purpose and what it’s intended to show.

The right side of the title bar contains the following controls:

  • Edit Mode button (not shown on Kentik-provided preset dashboards): Shows the Edit Mode Controls and enables the editing of Dashboard panels and rearrangement of panel layout in the display area. When you click the Edit Mode button and enter edit mode, the button itself is replaced with the following two buttons:
    - Save Changes: Saves changes and exits edit mode.
    - Cancel: Exits edit mode without saving changes.
    Note: To modify a preset, first find it in the Kentik section of the Library List, clone it, and then edit the clone.
  • Live Update: Enables Live Update at the interval (60, 90, or 120 seconds) chosen from the drop-down menu (see Live Update Mode). When Live Update is enabled, the button is replaced with a Stop Updating button. click it to disable Live Update.
  • Refresh button: Immediately updates the graphs in all panels.
  • Export Dashboard (up arrow icon): Allows you to export a PDF of the current state of the graphs, with each dashboard panel occupying a separate page in the document. The resulting PDF will open in a new tab of the browser and can be downloaded from there.

 

 
 top  |  section

Parent Panel Pane

Displayed below the Dashboard Title Bar, this pane is visible only on dashboards that have been arrived at directly from another dashboard via Dashboard Navigation. The pane enables you to see the “source panel” from which you navigated to the nested dashboard, and also to filter the traffic displayed in the nested dashboard’s panels by enabling/disabling any series in the parent panel (click on the series in the graph’s key).

The pane contains the following UI elements:

  • Collapse button: Collapse the Parent Panel Pane.
  • Panel title: The name of the panel from which you navigated to this dashboard (the source panel).
  • Change View button (not shown in edit mode): Set the view type of the parent panel as displayed on this dashboard (see Chart View Types).
  • Show Applied Filters button (shown only in edit mode): Opens a popup that shows the filters applied to the panel as well as their source (dashboard, panel, or both).
  • Panel graph: The graph from the source panel.
  • Key: A set of definitions, below the graph, for the values plotted on that graph. To toggle (off/on) the display of an individual line or area on the graph, click the same-colored swatch in the key. The graph will automatically redraw with the vertical axis re-scaled. The traffic graphed in the rest of the panels on the dashboard will be filtered based on the traffic that is toggled on/off with the parent panel key.
    Note: This filtering feature is not available if source panel displayed in the parent panel pane, is a gauge, map, matrix, or Sankey diagram.
  • Resize bar: Drag vertically to make more or less space for the Parent Panel Pane. The graph in the pane will resize.

 

 
 top  |  section

Edit Mode Controls

When you click the Edit Mode button and enter edit mode, the Add A Dashboard Panel pane is displayed between the Dashboard Title Bar and the Parent Panel pane.

This strip contains the following controls:

  • Add Explorer View: A button that adds a panel based on a view in Data Explorer. See the steps described in Adding Dashboard Panels.
  • Add Alert Scoreboard: A button that adds a panel that is an Alerting Scoreboard like that found at the top of the Active page of the Alerting section of the portal. The resulting Add Scoreboard Panel dialog includes a Title field to name the panel; the rest of the dialog is configured as described in Scoreboard Configuration.
  • Dashboard Properties (gear icon): Opens the Dashboard Properties dialog (see Dashboard Dialogs), allowing you to view and edit the properties of the dashboard.
  • Remove Dashboard button: Opens the Remove Dashboard dialog, in which you can either confirm or cancel removal of the dashboard.

 

 
 top  |  section

Panel Display Area

The panel display area for both guided-mode and standard-mode dashboards contains one or more panels that are each made up of a graph plus associated key and controls (see Panel UI Elements).

 

 
 top  |  section

Panel UI Elements

The UI elements of a panel on a dashboard vary depending on whether the dashboard itself is in edit mode or “view” (non-edit) mode.

 

Common Panel UI

The following panel UI elements are visible in both edit mode and “view” (non-edit) mode:

  • Panel title: The name given to the panel by the user when the graph is created or edited. The title appears at the top of the panel. In view mode it acts as a link that takes you to a view of the panel’s query in the Data Explorer.
  • Graph: A visual (or tabular, if view type is table or matrix) representation of the traffic specified in the settings for the panel over the defined timespan on the selected devices.
  • Key: A set of definitions, below the graph, for the values plotted on that graph. Each series in the graph is represented in the key by a same-colored swatch. See also Filtering With the Key.

 

View Mode Panel UI

The following panel UI elements appear only when the dashboard is not in edit mode:

  • Change View Type (upper right; not shown when dashboard is in edit mode): Selects the type of visualization; for descriptions of view types, see Chart View Types.
  • Clear Selections button (appears only when a series is selected; see Filtering With the Key): Resets the graph so that all series are enabled.
  • Drill Down button (appears only when a nested dashboard has been assigned to this panel; see Navigate To Tab): Enables navigation to a nested dashboard (see Dashboard Navigation). The number of series currently enabled on the graph is displayed next to the button. When you use the button to navigate to a nested dashboard, the Parent Panel Pane on the destination dashboard will be filtered to those currently enabled series.

 

Filtering With the Key

The key accompanying each panel’s graph can be used to filter what’s shown in the graph and also what filters are applied in the Parent Panel Pane on the destination dashboard if one is assigned to the panel (see Navigate To Tab). The key works as follows (as used below, “label” means either the text identifying a given series or the associated colored swatch):

  • The initial state of the graph is that all series are shown. The Drill Down button (shown if there’s a destination dashboard) will not be accompanied by a number, and the Clear Selections button will be hidden.
  • Clicking on a label will “solo” the corresponding series; the plots for all other series will be disabled (not shown in the graph) and the vertical axis is re-scaled. The Drill Down button will be accompanied by the number 1, and the Clear Selections button will be shown.
  • Clicking the same label again will restore the graph to its initial state.
  • Clicking one or more additional labels will enable their corresponding series, adding them back to the graph. The Drill Down button will be accompanied by the number of currently enabled series, and the Clear Selections button will still be shown.
  • Clicking a label for any enabled series will toggle the series back to a disabled state.
  • Clicking the Clear Selections button will restore the graph to its initial state.

Note: If Cross-Panel Filtering (see Panel Dialog Settings) is enabled on a given panel then the filtering applied with a key in that panel will affect the other panels on the dashboard and be indicated in the Filtering pane of the dashboard’s sidebar.

 

Edit Mode Panel UI

The following panel UI elements appear only when the dashboard is in edit mode:

  • Edit button: Opens the Edit View Panel dialog (see About Panel Dialogs), which is used to configure the settings of the panel.
  • Clone button: Opens a pop-up menu from which you can choose where you want the cloned panel to live (current dashboard, existing dashboard, or new dashboard), after which the Add View Panel dialog will open, enabling you to configure the panel (see Panel Dialog Settings). The menu options are:
    - This Dashboard: After saving the settings of the resulting Add View Panel dialog the new panel is added to the current dashboard.
    - Existing Dashboard: The resulting Add View Panel dialog includes a Dashboard pane in which to choose the dashboard to which the new panel will be added.
    - New Dashboard: After saving the settings of the resulting Add View Panel dialog, the Add Dashboard dialog opens, enabling you to configure the new dashboard (see Dashboard Properties).
  • Remove button: Remove the panel from your organization’s collection of Kentik-registered panels.
  • Show Applied Filters: Opens a popup that shows the filters applied to the panel and where those filters originate (dashboard, panel, or both).
  • Resize handle: A handle at the lower right of the panel that you can click and drag to resize the panel.

 

 
 top

Panel Dialogs

Adding or editing a panel via the Kentik portal involves specifying information in the dialogs covered in the following topics:

 

 
 top  |  section

About Panel Dialogs

Panel dialogs are used for the settings of individual panels. The required information is entered into the fields of the following dialogs:

  • Add View Panel when you click the Add Explorer View button in the Add A Dashboard Panel pane (see Edit Mode Controls). The dialog enables you to configure a new view (chart or table) panel on the current dashboard (see Adding Dashboard Panels).
  • Edit View Panel when editing the properties of an existing panel. This dialog appears when you click the Edit button in the title bar of an individual panel (see Editing Dashboard Panels). The Edit button is only visible when the dashboard itself is in edit mode (Edit Mode button on dashboard title bar).
  • Add Scoreboard Panel when you click the Add Alert Scoreboard button in the Add A Dashboard Panel pane. The dialog enables you to configure a new scoreboard panel on the current dashboard.
    Note: Configuration of scoreboards with the Add Scoreboard Panel dialog is covered in Scoreboard Configuration rather than in this article.

 

 
 top  |  section

Panel Dialogs UI

The Add View Panel and Edit View Panel dialogs share the same layout and the following common UI elements:

  • Close button: Click the X in the upper right corner to close the dialog. All elements will be restored to their values at the time the dialog was opened.
  • Remove button (Edit View Panel dialog only): Remove the panel from your organization’s collection of Kentik-registered panels. This button is only present if the panel being edited was manually added.
  • Cancel button: Cancel the add panel or edit panel operation and exit the dialog. All elements will be restored to their values at the time the dialog was opened.
  • Add Panel button (Add View Panel dialog only): Save settings for the new panel and exit the dialog.
  • Save button (Edit View Panel dialog only): Save changes to panel settings and exit the dialog.

 

 
 top  |  section

Panel Dialog Settings

A panel is configured or edited using the fields and controls of the Add View Panel and Edit View Panel dialogs:

  • Title field: A string that will appear in the title bar of the panel.
    Note: In a panel on a guided dashboard you can create a title that always reflects the panel’s current filter dimension and/or value. To do so, insert placeholders — {{filter_dimension}} and/or {{filter_value}} — into your title where you want the actual dimension and/or value to be.
  • Description: A user-specified description that (ideally) explains the purpose for which the dashboard was created.
  • Cross-Panel Filtering: A switch that, when enabled, results in any key-based filtering (see Filtering With the Key) being applied at the dashboard level so that it affects not only the panel in which it is applied but also all other panels on the dashboard.
  • Dashboard pane (shown only in Add View Panel dialog when cloning to existing dashboard; see Edit Mode Panel UI): A drop-down list from which you choose the dashboard to which the new panel will be added.
  • Query tab: Specify the query whose results will be graphed or displayed in the panel. See Panel Query Tab.
  • Guided Mode tab (on guided-mode dashboard only): Settings for panels on guided-mode dashboards; see Guided Mode Tab.
  • Navigate To tab: Settings for specifying a nested dashboard that will be linked to from the panel’s Navigate To button. See Navigate To Tab.

 

 
 top  |  section

Panel Query Tab

The settings on the Query tab define the query whose results will be graphed or displayed in the panel. The tab includes a sidebar at left with the following panes:

  • Query pane: Used to set the dimensions, metrics, and other parameters of the query, this pane contains the same settings as the Query pane of Data Explorer (see Query Pane Settings).
  • Time Range: Determines the time range covered by the panel. See Panel Time Range.
  • Bracketing (shown only if view type is Gauge or Table): Determines the bracketing, if any, to be applied to the panel. See Bracketing Pane Settings.
  • Filtering (on standard-mode dashboard only): The source of the filters applied to the data graphed in the panel; see Panel Filtering.
  • Devices: The source of the devices whose data is graphed in the panel; see Panel Devices.

The sidebar also includes, at top, the Preview Query button. Click the button to see the result of the current settings in the panel preview area at right. The controls in the panel preview are a subset of the controls in the chart display area in Data Explorer (see Explorer Chart Display).

 

Panel Time Range

The Controlled by Dashboard toggle switch in the Time Range pane sets the time range covered by the panel to one of the following:

  • If on (default), the time range will follow the setting in the Time pane in the dashboard sidebar.
  • If off, the time range represented in the panel’s graph is fully independent of the overall dashboard; it will not change when the time range is changed in the Time pane of the dashboard sidebar. Use the drop-down menu to choose the duration of the lookback time frame.

 

Panel Filtering

In the Filtering pane of the Query tab, the drop-down Filter Setting menu is used to specify the source of the filters applied to the data graphed in the panel:

  • Controlled by Dashboard: The filters applied to the panel’s graph are dynamic; they will change whenever the filters specified in the Filters Pane of the dashboard’s sidebar are changed (see Dashboard Sidebar Panes).
  • Additive: The filters applied in the Filters pane in this dialog will be ANDed with any filters that are applied in the sidebar of the dashboard itself.
  • Locked to Specific Filters: The filters applied to the panel’s graph are fully independent of the overall dashboard; they will not change when filter settings are changed in the Filtering pane of the dashboard’s sidebar.

The Edit Filters button opens the Filtering Options Dialog that is used to set the panel-level filtering.

 

Panel Devices

The Controlled by Dashboard toggle switch in the Devices pane sets the devices whose traffic is included in the panel to one of the following:

  • If on (default), the devices represented in the panel’s graph are dynamic; they will change whenever devices are changed in the Devices pane of the dashboard.
  • If off, the devices represented in the panel’s graph are fully independent of the overall dashboard; they will not change when devices are changed in the Devices pane of the dashboard sidebar.

 

 
 top  |  section

Guided Mode Tab

The Guided Mode tab of the Add View Panel and Edit View Panel dialogs is included only in the dialogs for panels on guided-mode dashboards. The settings in this tab determine how filtering on the panel will be affected by the setting of the dashboard’s Guided Mode UI:

  • When a guided-mode behavior option adds a filter to the panel:
    - The new filter’s dimension is set with the Select a Dimension selector (described below).
    - The new filter’s value will follow the guided-mode value set by users on the dashboard itself.
  • When a guided-mode behavior option refers to “existing” filters, those are the filters that were set in the Data Explorer sidebar when the panel was initially created.

Note: The filters, if any, applied with the sidebar of the dashboard itself are not overridden by the settings in this tab. The Filter Behavior of all panels on a guided-mode dashboard is Additive (sidebar filters are ANDed with any other filters; see Panel Dialog Settings).

The Guided Mode tab includes a radio button used to choose one of the following behaviors for filters on the panels of guided-mode panels:

  • Override All Filters: A new filter will be applied to the panel, and all existing filters will be ignored.
  • Override Specific Filters: No new filter is added to the panel. The value of any existing filters using the dimension specified with the Select a Dimension selector will use the guided-mode value set by users on the dashboard.
  • Add Filter Group: A new filter will be added to the panel and ANDed with existing filters.
  • Ignore: No new filter is added to the panel, and the panel ignores the guided-mode value set by users on the dashboard.

The Guided Mode tab also includes a drop-down menu from which to select the dimension used in the behaviors described above. The drop-down lists only dimensions that belong to the dimension category that was specified when the dashboard was added or edited (see Guided Mode Tab).

 

 
 top  |  section

Navigate To Tab

The Navigate To tab includes the following controls used to configure Dashboard Navigation:

  • Enable Dashboard Navigation switch:
    - If on, a Navigate To button will be added to the panel. The button is used to link to a nested dashboard.
    - If off, the rest of the settings on this tab will be hidden.
  • Destination Dashboard selector (only shown once dashboard navigation is enabled): Choose the dashboard to which this panel should navigate (see Destination Dashboard Selector).
  • Destination Dashboard Settings (only shown once a destination dashboard has been selected): Specify how the devices, time range, and filters of the destination (nested) dashboard will be set (see Destination Dashboard Settings).

 

Destination Dashboard Selector

The Destination Dashboard Selector is a drop-down menu enabling you to choose a destination dashboard from a list of all of the dashboards in your organization.

If you choose a guided-mode dashboard (see Dashboard Modes) a set of radio buttons appear to the right of the selector. These buttons determine how the value of the guided-mode dimension will be set when you navigate to the destination dashboard:

  • Fixed value: You set the value, either with a field or a drop-down menu (depends on the type of dimension).
  • Use filter value from this dashboard: Enabled only if the panel for which you are setting a nested dashboard is on a guided-mode dashboard. The guided-mode value of the destination dashboard will be set to the guided-mode value of the source dashboard.
    Note: The guided-mode dimensions of the source and destination dashboards are not validated to ensure that they are the same.
  • Use Drill Down selection: The series currently selected in the panel will be used to determine the value of the guided mode dimension.
    Note: in the event of a mismatch between the guided mode dimension and the panel dimension the Drill Down button will do nothing when clicked. There is currently no validation to prevent such a mismatch.
  • Prompt user: When the user clicks the Navigate To button (see Panel UI Elements), a prompt will appear asking for the value to use for the guided-mode dimension. This behavior is identical to what happens when a user navigates to a guided-mode dashboard directly (without coming from a source dashboard).

 

Destination Dashboard Settings

The Destination Dashboard Settings section of the Navigate To tab is used to specify how the devices, time range, and filters of the destination (nested) dashboard will be set. The following options are available:

Use settings from... Devices Time range Filters Description
Source dashboard Y Y Y Use the settings from the sidebar of the dashboard containing this panel.
Destination dashboard Y Y Y Use the settings from the sidebar of the nested dashboard that is linked-to from this panel.
Source and Destination combined N N Y Combine the filters from both the source and destination dashboards. Available for filters only.
Source panel Y Y Y Use the settings from this panel.
Navigate To tab (“Custom”) Y Y Y Specify custom settings on the Navigate To tab itself. The controls for these settings will be shown when this option is selected.

 

 
 top  |  section

Add View Panel Dialog

The Add View Panel dialog appears when saving the current Data Explorer view to a panel on an existing dashboard (see Add Panel From Explorer). The settings in this dialog are a subset of the fields in the Add Dashboard dialog:

  • Title field: A string that will appear in the title bar of the panel.
    Note: In a panel on a guided dashboard you can create a title that always reflects the panel’s current filter dimension and/or value. To do so, insert placeholders — {{filter_dimension}} and/or {{filter_value}} — into your title where you want the actual dimension and/or value to be.
  • Dashboard pane: A drop-down list from which you choose the dashboard to which the new panel will be added.

 

 
 top

Add or Edit Dashboard

Adding and editing dashboards is covered in the following topics:

 

 
 top  |  section

Adding a Dashboard

Creating a dashboard involves adding a new dashboard to your dashboards collection, after which you would typically add and configure at least one panel for that dashboard (see Adding Dashboard Panels). To add a new dashboard:

  1. Click Library from the Kentik Detect navbar.
  2. Click the New Dashboard button at upper right. The Add Dashboard dialog will open.
  3. In the dialog, specify the settings of the dashboard (see Dashboard Properties), including whether Guided Mode is enabled or disabled.
  4. Click the Add Dashboard button. The dialog will close and the dashboard will be displayed in the Library with the sidebar on the Options tab.

Notes:
- For information on populating the new dashboard with panels, see Adding Dashboard Panels.
- You can also add a dashboard by cloning a panel; see Clone button in Edit Mode Panel UI.
- You can also add a dashboard from Data Explorer; see New Dashboard Dialog.

 

 
 top  |  section

Editing a Dashboard

The details of editing a dashboard vary depending on which aspect of the dashboard you are trying to change:

  1. Click Library from the Kentik Detect navbar.
  2. In the Library page, click on a dashboard listed in the Library tab. The dashboard will open in the display area.
  3. If you opened a guided-mode dashboard, specify a value in the Filter value selector, then click the Apply button.
  4. In the Dashboard Title Bar, click the Edit Mode button.
  5. In edit mode, do one of the following:
    Add a panel: see Adding Dashboard Panels.
    Change dashboard settings: Click the Dashboard Properties button. The Dashboard Properties dialog will open. Change any desired settings (see Dashboard Properties), then click the Save button.
    Remove the dashboard: Click the Remove button, which opens a confirming dialog.
    Rearrange panel layout: In edit mode, panels can be moved and resized:
    - Move panel: Position the cursor on the desired panel. The move cursor will appear. Drag the panel to the desired new location. When the dragged panel is dropped, the other panels will rearrange around it.
    - Resize panel: A resize handle will appear at the bottom right of each panel. Drag the handle to change the size of the panel. Surrounding panels may be rearranged to accommodate the new size.
    Change panel settings: see Editing Dashboard Panels.

Note: Modifications made to any shared dashboard (see Dashboard Visibility) will affect that dashboard across all users in your organization.

 

 
 top

Add or Edit Panels

As described in About Dashboards, dashboards are made up of one or more individual panels that each contain a single graph that represents a query. The following topics cover working with panels:

Note: The elements that make up each panel are described in Panel Display Area.

 

 
 top  |  section

Adding Dashboard Panels

To add a panel to a dashboard:

  1. Click Library from the Kentik Detect navbar.
  2. In the Library page, click on a dashboard listed in the Library tab. The dashboard will open in the display area.
  3. If you opened a guided-mode dashboard, specify a value in the Filter value selector, then click the Apply button.
  4. In the Dashboard Title Bar, click the Edit Mode button. The Add A Dashboard Panel pane (see Edit Mode Controls) will appear below the title bar.
  5. Click one of the following:
    - Add Explorer View button: The Add View Panel dialog will open. Configure the settings described in Panel Dialogs.
    - Add Alert Scoreboard button: The Add Scoreboard Panel dialog will open. Configure the settings described in Scoreboard Configuration.
  6. When the dialog settings are complete, click the Add Dashboard Panel button to save the settings and close the dialog. The new panel will now appear on the Dashboard.
  7. In the dashboard title bar, click the Save Changes button to exit edit mode.

Notes:
- To add additional panels, repeat the above starting with step 3.
- Panels added to any shared dashboard (see Dashboard Visibility) will affect that dashboard across all users in your organization.

 

 
 top  |  section

Add Panel From Explorer

In addition to adding panels to a Dashboard with the Add View Panel button, you can also add a panel directly from the Data Explorer:

  1. At the upper-right of the chart display area in the Data Explorer (see Chart Display UI), click the drop-down View Options menu.
  2. Choose one of the following:
    - Add To New Dashboard: Choosing this option will open the New Dashboard Dialog. Specify settings for the new dashboard, then click the Add Dashboard button. The new dashboard will open and will display the new panel.
    - Add To Existing Dashboard: Choosing this option will open the Add View Panel Dialog. In the Dashboard pane, choose the existing dashboard to which you want to add the new panel, then click the Add View Panel button. The dashboard will open with the panel that you just added, and a notification will confirm that the new panel was created.

 

 
 top  |  section

Editing Dashboard Panels

The settings of an individual dashboard panel are edited in the Edit View Panel dialog. To edit panel settings:

  1. Click Library from the Kentik Detect navbar.
  2. In the Library page, click on a dashboard listed in the Library tab. The dashboard will open in the display area.
  3. If you opened a guided-mode dashboard, specify a value in the Filter value selector, then click the Apply button.
  4. In the Dashboard Title Bar, click the Edit Mode button.
  5. The title bar of each individual panel will now include an Edit button. Click the button in the panel that you want to edit.
  6. In the resulting Edit View Panel dialog, make your changes to the panel settings (see Panel Dialog Settings).
  7. Click the Save button to save your changes and return to the dashboard.

Note: Modifications made to a panel on any shared dashboard (see Dashboard Visibility) will affect that dashboard across all users in your organization.

 

 
 top

Adding Dashboard Navigation

Dashboards are nested via settings for the dashboard panel from which you will be navigating. In the following example, we’ll nest an existing dashboard (the “destination dashboard”) on an existing panel (the “source panel”) of another existing dashboard. The process would be similar when using a new dashboard or panel.

  1. Click Library from the Kentik Detect navbar.
  2. In the Library page, click on a dashboard listed in the Library tab. The dashboard will open in the display area.
  3. If you opened a guided-mode dashboard, specify a value in the Filter value selector, then click the Apply button.
  4. When the dashboard opens, click the Edit Mode button at upper right (see Dashboard Title Bar). The title bar of each individual panel will now include an Edit button.
  5. Click the Edit button in the panel on which you want to establish navigation to a different dashboard. The Edit View Panel dialog will open (see About Panel Dialogs).
  6. Use the controls of the Navigate To Tab to specify the destination dashboard (see Destination Dashboard Selector) and set the Destination Dashboard Settings.
  7. Save the changes you’ve made to the Edit View Panel dialog.
  8. Back in the dashboard title bar, click the Save Changes button to exit edit mode. The panel to which you added navigation will now have a Drill Down button at lower left. When you hover over the button, the tooltip will now show the name of the nested dashboard. Click the button to go to that dashboard.
 

In this article: