The administrative returns node (AdminReturnsNode) sets the return endpoint (ibmNprEndpoint) and return
reason (ibmReturnReason) for the transaction. It consists of these tables:
- Return reasons (initialization)
- Return customers (binary)
- Return endpoint (binary)
At initialization, the return reasons initialization table is loaded and set up for run time.
Return reasons initialization table
The return reasons initialization table is loaded at initialization. It is positioned to be used between
the return customer and return endpoint look ups. The example XML in
XML Examples shows a sample
of the ordering. The table is ordered by precedence values - the lower the number, the higher the precedence.
All data fields are required.
Table 1. Return reasons initialization table
| Field name |
Type |
Data type |
Length |
Description |
| ibmIntPrecedence |
Payload |
Byte |
2 |
Unique number that allows control over which reason is higher in priority when multiple
exceptions are encountered. The lower the number, the higher the precedence. |
| ibmIntExcpFlagDataFieldName |
Payload |
Char |
32 |
Name of the data field that is checked. The data is read as Boolean. |
| ibmNprReturnReason |
Payload |
Char |
2 |
Actual return reason, which is a two character field in the database. |
Return reasons table
The return reasons table sample (ReturnReasonsTable) that is included with
Distribution
contains the data that is shown in the following table.
Table 2. Return reasons table
| ibmIntPrecedence |
ibmIntExcpFlagDataFieldName |
ibmNprReturnReason |
Notes |
| 1 |
"ibmNprImgCompFailedIIA" |
"N" |
|
| 2 |
"ibmNprImgCompFailedIQA" |
"U" |
|
| 3 |
"ibmNprImgCompFailedTIFF" |
"I" |
|
| 4 |
"ibmNprMissingImage" |
"I" |
|
| 5 |
"ibmNprDuplicateIndicator" |
"Y" |
|
| 6 |
"ibmIntRecordValidationError" |
"2" |
Not supported in PVR workflows, unless the content and context nodes are included in the
workflow. |
| 7 |
"ibmIntWrongBank" |
"R" |
|
| 8 |
"ibmNprValidationError" |
"Q" |
|
| 9 |
"ibmValOperatorRejected" |
"O" |
|
Return customers table
The return customers table is extracted from the partner table in the database. It has a key field and no
payload data. If a transaction appears in this table, it is a return customer.
Table 3. Return customers table
| Field name |
Type |
Data type |
Length |
Description |
| ibmValDepositorId |
Key |
Char |
10 |
Supplied by the client application. |
Return endpoints table
The return endpoints table has two key fields. If a look up fails, the administrative returns node allows
the ibmNprReturnReason data field to be returned to the client as a set value.
Table 4. Return endpoints table
| Field name |
Type |
Data type |
Length |
Description |
| ibmValDepositorId |
Key |
Char |
10 |
Supplied by the client application. |
| ibmValFileInboundChannelType |
Key |
Byte |
2 |
Supplied by the client application. |
| ibmNprEndpoint |
Payload |
Char |
10 |
|