Creating and deleting KPI instances

KPI instances

KPI instances can be created either in the parameter list of the respective dashboard or when a widget is created. You can create the KPI instance either when creating a widget or later by editing the widget again.

You have several options to create a KPI instance:

  • You create a KPI type in the configuration and instantiate it either directly in the widget or in the parameter list. (typed)

  • You create a new KPI instance directly in the widget or the parameter list. (typeless)

In the preview, you can see the formula it contains and which operand is linked to which variable.

New KPI instances cause costs. The number of currently used KPI instances is displayed in the "Settings" menu under "Usage information".

If all KPI instances are occupied, order additional KPI instances or delete a KPI instance that is no longer needed.

NOTE

Automatically created KPI instances

Automatically generated dashboards automatically generate KPI instances. These can not be edited.

Creating KPI instances based on a KPI type (typed)

Follow these steps to create a KPI instance based on a KPI type:

  1. Create a widget.

    - or -

    Open a widget for editing.

  2. Go to the "Parameter" area

  3. Click "Create a new KPI instance".

  4. In the "General" area, you assign one unique KPI instance name per asset.

  5. Select "On basis of a KPI type (typed)".

    155974525323.png
  6. Select the desired KPI type. The preview shows the formula it contains.

    When you select a KPI type with time categories, you have the option of linking a status mapping and a parameter for the machine status.

  7. Link all operands contained in the formula to a variable or a KPI type. If you assign a variable to the operand, you also need to select an aggregation function.

    155978197515.png
  8. Select a status mapping.

Creating KPI instances without KPI type (typeless)

Follow these steps to create a typeless KPI instance:

  1. Create a widget.

    - or -

    Open a widget for editing.

  2. Go to the "Parameter" area

  3. Click "New KPI instance".

  4. Click the "General" tab.

  5. Assign a unique KPI instance name per asset.

  6. Select "Without KPI type (typeless)".

  7. Enter a unit.

    155980774795.png
  8. Create the formula from constants, operands, time categories and operators.

    If you select a time category, you also have the option of linking a status mapping and a parameter for the machine status.

  9. Link all operands contained therein to a variable or a KPI type. If you assign a variable to the operand, you also need to select an aggregation function.

If you have already defined limits for the variable or KPI used, they are displayed preset in the widget. These limits can be overwritten.

Defining limits

You can define limits both for typed and for typeless KPI instances (user-based KPI instances).

To define the limits, follow these steps:

  1. Go to the area "Limits".

  2. Enter the limit values.

    155978631307.png
  3. To receive notifications when a high or low limit value is violated, enable the function "Activate notifications".

    You can find additional information on the "Activate notifications" function here: "Activate notifications" for variables with numerical data type and KPI instances

Deleting KPI instances

You can delete KPI instances from the parameter list of the asset.

Follow these steps to delete a KPI instance:

  1. In "My Plant", select the asset in which the KPI instance is used.

  2. Open the list of the parameters.

  3. Select the KPI instance that is to be deleted.

    155980786187.png
  4. Click 175158468107.png and select 157269479179.png "Delete".

    NOTE

    No Undo

    The KPI instance is deleted without confirmation and can not be restored.