Skip to main content

OEE DTO Reference

This document provides a comprehensive reference for all OEE (Overall Equipment Effectiveness) Data Transfer Objects ( DTOs) in the Tamaki MES system.

DowntimeByInterruptionLocationDTO

NameTypeNullableDescriptionDefault Value
interruptionLocationPathStringTruePath of the interruption locationnull
interruptionLocationNameStringTrueName of the interruption locationnull
durationDoubleTrueDuration of downtime caused by the interruption location0.0
countLongTrueCount of downtime events caused by the interruption locationnull
durationPercentDoubleTruePercentage of total duration caused by this interruption location0.0
countPercentDoubleTruePercentage of total count caused by this interruption location0.0

OeeAlarmRecordDTO

NameTypeNullableDescriptionDefault Value
idStringTrueThe id of the OEE Alarm Recordnull
locationIdStringFalseIdentifier of the associated locationnull
locationPathStringTruePath to the associated locationnull
oeeStateRecordIdStringTrueOee State Record Id active at this location at this timenull
oeeStateRecordCodeIntegerTrueOee State Record code active at this location at this timenull
nameStringFalseThe alarm name as configured in Ignitionnull
ignitionAlarmIdStringFalseUnique identifier of the alarm instance in Ignitionnull
sourceStringFalseThe tag path or source that generated this alarmnull
priorityAlarmPriorityTrueThe configured priority level of the alarmnull
displayPathStringFalseThe hierarchical display path of the alarm in the tag structurenull
labelStringFalseThe human-readable display name for the alarmnull
clearedBooleanFalseIndicates if the alarm condition has returned to normalfalse
acknowledgedBooleanFalseIndicates if the alarm has been acknowledged by an operatorfalse
shelvedBooleanFalseIndicates if the alarm has been temporarily suppressedfalse
stateAlarmStateFalseThe current state of the alarm in Ignition's state machinenull
lastEventStateAlarmStateTransitionFalseThe most recent state transition that occurred for this alarmnull
eventTypeAlarmEventTypeFalseThe event type of this alarm recordnull
timestampLongFalseThe timestamp when this alarm event was triggerednull
notesStringTrueNotes associated with the OEE Alarm Recordnull
enabledbooleanTrueIndicates whether the Alarm Record is enabledtrue
spare1StringTrueExtra field 1null
spare2StringTrueExtra field 2null
spare3StringTrueExtra field 3null

OeeChartSegmentDTO

NameTypeNullableDescriptionDefault Value
nameStringTrueThe name of the chart segment (e.g., "Unscheduled Downtime" or "Running")null
codeIntegerTrueThe integer code associated with the Mode or Statenull
colorStringTrueThe color code for displaying this segmentnull
durationDoubleTrueThe total aggregated duration of this segment in secondsnull
durationPercentDoubleTrueThe percentage (0.0 to 1.0) of the total duration that this segment occupiesnull
typeStringTrueThe type of the original record, either "Mode" or "State"null

OeeConfigurationDTO

NameTypeNullableDescriptionDefault Value
idStringTrueThe id of the OEE Configurationnull
locationIdStringFalseIdentifier for the associated locationnull
locationPathStringTruePath for the associated location. For display purposes onlynull
maxRecordDurationIntegerFalseMaximum duration for an OEE production record in seconds600
maxTimeBetweenExecutionsIntegerTrueMaximum # of seconds between executions5
maxFlushIntervalIntegerTrueFlush interval in secondsnull
pruneDaysIntegerTrueNumber of days to retain OEE production recordsnull
modeExpressionStringTrueIgnition expression used to determine the OEE modenull
enableAvailabilityBooleanFalseFlag to enable or disable OEE availability calculationstrue
stateExpressionStringTrueIgnition expression for determining the machine statusnull
availabilityReasonSourceOeeAvailabilityReasonSourceTrueSpecifies how the system determines the availability reason codeMANUAL
availabilityReasonExpressionStringTrueIgnition expression that returns an integer code corresponding to a availability reasonnull
alarmsPathStringTruePath to the alarms for this OEE configurationnull
enablePerformanceBooleanFalseFlag to enable or disable OEE performance calculationstrue
productionCountUnitOfMeasureIdStringFalseIdentifier for the unit of measure used in production and quality countsnull
productionCountUnitOfMeasureNameStringTrueName for the unit of measure used in production and quality countsnull
productionCountUnitOfMeasureSymbolStringTrueSymbol for the unit of measure used in production and quality countsnull
productionCountExpressionStringTrueIgnition expression used to calculate the machine's production countnull
productionCountCalcTypeCountCalcTypeFalseCalculation type for the production countDELTA
productionCountOverflowValueDoubleTrueOverflow value used for production count calculationsnull
standardRateSourceOeeTargetSourceFalseSource for determining the standard rate of productionSTATIC
standardRateDoubleTrueStandard rate of production for this configuration per second0.0
standardRateExpressionStringTrueIgnition expression used to provide the standard production ratenull
productionRateTimeUnitsTimeUnitFalseUnit of measure for the machine production rate & standard rateMINUTES
enableQualityBooleanFalseFlag to enable or disable OEE quality calculationstrue
qualityCountCalcTypeCountCalcTypeFalseCalculation type for the quality countDELTA
qualityStrategyOeeQualityStrategyFalseQuality Strategy for this OEE ConfigurationWASTE_COUNT
qualityCountExpressionStringTrueIgnition expression used to determine the quality count for productionnull
qualityCountOverflowValueDoubleTrueOverflow value used for quality count calculationsnull
productionOrderSourceOeeProductionOrderSourceFalseSource for the production order resolutionNONE
productionOrderExpressionStringTrueExpression to provide the production order (id or name) for the current oee production recordnull
notesStringTrueNotes associated with the confignull
enabledbooleanTrueIndicates whether the config is enabledtrue
spare1StringTrueExtra field 1null
spare2StringTrueExtra field 2null
spare3StringTrueExtra field 3null

OeeDowntimeByReasonDTO

NameTypeNullableDescriptionDefault Value
availabilityReasonPathStringTruePath of the availability reasonnull
durationDoubleTrueDuration of downtime for this reason0.0
countLongTrueCount of downtime events for this reasonnull
durationPercentDoubleTruePercentage of total duration for this reason0.0
countPercentDoubleTruePercentage of total count for this reason0.0

OeeAvailabilityReasonDTO

NameTypeNullableDescriptionDefault Value
idStringTrueThe id of the Availability Reasonnull
locationIdStringTrueIdentifier of the associated location where this availability reason appliesnull
locationPathStringTruePath of the associated location where this availability reason appliesnull
parentIdStringTrueIdentifier of the parent availability reason, if applicablenull
codeIntegerFalseUnique fault code associated with this availability reason0
nameStringFalseName of the availability reasonnull
descriptionStringTrueDescription of the availability reasonnull
pathStringTruePath representation of the availability reason within a hierarchical structurenull
notesStringTrueNotes associated with the Availability Reasonnull
enabledbooleanTrueIndicates whether the Availability Reason is enabledtrue
spare1StringTrueExtra field 1null
spare2StringTrueExtra field 2null
spare3StringTrueExtra field 3null

OeeAvailabilityReasonHierarchicalDTO

NameTypeNullableDescriptionDefault Value
idStringTrueThe id of the Availability Reasonnull
locationIdStringTrueIdentifier of the associated location (inherited from OeeAvailabilityReasonDTO)null
locationPathStringTruePath of the associated location (inherited from OeeAvailabilityReasonDTO)null
parentIdStringTrueIdentifier of the parent availability reason (inherited from OeeAvailabilityReasonDTO)null
codeIntegerFalseUnique fault code associated with this availability reason (inherited from OeeAvailabilityReasonDTO)0
nameStringFalseName of the availability reason (inherited from OeeAvailabilityReasonDTO)null
descriptionStringTrueDescription of the availability reason (inherited from OeeAvailabilityReasonDTO)null
pathStringTruePath representation of the availability reason (inherited from OeeAvailabilityReasonDTO)null
childrenList<OeeAvailabilityReasonHierarchicalDTO>TrueList of child availability reasonsnull
notesStringTrueNotes associated with the Availability Reasonnull
enabledbooleanTrueIndicates whether the Availability Reason is enabledtrue
spare1StringTrueExtra fieldnull
spare2StringTrueExtra fieldnull
spare3StringTrueExtra fieldnull

OeeAvailabilityReasonTreePerspectiveDTO

NameTypeNullableDescriptionDefault Value
idStringTrueThe id of the Availability Reasonnull
titleStringFalseThe title of the Availability Reasonnull
typeStringTrueThe type of the Availability Reason"availabilityReason"
locationIdStringTrueThe unique identifier of the locationnull
childrenList<OeeAvailabilityReasonTreePerspectiveDTO>TrueList of children of the Availability Reasonnull
notesStringTrueNotes associated with the Availability Reasonnull
enabledbooleanTrueIndicates whether the Availability Reason is enabledtrue
spare1StringTrueExtra fieldnull
spare2StringTrueExtra fieldnull
spare3StringTrueExtra fieldnull

OeeDowntimeStatisticsDTO

NameTypeNullableDescriptionDefault Value
locationIdStringFalseIdentifier of the associated location where this OEE production record was capturednull
locationPathStringTruePath of the location where this OEE production record was capturednull
startDateInstantFalseStart date and time of the OEE production recordInstant.now()
endDateInstantTrueEnd date and time of the OEE production recordnull
totalDurationSecDoubleFalseTotal duration of the OEE production record in seconds0.0
downtimeTotalDurationSecDoubleFalseTotal downtime duration of the OEE production record in seconds0.0
downtimeEventAverageDurationSecDoubleFalseAverage Duration in seconds for downtime events on the machine0.0
downtimeEventCountIntegerFalseDowntime Event Count during this record period0
downtimePercentDoubleFalsePercent of time of the total duration that the machine was in downtime state0.0
meanTimeBetweenFailuresSecDoubleFalseThe Mean Time Between Failures (MTBF) in seconds0.0
meanTimeToRepairSecDoubleFalseThe Mean Time To Repair (MTTR) in seconds0.0
starvedTotalDurationSecDoubleFalseTotal starved duration of the OEE production record in seconds0.0
starvedEventAverageDurationSecDoubleFalseAverage Duration in seconds for starved events on the machine0.0
starvedEventCountIntegerFalseStarved Event Count during this record period0
starvedPercentDoubleFalsePercent of time of the total duration that the machine was in starved state0.0
blockedTotalDurationSecDoubleFalseTotal blocked duration of the OEE production record in seconds0.0
blockedEventAverageDurationSecDoubleFalseAverage Duration in seconds for blocked events on the machine0.0
blockedEventCountIntegerFalseBlocked Event Count during this record period0
blockedPercentDoubleFalsePercent of time of the total duration that the machine was in blocked state0.0

OeeModeDTO

NameTypeNullableDescriptionDefault Value
idStringTrueThe id of the OEE Modenull
locationIdStringFalseIdentifier of the associated locationnull
locationPathStringTruePath to the associated locationnull
codeIntegerFalseInteger value representing the modenull
nameStringFalseName of the modenull
calculationTypeOeeModeCalculationTypeFalseSpecifies how this mode should be factored into OEE calculationsSCHEDULED_PRODUCTION
expectedDurationSourceOeeModeExpectedDurationSourceFalseDefines the source used to determine the expected duration of a scheduled downtime eventSTATIC
expectedDurationExpressionStringTrueIgnition expression to dynamically calculate the expected duration of the mode in secondsnull
expectedDurationDoubleTrueExpected duration of the mode in seconds0.0
colorStringFalseHex color code representing the mode visually"#000000"
notesStringTrueNotes associated with the OEE Modenull
enabledbooleanTrueIndicates whether the OEE Mode is enabledtrue
spare1StringTrueExtra field 1null
spare2StringTrueExtra field 2null
spare3StringTrueExtra field 3null

OeeModeRecordDTO

NameTypeNullableDescriptionDefault Value
idStringTrueThe id of the OEE Mode Recordnull
locationIdStringFalseIdentifier of the associated location where this mode was recordednull
locationNameStringTrueName of the associated locationnull
locationPathStringTruePath of the associated location where this mode was recordednull
codeIntegerFalseInteger mode numbernull
statusStatusFalseStatus of the OEE production record (running, faulted, cancelled, complete etc.)UNKNOWN
startDateInstantFalseStart date and time of the mode recordInstant.now()
endDateInstantTrueEnd date and time of the mode recordnull
durationDoubleFalseTotal duration of the mode record in seconds0.0
overrunDurationSecDoubleFalseDuration in seconds that the machine has overrun its scheduled downtime0.0
nameStringFalseName of the modenull
calculationTypeOeeModeCalculationTypeFalseSpecifies how this mode should be factored into OEE calculationsSCHEDULED_PRODUCTION
colorStringFalseHex color code representing the mode visually"#000000"
expectedDurationSourceOeeModeExpectedDurationSourceFalseSource to calculate the expected duration of an scheduled downtime eventSTATIC
expectedDurationExpressionStringTrueExpression to calculate the expected duration of the mode in secondsnull
expectedDurationDoubleTrueExpected duration of the mode in seconds0.0
notesStringTrueNotes associated with the OEE Mode Recordnull
enabledbooleanTrueIndicates whether the OEE Mode Record is enabledtrue
spare1StringTrueExtra field 1null
spare2StringTrueExtra field 2null
spare3StringTrueExtra field 3null

OeeModeRecordsGroupedByModeDTO

NameTypeNullableDescriptionDefault Value
locationIdStringTrueIdentifier of the associated location where this mode was recordednull
codeIntegerTrueThe integer code associated with the Modenull
nameStringTrueThe name of the mode, such as "Production", "Scheduled Downtime", etc.null
colorStringTrueThe color code for displaying this modenull
durationDoubleTrueThe total aggregated duration of this mode in secondsnull
countLongTrueThe number of occurrences of this modenull

OeeProductionRecordDTO

NameTypeNullableDescriptionDefault Value
idStringTrueThe id of the OEE Production Recordnull
locationIdStringFalseIdentifier of the associated location where this OEE production record was capturednull
locationPathStringTruePath of the location where this OEE production record was capturednull
statusStatusFalseStatus of the OEE production record (e.g., running, faulted, canceled, complete)UNKNOWN
startDateInstantFalseStart date and time of the OEE production recordInstant.now()
endDateInstantTrueEnd date and time of the OEE production recordnull
totalDurationSecDoubleFalseTotal duration of the OEE production record in seconds0.0
scheduledDurationSecDoubleFalseDuration in seconds that the machine was scheduled to run during this record period0.0
runningDurationSecDoubleFalseDuration in seconds that the machine was actively running during this record period0.0
productionCountDoubleFalseTotal number of units produced during this record period0.0
expectedProductionCountDoubleFalseExpected number of units to be produced during this record period0.0
qualityStrategyOeeQualityStrategyFalseQuality Strategy for this OEE Production RecordWASTE_COUNT
qualityCountDoubleFalseTotal number of quality units recorded during this period0.0
productionCountUnitOfMeasureIdStringTrueIdentifier of the unit of measure for the production countnull
productionCountUnitOfMeasureNameStringTrueName of the unit of measure for the production countnull
productionCountUnitOfMeasureSymbolStringTrueSymbol of the unit of measure for the production countnull
productionRateTimeUnitsTimeUnitFalseUnit of measure for the machine production rate & standard rateMINUTES
modeRecordIdStringTrueIdentifier of the associated mode recordnull
modeCodeIntegerTrueCode of the associated mode recordnull
standardRateDoubleTrueThe standard rate for this record0.0
productionOrderIdStringTrueThe Id of the production order associated with this OEE production recordnull
productionOrderNameStringTrueThe name of the production order associated with this OEE production recordnull
notesStringTrueNotes associated with the OEE Production Recordnull
enabledbooleanTrueIndicates whether the OEE Production Record is enabledtrue
spare1StringTrueExtra field 1null
spare2StringTrueExtra field 2null
spare3StringTrueExtra field 3null

OeeResultsDTO

NameTypeNullableDescriptionDefault Value
locationIdStringFalseIdentifier of the associated location where this OEE production record was capturednull
locationPathStringTruePath of the location where this OEE production record was capturednull
startDateInstantFalseStart date and time of the OEE production recordInstant.now()
endDateInstantTrueEnd date and time of the OEE production recordnull
totalDurationSecDoubleFalseTotal duration of the OEE production record in seconds0.0
scheduledDurationSecDoubleFalseDuration in seconds that the machine was scheduled to run during this record period0.0
runningDurationSecDoubleFalseDuration in seconds that the machine was actively running during this record period0.0
productionCountDoubleFalseTotal number of units produced during this record period0.0
expectedProductionCountDoubleFalseExpected number of units to be produced during this record period0.0
averageStandardRateDoubleFalseAverage Standard Rate for the time period. Calculated as per minute0.0
maximumStandardRateDoubleFalseMaximum Standard Rate for the time period. Calculated as per minute0.0
wasteCountDoubleFalseTotal number of waste units recorded during this period0.0
goodCountDoubleFalseTotal number of good units recorded during this period0.0
productionCountUnitOfMeasureIdStringTrueIdentifier of the unit of measure for the production countnull
productionCountUnitOfMeasureNameStringTrueName of the unit of measure for the production countnull
productionCountUnitOfMeasureSymbolStringTrueSymbol of the unit of measure for the production countnull
availabilityDoubleTrueAvailability metric (0.0 to 1.0)1.0
performanceDoubleTruePerformance metric (0.0 to 1.0)1.0
qualityDoubleTrueQuality metric (0.0 to 1.0)1.0
oeeDoubleTrueOverall Equipment Effectiveness (OEE) metric (0.0 to 1.0)1.0

OeeStateDTO

NameTypeNullableDescriptionDefault Value
idStringTrueThe id of the OEE Statenull
locationIdStringFalseIdentifier of the associated locationnull
locationPathStringTruePath of the associated locationnull
codeIntegerFalseInteger state number, which must be unique for a given locationnull
nameStringFalseName of the statenull
calculationTypeOeeStateCalculationTypeFalseSpecifies how this state contributes to OEE calculationsDOWNTIME
colorStringFalseHex color code representing the state visually"#000000"
autoAcknowledgeBooleanFalseWhether to automatically acknowledge the state record when it is createdfalse
interruptionLocationIdStringTrueImmediate interruption location that caused a blocked/starved statenull
interruptionLocationPathStringTruePath to the location that caused a blocked/starved statenull
notesStringTrueNotes associated with the OEE Statenull
enabledbooleanTrueIndicates whether the OEE State is enabledtrue
spare1StringTrueExtra field 1null
spare2StringTrueExtra field 2null
spare3StringTrueExtra field 3null

OeeStateRecordDTO

NameTypeNullableDescriptionDefault Value
idStringTrueThe id of the OEE State Recordnull
codeIntegerFalseInteger state numbernull
locationIdStringFalseIdentifier of the associated location where this state record was recordednull
locationNameStringTrueName of the associated locationnull
locationPathStringTruePath of the location where this state record was recordednull
nameStringFalseName of the recorded statenull
calculationTypeOeeStateCalculationTypeFalseSpecifies how this state contributes to OEE calculationsDOWNTIME
colorStringFalseHex color code representing the state visually"#000000"
statusStatusFalseStatus of the OEE production record (e.g., running, faulted, canceled, complete)UNKNOWN
startDateInstantFalseStart date and time of the state recordInstant.now()
endDateInstantTrueEnd date and time of the state recordnull
durationDoubleFalseDuration of the state record in seconds0.0
availabilityReasonIdStringTrueIdentifier of the associated availability reason, if applicablenull
availabilityReasonStringTrueTitle of the availability reason. (Name - Code) For display purposes onlynull
availabilityReasonPathStringTruePath to the current availability reasonnull
interruptionLocationIdStringTrueLocation id that caused the blocked/starved state on the machinenull
interruptionLocationNameStringTrueName of the interruption location that caused the blocked/starved statenull
interruptionLocationPathStringTrueLocation path that caused the blocked/starved state on the machinenull
acknowledgedBooleanFalseBoolean indicating whether the state record has been acknowledgedfalse
acknowledgedByStringTrueAcknowledged By. This is the user who acknowledged the state recordnull
acknowledgedDateInstantTrueAcknowledged Date. This is the date when the state record was acknowledgednull
notesStringTrueNotes associated with the OEE State Recordnull
enabledbooleanTrueIndicates whether the OEE State Record is enabledtrue
spare1StringTrueExtra field 1null
spare2StringTrueExtra field 2null
spare3StringTrueExtra field 3null

OeeStateRecordsGroupedByStateDTO

NameTypeNullableDescriptionDefault Value
locationIdStringTrueIdentifier of the associated locationnull
codeIntegerTrueThe integer code associated with the Statenull
nameStringTrueThe name of the state, such as "Downtime", "Running", etc.null
colorStringTrueThe color code for displaying this statenull
durationDoubleTrueThe total aggregated duration of this state in secondsnull
countLongTrueThe number of occurrences of this statenull

Returns

If successful, an ApiResponse Object is returned with the success bool set True. If unsuccessful, an IllegalArgumentException or ConstraintViolationException is thrown. If the oee config that's being deleted has a reference, an ApiResponse Object is returned with details about the encountered error.

NameTypeDescription
successBooleanIndicates if the delete was successful.
messageStringThe reason why the deletion was successful or unsuccessful.
dataStringThe data associated with the deletion.
errorStringThe errors associated with the deletion.

Code Examples

# Delete an oee config by ID
system.mes.oee.deleteConfig('01JCH3ENEB-SV2X8B3W-NFY8WZNK')