Working with dashboards

In Reporting, a dashboard organizes a collection of panels. A panel can contain a chart, text, and action deployment options. Chart panels are based on report data. A dashboard can have one or more collapsible sections to organize related panels. For an overview of dashboards, including Tanium-managed and emerging issue dashboards, see Dashboards.

View dashboards

Perform the following steps to open a dashboard. You can access only dashboards that are in content sets for which you have Reporting Dashboard read permission.

  1. From the Main menu, go to Data > Dashboards.

    The Dashboards page lists all the dashboards that you have permissions to access.

    The page shows basic settings for each dashboard, such as the Dashboard Name and Content Set. If a dashboard has a description, labels, and associated reports, click Expand beside the Dashboard Name to see these additional settings. To see the additional settings for all dashboards, click Expand in the column heading. Associated reports are reports that serve as a chart source for a dashboard (see Chart data sources). For details on other basic settings, see Dashboard settings.

  2. (Optional) Use the following search and filter options to facilitate finding specific dashboards if the grid is long. The grid shows only the dashboards that match all the filters and search text that you specify.

    Dashboard search and filter options
    Option Description
    Filter by labels

    Select Labels to show only the dashboards to which those labels are assigned.

    You can also use the Labels panel to add, edit, or delete labels. See Managing labels.

    Filter by favorites

    Use the Show buttons to toggle between showing All dashboards or only dashboards that are in your favorites list .

    Click beside a dashboard name to add the dashboard to your favorites list or click to remove the dashboard from your favorites list.

    Filter by content set Select a content set to show only the dashboards that are assigned to that set.
    Filter by author Select a user name to show only the dashboards that the user created or select one of the Tanium Managed options to show only the predefined dashboards that Tanium provides (see Tanium-managed dashboards).

    Filter by creation date

    Date range

    Specify a range of dashboard creation dates by clicking the Created on and to calendar widgets Date range.
    Search by text Enter an alphanumeric string to filter by dashboard name or description.
  3. (Optional) Select a View as option to determine how the page displays the dashboards:

    Dashboard views
    View option Description

    List view (default)

    List the dashboards only by text attributes, such as name, author, and content set assignment.

    Grid view

    Display the dashboards as a grid, with a row for each dashboard. Each row shows small previews of the dashboard charts.

    In grid view, the charts render faster if you use the search and filter controls to reduce the number of dashboards before clicking .

    Click in a chart to add that chart to your favorites list or click to remove the chart from your favorites list.

    Click Next Next to see charts that do not fit in your browser view.

    By default, the grid is sorted Sort by Dashboard Name but you can select another attribute (such as Content Set assignment) in the dropdown.

    You can change the computer group filter for:

    • All dashboards: Select a group in the Computer Group dropdown.
    • A specific dashboard chart: In the chart, click Computer Group Computer group filter and select a group.
    Only computer management groups appear as filter options for dashboards. For information about the types of computer groups, see Tanium Console User Guide: Managing computer groups.

    The computer group that you select applies only to the current instance of the Dashboards page. To change computer group filters permanently, edit the dashboard. See Edit dashboards.

  4. Click a Dashboard Name to open the dashboard. You can then perform the following dashboard management tasks.

    If dashboard panels include endpoint data that is no longer relevant, you can purge the data that Tanium Data Service currently stores for those endpoints. See Purge endpoint data.

    Dashboard management tasks
    Task Description
    View or edit basic dashboard settings

    Click beside the dashboard name to show the dashboard description, content set assignment, label assignments, author (creator), creation date/time, date/time of the last update, user who performed the last update, and the reports that the dashboard uses.

    Each report name is a link that opens the report.

    Each label name is a link that opens the Dashboards page with the label selected as a filter in the Labels section.

    Perform the following steps to edit the dashboard name, description, content set assignment, or label assignments.

    For Tanium Managed dashboards, the only allowed edits are assigning a different content set and adding labels.

    1. Click Edit beside the dashboard name.

    2. Update the settings and click Save.

    Set favorite status

    Click beside a dashboard name to add the dashboard to your favorites list or click to remove the dashboard from your favorites list.

    Filter by Computer Group

    Computer group filter

    The following options are available to filter charts by computer group:

    • Select a Computer Group in the dropdown if you want all the charts to show data from only that group. Your selection overrides the default computer group that is configured in each chart (see Default Group). Reporting saves your selection without opening the dashboard in edit mode and requiring you to manually save.

    • To override the computer group for a single chart, click Computer Group Computer group filter within the chart and select a group. You cannot save the override selection; the next time you open the dashboard, it shows data for the default computer group.

    Only computer management groups appear as filter options for dashboards. For information about the types of computer groups, see Tanium Console User Guide: Managing computer groups.

    Some charts might not contain data for certain computer groups. See Data is missing from certain endpoints.

    Filter by Timeframe

    Select a Timeframe if you want all the charts to show data only from a specific date or date range. Your selection overrides the timeframe that is configured in each chart (see Date/Timeframe). Reporting saves your selection without opening the dashboard in edit mode and requiring you to manually save.

    Based on the chart type, you can open a tooltip that indicates the date/time when Reporting ran a collection for the data:

    • Historical charts: In area charts and line charts, hover over a data point.
    • One-day charts: In other chart types, hover over the chart name.

    For details on the Timeframe options, see Date options. For details on how Reporting collects data for a timeframe, see Historical data collection.

    Some charts might not contain data for certain time frames. See Data is unavailable for timeframe.

    Export as JSON or HTML

    To export the dashboard as an HTML or JSON file to the downloads folder of your local browser, click Export and select Dashboard as HTML or Dashboard Definition as JSON. For details, see Export dashboards.

    To export dashboards in HTML format to a destination other than the downloads folder of your local browser, see Export dashboards through Tanium Connect.

    To import dashboard configurations from a JSON file into another Tanium Cloud instanceTanium Server, see Import dashboards.

    Refresh data

    By default, a dashboard updates every two minutes when the browser tab is open. In the dashboard header, click Refresh to manually refresh all charts on the dashboard. To change the automatic refresh interval, click and either select an interval or select Pause auto refresh to stop automatic refreshes.
    Edit dashboard contents Click Edit and perform the steps under Edit dashboards to change which sections, charts, and data the dashboard includes.
    Clone dashboard Click Clone and perform the steps under Clone dashboards.
    Open associated reports

    If you set the View as option to Grid View , you can click the name of a chart panel to open the report that provides the chart data. The report opens in a new browser tab.

    Clicking a data point in the chart opens the report with that data point applied as a filter.

    When you click a data point from a past date/time in a historical chart, the report that opens shows the current data, not the past data.

    Deploy actions

    (Action panels only) If an action panel indicates an issue on endpoints that requires attention and provides a Deploy Action option, you can address the issue by deploying an action to the endpoints. If only one action is available, the panel provides a Deploy Action button. If multiple actions are available, the panel provides a Deploy Action dropdown. Clicking the button or selecting a dropdown option opens the Action Deployment page, where you can configure and schedule the action. See Tanium Console User Guide: Deploying actions.

    Action panels are a feature of emerging issue dashboards that Tanium manages (see Emerging issue dashboards) but custom dashboards can also have action panels (see Add action panels).

    Delete dashboard Click Delete and perform the steps under Delete dashboards.

Create dashboards

You have two options for creating dashboards:

  • Create new dashboards
  • Clone dashboards: This is a quicker workflow if an existing dashboard has settings, sections, and panels that are similar to what you want for the new dashboard.

Tanium-managed dashboards might provide the information that you want without the need to create a custom dashboard. See Tanium-managed dashboards.

Create new dashboards

  1. From the Main menu, go to Data > Dashboards.
  2. Click Create Dashboard and configure the following settings:

    Dashboard settings
    Setting Decription
    Dashboard Name Enter a name of up to 255 characters to identify the dashboard.
    Content Set Assign the dashboard to a Content Set. The dropdown lists only the content sets for which you have Dashboard write permission. Only users who have Dashboard read permission for the content set can access the dashboard.

    Description

    (optional)

    Enter a description for other users to understand the purpose and contents of the dashboard.

    Labels

    (optional)

    Assign one or more labels to use when filtering the Dashboards page by labels.

    If the list of labels is long, use the search field within the dropdown to quickly find labels. The search field shows each selected label as a pill with an X.

    Click X within a pill to unassign that label or click the X to the right of all the pills to unassign all labels.

    To simultaneously create and assign a label, type its name in the Labels search field and select Create <name> in the dropdown.

    For information on labels, see Managing labels.

  3. Click Create. Reporting saves the dashboard and opens it in edit mode.
  4. (Optional) Select the Computer Group and Timeframe filters. For details, see Filter by Computer Group and Filter by Timeframe.
  5. Perform the following tasks to add sections and panels to the dashboard, and then click Save:

Clone dashboards

  1. From the Main menu, go to Data > Dashboards.

  2. Click the Dashboard Name of the dashboard with settings and contents that are similar to dashboard you want to create.
  3. Click Clone, edit the settings (see Dashboard settings), and click Save. Reporting saves the dashboard and opens it in edit mode.
  4. (Optional) Select the Computer Group and Timeframe filters. For details, see Filter by Computer Group and Filter by Timeframe.
  5. Edit the sections and panels as necessary (see Edit dashboards), and then click Save.

Edit dashboards

Limitations when editing dashboard attributes

You can edit the sections, panels, filters, and basic settings of a custom dashboard.

To edit the label assignments of multiple dashboards in a single operation, see Manage label assignments for dashboards.

The only allowed edits for Tanium-managed dashboards are assigning a different content set and adding labels. However, you can clone a Tanium Managed dashboard and edit all the settings of the clone. See Clone dashboards.

If you remove Tanium-assigned labels from a Tanium-managed dashboard, those labels are restored the next time you update or re-import Reporting. However, you can remove labels that another user assigned to a Tanium-managed dashboard.

For details on Tanium-managed dashboards, see Tanium-managed dashboards.

Edit a dashboard

  1. From the Main menu, go to Data > Dashboards and click the Dashboard Name of the dashboard that you want to edit.
  2. To edit the dashboard name, description, content set assignment, or label assignments, click Edit beside the name, update the settings, and click Save. For details on these settings, see Dashboard settings.
  3. To edit the Computer Group and Timeframe filters, see Filter by Computer Group and Filter by Timeframe.
  4. To edit dashboard sections and panels, click Edit, and perform the corresponding tasks.
    The dashboard editor contains a grid layout to assist when you resize and move panels within the grid.

    If you resize or move panels in a section, the section might automatically resize vertically to match the largest height of panels.

    Dashboard editing tasks
    OptionDescription
    Add sectionsAdd sections to the dashboard. See Add sections.
    Edit section namesType over the existing name for a section to rename it. Section names can have up to 255 characters.
    Move sections

    Select Reorder Sections, and then click and drag sections in the desired order.

    Delete sectionsClick Delete beside the section name to delete the section and any panels in it.
    Add panels

    Add one or more panels to each section:

    Edit panelsClick Edit at the top of the panel and configure the settings just as you do when adding a panel.
    Move panels

    Click the blank space in a panel, and then drag the panel to the desired location. When you release the mouse button, the panel snaps to the nearest coordinates on the design grid.

    Resize panelsClick and drag any panel corner or panel edge midpoint. When you release the mouse button, the panel snaps to the nearest coordinates on the design grid. The panel size determine how much data the panel shows. To show more data, enlarge the panel.
    Delete panelsClick Delete Delete at the top of the panel.
  5. Click Save when you finish editing the dashboard.

Any changes that you make to the dashboard are not saved until you click Save.

Add sections

In dashboards, a section is a collapsible division that groups related panels. A dashboard can have multiple sections, and each section can contain multiple panels. A dashboard requires at least one section. If you add a panel to a dashboard without a section, Reporting automatically creates a section for the panel.

  1. Perform one of the following steps to add a section to an existing or new dashboard:
    • Existing dashboard: From the Main menu, go to Data > Dashboards, click the Dashboard Name, and click Edit.

    • New dashboard: Clone an existing dashboard or create one from scratch. The new dashboard automatically opens in edit mode. For details, see Create dashboards.
  2. Select Add > Add Section.

    Reporting adds the section to the bottom of the dashboard.

    To move the section, select Reorder Sections, and then click and drag sections into the desired order.

  3. Scroll to the bottom of the dashboard to find the new section.
  4. (Optional) Enter a name of up to 255 characters for the section.
  5. Add one or more panels to the section:
  6. Click Save when you finish editing the dashboard.

Add chart panels

A chart panel contains a chart that helps users to visualize metrics from a report. The report that you want to use for the panel must exist before you add the panel to a dashboard. You do not have to add a visualization chart to the report but, if you do, the chart settings in the report have no effect on the chart that you configure for the dashboard. To verify that a report exists or to create a new report, see Working with reports.

For example chart panels, see Chart types.

  1. Perform one of the following steps to add a panel to an existing or new dashboard:
    • Existing dashboard: From the Main menu, go to Data > Dashboards, click the Dashboard Name, and click Edit.

    • New dashboard: Clone an existing dashboard or create one from scratch. The new dashboard automatically opens in edit mode. For details, see Create dashboards.
  2. Perform one of the following steps depending on the dashboard section where you want to add the panel:

    • Bottom section: At the top of the dashboard, select Add > Add Chart Panel.
    • Any other section: In the section where you want the panel, select Add Panel > Add Chart Panel.
  3. Use the Add Panel dialog to specify the following settings:
    1. Configure the basic panel settings:
    2. Panel settings: basic
      SettingDescription
      Select ReportSelect the report from which to retrieve information. This field lists only the reports that are in content sets for which you have Report read permission.
      Group By Column(Optional) Select one or more report columns by which to group data on the chart. Reporting performs aggregations for each group that you select. The combined values of the selected groups appear as labels on the chart. Reporting automatically populates the dropdown with the report columns. If you do not select an option, Reporting shows results as a single aggregate.
      Aggregate

      Aggregation summarizes the data in each group. This field appears for number charts and charts with numeric columns. You can select:

      • Count: Display the number of items in the group. Reporting automatically aggregates the results by Count if you do not select an Aggregate.
      • Percentage: (Number charts only) Display the data as a percentage of the selected group divided by the total of all groups in the source column. For example, consider a column that contains 100 rows: 75 rows contain True, 20 rows contain False, and 5 rows contain N/A. If you aggregate by percentage and select False for the Group, the percentage that appears is 20% based on the formula (20 / (75+20+5)) * 100.
      • <column name> [Average | Max | Min | Sum]: If the report contains numeric columns, you can also aggregate the data in each group based on a numeric column. The following options are available for each numeric column:
        • Average: Display the total value of all items in the group (the Sum) divided by the number of items in the group.
        • Max: Display the maximum item value in the group.
        • Min: Display the minimum item value in the group.
        • Sum: Display the total value of all items in the group.
    3. (Optional) Add Advanced Filters. You can filter by a filter group and by a source condition. If you add both filters, data must match both filters to appear in the chart.
      Panel settings: filters
      SettingDescription
      Filter Group

      If you select a filter group, the chart shows results only from that group. Reporting refreshes the chart preview based on your selection. If the list of filter groups is long, use the typeahead within the Filter Group dropdown to quickly find filter groups.

      The Filter Group dropdown contains only the groups that are assigned to a content set for which your account has Filter Group read permission. For details about filter groups, see Tanium Console User Guide: Managing filter groups. For details about configuring and assigning role permissions, see Tanium Console User Guide: Managing roles.

      SourceSelect a source condition that report data must match. A source condition contains a source, operator, and a value. For example, if you want to show data from Linux endpoints, select Operating System for the source, contains for the operator, and linux for the value.
    4. Select a chart type:

      Vertical bar chart vertical bar

      Donut chart donut

      Number chart number

      Line chart line

      Area chart area

      Table chart table

      After you select a type, the Preview pane shows the chart at different sizes. You can resize the chart after you add the chart to the dashboard. For information about chart types, see Chart types.

    5. Customize the advanced panel settings. The available settings depend on the selected report and chart type.
    6. Panel settings: advanced
      SettingDescription
      NameEnter a name of up to 255 characters to appear at the top of the panel.
      DescriptionEnter a description to appear under the panel name.
      Group(Number charts only) Select the group value to display for the chart.
      Date/Timeframe

      Select a Timeframe (date range) for historical charts or a single Date for one-day charts. For details about the date options for these chart types, see Date options.

      Reporting starts collecting data for charts when you save the dashboard. Historical charts show a Collecting initial data message until the data exists. The chart preview shows any available data so you can see how the chart appears. You might lose historical data if you change certain chart settings. For more information, see Historical data collection.

      After you save the dashboard and view it, you can select a dashboard-level Timeframe that overrides the Date or Timeframe in the chart configuration. See Filter by Timeframe.

      Subtitle(Number charts only) Enter text to display under the value in the number chart.
      Timeframe Label(Number and donut charts only) Enter text to display under the chart. The default value matches the Date value.
      Default Group

      Select the default computer group for which to show data in the panel. The options include only computer groups that are registered with Reporting (see Register computer groups for collection) and that you have RBAC permission to access. To show data from all endpoints, select All Computers.

      When you view an existing dashboard, you can select a dashboard-level Computer Group to override the Default Group. See Filter by Computer Group.

      Use the Filter Group option in the Advanced Filters instead of the Default Group. The Default Group field can unintentionally reduce visibility for users because it limits the results to one computer group. To provide more flexibility to end users, set this field to All Computers and use the Filter Group option in the Advanced Filters to narrow the results instead. See Filter Group.

      Only computer management groups appear as options. For information about the types of computer groups and how to assign them for RBAC, see Tanium Console User Guide: Managing computer groups.

      Max ResultsThe maximum number of items to display in the chart.
      Scale

      For vertical bar charts, area charts, and line charts, select how to scale values on the y-axis:

      • Linear: Use consistent values on the y-axis. For example, if the minimum data point on a chart is 1, and the maximum data point is 100, the y-axis values would be 0, 20, 40, 60, 80, and 100.
      • Logarithmic: Scale the y-axis on an exponential basis. Use this option for charts that contain a large range of data points.
      Value Format

      Select a format for the chart values if the Aggregate is set to a percentage or numeric column value:

      • Percent: Adds % as a suffix to the values
      • None: No suffix is added

      The format selection controls only the value unit that appears in the chart and does not change the actual value.

      The format option is not available for table charts or charts in which the Aggregate is set to Count.

      Sort

      Select an item name or value (result) by which to sort items in the chart. Click for ascending order (low to high) or for descending order (high to low).

      X-Axis LabelEnter a label to display horizontally under the chart. This option only displays for chart types that use axis labels.
      Y-Axis LabelEnter a label to display vertically to the left of the chart. This option only displays for chart types that use axis labels.
      Trend Indicator(Number charts only) Select to hide or show a trend indicator on the chart. When you select Show, select the direction of the indicator, and the date to compare with the current value. If the value that you want to compare against does not exist, the trend indicator does not appear on the panel.
      Legend Display Options

      Use this section to customize the items that appear in the chart.

      • Exclude items: Clear the check box for an item to exclude that item from the chart.
      • Customize colors: Click the colored disk beside an item to change the color that the chart uses for the item. Multiple items can use the same color.
      Conditional Formatting

      Conditional formatting helps users identify issues that need attention. If chart data matches the specified threshold, the chart shows a label and (optionally) background color that indicates the issue severity. In the following example, risk scores match the Needs Improvement threshold:

      If you add multiple conditions to a chart, Reporting evaluates them in descending order: it applies the first condition that matches the corresponding threshold.

      If you specify exclusions in the Legend Display Options, Reporting still evaluates the excluded items and applies conditional formatting if they match thresholds.

      To add conditional formatting:

      1. Expand Expand the Conditional Formatting section and click + Add.
      2. Click the severity color dropdown Severity and select a severity level for the label to show:

      3. Select Apply Color to Panel to apply the color to the chart background or clear the check box to retain the default background color.
      4. Click Assign to apply your selections.
      5. In the Select Group dropdown, select the result on which to base the condition. Reporting populates the dropdown based on the Group By Column setting.
      6. Select an Operator (such as < Less Than) for matching the condition.
      7. Enter the condition threshold and select the threshold units (such as Count).

      For number charts, if the previous period of data is 0, the Trend Indicator shows 100% if the current data is positive, and -100% if the current data is negative. Both of these conditions trigger conditional formatting.

  4. Verify that the chart and text appear as you expect in the Preview pane, and then click Done.

    Click Show Underlying Report Data to view the report data for the chart in the same pane.

    The Preview pane contains an option to change the computer group, which enables you to preview data from different computer groups. Changing the computer group affects only the data in the Preview pane, and the change is not saved when you save the panel.

  5. Click Save when you finish editing the dashboard.

Add action panels

An action panel contains a message that alerts users to issues that require attention. Optionally, you can configure the panel to identify the number of affected endpoints and to provide corrective actions that users can deploy to those endpoints. In the following example, the action panel indicates how many endpoints have the PrintNightmare vulnerability and provides options for mitigating the vulnerability and for rolling back the mitigation action.

Action panel

Before you add action options to a panel, the packages that the actions deploy must exist. If no Tanium-defined packages exist for the issues that the panel addresses, see Tanium Console User Guide: Create a package.

You can see examples of action panels in Tanium-managed emerging issue dashboards. See Emerging issue dashboards.

An action panel is similar to a Tanium Feed notification. See Tanium Feed User Guide: Notifications.

  1. Perform one of the following steps to add a panel to an existing or new dashboard:
    • Existing dashboard: From the Main menu, go to Data > Dashboards, click the Dashboard Name, and click Edit.

    • New dashboard: Clone an existing dashboard or create one from scratch. The new dashboard automatically opens in edit mode. For details, see Create dashboards.
  2. Perform one of the following steps depending on the dashboard section where you want to add the panel:

    • Bottom section: At the top of the dashboard, select Add > Add Action Panel.
    • Any other section: In the section where you want the panel, select Add Panel > Add Action Panel.
  3. Configure the following settings and then click Done:
    Action panel settings
    TabSettings
    Type
    • Category: Select Recommended Action if you want the panel to provide the option to deploy actions.

    • Topic: Select Emerging Issues if the panel addresses an emerging issue.
    • Priority: Select a priority level to help users understand the importance and urgency of the issue that the panel addresses.
    Message

    Enter the text for users to read in the panel. For example, if the message concerns a vulnerability, you can enter highlights of the latest industry information and Tanium insights on the vulnerability.

    If you want the message to include the count of affected endpoints, repeat the following steps for each issue for which you want to add a count:

    1. Move your cursor to the spot in the message where you want the count to appear.

    2. Select the report that provides the count and click Add.
    Actions

    (Optional) You can add one or more actions to deploy packages that remediate or mitigate issues on endpoints, or to roll back previous remediations or mitigations. Repeat the following steps for each action:

    1.  Click Add Action.

    2. Enter an Action Label to appear in the Deploy Action dropdown of the panel. The label applies only if the panel provides multiple actions. If only one action is available, the panel displays a button labeled Deploy Action regardless of the label you configure.
    3. Select the Package Name.
  4. Click Save when you finish editing the dashboard.

Add text panels

A text panel contains static text that provides context to the report.

ClosedExample text panels

  1. Perform one of the following steps to add a panel to an existing or new dashboard:
    • Existing dashboard: From the Main menu, go to Data > Dashboards, click the Dashboard Name, and click Edit.

    • New dashboard: Clone an existing dashboard or create one from scratch. The new dashboard automatically opens in edit mode. For details, see Create dashboards.
  2. Perform one of the following steps depending on the dashboard section where you want to add the panel:

    • Bottom section: At the top of the dashboard, select Add > Add Text Panel.
    • Any other section: In the section where you want the panel, select Add Panel > Add Text Panel.
  3. Configure the following settings to compose the text in the panel, and then click Done.
    Text panel settings
    SettingDescription
    FormatUse the dropdown to select the format of selected text (such as Heading or Paragraph), or to enter new text in that format. Select Metric Set to add a row of metrics. See Add Metric.
    BTo apply bold formatting to text, select it and click B.

    Add Link

    Link

    To add a link, click Add Link Link, enter the Text to display, enter the Link URL, and click Save. The link can be absolute or relative. The icon that renders with the link indicates if the link is external or links to another page in Tanium Console.

    For security, a confirmation prompt appears when a user clicks an external link in the Console. If the link targets a Console page for which the user does not have access permissions, the link renders as static text.

    Add Metric

    Metric

    To add metrics to the panel:

    1. Click Add Metric Metric, enter a Name and Value for the metric, and specify any optional fields.

    2. If you are finished adding metrics, click Apply to add the metric to the text panel and to close the Edit Metric dialog. If you want to add another metric, click Add to add the metric to the text panel but keep the Edit Metric dialog open.

    To include multiple metrics in a horizontal row, select the Metric Set option from the dropdown menu on the Edit Text dialog. A shaded row appears in the dialog. Click the row, and then click Add Metric Metric. When you add metrics, click Add to add another metric to the row.

  4. Click Save when you finish editing the dashboard.

Export dashboards

You can export dashboards in the following file formats to the downloads folder of your local browser:

  • JSON: Export dashboard configurations as a JSON file to import into another Tanium Cloud instanceTanium Server. See Import dashboards.
  • HTML: Export the dashboard as a standalone HTML file that you can distribute to stakeholders or post to an internal web server.

To export reports in HTML format to a destination other than the downloads folder of your local browser, see Export dashboards through Tanium Connect.

Exported dashboards include data for the currently selected Computer Group and Timeframe filters.

Dashboard read permission is required to export dashboards. To export dashboards that are associated with reports (through chart panels), Report read permission is also required. The predefined roles that have these permissions are Aministrator, Reporting Operator, Reporting User, and Reporting Viewer.

  1. From the Main menu, go to Data > Dashboards.
  2. Perform one of the following steps based on the preferred export format:
    • JSON: Select the dashboards and select Export > Dashboard Definition as JSON (single dashboard) or click Export Dashboard Definitions (multiple dashboards).

      The Export > Dashboard Definition as JSON option is available within a dashboard also if you open the dashboard.

    • HTML: Click the Dashboard Name to open the dashboard and select Export > Dashboard as HTML.

The exported file has the name dashboard_definition_export_<month_day_year>.json or <dashboard-name>_<month_day_year>.html.

Export dashboards through Tanium Connect

Use Connect to send dashboards to Connect destinations.

Before you begin

  • Your Tanium license must include Connect.
  • You must install Connect 5.9.65 or later and Reporting 1.12 or later.
  • You must have access to Connect with the Connect Operator or Connect Administrator role.
  • You must have a role with the Dashboard read and Report API user permissions. Predefined roles with required permissions include Reporting Operator and Reporting User.
  • Reporting must have one or more dashboards.

Create a connection

The following steps describe the basic settings that you configure for a connection. Additional settings vary by connection destination. For details, see Tanium Connect User Guide: Managing connections.

  1. From the Main menu, go to Modules > Connect.
  2. From the Connect Overview page, scroll to the Connections section and click Create Connection.
  3. In the General Information section, enter a Name and optional Description for the connection.
  4. In the Configuration section, select Tanium Reporting (Reports and Dashboards) for the Source.
  5. Select an Export Format, and then select Dashboard as the Type.
  6. Select the Dashboard to export, and then select the Computer Group for which to show data.
    If dashboards have duplicate names, you can distinguish them by the author and dashboard ID that are appended to the dashboard names. The ID for a dashboard appears in the browser URL field when you view the dashboard. For example, the Endpoint Management dashboard has id=default-endpoint-management appended to its URL. See View dashboards.
  7. Select the Destination where you want Connect to send the dashboard. Provide any additional configuration for the type of destination you select.
  8. (Optional) Configure a Schedule to send the dashboard.
  9. Click Save.

When the connection runs, the dashboard is sent to the destination according to the schedule that you set. To manually export the dashboard using the connection settings, select the connection on the Connect Overview page and click Run Now.

Import dashboards

You can import dashboard configurations that are stored in a JSON file.

Dashboard write permission is required to import dashboards. To import dashboards that are associated with reports (through chart panels), Report write permission is also required. The predefined roles that have these permissions include Reporting Operator and Reporting User.

  1. Copy the JSON file to a system that is accessible from the computer that you use to sign in to Tanium Console.

  2. From the Main menu, go to Data > Dashboards and click Import.
  3. Perform one of the following steps:
    • Drag and drop the JSON file to the Import a Dashboard.json File dialog.
    • Click Browse for File, select the JSON file, and click Open.
  4. Review the list of dashboards in the File Contents, optionally clear any dashboards that you do not want to import, and click Import.

    If the file has no issues to resolve, the import proceeds and you can skip the next step. If the file has any issues that block the import, perform the next step to resolve them.

  5. Resolve any issues in the file and click Import again:
    • Name conflicts: If the JSON file contains dashboards or reports with the same names and content set assignments as dashboards or reports that already exist on Tanium Cloudthe Tanium Server, select one of the following options:

      • Skip Import to omit the dashboard or report from the import process.
      • Overwrite Existing to replace the existing dashboard or report with the imported dashboard or report. This option is not available if:

        • The existing report or dashboard is Tanium managed.
        • The imported report uses sensors that are not present in the environment where you perform the import.
        • The imported report has a Group By Column selection and either of the following conditions apply:
          • The imported report does not include the data source that the associated dashboard panel uses for the Group By Column or Aggregate selections. See Panel settings: basic.

          • The imported report uses a different sensor for flattening data than the existing report. See Flattened data.

      • Import as New to import the dashboard or report and retain its current name, notwithstanding that an existing dashboard or report has the same name.
      • Rename the dashboard or report that you are importing. When you select this option, a text field appears where you specify the new name.
    • Invalid content set: If the dashboard or report is assigned to a content set that does not exist on Tanium Cloudthe Tanium Server, select one of the following options:
      • Skip Import to omit the dashboard or report from the import process.
      • Update Content Set to assign a valid content set. When you select this option, a dropdown appears for you to select a content set. The dropdown lists only the content sets for which you have role permissions.

    If a dashboard panel requires a sensor that does not exist on Tanium Cloudthe Tanium Server or that is not registered with Tanium Data Service, a message indicates the sensor is missing. You can proceed with the import but it omits that panel and associated report. To import missing sensors, see Tanium Console User Guide: Import sensors.

Manage dashboards on the Tanium Home page

The Tanium Home page includes a Dashboard section that shows a dashboard with full-size charts and a Dashboard List section that shows small (micro) charts for up to five dashboards. By default, these sections contain Tanium-managed dashboards. Each user can customize which dashboards appear on their Tanium Home page. Use the widgets in these sections to filter the dashboard data by computer group, favorites, or alerts. See Tanium Console User Guide: Work with Reporting dashboards.

By default, the Dashboard section is hidden. To show the section, click Customize Page and select the sections that you want to appear on the Tanium Home page. For more information on customizing the Home page, see Tanium Console User Guide: Tanium Home page.

The Dashboard and Dashboard List sections only appear if Reporting 1.8 or later and Interact 2.12 or later are installed in your environment.

Select a dashboard in the Dashboard section

  1. From the Main menu, click Home Home.
  2. Scroll to the Dashboard section and click Edit Edit.
  3. Select a dashboard from the dropdown. To quickly find a dashboard in a long list, enter its name in the Search field.

Select dashboards in the Dashboard List section

  1. From the Main menu, click Home.
  2. Scroll to the Dashboard List section and click Edit Edit.
  3. Select up to five dashboards from the dropdown. To quickly find a dashboard in a long list, enter the dashboard name in the Search field.

Manage historical data

Historical data collection

Reporting collects data every 24 hours for dashboard charts. You can filter the data by a specific date or date range when you configure the chart (see Date/Timeframe) or when you view the dashboard (see Filter by Timeframe).

For details about the specific date and date range options for dashboard charts, see Date options.

Historical and current data

When you select a timeframe that includes current data for a dashboard chart, the chart shows the latest results from Tanium Data Service for the current data (see Data sources). If you select a timeframe that includes data from a past date, the chart shows the results that Reporting collects at scheduled intervals for that historical data. For example, if you set the timeframe to Last 7 Days for a line chart, the chart shows the current data for today and historical data for the previous six days.

Chart data sources

A dashboard chart source is the combination of the report that provides the data and the following optional chart settings:

  • Group By Column: see Group By Column
  • Aggregate: see Aggregate

    If you do not specify the Aggregate setting, the chart automatically aggregates the results by Count.

  • Filter Group: see Filter Group
  • Source filter: see Source

If you change any of these settings or select a different report for an existing chart and then save the dashboard, Reporting starts a new collection because that new combination comprises a new source. If no other charts use the previous source, Reporting stops collecting data for the previous source after 10 days and removes the collected data.

Historical data collection does not include data from before you created the chart panel, unless another chart panel with the same source already exists in the environment. Multiple charts can use the same source.

Scheduled and manual data collection

Reporting does not collect chart data when you create the report that provides the data source. Instead, data collection begins when you add a chart to a dashboard, and then save the dashboard. The chart shows a Collecting initial data message until the data exists. Reporting collects chart data for each source once every 24 hours. For example, if you save a dashboard with a new chart at 12 PM today, the first collection starts at that moment for the chart source and the next collection starts at 12 PM tomorrow.

You can run the collection process manually at any time for one or more sources, with a minimum of one hour between collections. Manual collections do not change the scheduled collections that Reporting runs. For example, if the next scheduled collection is at 12 PM today and you run a manual collection at 10 AM today, the next scheduled collection remains at 12 PM today instead of resetting to 10 AM tomorrow. To perform a manual collection, see Run data collections.

Computer group registration

Reporting collects historical data from all computer groups that are registered for collection. If you register a new computer group, dashboard charts do not show historical data from that group until the next collections complete for the sources of those charts. For details, see Register computer groups for collection.

View historical data sources

Perform the following steps to view details (such as collection status) about the sources that provide data for dashboard charts.

You must be assigned a role with Reporting Historical Sources read permission to view historical data.
  1. From the Main menu, go to Data > Settings > Historical Data Sources.

    The grid lists sources with the following information:

    ColumnDescription
    Source

    Reporting names each source based on the name of the report that provides the data and on certain chart settings as described under Chart data sources.

    To see the error message associated with a failed collection run, expand Expand the source.

    Status

    The status of the last collection run for the source:

    Finished: The last collection run completed successfully.

    Pending: A collection run is in-progress.

    Failed: The last collection run did not complete successfully.

    Last RunThe date and time when the last collection run started.
    Next CollectionThe date and time of the next collection run.
    Total DataThe amount of data in the last collection run.

    You can sort Sort the grid by the Status or Last Run of a collection process.

  2. (Optional) Enter a text string in the Filter by source field to show only sources with names that match the string.
  3. Click the name of a source to view its details.

    The Source Details page contains the following information:

    Source Details section
    Field Description
    Status

    The status of the last collection run for the source:

    Finished: The last collection run completed successfully.

    Pending: A collection run is in-progress.

    A source might have multiple runs with the Pending state. Runs that time out or are overridden by another run might show the Pending state.

    Failed: The last collection run did not complete successfully.

    Report The name of the report that contains the data.
    Group By Columns The columns on which the data is grouped. If there are no columns listed, the data is grouped as a single aggregate. For details about the Group By Column or Aggregate settings, see Panel settings: basic.
    Filter Group The chart shows data only from the specified filter group. If the chart has no filter group selection, this field is blank. See Filter Group.
    Source Filter The chart shows only the data that matches the source condition that is specified for the chart. If no source condition is specified, this field is blank. See Source.
    Total Data The amount of data in the last collection run.


    Schedule Details section
    Field Description
    Collection Schedule

    How often collection runs are scheduled for the source.

    Last Run The date and time when the last run started.
    Last Updated The data and time when the data for the collection was most recently updated. On successful runs, this field is the same as the Last Run field.
    Next Collection The date and time of the next collection run.


    The Collection History section lists previous and current collection runs.

    You can sort Sort the grid by the Status or Last Run of a collection process.

    Collection History section
    Column Description
    Status

    The status of the collection run:

    Finished: The collection run completed successfully.

    Pending: A run is in progress.

    Failed: The last collection run did not complete successfully.

    To see the error message associated with a failed collection, expand Expand the run.

    Report Rows The total number of rows that the source collected.
    Grouped Rows The number of rows collected that match the Grouped By Columns value.
    Computer Groups The number of computer groups included in the collection.
    Duration The amount of time it took to collect the data.
    Last Run The date and time when the run started.
    Total Data The amount of data that the run collected.

Run data collections

You can run the collection process manually at any time for one or more sources, with a minimum of one hour between collections.

You must be assigned a role with Reporting Historical Sources write permission to run the collection process.
  1. From the Main menu, go to Data > Settings > Historical Data Sources.
  2. Select the check boxes of the desired sources and click Run Collection.

    The collection run has Pending status until all the data is collected, at which point the status changes to Finished.

Delete dashboards

When you delete a dashboard, any panels and sections in the dashboard are also deleted.

You cannot delete Tanium Managed dashboards.

  1. From the Main menu, go to Data > Dashboards.
  2. Perform one of the following steps:
    • Select the check box beside the dashboard and click Delete.
    • Click the dashboard to view the dashboard. In the upper-right corner, click Delete.