Skip to main content
Version: V2 (Ignition 8.1)

system.mes.oee.splitOeeRecord

Description

Splits an OEE Record at a specified time. This action modifies the original record, shortening its duration, and creates a new record for the remaining time.

Permissions

This method requires the OEE.WRITE.SAVE permission.

Syntax

system.mes.oee.splitOeeRecord(oeeRecordId, splitDate)

Parameters

ParameterTypeNullableDescription
oeeRecordIdString (ULID)FalseThe ID of the OEE record to split.
splitDateDateFalseThe date at which to split the record.

Returns

Returns a JSON representation of the new OeeRecordDTO created from the split.

NameTypeNullableDescriptionDefault Value
idStringTrueThe id of the OEE Recordnull
locationIdStringFalseIdentifier of the associated locationnull
locationPathStringTruePath of the location where this OEE record was capturednull
locationNameStringTrueName of the associated locationnull
statusStatusFalseStatus of the OEE record (e.g., running, faulted, canceled, complete)UNKNOWN
startDateInstantFalseStart date and time of the OEE recordInstant.now()
endDateInstantTrueEnd date and time of the OEE recordnull
totalDurationSecDoubleFalseTotal duration of the OEE record in seconds0.0
productionCountDoubleFalseTotal number of units produced during this record period0.0
expectedProductionCountDoubleFalseExpected number of units to be produced during this record period0.0
qualityStrategyStringFalseQuality Strategy for this OEE RecordGOOD_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
productionRateTimeUnitsStringFalseUnit of measure for the machine production rate and standard rateMINUTES
stateRecordIdStringTrueIdentifier of the associated state recordnull
standardRateDoubleTrueThe standard rate for this record0.0
productionOrderIdStringTrueThe ID of the production order associated with this OEE recordnull
productionOrderNameStringTrueThe name of the production order associated with this OEE recordnull
notesStringTrueNotes associated with the OEE Recordnull
enabledbooleanTrueIndicates whether the OEE Record is enabledtrue
spare1StringTrueExtra field 1null
spare2StringTrueExtra field 2null
spare3StringTrueExtra field 3null

Code Examples

splitDate = "2025-09-05 14:58:30"
splitDate = system.date.parse(splitDate, "yyyy-MM-dd HH:mm:ss")

newRecord = system.mes.oee.splitOeeRecord(
'01JAP8RJBN-8ZTPXSGY-J9GSDPE1',
splitDate
)
print(newRecord)