system.mes.batch.queue.getActiveSteps

Sepasoft MES Module Suite

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

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

Below:

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

Function Name

getActiveSteps(

batchQueueEntry: BatchQueueEntry

path: 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

getActiveSteps(     
	batchQueueEntry: BatchQueueEntry
	path: String = None
	)

Parameters

Parameter Type Required Description

Parameter	Type	Required	Description
batchQueueEntry	batch object BatchQueueEntry	Yes	batchQueueEntry: The BatchQueueEntry object to get active steps for.
path	String	Optional	Optional full path to a logic item in the recipe. If not specified, active steps for all logic items in the recipe will be returned. The format of the path must follow the /Procedure/Unit_Procedure/Operation pattern. The "{}" can be used in place of the Procedure. Example: /{}, /{}/Unit_Procedure, or /{}/Unit_Procedure/Operation Default: `None`

batchQueueEntry

batch object BatchQueueEntry

Yes

batchQueueEntry: The BatchQueueEntry object to get active steps for.

path

String

Optional

Optional full path to a logic item in the recipe. If not specified, active steps for all logic items in the recipe will be returned. The format of the path must follow the /Procedure/Unit_Procedure/Operation pattern. The "{}" can be used in place of the Procedure. Example: /{}, /{}/Unit_Procedure, or /{}/Unit_Procedure/Operation

Default: None

Returns

Type	Description
	list of step paths to steps that are an "active step" in the execution logic.

Type

Description

list of step paths to steps that are an "active step" in the execution logic.

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.changeActiveStep(batchQueueEntry, path, [changedBy])

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