system.mes.operation.validateOperation

Description

Validates the specified parameters for an Operations record and returns any validation errors. This only checks if the operation object can be saved based on the attributes given, without actually creating or modifying the operation. Use this function to verify your parameters before executing save operation.

Permissions

This method requires the OPERATION.READ.VALIDATE permission.

Syntax

system.mes.operation.validateOperation(**operationData)

Parameters

Parameter	Type	Nullable	Description
locationId	String (ULID)	False	The ULID of the location associated with the operation.
locationPath	String	True	The path of the location associated with the operation.
name	String	False	The name of the operation.
status	String	True	The status of the operation. Default value is IDLE
currentOperationRecordId	String (ULID)	True	The ULID of the current operation record.
currentProductionOrderId	String (ULID)	True	The ULID of the current production order associated with the operation.
runningConflictStrategy	String	False	The conflict strategy when a new operation is started while another is running. Default value is STOP_PREVIOUS
triggerSource	String	False	The ways that the various operations can trigger. Default value is EXPRESSION
startTriggerExpression	String	True	The Ignition expression to trigger the start of the operation.
startTriggerType	String	False	The trigger type when starting the operation. Default value is RISING_EDGE
stopTriggerExpression	String	True	The Ignition expression to trigger the end of the operation.
stopTriggerType	String	False	The trigger type when stopping the operation. Default value is FALLING_EDGE
productionOrderResolutionStrategy	String	True	The resolution strategy to get the production order. Default value is NONE
productionOrderUpdateStrategy	String	True	The update strategy if the production order expression changes while the operation is active. Default value is KEEP_FIRST_GOOD_VALUE
productionOrderExpression	String	True	The Ignition expression of the production order associated with the operation.
updateProductionOrderStatusOnStart	Boolean	False	Indicates if the production order status should update when the operation starts. Default value is false
startProductionOrderStatus	String	True	The status of the production order when the operation starts. Default value is RUNNING
updateProductionOrderStatusOnStop	Boolean	False	Indicates if the production order status should update when the operation stops. Default value is false
stopProductionOrderStatus	String	True	The status of the production order when the operation stops. Default value is STOPPED
autoAddToSchedule	Boolean	False	Indicates if the operation should be automatically added to the schedule if it doesn't exist. Default value is true
expectedDurationCalculationStrategy	String	True	The resolution strategy to get the expected duration of the operation. Default value is STATIC
expectedDurationSeconds	Integer	True	The expected duration of the operation in seconds. Default value is 0
expectedDurationExpression	String	True	The Ignition expression of the expected duration of the operation.
flushIntervalMillis	Integer	True	The flush interval in milliseconds. Default value is 0
id	String (ULID)	True	The ULID of the operation (optional, used for updating an existing operation).
notes	String	True	Notes related to the operation.
enabled	Boolean	True	Indicates if the operation is active and enabled. Default value is true
spare1	String	True	Additional field for user-defined context.
spare2	String	True	Additional field for user-defined context.
spare3	String	True	Additional field for user-defined context.

Returns

Returns a JSON object where keys are field names and values are lists of validation violation messages.

Code Examples

# Generate the object structure for a new operation object
operationData = system.mes.operation.newOperation()

# Set basic attributes for the new operation
operationData['locationId'] = '01JD7M94CJ-HPEQEJ1F-QA8EQ6VE'
operationData['name'] = 'Packaging'
# (You can continue setting other properties as needed here)

# Validate operation parameters
validationErrors = system.mes.operation.validateOperation(**operationData)

if len(validationErrors) > 0:
    print('Validation errors found:', validationErrors)
else:
    print('Operation parameters are valid.')