Close receipts

This time-triggered transaction closes receipts using the receiving rule specified.

Attributes

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

Table 1. Close receipts attributes
Attribute Value
Base Transaction ID RECEIPT_COMPLETE
Base Document Type Order
Base Process Type Receipt (Purchase Order Receipt, Return Receipt, Transfer Order Receipt, Receipt)
Abstract Transaction No
APIs Called None
User Exits Called None

Criteria parameters

The following are the criteria parameters for this transaction:

Table 2. Close receipts criteria parameters
Parameter Description
Action Triggers the transaction. If left blank, it defaults to Get, the only valid value.
Number of Records To Buffer Number of records to retrieve and process at one time. If left blank or specified as 0 (zero), it defaults to 5000.
EnterpriseCode Enterprise for which the Close Receipts needs to be run. If not passed, then all enterprises are monitored.
Node Node for which the Close Receipts needs to be run.
Note: Both Node and AgentCriteriaGroup cannot be blank. You must specify a value for the Node parameter, the AgentCriteriaGroup parameter, or both parameters.
AgentCriteriaGroup Used to classify nodes. This value can be accepted by Sterling™ Order Management System Software 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 Application Platform > System Administration > Agent Criteria Groups.
ColonyID Required in a sharded 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. Close receipts statistics
Statistic Name Description
NumReceiptsClosed Number of receipts closed.

Pending job count

For this transaction the pending job count is the number of Receipts that can be closed (with OPEN_RECEIPT_FLAG='Y').

Events raised

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

Table 4. Events raised by the close receipts transaction
Transaction/Event Key Data Data Published Template Support?
ON_SUCCESS receipt_dbd.txt
YFS_RECEIPT_COMPLETE
.ON_SUCCESS.xml
 Yes