Batch Controller Component

Sepasoft MES Module Suite

Batch Controller Component Reference

Find this component under the Perspective Component Palette, named Batch Controller.

For user information, see Using Batch Controller.

Properties

Meta Property

Name batchController

Component Properties

Property Name
Data Type
Description
batchID binding

Read-only. Input value from a component, such as Batch Execution.

Batch Procedure Components in a Single Perspective View

itemPath string

Read-only. Output value to a component, such as Document Viewer.

enableBatchCommand Boolean

Shows or hides the controls for actions on the batch as a whole.

enableStepCommand Boolean

Allows the operator to send commands for the currently active step.

enableAcknowledgeMessages Boolean Allows the acknowledgement of user message based on Ignition user roles.
enableModeChange Boolean

Allows the operator to change the mode (automatic, semi-automatic, manual)

enableSkipTransition Boolean

Allows the operator to skip transitions.

enableManualStepCompletion Boolean

Allows the operator to complete steps (Unit Procedure, Operation, Phase) in a recipe.

enableManualExecution Boolean

Allows the operator to manually start steps (Unit Procedure, Operation, Phase) in a recipe.

enableSyncStepState Boolean

Use this property to display a button to sync the state to the command when a phase is in PLI mode.

When set to True, the Sync State button displays within the recipe procedure at the appropriate step element when relevant based on the phase and mode. When set to False the button is hidden.

First released in:

Warning

MES 3.81.8 SP3 -  Stable Release

  • START - sets the state to RUNNING
  • STOP - sets the state to STOPPED
  • PAUSE - sets the state to PAUSED
  • HOLD - sets the state to HELD
  • ABORT - sets the state to ABORTED
  • RESET - sets the state to IDLE
  • RESTART - sets the state to RUNNING
  • RESUME - sets the state to RUNNING
  • NONE and state = RUNNING - sets state to COMPLETE
  • NONE and state != RUNNING - sets state to IDLE
showAllMessages Boolean

Displays user messages in the view.

showParameters Boolean

Displays the parameters for a selected step (Unit Procedure, Operation, Phase).

showMessages Boolean

Displays equipment messages.

showTransitionStatus Boolean

Displays a Transition status as defined in the stateStyles, see below

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.

Warning Available in versions 3.81.11 RC1 and later.

Binding

You can bind the property named batchID to Batch Procedure components, such as Batch Controller to filter active batches. See the property table above for more information.

Scripting

For script functions for Batch Controller actions, see system.mes.batch.queue.





Sepasoft MES Module Suite