system.mes.batch.queue.changeActiveStep

Sepasoft MES Module Suite

system.mes.batch.queue.changeActiveStep(batchQueueEntry, path, [changedBy])

Method on Ignition.mes.batch.queue for 3.81.12 RC3 and later.

Below:

Related Topics: <link to related component(s)>

Function Name

changeActiveStep(

batchQueueEntry: BatchQueueEntry

path: String

changedBy: String = None

)

Summary

This function changes the active execution of a step to a different valid step in the recipe. The batch must be actively running, the specified step's associated logic (e.g. Procedure, Unit Procedure, or Operation) must be in Manual mode, and the currently active step must be in a terminal state (e.g. idle, complete, aborted, or stopped).

Syntax

Copy Code

Python

changeActiveStep(    
	batchQueueEntry: BatchQueueEntry    
	path:        String    
	changedBy: String = None
)

Parameters

Parameter Type Required Description

Parameter	Type	Required	Description
batchQueueEntry	batch object	Yes	batchQueueEntry
path	String	Yes	The full path to the step which should be made an active step. The format of the path must follow the /Procedure/Unit_Procedure/Operation:Step pattern. The "{}" can be used in place of the Procedure. Example: /{}:Step, /{}/Unit_Procedure:Step, or /{}/Unit_Procedure/Operation:Step
changedBy	String	Optional	Optional string value to associate with the change. If not specified, "Script" will be used. Default: `None`

batchQueueEntry

batch object

Yes

batchQueueEntry

path

String

Yes

The full path to the step which should be made an active step. The format of the path must follow the /Procedure/Unit_Procedure/Operation:Step pattern. The "{}" can be used in place of the Procedure. Example: /{}:Step, /{}/Unit_Procedure:Step, or /{}/Unit_Procedure/Operation:Step

changedBy

String

Optional

Optional string value to associate with the change. If not specified, "Script" will be used.

Default: None

Returns

Type	Description
No return value.	No return value.

Example

Code

bq =

Result

Batch execution change. No return value.

Notes

Important behaviors, limitations, or rules.

Examples:

Case sensitive.
Null values return empty string.
Does not modify the original variable.

Common Errors

Error	Cause	Solution
Invalid parameter type	Parameter must be a string	Convert value before calling function

Related Functions

system.mes.batch.queue.getValidNextSteps(batchQueueEntry, [path])

system.mes.batch.queue.getActiveSteps(batchQueueEntry, [path])

Category Functions

Batch Queue, Execution functions.

Version

Active Step | Skip Step is available in 3.81.12 RC3 and later.

Permissions / Scope

If the function only works in certain contexts.

Sepasoft MES Module Suite