APPENDIX 17: TPAD - ADDITIONAL INFORMATION
Geosupport Warnings, TPAD Conflict Flag, Reason Code Qualifier and Error Message
The TPAD Option allows users to get up-to-date property-level information. The TPAD Option is available for Function 1A, BL, BN, and 1B calls (PAD calls). When users turn the TPAD Switch ‘on’ in their applications, Geosupport reads the Transitional PAD file (TPAD) for intra-cycle PAD data and if any is found, Geosupport returns the TPAD data to the calling application. See Chapter VI.11 for a more detailed description of the TPAD option and the information it returns.
This appendix describes the special return code and error message handling with respect to TPAD. If your applications make function 1A, BL, BN or 1B calls with the TPAD Option ‘on’, then you must read this description.
Geosupport is designed to return information about both a normal warning (e.g. Hyphen Deleted) and a TPAD Conflict situation (e.g. …No Existing PAD BBL) with only one Function 1A, BL, BN or 1B call (with TPAD Switch ‘on’) to Geosupport. The value in the Geosupport Reason Code will be the value that a user would expect when a Geosupport function call has completed with a warning. The TPAD Conflict Flag will be in Work Area 2 (WA2) for all PAD calls with the TPAD Option ‘on’. The ‘*’ Reason Code (which indicates a TPAD Warning) will appear in only one exceptional case. In the situation where there was no regular Warning Message for the regular PAD call and there was TPAD data found that conflicts with the PAD data, then the GRC will contain ‘01’ (indicating a warning) and the Reason Code will contain ‘*’ (indicating that there is only a TPAD Conflict Flag warning and no regular Geosupport warning).
In addition, if TPAD data is found and there is a conflict with the PAD data, the value in the WA2 Conflict Flag field will also be placed into a new field called the Geosupport Reason Code Qualifier field which immediately follows the Geosupport Reason Code field in Work Area 1 (WA1). When this new field is populated with the TPAD Conflict Flag, the TPAD Conflict Message will be put in the Geosupport Error Message field instead of the Geosupport Warning Message that would normally appear. Note, therefore, that if there was a Geosupport Warning involving the regular PAD portion of this call, the Reason Code field will indicate the nature of the warning as with all other Geosupport calls (but the Error Message field for this warning will be overridden by the TPAD Conflict message if a conflict exists).
Values of ‘0’ or ‘1’ in the TPAD Conflict Flag (in WA2) are considered ‘normal results’. ‘0’ signifies TPAD data was found and does not conflict with PAD data; ‘1’ signifies that no TPAD data was found. When there are ‘normal results’, the WA2 TPAD Conflict Flag will not be placed into the new Geosupport Reason Qualifier field in WA1.
The following table shows the possible results for Function 1A, BL, BN an 1B calls with the TPAD Switch ‘on’.
| Regular Geosupport Warning for PAD Call | ||||
|---|---|---|---|---|
| Yes | No | |||
| TPAD Data Found | TPAD Data Found | |||
| Work Area 1 Fields | Yes | No | Yes | No |
| Geosupport Return Code (GRC) |
01 | 01 | 01 | 00 |
| Reason Code | Warning Reason Code |
Warning Reason Code |
\* | blank |
| Reason Code Qualifier | TPAD Conflict Flag† |
blank | TPAD Conflict Flag† |
blank |
| Error Message | TPAD Conflict Flag† |
blank | TPAD Conflict Flag† |
blank |
| WA2 Conflict Flag | TPAD Conflict Flag | TPAD Conflict Flag | TPAD Conflict Flag | TPAD Conflict Flag |
† Note: The TPAD Conflict Flag appears in the Reason Code Qualifier only if its value is greater than ‘1’. Similarly, the TPAD Conflict Message will appear in the Error Message field, only if the TPAD Conflict field is greater than ‘1’. The TPAD Conflict Flag ‘1’ (no TPAD data was found) and the TPAD Conflict Flag ‘0’ (TPAD data found and it does not conflict with PAD data) will not appear in the Reason Code Qualifier field in WA1. The Error Message field will have a TPAD Conflict Message only when TPAD data was found and it conflicts with the PAD data in some way (and as a result, the Reason Code Qualifier will be non-blank). Note that if there is no Regular Geosupport Warning, and there is TPAD data which does not conflict with the PAD data (Conflict Flag ‘0’), the GRC will be ‘00’ the Reason Code, Reason Code Qualifier, and Error Message will all be blank.
See examples on the following pages.
Examples: PAD Data Found with Regular Warnings
| PAD Data (with regular Geosupport warning) and No TPAD Data Found | |
|---|---|
| Input: 12-34 Sample Street | |
| WA1 Fields | Value |
| GRC | 01 |
| Reason Code | 3 [indicates input address number altered – hyphen deleted] |
| Reason Code Qualifier | blank |
| Error Message | ADDR NUMBER ALTERED: HYPHEN DELETED |
| WA2 Conflict Flag | 1 |
| PAD Data (with regular Geosupport warning) and TPAD Data (with no conflicts) | |
|---|---|
| Input: 12-34 Sample Street | |
| WA1 Fields | Value |
| GRC | 01 |
| Reason Code | 3 [indicates input address number altered – hyphen deleted] |
| Reason Code Qualifier | blank |
| Error Message | ADDR NUMBER ALTERED: HYPHEN DELETED |
| WA2 Conflict Flag | 0 |
| PAD Data (with regular Geosupport warning) and TPAD Data (with conflicts) | |
|---|---|
| Input: 12-34 Sample Street | |
| WA1 Fields | Value |
| GRC | 01 |
| Reason Code | 3 [indicates input address number altered – hyphen deleted] |
| Reason Code Qualifier | D [indicates address in TPAD but not PAD (PAD data from BL call)] |
| Error Message | ADDRESS FOUND IN TPAD, NOT FOUND IN PAD…… |
| WA2 Conflict Flag | D |
Examples: PAD Data Found with No Regular Geosupport Warning
| PAD Data (with no regular Geosupport warning) and No TPAD Data Found | |
|---|---|
| Input: 1234 Sample Street | |
| WA1 Fields | Value |
| GRC | 00 |
| Reason Code | Blank |
| Reason Code Qualifier | Blank |
| Error Message | Blank |
| WA2 Conflict Flag | 1 |
| PAD Data (with no regular Geosupport warning) and TPAD Data (with no conflicts) | |
|---|---|
| Input: 1234 Sample Street | |
| WA1 Fields | Value |
| GRC | 00 |
| Reason Code | Blank |
| Reason Code Qualifier | Blank |
| Error Message | Blank |
| WA2 Conflict Flag | 0 |
| PAD Data (with no regular Geosupport warning) and TPAD Data (with conflicts) | |
|---|---|
| Input: 1234 Sample Street | |
| WA1 Fields | Value |
| GRC | 01 |
| Reason Code | * [indicates TPAD Conflict only; no regular warning] |
| Reason Code Qualifier | D [indicates address in TPAD but not PAD (PAD data from BL call)] |
| Error Message | ADDRESS FOUND IN TPAD, NOT FOUND IN PAD…….. |
| WA2 Conflict Flag | D |
The Reason Code Qualifier is used to define a specific TPAD warning. When there is a true conflict between TPAD data and PAD data, the Reason Code Qualifier contains the same information as the TPAD Conflict Flag.
The following table indicates where in Work Area 1 the one-byte Reason Code Qualifier field(s) may be found.
| (1 byte) Position | |||
|---|---|---|---|
| Field Name | Function(s) | COW | MSW |
| Reason Code Qualifier | 1A, BL, BN | 714 | n/a |
| Reason Code Qualifier 2 | 1B | 575 | n/a |
For Functions 1A, BL, and BN the Reason Code Qualifier is a one-byte field, in column 714 of COW Work Area 1. For Function 1B, the Reason Code Qualifier 2 is a one-byte field, in column 575 of COW Work Area 1.
The following table contains the field name in the COPY libraries for the Reason Code Qualifiers.
| Reason Code Qualifier(s) Field Names in COPY Libraries |
|||
|---|---|---|---|
| Language | COPY Library (COW Only) |
Function(s) (COW Only) |
Field Name |
| BAL | P1BAL | 1A, BL, BN 1B |
reason_code_qual reason_code_qual_2 |
| COBOL | P1COB | 1A, BL, BN 1B |
GEO-WA1-OUT-REASON-CODE-QUAL GEO-WA1-OUT-REASON-CODE-QUAL2 |
| Natural | GEOLP1 | 1A, BL, BN 1B |
PIWA1-OUT-REASON-CODE-QUAL PIWA1-OUT-REASON-CODE-QUAL-2 |
| PL/1 | P1PL1 | 1A, BL, BN 1B |
PIWA1_OUT_REASON_CODE_QUAL PIWA1_OUT_REASON_CODE_QUAL_2 |