KB | Resolving a Stalled Batch Command Loop
A batch process can become "stuck" when it enters this condition. The batch enters this "stuck" state because it is caught in a "setCommand loop," perpetually waiting for a child step or logic to be set to a specific State which never occurs.
Use the .exitCommandLoop to to resolve this specific issue without a system-wide interruption.
The exitCommandLoop Script Function
The system.mes.batch.queue.exitCommandLoop(batchQueueEntry, [path]) function is designed to programmatically resolve a stalled batch process. It provides a targeted method for intervention, eliminating the need for a disruptive system restart.
The core mechanism of this function is to force a "stuck" batch to exit its command loop. By terminating this waiting cycle, the script allows the batch to become "unstuck" and proceed to its expected final State. This simple yet powerful command provides a direct resolution to a complex process stall.
A Step-by-Step Resolution
The following steps provide a precise method for targeting and correcting a single stalled process without affecting any other running batches within the Production module. To resolve the issue, execute the following two steps in order:
- Retrieve the Batch Queue Entry First, you must retrieve the unique identifier for the specific batch that is stalled. This is accomplished by using the getEntry function with the batch ID as its argument. This action isolates the target for the subsequent command.
- Execute the Exit Command With the stalled batch queue entry assigned to the bqe variable, you can now execute the exitCommandLoop function. Pass the bqe variable as the argument to the function to terminate the stalled loop.
Python |
bqe = system.mes.batch.queue.getEntry("batchID") |
After executing these commands, the targeted batch will be released from its stalled condition. The script forces the process out of the waiting loop, allowing it to move to its expected final State.