Migrating the Process (4, 5, 6, and 7) Return Callarea - 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 Return callarea for the Process call to the Finalist native APIs and structures. The return structures passed to the Finalist native PBFNProcess call now return the information previously returned from the Finalist CI Process call. Finalist CI returned a combination of address line and parsed data components.

COBOL

C

Assembler

Position

CI Structure/Field/Notes

FINAL-ONLINE-RETURN-CODE

cOnlineRC

OLRETCD

1

If the PBFNProcess call returns PBFN_SUCCESS, then check PBFNAddressDataDef.cReturnLevel.:

  • A cReturnLevel of PBFN_RTNZIP4 indicates a 0.

  • A cReturnLevel of PBFN_RTNZIPCRRT indicates a 1.

  • A cReturnLevel value of PBFN_RTNZIP indicates a 2.

  • Any other value indicates a value of 9.

If PBFNProcess returns any other value, FINAL-ONLINE-RETURNCODE is 9.

FINAL-OLD-RETURN-CODE2

cOldRC2

OLRETCD2

2

 

FINAL-OLD-RETURN-CODE3

cOldRC3

OLRETCD3

3

 

CAERRMOD

union4567.OnlineError.caErrorModule

ACERRMOD

4-11

 

CAERRSRC

union4567.OnlineError.caResource

CAERRSRC

12-19

 

CAERRDSC

union4567.OnlineError.caResource

CAERRDSC

20-28

 

FINAL-ISOL

union4567.FinalArea4567.cIsol

ISOLATOR

4

No longer returned in the Finalist native interface. Finalist native internal logic has multiple isolation paths and logic that make this an obsolete piece of information.

FINAL-RECORD-NUMBER

union4567.FinalArea4567.caRecNumber

RECNMBR

5-9

 

FINAL-ZIP

union4567.FinalArea4567.Zip

RTNZIP

10-14

PBFN-RRTN-ZIP

PBFNAddressDataDef.cZip

FINAL-SCF

union4567.FinalArea4567.Zip.caScf

RTNSCF

10-12

Not returned in a parsed format in the Finalist native interface. Use the first three positions of the following fields:

PBFN-RRTN-ZIP field

PBFNAddressDataDef.cZip

FINAL-ZONE

union4567.FinalArea4567.Zip.caZone

RTNZONE

13-14

Not returned in a parsed format in the Finalist native interface. Use the last two positions of the following fields:

PBFN-RRTN-ZIP field

PBFNAddressDataDef.cZip

FINAL-SEC-SEG

caSecSeg

RTNSS#

15-18

PBFN-RRTN-ZIP4

PBFNAddressDataDef.cZip4

FINAL-CR-RTE

caCrRte

RTNCR

19-23

PBFN-RRTN-CRRTE

PBFNAddressDataDef.cCrRte

FINAL-STATE

caState

RTNSTATE

24-25

PBFN-RRTN-STATE

PBFNAddressDataDef.cState

FINAL-CITY

caCity

RTNCITY

26-38

PBFN-RRTN-CITY

PBFNAddressDataDef.cCity

FINAL-COUNTY

caCounty

RTNCNTY

39-43

PBFN-RRTN-COUNTY-NAME

PBFNAddressDataDef.cCountyName

FINAL-DIR11

Direction[0].caDir1

DIRCTN11

44-45

PBFN-RRTN-PREDIRECTIONAL   

PBFNParsedAdrDefinition.cPreDirectional

The Finalist native interface does not support returning information on failed isolations.

FINAL-SFX11

Direction[0].caSfx1

SUFFIX11

46-49

PBFN-RRTN-STREETSUFFIX

PBFNParsedAdrDefinition.cStreetSuffix

The Finalist native interface does not support returning information on failed isolations.

FINAL-SFX12

Direction[0].caSfx2

SUFFIX12

50-53

The Finalist native interface does not support returning information on failed isolations.

FINAL-PDIR1   

Direction[0].caPDir

DIRCTN12

54-55

The Finalist native interface does not support returning information on failed isolations.

FINAL-DIR21

Direction[1].caDir1

DIRCTN21

56-57

The Finalist native interface does not support returning information on failed isolations.

FINAL-SFX21

Direction[1].caSfx1

SUFFIX21

58-61

The Finalist native interface does not support returning information on failed isolations.

FINAL-SFX22

Direction[1].caSfx2

SUFFIX22

62-65

The Finalist native interface does not support returning information on failed isolations.

FINAL-PDIR2

Direction[1].caPDir

DIRCTN22

66-67

The Finalist native interface does not support returning information on failed isolations.

FINAL-DIR31

Direction[2].caDir1

DIRCTN31

68-69

The Finalist native interface does not support returning information on failed isolations.

FINAL-SFX31

Direction[2].caSfx1

SUFFIX31

70-73

The Finalist native interface does not support returning information on failed isolations.

FINAL-SFX32

Direction[2].caSfx2

SUFF32

74-77

The Finalist native interface does not support returning information on failed isolations.

FINAL-PDIR3

Direction[2].caPDir

DIRCTN32

78-79

The Finalist native interface does not support returning information on failed isolations.

FINAL-VALIDCICS-OPTION

caValidCICSOption

CAFNOPT

80

 

FINAL-HOUSE-NUM

caHouseNum

HOUSNMBR

84-93

PBFN-RRTN-RANGE

PBFNAddressDataDef.cRange

FINAL-PRE-DIR

caPreDir

PREDRCTN

94-95

PBFN-RRTN-PREDIRECTIONAL

PBFNAddressDataDef.cPreDirectional

FINAL-STREET-NAME

caStreetName   

STNAME

96-123

PBFN-RRTN-STREET-NAME

PBFNAddressDataDef.cStreetName

FINAL-POST-DIR

caPostDir

PSTDRCTN

124-125

PBFN-RRTN-POSTDIRECTIONAL

PBFNAddressDataDef.cPostDirectional

FINAL-SFX1

caSfx1

STSFX1

126-129

PBFN-RRTN-STREETSUFFIX

PBFNAddressDataDef.cStreetSuffix

FINAL-SFX2

caSfx2

STSFX2

130-133

The Finalist native interface and the USPS data no longer support the concept of two suffixes.

FINAL-APT-NUM

caAptNum

APTNMBR

134-143

PBFN-RRTN-UNIT1 or PBFN-RRTN-UNIT2

PBFNAddressDataDef.cUnit1

PBFNAddressDataDef.cUnit2

FINAL-EXTRA

caExtra

EXTRA

144-152

PBFN-RRTN-EXTRA

PBFNAddressDataDef.cExtra

ORIG-ZIP

OrigZip

ORIGZIP

153-157

PBFN-RRTN-ORIG-ZIP

PBFNOrigDataDef.cOrigZip

ORIG-SCF   

caScf

ORIGSCF

153-155

Not returned in a parsed format in native. Use the first 3 positions of:

PBFN-RRTN-ORIG-ZIP

PBFNOrigDataDef.cOrigZip

ORIG-ZONE

caZone

ORIGZONE

156-157

Not returned in a parsed format in native. Use the last 2 positions of the following fields:

PBFN-RRTN-ORIGZIP

PBFNOrigDataDef.cOrigZip

ORIG-SEC-SEG

caOrigSecSeg

ORIGSS#

158-161

PBFN-RRTN-ORIGZIP4

PBFNOrigDataDef.cZip4

ORIG-CR-RTE   

caOrigCrRte

ORIGCRRT

162-166

PBFN-RRTN-ORIGCRRTE

PBFNOrigDataDef.cOrigCrRte

ORIG-STATE

caOrigState

ORIGSTE

167-168

PBFN-RRTN-ORIGSTATE

PBFNOrigDataDef.cOrigState

ORIG-CITY

caOrigCity

ORIGCITY

169-196

PBFN-RRTN-ORIGCITY

PBFNOrigDataDef.cOrigCity

ORIG-ZIPP   

caOrigZipP

ORIGZIPP

197-199

The Finalist native interface does not return packed data.

ORIG-SECSEGP

caSecSegP

ORIGSS#P

200-202

The Finalist native interface does not return packed data.

FINAL-STATE-SCF-VER

caStateScfVer

SSVERIND

203

PBFN-RRTN-ADSCITY

PBFN-RRTN-ADSSTATE

PBFNAddressDataDef.cAdsCity

PBFNAddressDataDef.cAdsState settings

FINAL-RETSCF

caRetScf

RETSCF

204-206

Not returned in a parsed format in the Finalist native interface. Use the first three positions of the following fields:

PBFN-RRTN-ZIP   

PBFNAddressDataDef.cZip

FINAL-PMUNIT

caPMUnit

PMUNIT

207-210

PBFN-RRTN-ADSPMBDESIGNATOR

PBFNAddressDataDef.cPMUnitDesignator

FINAL-PMNUMBER

caPMNumber

PMNUMBER

211-220

PBFN-RRTN-PMUNITNUMBER

PBFNAddressDataDef.cPMUnitNumber

FINAL-DPV-FOOTNOTES

caDPVFootnotes

DPVFTNOE

221-230

PBFN-RRTN-DPVFOOTNOTE

PBFNAddressDataDef.cDPVFootnote

FINAL-UNITDES

caUnitDes

UNITDES

231-234

PBFN-RRTN-ADSUNIT1DESIGNATOR

PBFNAddressDataDef.cUnit1Designator

FINAL-CITY-IND

caCityInd

CITYIND

237

PBFN-RRTN-CITY-TYPE

PBFNAddressDataDef.cCityType

FINAL-OUTSEL-GOOD

cGood

CAOUTSLG

238

PBFNProcess return code equal to PBFN_SUCCESS.

cReturnLevel in PBFNAddressDataDef set to PBFN_RTNZIP4.

cCity and cZIP in PBFNAddressDataDef are not set to PBFN_CORRECTED.

FINAL-OUTSEL-BAD

cBad

CAOUTSLB

239

PBFNProcess return code not equal to PBFN_SUCCESS.

FINAL-OUTSEL-CHANGE

cChange

CAOUTSLC

240

PBFNProcess return code equal to PBFN_SUCCESS.

cReturnLevel in PBFNAddressDataDef set to PBFN_RTNZIP4

cCity or cZIP in PBFNAddressDataDef are set to PBFN_CORRECTED.

FINAL-RETURN-CODE-1

cRc1

CARETCD1

241

The PBFNProcess return code is set to:

  • 0 = PBFNProcess return code equal to PBFN_SUCCESS and cReturnLevel in PBFNAddressDataDef set to PBFN_RTNZIP4.

  • 1 = PBFNProcess return code not equal to PBFN_SUCCESS and cReturnLevel in PBFNAddressDataDef set to PBFN_RTNZIPCRRT.

  • 2 = PBFNProcess return code not equal to PBFN_SUCCESS and cReturnLevel in PBFNAddressDataDef set to PBFN_RTNZIP.

  • 9 = All other cases.

FINAL-REASON-CODE1

cReasonCode[0]

CARESN1

243

Refer to the section "Migrating the CI Reason Codes".

FINAL-REASON-CODE2

cReasonCode[1]

CARESN2

244

Refer to the section "Migrating the CI Reason Codes".

FINAL-REASON-CODE3

caReasonCode[2]

CARESN3

245

Refer to the section "Migrating the CI Reason Codes".

FINAL-REASON-CODE4

caReasonCode[3]

CARESN4

246

Refer to the section "Migrating the CI Reason Codes".

FINAL-REASON-CODE5

caReasonCode[4]

CARESN5

247

Refer to the section "Migrating the CI Reason Codes".

FINAL-REASON-CODE6

caReasonCode[5]

CARESN6

248

Refer to the section "Migrating the CI Reason Codes".

FINAL-REASON-CODE7

caReasonCode[6]

CARESN7

249

Refer to the section "Migrating the CI Reason Codes".

FINAL-REASON-CODE8

caReasonCode[7]

CARESN8

250

Refer to the section "Migrating the CI Reason Codes".

FINAL-REASON-CODE9

caReasonCode[8]

CARESN9

251

Refer to the section "Migrating the CI Reason Codes".

FINAL-REASON-CODE10

caReasonCode[9]

CARESN10

252

Refer to the section "Migrating the CI Reason Codes".

FINAL-REASON-CODE11

caReasonCode[10]

CARESN11

253

Refer to the section "Migrating the CI Reason Codes".

FINAL-REASON-CODE12

caReasonCode[11]

CARESN12

254

Refer to the section "Migrating the CI Reason Codes".

FINAL-INFO-CODE1

cInformationCode[0]

CAINFO1

255

Refer to the section "Migrating the CI Address Information Codes".

FINAL-INFO-CODE2

cInformationCode[1]

CAINFO2

256

Refer to the section "Migrating the CI Address Information Codes".

FINAL-INFO-CODE3

cInformationCode[2]

CAINFO3

257

Refer to the section "Migrating the CI Address Information Codes".

FINAL-INFO-CODE4

cInformationCode[3]

CAINFO4

258

Refer to the section "Migrating the CI Address Information Codes".

FINAL-INFO-CODE5

cInformationCode[4]

CAINFO5

259

Refer to the section "Migrating the CI Address Information Codes".

FINAL-INFO-CODE678

cCode678

CAINF678

260-262

Refer to the section "Migrating the CI Address Information Codes".

FINAL-INFO-CODE9

cInformationCode[8]

CAINFO9

263

Refer to the section "Migrating the CI Address Information Codes".

FINAL-INFO-CODE10

cInformationCode[9]

CAINFO10

264

Refer to the section "Migrating the CI Address Information Codes".

FINAL-5D-BARCODE

(See next four fields.)

CA5BAR

265-272

PBFN-RRTN-FIVEDIGITBARCODE

PBFNAddressDataDef.cFiveDigitBarcode

FINAL-5D-BEG

cBeg

CA5BARB

265

PBFN-RRTN-FIVEDIGITBARCODE

Not separately defined in the Finalist native interface. Use position 1 of PBFNAddressDataDef.cFiveDigitBarcode.

FINAL-5D-ZIP

caZip

CA5RZIP

266-270

PBFN-RRTN-FIVEDIGITBARCODE

Not separately defined in the Finalist native inter va ce. Use positions 2–6 of PBFNAddressDataDef.cFiveDigitBarcode.

FINAL-5D-CKDIGIT

caChkdigit

CA5CHKD

271

PBFN-RRTN-FIVEDIGITBARCODE

Not separately defined in native. Use position 7 of PBFNAddressDataDef.cFiveDigitBarcode.

FINAL-5D-END

cEnd

CA5BARE

272

PBFN-RRTN-FIVEDIGITBARCODE

Not separately defined in native. Use position 8 of PBFNAddressDataDef.cFiveDigitBarcode.

FINAL-LINE-OF-TRAVEL

CALOTCDS

273-277

PBFN-RRTN-LOTCODE

PBFNAddressDataDef.cLOTCode

FINAL-LOT-CODE

caLotCode

CALOTOD

273-276

Pos 1–4 of:

PBFN-RRTN-LOTCODE

PBFNAddressDataDef.cLotCode

FINAL-LOT-ASCDSC

caLotAD

CALOTAD

277

Position 5 of:

PBFN-RRTN-LOTCODE

PBFNPrcoessDataDef.cLotCode

FINAL-LACS-FLAG   

cLACS

CALACS

278

PBFN-RRTN-LACS

PBFNAddressDataDef.cLACS

FINAL-ADVANCED-BARCODE

AdvBarCode

CAABARCD

285-298

PBFN-RRTN-ADVANCEBARCODE

PBNFProcessDataDef.cAdvanceBarcode

FINAL-ABC-BEG

cBeg

CAABARB

285

Position 1 of:

PBFN-RRTN-ADVANCEBARCODE

PBFNAddressDataDef.cAdvanceBarcode

FINAL-ABC-ZIP

caZip

CAARZIP

286-290

Position 2-6 of:

PBFN-RRTN-ADVANCEBARCODE

PBFNAddressDataDef.cAdvanceBarcode

FINAL-ABC-ZIP4

caZip4

CARZIP4

291-294

Position 7-10 of:

PBFN-RRTN-ADVANCEBARCODE

PBFNAddressDataDef.cAdvanceBarcode

FINAL-ABC-WSEQ

caWseq

CARWALK

295-296

Position 11-12 of:

PBFN-RRTN-ADVANCEBARCODE

PBFNAddressDataDef.cAdvanceBarcode

FINAL-ABC-CKDIGIT

caChkdigit

CAARCHKD

297

Position 13 of:

PBFN-RRTN-ADVANCEBARCODE

PBFNAddressDataDef.cAdvanceBarcode

FINAL-ABC-END

cEnd

CAABARE

298

Position 14 of:

PBFN-RRTN-ADVANCEBARCODE

PBFNAddressDataDef.cAdvanceBarcode

FINAL-ALT-ISOLATION

AltIsol

CAARISOL

299-357

 

FINAL-ALT-RANGE

caRange

CAARANGE

299-308

 

FINAL-ALT-PRE-DIR

caPreDir   

CAARDIR

309-310

 

FINAL-ALT-STREET

caStreet

CAASTRT

311-335

 

FINAL-ALT-SUFFIX

caSuffix

CAASFX

336-339

 

FINAL-ALT-POST-DIR

caPostDir

CAARPDIR

340-341

 

FINAL-ALT-UNIT

caUnit

CAARUNIT

342-347

 

FINAL-ALT-RANGE2

caRange2

CAARNGE2

348-357

 

FINAL-FULL-CITY-NAME

caFullCityName

CARCITY

358-382

PBFN-RRTN-FULLCITY-NAME

PBFNAddressDataDef.cFullCityName

FINAL-LABEL-RC   

cRc1

CALRTCDE

383

Label lines are always built from the Finalist area, except for the Firm name.

This is a selection option in the setup data.

Unused   

Unused

CAFLLGTH

384

 

FINAL-FIRM-LENGTH1

caLen[0]

CAFLCLGH

385-386

PBFN-RRTN-FIRM-LEN

FINAL-FIRM-LINEcaLine[0]

CAFLADDR

387-456

Label lines built and returned from the bottom up.

On successful addresses:

  • Line 5=CSZ

  • Line 4=Address

  • Line 3=URB if input, else Firm if input

  • Line 2=Firm if input and not on line 3

On failed address:

  • Line 5=CSZ

  • Line 4=address line 2 if entered, else address line 1

  • Line 3=address line 1 if not on Line 4

Lines based on data received.

FINAL-LABEL-LENGTH1

caLen[1]

CAL1CLGH

458-459

PBFN-RRTN-ADDRESSLINE1-LEN

PBFNAddressDataDef.sAddressLine1Len

FINAL-LABEL-LINE1

caLine[1]

CAL1ADDR

460-529

PBFN-RRTN-ADDRESSLINE1

PBFNLabelLineDef.cAddressLine1

FINAL-LABEL-LENGTH2

caLen[2]

CAL2CLGH

531-532

PBFN-RRTN-ADDRESSLINE2-LEN

PBFNLabelLineDef.sAddressLine2Len

FINAL-LABEL-LINE2

caLine[2]

CAL2ADDR

533-602

PBFN-RRTN-ADDRESSLINE2

PBFNLabelLineDef.cAddressLine2

FINAL-LABEL-LENGTH3

caLen[3]

CAL3CLGH

604-605

PBFN-RRTN-ADDRESSLINE3-LEN

PBFNLabelLineDef.sAddressLine3Len

FINAL-LABEL-LINE3

caLine[3]

CALN3CTY

606-675

PBFN-RRTN-ADDRESSLINE3

PBFNLabelLineDef.cAddressLine3

FINAL-ALT-LABEL-LENGTH2

caLen[4]

CAALCLGH

677-678

See FINAL-LABEL_RETURN_AREA for full explanation.

FINAL-ALT-LABEL-LINE2

caLine[4]

CAALADDR

679-748

If PBFN-ADRS-LACSSEEDHIT contains a blank, FINAL-ALT-LABELLINE2 contains the alternate label line.

If PBFN-ADRS-LACSSEEDHIT contains any other value, FINAL-ALT-LABEL-LINE2 contains the LACSLink seed detail record.

FINAL-MAIL-FIRM-NAME

caMailFirmName

CACMFIRM

749-788

These fields are not directly supported.

Consider using the pRtnAddressData.cFirm field (truncated if necessary).

FINAL-CITY-VANITY-NAME

caCityVanityName

CACTYVAN

789-801

Vanity names no longer used. Long, abbreviated, and non-mailing city names are now returned in individual fields.

Consider using the pRtnAddressData.cNonMailingCityName field.

FINAL-URB-RETURN

caURBReturn

CAURBRTN

802-831

PBFN-RRTN-URB

PBFNAddressDataDef.cUrb

FINAL-DEFAULT-IND

cDefault

CADFLT

832

PBFN-RRTN-DEFAULTMATCH

PBFNAddressDataDef.cMatch

FINAL-POUND-FIELD1

ca#Field1

CA#FLD1

833-842

All secondary info is now returned in the following fields.

PBFN-RRTN-UNIT-1 or PBFN-RRTN-UNIT-2

PBFNAddressDataDef.cUnit1 and PBFNAddressDataDef.cUnit2

FINAL-POUND-FIELD2

ca#Field2

CA#FLD2

843-852

All secondary info is now returned in the fields below.

PBFN-RRTN-UNIT1 or PBFN-RRTN-UNIT2

PBFNAddressDataDef.cUnit1 and PBFNAddressDataDef.cUnit2

FINAL-DPV-IND

caDPVIND

CADPVIND

853

PBFN-RRTN-DPVFLAGS

PBFNAddressDataDef.cDPVFlags[0]

FINAL-CMRA-IND

caDPVCMRA

CADPVCMR

854

PBFN-RRTN-DPVFLAGS

PBFNAddressDataDef.cDPVFlags[1]

FINAL-DPV-FALSE-POSITIVE

caDPVFalsePositive

CADPVFLS

855

 

FINAL-MATCH-LEVEL-IND

caMatchLevel

CAMATLVL

856

PBFN-RRTN-MATCHLEVEL

PBFNAddressDataDef.cMatchLevel

FINAL-LACS-SEED-HIT

cLacsSeedHit

CALACSSH

858

PBFN-ADRS-LACSSEEDHITPBFNAddressDataDef.LACSSeedHit.

FINAL-IDMSFLDS

caIDMSMessage

IDMSFLDS

859-892

The Finalist native interface no longer supports the IDMS operating system/platform.

FINAL-ISMSERMD

caIDMSModuleName

IDMSERMD

893-900

The Finalist native interface no longer supports the IDMS operating system/platform.

FINAL-SEASONAL-DATA

caSeasonInd

CASEASNL

901-912

PBFN-RRTN-SEASONALFLAGS

PBFNAddressDataDef.cSeasonalFlags

FINAL-SLK-RETURN-CODE

caSLKReturnCode   

CASLKRC

913-915

PBFN-RRTN-STELNKRTNCODE

PBFNAddressDataDef.cSteLnkRtnCode

FINAL-SLK-MATCH-CODE   

caSLKMatchCode

CASLKMC

916

PBFN-RRTN-STELNKMATCHCODE

PBFNAddressDataDef.cSteLnkMatchCode

FINAL-SLK-FIDELITY-CODE

caSLKFidelityCode

CASLKFC

917

PBFN-RRTN-STELNKFIDELITYCODE

PBFNAddressDataDef.cSteLnkFidelityCode

FINAL-DPV-SEED-HIT

caSeedViolationFlag

CASEEDFG

918

PBFN-RRTN-DPVSEEDHIT

sSeedViolationEncountered

FINAL-DPV-NCOAKEY-FLAG

caDPVKeyNCOAFlag

CADPNSTP

919

PBFN-RRTN-SEEDVIOLATIONENC

sDPVKeyNCOA