BI Card#

Overview#

A BI Card is a graphic representations of Key Performance Indicators (KPIs), and are used as a mean to assess the performance of entities on the shop floor.

General Steps#

To use the BI Card widget in a UI Page, follow the steps below:

1. In any UI Page in Build mode, select the BI Card from the widgets list located on the left side of the page; drag and drop to the desired place in the UI Page.
2. Enter the Settings section of the widget through the three vertical dots.
3. In the General tab, provide a name and a description for the widget. Use the toggle buttons to specify whether the widget should be visible, display the header, or allow full screen mode. Additionally, determine if the widget can be opened as an image in a new tab or exported as an image. You can also select the navigation mode behavior: open a new page, replace the current page, or none.

Widget Customization#

1. Optionally, in the Style tab, you can define a Border Width and Color.

   

2. In the Setup tab, provide the Entity Type for which you want to create the Card and in the next field, specify the precise equipment for which data will be shown in the Card. Additionally, select if you want to display the entity name in the widget header, by setting the Show Entity Name toggle button to true (default setting is false).

   

   Note

   When a BI Card is configured with a KPI/Dimension that uses a variable such as @EntityName or @EntityId, you should fill out the field below the Entity Type. If this field is left empty, it is available as an input of the BI Card Widget, so that, for example, another widget can be configured in the UI Page to have this variable populated dynamically.

3. In the Layout page, provide the following properties:

   • KPI - Select the KPI to be displayed.
   • Title - Add a title to be displayed in the Card.
   • Dimension - Specify the time frame for the values to be displayed.
   • Show Caption - Determine whether the chart captions should be displayed. This option is set to true by default.
   • Show Title - Decide whether to display the title. This option is set to true by default.
   • Show Subtitle - Decide whether to display the subtitle. This option is set to true by default.
   • Gauge Type - Select the graphic representation for the BI Card from the available gauge types to display the data. Depending on the gauge type selected,additional options may become available. For more information on gauge types, see the Data Value widget page.

   You can add multiple KPIs by selecting the button in the top right-hand corner of the screen. To remove a KPI, select the button. The Cards can be resized and arranged as desired by dragging them to adjust their proportions.

   Layout PropertiesGauge Types

   

   

   Note

   KPIs available for selection will match the Entity Type for which the BI Card widget is setup.

4. Optionally, define the Links between this widget and other elements of the UI Page.

   

5. To optimize the creation of BI Cards, you can duplicate an existing Card instead of creating new one. Simply select the three-dot icon and then Duplicate.

Real Use Case#

A BI Card can be linked to show data for a specific entity, such as one provided as input from an Entity List widget.

Preconditions#

• An Entity Type List widget must be present on the same UI Page and configured for the matching Entity Type.

• The KPI must be configured with a corresponding @EntityName parameter to ensure the data is specific to the entity.

Steps#

1. Set up the link between the BI Card and the Entity List widget. The configuration should look similar to the following example:

Available KPIs#

You can see a list of dynamic KPIs that are available in a fresh installation of Critical Manufacturing MES in this page: System KPIs.