Skip to main content
Version: V2 (Ignition 8.1)

OEE Record

Overview​

The OeeRecord entity stores information for Past/Current runs in SQL to be reported on later. The entity contains several properties including the start and end time of the OEE record, the expected, quality, and total production units count, and the standard rate of production.

Table Structure​

The following table outlines the SQL columns for the oee_records table, providing a brief description of each.

ColumnTypeDescriptionExample
idString (ULID)Unique identifier for the entity.01JAP8RJBN-8ZTPXSGY-J9GSDPE1
enabledBooleanIf the entity is enabled or not.true
created_dateDateTimeDate the entity was created.2024-12-31T19:48:44Z
created_byStringPerson who created the entity.TamakiMES
modified_dateDateTimeDate the entity was modified. Value is null upon creation, and gets initially populated upon the first edit.2024-12-31T19:48:44Z
modified_byStringLast person to modify the entity. Value is null upon creation, and gets initially populated upon the first edit.TamakiMES
notesStringNotes about the entity.This entity has these extra notes
spare1StringThe first spare column that can be used for additional context on the entity.some extra context 1
spare2StringThe second spare column that can be used for additional context on the entity.some extra context 2
spare3StringThe third spare column that can be used for additional context on the entity.some extra context 3
location_idString (ULID)References the location for the OEE record. See Location.01JAP8RJBN-8ZTPXSGY-J9GSDPE1
statusString (Enum)Status of the OEE record (running, faulted, cancelled, complete etc.).RUNNING
start_dateDateTimeStart date/time of OEE record.2025-12-09T19:48:44Z
end_dateDateTimeEnd date/time of OEE record.2025-12-09T19:48:44Z
total_duration_secDoubleTotal duration of the OEE record in seconds.36.054
production_countDoubleTotal units produced in the recorded time period.52.5
expected_production_countDoubleExpected production count in the recorded time period.60.09
quality_strategyString (Enum)Quality Strategy for this OEE Record.WASTE_COUNT
quality_countDoubleProvided Quality Units Count in the recorded time period.2.9
production_count_uom_idString (ULID)Represents the unit of measure for production/quality count. See unit_of_measure.02K4M9QY3F-7XW8A2ZL-QM9D6B1P
production_rate_time_unitsString (Enum)Unit of measure for the machine production rate & standard rate.MINUTES
state_record_idString (ULID)Represents the current state for the OEE record. See Oee State Record.02K4M9QY3F-7XW8A2ZL-QM9D6B1P
standard_rateDoubleStandard production rate for the OEE record.100.0
production_order_idString (ULID)Represents the production order for the OEE record. See Production Order.02K4M9QY3F-7XW8A2ZL-QM9D6B1P
to_be_prunedBooleanWhen true, the record is flagged for deletion during the next OEE record pruning window. Defaults to false.false

Field Details​

location_id​

References the location for the OEE record. See Location for details.

status​

Status of the OEE record. Status types include IDLE, RUNNING, COMPLETED, FAULTED, CANCELLED, UNKNOWN, and PAUSED.

start_date​

Start date/time of OEE record.

end_date​

End date/time of OEE record.

total_duration_sec​

Total duration of the OEE record in seconds.

production_count​

Total units produced in the recorded time period.

expected_production_count​

Expected production count in the recorded time period.

quality_strategy​

Quality Strategy for this OEE Record. The quality strategy is used to determine how to calculate an OEE state number. Types include WASTE_COUNT and GOOD_COUNT.

quality_count​

Provided Quality Units Count in the recorded time period.

production_count_uom_id​

Represents the unit of measure for production/quality count. See unit_of_measure for details.

production_rate_time_units​

Unit of measure for the machine production rate & standard rate. Time Unit types are NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, and DAYS.

state_record_id​

Represents the current state of the machine for the OEE record. See Oee State Record for details.

standard_rate​

Standard production rate for the OEE record.

production_order_id​

This is the current production order of the machine for the OEE record. See Production Order for details.

to_be_pruned​

When true, the record is flagged for deletion during the next OEE record pruning window. Defaults to false.