AuxOnUs Node

The AuxOnUs node requires several fields be set appropriately before it attempts a lookup in the AuxOnUs table.

If ibmIntAuxPrefix or ibmNprAuxOnUs have not been set or ibmNprValidAuxOnUs is false, the lookup is not attempted. Normally, the ibmNprAuxOnUs field would come from the client application, and ibmIntAuxPrefix would come from an upstream payment validation rule node table lookup. The ibmNprValidAuxOnUs field is set to false when a prior node lookup for a record ID was invalid or comes in that way from the client.

When the AuxOnUs table record is successfully located and the ibmNprRecordId value has changed, a lookup in the record ID validation table is performed and the fields are validated according to the record ID validation node (see Record ID Validation).

Table Record Layout

The AuxOnUs node table record layout is shown in Table 1.
Table 1. AuxOnUs Node Table Record Layout
Field Type Field Name Data Type Length Notes
Key ibmIntAuxPrefix byte 2  
Start Key ibmIntAuxLow char 17  
End Key ibmIntAuxHigh char 17  
Payload ibmNprRecordType byte 2  
ibmNprControlDoc char 1  
ibmNprRecordId byte 2 Used as one of the keys in the record ID validation table
ibmNprCredit char 1  
ibmIntEndorseId byte 2 Endorse table key
ibmIntAmountPrefix byte 2 Amount table key
ibmIntPcPrefix byte 2 Process Control table key
ibmIntAccountPrefix byte 2 Account table key
ibmIntField4Prefix byte 2 Field 4 table key
ibmIntEpcPrefix byte 2 Extended process code table key
ibmIntAuxPrefix byte 2 AuxOnUs table key

Fields that can change

The AuxOnUs node fields that can change are:
Table 2. AuxOnUs Node Fields that can Change
Field Name Data Type Length
ibmNprRecordId byte 2
ibmNprValidationError byte 1
ibmNprValidAmount byte 1
ibmNprValidPc byte 1
ibmNprValidAccount byte 1
ibmNprValidField4 byte 1
ibmNprValidRT byte 1
ibmNprValidExtProcCode byte 1
ibmNprValidAuxOnUs byte 1

Results

The AuxOnUs node results are:
Table 3. AuxOnUs Node Results
If Condition Results Notes
ibmIntAuxPrefix Not set SUCCESS Without doing the lookup
ibmNprValidAuxOnUs false FAILURE Without doing the lookup
ibmNprAuxOnUs Not set SUCCESS Without doing the lookup
Lookup Fails FAILURE  
Lookup Succeeds SUCCESS  
Validation Succeeds/Fails SUCCESS  

Initialize

Not applicable

Process

The AuxOnUs node does the following in sequence:
  1. Checks that the ibmIntAuxPrefix field has been set. If it is not present, sets the node’s response to success and goes to step 10.
  2. Checks the value of the ibmNprValidAuxOnUs field. If it is false, sets the node’s response to failure and goes to step 10.
  3. Checks that the ibmNprAuxOnUs field has a value in it. If it is not present, sets the node’s response to success and goes to step 10.
  4. Saves a copy of ibmNprRecordId.
  5. If the user exit is present, calls its preProcess routine.
  6. Performs the lookup in the AuxOnUs table.
  7. If the record is not found, sets the node’s response to failure and goes to step 10.
  8. If the record is found, reads the payload fields into DecisionRequest and sets the node’s response to success.
  9. Checks if the ibmNprRecordId was modified from the table lookup. If it was, it continues with the validate the payment field operation (see Validating the Payment Fields Operation).
  10. If the user exit is present, calls its buildClientResponse routine.
  11. Returns to the workflow controller.