Postal Matcher Attributes for Canada (CA) - trillium_discovery - trillium_quality - 17.2

Trillium Input/Output Attributes Reference Guide

Product type
Software
Portfolio
Verify
Product family
Trillium
Product
Trillium > Trillium Discovery
Trillium > Trillium Quality
Version
17.2
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 Canada (CA).

Table 1. CA Postal Matcher Attributes

Attribute Name

Length

Description

ca_gin_building

30

Building name.

ca_gin_city_name

30

Area name.

ca_gin_filler

8

Reserved for future use.

ca_gin_house_number

10   

House number.

ca_gin_organization_name

30

Organization name.

ca_gin_postal_code

6

Postal code containing original post code from the input record.

ca_gin_province_name

2

Province name code. Values are:

NF—Newfoundland and Labrador

NS—Nova Scotia

PE—Prince Edward Island

NB—New Brunswick

QC—Quebec

ON—Ontario

MB—Manitoba

SK—Saskatchewan

AB—Alberta

BC—British Columbia

NT—Northwest Territories

YT—Yukon

NU—Nunavut

ca_gin_record_type

1

Address type. Values are:

1—Street Record

2—Route Record

3—PO Box Record

4—All Records that don't fit any other type

6—Street with Route Record

E—Pattern Error Record

F—Foreign Record

ca_gin_route_number

10

Route number.

ca_gin_route_type

20

Route type. Values are:

RR—Rural Route

SS—Suburban Service

MR—Mobile Route

GD—General Delivery

ca_gin_street_direction

2

Street direction. Values are:

N—North/Nord

S—South/Sud

E—East/Est

W—West

O—Ouest

NE—North East/Nord-est

NW/NO—North West/Nord-Ouest

SE—South East/Sud-est

SW/SO—South West/South-Ouest

ca_gin_street_name

30

Street name.

ca_gin_street_type

6

Street type.

ca_gin_sub_building

30

Unit type within a building.

ca_gin_sub_building_value

10

Unit value within a building.

ca_gout_a1_questionable_flag

1

If set to Y, indicates that an A1 record is determined to be valid but questionable because (1) the GAV table does not include a suite range for this address and (2) the record does not include a suite number.

Note: An A1 record is one in which the ca_gout_record_type attribute is set to A and the ca_gout_address type is set to 1.

ca_gout_abbr13_city_name

30

A 13-character abbreviation for city name. This only takes place if the Match Level Code is 0. The original city name will be returned if there is no abbreviated name available.

ca_gout_abbr18_city_name

30

A 18-character abbreviation for city name. This only takes place if the Match Level Code is 0. The original city name will be returned if there is no abbreviated name available.

ca_gout_address_type

1

Address type. Values are:

1—Civic (street) address format

2—Delivery installation (station) address format

ca_gout_base_format_flag

1

French or English formatting indicator based on the information in ca_gout_base_street_type. Values are:

1—English formatting (Street Name, Street Type, Street Direction)

2—French formatting (Street Type, Street Name, Street Direction)

Note: This attribute is used in the default Transformer Data Reconstruction process. Canadian projects that were created in the previous version did not include this attribute. If an old Canadian project is imported or migrated and a new Transformer Data Reconstruction process is added, the user may need to add this attribute manually.

ca_gout_base_street_dir

2

Base street direction for alias street information.

ca_gout_base_street_name

30

Base street name for alias street information.

ca_gout_base_street_type

6

Base street type for alias street information.

ca_gout_building

30

Building name.

ca_gout_city_name

30

Area name.

ca_gout_city_prov_changed

1

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

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

ca_gout_conflict_pc

1

If Y, indicates a conflict between a PO box record and a non-PO box record.

ca_gout_cp_status

1

Canada Post status. Values are:

N—Not correctable

V—Verifiable

C—Correctable

O—Optional record

ca_gout_delivery_address

50

Reconstructed street address.

ca_gout_format_flag

1

French or English formatting. Values are:

   1—English formatting (Street Name, Street Type, Street Direction)

  2—French formatting (Street Type, Street Name, Street Direction) 

Note: This attribute is used in the default Transformer Data Reconstruction process. Canadian projects that were created before Version 13.5 did not include this attribute. If an old Canadian project is imported or migrated and a new Transformer Data Reconstruction process is added, the user may need to add this attribute manually.

ca_gout_filler

20

When the FORMAT_OPTION setting of the Canadian Postal Matcher is on (set to Y), the matcher program returns the second address line to this field. (The first line is returned to the 50-character ca_gout_delivery_address attribute.)

You can use the two fields separately for a two-line SERP address or combine them by appending ca_gout_delivery_address to ca_gout_filler to create a valid SERP delivery line that is effectively 70 characters long.  

ca_gout_house_number

10

House number.

ca_gout_install_name

30

Delivery Installation name.

ca_gout_install_qual

15

The qualifier name that uniquely identifies the delivery installation when more than one delivery installation serves and is described by the Delivery Installation Name.

ca_gout_install_type

15

Category of Delivery Installation. Values are:

BDP—Bureau De Post

CC—Concession Commerciale

CDO—Commercial Dealership Outlet

CMC—Community Mail Center

CPC—Centre Postal Communautaire

CSP—Comptoir Service Postal

LCD—Letter Carrier Depot

PDF—Poste Des Facteurs

PO—Post Office

RPO—Retail Postal Outlet

STN—Station

SUCC—Succursale

ca_gout_match_level

1

Contains the 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 Director

  6—Rural record failure

ca_gout_multiple_installations

1

Multiple installations.

ca_gout_number_of_changes

3

Numerical indicator for the number of changes to the output address.

ca_gout_organization_name

30

Organization name.

ca_gout_postal_code

6

Value from the table when there is a match to the street components, otherwise the original input post code is returned.

ca_gout_postal_code_changed

1

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

ca_gout_province_county

2

Province name. Values are:

NF—Newfoundland and Labrador

NS—Nova Scotia

PE—Prince Edward Island

NB—New Brunswick

QC—Quebec

ON—Ontario

MB—Manitoba

SK—Saskatchewan

AB—Alberta

BC—British Columbia

NT—Northwest Territories

YT—Yukon

NU—Nunavut

ca_gout_record_type

1

Values are:

1—Street address record

2—Street served by route record

3—Lock box address record

4—Route service address record

5—General delivery address record

A—Building name record

B—Large volume receiver name (Street) record

C—Government name (Street) record

D—Large volume receiver name (Lock Box) record

E—Government name (Lock box) record

F—General delivery name record

ca_gout_route_number

10

Secondary route number. Number that identifies a rural route, suburban service, or mobile route delivery mode.

ca_gout_route_type

2

Secondary route type. Values are:

RR—Rural Route

SS—Suburban Service

MR—Mobile Route

GD—General Delivery

ca_gout_rural_questionable_flag

1

If set to Y, indicates that the postal matcher determined that a match to a rural record is not a perfect match; also set to Y when the postal matcher returns a fail level of 6.

ca_gout_street_components_change

1

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

ca_gout_street_direction

2

Street direction. Values are:

N—North/Nord

S—South/Sud

E—East/Est

W—West

O—Ouest

NE—North East/Nord-est

NW/NO—North West/Nord-Ouest

SE—South East/Sud-est

SW/SO—South West/South-Ouest

ca_gout_street_name

30

Name of the street.

ca_gout_street_name_changed

1

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

ca_gout_street_type

6

Street type.

ca_gout_sub_building

30

Unit type within a building.

ca_gout_sub_building_value

10

Unit value within a building.