Collection Attributes in Release 6.0
New Attribute added for Collection Definition
The Recon Status attribute in the Paylink collection query helps to categorize and filter transactions based on their reconciliation status. Reconciliation is the process of matching records to ensure everything adds up, like balancing a checkbook or comparing two lists to find matches or differences.
Syntax:
[Collection : <Collection Name>]
Type : Paylink
Recon Status : <Recon Status String>
Where, < Collection Name> is the name of the collection
<Recon Status String> is to specify the status of the reconciliation.
Example:
[Collection: BankRec FindMatch BooksReconciledVchs]
Use : BankRec PayLinkBase
Recon Status : @@SysNameChqRecon
Compute : ReconStatus : $BankReconStatus
Multiple Recon Statuses can also be defined as shown below:
[Collection: External Data Coll]
Type : PayLink
Recon Status : $$SysName:ChqRecon
Recon Status : $$SysName:AvailableOnlyInPortal
This will fetch all ‘reconciled’ and ‘available only in portal’ paylink transactions.
Attribute enhancements
Currently, the collection attributes like Transaction Type, Primary Status, and Secondary Status in Paylink queries accept only a single value. However, many scenarios, such as e-payment reports, require filtering objects based on multiple status values. For example:
- E-payment reports may need transactions with types like Inter Bank Transfer, Same Bank Transfer, and e-Cheque together.
To achieve this with the existing capability, developers must create multiple collections and combine them using union collections, which is inefficient and adds unnecessary complexity.
What’s changing?
These attributes will now accept multiple values in a single collection as a list. Developers can specify the required values for attributes like Transaction Type, Primary Status, and Secondary Status in a single query.
Comparison of Existing and Enhanced Collection Design
| Scenario | Before Enhancement (Separate Collections) | After Enhancement (Single Collection) |
|---|---|---|
| Code Example |
[Collection: ePaymentsPaylinkLedgerIBT] Type: Pay Link PrimaryStatus: $$SysName:StatusTransacted Transaction Type: $$SysName:InterBankTransfer [Collection: ePaymentsPaylinkLedgerSBT] Type: Pay Link PrimaryStatus:$$SysName:StatusTransacted Transaction Type: $$SysName:SameBankTransfer [Collection: ePaymentsPaylinkLedgerECheq] Type: Pay Link PrimaryStatus: $$SysName:StatusTransacted Transaction Type: $$SysName:ElectronicCheque |
[Collection: ePaymentsPaylinkSrc] Type: Pay Link PrimaryStatus:$$SysName:StatusTransacted Transaction Type: $$SysName:InterBankTransfer Transaction Type: $$SysName:SameBankTransfer Transaction Type: $$SysName:ElectronicCheque |
| Efficiency | Requires union collections or multiple queries to combine data from separate collections. | Eliminates the need for union collections and consolidates all relevant data in one query. |
| Performance | Additional overhead due to executing multiple queries. | Improved performance by reducing query overhead and simplifying execution. |
The Secondary Status attribute currently works only when used with the Child Of attribute for a bank ledger. However, there is now a requirement to retrieve Paylink objects based on the Secondary Status, independent of the bank ledger, i.e., at the company level.
This functionality has been enhanced to allow the application to specify the Secondary Status attribute either with or without the bank ledger.
As a result, the following 16 combinations of four attributes (Transaction Type, Primary Status, Secondary Status, and Recon Status) will now work seamlessly, both with and without the bank ledger:
- None of the attributes are specified.
- Only the Transaction Type attribute is specified.
- Only the Primary Status attribute is specified.
- Only the Secondary Status attribute is specified.
- Only the Recon Status attribute is specified.
- Transaction Type and Primary Status attributes are specified.
- Transaction Type and Secondary Status attributes are specified.
- Transaction Type and Recon Status attributes are specified.
- Primary Status and Secondary Status attributes are specified.
- Primary Status and Recon Status attributes are specified.
- Secondary Status and Recon Status attributes are specified.
- Transaction Type, Primary Status, and Secondary Status attributes are specified.
- Transaction Type, Primary Status, and Recon Status attributes are specified.
- Transaction Type, Secondary Status, and Recon Status attributes are specified.
- Primary Status, Secondary Status, and Recon Status attributes are specified.
- All four attributes (Transaction Type, Primary Status, Secondary Status, and Recon Status) are specified.
This improvement provides greater flexibility for applications to manage Paylink objects effectively across various scenarios.
