Skip to content

Cancel Batch#

🔒 Batch.Cancel

Overview#

This operation is used to Cancel a given Batch.

Setup#

No specific setup is required other than to meet the precondition of the transaction.

Preconditions#

  • The Batch exists in the system and is Active.
  • If the Batch Load Mode is defined:
    • The Batch System State is Created or Released.
    • All Batch Materials must be in a Not Loaded state.
  • If the Batch Load Mode is not defined:
    • The Batch System State is Created or Queued.
    • All Batch Materials must be in a Loaded state.

Sequence of Steps#

  1. Choose a Batch matching the preconditions above, then select the Cancel button on the top ribbon.
  2. Optionally, enter a comment for the operation.
  3. Select Cancel Batch.

Screenshot showing a UI element related to cancelling a batch operation.

Info

Once a Batch is canceled, its System State will change to Canceled and its Universal State will change to Terminated.