> For the complete documentation index, see [llms.txt](https://docs.tricloudnexus.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tricloudnexus.io/management-portal/oee.md).

# OEE

Configure Sites, Equipment, Shifts and Stop Causes to calculate Overall Equipment Effectiveness from your live data.

**OEE** (Overall Equipment Effectiveness) in Tricloud Nexus turns the data you already collect from your machines into a single, comparable score for how well each piece of equipment is performing. The calculation combines three pillars — **Availability**, **Performance**, and **Quality** — into one score you can track over time, compare across lines, and use to drive improvement work.

OEE in Nexus is built on top of the same building blocks you use elsewhere in the platform: **tags** carry the live machine signals, **shifts** define when equipment is expected to run, and **stop causes** explain why it isn’t. Once configured, the platform continuously calculates OEE for every enabled equipment and stores the results in your OEE-purposed [data store](/management-portal/platform-settings/data-stores.md), where they can be queried and used to build dashboards, just like any other measurement.

***

## Key Capabilities

* **Three independent pillars**\
  Enable **Availability**, **Performance**, and **Quality** individually for each equipment, with a target per pillar plus an overall OEE target.
* **Site → Area → Equipment structure**\
  Organize plants, lines and machines in a single tree that mirrors your physical layout.
* **Shift-aware calculations**\
  Define shift calendars per Site and assign them to equipment so OEE only counts time when equipment is expected to run.
* **Planned Stops**\
  Schedule recurring planned downtime (changeovers, maintenance, breaks) so it doesn’t count against Availability.
* **Stop Causes & Error Code Mapping**\
  Translate vendor error codes coming from PLCs into business-friendly stop reasons categorized as Planned or Unplanned.
* **State Mapping**\
  Map raw equipment states (e.g. `Running`, `Stopped`, `Idle`) to Availability Categories so the calculation knows what counts as productive time.
* **Product Lists with Excel import**\
  Maintain a per-Site product list with ideal cycle times, importable from a standard Excel template.
* **Calculations as tag inputs**\
  When a single tag isn’t enough, derive equipment state, error codes, or product information from a multi-variable expression — same engine used by the [Equation data connector](/management-portal/designer/assets/data-connectors/equation.md).

<figure><img src="https://570593659-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYMGRODsc2QD3N3wmfwTl%2Fuploads%2Fgit-blob-22cb66391f35baa19c0bd5aabca79d35600c3010%2Foee-site-settings.png?alt=media" alt=""><figcaption><p>OEE Sites — tree of Site / Area / Equipment with the active equipment’s configuration tabs on the right</p></figcaption></figure>

***

## Where to Start

If you’re new to OEE in Nexus, work through the section in this order:

1. [**OEE Concepts**](/management-portal/oee/oee-concepts.md) — How Availability, Performance and Quality are combined, and how the Site / Area / Equipment structure fits together.
2. [**Prerequisites**](/management-portal/oee/prerequisites.md) — Data store and role required to set up and configure OEE.
3. [**Sites**](/management-portal/oee/sites.md) — Build the structure and configure your first Site (location, time zone, shift calendars, products).
4. [**Equipment**](/management-portal/oee/equipment.md) — Enable OEE on a piece of equipment, wire up its tags, assign a shift calendar, plan its stops, and map its states and error codes.
5. [**Availability Categories**](/management-portal/oee/availability-categories.md) — Global labels (Running, Unplanned Stop, Planned Stop, …) used by States Mapping and Planned Stops.

When you’re ready to validate the result, the [Use Cases](/management-portal/oee/use-cases.md) page walks through end-to-end scenarios for each pillar, and [Troubleshooting](/management-portal/oee/troubleshooting.md) covers the most common reasons OEE doesn’t calculate as expected.

{% hint style="info" %}
OEE is a separately licensed capability. If the **OEE** entry isn’t visible in the left navigation, see [Prerequisites](/management-portal/oee/prerequisites.md).
{% endhint %}