Cancel Wave Time-Triggered Transaction

This time-triggered transaction is used to cancel waves. Waves can be cancelled either in offline or online mode, depending on the values set for the yfs.cancelwave.offline.taskcount.greaterthan or yfs.cancelwave.offline.shipmentcount.greaterthan variables that are defined in the yfs.properties_wms_ext.in file. Waves are cancelled in the offline mode, if a wave is released and the number of wave tasks to be cancelled is greater than the value of the yfs.cancelwave.offline.taskcount.greaterthan variable, or the wave is yet to be released and the number of shipments included in the wave to cancel is greater than the value of the yfs.cancelwave.offline.shipmentcount.greaterthan variable. Otherwise, waves are cancelled in the online mode.

If waves are cancelled in offline mode, the status of the wave changes to Cancellation Requested (00) on cancel wave operation. On successful cancellation, the wave status changes to Cancelled. If the cancellation fails due to some reason, the status of the wave changes to Cancellation Failed (01).

Attributes

The following are the attributes for this time-triggered transaction:

Table 1. Cancel Wave Attributes
Attribute Value
Transaction Name Request Wave Cancellation
Transaction ID CANCEL_WAVE
Base Document Type Outbound Picking
Base Process Type Outbound Picking
Abstract Transaction None
APIs Called manageWave()
User Exits Called None

Criteria Parameters

The following are the criteria parameters for this transaction:

Table 2. Cancel Wave Criteria Parameters
Parameter Description
Action Required. Triggers the transaction. If left blank, it defaults to Get, the only valid value.
Number of Records To Buffer Optional. Number of records to retrieve and process at one time. If left blank or specified as 0 (zero), it defaults to 5000.
Node Required. The warehouse management ship node for which records are being processed.
AgentCriteriaGroup Optional. Used to classify nodes. This value can be accepted by WMS time-triggered transactions that only perform their tasks on the nodes with a matching node transactional velocity value.

Valid values are: LOW, HIGH, and any additional values defined by the Hub from Sterling Application Platform > System Administration > Agent Criteria Groups.

ColonyID Required in a multischema deployment where a table may exist in multiple schemas. Runs the agent for the colony.

Statistics Tracked

No statistics are tracked for this transaction.

Pending Job Count

No pending job counts are present for this transaction.

Events Raised

The following events are raised by this time-triggered transaction:

Table 3. Events Raised by the Cancel Wave Transaction
Transaction/Event Key Data Data Published Template Support?
WAVE_CANCELLATION_REQUESTED wave_dbd.txt WMS_MANAGE_WAVE.ON_SUCCESS.xml Yes
WAVE_CANCELLATION_FAILED wave_dbd.txt CANCEL_WAVE.WAVE_CANCELLATION_FAILED.xml Yes