Request Batch Completion Time-Triggered Transaction

Request Batch Completion is a time-triggered transaction that completes a batch after completing its tasks.

The yfs.confirmbatch.online property in the yfs.properties_wms_ext.in file is used to set this time-triggered transaction to work in online or offline mode.

The mode of operation (online or offline) is decided on the basis of a property defined in the yfs.properties_wms_ext.in file:
yfs.confirmbatch.online = Y/N

The default out-of-the-box shipped property causes the Request Batch Completion transaction to run in online mode.

Note: In instances where the Request Batch Completion transaction is run in offline mode, ensure that all Agent Criteria defined for the transaction are configured properly.

Attributes

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

Table 1. Request Batch Completion Attributes
Attribute Value
Transaction Name Request Batch Completion
Transaction ID REQ_BATCH_COMPLETION
Base Document Type General
Base Process Type Task Execution
Abstract Transaction No
APIs Called registerBatchCompletion()
registerTaskCompletion()
User Exits Called None

Criteria Parameters

The following are the criteria parameters for this transaction:

Table 2. Request Batch Completion 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

The following statistics are tracked for this transaction:

Table 3. Request Batch Completion Statistics
Statistic Name Description
NumberOfBatchesCompleted Number of batches completed.
NumberOfTasksCompleted Number of tasks completed.

Pending Job Count

For this transaction the pending job count is the number of batches and their tasks that can be completed.

Events Raised

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

Table 4. Events Raised by the Request Batch Completion Transaction
Transaction/Event Key Data Data Published Template Support?
BATCH_COMPLETION_REQUESTED batch_dbd.txt YCP_REQ_BATCH_COMPLETION.BATCH_COMPLETION_REQUESTED.xml Yes