OEE
User Guide
Created By Gabriel Turmail, Logan Kraus
Revision C
Revision Date: 3/31/2023
[Link]™️ - EFFECTIVE 01 January 2023 | © SORBOTICS LLC., 2023
CONFIDENTIAL- Please Do Not Share.
ALL RIGHT RESERVED. ANY UNAUTHORIZED USE OR DISCLOSURE IS PROHIBITED BY LAW AND WILL RESULT IN PROSECUTION.
1
Terms And Conditions User Agreement.
All rights reserved. No part of this documentation shall be reproduced, stored in a retrieval system, or
transmitted by any means, electronic, mechanical, photocopying, recording, or otherwise, without prior
written permission. No copyright or patent liability is assumed with respect to the use of the information
contained herein. Although every precaution has been taken in the preparation of this documentation, the
publisher and the author assume no responsibility for errors or omissions. Neither is any liability assumed
for damages resulting from the use of the information contained herein.
The information in this documentation is subject to change without notice and does not represent a
commitment. The software described in this documentation is furnished under a license or nondisclosure
agreement. This software may be used or copied only in accordance with the terms of these agreements.
OEE User Guide
2
Table of Contents
TERMS AND CONDITIONS USER AGREEMENT. ..........................................................................................1
TABLE OF CONTENTS ...................................................................................................................................2
INTRODUCTION ............................................................................................................................................4
ABOUT THIS MANUAL................................................................................................................................................... 4
Technical support ................................................................................................................................................. 4
WHAT IS OEE .................................................................................................................................................5
KEY PERFORMANCE INDICATORS.................................................................................................................................. 5
Availability ........................................................................................................................................................... 5
Performance ......................................................................................................................................................... 5
Quality.................................................................................................................................................................. 5
OEE EVENTS ............................................................................................................................................................... 5
CREATING AN OEE SENSOR ........................................................................................................................6
NAVIGATING TO THE OEE SENSOR MENU .................................................................................................................. 6
CREATING A NEW OEE SENSOR ................................................................................................................................. 8
THE OEE USER INTERFACE ........................................................................................................................ 10
NAVIGATING TO THE OEE USER INTERFACE .............................................................................................................. 10
OEE NODE DASHBOARD .......................................................................................................................................... 11
Availability, Quality, Performance ................................................................................................................. 12
Production KPIs ................................................................................................................................................. 13
SHIFT ................................................................................................................................................................. 14
Availability Production ..................................................................................................................................... 14
Line Status ......................................................................................................................................................... 15
Production Rate ................................................................................................................................................ 15
Predicted Units .................................................................................................................................................. 16
Trend Data ........................................................................................................................................................ 16
Events Summary ................................................................................................................................................ 16
Other Metrics .................................................................................................................................................... 16
CONFIGURING AN OEE SENSOR .............................................................................................................. 18
OPENING YOUR SENSOR.......................................................................................................................................... 18
CONFIG ................................................................................................................................................................... 18
SCHEDULER............................................................................................................................................................... 19
EVENTS .................................................................................................................................................................... 20
Types of OEE Events ......................................................................................................................................... 20
Creating a New OEE Event .............................................................................................................................. 21
Managing OEE Events ...................................................................................................................................... 22
REASON CODES ....................................................................................................................................................... 23
What are Reason Codes .................................................................................................................................. 23
Creating a Reason Code.................................................................................................................................. 23
Managing Reason Codes ................................................................................................................................. 24
HISTORICAL .............................................................................................................................................................. 24
Filtering Events .................................................................................................................................................. 24
Adding Reason Codes ...................................................................................................................................... 25
EVENT CATEGORIES AND SHIFTS ............................................................................................................. 27
OEE User Guide
3
NAVIGATING TO EVENT CATEGORIES AND SHIFTS .................................................................................................... 27
EVENT CATEGORIES .................................................................................................................................................. 28
SHIFTS ...................................................................................................................................................................... 28
OEE INTERACTIONS ................................................................................................................................... 30
FINDING OEE EVENTS IN IOT UNIFIED EDGE ............................................................................................................ 30
OEE EVENT TRIGGERS IN IOT UNIFIED EDGE ............................................................................................................ 31
View OEE Event Triggers in Workspace ........................................................................................................ 31
Read and Write OEE Event Triggers in Data View ....................................................................................... 32
OEE User Guide
4
Introduction
ABOUT THIS MANUAL
This manual is divided into a series of logical building block chapters that describe the various aspects of
using SORBA OEE Platform. The SORBA OEE Users Guide will help you familiarize yourself with the SORBA
OEE Platform and its tools.
Assumptions:
• Users are familiar with Operating System: Windows, Linux, or Mac OS.
• Users are knowledgeable of how to use of a mouse, Windows menus, select options, browser
navigation, and accessing online Help.
• Users are experienced with SORBA SDE user interface and Web configuration Tools interface.
TECHNICAL SUPPORT
Our Technical Support team offers a variety of support options to answer any questions on the SORBA
OEE product and their implementation.
Prior to contacting technical support, please refer to the relevant chapter(s) in your SORBA ML Trainer
User's Guide for a possible solution to any problem(s) you may have with your system. If you find it
necessary to contact technical support for assistance, please make sure to have the following information
available:
1 The version of SORBA OEE you are running.
2 The type and version of the operating system you are using. For example, Microsoft Windows 7.
3 The exact wording of system error messages encountered.
4 Details of the attempts you made to solve the problem(s) and your results.
5 Details of how to recreate the problem.
6 If known, the Technical Support case number assigned to your problem (if this is an on-going
problem).
Technical Support can be contacted during regular business hours at info@[Link] or
[Link] Please make sure to have the information stated above to assist in
determining rapid response solutions.
OEE User Guide
5
What is OEE
KEY PERFORMANCE INDICATORS
OEE stands for Overall Equipment Effectiveness, and consists of three different performance metrics, which
are known as KPIs (Key Performance Indicators). The three KPIs that make up OEE are: Availability,
Performance, and Quality. You can think of OEE as being calculated by the formula:
𝑂𝐸𝐸 (Overall Equipment Effectiveness) = 𝐴𝑣𝑎𝑖𝑙𝑖𝑎𝑏𝑖𝑙𝑡𝑖𝑦 𝑥 𝑃𝑒𝑟𝑓𝑜𝑟𝑚𝑎𝑛𝑐𝑒 𝑥 𝑄𝑢𝑎𝑖𝑙𝑡𝑦
AVAILABILITY
Availability is considered to be when how often a line is able to run on its schedule, where 100%
availability is when the line is running with 0 problems.
PERFORMANCE
Performance is considered to be your theoretical rate of production versus your actual rate of production.
QUALITY
Quality is considered to be the result of quality checks, how much of your product is usable.
OEE EVENTS
OEE can also be affected by events. OEE events are instances when something occurs in your production
line to impact one of the three performance metrics that make up OEE. These could be any sort of event
that impacts the Availability, Performance, or Quality of your production line, and you can use the overall
OEE metric to determine the total impact of these events.
OEE User Guide
6
Creating an OEE Sensor
NAVIGATING TO THE OEE SENSOR MENU
Creating OEE Sensors is done through the workspace. The workspace is the hierarchy of components within
SORBA that can be found on the IOT Unified Edge web page. OEE configuration is based on groups within
this workspace hierarchy. You can access the workspaces page using this icon:
Figure 0.1 Accessing the Workspace Page in SORBA IOT Unified.
To create a new OEE sensor you first want to select the asset that you want to add the sensor to. Navigate
to that sensor in the hierarchy and then click on the Groups sub-heading within that asset to open the
Groups page:
OEE User Guide
7
Figure 0.2 Accessing the Groups node within an asset.
Once in the Groups page, you can create an OEE Sensor by pressing on the 3 dot menu in the top right
hand corner of the page, then selecting the Add Node heading, and then pressing on the Add OEE Sensor
button:
Figure 0.3: How to create an OEE Sensor.
OEE User Guide
8
CREATING A NEW OEE SENSOR
Once in the New OEE Sensor menu, you must give your new sensor a name, and optionally an alias and
description. You can also enable or disable the sensor during creation and select if you want this sensor to
follow class changes, which is useful when creating a template class.
Figure 0.4: New OEE Sensor Menu.
The final option when creating a new OEE sensor is to create custom fields. Custom fields are metadata
that you can add to your sensor for future reference by yourself or other members of your team. You can
create custom fields using the Add Custom Field button in the bottom right corner of the menu, and it brings
up the New Custom Field menu where you can name the field and give it a data type.
OEE User Guide
9
Figure 0.5: New Custom Field menu for a new OEE Sensor.
When you are done with your OEE Sensor, press the Save button to create it.
OEE User Guide
10
The OEE User Interface
The OEE User Interface, where you can configure and view OEE Nodes and Sensors, is a separate page
from the IOT Unified Platform.
NAVIGATING TO THE OEE USER INTERFACE
You can navigate to the OEE User Interface using the OEE symbol, a lightning bolt, on the left side of the
page in IOT Unified:
Figure 0.1: Lightning Bolt icon to navigate to the OEE User Interface.
Once in the OEE User Interface you will see a hierarchy very similar to the IOT Unified Hierarchy. This is
where you can configure OEE Sensors and Nodes:
OEE User Guide
11
Figure 0.2: Hierarchy of OEE Sensors and Nodes.
In the hierarchy in the OEE User Interface, an OEE Sensor or Node will be represented by a gauge icon,
which looks like this:
Figure 0.3: Gauge Icon of an OEE Sensor or Node.
OEE NODE DASHBOARD
When you click on one of your OEE Sensors or Nodes, you will see a pre-defined dashboard for that
asset:
OEE User Guide
12
Figure 0.4: Default OEE Sensor Dashboard.
Within this dashboard are many metrics. When you first create an OEE Sensor or Node, these will be
blank. Once configured, they will automatically populate. We will briefly go over each of the items in this
dashboard in the sections below:
AVAILABILITY, QUALITY, PERFORMANCE
Figure 0.5: Gauges that measure OEE, Availability, Quailty, and Performance KPIs.
The first four gauges measure Overall OEE, Availability KPI, Quality KPI, and Performance KPI.
OEE User Guide
13
PRODUCTION KPIS
Figure 0.6: Production KPIs display with TAKT calculated (TEEP not shown).
Production KPIs is split into two metrics. TAKT and TEEP. TAKT is an estimation of how long it takes to make
each unit of your product in seconds, while TEEP is total effective equipment performance, an indication of
how much capacity in your production line is going unutilized.
OEE User Guide
14
SHIFT
Figure 0.7: Current shift display.
AVAILABILITY PRODUCTION
Figure 0.8: Availability Production and Availability Runtime Display.
OEE User Guide
15
LINE STATUS
Figure 0.9: Line status and Good, Total, and Bad Parts displays.
Line status both tells you if your line is currently running, as well as current production counts including totals
of Good Parts, Total Parts, and Bad Parts.
PRODUCTION RATE
Figure 0.10: Production rate display (no data included for production rate in this example).
Production Rate is a measurement of how many units per minute are being produced based on the
theoretical rate defined in the scheduler.
OEE User Guide
16
PREDICTED UNITS
Figure 0.11: Predicted units display (no data included for predicted units in this example).
Predicted Units estimates how many units will be produced in the current shift based on the current
production rate.
TREND DATA
Figure 0.12: Trend data display (no data included for trend data in this example).
This section allows you to trend the OEE KPIs on a running graph for quick analysis.
EVENTS SUMMARY
Figure 0.13: Events summary display (no events included for summary display in this example).
The events section is split into 3 parts, a view of the Events Counter, a view of the Events Duration, and a
total Summary of the events.
OTHER METRICS
OEE User Guide
17
Figure 0.14: Other metrics display, which can be opened to reveal each extra metric.
The final section, other metrics, holds any data from your node or sensor that does not fall within the
default dashboard configuration. To view each extra metric, you can click on the Other Metrics box to
open up a display with each one.
OEE User Guide
18
Configuring an OEE Sensor
Once you have created an OEE Sensor on an asset in the IOT Unified platform, you can configure it from
the OEE User Interface.
OPENING YOUR SENSOR
To open your OEE Sensor, you can navigate the hierarchy just like you would in IOT Unified. You can click
on an entry to expand it and see nested components:
Figure 0.1: OEE Sensor and its gauge icon in the OEE Hierarchy menu.
Once you find the Sensor or Node you want to configure, click it to show the components nested in it. Each
component nested within allows you to configure different aspects of the Sensor or Node.
CONFIG
When you open the Config component of an OEE Sensor or Node, you can give it a cycle time in seconds,
which is how often the sensor will update, and a part demand, which will determine the TAKT time.
Figure 0.2: Configuration menu for an OEE Sensor.
OEE User Guide
19
SCHEDULER
The scheduler is where you will define your production schedule. You do this using the calendar tool in the
scheduler menu:
Figure 0.3: Scheduler menu for an OEE Sensor.
In this tool, you can click on any space in the calendar to mark the beginning of a shift and drag your
cursor to the end of the shift, releasing when you have the entire shift selected, to create a new shift on the
schedule.
Figure 0.4: Selecting time blocks on the schedule to create a new shift.
When you click on a shift, you can set attributes of the shift including the shift name, operator, theoretical
rate of production from this line, and a color for the shift.
OEE User Guide
20
Figure 0.5: New Shift configuration menu.
Once you are done creating and identifying your shift, you can either create more shifts or duplicate that
shift to fill the rest of the week with copies of that shift.
EVENTS
In the events page you can define events that indicate downtime or interruptions to your production
process.
TYPES OF OEE EVENTS
OEE Events can either be alarms triggered within your system or manual events that can be triggered
through a user interface or SCADA (Supervisory Control And Data Acquisition) system. Events are usually
known events that you can predict, and you can always add more once you identify potential interruptions.
When you create events in the OEE User Interface, they also appear in IOT Unified as tags under the
node.
OEE User Guide
21
Figure 0.6: OEE Events in the IOT Unified Edge Workspace hierarchy.
Please do not edit events from IOT Unified, you can edit them in the OEE User Interface. For more
information about this connection see Section 7 of this guide.
CREATING A NEW OEE EVENT
To create a new OEE event you press the Add Event button on the Event page.
Figure 0.7: Event configuration menu for an OEE Sensor, with Add Event button pointed out.
In the Add Event menu you can name the event, select an event type, and optionally give the event a
description.
OEE User Guide
22
Figure 0.8: Add Event menu.
The last field you can add to an event is Realtime Metadata, which are fields you can add to the event
that will collect data in real-time during the event and save for future analysis. Each Realtime Metadata
entry needs a name and type.
Figure 0.9: Realtime Metadata field within the Add Event menu.
Once you are done creating your new event, click on the Done button to save the event.
MANAGING OEE EVENTS
OEE User Guide
23
From the Event page you can manage your events by editing current events and deleting events you no
longer need.
Figure 0.10: Edit OEE Event button represented by a blue pen and Delete OEE Event button represented by a red trash can.
REASON CODES
WHAT ARE REASON C ODES
Reason Codes are applied to events after they occur and are used to provide more information as to why
the event occurred. They are usually used with generic event types. Reason codes can be used to create
more detailed reports.
CREATING A REASON CODE
Reason Codes can be created in the Reason Code page for a OEE Sensor using the Add Reason Code
button:
Figure 0.11: Reason Code menu for an OEE Sensor, with Add Reason Code button pointed out.
Once you enter the info for a reason code you can click Add to save the reason code.
OEE User Guide
24
Figure 0.12: Add Reason Code menu with Add button pointed out.
MANAGING REASON CODES
From the Reason Code page, you can delete currently created reason codes using this trash can button:
Figure 0.13: Delete Reason Code button pointed out, represented by a red trash can icon.
Reason Codes can be applied to events in the Historical page for an OEE Sensor or Node.
HISTORICAL
FILTERING EVENTS
When you enter the Historical page for an OEE Sensor or Node, the page will show up as blank.
OEE User Guide
25
Figure 0.14: Historical menu for an OEE Sensor.
To bring up past events, you need to set a filter. You can do this by pressing the Filter button to bring up
the Filter menu.
Figure 0.15: Filter button pointed out in the Historical menu for an OEE Sensor.
Within the filter menu you can select a range of dates to filter down to, and then select a type of shift to
filter down to that would fall during that range.
Figure 0.16: Filter menu.
Once you are happy with your filters, you can press on the Apply button to load the events from that
range of shifts.
ADDING REASON C ODES
OEE User Guide
26
You can give events in the Historical page Reason Codes by pressing on the blue edit button next to each
event.
You can either begin typing to create a new reason code and then press the save button, or click on the
box to open a drop-down menu of your currently defined reason codes (no save button required).
OEE User Guide
27
Event Categories and Shifts
NAVIGATING TO EVENT CATEGORIES AND SHIFTS
To find the event categories and shifts menu, you need to open the OEE User Interface and then select the
SDE node at the top of the hierarchy.
Figure 0.1: SDE Node at the top of the OEE User Interface Hierarchy.
Clicking on the SDE Node will open a page with two tabs, one named Category and one named Shift.
Clicking on these tab names will open that tab and let you edit them respectively.
OEE User Guide
28
Figure 0.2: Category and Shift tabs at the top of the menu, with Category currently selected.
EVENT CATEGORIES
There is a predefined list of event categories that appear in Event Type drop-down menu when creating
an event, but in the Event Categories tab you can edit or create your own categories of events. To create
a new category, press on the blue Add Category button to open the Add Category menu.
Figure 0.3: Category Menu with Add Category button pointed out.
In the Add Category menu you can name the new category and give it an overarching event type. Once
you are happy with your category you can press the Save button to finalize it.
Figure 0.4: Add Category Menu.
SHIFTS
OEE User Guide
29
In the Shifts menu you can edit and create new shifts that will appear in the Shift Name drop-down menu in
the scheduler for each OEE Sensor or Node.
Figure 0.5: Shift Menu with Add Shift button pointed out.
Clicking on the Add Shift button opens the Add Shift menu, where you can create a new shift category.
When you are done, press the save button to finish.
Figure 0.6: Add Shift menu.
OEE User Guide
30
OEE Interactions
FINDING OEE EVENTS IN IOT UNIFIED EDGE
When you create events through the OEE User Interface, they also appear in IOT Unified as tags under the
node.
Figure 0.1: OEE Events in the IOT Unified Edge Workspace hierarchy.
When you click on one of the events through IOT Unified Edge, you can find information about the event.
OEE User Guide
31
Figure 0.2: OEE Event information within IOT Unified Edge
Please do not edit events from IOT Unified, you can edit them in the OEE User Interface.
OEE EVENT TRIGGERS IN IOT UNIFIED EDGE
VIEW OEE EVENT TRIGGERS IN WORKSPACE
OEE Event Triggers are a set of conditions that create OEE Events when activated. They are automatically
created when an OEE Event is created. They can be viewed and controlled from IOT Unified Edge, where
they can be found in the workspace page under the OEE Sensor in the hierarchy.
Figure 0.3: OEE Event Triggers found in the IOT Unified Edge Workspace Hierarchy.
OEE User Guide
32
READ AND WRITE OEE EVENT TRIGGERS IN D ATA V IEW
OEE Event Triggers can be controlled within the Data View page of IOT Unified Edge for manual use or
testing purposes. You can access the Data View by clicking on the stack icon on the left side of the page.
Figure 0.4: Data View Icon in IOT Unified Edge.
In the Data View page, you will be presented with a simple user interface for managing tags, with a
version of the hierarchy from the workspace page on the left-hand side.
Figure 0.5: Data View page.
Once on the Data View page, you can select any number of tags to monitor and trigger by checking their
boxes from the hierarchy.
OEE User Guide
33
Figure 0.6: Selecting tags for monitoring on the Data View page.
Once you have selected all the tags you want to monitor, you can either change the settings of your
monitoring, or begin monitoring the selected tags.
To change the monitor settings, click on the gear icon to open the settings menu.
Figure 0.7: Settings button on the Data View page.
Within the settings menu you can change the monitoring mode and frequency.
OEE User Guide
34
Figure 0.8: Settings menu in the Data View page.
To begin monitoring the selected tags, click on the run button.
Figure 0.9: Run button pointed out on the Data View page.
If the tags have been assigned to PLC or SCADA tags, the values being measured from those will begin to
display. If not, you can manually trigger these tags using the Write Values button, which is represented by
a blue pen icon.
OEE User Guide
35
Figure 0.10: Write Values button pointed out on the Data View page.
Once you have entered the value you want to write to the tag, press the blue checkmark button to write
that value. To trigger an event, write a value of 1 to the trigger tag. To disable an event, write a value of
0 to the trigger tag. The OEE metric updates every 5 minutes, so changes to your KPIs may not be
immediate.
OEE User Guide