system.mes.oee.validateState

Description

Validates an OEE State object against the system's business rules without saving it. This is useful for checking if a state is valid before attempting to save it.

Permissions

This method requires the OEE.READ.VALIDATE permission.

Syntax

system.mes.oee.validateState(**stateData)

Parameters

An unpacked dictionary of OeeStateDTO fields.

Parameter	Type	Nullable	Description	Default Value
id	String	True	The id of the OEE State	null
locationId	String	False	Identifier of the associated location	null
locationPath	String	True	Path of the associated location	null
code	Integer	False	Integer state number, which must be unique for a given location	null
name	String	False	Name of the state	null
calculationType	OeeStateCalculationType	False	Specifies how this state contributes to OEE calculations	DOWNTIME
color	String	False	Hex color code representing the state visually	"#000000"
autoAcknowledge	Boolean	False	Whether to automatically acknowledge the state record when it is created	false
interruptionLocationId	String	True	Immediate interruption location that caused a blocked/starved state	null
interruptionLocationPath	String	True	Path to the location that caused a blocked/starved state	null
maxRootCauseDelaySeconds	Integer	True	Maximum delay in seconds for looking back at historical state records when resolving root cause for blocked/starved states	0
notes	String	True	Notes associated with the OEE State	null
enabled	boolean	True	Indicates whether the OEE State is enabled	true
spare1	String	True	Extra field 1	null
spare2	String	True	Extra field 2	null
spare3	String	True	Extra field 3	null

Returns

A JSON object containing validation results. If the object is empty, validation passed. If it contains entries, the keys are the field names and the values are lists of validation error messages.

Code Examples

# Create a new OEE state object
newState = system.mes.oee.newOeeState()

# Set some attributes (leaving required fields blank to trigger validation errors)
newState['enabled'] = True

# Validate the state
validationErrors = system.mes.oee.validateState(**newState)

if not validation_errors:
    print "Validation passed. State is valid."
else:
    print "Validation failed. Errors:"
    for field, errors in validationErrors.items():
        print "  - {}: {}".format(field, ", ".join(errors))

# Example of a valid state
validState = system.mes.oee.newOeeState()
validState['locationId'] = 'some-location-id'
validState['name'] = 'Running'
validState['code'] = 1
validState['calculationType'] = 'RUNNING'
# ... other required fields ...

errors = system.mes.oee.validateState(**validState)
if not errors:
    print "\nThe second state is valid."