Cancel Move Time-Triggered Transaction

This time-triggered transaction is used to cancel move request. Move request cancellation can happen either in offline or online mode, depending on the values set for the variable yfs.cancelmove.offline.taskcount.greaterthan defined in yfs.properties_wms_ext.in. Move request cancellation happens in the offline mode, if the number of move request tasks to be cancelled is greater than the value of the variable. Otherwise, cancellation happens in the online mode.

If cancellation happens in the offline mode, the status of the move request changes to Cancellation Requested and on successful cancellation, the status changes to Closed. If the cancellation fails due to some reason, the status changes to Cancellation Failed.

Attributes

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

Table 1. Cancel Move Attributes
Attribute Value
Transaction Name Request Move Cancellation
Transaction ID CANCEL_MOVE_REQUEST
Base Document Type Move Request Execution
Base Process Type Move Request Execution
Abstract Transaction None
APIs Called cancelTask()
User Exits Called None

Criteria Parameters

The following are the criteria parameters for this transaction:

Table 2. Cancel Move 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 Move Transaction
Transaction/Event Key Data Data Published Template Support?
MOVE_CANCELLATION_REQUESTED WMS_cancelMoveRequest_input_dtd_txt WMS_CANCEL_MOVE_REQUEST.ON_SUCCESS.xml Yes
MOVE_CANCELLATION_FAILED None WMS_CANCELMOVE_REQUEST.MOVE _CANCELLATION_FAILED.xml Yes