KPI#

The KPI Tasks are categorized into Dynamic KPI, KPI Data Series, KPI Data Value, Overall Equipment Effectiveness, Process KPI, and Resource KPI. Each type is further described below.

Dynamic KPI#

The Dynamic KPI Task provides a data value from a given KPI. This task allows you to use several different KPI types and use them in combination with several widgets like the Data Value and Data Series widgets. To configure a Dynamic KPI, you need to provide a name and, optionally, a description. Additionally, you can customize its behavior by adjusting the following settings:

Auto Refresh - When enabled, the page will automatically update its data at defined intervals. You can set the specific interval according to your needs. The default setting is false.
Retrieve Data on Start - When enabled, the system will fetch and display relevant data as soon as the page loads. The default setting is true.
Retrieve Data on Changes - When enabled, the system will update the data displayed whenever there are changes. The default setting is true.

The Dynamic KPI task includes a Setup tab where you can define the Entity Type, a KPI associated with the Entity Type selected and a Dimension (current day, month, order, shift, week, last 3 or 7 days).

KPI Data Series#

The KPI Data Series Task retrieves information from an existing KPI. This task also allows you to use several different KPI types and use them in combination the Data Series widget. To configure a KPI Data Series, you need to provide a name and, optionally, a description. Additionally, you can customize its behavior by adjusting the following settings:

Auto Refresh - When enabled, the page will automatically update its data at defined intervals. You can set the specific interval according to your needs. The default setting is false.
Retrieve Data on Start - When enabled, the system will fetch and display relevant data as soon as the page loads. The default setting is true.
Retrieve Data on Changes - When enabled, the system will update the data displayed whenever there are changes. The default setting is true.
KPI - Select a existing KPI from the MES system.

The KPI Data Series task includes a Setup tab where you can configure the time frame using:

Last Occurrences - where you can choose the number and the units (time frames, minutes, hours, days, weeks, and months).
Time Interval - where you can selected the start and end date.

You also have the possibility to show the terminated occurrences by toggling the Show Terminated button, set to true as default.

Last OccurrencesTime Interval

In the Links Diagram, you will be able to see the outputs from the KPI Data Series, which include Data Series, Date Entries, and KPI Name.

This task can feed directly a Data Series widget, as shown below.

KPI Data Value#

The KPI Data Value Task also retrieves information from an existing KPI. This task allows you to use several different KPI types and use them in combination with the Data Value widget. To configure a KPI Data Value, you need to provide a name and, optionally, a description. Additionally, you can customize its behavior by adjusting the following settings:

Auto Refresh - When enabled, the page will automatically update its data at defined intervals. You can set the specific interval according to your needs. The default setting is false.
Retrieve Data on Start - When enabled, the system will fetch and display relevant data as soon as the page loads. The default setting is true.
Retrieve Data on Changes - When enabled, the system will update the data displayed whenever there are changes. The default setting is true.
KPI - Select an existing KPI from the MES system.

In the Links Diagram, you will be able to see the outputs from the KPI Data Value, which include Data Value, KPI Name, KPI Units, KPI Type, KPI Value, KPI Minimum, KPI Maximum, KPI Close To Target Minimum, KPI Target Minimum, KPI Target, KPI Target Maximum, KPI Close To Target Maximum, and KPI Delta.

Overall Equipment Effectiveness#

This task was specifically developed to be used in the Overall Equipment Effectiveness System UI Page. To configure the Overall Equipment Effectiveness task, you need to provide a name and, optionally, a description. Additionally, you can customize its behavior by adjusting the following settings:

Auto Refresh - When enabled, the page will automatically update its data at defined intervals. You can set the specific interval according to your needs. The default setting is false.
Retrieve Data on Start - When enabled, the system will fetch and display relevant data as soon as the page loads. The default setting is true.
Retrieve Data on Changes - When enabled, the system will update the data displayed whenever there are changes. The default setting is true.

In the Links Diagram, you will be able to see the following inputs:

Time Frame - The data that will be shown in the graph.
Include Actual - Indicates if the actual week/month should be included or not.
Facility - The Facility for which the process KPIs are to be retrieved.
Area - The Area for which the process KPIs are to be retrieved.
Resource Type - The Resource Type for which the process KPIs are to be retrieved.
Resource Resource Type - The Resource Resource Type for which the process KPIs are to be retrieved.
Resource - The Resource for which the process KPIs are to be retrieved.
Shift Definition - The Shift Definition for which the process KPIs are to be retrieved.
Shift Definition Shift - The Shift Definition Shift for which the process KPIs are to be retrieved.
Lower Target - Used to define interval of the yellow color.
Minimum Lower Target - Used to define interval of the red color.

You will also be able to see the outputs:

OEE Data Value - Data value of Overall Equipment Effectiveness indicator.
AVA Data Value - Data value of Availability indicator.
QUA Data Value - Data value of Quality indicator.
PER Data Value - Data value of Performance indicator.
Data Series - Data that feeds the OEE Data Series.
OEE Data - Object containing the necessary data to populate the widget.
Last Time Frame - The Last Time Frame Data.

An example of this task in use is shown below.

Process KPI#

The Process KPI Task allows you to track and analyze KPIs related to specific processes. To configure the Process KPI task, you need to provide a name and, optionally, a description. Additionally, you can customize its behavior by adjusting the following settings:

Auto Refresh - When enabled, the page will automatically update its data at defined intervals. You can set the specific interval according to your needs. The default setting is false.
Retrieve Data on Start - When enabled, the system will fetch and display relevant data as soon as the page loads. The default setting is true.
Retrieve Data on Changes - When enabled, the system will update the data displayed whenever there are changes. The default setting is true.

In the Links Diagram, you will be able to see the following inputs:

Time Frame - The data that will be shown in the graph.
Include Actual - Indicates if the actual week/month should be included or not
Facility - The Facility for which the process KPIs are to be retrieved
Area - The Area for which the process KPIs are to be retrieved
Step Type - The Step Type for which the process KPIs are to be retrieved
Step - The Step for which the process KPIs are to be retrieved
Resource Type - The Resource Type for which the process KPIs are to be retrieved
Resource Resource Type - The Resource Resource Type for which the process KPIs are to be retrieved
Resource - The Resource for which the process KPIs are to be retrieved
Product Group - The Product Group for which the process KPIs are to be retrieved
Product Type - The Product Type for which the process KPIs are to be retrieved
Product - The Product for which the process KPIs are to be retrieved
Lower Target - Used to define interval of the yellow color
Minimum Lower Target - Used to define interval of the red color
Units Lower Target - Specifies the units for the lower target.
Units Minimum Lower Target - Specifies the units for the minimum lower target.

You will also be able to see the outputs:

Yield Data Value - Data value of the Yield indicator.
UTC Data Value - Data value of the Unit Cycle Times indicator.
Yield Data Series - Data that feeds the Yield Data Series.
UTC Data Series - Data that feeds the Unit Cycle Time Data Series.
Problems Data Series - Data that feeds the Problems Data Series.
Process KPI Data - Object containing the necessary data to populate the widget.

Resource KPI#

The Resource KPI Task allows you to track and analyze KPIs related to specific resources. To configure the Resource task, you need to provide a name and, optionally, a description. Additionally, you can customize its behavior by adjusting the following settings:

Auto Refresh - When enabled, the page will automatically update its data at defined intervals. You can set the specific interval according to your needs. The default setting is false.
Retrieve Data on Start - When enabled, the system will fetch and display relevant data as soon as the page loads. The default setting is true.
Retrieve Data on Changes - When enabled, the system will update the data displayed whenever there are changes. The default setting is true.

In the Links Diagram, you will be able to see the following inputs:

Time Frame - The data that will be shown in the graph.
Include Actual - Indicates if the actual week/month should be included or not.
Resource Type - The Resource Type for which the process KPIs are to be retrieved.
Facility - The Facility for which the process KPIs are to be retrieved.
Area - The Area for which the process KPIs are to be retrieved.
Step Type - The Step Type for which the process KPIs are to be retrieved.
Step - The Step for which the process KPIs are to be retrieved.
Resource Resource Type - The Resource Resource Type for which the process KPIs are to be retrieved.
Resource - The Resource for which the process KPIs are to be retrieved.
Time Minimum Lower Target - Uptime for the minimum lower target.
Time Lower Target - Uptime for the lower target.
Time Upper Target - Downtime for the upper target.
Time Maximum Upper Target - Downtime for the maximum upper target.
MTBF Minimum Lower Target - Mean Time Between Failure for the minimum lower target.
MTBF Lower Target - Mean Time Between Failure for the lower target.
MTTR Upper Target - Mean Time To Repair for the upper target.
MTTR Maximum Upper Target - Mean Time To Repair for the maximum upper target.

You will also be able to see the outputs:

Uptime Data Value - Data value of the Uptime indicator.
Downtime Data Value - Data value of the Downtime indicator.
MTBF Data Value - Data value of the Mean Time Between Failure indicator.
MTTR Data Value - Data value of the Mean Time to Repair indicator.
Operating Time Data Series - Data that feeds the Operating Times Data Series.
Mean Time Data Series - Data that feeds the Mean Time Between Failure & Mean Time to Repair Data Series.
Time At State Data Series - Data that feeds the Time at State Data Series.
Resources KPI Data - Object containing the necessary data to populate the widget.