Setup
Navigation:

Example:

Description:
- The Setup screen allows users to configure the OEE model, including defining States, Modes, Availability Reasons, and other OEE Configurations. This screen is essential for customizing the OEE tracking system to fit the specific needs of the manufacturing operation.
How to use:
- To populate the OEE Configurations, States, Modes, and Availability Reasons tabs, the user must first select a location from the location tree on the left side of the screen. This selection will determine which configurations are displayed and modified.
OEE Configuration
Example:

OEE Configuration Workflow
- Select a location from the dropdown menu to configure OEE settings for that specific location.
- Set the Max Record Duration and Prune Days.
- Set the Max Flush Interval and the Max Time Between Executions.
- Fill out the Mode Expression.
- Configure the Availability settings:
- Enable Availability.
- Fill out the State Expression.
- Configure the Availability Reason Source and Availability Reason Expression.
- Fill out the Alarm Path.
- Configure the Performance settings:
- Enable Performance.
- Fill out the Production Count Unit of Measure.
- Fill out the Production Rate Time Unit.
- Fill out the Production Count Expression.
- Set the Production Count Overflow Value.
- Configure the Standard Rate Source and set the Standard Rate.
- Configure the Quality settings:
- Enable Quality.
- Configure the Quality Strategy and Quality Count Expression.
- Set the Quality Count Overflow Value.
- Configure the Production Order Source.
- Save the configuration by clicking the
Confirmbutton at the bottom of the screen.
OEE Configuration Fields
Import
Imports the OEE configurations from a CSV or JSON file. The imported file should match the expected format exported from Tamaki MES to ensure data integrity.
Export
Exports the OEE configurations for the selected location to a CSV or JSON file. This can be useful for backup purposes or for transferring configurations between different instances of Tamaki MES.
Delete
Deletes the OEE configuration for the selected location. This will not affect any existing OEE Records at this location, they will remain.
Enabled
Toggles the OEE tracking for the selected location.
Max Record Duration
Maximum duration for an OEE record in seconds. Normally, the following events cause an OEE record to cut over to the next record:
- OEE Mode change at the location.
- Standard rate change at the location.
- Production order change at the location.
- [future] Operation start or end at the location.
- [future] Shift start or end at the location.
If none of those events occur within the Max Record Duration, the OEE record will to cut over to the next record automatically. The purpose of this is to control the granularity of the records. Changing this value will not affect existing records, but will apply to new records created after the change.
Prune Days
Number of days to retain OEE records in the database before deleting. (If blank, records will be kept indefinitely)
Max Flush Interval
Maximum time oee data being flushed into the database from the data collection service.
Max Time Between Executions
Maximum number of seconds between data collection evaluating data.
Mode Expression
The Expression Field is evaluated to an integer value corresponding to a Mode's code of the location is bound to the OEE model.
Availability
Enable Availability
Enables availability tracking for the OEE Records. This allows the system to track when the location is running and when it is not, providing insights into the operational efficiency of the equipment.
State Expression
This is where the Oee State's code number is specified for this location State. This can be a static value but will most likely be a tag binding to reflect the PLC's value for the state of the machine Expression Field.
Availability Reason Source
Opens a dropdown with the following options:
- Manual: The availability reason will be manually selected by the user when a downtime event occurs using the Downtime Entry page.
- Expression: The availability reason will be determined by the Availability Reason Expression field.
Availability Reason Expression
This is where the Availability Reason's fault code is specified for this location Availability Reason. This can be a static value but will most likely be a tag binding to reflect the PLC's value for the fault code of the machine Expression Field.
Alarm Path
This defines the tag path where alarms related to this location are configured. Any alarms triggered under this path will be captured and associated with the corresponding equipment.
Performance
Enable Performance
Enables performance tracking for the OEE Records. This allows the system to track the production count and rate of the location.
Production Count Unit of Measure
The unit of measure for the Production Count. This is used to define how the production count is measured, such as in pieces, kilograms, or liters.
Production Rate Time Unit
The time unit for the production rate, such as seconds, minutes, or hours. This is used to define how the production rate is calculated.
For example, if this field is set to Minutes, and the Production Count Unit of Measure is set to Pound, then the production rate will be calculated in Pounds per Minute.
Production Count Expression
This is where the production count value is specified for the location Production Count. This can be a static value but will most likely be a tag binding to reflect the PLC's value for the current production count at the machine Expression Field.
Production Count Overflow Value
The tag capturing production count will roll over to 0 when it reaches this value. This is used to calculate the production count.
Standard Rate Source
Opens a dropdown with the following options:
- Static: The standard rate will be a fixed value set in the Standard Rate field.
- Expression: The standard rate will be determined by the Standard Rate Expression field.
Standard Rate (UoM/Time Unit)
The fixed value for the Standard Rate of the location, defined in the unit of measure and time unit specified in the Production Count Unit of Measure and Production Rate Time Unit fields. This is used to define the expected production rate for the location.
Standard Rate Expression (UoM/Time Unit)
This is where the value for the Standard Rate is specified for the location. This can be a static value but will most likely be a tag binding to reflect the PLC's value for the standard rate for the product running at the machine Expression Field.
Quality
Enable Quality
Enables quality tracking for the OEE Records. This allows the system to track the waste count and rate of the location.
Quality Strategy
Opens a dropdown with the following options:
- Good Count: The Quality Count Expression field is evaluated based on the count of good units produced.
- Waste Count: The Quality Count Expression field is evaluated based on the count of waste units produced.
Quality Count Expression
The Expression Field where the PLC tag for the Good Count or Waste Count of the location is bound to the OEE model.
Quality Count Overflow Value
The tag capturing waste count will roll over to 0 when it reaches this value. This is used to calculate the waste count.
Production Order
Production Order Source
Opens a dropdown with the following options:
- None: No production order will be tracked for the location.
- Expression: The production order will be determined by the Production Order Expression field.
Production Order Expression
This is where the name or id of the Production Order running at the location. This can be a static value but will most likely be a tag binding to reflect the PLC's value for the current production order name running at the machine Expression Field.
States
Example:

State Workflow
Create New State
- Click on the
Create Newbutton to create a new state. - Fill out the fields in the popup that appears (see Edit or Create New State Popup Fields for details).
- Click the
Confirmbutton to save the new state.
Edit State
- Select a state from the list on the right side of the screen.
- Click on the
Editbutton to open the edit popup. - Modify the fields in the popup as needed (see Edit or Create New State Popup Fields for details).
- Click the
Confirmbutton to save the changes.
State Fields
Import
Imports the OEE states from a CSV or JSON file. The imported file should match the expected format exported from Tamaki MES to ensure data integrity.
Export
Exports the OEE states for the selected location to a CSV or JSON file. This can be useful for backup purposes or for transferring configurations between different instances of Tamaki MES.
Delete
Deletes the selected state.
Edit
Opens the following popup to edit the selected state (in this case, "Downtime"):

Refer to Edit or Create New State Popup Fields for details on the popup.
Create New
Opens the following popup to create a new state:

Refer to Edit or Create New State Popup Fields for details on the popup.
Edit or Create New State Popup Fields
Enabled
Toggles the state on or off.
Name
The name of the state. This should be a descriptive name that clearly indicates the purpose of the state (e.g., "Running", "Downtime", "Setup").
State Calculation Type
This is a dropdown that allows the user to select how the OEE record of the state will be handled. The options are:
- Idle: This is the default state for the OEE record, indicating that the location is not currently running or producing anything.
- Running: This is the state for the OEE record when the location is actively producing items. This state is counted towards the OEE calculation as running time.
- Downtime: This is the state for the OEE record when the location is not producing items due to a planned or unplanned downtime event.
- Starved: This is the state for the OEE record when the location is not producing items because it is waiting for input from a previous location in the production line.
- Blocked: This is the state for the OEE record when the location is not producing items because it is waiting for output to be accepted by a subsequent location in the production line.
Interruption Location
This is a dropdown that allows the user to select an interruption location.
The interruption location is the location that is causing the state of the selected location to be set to the selected state.
Here are a few examples of states and their corresponding interruption locations:
-
State is
Downtime: The interruption location would be left blank, because downtime doesn't occur as a result of another location. -
State is
Starved: The interruption location would be the location that is directly before the selected location. This is because, for the location to be starved, the location before it in the production line must not be outputting what the selected location needs to run. -
State is
Blocked: The interruption location would be the location that is directly after the selected location. This is because, for the location to be blocked, the location after it in the production line must not be accepting an input from the selected location.
State Code
This is the integer code for the state, matching the PLC tag that indicates the state of the location. This code is used to identify the state in the PLC and should be unique for each state.
State Code
This is the integer code for the state, matching the PLC tag that indicates the state of the location. This code is used to identify the state in the PLC and should be unique for each state.
Color
The color associated with the state, used for visual representation in the OEE timeline.
Notes
The optional comments or explanation about the state.
Modes
Example:

Mode Workflow
Create New Mode
- Click on the
Create Newbutton to create a new mode. - Fill out the fields in the popup that appears (see Edit or Create New Mode Popup Fields for details).
- Click the
Confirmbutton to save the new mode.
Edit Mode
- Select a mode from the list on the right side of the screen.
- Click on the
Editbutton to open the edit popup. - Modify the fields in the popup as needed (see Edit or Create New Mode Popup Fields for details).
- Click the
Confirmbutton to save the changes.
Mode Fields
Import
Imports the OEE modes from a CSV or JSON file. The imported file should match the expected format exported from Tamaki MES to ensure data integrity.
Export
Exports the OEE modes for the selected location to a CSV or JSON file. This can be useful for backup purposes or for transferring configurations between different instances of Tamaki MES.
Delete
Deletes the selected mode.
Edit
Opens the following popup to edit the selected mode (in this case, "CIP"):

Refer to Edit or Create New Mode Popup Fields for details on the popup.
Create New
Opens the following popup to create a new mode:

Refer to Edit or Create New Mode Popup Fields for details on the popup.
Edit or Create New Mode Popup Fields
Enabled
Toggles the mode on or off.
Name
The name of the mode. This should be a descriptive name that clearly indicates the purpose of the mode (e.g. Idle, Production, Product Changover, Maintenance).
Mode Code
The integer code for the mode, matching the PLC tag that indicates the mode of the location. This code is used to identify the mode in the PLC and should be unique for each mode.
Mode Calculation Type
This is a dropdown that allows the user to select how the OEE record of the mode will be handled. The options are:
- Schedule Production: This mode is used for scheduled production runs, where the location is expected to produce items according to a predefined schedule.
- Scheduled Downtime: This mode is used for planned downtime events, such as maintenance or setup changes, where the location is not expected to produce items.
- Unscheduled Downtime: This mode is used for when the location is not planned to be producing items but not due to a planned downtime event. This could be simply idle time between production runs.
Color
The color associated with the mode, used for visual representation.
Expected Duration Source
Opens a dropdown with the following options:
- Expression: The expected duration will be determined by the Expected Duration Expression field.
- Static: The expected duration will be a fixed value set in the Expected Duration field.
Expected Duration Expression (Seconds)
The Expression Field where the PLC tag for the expected duration of the mode is bound to the OEE model. This allows for dynamic calculation of the expected duration based on real-time data.
Expected Duration (Seconds)
The fixed value for the expected duration of the mode, defined in seconds. This is used to set a baseline for how long the mode is expected to last, which can be useful for planning and scheduling purposes.
Notes
The optional comments or explanation about the mode. This will be automatically copied into any mode records as template notes.
Availability Reasons
Example:


Availability Reasons Model oee availability reason
Availability Reasons Workflow
Create New Availability Reason
- Click the availability reason you want to set as the parent reason, or leave it unselected if no parent reason is required.
- Click
Createon the default availability reason page. This will populate the right side of the screen with empty values, and set the Parent Availability Reason to what was clicked (see Edit or Create New Availability Reason Fields). - Fill out the fields on the right side of the screen (see Edit or Create New Availability Reason Fields for details).
- Click the
Confirmbutton to save the new availability reason.
Edit Availability Reason
- Select a availability reason from the tree on the left side of the screen. The right side of the screen will be populated with the details of the selected availability reason.
- Modify the fields on the right side of the screen as needed (see Edit or Create New Availability Reason Fields for details).
- Click the
Confirmbutton to save the changes.
Availability Reasons Fields
Availability Reason Tree
The availability reason tree displays the hierarchy of availability reasons. It allows users to navigate through the availability reasons, making it easier to add or edit a availability reason.
To edit a availability reason, select it from the tree to populate the right side of the screen. See Edit or Create New Availability Reason Fields for details on the fields.
Edit or Create New Availability Reason Fields
Import
Imports the OEE availability reasons from a CSV or JSON file. The imported file should match the expected format exported from Tamaki MES to ensure data integrity.
Export
Exports the OEE availability reasons to a CSV or JSON file. This can be useful for backup purposes or for transferring configurations between different instances of Tamaki MES.
Enabled
Toggles the availability reason on or off.
Name
The name of the availability reason, which is displayed in Downtime Entry and other places in the MES. This should be a descriptive name that clearly indicates the cause of the downtime.
Description
A concise, detailed description of the availability reason, providing additional context and information about the cause of the downtime. This can help operators and managers understand the issue better and take appropriate actions.
Code
The integer code for the availability reason, matching the PLC tag that indicates the availability reason or fault code of the location. This code is used to identify the availability reason in the PLC and should be unique for each availability reason.
Location
The location where this availability reason applies. This determines which specific machine, line, or area the reason is associated with when downtime is recorded.
Parent Availability Reason
The parent availability reason, which is used to create a hierarchy of availability reasons. This allows for categorization and grouping of related availability reasons, making it easier to analyze and report on downtime events.