batch.queue.MODE_MANUAL()

Sepasoft MES Module Suite

queue.MODE_MANUAL()

Overview

Returns the canonical string token for Manual batch logic run mode. Pass this value to setMode (and compare against mode-related recipe parameters) instead of hard-coding "Manual" so scripts stay aligned with the batch runtime’s mode vocabulary. Manual mode requires explicit operator or script actions—such as executeStep—to advance steps that support manual execution; automatic progression is suppressed for logic under that mode.

Syntax

Copy Code
Python
system.mes.batch.queue.MODE_MANUAL()

Return Value

Type

Description

String

The friendly run-mode name "Manual" (from BatchModeTypes.MANUAL). The gateway resolves modes with case-insensitive friendly-name matching.

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 where applicable).

Excluded / Edge Cases

  • This function only returns the mode string; it does not change batch state. Apply the value with setMode on a Procedure, Unit Procedure, or Operation path (not an individual step path).

  • setMode rejects unrecognized mode strings with IllegalArgumentException: Unable to set mode because specified mode is not recognized. Use MODE_MANUAL() rather than alternate spellings unless you intentionally match the friendly name.

  • Whether Manual mode can be set, and how it propagates to child or parent logic, depends on recipe configuration (for example Propagate Mode To Children / Propagate Mode To Parent) and whether the queue entry’s control logic is active.

  • Manual mode is a prerequisite for some operator and script actions (for example executeStep on equipment phases, and changeActiveStep when the parent logic must be in manual mode). Other phase types and recipe permissions still apply.

Example Usage

Minimal example

Copy Code
Python
mode = system.mes.batch.queue.MODE_MANUAL()

Complex example

Set manual mode at the procedure root, then manually execute a step after the batch is running:

Copy Code
Python
batchId = "BATCH-2026-0042"
entry = system.mes.batch.queue.getEntry(batchId)

system.mes.batch.queue.executeEntryCommand(
    entry,
    system.mes.batch.queue.COMMAND_START(),
    changedBy="batchScript"
)

system.mes.batch.queue.setMode(
    entry,
    system.mes.batch.queue.MODE_MANUAL(),
    path="/{}/Mix_UP/Mix_Op",
    changedBy="batchScript"
)

system.mes.batch.queue.executeStep(
    entry,
    "/{}/Mix_UP/Mix_Op:Weigh_Add",
    "batchScript"
)

Related Functions


Sepasoft MES Module Suite