Dashboards

About Dashboards

Dashboards are stored in the Catalog, and they are displayed on the Dashboard page. The content of each dashboard is determined by queries that define what should be displayed on the dashboard. Throughout this documentation, we use the term dashboard to refer to the dashboard Catalog item and its underlying queries that are displayed on the Dashboard page.

Dashboard Catalog items store configurable widgets. The term widget is used in the Predix Essentials documentation to refer to dashboard widgets, their configuration options, and default layouts.

Predix Essentials includes a set of baseline dashboards that are specific to certain modules and work processes. If you do not specify a default dashboard in Predix Essentials, the APM Foundation dashboard will be set as your default dashboard.

Access and Modify the Dashboard Configuration

Procedure

  1. Open an existing dashboard.
  2. In the upper-right corner of the page, select Edit Mode.


    Depending on your security permissions, the following options appear:

    • Filter Query : Displays a window with prompts by which to filter query results.
    • Add New Widget : Displays buttons for each widget type.
    • Show Hidden Widgets : Displays a list of widgets that are hidden from the dashboard. This list is displayed to all users. You can redisplay a widget that appears in this list.
    Tip:  You can move widgets by selecting them and then dragging-and-dropping them in your desired location. You can also resize widgets by selecting the border of the widget and adjusting its dimensions.
  3. After making changes using the dashboard configuration options, select Edit Mode.

    The changes made to the dashboard are saved.

Create a New Dashboard

Procedure

  1. Access the Dashboards page.
  2. In the upper-right corner of the Dashboards page, select Create New.

    The Save As window appears.

  3. In the Catalog pane, navigate the hierarchy to determine the type of dashboard that you want to create.

    A grid appears in the workspace.

  4. Under the grid, complete the required fields.
    • In the Name box, enter a unique file name for the new dashboard.
    • In the Caption box, enter unique text to identify the new dashboard.
    • Optionally, in the Description box, you can enter an explanation of the new dashboard.
  5. Select Save.

    A blank dashboard appears on the Dashboard page, and the dashboard is saved to the Catalog.

Filter Dashboard Content

Procedure

  1. Access the dashboard configuration options.
  2. In the Filter Query section, select .

    The Select a query from the catalog window appears.

  3. In the hierarchy, navigate to the folder that contains the query by which you want to filter the dashboard.

    The queries by which you can filter the dashboard appear on the window.

  4. In the grid, select the query, and then select Open.
    The dashboard appears, displaying the selected query in the Filter Query section.

  5. In the upper-left corner of the page, select .
    If the does not appear on the upper-left corner of the page, then, in the upper-right corner of the page, select Edit Mode, and then select Edit Mode again. This will cause the button to appear.
    The Enter Parameter Values window appears.
  6. Using the options on the window, configure values by which to filter the query results, and then select Done.
    The dashboard content is filtered according to the selected parameters.

Set a Dashboard as the Home Dashboard

About This Task

The home dashboard is the first display that appears when Predix Essentials opens or when you select from the top navigation bar. You can set any existing dashboard as your home page.
Note: Selecting a dashboard as your main dashboard does not affect any other users.

Procedure

  1. Access a dashboard.
  2. Select , and then select Set as Home Page.
    The Set as Home Page window appears.

  3. Select Yes.
    The dashboard is set as your home dashboard.