Clean up Pending Cashiering Register Transactions

This task processes pending register transactions that were created by Infor Rhythm for Civics.

If you are using a web form payment gateway or a hosted page payment gateway for payments, a register transaction with a status of Pending is created in Infor Public Sector whenever a user opens the checkout page in Rhythm for Civics.

If the user cancels the checkout process in Rhythm for Civics, the pending register transaction is automatically voided. However, if the payment process is interrupted for some reason, then the transaction will remain pending. For example, the user might navigate away from the checkout page without canceling or completing the checkout process.

The task first loads the pending register transactions that match the task parameters, then loops through them and processes each one.

If the task is configured to attempt to complete transactions before voiding them, then it will first attempt to complete each transaction. Select the Pay Forward check box to enable this behavior.

If Pay Forward is not selected, or if a transaction cannot be completed, it will be voided instead. To void a register transaction, Infor Public Sector changes the transaction's status to Voided.

Note: Transactions with associated payments are not voided unless the status of the payment is Declined. In some cases the payment information is successfully returned from the gateway but the process cannot be completed due to workflow issues in Infor Public Sector. In this case the transaction remains pending until the issue is resolved.

The task also voids the drawer transactions associated with these register transactions, if they have not been voided already. To void a drawer transaction, Infor Public Sector adds a separate drawer transaction with transaction type Void, which is linked to the voided transaction.

Because Rhythm for Civics uses merchant accounts for payment processing, the task also checks the associated payment server transactions, and reverses them as necessary. For this Infor Public Sector uses the Inquire Payment and Reverse Payment setups, as defined in the merchant account. If either of these processes fails, the register transaction will not be processed, and will remain pending.

See the Infor Public Sector Cashiering Administration Guide and the Infor Rhythm for Civics User and Administration Library on docs.infor.com for more information.

Setup

This table describes the Infor Public Sector setup forms that are used to configure this task:

Setup form Comments
Cashiering Setup On the merchant account that Rhythm for Civics uses, ensure that the Void Approved Only check box is cleared. If this check box is selected then only approved transactions can be voided, but the task might need to void transactions with an unknown status.

This table describes the Configuration Editor settings that affect this task:

Configuration Comments
CashieringSetup configuration The task uses the fee lock settings defined in this configuration when attempting to complete transactions.

In an on-premises environment, the Infor Public Sector Batch Manager service on the server must be set up to use Network Service as the log on account.

Invocation

The Clean up Pending Cashiering Register Transactions task can be scheduled and invoked manually through the Infor Public Sector Batch Manager form.

This table describes each parameter for this task:

Parameter Description
Register Group Register group for which you want to clean up pending transactions.
Register ID ID of the register for which you want to clean up pending transactions.
Pending for Number of minutes before a pending transaction is eligible to be cleaned up.
Voided By Employee ID that will be used for the Void By field in the voided register transactions. If you do not specify a value here, then the employee who created the original transaction will be used.
Pay Forward Indicates whether the task will attempt to complete pending transactions if possible. If a transaction cannot be completed, then it will be voided.

Monitoring

If the task is successful, you should see a series of messages similar to these in the primary Infor Public Sector log:

  • Cashiering Clean up Pending Register Transactions Process Started.
  • CleanupPendingRegTrans: Task started: [date/time]
  • CleanupPendingRegTrans: Processing Register Transaction: [transaction #]
  • CleanupPendingRegTrans: Processing Drawer Transaction: [transaction #]
  • [Various messages as transactions are processed]
  • CleanupPendingRegTrans: Analyzing pending transaction completed
  • CleanupPendingRegTrans: Task Ended: [date/time]
  • Cashiering Clean up Pending Register Transactions Process Completed.

Note that logging must be turned on in the Logging configuration.

Common errors

This table lists some common errors that this task may return:

Error message Comments
Inquire payment failed The payment inquiry to the merchant account failed. The pending transaction will not be cleaned up.
Reverse payment failed The payment associated with a voided drawer transaction could not be reversed. The pending transaction will not be cleaned up.

Data output

This table lists the database tables in which this task adds or updates records:

Table Comments
CASHIERING.REGISTERTRANSACTION Stores register transactions. Each voided transaction will have its status changed to Voided.
CASHIERING.DRAWERTRANSACTION Stores drawer transactions. For each drawer transaction that needs to be voided, Infor Public Sector adds a separate void transaction.
CASHIERING.PAYMENTSERVERTRANSACTION Stores payment server transactions for credit and debit card payments. A void transaction will be added for each voided drawer transaction.