Postal Matcher Attributes for Hong Kong (HK) - 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
Administration
Overview
How Do I
Configuration
Reference
Installation
First publish date
2008

The table given below lists the Postal Matcher attributes for Hong Kong (HK).

Note: If you are using the new HK GAV tables delivered in June 2013 or later, the following output attributes are no longer generated:

hk_gout_delivery_office

hk_gout_beat_number

hk_gout_matched_bldg_on_street

hk_gout_postal_code_changed

Instead, the hk_gout_city_name attribute will be used to write the postal district name output.

Table 1. HK Postal Matcher Attributes

Attribute Name

Length

Description

hk_gin_area_name

30

Area name.

hk_gin_building

30

Building name.

hk_gin_city_name

30

Name of the postal city.

hk_gin_filler_01

4

Reserved for future use.

hk_gin_filler_02

6

Reserved for future use.

hk_gin_house_number

8

House number that typically precedes the street name.

hk_gin_house_number2

3

Overflow house number. For example, if the house number is 12345-12347, then hk_gin_house_number and hk_gin_house_number2 will contain 12345-12 and 347, respectively.

hk_gin_organization_name

30

Organization name.

hk_gin_record_type

1

Contains the built record type.

hk_gin_street_name

30

Street name.

hk_gin_sub_building

25

Unit type within a building, such as Apt.

hk_gin_delivery_office

3

Delivery office code.

Note: This attribute is not generated if you are using the Hong Kong GAV table for June 2013 or later.

hk_gout_area_name

30

Area name.

hk_gout_beat_number

5

Delivery beat code.

Note: This attribute is not generated if you are using the Hong Kong GAV table for June 2013 or later.

hk_gout_building

30

Building name.

hk_gout_building_street

30

Street name of the building.

hk_gout_city_name

30

District name.

hk_gout_city_state_changed

1

If Y, indicates the city state name output is different from the input.

hk_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.

hk_gout_delivery_address1

50

Output delivery address 1. It is formatted as "dwelling building/complex name. "

hk_gout_delivery_address2

50

Output delivery address 2.

hk_gout_delivery_office

3

Delivery office code.

hk_gout_house_number

11

House number.

hk_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

   1—City/Province failure

   2—Street name failure

   3—House number range failure

   4—Street component failure

   5—Multiple possible matches to table

hk_gout_matched_bldg_on_street

1

Matched street, including the building.

Note: This attribute is not generated if you are using the Hong Kong GAV table for June 2013 or later.

hk_gout_number_of_changes

1

Number of changes.

hk_gout_postal_code_changed

1

If Y, indicates the postal code is different from the input.

Note: This attribute is not generated if you are using the Hong Kong GAV table for June 2013 or later.

hk_gout_record_type

1

Record type.

hk_gout_street_components_changed

1

If Y, indicates the street components output is different from the input.

hk_gout_street_name

30

Contains the street name.

hk_gout_street_name_changed

1

If Y, indicates the street name output is different from the input.

hk_gout_sub_building

15

Unit type within a building, such as Apt.

hk_gout_sub_building_of

5

Building in which the sub-building exists.

hk_gout_sub_building_value

10

Unit value within a building, such as Apt # or Unit #.