OEE: Configuration, Dashboard and History

Last updated

License feature: OEE Tracking

Monitor > OEE opens OEE Tracking ("Overall Equipment Effectiveness monitoring"). It has three tabs: Dashboard, Configuration and History. Each device gets at most one OEE configuration.

Note: Bind Good Count Tag / Reject Count Tag and the engine counts automatically — see Feeding OEE counts and downtime for exactly how. Set a Run Status Tag and downtime opens and closes itself too; without one, downtime needs Log Downtime / End (or the API). Without a count source (bound tags or posted snapshots), Performance and OEE stay at 0 %.

Configure a device

1. Open the Configuration tab and click Add Device. The New OEE Config form opens.
2. Choose the Device.
3. Enter the Ideal Cycle Time (seconds) — the fastest sustainable time for one part at nameplate speed.
4. Pick the Production Time Source: From Shift Schedule or Manual.
5. For Manual, enter Planned Production Time (minutes per day).
6. Optionally pick tags under Tag Bindings — see the field table below for what each one does.
7. Click Save.

To change a configuration, click its edit icon (the form title reads Edit OEE Config and the Device cannot be changed). The trash icon deletes it immediately, with no confirmation.

Configuration fields

Field	What it does	Default	Allowed values
Device	The device this configuration belongs to. One per device. Changing it clears the tag fields.	first device	any device; locked when editing
Ideal Cycle Time (seconds)	Seconds per part at ideal rate. Used for Performance.	60	≥ 0, step 0.1. 0 makes Performance 0.
Production Time Source	Where planned production time comes from.	From Shift Schedule	From Shift Schedule, Manual
Planned Production Time (minutes per day)	Planned time for Manual. "From Shift Schedule" uses it only when no shifts are defined at all.	480	minutes; shown only for Manual
Good Count Tag	Live: every change is turned into a count increment and added to the current shift's snapshot (the day's, outside shifts or on Manual). See Feeding OEE counts and downtime.	None	subscribed tags on the device
Reject Count Tag	Live: same as Good Count Tag, for rejects. When it is set, logged quality events don't change OEE.	None	subscribed tags on the device
Run Status Tag	A tag that says whether the machine is running. When it stops matching Run Status Value, a downtime event opens automatically (Uncategorized — set the reason later); when it matches again, that event closes. See Feeding OEE counts and downtime.	None	subscribed tags on the device
Run Status Value (value when machine is running)	The reading that means running. Numbers compare as numbers (1 = 1.0), text ignoring case (RUN = run), and true/on count as 1, false/off as 0. Appears when a Run Status Tag is chosen.	1	text
Minimum Downtime (seconds)	A stop shorter than this opens no downtime event: it counts against Performance (fewer parts in the run time) instead of Availability. A stop that lasts this long opens its event then, with the start time set to when the machine actually stopped, so no downtime is lost. Appears when a Run Status Tag is chosen.	0 (every stop is downtime)	0 to 86400
Enabled	Off: the device's counts are not tracked, its Run Status Tag opens no downtime, it drops off the Dashboard, and any automatic downtime still open on it is closed. The configuration is kept, ready to switch back on.	on	on, off

The tag lists show only tags subscribed on the device. With none you see "No tags subscribed for this device. Add tags on the device detail page first."

The list shows columns Device, Cycle Time (e.g. 0.5s), Time Source (Shift or Manual), Tags Bound (n/3), Status and Actions. Status is a switch: click Enabled / Disabled to turn tracking off or on without opening the form. A configured minimum shows next to it (e.g. min. stop 30 s).

"From Shift Schedule" in detail

• The running shift comes from the shift's times and Active Days, and from the production calendar: a holiday stops a shift, and a calendar entry that picks a shift runs it that day. See Shift Scheduling.
• Each shift is its own OEE period. Counts, downtime and planned time all start from zero when a shift starts, and each shift gets its own History row.
• Planned time is the time elapsed in the shift so far, minus the Break Periods that have passed. A shift with no Break Periods takes off Total Break (min) spread evenly across the shift. Takt Time (s) and Target Parts/Shift don't change OEE.
• Between shifts and on holidays nothing is planned: the card says Not scheduled and OEE reads 0 %.

Dashboard tab

• Refreshes every 10 seconds from GET /api/oee/realtime.
• One card per configured device: the device name with the running shift (or Not scheduled), a large OEE %, a bar, mini bars for Availability, Performance and Quality, Good, Reject and Run Time, and a downtime line splitting unplanned, changeover and planned time.
• Color: green at 85 % or more, amber at 60 % or more, red below 60 %.
• Performance can show above 100 % (it is capped at 200 %); OEE, Availability and Quality are capped at 100 %.
• Empty state: "No devices configured for OEE tracking." / "Go to the Configuration tab to set up a device."

History tab

• Shows the latest 50 rows from GET /api/oee/history, filterable by All devices or one device.
• Columns: Date, Device, Shift, OEE, A, P, Q, Good, Reject.
• There is one row per device, date and shift (one per day outside shifts and on Manual). Each count update rewrites that row.
• The A, P, Q and OEE in a row are calculated from the counts saved in the same row.

Dashboard widgets and reports

• OEE Gauge and OEE Timeline widgets put the same numbers on a dashboard — see Production widgets.
• The report designer has an OEE Snapshots data source.

REST endpoints

Method	Path	Purpose	Role
GET	/api/oee/configs	List configurations	viewer
GET	/api/oee/configs/:deviceId	One device's configuration	viewer
POST	/api/oee/configs	Create or update (upsert by device)	editor
DELETE	/api/oee/configs/:deviceId	Delete a configuration	editor
GET	/api/oee/realtime	Live calculation for every enabled configuration	viewer
GET	/api/oee/realtime/:deviceId	Live calculation for one device (404 without a configuration)	viewer
GET	/api/oee/history	Snapshots; deviceId, from, to, limit (30), offset	viewer
POST	/api/oee/snapshot	Save counts for the current shift (or day)	operator

All /api/oee routes need a signed-in user token (JWT). API tokens for /api/v1 do not reach them.

See also

• OEE Formulas and Worked Example
• Feeding OEE Counts and Downtime
• OEE Troubleshooting
• Shift Scheduling
• Downtime Tracking
• Simulator Devices