Postal Matcher Attributes for the United Kingdom (GB) - trillium_discovery - trillium_quality - 17.1

Trillium Input/Output Attributes Reference Guide

Product type
Software
Portfolio
Verify
Product family
Trillium
Product
Trillium > Trillium Discovery
Trillium > Trillium Quality
Version
17.1
Language
English
Product name
Trillium Quality and Discovery
Title
Trillium Input/Output Attributes Reference Guide
Topic type
How Do I
Administration
Installation
Overview
Reference
Configuration
First publish date
2008
ft:lastEdition
2024-02-22
ft:lastPublication
2024-02-22T07:11:30.316879

The table given below lists the Postal Matcher attributes for the United Kingdom.

Table 1. GB Postal Matcher Attributes

Attribute Name

Length

Description

gb_gin_building

30

Building or house name.

gb_gin_county_posttown_code

10

County or post town code.

gb_gin_dpnd_locality_code

5

Double-dependent locality code.

gb_gin_dpnd_thorough_desc

15

Dependent thoroughfare description (type).

gb_gin_dpnd_thorough_name

30

Dependent thoroughfare name, direction.

gb_gin_house_number

10

House number.

gb_gin_locality_code

5

Locality code.

gb_gin_organization_name

30

Organization name.

gb_gin_pobox

6

PO Box number.

gb_gin_postal_code

8

Postal code.

gb_gin_record_type

1

Pre-defined record type.

1 - Street Record

3 - PO Box Record

4 - Error Record. Record does not conform to any of the other types.

5 - House Record

6 - Building/Postal Record

gb_gin_sub_building

30

Type and value: for example, Flat or Flat #.

gb_gin_sub_building_value

10

Value only (1).

gb_gin_thorough_desc

15

Descriptor (type).

gb_gin_thorough_name

30

Thoroughfare name, direction.

gb_gout_building

50

Building or house name.

gb_gout_building_changed

1

This flag is set to Y if the match level code is 0, 4, or 5, and the building name changed from the original input.

gb_gout_completion_code

1

Return code.

  • 0 = Incomplete Address. Not matched to GAV table. Check the Match Level Code for more information.
  • 1 = Matched Address.

gb_gout_county_code

5

County code.

gb_gout_county_name

30

County name.

Note: Royal Mail no longer includes county name in the GAV table it provides. County names that are available pre-date 1996.

gb_gout_delivery_address

100

Stores the first line of delivery address. It is built using the following attributes:

gb_gout_house_number + gb_gout_thorough_name + gb_gout_thorough_desc

OR

gb_gout_thorough_name + gb_gout_pobox (or gb_gout_house_number if gb_gout_pobox is empty)

gb_gout_delivery_address_2

100

Stores the second line of delivery address. It is built using the following attributes:

gb_gout_sub_building + gb_gout_sub_building_value + gb_gout_building

gb_gout_delivery_point

2

Delivery point suffix.

gb_gout_department

60

Stores the department name.

Note: To display the department names, the Use Postal Extensions option must be checked to use the postal extension table (GBEXDATA.tbl). The postal extension table is included in the GB GAV tables delivered in September 2014 or later.
Note: This is a new attribute for v15 Update 1. If you import or migrate your old or legacy projects after installing v15 Update 1, the new attribute will be automatically applied upon import or migration. If you import or migrate your old or legacy projects in v15 and then install v15 Update1, the new attribute will be applied when you run the GB Postal Matcher process.

gb_gout_dpnd_locality_code

5

Double-dependent locality code.

gb_gout_dpnd_locality_name

30

Double-dependent locality name.

gb_gout_dpnd_thorough_desc

15

Descriptor (type).

gb_gout_dpnd_thorough_name

30

Dependent thoroughfare name.

gb_gout_dps_checksum

1

Delivery point checksum value.

gb_gout_house_number

10

House number.

gb_gout_locality_changed

1

This flag is set to Y if the match level code is 0, 4, or 5, and if any of the following occurs:

  • Output locality code changed from input locality code.
  • Output double-dependent locality code changed from input double-dependent locality code.
  • Output post town code changed from input county or post town code (position 5-9).
  • Output county code changed from input county or post town code (position 0-4).

gb_gout_locality_code

5

Locality code.

gb_gout_locality_name

30

Locality name.

gb_gout_match_level

1

Numeric code to identify the level at which the address matched, or failed to match, the GAV tables.

Values are:

0=exact match to table

1=city/province failure

2=street name failure

3=house number range failure

4=street component failure

5=multiple possible matches to table

gb_gout_organization_changed

1

This flag is set to Y if the match level code is 0, 4, or 5 and the organization changed from the original input.

gb_gout_organization_key

8

Organization key provided by the PAF file.

gb_gout_organization_name

60

Organization name.

Note: The length of gb_gout_organization_name is extended from 30 to 60 in v15 Update 1. To display the extended version of organization names, the Use Postal Extensions option must be checked to use the postal extension table (GBEXDATA.tbl). The postal extension table is included in the GB GAV tables delivered in September 2014 or later.
Note: If you import or migrate your old or legacy projects after installing v15 Update 1, the new attribute length will be automatically applied upon import or migration. If you import or migrate your old or legacy projects in v15 and then install v15 Update1, the new attribute length will be applied when you run the GB Postal Matcher process.

gb_gout_paf_key

8

Key provided from the PAF file.

gb_gout_pobox

6

PO box number.

gb_gout_postal_code

7

Postal code.

gb_gout_postal_code_in

3

Postal code inbound.

gb_gout_postal_code_out

4

Postal code outbound.

gb_gout_postcode_changed

1

This flag is set to Y if the match level code is 0, 4, or 5 and the postcode changed from the original input.

gb_gout_postcode_type

1

Postcode type. Values are:

L—Large user

S—Small user or street

gb_gout_posttown_code

5

Post town code.

gb_gout_posttown_name

30

Post town name.

gb_gout_street_name_changed

1

This flag is set to Y if the match level code is 0, 4, or 5 and the street name changed from the original input.

gb_gout_street_type_changed

1

This flag is set to Y if the match level code is 0, 4, or 5 and the street type changed from the original input.

gb_gout_sub_building

30

Sub-building name. For example, Flat or Flat #.

gb_gout_sub_building_changed

1

This flag is set to Y if the match level code is 0, 4, or 5 and the sub-building name changed from the original input.

gb_gout_sub_building_value

10

Sub-building value only.

gb_gout_thorough_desc

15

Descriptor (type).

gb_gout_thorough_name

30

Thoroughfare name.

gb_gout_udprn

8

Stores a UDPRN (Unique Delivery Point Reference Number), an 8-character numeric code to identify the PAF addresses.

Note:  This is a new attribute for v15 Update 1. If you import or migrate your old or legacy projects after installing v15 Update 1, the new attribute will be automatically applied upon import or migration. If you import or migrate your old or legacy projects in v15 and then install v15 Update1, the new attribute will be applied when you run the GB Postal Matcher process.