system.mes.batch.queue.addEntry(...)

Using the addEntry Scripting Function

These scripting examples detail how to programmatically create and manage batch entries within a Manufacturing Execution System (MES), a critical capability for modern production environments. The strategic importance of this function lies in its ability to automate production scheduling and enable seamless integration with external systems, such as an Enterprise Resource Planning (ERP) platform. By leveraging this function, organizations can achieve centralized control over distributed manufacturing operations, ensuring data consistency and process integrity. To effectively use this function, it is essential to first understand the foundational equipment model concepts that inform the function's parameters.

Foundational Concepts: The ISA88 Equipment Model

A clear understanding of the physical equipment model is essential for correctly targeting batch operations. The MES Batch Procedure module is designed to be compliant with the ISA88 standard, providing a structured and hierarchical representation of production assets. This model ensures that scripts can reliably and unambiguously direct batch jobs to the correct physical equipment on the plant floor.

Process Cell

A Process Cell is a logical grouping that represents all the physical equipment required for a complete production line. This can encompass various manufacturing types, including continuous processes, converting lines, discrete manufacturing, or packaging lines. It serves as the primary container for a set of related production activities.

Unit

A Unit represents a specific piece of equipment where a batch control operation is executed. During batch execution-time, there is a strict one-to-one relationship between a Unit Procedure (a step in a recipe) and a physical Unit. A Unit is allocated to a Unit Procedure when the Unit Procedure step becomes active in the recipe, linking the procedural logic to the physical asset that will perform the work.

Equipment Hierarchy

The equipment model follows a clear hierarchical path structure, which is used to uniquely identify any asset within the enterprise. This path is fundamental for targeting batch operations correctly.

Enterprise > Site > Area > Process Cell > Unit

With these core concepts established, we can now examine the detailed syntax and parameters of the system.mes.batch.queue.addEntry() function itself.

Function Deep Dive: system.mes.batch.queue.addEntry()

The system.mes.batch.queue.addEntry() function is the primary scripting command for creating new batch entries in the MES queue. It provides a powerful interface for automating the initiation of production runs with precise control over recipe selection, quantity, and equipment allocation. This section deconstructs its syntax and defines its most critical parameters.

Function:

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

Key Parameter Definitions for these examples:

masterRecipeLink: The link to the master recipe that this batch will execute.

batchName: The unique name for the batch entry. 

batchID: The unique identifier for the batch entry. 

priority: The priority of the batch in the queue. 

scale: The scale for the batch execution. 

quantity: The quantity for the batch execution.

unitAssignments: A dictionary used to explicitly allocate a specific Equipment Unit to a procedure within the recipe (e.g., {'P2': unitPath}). 

processCellPath: The explicit equipment path to the Process Cell that should run the batch.

The system uses these parameters to construct and place the batch job. The processCellPath, in particular, is a key argument that directly influences the system's logic for determining where the batch should be executed, as detailed in the following section.

Core Operational Logic and Process Cell Targeting

The system employs a sophisticated logic to determine the correct Process Cell for a new batch entry. This logic is crucial for ensuring that batches are executed on the intended equipment, especially in a distributed environment with multiple sites or production lines. The behavior is primarily driven by the processCellPath parameter and the context from which the function is called.

Conditional Behavior (from Enterprise Level)

When the system.mes.batch.queue.addEntry() function is called from the Enterprise level, its behavior changes based on whether the processCellPath is provided.

• When processCellPath IS provided:

  • The Batch Queue Entry is created directly on the target Site gateway. It is then synchronized up to the Enterprise for centralized visibility.

• When processCellPath IS NOT provided:

  • Scenario 1: If the Enterprise itself has a configured Process Cell, the system assumes the Enterprise can execute the batch. The entry is created at the Enterprise level and will not sync down to a Site.

  • Scenario 2: If the Enterprise does not have its own Process Cell, the entry automatically syncs down to the Site that is capable of executing the associated recipe.

The four targeting methods detailed below are the mechanisms the system uses to determine the Process Cell, which in turn dictates which of the conditional Enterprise-level synchronization behaviors is triggered.

Methods for Targeting a Process Cell

There are four primary methods the system can use to identify the target Process Cell for a new batch:

1. Direct Specification: Providing the explicit equipment path in the processCellPath argument. This is the most direct and unambiguous method.

2. Unit Derivation: Deriving the Process Cell from the parent of a Unit specified in the unitAssignments argument.

3. Automatic (Single Cell): In a simple configuration with only one Process Cell, the system will automatically select it without requiring an explicit path.

4. Unit Class Derivation: Deriving the Process Cell from the parent of a Unit that is assigned to the Unit Class specified within the recipe's Unit Procedure.

The following section provides practical code examples to demonstrate how this logic is applied in common implementation scenarios.

Practical Implementation: Code Examples

This section presents three practical, scripted examples that demonstrate how to add batch queue entries in different common scenarios. These examples range from a simple, single-cell setup to more complex configurations involving explicit equipment allocation, illustrating the flexibility of the system.mes.batch.queue.addEntry() function.

Example 1: Implicit Process Cell in a Single-Cell Environment

Scenario: In a simple site-level configuration with only one Process Cell, the processCellPath parameter is not required. The system can automatically infer and assign the batch to the correct queue. This automatic assignment is based on the Unit Procedure configuration within the batch recipe, where a Unit Class is selected, which in turn links to the site's available Equipment Units.

#Getting required params and objects
bid = 'batch123'
recipeClassName = 'Test'
recipeName = 'ConsumeMaterialLot'
recClassLink = system.mes.getMESObjectLinkByName('BatchMasterRecipeClass', recipeClassName)
masterRecipeLink = system.mes.batch.recipe.getRecipeLink(recipeName, recClassLink)

system.mes.batch.queue.addEntry(masterRecipeLink=masterRecipeLink,
                                 batchName=bid,
                                 batchID=bid,
                                 priority=1.0,
                                 scale=1.0,
                                 quantity=1.0)

Outcome Analysis: After execution, the batch entry is added to the batch queue of the target Process Cell. The system targets the cell implicitly using the "Automatic (Single Cell)" or "Unit Class Derivation" method.

#Getting required params and objects
bid = 'batch123'
recipeClassName = 'Test'
recipeName = 'ConsumeMaterialLot'
recClassLink = system.mes.getMESObjectLinkByName('BatchMasterRecipeClass', recipeClassName)
masterRecipeLink = system.mes.batch.recipe.getRecipeLink(recipeName, recClassLink)
processCellPath = 'New Enterprise\New Site\New Area\New Process Cell'

system.mes.batch.queue.addEntry(masterRecipeLink=masterRecipeLink,
                                 batchName=bid,
                                 batchID=bid,
                                 priority=1,
                                 scale=1.0,
                                 quantity=1.0,
                                 processCellPath=processCellPath)

#Getting required params and objects
bid = 'batch123'
recipeClassName = 'Test'
recipeName = 'ConsumeMaterialLot'
recClassLink = system.mes.getMESObjectLinkByName('BatchMasterRecipeClass', recipeClassName)
masterRecipeLink = system.mes.batch.recipe.getRecipeLink(recipeName, recClassLink)
unitPath = 'New Enterprise\New Site\New Area\New Process Cell\Unit 5'

system.mes.batch.queue.addEntry(masterRecipeLink=masterRecipeLink,
                                 batchName=bid,
                                 batchID=bid,
                                 priority=1,
                                 scale=1.0,
                                 quantity=1.0,
                                 unitAssignments={'P2':unitPath})