system.mes.batch.queue.getParameterValue(batchQueueEntry, path)

Sepasoft MES Module Suite

system.mes.batch.queue.getParameterValue(batchQueueEntry, batchId, path)

Returns a list of messages for Equipment Units associated with the specified batch. If an Equipment Unit filter is provided, returns messages for all batches executing on Equipment Units that match the filter.

Note

In version 3.81.12 SP2 and later:

  • Updated to not require a Batch to be running to get the value of a parameter.
    • For parameters that have a Calculation Expression, if the Batch is not active, the last calculated value will be returned, if present, otherwise the Calculation Expression is returned.

  • Can accept either a batchQueueEntry or a BatchID.

Syntax

getParameterValue(batchQueueEntry=None, batchID=None, path) 

Parameters

  • Exactly one required: batchQueueEntry | batchID
    • batchQueueEntry batchQueueEntry - The batchQueueEntry object to get a batch parameter from.

    • batchID

      batchID

      A batch ID is a unique identifier assigned to a batch within the Sepasoft MES (Manufacturing Execution System). It is used to reference and manage specific batches during their lifecycle in the batch queue. The batch ID is crucial for retrieving associated control recipes and logic objects, as well as for tracking the status and parameters of the batch.

      For example, in the function system.mes.batch.queue.getBatchObjects(batchID), the batch ID is passed as a parameter to retrieve the control recipe and logic objects associated with that specific batch.

  • String path - The path to the batch parameter.

    The path must follow the format:

    /Procedure/Unit Procedure/Operation:Transition.ParameterName

    Example:
    /Make Cookies/Mix/Add Flour.Amount Added 

Returns

The current batch parameter value with the datatype that it is configure for.

Scope

All



Sepasoft MES Module Suite