> 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/prerequisites.md).

# Prerequisites

What needs to be in place before the OEE menu appears and you can configure your first Site.

Three things must be in place before you can use the OEE feature:

1. The **OEE feature** is enabled in your installation.
2. At least one **data store** has the **OEE** purpose flag set.
3. The user configuring OEE has the **Contributor** or **Administrator** role.

Each is covered below.

***

## 1. OEE Feature

OEE is a separately licensed capability, managed by Tricloud as part of your subscription — contact your Tricloud representative to enable OEE for your installation.

{% hint style="info" %}
After OEE is enabled, refresh the portal in your browser. The **OEE** menu appears between **Designer** and **Management** in the left navigation.
{% endhint %}

***

## 2. OEE-Purposed Data Store

OEE results (calculated values, state history, stop history) are written to a [data store](/management-portal/platform-settings/data-stores.md) you **select** per Site. Only data stores with Purpose **OEE** can be selected in the Site Settings.

To prepare a data store for OEE:

1. Open **Platform Settings → Data Stores**.
2. Either add a new Data Store, or edit an existing one.
3. In the **Purposes** field, tick **OEE** alongside any other purposes already set.
4. Save.

{% hint style="info" %}
Editing a data store's **Purposes** requires the **Administrator** role. Enabling the **OEE** purpose also provisions the OEE data schema in the underlying database, so the Site can start writing OEE results to it.
{% endhint %}

The same data store can serve OEE and other purposes (e.g. general time-series ingestion). Multiple data stores can have the OEE purpose; each Site selects one of them.

{% hint style="warning" %}
A Site without an OEE data store cannot calculate OEE. The Site Settings page surfaces a warning if the data store is missing.
{% endhint %}

***

## 3. User Role

Editing OEE configuration (creating Sites, mapping tags, scheduling shifts, defining stop causes, etc.) requires either:

* **Administrator**
* **Contributor**

See [User Roles and Permissions](/platform-architecture/security-architecture/user-roles-and-permissions.md) for the full role matrix. Users without one of these roles can still **view** the OEE pages if they have read access, but the Save / Add / Delete actions will be hidden.

***

## Verifying

Once all three are in place:

1. Sign in to the portal.
2. Confirm the **OEE** menu is visible on the left, with **Sites** and **Availability** sub-items.
3. Open **OEE → Sites** and choose **+ New Site**.
4. In Site Settings, confirm the **Data Store** dropdown lists at least one entry.

If any of these steps fails, return to the relevant section above before continuing to [Sites](/management-portal/oee/sites.md).
