BatchQueueEntry Object

Sepasoft MES Module Suite

BatchQueueEntry 

BatchQueueEntry holds the batch parameter values listed in the table below. The example uses a Batch scripting function to return BatchQueueEntry.

Scripting Functions

Returns the BatchQueueEntry Object:

    • system.mes.batch.queue.addEntry(masterRecipeLink, batchName, batchID, priority, scale, quantity, unitAssignments, batchParameters, processCellPath)

    • system.mes.batch.queue.changeEntryPriority(batchQueueEntry, newPriority)

    • system.mes.batch.queue.getEntry(batchID)

BatchQueueEntry is a parameter for:

    • system.mes.batch.queue.setParameterValue(batchQueueEntry, path, value)

Scripting examples:

BatchQueueEntry contains:

Returned in this order

Batch Name

The name entered in Batch Recipe Editor or created via script. 

Batch ID

The ID entered in Batch Execution or created via script.

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.

Priority

The priority as an integer entered when a new batch is created in Batch Execution or set via script.

Scale

The scale entered as a float number when a new batch is created in Batch Execution or set via script.

Quantity

The quantity entered when a new batch is created in Batch Execution or set via script.

State

The state of the batch within the batch run, see State Transition Diagram.

Object Functions

getBatchID()

Description

Gets the BatchID that is created when a batch is added to the batch queue.

Syntax

getBatchID()

  • Parameters

None

  • Returns

String

hasQuantity()

Description

Specifies if the batch has an entry in batch queue for Quantity.

Syntax

hasQuantity()

  • Parameters

  None

  • Returns

Boolean

Code Examples

Code Snippet

Copy Code
Code
#()

Code Snippet

Copy Code
Code
LOT

getRecipeName()

Description

Gets the name of the Batch Recipe that the batch is based on.

Syntax

getRecipeName()


  • Parameters

None

  • Returns

String  - The batch recipe name created in Recipe Editor and system.mes.batch.recipe.createRecipe().

Code Examples

Code Snippet

Copy Code
Code
#()

Output

Copy Code
Code
LOT
Copy Code
Code
>>> 
Kettle A
>>>

getPriority()

Description

Gets the priority for the batch in the batch queue.

Syntax

getPriority()


  • Parameters

-

  • Returns

Integer - 

Code Examples

Code Snippet

Copy Code
Code
#()

Output

Copy Code
Code
LOT

getBatchState()

Description

Gets the state of a batch within the batch lifecycle.

For information, see:

Syntax

getBatchState()


  • Parameters

   None

  • Returns

String 

Copy Code
Code
#()
Copy Code
Code
LOT

setUnit(String unitProcedureName, MESObjectLink unitLink)

Description

Sets

Syntax

setUnit(String unitProcedureName, MESObjectLink unitLink)


  • Parameters

unitProcedureName String

MESObjectLink

unitLink

  • Returns

No Return

getUnit(String unitProcedureName)

Description

Gets the unit for the Batch Queue Entry.

Syntax

getUnit(String unitProcedureName)


  • Parameters

   unitProcedureName String 

  • Returns

MESObjectLink to the Equipment Unit specified when the batch queue entry was made for a given Unit Procedure.

Code Examples

Code Snippet

Copy Code
Code
#()

Returns None when a Unit is not specified.

Code Snippet

Copy Code
Code
LOT

Returns the MESObjectLink when a Unit is specified.

Code Snippet

Copy Code
Code
>>> 
Kettle A
>>>

setBatchParameter(String paramName, Serializable value)

Description

Sets

Syntax

setBatchParameter(String paramName, Serializable value)

  • Parameters

paraName String

Serializable value

  • Returns

String mode Name - The name of the type of results to return.

Code Examples

Code Snippet

Copy Code
Code
#()

Output

Copy Code
Code
LOT

getBatchParameter(String paramName)

Description

Gets

Syntax

getBatchParameter(String paramName)


  • Parameters

paramName String

  • Returns

returns Serializable










Sepasoft MES Module Suite