Migrating the CI Address Information 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

This migration table maps the CI address information codes to the Finalist native address information codes. Also, refer to Using the FNCIRCAC Conversion Routine. Programs can also call FNCIRCAC to convert the Finalist native address information codes to the CI format.

Note: C field names are provided in the following table since COBOL cannot easily process "bit flags". For more information, refer to the description of PBITBYTE in FNCIRCAC.

Finalist CI Address Info Code Description

Finalist Native Field Setting

Field/Notes

Address Info Code 1

City type information

 

0

Single ZIP code city

PBFN_SINGLEZONE

PBFNAddressDataDef.cCityType

1

Multi-ZIP code city

PBFN_MULTIZONE

PBFNAddressDataDef.cCityType

9

City type not determined

0

PBFNAddressDataDef.cCityType

Address Info Code 2

Address type information

 

0

Conventional address

PBFN_ADSTYPE_STREET or

PBFN_ADSTYPE_HIGHRISE

PBFNAddressDataDef.cAddressType

1

PO Box

PBFN_ADSTYPE_PO_BOX

PBFNAddressDataDef.cAddressType

2

Rural route

PBFN_ADSTYPE_RR

PBFNAddressDataDef.cAddressType

3

Highway contract route

PBFN_ADSTYPE_HC

PBFNAddressDataDef.cAddressType

4

General delivery

PBFN_ADSTYPE_GD

PBFNAddressDataDef.cAddressType

5

Firm address

PBFN_ADSTYPE_FIRM

PBFNAddressDataDef.cAddressType

6

Pre-directional address

N/A

Not supported in the Finalist native interface. Use the PBFNAddressDataDef.cPreDir flag to determine predirectional attributes.

7

Post-directional address

N/A

Not supported in the Finalist native interface. Use the PBFNAddressDataDef.cPostDir flag to determine postdirectional attributes.

8

Postmaster

N/A

Not supported in the Finalist native interface. Postmasters are not currently flagged in the engine.

9

Address type not determined

PBFN_ADSTYPE_UNKNOWN

PBFNAddressDataDef.cAddressType

Address Info Code 3

Delivery type information

 

0

City delivery

PBFN_ADSTYPE_STREET

PBFNAddressDataDef.sAddrMatchLevel

1

City delivery default

None

Not supported in the Finalist native interface.

2

PO Box

PBFN_ADSLVL_PO

PBFNAddressDataDef.sAddrMatchLevel

3

Rural route/highway contract route

PBFN_ADSLVL_RRHC_DEFAULT or

PBFN_ADSLVL_RRHC_SECONDARY

PBFNAddressDataDef.sAddrMatchLevel

4

General Delivery

PBFN_ADSLVL_GENDEL

PBFNAddressDataDef.sAddrMatchLevel

9

Delivery type not determined

0

PBFNAddressDataDef.sAddrMatchLevel

Address Info Code 4

Input address information

 

0

Firm found on firm line. Delivery found on line 1 and line 2.

See notes

PBFNAddressDataDef.cFirmLoc=PBFN_FIRMLOC_FIRM and PBFNAddressDataDef.cAddressLoc=PBFN_ADSLOC_L1_L2

1

Address found on address line 1

PBFN_ADSLOC_L1

PBFNAddressDataDef.cAddressLoc

2

Address found on address line 2

PBFN_ADSLOC_L2

PBFNAddressDataDef.cAddressLoc

3

Address found on both address line 1 and line 2

PBFN_ADSLOC_L1_L2

PBFNAddressDataDef.cAddressLoc

4

Firm found on firm line, no delivery address found

See notes

PBFNAddressDataDef.cFirmLoc=PBFN_FIRMLOC_FIRM and PBFNAddressDataDef.cAddressLoc=PBFN_ADSLOC_UNKNOWN

5

Firm found on address line 1, no delivery address found

See notes

PBFNAddressDataDef.cFirmLoc=PBFN_FIRMLOC_L1 and PBFNAddressDataDef.cAddressLoc=PBFN_ADSLOC_UNKNOWN

6

Address found on firm line

See notes

PBFNAddressDataDef.cDualAddressInd indicates the address was found on the firm line. Firm was found on the address line.

7

Firm found on firm line-delivery address found on address line 1

PBFN_ADSLOC_FIRM_L1

PBFNAddressDataDef.cAddressLoc

8

Firm found on firm line-delivery address found on address line 2

PBFN_ADSLOC_FIRM_L2

PBFNAddressDataDef.cAddressLoc

9

All address lines used-address failed

PBFN_FAILED

Return code from PBFNProcess.

Address Info Code 5

Address lookup information

 

0

Address found on primary lookup

N/A

Internal logic has changed. This is no longer a valid reason code in the Finalist native interface.

1

Address found on backtrack lookup

N/A

Internal logic has changed. This is no longer a valid reason code in the Finalist native interface.

Address Info Code 6-8

Unit information

 

051 through 058

Unit number missing for MFDU with over 59 units

N/A

Data is no longer available. Not supported in the Finalist native interface.

060

Sector/segment is not deliverable

Y

PBFNAddressDataDef.cNonDeliverableInd

101 through 300

Unit number missing for MFDU with 04-59 units

N/A

Data is no longer available. Not supported in the Finalist native interface.

400 and 000

Unit number entered is unavailable or not determined

N/A

Data is no longer available. Not supported in the Finalist native interface.

Address Info Code 8

Output address type

 

0

Conventional address coded

PBFN_ADSLVL_STREET

PBFNAddressDataDef.sAddrMatchLevel return code from PBFNProcess is PBFN_SUCCESS.

1

PO Box address coded

PBFN_ADSLVL_PO

PBFNAddressDataDef.sAddrMatchLevel return code from PBFNProcess is PBFN_SUCCESS.

2   

Rural route address coded

PBFN_ADSLVL_ RRHC_DEFAULT or

PBFN_ADSLVL_RRHC_SECONDARY

PBFNAddressDataDef.sAddrMatchLevel

PBFNAddressDataDef.cAddressType=PBFN_ADSTYPE_RR

Return code from PBFNProcess is PBFN_SUCCESS.

3

Highway contract address coded

PBFN_ADSLVL_ RRHC_DEFAULT or

PBFN_ADSLVL_RRHC_SECONDARY

PBFNAddressDataDef.sAddrMatchLevel

PBFNAddressDataDef.cAddressType =PBFN_ADSTYPE_RR

Return code from PBFNProcess is PBFN_SUCCESS.

4

General deliver address coded

PBFN_ADSLVL_GENDEL

PBFNAddressDataDef.sAddrMatchLevel return code from PBFNProcess is PBFN_SUCCESS.

5

Firm address coded

PBFN_ADSLVL_FIRM_PRIMARY or

PBFN_ADSLVL_FIRM_SECONDARY

PBFNAddressDataDef.sAddrMatchLevel return code from PBFNProcess is PBFN_SUCCESS.

6

Highrise address coded

PBFN_ADSLVL_HIGHRISE_DEFAULT

or

PBFN_ADSLVL_HIGHRISE_SECONDA RY

PBFNAddressDataDef.sAddrMatchLevel return code from PBFNProcess is PBFN_SUCCESS.

7

Firm at highrise address coded

PBFN_ADSLVL_FIRM_PRIMARY or

PBFN_ADSLVL_FIRM_SECONDARY

and

PBFN_ADSLVL_HIGHRISE_DEFAULT

or

PBFN_ADSLVL_HIGHRISE_SECONDA

RY

Combination of bit setting from these bits.

PBFNAddressDataDef.sAddrMatchLevel return code from PBFNProcess is PBFN_SUCCESS.

8

Military address coded

PBFN_ADSLVL_MIL_DEFAULT or

PBFN_ADSLVL_MIL_SECONDARY

PBFNAddressDataDef.sAddrMatchLevel or PBFNAddressDataDef.cZipType = PBFN_MILITYARY

9

Cannot code output address

PBFN_FAILED

Return code from PBFNProcess

Address Info Code 10

ZIPMove type

 

0

Match determined using ZIPMove record

Y

PBFNAddressDataDef.cZipMove

9

ZIPMove forwarding did not occur

N

PBFNAddressDataDef.cZipMove