Reason Codes - Finalist - 10.0

Finalist Compatibility Interface (CI) Migration Guide

Product type
Software
Portfolio
Verify
Product family
Data Quality - Postals
Product
Finalist
Version
10.0
Language
English
Product name
Finalist
Title
Finalist Compatibility Interface (CI) Migration Guide
Copyright
2023
First publish date
1998
ft:lastEdition
2024-05-15
ft:lastPublication
2024-05-15T00:18:43.325870

The most significant difference between the Finalist Compatibility Interface (CI) and the Finalist native interface is the return, reason, and address-information codes. The CI version has a limited set of return information but significant customer business logic was written that depends on those values. The direct AddressInfo information returned from the native interface does not always directly map to the old return, reason, and address-information codes. However, Finalist includes the FNCIRCAC conversion routine to map the AddressInfo fields to return, reason, and address-information fields.

Using the FNCIRCAC Conversion Routine

You can use the FNCIRCAC conversion routine to map the AddressInfo fields to return, reason, and address-information fields. To use FNCIRCAC, you must pass in seven parameters. The first three parameters are the input parameters to FNCIRCAC. The last four parameters are output parameters.

  1. The first parameter is a pointer to a one byte Y or N indication of your firm processing (FINAL-FIRMLBL-OPT or derived from PBFN-GCFG-RETINPUTFIRM).

  2. The second parameter is a pointer to a fullword (4 byte integer), that contains the return code from the PBFNProcess call (see Initialize - 0 Call).

  3. The third parameter is a pointer to the output AddressData structure after the call to PBFNProcess.

  4. The fourth parameter is a pointer to a three-byte field formerly known as FINAL-OUTPUT-SELECT.

  5. The fifth parameter is a pointer to a one-byte area formerly known as FINAL-RETURN-CODES.

  6. The sixth parameter is a pointer to a 12-byte area formerly known as FINAL-REASON-CODES.

  7. The seventh and final parameter is a pointer to the 10-byte area formerly known as FINAL-ADDRESS-INFO-CODES.

To use FNCIRCAC, you need to:

  1. Define the local fields.

  2. Successfully call PBFNProcess (does not generate return code -1).

  3. Call FNCIRCAC passing the parameters as described immediately above.

After the call to FNCIRCAC, you can continue with your business logic using the return, reason, and address information codes that FNCIRCAC returned.

Note: FNCIRCAC returns the codes as defined when the CI was first developed. If you are not satisfied with the values returned from FNCIRCAC, Finalist includes the C source for FNCIRCAC. You are free to modify the source and reuse it for your own purposes. Precisely does not provide support for the FNCIRCAC source.