Dashboard Widgets

About Widgets

Use widgets to access data for an asset context.

Widgets allow you to visualize data available in Predix Essentials.

Predix Essentials utilizes both configurable and non-configurable widgets, either of which can be added to a card. You can add multiple rows of tiles to a card, adding the widgets you want in a customizable layout.

Widgets are added in the widget library. Each added widget can be configured based on your needs.

Predix Essentials has instituted versioning for widgets. Older widget versions that are in use are supported; however, they are not available for inclusion in your cards. If you are using an older widget version, you should migrate to the newer version.

All widgets have a responsive aspect ratio.

Summary widgets used for the Dashboard Summary card will only appear as selections when they are added. They are not included in the main widget library.

Once a configurable widget is added to a card, you can modify or delete it. Non-configurable widgets can be added or deleted. Navigation is preset for non-configurable widgets, and can be set for many of the configurable widgets.

Predix Essentials includes the following widgets in its library:
Note: The Operations Performance Monitoring (OPM) widgets are also available in the GE Dashboard. For more information on the OPM widgets, refer to the https://www.ge.com/digital/documentation/opm/. The OPM services are available subject to subscription by tenant.
Table 1. Predix Essentials Core Widget Library
WidgetDescriptionConfigurations Options
Generic Graph Widget The Generic Graph widget is used to visualize time series data related to asset tags in the widget. This widget can be used in all the supported dashboards layouts. Title: Name of the widget as configured in the dashboard. The default name is Generic Graph Widget. This can be entered in any local language for internationalization and is not automatically translated. Limited to 50 characters.

Chart Type: This widget can be configured to plot the time series data either as a line chart or scatter chart.

Timespan: The default time duration for this widget can be configured to any of the following values:

  • 1 Hour
  • 1 Day
  • 1 Week
  • 1 Month
  • 3 Months
  • 6 Months
  • 1 Year

Refresh Rate: This option allows you to configure the widget to auto refresh at a specific rate. The options are:

  • Refresh Off (Default)
  • Every 1 minute
  • Every 5 minutes
  • Every 10 minutes

Data Operation: This option allows you to configure to view the data as interpolated or raw data.

Navigator: This option allows you to enable the chart navigator to display with the widget. This option is to be used only when the widget displays in the full-width layout.

Asset Name in Tooltip: This option enables you to view the name of the asset along with the tag name when you hover over the charts in the widget. This option is useful when you have tags from multiple assets configured in the widget. This shows which tag belongs to which asset when you view the values on the chart in the widget.

Threshold: This option allows you to configure a threshold line in the chart. The threshold value is a static value that is drawn on the chart in the widget.

Data: This option allows you to configure the tags associated with the chart in the widget. You can select up to 10 tags from one or more assets. This section allows you to add more assets in the context for the dashboard. This allows the dashboard to visualize data from multiple assets.

Navigation: This option allows you to set the application that you navigate to from the widget. You can add multiple navigation links from the widget. The options are:

  • Alerts
  • Analysis
  • Cases
  • Asset
  • Dashboard
  • Dashboard Internal

When you navigate from the widget to the other application, the context is passed to the other application and is set in the destination application.

  • If you select the dashboard as the destination of the navigation, you can select the context and dashboard that you navigate to when you select on the navigation link. If only the context is set for the dashboard navigation, the default dashboard for that context loads. Otherwise, the most recent dashboard loads. You can configure the dashboard to display line, bar, or scatter charts. It also provides navigation to a time series chart.
    Note: If you want to navigate from a widget to a dashboard that does not have any asset context, the name of the source dashboard and the context should be passed from the widget to navigate to the destination dashboard.
  • If you select Dashboard Internal as a destination to navigate from a widget, the dashboard that you select replaces the existing dashboard in the destination.
Interactive Generic Graph WidgetThe Interactive Generic Graph widget is used to visualize time series data related to asset tags in the widget. This widget can be used in all supported dashboard layouts.This widget supports all the configuration options available in the Generic Graph Widget. The additional options that are available are:

Sends Data: If this option is enabled, the widget sends time information to all the widgets in the card when a point in the chart is selected. If the other widgets are listening to that event, the point on the other chart that corresponds to the set time is highlighted.

Receives Data: If this option is enabled, the widget receives time information from other widgets and responds to that message by highlighting points on the chart that correspond to the time stamp in the message that was received.

Scatter ChartThe Scatter Chart widget is used to visualize the correlation between different tags on one or more assets based on the time series data of the tags.

The Scatter Chart widget selects tags from asset or chooses tags plus children tags from any asset in the hierarchy for the data.

The Scatter Chart widget uses interpolated data to show the correlation of two tags.

Title: Name of the widget as configured on the dashboard. The default name is Scatter Chart. This can be entered in any local language for internationalization and is not automatically translated. Limited to 50 characters.

Timespan: The default time duration for this widget can be configured to any of the following values:

  • 1 HR
  • 6 HRS
  • 12 HRS
  • 1 DAY
  • 3 MO
  • 6 MO
  • 9 MO
  • 1 YR

Refresh Rate: This option allows you to configure the widget to auto refresh at a specific rate. The options are:

  • Refresh Off (Default)
  • Every 1 minute
  • Every 5 minutes
  • Every 10 minutes

Data: This option allows you to configure the tags used on the x- and y-axis of the chart. You can select the tags on the x- and y-axis based on the base asset context, creation of the dashboard, or tags from any child assets. You can search by typing in the search field.

Navigation: This option allows you to set the application that you navigate to from the widget. You can add multiple navigation links from the widget to allow you to choose where to go from the widget. The options are:

  • Alerts
  • Analysis
  • Cases
  • Asset
  • Dashboard

Goes to: This option allows you to select the navigation path.

Sends Data: If this option is enabled, the widget sends time information to all the widgets in the card when a point in the chart is selected. If the other widgets are listening to that event, the point on the other chart that corresponds to the set time is highlighted.

Receives Data: If this option is enabled, the widget receives time information from other widgets and responds to that message by highlighting points on the chart that correspond to the time stamp in the message that was received.

Tag search box: Enter at least three characters into the Search field to find a data item.

Open CasesThe Open Cases Widget is used to view all the open cases that exist at the hierarchy level when the dashboard loads. No configuration options exist for this widget.
Ambient ConditionsThe Ambient Conditions widget is a limited utility widget that has been developed primarily for demonstrating the dashboarding capability. Use this widget only in 1/3 of the dashboard layout. Title: Name of the widget as configured on the dashboard. The default name is Ambient Conditions. This can be entered in any local language for internationalization and is not automatically translated. Limited to 50 characters.

Refresh Rate: This option allows you to configure the widget to auto refresh at a specific rate. The options are:

  • Refresh Off (Default)
  • Every 1 minute
  • Every 5 minutes
  • Every 10 minutes

Plotted Tags: This option allows you to select the two tags that can be associated with the widget.

The first tag associates with the Temperature that displays in the widget. The widget displays the most recent value of this tag in the widget.

The second tag associates with the Relative Humidity that displays in the widget. The widget displays the most recent value of this tag in the widget.
Unclaimed AlertsThe Unclaimed Alerts widget is used to view all the unclaimed alerts that exist at the hierarchy level on loaded dashboards. This widget is not configurable but displays the number of unclaimed alerts of Severity 1, Severity 2, and Severity 3 in the widget.
Monitoring & DiagnosticsThe Monitoring and Diagnostics Outcomes widget is used to view the outcomes of all the cases that have been closed for the assets at the hierarchy level on loaded dashboards. This widget is not configurable but displays the number of cases that are closed with different closure codes for all the cases that are closed for that assets.
Small ListThe Small List Widget is used to display the most recent alerts or cases for the asset that the dashboard is in the context of. You can use this in 1/3 of the dashboard layout.If you select an alert or a case on the widget, then they are automatically moved to the selected alert or case. Title: Name of the widget as configured on the dashboard. The default name is Small List. This can be entered in any local language for internationalization and is not automatically translated. Limited to 50 characters.

Timespan:

  • Most recent 4

Refresh Rate: This option allows you to configure the widget to auto refresh at a specific rate. The options are:

  • Refresh Off (Default)
  • Every 1 minute
  • Every 5 minutes
  • Every 10 minutes

Data : This option allows you to choose Alerts or Cases. It also allows you to select what displays in each column in the table.

Navigation: This option allows you to set the application that you navigated to from the widget. You can add multiple navigation links from the widget. The options are:

  • Alerts
  • Analysis
  • Cases
  • Asset
  • Dashboard
Spider Web ChartThe Spider Web Chart widget is used to configure a spider web chart in the widget using three or more asset tags from one or more assets. This provides information for the correlation between the tags over the time duration selected on the dashboard or on the widget. This widget also computes the average values for these tags over the time period. A visual indicator provides information on whether or not the actual tag values are exceeding the average values.

The Spider Web Chart widget plots the latest time series value of all tags based on the Predix Essentials time series query.

You can select tags from asset or choose tag plus child tags from any asset in the hierarchy for the data. And this widget displays the latest value for each tag. The default value is 15 days.

Title: Name of the widget as configured on the dashboard. The default name is Spider Web Chart. This can be entered in any local language for internationalization and is not automatically translated. Limited to 50 characters.

Layout: The Spider Web Chart is pre-selected and cannot be modified.

Show Average Values: This option allows you to choose if they want to see the average values plotted on the chart along with the actual values. The default setting for this option is off. Turning on this option makes the Timespan drop-down list box appear.

Timespan: The timespan for this widget can be configured to any of the following values:

  • 1 HR
  • 6 HRS
  • 12 HRS
  • 1 DAY
  • 3 MO
  • 6 MO
  • 9 MO
  • 1 YR

Refresh Rate: This option allows you to configure the widget to auto refresh at a specific rate. The options are:

  • Refresh Off (Default)
  • Every 1 minute
  • Every 5 minutes
  • Every 10 minutes

Tag search box: Enter at least three characters into the Search field to find a data item.

Data: This option allows you to configure the tags that are associated with the chart on the widget. You can select up to nine tags from one or more assets. This section allows you to add tags from either the base asset or any other child assets. A minimum number of three tags are needed for this widget.

Navigation: This option allows you to set the application that you navigate to from the widget. You can add multiple navigation links from the widget. The options are:

  • Alerts
  • Analysis
  • Cases
  • Asset
  • Dashboard
Vertical Grouped Bar ChartThe Vertical Grouped Chart is used to visualize the Alerts or Cases open for the asset in context. In addition, it is used to group them based on the various attributes of the alerts or cases. Title: Name of the widget as configured on the dashboard. The default name is Vertical Grouped Chart. This can be entered in any local language for internationalization and is not automatically translated. Limited to 50 characters.

Layout: This option allows you to select the layout of the grouped bar chart. The options are

  • Vertical Grouped Chart
  • Horizontal Grouped Chart
  • Vertical Stacked Chart
  • Horizontal Stacked Chart

Timespan: This allows you change the default time duration for this widget. The options are:

  • 1 hour
  • 6 hours
  • 12 hours
  • 1 day
  • 1 week
  • 1 month
  • 3 months
  • 6 months
  • 1 year

Refresh Rate: This option allows you to configure the widget to auto refresh at a specific rate. The options are:

  • Refresh Off (Default)
  • Every 1 minute
  • Every 5 minutes
  • Every 10 minutes

Data : This option allows you to select the data that is visualized in the widget. You can select Primary Data or Secondary Data.

Primary Data: This option allows you to make a few selections. First, select Alerts or Cases. If you choose Alerts, you can select the following additional display and grouping options:

  • Types
  • Claimed / Unclaimed
  • Source
  • Status
  • Severity
  • Context

Secondary Data: This option allows you to select the same set of options listed above but use them as grouping options for the Alerts or Cases Data.

Navigation: This option allows you to set the application that you would be navigating to from the widget. You can add multiple navigation links from the widget. The options are:
  • Alerts
  • Analysis
  • Cases
  • Asset
  • Dashboard

View by: This option displays a list with secondary filters that you can apply to widgets.

KPI WidgetThe KPI Widget is used to view a KPI and the trend of the KPI over a specified time interval. This widget is to be deployed in 1/3 of the dashboard layout. The KPI Widget displays the latest time series value, trend indicator, and raw data (line).

You can also select tags from asset or choose tag plus child tags from any asset in the hierarchy for the data at only instance level not context-level.

Title: Name of the widget as configured on the dashboard. The default name is "KPI Overview". This can be entered in any local language for internationalization and is not automatically translated. Limited to 50 characters.

Timespan: The default time duration for this widget can be configured to any of the following values:

  • 1 Hour
  • 1 Day
  • 1 Week
  • 1 Month
  • 3 Months
  • 6 Months
  • 1 Year

Refresh Rate: This option allows you to configure the widget to auto refresh at a specific rate. The options are:

  • Refresh Off (Default)
  • Every 1 minute
  • Every 5 minutes
  • Every 10 minutes

Data: This option allows you to configure the tag associated with the chart on the widget. You can only select one tag for this widget. Once selected, you can configure the optional indicators and KPIs that display.

Navigation: This option allows you to set the application that you would be navigating to from the widget. You can add multiple navigation links from the widget. The options are:

  • Alerts
  • Analysis
  • Cases
  • Asset
  • Dashboard

Trend Indicator: This option allows you to view how the KPI is trending.

Red dot: This dot indicates that the data point is not the latest.

Data Grid WidgetDoes not apply to Predix Essentials:The Data Grid Widget is used to visualize the output of a predefined query that has been stored in the system. Title: Name of the widget as configured on the dashboard. The default name is the name of the query that is configured in the widget. This can be entered in any local language for internationalization and is not automatically translated. Limited to 50 characters.

Path: This option allows you to choose the query to visualize on the widget.

Enhanced Graph WidgetDoes not apply to Predix Essentials:The Enhanced Graph Widget is used to visualize a predefined graph that has been stored in the system. This widget is configured to use an existing graph object that has already been created.

Title: Name of the widget as configured on the dashboard. The default name is the name of the graph that is configured in the widget. This can be entered in any local language for internationalization and is not automatically translated. Limited to 50 characters.

Path:This option allows you to choose the graph that you want to visualize on the widget.

Refresh Rate: This option allows you to configure the widget to auto refresh at a specific rate. The options are:

  • Refresh Off (Default)
  • Every 1 minute
  • Every 5 minutes
  • Every 10 minutes

Sends Data: This option allows you to initiate inter widget communication interactions from the widget.

Receives Data: This option allows you to participate in inter widget communication interactions from other widgets in the card on the dashboard.
Enhanced KPI WidgetDoes not apply to Predix Essentials:The Enhanced KPI Widget is used to visualize a preexisting KPI that has been stored in the system. Title: Name of the widget as configured on the dashboard. The default name is the name of the KPI that is configured in the widget. This can be entered in any local language for internationalization and is not automatically translated. Limited to 50 characters.

Select a KPI from the list of all the KPIs that exist in the system.

Hyperlink WidgetDoes not apply to Predix Essentials:The Hyperlink widget is used to embed one or more hyperlinks in either internal or external pages/sites. Title: Name of the widget as configured on the dashboard. The default name is "Hyperlink Widget". This can be entered in any local language for internationalization and is not automatically translated. Limited to 50 characters.

Add Hyperlink: This option allows you to add a new hyperlink to the widget. Each Hyperlink contains the name of the hyperlink and the URL for the hyperlink.

Image View WidgetDoes not apply to Predix Essentials:The Image View Widget is used to visualize an image from a publicly accessible site on the widget. Title: Name of the widget as configured on the dashboard. The default name is empty. This can be entered in any local language for internationalization and is not automatically translated. Limited to 50 characters.

URL: This option allows you to embed the URL of the image that you want to visualize on the widget. This has to be a publicly addressable URL that can be accessed from the cloud platform without any user credentials.

Table 2. Predix Essentials Dashboard Summary Library
WidgetDescriptionConfiguration Options
KPI SummaryThe KPI Summary widget is used to add in summary widgets to the dashboard. The KPI Summary widget displays the latest time series value, trend indicator, and raw data (line)

You can also select tags from asset or choose tag plus child tags from any asset in the hierarchy for the data at only instance level not context-level.

The Configure Dashboard Summary option, allows you to customize your dashboard.

Title: Name of the widget as configured on the dashboard. The default name is KPI Summary. This can be entered in any local language for internationalization and is not automatically translated. Limited to 50 characters.

Refresh Rate: This option allows you to configure the widget to auto refresh at a specific rate. The options are:

  • Refresh Off (Default)
  • Every 1 minute
  • Every 5 minutes
  • Every 10 minutes

Data: This option allows you to configure the tags used on the x- and y-axis of the chart. You can select the tags on the x- and y-axis based on the base asset context, creation of the dashboard, or tags from any child assets.

Trend Indicator: This option allows you to view how the KPI is trending.

Red dot: This dot indicates that the data point is not the latest.

Tag search box: Enter at least three characters into the Search field to find a data item.

Add and Delete Widgets on a Card

You can add configurable widgets in the widget library to the provided card layouts in the card library, or to your own custom card.

About This Task

Each widget in the widget library displays a thumbnail image and description allowing you to make informed choices.

You can add widgets in the following ways:
  • From the widget library during the creation of a new card.
  • From the widget library to an existing card.

Deleting all widgets in a row deletes the row in the card.

Procedure

  • To add a widget to a new card:
    1. After you have added a new card, select Add Widget to access an empty widget tile in the card layout.
    2. In the widget library, select Add for a widget.
      An empty widget for the type selected appears in the card layout. You are now ready to configure the widget.
  • To add a widget to an existing card:
    1. Access the Dashboard Browser.
    2. Use the Context Browser to select an asset context.
    3. Select the view containing the target card.
    4. Select Action, and then select Edit Card.
    5. Select Add Widget to access an empty widget tile in your card layout.
      If all the widget tiles on the card are occupied by a widget, you must remove a widget before you can add a new one. If the card is a custom card, you can add a widget tile by modifying the card.
    6. In the widget library, select Add for your preferred widget.
      An empty widget for the selected type appears in the card layout. You are now ready to configure the widget.
  • To delete a widget from a card, hover over the selected widget and select X.
    The widget is permanently removed In the card. A widget tile remains where you can add a new widget.

Add or Delete Widgets on a Dashboard Summary Card

Before You Begin

Make sure you have enabled a dashboard summary card.

About This Task

The Dashboard Summary card contains a minimum of three tiles by default. You can add or delete up to three more tiles for a total of six. You can add or delete widgets for the available tiles. When adding widgets, only the summary widgets are available.

Procedure

  • To add a tile to a dashboard summary card:
    1. Access the Dashboard Browser.
    2. Use the Context Browser to select a asset context.
    3. Select the view containing the dashboard summary card.
    4. Select Configure Dashboard Summary for a new dashboard summary card.
      Alternatively, you can select , and then select Configure Dashboard Summary.
    5. Select next to the tiles to add a new tile.
      A new tile appears to the right.
      Tip: The Dashboard Summary card can encompass up to six tiles, and must contain at least three tiles.
  • To delete a tile in a dashboard summary card:
    1. Access the Dashboard Browser.
    2. Use the Context Browser to select an asset context.
    3. Select the view containing the dashboard summary card.
    4. Select , and then select Configure Dashboard Summary.
    5. If there are more than three tiles available, you can delete any tile by hovering over the tile and selecting the X.
      The selected tile is deleted.
      Note: Deleting a tile deletes its widget. This action cannot be undone.
  • To add a widget to a dashboard summary card:
    1. Access the Dashboard Browser.
    2. Use the Context Browser to select an asset context.
    3. Select the view containing the dashboard summary card.
    4. Select , and then select Configure Dashboard Summary.
    5. Select Add Widget to access an empty widget tile in your card layout.
    6. In the widget library, select Add for your preferred widget.
    7. Select Save when you have finished adding all the widgets to save your changes.
  • To delete a widget in a dashboard summary card:
    1. Access the Dashboard Browser.
    2. Use the Context Browser to select an asset context.
    3. Select the view containing the dashboard summary card.
    4. Select , and then select Configure Dashboard Summary.
    5. Hover over the widget you want to delete, and then select the X for the widget.
      The widget is removed. You can add a new widget to replace the one deleted.
    6. Select Save when you have finished replacing widgets to save your changes.

Add, Edit, or Delete a Tag Expression from a Dashboard

About This Task

You can create a tag expression only when creating a new Dashboard or editing an existing Dashboard. The tag expression is then available to all tag expression enabled widgets on the Dashboard. You must configure the widget to use tag expressions

You can add, edit, or delete a tag expression from a widget using the Dashboard module.

Procedure

  • To create a new Tag Expression on a new Dashboard:
    1. Access the Dashboard Browser.
    2. Select Create New.
    3. Select the Expressions tab.
    4. Select Plus, and specify the following:
      FieldDescription
      Tag Expression NameEnter the name of the tag expression. This field is mandatory.
      DescriptionEnter a description of what the tag expression displays. This field is limited to 140 characters. This field is mandatory.
      Asset ScopeSelect Plus, and then select an asset.
      FormulaEnter the formula. This field is mandatory.
      Unit of MeasureEnter characters, and then select an option from the drop-down list box.
      Significant DigitsSelect the down arrow, and then select an option from the drop-down list box.
    5. Select Done.
  • To create a new Tag Expression on an existing Dashboard:
    1. Access the Dashboard Browser.
    2. Select a dashboard.
    3. Select , and then select Edit Dashboard.
    4. Select the Expressions tab.
    5. Select Plus, and specify the following:
      FieldDescription
      Tag Expression NameEnter the name of the tag expression. This field is mandatory.
      DescriptionEnter a description of what the tag expression displays. This field is limited to 140 characters. This field is mandatory.
      Asset ScopeSelect Plus sign, and then select an asset.
      FormulaEnter the formula. This field is mandatory.
      Unit of MeasureStart typing, and then select an option from the drop-down list.
      Significant DigitsSelect the down arrow, and then select an option from the drop-down list.
    6. Select Done.
  • To modify an existing Tag Expression in a Dashboard:
    1. Access the Dashboard Browser.
    2. Select a dashboard.
    3. Select , and then select Edit Dashboard.
    4. Select the Expressions tab.
    5. Hover over a Tag Expression, and then select Edit.
    6. Modify the settings as needed.
    7. Select Done.
  • To delete an existing Tag Expression in a Dashboard:
    1. Access the Dashboard Browser.
    2. Select a dashboard.
    3. Select , and then select Edit Dashboard.
    4. Select the Expressions tab.
    5. Hover over a Tag Expression, select Trash can, and then select Continue.
      Note: Deleting a tag expression removes it from the widgets that use the tag expression. This cannot be undone.
  • To add a Tag Expression to a Tag Expression enabled widget:
    1. Access the Dashboard Browser.
    2. From the Dashboard, perform one of the following:
      • Select a Dashboard with Tag Expressions already created.
      • Create a new Dashboard with new Tag Expressions.
    3. From the Card Edit mode, select Edit Widget for the Tag Expression enabled widget.
    4. From the Widget Settings menu, select Add Data for the Tag Browser to display.
    5. Add Tag Expressions to a widget, using one of the following ways based on what widget was implemented:
      • In the Ambient Conditions widget, search for the tag expression, and then select it.
      • In the Generic Graph widget, use the Tag Browser, and then plot a Tag Expression onto the graph.
  • To remove a Tag Expression from a Tag Expression enabled widget:
    1. Access the Dashboard Browser.
    2. From the Dashboard, perform one of the following:
      • Select a Dashboard with Tag Expressions already created.
      • Create a new Dashboard with new Tag Expressions.
    3. From the Card Edit mode, select Edit Widget for the Tag Expression enabled widget.
    4. From the Widget Settings menu, select Add Data for the Tag Browser to display.
    5. From Plotted Tags, under the Tag Browser section, hover over the Tag Expression, and then select X.

Configure Widgets

Widgets control the data displayed on cards.

The card library includes widgets in the Overview card, and a Custom card where you can add widgets to fit your needs.

You must configure the following widgets for your site:
  • Generic time series chart widget.
  • Interactive generic time series chart widget.
  • Scatter Chart widget.
  • Ambient Conditions widget.
  • Small List widget.
  • Spiderweb chart widget.
  • Vertical Grouped bar chart widget.
  • Goals KPI widget.
  • KPI widget.
  • Summary KPI widget.
  • Summary Count widget.
  • Does not apply to Predix Essentials: Calendar widget
The following widgets work with your selection in the Context Browser, and cannot be modified:
  • Unclaimed Alerts and Events: Unclaimed count for severity 1, 2, and 3 alerts.
  • Open Cases: Count of current open cases, displayed as a stacked chart and grouped by severity.
  • Monitoring & Diagnostics Outcomes: Historical outcomes for cases grouped by resolution code, displayed as a stacked chart.
  • Does not apply to Predix Essentials: Asset Criticality: Displays the criticality number assigned to an asset context.
  • Does not apply to Predix Essentials: Completed Work Orders: Displays the ten most recent completed work orders for an asset context.
  • Does not apply to Predix Essentials: Open Work Orders: Displays the 10 most recent open work orders for an asset context.
  • Does not apply to Predix Essentials: Recommendations: Displays all Recommendation records for an asset context.

Configuration for Generic Graph Widget

The Generic Graph widget allows you to create a line chart using time series data from the assets that exist in Predix Essentials. The widgets allow you to configure. This configuration adds navigation and an auto-refresh interval to the widget.

  1. Modify the Title to Heat Rate Performance.
  2. Select Line Chart in the Chart selections.
  3. Select Every 3 minutes in the Refresh box.
  4. Select a tag to display the time series output.
  5. Select On in the Navigation box.
  6. Select Done to exit modify mode.
  7. Select Save to save the widget changes.

Configuration for Ambient Conditions Widget

Ambient Conditions - Site relative humidity, displayed as a percentage, and site temperature, displayed in degrees Celsius.

  1. Modify the Title to Ambient Conditions.
  2. Select the first tag, which displays the temperature.
  3. Enter Temperature in the Name box.
  4. Select the second tag, which displays the relative humidity.
  5. Enter Humidity in the Name box.
  6. Select Done to exit modify mode.
  7. Select Save to save the widget changes.

Configuration for Interactive Generic Graph Widget

The Interactive Generic Graph widget allows you to create a line chart using time series data from the assets that exists in Predix Essentials. The additional functionality allows the widget to communicate with the other interactive graph widgets in the card to synchronize the time context between the widgets. This configuration adds navigation and an auto-refresh interval to the widget along with whether this widget can receive messages from other widgets, or if it can send messages to other widgets. It can also be configured to do both.

  1. In the Widget Communication, toggle Send and Receive to On.
  2. Select a tag to display the time series output.
  3. Select Done to exit modify mode.
  4. Repeat for each additional widget.
    Tip: Change the Title for each widget to match the tags for temperature and pressure.
  5. Select for one of the widgets.
    Note: All widgets must be on the same card.
  6. Select Save to save the widget changes.

Configure Time Series Interactive Chart Widgets

Use the time series interactive chart widget to track possible issues at a glance.

About This Task

You can configure this widget to easily navigate to an Analysis chart or another dashboard, control refresh rates, and synchronize communication between widgets on the same card. If you set your preferred time zone in the user management, the widget displays data for your preferred time zone.
Tip: This widget is not suitable for a class-level configuration if Dashboard is selected.

You can access cross-tenant asset resources that have been assigned to you. When selecting a destination for your widget, these resources are available for selection. If the resource you need is unavailable, contact your administrator.

Procedure

  1. Access the Dashboard Browser.
  2. Use the Context Browser to select an asset context.
  3. Select a view.
  4. In an existing card, select Action, and then select Edit Card.
  5. Hover over a time series interactive chart widget, and then select .
  6. Each interactive time series widget can be uniquely configured. Use the following options to configure the widget:
    For this optionDo this
    Title fieldEnter a name for the widget
    Chart iconsSelect a chart type icon.
    Timespan boxSelect a time span option in the list.
    Refresh boxSelect a refresh option.
    Threshold fieldEnter a static value.
    Sends Data toggleSelect on or off.
    Receives Data toggleSelect on or off.
    Navigation Add iconSelect to begin destination selections.
    Select Destination boxIn Select Destination list, select a module or Dashboard.
    Set Context linkWhen Dashboards is selected, use the Context Browser to select an asset, then use the View box to select a view.
    Enable toggleSelect on or off.
    You can select multiple destinations for the widget. Use to enable or disable destination targets for the widget.
  7. To plot tags or tag expressions in the Tag Browser or Plotted Tags list to an existing chart, complete one of the following actions:
    • Select a tag in the Tag Browser or Plotted Tags list, drag it over a chart, and then drop it on the chart.
    • Select multiple tags in the Tag Browser list using CTRL+Tap or SHIFT+Tap, drag them over a chart, and then drop them on the chart.
      Note: Multiple tags can only be selected from one parent node at a time. For example, you can select multiple tags from a single asset, but you cannot simultaneously select any from a second asset or in the Plotted Tags list. The selected chart is framed as you drop the tags. If a tag is already plotted on the selected chart, an error message appears.
  8. To plot tags or tag expressions in the Search list in the Tag Tree Browser to an existing chart, complete one of the following actions:
    • Select a tag in the All Tags list, drag it over a chart, and then drop it on the chart.
    • Select multiple tags in the All Tags list using CTRL+Tap or SHIFT+Tap, drag them over a chart, and then drop them on the chart. The selected chart is framed as you drop the tags. If a tag is already plotted on the selected chart, an error message appears.
  9. Select Done, and then select Save to save your configuration changes and exit modify mode.

Configure Time Series Generic Chart Widgets

Use the time series generic chart widget to monitor an asset or issue.

About This Task

You can configure this widget to navigate to the Analysis chart, select raw or interpolated data for display, and control refresh rates. Selecting the Navigator option allows you to manipulate the amount of data available in the widget using the Timeline Slider. If you set your preferred time zone in the user management, the widget displays data for your preferred time zone.

You can access cross-tenant asset resources that have been assigned to you. When selecting a destination for your widget, these resources are available for selection. If the resource you need is unavailable, contact your administrator.

Procedure

  1. Access the Dashboard Browser.
  2. Use the Context Browser to select an asset context.
  3. Select a view.
  4. In an existing card, select Action, and then select Edit Card.
  5. Hover over a time series generic chart widget, and then select .
  6. Each generic time series widget can be uniquely configured. Use the following options to configure the widget:
    For this optionDo this
    Title fieldEnter a name for the widget.
    Chart iconsSelect a chart type icon.
    Timespan drop-down list boxSelect a time span option in the drop-down list box.
    Refresh drop-down list boxSelect a refresh option.
    Data Operation drop-down list boxSelect between Interpolation and Raw to select the type of data displayed.
    Navigator toggleSelect on or off to add a time line slider below the chart.
    Threshold fieldEnter a static value.
    Navigation Add iconSelect to begin destination selections.
    Select Destination drop-downIn the Select Destination drop-down list box, select a module or Dashboard.
  7. To plot tags or tag expressions in the Tag Browser or Plotted Tags list to an existing chart, complete one of the following actions:
    • Select a tag in the Tag Browser or Plotted Tags list, drag it over a chart, and then drop it on the chart.
    • Select multiple tags in the Tag Browser list using CTRL+Tap or SHIFT+Tap, drag them over a chart, and then drop them on the chart.
      Note: Multiple tags can only be selected from one parent node at a time. For example, you can select multiple tags from a single asset, but you cannot simultaneously select any from a second asset or in the Plotted Tags list. The selected chart is framed as you drop the tags. If a tag is already plotted on the selected chart, an error message appears.
  8. To plot tags or tag expressions in the Search list in the Tag Tree Browser to an existing chart, complete one of the following actions:
    • Select a tag in the All Tags list, drag it over a chart, and then drop it on the chart.
    • Select multiple tags in the All Tags list using CTRL+Tap or SHIFT+Tap, drag them over a chart, and then drop them on the chart. The selected chart is framed as you drop the tags. If a tag is already plotted on the selected chart, an error message appears.
  9. Select Done, and then select Save to save your configuration changes and exit modify mode.

Configure Ambient Conditions

Use the ambient conditions widget to display data for two tags.

About This Task

You can configure the ambient conditions widget to track two tags in their unit of measure for an asset context. For example, you can track weather information for the asset context.

You can access cross-tenant asset resources that have been assigned to you. When selecting a destination for your widget, these resources are available for selection. If the resource you need is unavailable, contact your administrator.

Procedure

  1. Access the Dashboard Browser.
  2. Use the Context Browser to select an asset context.
  3. Select a view.
  4. In an existing card, select Action, and then select Edit Card.
  5. Hover over an ambient conditions widget, and then select .
  6. Each ambient conditions widget can be uniquely configured. Use the following options to configure the widget:
    For this optionDo this
    Title fieldEnter a name for the widget.
    Refresh drop-down list boxSelect a refresh option.
    Name fieldEnter a name for the tag you are plotting.
    Note: The ambient conditions widget can plot two tags. Enter a second name for the tag you are plotting.
  7. To plot tags or tag expressions in the Tag Browser or Plotted Tags list to an existing chart, complete one of the following actions:
    • Select a tag in the Tag Browser or Plotted Tags list, drag it over a chart, and then drop it on the chart.
    • Select multiple tags in the Tag Browser list using CTRL+Tap or SHIFT+Tap, drag them over a chart, and then drop them on the chart.
      Note: Multiple tags can only be selected from one parent node at a time. For example, you can select multiple tags from a single asset, but you cannot simultaneously select any from a second asset or in the Plotted Tags list. The selected chart is framed as you drop the tags. If a tag is already plotted on the selected chart, an error message appears.
  8. Select Done, then select Save to save your configuration changes and exit.

Configure Vertical Grouped Bar Chart Widgets

Use grouped bar charts to compare data for analysis, alerts, cases, or dashboards.

About This Task

You can configure this widget to navigate to the analysis, alerts or cases module, or a dashboard for a selected asset context, then select a time span to monitor.

Configuration for the Grouped Chart can differ from older versions. If you are using the Grouped Chart widget, you should migrate to the current version.

You can access cross-tenant asset resources that have been assigned to you. When selecting a destination for your widget, these resources are available for selection. If the resource you need is unavailable, contact your administrator.

Tip: This widget is not suitable for a class-level configuration if Dashboard is selected.

Procedure

  1. Access the Dashboard Browser.
  2. Use the Context Browser to select an asset context.
  3. Select a view.
  4. In an existing card, select Action, and then select Edit Card.
  5. Hover over a grouped bar chart widget, and then select .
  6. Each grouped bar chart widget can be uniquely configured. Use the following options to configure the widget:
    For this optionDo this
    Title fieldEnter a name for the widget.
    Layout drop-down list boxSelect a layout option.
    Timespan drop-down list boxSelect a timespan option for the data applied to the widget.
    Refresh Rate drop-down list boxSelect a refresh option.
    Navigation toggleSelect on or off.
    Goes To drop-down list boxSelect Dashboards for the navigation destination.
    For When Dashboards is selected, select Set Context and use the Context Browser to select an asset, then use the View drop-down list box to select a view.

    You can select multiple destinations for the widget. Use to enable or disable destination targets for the widget.

  7. Select for the Primary Data Item in the Data section.
  8. Select Alerts or Cases.
  9. On the data type list, select an option.
    Options for data type differ between alert and case selections.
  10. In Attributes, use the Search field to find specific attributes.
  11. Check at least one attribute, and then select Add.
    The primary data is enabled.
  12. In Grouped By, select for the Secondary Data Item.
  13. On the data type list, select an option.
  14. In the Navigation, select , and then select the destination in the box.
  15. In Attributes, use the Search field to find specific attributes.
  16. Check at least one attribute, then select Add.
    As each data type is added for the secondary data item just added, a new secondary data item appears until all data type options have been selected. Adding new secondary data items is optional.
    The secondary data is enabled, a title field appears for the secondary data item just added, and new secondary data item appears for configuration.
  17. Enter the a name for the View in the Title field for the secondary data item you just added.
  18. Add additional secondary data items as needed.
  19. Select Done, and then select Save.

Configure Spider Web Chart Widgets

Use a Spider Web Chart widget to compare values across three to nine plotted tags.

About This Task

This chart can display the average values for the tags based on the selected timespan. You can configure this widget to navigate to an Analysis chart, Alerts, Cases, or Dashboard for a selected asset context, and control refresh rates.

Configuration for the Spider Web Chart can differ from older versions. If you are using the Spider Web Chart widget, you should migrate to the current version.

You can access cross-tenant asset resources that have been assigned to you. When selecting a destination for your widget, these resources are available for selection. If the resource you need is unavailable, contact your administrator.

Tip: This widget is not suitable for a class-level configuration if Dashboard is selected.

Procedure

  1. Access the Dashboard Browser.
  2. Use the Context Browser to select an asset context.
  3. Select a view.
  4. In an existing card, select Action, and then select Edit Card.
  5. Hover over a Spider Web Chart widget, and then select .
  6. Each Spider Web Chart widget can be uniquely configured. Use the following options to configure the widget:
    For this optionDo this
    Title fieldEnter a name for the widget.
    Layout fieldThe Spider Web Chart is pre-selected and cannot be modified.
    Show Average Values toggleSelect on or off. Selecting Show Average Values enables the Timespan box. This field displays the average of all the values across the selected time span.
    Refresh Rate drop-down list boxSelect on or off.
    Timespan drop-down list boxSelect an option.
    Navigation toggleSelect on or off.
    Goes To drop-down list boxSelect a module, or Dashboards for navigation destination.
    Navigation contextWhen Dashboards is selected, use the Context Browser to select an asset, then use the View drop-down list box to select a view.
  7. To plot tags or tag expressions in the Tag Browser or Plotted Tags list to an existing chart, complete one of the following actions:
    This option is plotting the latest time series value of all the tags. You can use the search box to find a tag. The first three characters display the search results. In addition, the widget displays value from last 15 days.
    • Select a tag in the Tag Browser or Plotted Tags list, drag it over a chart, and then drop it on the chart.
    • Select multiple tags in the Tag Browser list using CTRL+Tap or SHIFT+Tap, drag them over a chart, and then drop them on the chart.
      Note: Multiple tags can only be selected from one parent node at a time. For example, you can select multiple tags from a single asset, but you cannot simultaneously select any from a second asset or in the Plotted Tags list. The selected chart is framed as you drop the tags. If a tag is already plotted on the selected chart, an error message appears.
  8. Select Done, then select Save to save your configuration changes and exit modify mode.

Configure Goals KPI Widgets

Use the Goals KPI widget to compare actual computed values with set goal values for an asset context.

About This Task

To compare KPI values for an asset context, you can display up to nine Actual tags and nine set Goal tags for a total of eighteen tags. You must plot at least three tags in each category for the chart. If you remove a tag from one of the categories, you must remove the corresponding tag in the other category to keep the tag pairs together.
Tip: Plot an Actual tag, and then a Goals tag so they are displayed in pairs for easy comparison.

You can display a fill pattern for the Goal KPIs to visualize if the actual asset performance is within the set parameters. You can change tag names, and set a filter for each plotted tag. Tags are displayed in the order they are selected for the chart.

You can access cross-tenant asset resources that have been assigned to you. When selecting a destination for your widget, these resources are available for selection. If the resource you need is unavailable, contact your administrator.

Procedure

  1. Access the Dashboard Browser.
  2. Use the Context Browser to select an asset context.
  3. Select a view.
  4. In an existing card, select Action, and then select Edit Card.
  5. Hover over a goals KPI widget, and then select .
  6. Each goals KPI widget can be uniquely configured. Use the following options to configure the widget:
    For this optionDo this
    Title fieldEnter a name for the widget.
    Layout fieldThe Goals KPI widget is pre-selected and cannot be modified.
    Refresh Rate drop-down list boxSelect an option.
    Fill Goal Area toggleSelect on or off to add a fill for the set goals KPIs in the spiderweb chart.
    Add Navigation iconSelect to add navigation for the widget.
    Navigation destinationOn Goes To, select Analysis View, Asset, or Dashboards.
    Navigation contextWhen Dashboards is selected, use the Context Browser to select an asset, and then use the View drop-down list box to select a view.
    Enable iconSelect on or off to enable or disable navigation for a specific destination.
  7. Select next to an Actual tag or Goal tag place holder.
  8. Select , and then enter at least three characters that match a tag or child tag name into the Search field to find suitable tags for plotting.
    Important: When you add an Actual tag, you must add a Goal tag so they can display in pairs.
  9. In the Search Results, select next to a tag selection, and then select Add.
    The tag selection is added to the Plotted Tags list at the bottom of the list for that category.
    Note: Add at least three and up to nine tags for Actual and Goal Tags categories, for a total of eighteen tags.
  10. Select a plotted Actual tag to rename the tag and enter filter criteria.
    • Enter a new name for the tag in the Tag Name field.
    • Enter a value in the Min and Max fields to add a filter to the tag.
      Note: You must enter a filter value for each tag in the Actual category. If you miss any, you will receive an error message and the tag will not plot.
    • Select the Reverse Range toggle to On to invert the filter, or Off to revert the filter to normal.
  11. Select Done, then select Save to save your configuration changes and exit modify mode.

Configure KPI Widgets

Use the KPI widget to monitor one or more KPIs.

About This Task

The KPI widget can be configured to display selected KPIs for the selected asset. Once a data item has been selected, the unit of measure appears automatically.

You can access cross-tenant asset resources that have been assigned to you. When selecting a destination for your widget, these resources are available for selection. If the resource you need is unavailable, contact your administrator.

The KPI widget can be configured to display a trend indicator for the selected tag. You can select:
Table 3. Tend Indicator Selections
Selecting thisMeans this
A green up-arrow signifies that the value for the KPI is greater than that recorded in the previous data retrieval. A red down-arrow signifies that the value for the KPI is lower than that recorded in the previous data retrieval. In this case, the up-arrow is the desired trend.
A red up-arrow signifies that the value for the KPI is greater than that recorded in the previous data retrieval. A green down-arrow signifies that the value for the KPI is lower than that recorded in the previous data retrieval. In this case, the down-arrow is the desired trend.
A grey up-arrow signifies that the value for the KPI is greater than that recorded in the previous data retrieval. A grey down-arrow signifies that the value for the KPI is lower than that recorded in the previous data retrieval. In this case, the direction of the arrow is informational.
Tip: This widget is not suitable for a class-level configuration if Dashboard is selected for navigation.

Procedure

  1. Access the Dashboard Browser.
  2. Use the Context Browser to select an asset context.
  3. Select a view.
  4. In an existing card, select Action, and then select Edit Card.
  5. Hover over a KPI widget, and then select .
  6. Each KPI widget can be uniquely configured. Use the following options to configure the widget:
    For this optionDo this
    Title fieldEnter a name for the widget.
    Layout fieldThe KPI grid is pre-selected and cannot be modified.
    Timespan drop-down list boxSelect a timespan option for the data applied to the widget.
    Refresh Rate drop-down list boxSelect a refresh option.
    Navigation toggleSelect on or off.
    Goes To drop-down list boxSelect Analysis View or Dashboards.
    ForWhen Dashboards is selected, select Set Context and use the Context Browser to select an asset, and then use the View drop-down list box to select a view.
    Trend toggleSelect the data item, then select on or off for the trend indicator you want to use.
    Note: You can select only one indicator.

    You can select multiple destinations for the widget. Use to enable or disable destination targets for the widget.

  7. In Data, use to find at least one KPI tag to plot, and then select next to your selection.
    Selecting a data item a second time allows you to select and enable a Trend Indicator.
  8. Select Done, and then select Save.

Configure Small List Widgets

Use the Small List widget to monitor four of the most recent alerts or cases.

About This Task

You can access cross-tenant asset resources that have been assigned to you. When selecting a destination for your widget, these resources are available for selection. If the resource you need is unavailable, contact your administrator.

About This Task

The different severity levels are helpful in defining the problem. These icons are for Alerts only.
Severity LevelDefinition
1 Is a red box with the number one in it.
2 Is a red box with the number two in it.
3Is a red box with the number three in it.
4Is an orange box with the number four in it.
5 Is an orange box with the number five in it.
Tip: This widget is not suitable for a class-level configuration if Dashboard is selected.

Procedure

  1. Access the Dashboard Browser.
  2. Use the Context Browser to select an asset context.
  3. Select a view.
  4. In an existing card, select Action, and then select Edit Card.
  5. Hover of a Small List widget, and then select .
  6. Each Small List widget can be uniquely configured. Use the following options to configure the widget:
    For this optionDo this
    Title fieldEnter a name for the widget.
    Timespan fieldThe most recent four entries is default.
    Refresh Rate drop-down list boxSelect a refresh option.
    Navigation toggleSelect on or off.
    Goes To drop-down list boxSelect a module or Dashboard in the list.
    ForWhen Dashboards is selected, use the Context Browser to select an asset, and then use the View drop-down list box to select a view.

    You can select multiple destinations for the widget. Use to enable or disable destination targets for the widget.

  7. Select for the Primary Data Item in the Data section.
  8. Select Alerts or Cases. If there is no data for Alerts or Cases, then only the widget title displays.
  9. On Attributes, select an option from each Attribute Placement, and then select Next.
    Note: You must select an option for all attribute placement drop-down list box before Next is enabled.
    If you selected Alerts attributes, you can optionally select the Show Severity toggle to include severity for each item in the list.
    The selected data is enabled.
  10. Select Done, and then select Save.

Configure Scatter Chart Widgets

Use the Scatter Chart widget to display correlations between two parameters or tags.

About This Task

Use the Scatter Chart widget for the extent of correlation to appear, if any, between the values for two parameters or tags. This widget uses interpolated data to display the correlation of the two tags.

You can access cross-tenant asset resources that have been assigned to you. When selecting a destination for your widget, these resources are available for selection. If the resource you need is unavailable, contact your administrator.

Procedure

  1. Access the Dashboard Browser.
  2. Use the Context Browser to select an asset context.
  3. Select a view.
  4. In an existing card, select Action, and then select Edit Card.
  5. Hover over a Scatter Chart widget, then select .
  6. Each Scatter Chart widget can be uniquely configured. Use the following options to configure the widget:
    For this optionDo this
    Title fieldEnter a name for the widget.
    Layout text fieldView the layout.
    Timespan drop-down list boxSelect a timespan option.
    Refresh drop-down list boxSelect a refresh option.
    Navigation toggleSelect on or off.
    Goes To drop-down list boxSelect a module or Dashboard.
    ForWhen Dashboards is selected, use the Context Browser to select an asset, and then use the View drop-down list box to select a view.
    Sends Data toggleSelect on or off.
    Receives Data toggleSelect on or off.
    Zoom Drag your cursor over the area to zoom. You can perform multiple zoom actions. The zoom selection includes any stacked charts.
    Tooltip Hover over a chart data point to view data in a tooltip.
    PanSelect to pan in or out of the chart.
    You can select multiple destinations for the widget. Use to enable or disable destination targets for the widget.
  7. To plot tags or tag expressions in the Tag Browser or Plotted Tags list to an existing chart, complete one of the following actions:
    This option is plotting the latest time series value of all the tags. You can use the search box to find a tag. The first three characters display the search results. In addition, the widget displays value from last 15 days.
    • Select a tag in the Tag Browser or Plotted Tags list, drag it over a chart, and then drop it on the chart.
    • Select multiple tags in the Tag Browser list using CTRL+Tap or SHIFT+Tap, drag them over a chart, and then drop them on the chart.
      Note: Multiple tags can only be selected from one parent node at a time. For example, you can select multiple tags from a single asset, but you cannot simultaneously select any from a second asset or in the Plotted Tags list. The selected chart is framed as you drop the tags. If a tag is already plotted on the selected chart, an error message appears.
  8. Select next to the X-Axis option in the Data section to select a tag for plotting.
  9. Enter at least three characters that match a tag name into the Search field to find suitable tags for plotting.
  10. Select next to a tag to plot it to the chart, and then select Add.
  11. Optional: To change the tag name, select the tag name and enter a new name in the X-Axis Name field.
  12. Select next to the Y-Axis option in the Data section, then search for and add a tag.
  13. Optional: To change the tag name, select the tag name and enter a new name in the Y-Axis Name field.
  14. Select Done, and then select Save.

Configure Summary KPI Widget

Use the Summary KPI widget to display overall key performance indicators for the selected asset.

About This Task

The Summary KPI widget can be configured to display selected KPIs for the selected asset. Once a data item has been selected, the unit of measure appears automatically. The KPI displays the latest value for a 30-day time span.

You can access cross-tenant asset resources that have been assigned to you. When selecting a destination for your widget, these resources are available for selection. If the resource you need is unavailable, contact your administrator.

The KPI widget can be configured to display a trend indicator for the selected tag. You can select:
Table 4. Tend Indicator Selections
Selecting thisMeans this
A green up-arrow signifies that the value for the KPI is greater than that recorded in the previous data retrieval. A red down-arrow signifies that the value for the KPI is lower than that recorded in the previous data retrieval. In this case, the up-arrow is the desired trend.
A red up-arrow signifies that the value for the KPI is greater than that recorded in the previous data retrieval. A green down-arrow signifies that the value for the KPI is lower than that recorded in the previous data retrieval. In this case, the down-arrow is the desired trend.
A grey up-arrow signifies that the value for the KPI is greater than that recorded in the previous data retrieval. A grey down-arrow signifies that the value for the KPI is lower than that recorded in the previous data retrieval. In this case the direction of the arrow is informational.
A red dot signifies that the data point is not the latest version.

Procedure

  1. Access the Dashboard Browser.
  2. Use the Context Browser to select an asset context.
  3. Select a view.
  4. In , select Edit Dashboard, select the Dashboard Summary toggle to On, and then select Save and Done.
  5. In , select Configure Dashboard Summary.
  6. On a widget tile, select Add Widget.
  7. On the Widget Library, select Add next to the Summary KPI Widget.
  8. Hover over the Summary KPI widget, and then select .
  9. Each Summary KPI widget can be uniquely configured. Use the following options to configure the widget:
    For this optionDo this
    Title fieldEnter a name for the widget.
    LayoutDisplays the name.
    Refresh Rate drop-down list boxSelect a refresh option.
    Trend toggleSelect the data item, and then select on or off for the trend indicator you want to use.
    Note: You can select only one indicator.
  10. Select next to the Data Item.
  11. To plot tags or tag expressions in the Tag Browser or Plotted Tags list to an existing chart, complete one of the following actions:
    This option is plotting the latest time series value of all the tags. You can use the search box to find a tag. The first three characters display the search results. In addition, the widget displays value from last 15 days.
    • Select a tag in the Tag Browser or Plotted Tags list, drag it over a chart, and then drop it on the chart.
    • Select multiple tags in the Tag Browser list using CTRL+Tap or SHIFT+Tap, drag them over a chart, and then drop them on the chart.
      Note: Multiple tags can only be selected from one parent node at a time. For example, you can select multiple tags from a single asset, but you cannot simultaneously select any from a second asset or in the Plotted Tags list. The selected chart is framed as you drop the tags. If a tag is already plotted on the selected chart, an error message appears.
  12. Enter at least three characters into the Search field to find a data item.
  13. Select a data item in the list, and then select Done.
    Selecting a data item a second time allows you to select and enable a Trend Indicator.
    The data and unit of measure appear in the Summary KPI widget.
  14. Select Done.
    The widget appears in the Dashboard Summary tile.
  15. Select Save.
    The Dashboard Summary Card displays the widget on the selected view.

What To Do Next

Add and configure up to six widgets for the Dashboard Summary Card.

Configure Summary Count Widget

Use the Summary Count widget to display a data item count value and total for the selected asset context.

About This Task

The Summary Count widget can be configured to display the count value and total of a selected module's data item for a selected asset context. These values are not stored as tags. Once a data item has been selected, the unit of measure displays automatically. The KPI displays the latest value for a six-month time span.

You can access cross-tenant asset resources that have been assigned to you. When selecting a destination for your widget, these resources are available for selection. If the resource you need is unavailable, contact your administrator.

Procedure

  1. Access the Dashboard Browser.
  2. Use the Context Browser to select an asset context.
  3. Select a view.
  4. In , select Edit Dashboard, and then select Dashboard Summary toggle to On, then select Save.
  5. In , select Configure Dashboard Summary.
  6. On a widget tile, select Add Widget.
  7. In the Widget Library, select Add next to the Summary Single Sum Widget.
  8. Hover over the summary single sum widget, and then select .
  9. Each summary single sum widget can be uniquely configured. Use the following options to configure the widget:
    For this optionDo this
    Title fieldEnter a name for the widget.
    Refresh Rate drop-down list boxSelect a refresh option.
    Display Total toggleSelect on or off.
  10. Select next to the Data Item to select a parent asset context.
  11. Select an asset context, and then select Done.
  12. Select next to Grouped By to select a data item.
    You can select a data item in the Asset Attributes, Alerts, or Cases categories.
  13. Select a data item, and then select Done.
    The widget appears in the Dashboard Summary tile.
  14. Select Save to save the widget to the dashboard summary card.
    The Dashboard Summary Card displays the widget on the selected view.

What To Do Next

Add and configure up to six widgets for the Dashboard Summary Card.

Configure Calendar Widget

About This Task

This features does not apply to Predix Essentials. You can customize the widget by configuring its options.

You can access cross-tenant asset resources that have been assigned to you. When selecting a destination for your widget, these resources are available for selection. If the resource you need is unavailable, contact your administrator.

Procedure

  1. Access the Dashboard Browser.
  2. Use the Context Browser to select an asset context.
  3. Select a view.
  4. On an existing card, select Action, and then select Edit Card.
  5. To add a widget, select Calendar Widget, and then select .
  6. Each interactive calendar widget can be configured. Use the following options to configure the widget:
    OptionDescription
    TitleEnter a name for the widget. This field is required.
    PathSelect this option to select a query.
    Title ColumnSelect a title column.
    Start Date ColumnSelect a start date. This field is required.
    Category ColumnSelect a category.
    End Date ColumnSelect an end date.
    Category Color ColumnSelect a category color.
    RefreshSelect this option to refresh the calendar.
    TimespanSelect a timespan option.
  7. Select Save, and then select Done.

Modify Widgets

Each widget type contains its own configuration options.

Specific widgets have configuration options that are complex and need extra explanation to set up properly. Some options are configured differently depending on the widget selected and the purpose of the widget.

For instance, configuring navigation from a widget to an analysis chart is relatively simple to set up. Whereas configuring navigation to an alert or case Inbox may require data selection, and configuring navigation to a dashboard requires context and view selection.

Configuring communication for widgets may require you to select send only, receive only, or both, again depending upon the purpose of the widget.

Widget refresh is relatively simple to configure, however setting up widget refresh using time control requires more thought.

Configure Widgets for Asynchronous Queries

Widgets that display Time Series data use asynchronous queries to retrieve large amounts of information.

About This Task

Widgets that display Time Series data use dynamic queries to retrieve information. If the data is stored in Predix Time Series, the requests are synchronous queries, and the response contains the requested data. If the data is stored in long-term storage (other than Predix Time Series), the requests are converted to asynchronous queries.

Queries that retrieve Time Series data from long-term storage usually take a long time to return results. Asynchronous queries give you the option of canceling long-running queries or waiting for the data to load.

Asynchronous queries are relevant for customers who use a tiered storage mechanism for their Time Series data, where the most recent data is stored in high performance Predix Time Series, and longer-term data is stored in an external S3 data source.

The following widgets support asynchronous queries:
  • Generic Graph
  • Scatter Chart
  • Spider Web Chart
  • KPI Overview

Procedure

  1. Access the Dashboard Browser.
  2. Open a dashboard by selecting its name in the dashboard browser.
  3. In the card heading, select , and then select Edit Card.
  4. Hover your mouse pointer over a Generic Graph, Scatter Chart, Spider Web Chart, or KPI Overview widget and select .
  5. For Spider Web Chart, turn on the Show Average Values toggle.
    The Timespan configuration option appears.
  6. In the Timespan drop-down list box, select an option that specifies six months or more.
    An asynchronous query is immediately made on the data source connected to the widget. A message appears, giving you two options. Select from:
    • Quit, to cancel the query.
    • Wait, to allow the query to finish.
    Note: If you do not select an option, the query runs to completion (as if you had selected Wait).
    The widget displays the data returned by completed queries. Canceled queries leave the widget in an indeterminate state.
  7. Select Done to save the widget configuration changes.
  8. Select Save to update the card.

What To Do Next

Whenever a widget configured for asynchronous queries refreshes its data, the asynchronous query confirmation message appears. Respond as needed to the message to cancel or complete the query.

Configure Communications for Widgets

You can configure widgets on a card to send and receive data to each other.

About This Task

Widgets on a card can be configured to align information based on their timestamp. By configuring multiple widgets on a card to send and receive data, then synchronizing them to ensure the timestamp on each widget is the same, you can view data for any point in time recorded by the selected widgets.
Note: Only time series interactive widgets can be configured for communication.

For example, you can set up a widget displaying temperature over 30 days to send and receive data to a widget displaying pressure over 30 days, then synchronize the timestamp for the widgets. When you select a data point at 15 days on one of the widgets, the second widget displays a tooltip using data for the same timestamp. You can do this for multiple widgets on the same card.

When you configure one widget to send and a second widget to receive, the data communication is one way.

Procedure

  • To configure multiple widgets on a card to send and receive data (two-way):
    1. Access the Dashboard Browser.
    2. Use the Context Browser to select an asset context.
    3. In an existing card, select Action, and then select Edit Card.
    4. Hover over a widget, and then select .
    5. Select the Sends Data and Receives Data toggles for Widget Communication.
    6. Select Done to save your configuration changes.
    7. Repeat these steps for at least one additional widget.
    8. Select Save to exit.
  • To configure one-way data for multiple widgets on a card:
    1. Access the Dashboard Browser.
    2. Use the Context Browser to select an asset context.
    3. On an existing card, select Action, and then select Edit Card.
    4. Hover over the source widget for your data, and then select .
    5. Select the Sends Data toggle for Widget Communication.
    6. Select Done to save your configuration changes.
    7. Hover over the target widget, and then select .
    8. Select the Receives Data toggle for Widget Communication.
    9. Select Done to save your configuration, then select Save to exit.
  • To disable communications for a widget:
    1. Access the Dashboard Browser.
    2. Use the Context Browser to select an asset context.
    3. In an existing card, select Action, and then select Edit Card.
    4. Hover over the widget, and then select .
    5. Toggle the Sends Data and Receives Data toggles for Widget Communication to Off.
    6. Select Done to save your configuration changes, and then select Save.

What To Do Next

Synchronize the widget data on a card.

Configure Navigation for Widgets

Some widgets can be configured for navigation, allowing you to view detailed data residing in another dashboard view or a different module view.

About This Task

You can control widget navigation, the asset context, and multiple widget destinations. Destinations can be disabled or removed during configuration. Enabling and disabling destinations affects the targets available on the List icon for the widget.
Note: The widget cannot be saved until all selections for required fields marked by an asterisk are made.

Procedure

  1. Access the Dashboard Browser.
  2. Use the Context Browser to select an asset context.
  3. Select a dashboard.
  4. In an existing card, select Action, and then select Edit Card.
  5. Hover over the widget, and then select .
  6. Select next to Navigation.
  7. Make a selection in the Select list box.
    This is a required field. Each widget contains unique configuration options. Select the option that applies:
    OptionDescription
    AlertsWhen you select Alerts as a destination for widget navigation, the alerts page for that asset where you can see all alerts for that asset without any filters is set as a destination for the widget.
    AssetWhen you select Asset as a destination for widget navigation, the asset page for that particular asset is set as the destination for a widget.
    CasesWhen you select Cases as a destination for widget navigation, the cases page for that asset where you can see all cases for that asset without any filters is set as a destination for the widget.
    AnalysisWhen you select Analysis as a destination for widget navigation, if there are tags configured, the analysis page of that asset for those tags is set as a destination for the widget. If there are no tags the default analysis page for that asset is set as a destination for the widget.
    DashboardsWhen you select Dashboards as a destination for widget navigation, Set Context is available. When you select Set Context the context browser opens, which allows you to set a dashboard as a destination. Once you select a context, the View Selector is enabled where you can select a view in the dashboard.
    Note: You do not have to select a destination for navigation. If you do not, you are directed to the default dashboard for the selected context or the first dashboard listed.
    DocumentsThis option is available to tenants that have permissions to the Document module.
  8. In a new Select Destination, continue to make navigation destination selections for the selected widget.
  9. Set next to each destination to On to enable the destination on the widget's List icon.
  10. Select Done to save your configuration changes, then Save to exit edit mode.
    The selected widget permits navigation to the selected target destinations.

Configure Layout and Data for a Widget

You can configure how a Bar chart is displayed and what data is available for the chart over a selected time range.

About This Task

Data selections include the following information:
  • Primary - On a selected module including a data type and a maximum of three attributes.
  • Secondary - Includes a data type and a maximum of six attributes for the primary selection.
The data selections vary by layout selection:
Table 5. Layout Selections
Selecting this chartDisplays this
Horizontal Simple ChartThe bars are displayed horizontally, without grouping. This selection does not allow secondary data configuration.
Vertical Simple ChartThe bars are displayed vertically, without grouping. This selection does not allow secondary data configuration.
Horizontal Stacked ChartThe bars are displayed horizontally, using stacked grouping. This selection requires secondary data configuration.
Vertical Stacked ChartThe bars are displayed vertically, using stacked grouping. This selection requires secondary data configuration.
Horizontal Grouped ChartThe bars are displayed horizontally, grouped by the secondary data configuration. This selection requires secondary data configuration.
Vertical Grouped ChartThe bars are displayed vertically, grouped by the secondary data configuration. This selection requires secondary data configuration.

Procedure

  • To configure the primary data item:
    1. Access the Dashboard Browser.
    2. Use the Context Browser to select an asset context.
    3. In an existing card, select Action , then select Edit Card.
    4. Hover over a grouped bar-chart widget, and then select .
    5. In Layout, select a chart type.
    6. In Timespan, select a time span for the chart.
    7. In Data, select for the Primary Data Item.
    8. In Primary Data Item, select:
      SelectionData Type Available
      Alerts
      • Severity
      • Status
      Cases
      • Severity
      • Status
      • Anomaly Type
    9. Hover over a data type, and then select .
    10. On Attributes, select a maximum of three attributes, and then select outside the selection box.
      All selections collapse and the primary data is enabled.
    11. If you are configuring a simple bar chart, select Done, and then select Save to save your changes. Otherwise, configure the secondary data item.
  • To configure the secondary data item:
    1. In Grouped By, select for the Secondary Data Item.
    2. Hover over a data type, and then select .
      The secondary data drop-down list box selection is based on the primary data item and cannot be selected.
    3. On Attributes, check a maximum of six attributes, then tap outside the selection box.
      All selections collapse, and the secondary data is enabled.
    4. Select Done to return to the card edit screen, and then select Save.

Configure Widget Refresh

You can configure each widget individually to automatically refresh over a selected interval.

About This Task

Widget refresh intervals do not have to match those of the card or the dashboard.

Procedure

  1. Access the Dashboard Browser.
  2. Use the Context Browser to select an asset context.
  3. On an existing card, select Action, and then select Edit Card.
  4. Hover over the widget, and then select .
  5. Select Refresh and select an interval:
    • Every 1 minute
    • Every 5 minutes
    • Every 10 minutes
    The default selection for Refresh is Off.
  6. Select Done, and then select Save.
    The widget refreshes at the defined interval.

Customize a Widget Refresh Using Time Control

You can use Time Control to customize interactive widgets to display the time range selected for a widget, and a date and time to use as a start point for the custom refresh interval.

About This Task

When you select a custom setting, the automatic refresh rate selected in the configuration is disabled. The following Time Control selections are available:
Table 6. Time Control Selections
This selectionAllows you to
Time SpanCustomize the interactive widgets on a card to temporarily refresh the data for the past day, week, month, three months, six months, or year. The selected time span is displayed at the bottom of the widget.
Date SelectorCustomize the interactive widgets on a card to temporarily refresh beginning at a date and time selected in the calendar. Default is set at the current date and time. For example, if the interactive widget is configured for seven days, it refreshes the data for the past seven days in the selected date and time in the Date Selector. The configured time range is displayed at the bottom of the widget.
Date & Time SpanCustomize the interactive widgets on a card to temporarily refresh beginning at a date and time selected in the calendar, and to select a default time span. For example, if the preset time selected is three months, the interactive widget refreshes the data for the past three months in the selected date and time in Date Selector. The selected time span is displayed at the bottom of the widget.
Custom Time SpanCustomize the interactive widgets on a card to temporarily refresh for a beginning and end date and time selected in the calendar. For example, if you select a nine-day range in the calendars, the interactive widget refreshes the data for the past nine days in the selected end date in the Date Selector. The selected time span is displayed at the bottom of the widget.

Default date ranges are displayed on the Custom Time Span calendar.

Procedure

  • To access Time Control:
    1. Access the Dashboard Browser.
    2. Use the Context Browser to select an asset context.
    3. Select a view.
    4. Select Action, and then select Time Control.
      The Time Control Selector is enabled.
  • To use Time Span:
    1. Select the Time Control Selector, and then select Time Span.
      A blue bar appears above the card containing several options.
    2. Select a preset time range.
      The automatic refresh rate is disabled, and the interactive widgets on the card refresh at the selected rate until you resume the normal refresh rate.
  • To use Date Selector:
    1. Select the Time Control Selector, and then select Date Selector.
      A blue bar, which contains a calendar field, appears above the card .
    2. Select the Calendar field and select a date in the calendar, and then select Apply.
      You can also select a specific time on the calendar before applying your changes.
      The automatic refresh rate is disabled, and the interactive widgets on the card refresh beginning in the selected date until you resume the normal refresh rate.
  • To use Date & Time Span:
    1. Select the Time Control Selector, and then select Date & Time Span.
      A blue bar, which contains a calendar field and other options, appears above the card.
    2. Select the Calendar field and select a date in the calendar, then select Apply.
    3. Select a time range.
      The automatic refresh rate is disabled, the interactive widgets on the card refresh beginning in the selected date, and the time range displayed changes to your selection until you resume the normal refresh rate.
  • To use Custom Time Span:
    1. Select the Time Control Selector, and then select Custom Time Span.
      A blue bar, which contains a from and to calendar field, appears above the card .
    2. Select a Calendar field and select a date for the start and end point in the calendar, and then select Apply.
      Table 7. Available Presets
      Selecting this PresetDisplays this
      TodayBegins at 12:00 A.M. and ends at the current timestamp.
      YesterdayBegins at 12:00 A.M. yesterday and ends at 11:59 P.M. yesterday.
      Last 7 DaysThe past seven days in the current date and time.
      This MonthBegins on the first of the month and ends on the current date and time.
      Last MonthThe date range begins on the first of the last months and ends on the last day of the last month.
      If you select a preset, the calendars adjust to reflect your selection.
      The automatic refresh rate is disabled, and the interactive widgets on the card refresh beginning in the selected date range until you resume the normal refresh rate.
  • To resume normal refresh rates:
    1. Access a customized time control card.
    2. Select Resume in the blue bar above the affected card.
    3. Select Action and clear Time Control.
    The card returns to its configured refresh rate.
  • Clear Time Control to disable the Time Control Selector.

Access Data from a Widget

You can navigate to a different Predix Essentials module on a widget that has been configured to allow navigation.

When you select such a widget, Predix Essentials accesses the appropriate module or Dashboard in another tab.

Table 8. Navigable Widgets
In this widgetSelect to access
Generic Chart Widget (time series)Accesses the time series chart in another tab. The analysis chart is plotted identically to the selected widget.
Note: You can adjust how the chart displays by muting and unmuting tags.
Interactive Chart Widget (time series)Accesses the configured destination module or Dashboard. You can configure multiple destinations and select one on this widget.
Vertical Grouped Bar Chart WidgetAccesses the configured destination Dashboard.
Spiderweb Chart WidgetAccesses the configured destination module or Dashboard.
KPI WidgetAccesses the configured destination module or Dashboard.
Small List WidgetAccesses the configured destination module or Dashboard.
Goals WidgetAccesses the configured destination module or Dashboard. You can configure multiple destinations and select one on this widget.
Scatter Chart WidgetAccesses the configured destination module or Dashboard. You can configure multiple destinations and select one on this widget.
Unclaimed Alerts and EventsAccesses the filtered Alerts Inbox in another tab.
Open CasesAccesses the filtered Cases Inbox in another tab.
Monitoring & Diagnostics OutcomesAccesses the filtered Cases Inbox by outcome in another tab.
Does not apply to Predix Essentials: Asset CriticalityAccesses details in Meridium.
Does not apply to Predix Essentials: Completed Work OrdersAccesses details in Meridium.
Does not apply to Predix Essentials: Open Work OrdersAccesses details in Meridium.
Does not apply to Predix Essentials: RecommendationsAccesses details in Meridium.

You can configure communication between widgets on the same card to synchronize and view data for the same timestamp. The time and date picker uses your preferred timezone set up in the user preference page. You can use time control for the configurable widgets on a card by selecting it in the Action drop-down list box. The time control is disabled for non-configurable widgets.

The Unit of Measure (UoM) you select appears on the dashboard for all the tags.

You do not have to select a destination for navigation. If you do not, you are directed to the default dashboard for the selected context or the first dashboard listed.

Mute and Unmute Chart Data on a Widget

You can adjust chart displays on the Dashboard or in the Analysis module by muting tags on the chart.

Procedure

  • To mute tags on a Generic chart widget with plotted tags:
    1. Access the Dashboard Browser.
    2. Use the Context Browser to select an asset context.
    3. Select a view.
    4. In the Generic chart widget, use Legend to scroll through tag names plotted on the chart.
    5. Select a tag.
      The action hides plotted data on the chart, and disables the tag Legend.
  • To unmute tags on the Generic chart widget:
    1. In the Generic chart widget, use Legend to scroll through the tag names plotted on the chart.
    2. Select a muted tag.
      The action displays plotted data on the chart, and enables the tag Legend.

Synchronize Widget Data on a Card

To make the data more meaningful, you must first synchronize the timestamps for the data.

About This Task

Widgets on the same card can be configured to communicate with each other. When not synchronized on a card, widgets display the timestamp closest in time for the communicating widgets.

Procedure

  1. Access the Dashboard Browser.
  2. Use the Context Browser to select an asset context.
  3. Select a dashboard.
  4. Select to ensure that the timestamp selected on the widget matches the timestamp on the communicating widgets.
  5. Verify the synchronization by selecting a data point on a widget configured for communication.
    All widgets on the card that are configured for communication display a data tool tip for the selected timestamp.

Modify the Timespan from a Widget

You can modify the timespan configured for a widget while you are viewing data.

About This Task

Widgets display the timespan set for them during configuration. Widgets with configurable timespans display timespan links at the bottom where you can select a different timespan. Selecting a new timespan does not modify the original configuration setting.

Procedure

  1. Access the Dashboard Browser.
  2. Use the Context Browser to select an asset.
  3. Select a dashboard with cards that contain one or more widgets with configurable timespans.
  4. In a widget with timespan links, select a different timespan link.
    The data displayed modifies to the new timespan.

Refresh Widgets

You can refresh the data displayed by the widgets on a dashboard on demand.

Procedure

  1. Access the Dashboard Browser.
  2. Use the Context Browser to select an asset context.
  3. Select a dashboard.
  4. Select , and then select Refresh Data.
    The dashboard reloads, refreshing data for each widget on the dashboard.
    Tip:
    • To refresh the data for a selected widget without refreshing the entire dashboard, try configuring auto-refresh for the selected widget.
    • To customize the interactive widgets on a card to temporarily refresh the data for selected time or date ranges, try configuring the time control for the selected widget.

Pause and Resume Dashboard Refresh

You can temporarily stop the automatic reloading of data to all widgets on a dashboard by pausing the refresh cycle.

About This Task

To freeze the dashboard data at a selected point in time, you can pause the data displayed at the current time until you resume the refresh cycle.

Procedure

  • To pause refresh on a dashboard:
    1. Access the Dashboard Browser.
    2. Use the Context Browser to select an asset context.
    3. Select a dashboard.
    4. Select , and then select Pause Data.
      The data refresh stops. At the top of the dashboard, a message tracks the running time the data refresh is paused.
  • To resume the normal refresh cycle for a dashboard, select Done.

Correct a Data Load Error with Refresh

When data fails to load for an Interactive Time Series widget, an error message displays at the bottom of the widget.

About This Task

Refresh the widget to reload the data.

Procedure

  1. Access the Dashboard Browser.
  2. Use the Context Browser to select an asset context.
  3. Select a dashboard to view.
  4. Select the red link at the bottom of the Interactive Time Series widget.
    The widget refreshes, loading the data if available.
    Tip: You can refresh the widget multiple times if the data continues to fail, or wait and refresh the data at a later time.

About Widget Repository Administration

Widget Repository Administration is only available to the Predix Essentials administrators. You need to work with whoever creates your tenants. They will need to create a new user and assign the Widget-Repo-Admin (QA) permission set to be able to access the Widget Repo Administration feature.

You can use Widget Repository Administration to search, add, or modify widgets.

Search for Widget Repository Administration

About This Task

You can search for widget repository administration.

Procedure

  1. Copy the secret URL in the browser.
  2. Enter your search criteria at the top of the page. You can only search for the name of the widget.
  3. Select Enter.

Results

The search results appear.

Add a Widget Repository Administration

Before You Begin

Only the Predix Essentials administrators can add a widget.

About This Task

Each widget in the widget library has a thumbnail image and description allowing you to make informed choices. Only the Predix Essentials administrators can add a widget.
You can add widgets in the following ways:
  • On the widget library during the creation of a new card.

Procedure

To add a widget to a new card:
  1. After you have added a new card, select Upload New.
  2. On the pop up window, do the following:
    Field Description
    Meta Data FileSelect Choose File, and navigate to the meta data file that you want to appear. The meta data file format should be .JSON.

    The metadata structure is as follows:

    PathTypeDescription
    idStringThe id can be an alphanumeric string of 5-30 characters. Special characters other than hyphens are not allowed.
    titleStringTitle of a widget cannot exceed 100 characters in length.
    instanceStringThe environment in which the widget resides.
    descriptionStringThe description of a widget cannot exceed 255 characters in length.
    slugStringThe slug id of a widget cannot exceed 50 characters in length.A new slug ID should be created for each instance of a widget and updated in the metadata.json and the markup.htm files.
    isConfigurableBooleanBoolean is either true or false.
    categoryString
    CategoryType
    ChartLine, Bar, Scatter, Pie, Area
    Grid
    Map
    Summary
    Component
    typeString
    CategoryType
    ChartLine, Bar, Scatter, Pie, Area
    Grid
    Map
    Summary
    authorStringThe author of a widget cannot exceed 100 characters in length.
    authorEmailStringThe authorEmail of a widget cannot exceed 100 characters in length.
    tenantslist of UUIDYou can have a maximum of 50 tenants.
    versionStringThe version of a widget.
    propertiesjsonAny additional default properties that cannot exceed 5000 characters in length.
    Markup FileSelect Choose File, and then navigate to the markup file that you want to appear. The markup file format should be .html. Cannot exceed 500 KB.
    Image FileSelect Choose File, and then navigate to the image file you want to appear. The SVG image should be 20px x 20px and smaller than 50 KB.
    TenantsOptionally, type to start adding tenant IDs.
  3. Select Save. Upon successful save, you can access the uploaded information on the Widget Repository.

Modify a Widget Repository Administration

Before You Begin

Only the Predix Essentials administrators can modify a widget.

Procedure

  1. Copy the secret URL in the browser.
  2. Search for the widget. You can only search for the name of the widget.
  3. Select Edit next to the widget.
  4. Optionally, select Upload a new version of widget check box, if you want to the same widget with a different version.
  5. Optionally, select Add Tenant Access, to add more tenant to the current widget. The tenant cannot exceed more than 50 characters.
  6. Select Save, and then select Back.

Delete a Widget Repository Administration

About This Task

Only the Predix Essentials administrators can delete a widget.

Procedure

  1. Access the Dashboard Browser.
  2. Use the Context Browser to select an asset context.
  3. Select the view containing the target card.
  4. Select the Action drop-down list box, and then select Edit Card.
  5. Select Delete Widget.
  6. Specify the name of the widget, and then select Delete. This permanently deletes a widget on the repository and makes it unavailable for future use.