Sepasoft MES Module Suite
Batch List Component Reference
Batch List is installed with the Batch Procedure module.
For user information, see Using Batch List.
Meta Property
Name | batchList |
Component Properties
| Property Name | Data Type | Description | ||
|---|---|---|---|---|
viewMode | Toggle | Remote/Local MES Enterprise Root Gateway Servers can run in Remote or Local mode. To see batch-queue entries on other gateway servers within an MES Enterprise Network, set to Remote. Site gateways in the MES Enterprise Gateway can only run in Local mode.
| ||
selectedBatchID | string | Batch ID entered in the Batch header information. Must be unique. | ||
equipmentFilter | string | Limits the entries to equipment under an equipment path. wildcard characters are valid '*' '?' | ||
enableCommandPalette | boolean | Adds command palette with icons for: "Start", 1 | "Pause", 2 | "Resume", 3 | "Hold", 4 | "Restart", 5 | "Stop", 6 | "Reset", 7 | "Abort", 8 For details about commands, states and lifecycle, see Batch Command-State Sequence. | ||
enableEditParams | boolean | Sets editing mode of recipe parameters when managing batch entries. | ||
enableEditUnitAssignments | boolean | Allows assigning batches to Units (within the Production Equipment Model) when editing or creating a batch entries. Units must have the same Unit Class assignment for the system to allocate automatically. As of 3.81.8 SP2: | ||
enableAdd | boolean | Adds the Plus icon for adding recipes in a view. | ||
enableEdit | boolean | Adds the Pencil icon for adding recipes in a view. | ||
enableDuplicate | boolean | Adds the Duplicate icon for adding recipes in a view. | ||
enablePagination | boolean | Used to add controls for pagination such as, how many rows to view on a page and arrows for navigation through the list of batches. | ||
recipeClassFilter | string | An array of Recipe Class filters. The wildcard * can be used for 0 or more of any character, the ? wildcard can be used for any single character. If no wild cards are used, the string must contain the text of one of the items in this array, case insensitive.
| ||
recipeStateFilter | string | An array of string values that represent a Recipe State. This filters which type of recipes can have a Batch Queue Entry created. Leave empty to allow all recipe types.
| ||
| user | string | Name of user recorded in the EBR if this component changes batch parameters. Bind to session properties. If blank, the logged user is used.
|
Core Property Reference for Command Buttons
This section provides a detailed reference for the six boolean properties that directly control the state of the primary command buttons located on the Batch List component's toolbar. Each property corresponds to a specific user action and can be bound to system logic to create a responsive and context-aware control interface.
|
Available in versions 3.81.11 SP10 and later. |
Property | Controlled UI Command | Functional Description and Use Case |
| enableCommandPalette | A boolean that adds command palette with icons for: "Start", 1 | "Pause", 2 | "Resume", 3 | "Hold", 4 | "Restart", 5 | "Stop", 6 | "Reset", 7 | "Abort", 8 For details about commands, states and lifecycle, see Batch Command-State Sequence. | |
enablePlay | Start | A boolean that controls if the Start command is enabled (true) or disabled (false). Use Case: Set to true only when a selected batch is in a state from which it can logically begin or resume execution (e.g., Idle, Paused, Held). |
enablePause | Pause | A boolean that controls if the Pause command is enabled (true) or disabled (false). Use Case: Set to true only when a selected batch is Running and the process logic allows for temporary suspension. |
enableStop | Stop | A boolean that controls if the Stop command is enabled (true) or disabled (false). Use Case: Set to true for any non-terminal state (e.g., Running, Paused, Held) where an orderly process termination is a valid action. |
enableHold | Hold | A boolean that controls if the Hold command is enabled (true) or disabled (false). Use Case: Set to true only when a batch is Running and the procedure defines a specific Hold state. |
enableAbort | Abort | A boolean that controls if the Abort command is enabled (true) or disabled (false). Use Case: Set to true during active states (e.g., Running, Paused, Held) to provide an immediate, unconditional termination option. |
enableReset | Reset | A boolean that controls if the Reset command is enabled (true) or disabled (false). Use Case: Set to true when a batch is in a terminal state (e.g., Completed, Stopped, Aborted) to return it to a pristine, idle condition. |
These properties serve as the foundational building blocks for creating a state-driven user interface, which is best achieved by correlating their values directly to the live state of a selected batch.
For user information, see Using Batch Controller.
Sepasoft MES Module Suite