system.mes.batch.queue.COMMAND

Sepasoft MES Module Suite

COMMAND_START Script Function

Returns the canonical string token for the batch Start command. Pass this value to executeEntryCommand, executeEntryCommandAsync, executeEntryCommandBlocking, or executeStepCommand instead of hard-coding command text so scripts stay aligned with the batch runtime’s command vocabulary. Start begins (or transitions toward running) batch execution according to the recipe and process cell state machine when the entry is in an allowed state.

Syntax

Copy Code

Python

system.mes.batch.queue.COMMAND_START()

Return Value

Type	Description
str	The command identifier "START" (the Java enum name for BatchCommandTypes.START).

Scope / Availability

Registered on the system.mes.batch.queue script module (Sepasoft Batch / MES).
Gateway: Available where the batch queue script module is hosted.
Designer / Client: Same API; behavior matches other system.mes.batch.queue.* calls (RPC to the gateway that owns the queue / batch, including Enterprise routing for queue operations).

Excluded / Edge Cases

This function only returns the command string; it does not change batch state. You must pass the result into a command API (for example executeEntryCommand) with a valid BatchQueueEntry (and step path for step-level commands).
Prefer COMMAND_START() over the literal "START" so scripts follow the supported constant pattern documented for command parameters.
Whether Start is accepted and how the batch behaves afterward depends on the running recipe, unit assignments, process cell logic, and current state—not on this helper alone.

Example Usage

Copy Code

Python

cmd = system.mes.batch.queue.COMMAND_START()

Complex Example

Copy Code

Python

entry = system.mes.batch.queue.getEntry("BATCH-2026-0042")
system.mes.batch.queue.executeEntryCommand(
	entry,
	system.mes.batch.queue.COMMAND_START(),
	changedBy="operatorScreen"
)

Related Functions

system.mes.batch.queue.executeEntryCommand(batchQueueEntry, command, ...) — Sends a batch-level command (non-blocking by default); use COMMAND_START() for the command argument.
system.mes.batch.queue.executeEntryCommandAsync(batchQueueEntry, command, ...) — Fires the command asynchronously.
system.mes.batch.queue.executeEntryCommandBlocking(batchQueueEntry, command, ...) — Waits until the command completes.
system.mes.batch.queue.executeStepCommand(batchQueueEntry, stepPath, command, ...) — Sends a command scoped to a recipe step; COMMAND_* constants apply here as well.
system.mes.batch.queue.COMMAND_STOP() / COMMAND_ABORT() / COMMAND_RESET() — Other lifecycle command tokens.
system.mes.batch.queue.COMMAND_PAUSE() / COMMAND_HOLD() / COMMAND_RESUME() — Suspend and resume–style command tokens.
system.mes.batch.queue.COMMAND_RESTART() — Restart command token when the recipe allows it.

Sepasoft MES Module Suite