Includes the part of address up to, but not including, the locality "last line." The word order, which represents the position of the address components, must be the normal word order used in your data population.

These must be passed in one field. Based on table design, your application might need to concatenate these attributes into one field before calling SSA-NAME3. For example, in the U.S., a typical string to pass consists of the following attributes:

Care-of + Building Name + Street Number + Street Name + Street Type + Apartment Details

The default key length of the

Address_Part1

field is 8 bytes. You can change the key length to 5 bytes by using the

KEY_SIZE

control. Matching on

Address_Part1

uses methods and options designed specifically for addresses. The Population Override Manager or the Edit Rule Wizard can override the Edit-List rules of the algorithm that uses the

Address_Part1

field.

It is also possible to supply the entire address in the

Address_Part1

field for matching. The application might pass multiple addresses (such as a residential address and a postal address) in the one call to SSA-NAME3.

Includes the "locality" line in an address. For example, in the U.S., a typical string to pass consists of the following attributes:

City + State + Zip (+ Country)

Matching on

Address_Part2

uses methods and options designed specifically for addresses. It uses the same Edit-List as

Address_Part1

. The Population Override Manager or the Edit Rule Wizard can override the Edit-List rules of the algorithm that uses the

Address_Part2

field.

The default key length of the

Address_Part2

field is 8 bytes. You can change the key length to 5 bytes by using the

KEY_SIZE

control.

Use the

Attribute 1

and

Attribute 2

fields for general purpose. The fields use a general purpose string matching algorithm that compensates for transpositions and missing characters or digits.

The Population Override Manager or the Edit Rule Wizard can override the Edit-List rules of the algorithm that uses the

Attribute 1

and

Attribute 2

fields. Define any rules for the

Attribute 1

and

Attribute 2

fields as character rules, which replace or remove strings or numbers that include special characters or delimiters.

The default key length of the

Attribute 1

and

Attribute 2

fields is 8 bytes. You can change the key length to 5 bytes by using the

KEY_SIZE

control.

The

Code

field indexes and searches for any value that is in the alphanumeric or numeric format, such as credit card number, telephone number, Vehicle Identification Number, date, product code, and International Standard Book Number. The

Code

field uses an algorithm that overcomes any errors or variations that are common across the code entities, such as missing digits, different digit orders, and special characters.

The Population Override Manager or the Edit Rule Wizard can override the Edit-List rules of the algorithm that uses the

Code

field. Define any rules for the

Code

field as character rules, which replace or remove strings or numbers that include special characters or delimiters.

The key length of the

Code

field is 12 bytes.

Matches the names of organizations, which can be business names, institution names, department names, agency names, product names, or trading names. The

Company_Name

field matches a single name or a compound name such as a legal name and its trading style. The

Company_Name

does not include the person name rules.

The Population Override Manager or the Edit Rule Wizard can override the Edit-List rules of the algorithm that uses the

Company_Name

field.

The default key length of the

Company_Name

field is 8 bytes. You can change the key length to 5 bytes by using the

KEY_SIZE

control.

The

CreditCard

field indexes and searches the credit card numbers, which are generally a 16-digit number. A credit card is electronically associated with a bank, a customer, and the customers' accounts. The

CreditCard

field uses an algorithm that overcomes any errors or variations, such as different industry identifiers, issuer identifiers, account numbers, special characters, embedded spaces, different digit orders, and missing or extra digits.

The Population Override Manager or the Edit Rule Wizard can override the Edit-List rules of the algorithm that uses the

CreditCard

field. Define any rules for the

CreditCard

field as character rules, which replace or remove strings or numbers that include special characters or delimiters.

The key length of the

CreditCard

field is 12 bytes.

The

Date

field indexes and searches for any types of date, such as expiry date, date of contract, date of change, and creation date. Use the

Day+Month+Year

format for a date. The algorithm uses the methods and options designed specifically for dates to overcome any errors or variations that are common in the date format.

The Population Override Manager or the Edit Rule Wizard can override the Edit-List rules of the algorithm that uses the

Date

field. Define any rules for the

Date

field as character rules, which replace or remove strings or numbers that include special characters or delimiters.

The default key length of the

Date

field is 8 bytes. You can change the key length to 5 bytes by using the

KEY_SIZE

control.

Use the Geocode field to index and search the records based on latitude and longitude geographic coordinates with an optional elevation. Specify the elevation value with its unit after the geographic coordinates. The supported units for elevation are ft (feet), km (kilometer), and m (meter). Negative elevation represents depths below the sea level.

The default key length of the

Geocode

field is 8 bytes. You can change the key length to 5 bytes by using the

KEY_SIZE

control.

Use the

ID

field to match any type of ID number such as account number, customer number, credit card number, drivers license number, passport, policy number, SSN or other identity code, product identifier, or VIN. The

ID

field uses a string-matching algorithm that compensates for transpositions and missing characters or digits.

The Population Override Manager or the Edit Rule Wizard can override the Edit-List rules of the algorithm that uses the

ID

field. Define any rules for the

ID

field as character rules, which replace or remove strings or numbers that include special characters or delimiters.

The key length of the

ID

field is 12 bytes.

The

ISBN10

and

ISBN13

fields index and search the International Standard Book Number (ISBN). The International Standard Book Number is a unique code that identifies the commercial books. Use the

ISBN10

field to search for a 10-digit number, and use the

ISBN13

field to search for a 13-digit number.

The Population Override Manager or the Edit Rule Wizard can override the Edit-List rules of the algorithm that uses the

ISBN10

and

ISBN13

fields. Define any rules for the

ISBN10

and

ISBN13

fields as character rules, which replace or remove strings or numbers that include special characters or delimiters.

The key length of the

ISBN10

and

ISBN13

fields is 12 bytes.

Matches the names of organizations, which can be business names, institution names, department names, agency names, or trading names.

The

Organization_Name

field matches a single name or a compound name such as a legal name and its trading style. The

Organization_Name

field includes the person name rules. The Population Override Manager or the Edit Rule Wizard can override the Edit-List rules of the algorithm that uses the

Organization_Name

field.

The default key length of the

Organization_Name

field is 8 bytes. You can change the key length to 5 bytes by using the

KEY_SIZE

control.

Used to match the names of people. An application must pass the full person name. The word order represents the position of the first name, middle names, and family names. It must be the normal word order used in your data population. For example, in English speaking countries, the normal word order is as follows:

First Name + Middle Name(s) + Family Name(s)

Based on table design, your application might have to concatenate these separate fields into one field before calling SSA-NAME3.

The default key length of the

Person_Name

field is 8 bytes. You can change the key length to 5 bytes by using the

KEY_SIZE

control.

This field supports matching on a single name, or an account name such as

JOHN and MARY SMITH

. The application might pass multiple names such as a married name and a former name in the one call to SSA-NAME3.

The Population Override Manager or the Edit Rule Wizard can override the Edit-List rules of the algorithm that uses the

Person_Name

field.

Use the

Postal_Area

field to place more emphasis on the postal code than if it were included in the

Address_Part2

field. Use this field for all types of postal codes, including ZIP codes. This field uses a string matching algorithm that compensates for transpositions and missing characters or digits.

The Population Override Manager or the Edit Rule Wizard can override the Edit-List rules of the algorithm that uses the

Postal_Area

field. Define any rules for the

Postal_Area

field as character rules, which replace or remove strings or numbers that include special characters or delimiters.

The default key length of the

Postal_Area

field is 8 bytes. You can change the key length to 5 bytes by using the

KEY_SIZE

control.

The

Telephone_Number

field indexes and searches different variations of the telephone numbers. The

Telephone_Number

field uses a string-matching algorithm that overcomes any errors or variations, such as incorrect area code or country code, special characters, embedded spaces, different digit orders, use of symbols such as plus (+), transpose errors, concatenated digits, deletion or omission of digits, insertion errors, substitution errors, and transpositions.

The Population Override Manager or the Edit Rule Wizard can override the Edit-List rules of the algorithm that uses the

Telephone_Number

field. Define any rules for the

Telephone_Number

field as character rules, which replace or remove strings or numbers that include special characters or delimiters.

The key length of the

Telephone_Number

field is 12 bytes.

The

VIN

field indexes and searches the Vehicle Identification Number (VIN). It is a unique code that identifies individual motor vehicles, towed vehicles, motorcycles, scooters, or mopeds. The

VIN

field uses an algorithm that overcomes any errors or variations, such as vehicle manufacturer codes, special characters, embedded spaces, different letter or digit orders, transpose errors, concatenated digits, transpositions, and sequence variations.

The Population Override Manager or the Edit Rule Wizard can override the Edit-List rules of the algorithm that uses the

VIN

field. Define any rules for the

VIN

field as character rules, which replace or remove strings or numbers that include special characters or delimiters.

The key length of the

VIN

field is 12 bytes.

This Purpose identifies an address match. The address might be postal, residential, delivery, descriptive, formal, or informal.

This Match purpose is used after a search by

Address_Part1

.

Field	Required
Address_Part1	Yes
Address_Part2	No
Postal_Area	No
Telephone_Number	No
ID	No
Date	No
Attribute1	No
Attribute2	No
Geocode	No
Code	No

If you use the name of a city, state, or both as

Address_Part2

, the field helps differentiate between a common street address [100 Main Street] in different locations.

To achieve a best score between

Address_Part2

and

Postal_Area

, pass

Postal_Area

as a repeat value in the

Address_Part2

field.

For example:

*Address_Part2*100 Main St*Address_Part2*06870***

In this example, the

Address_Part2

score uses the highest of the two scored fields.

The

AuthorISBN

purpose identifies and matches an author for the specified book with an International Standard Book Number. You can use this purpose after a search by book number, author, or both.

You can use the ISBN 10-digit number or 13-digit number based on your requirement to achieve a best score.

The

CC_Issuer

purpose identifies and matches the organization that issues credit card to the customers. You can use this purpose when you search for a credit card or the credit card-issuing organization.

The

CC_Owner

purpose identifies and matches the credit card owner and the address. You can use this purpose after a search by person name, credit card number, or telephone number. You can provide the locality, state, or post or ZIP code in the

Address_Part2

field to achieve a best score. You can increase the weight of the post or ZIP code by using the

Postal_Area

field.

To achieve a best score between the

Address_Part1

and

Postal_Area

fields, specify

Postal_Area

as a repeat value in the

Address_Part2

field.

This purpose identifies a contact within an organization at a specific location. This Match purpose is used after a search by

Person_Name

. However, either

Organization_Name

or

Address_Part1

could be used as the search criteria.

For ultimate quality, a tiered search using two or all three of these fields could be used in the search. An example of a tiered search is a

Person_Name

search followed by a

Address_Part1

search).

To achieve a best score between

Address_Part2

and

Postal_Area

, pass

Postal_Area

as a repeat value in the

Address_Part2

field.

For example:

*Address_Part2*100 Main St*Address_Part2*06870***

In this example, the

Address_Part2

score uses the highest of the two scored fields.

The

Corp_Entity

purpose identifies an organization based on its legal corporate name, including the legal endings such as

INC

and

LTD

. Use the

Corp_Entity

purpose in applications that honor differences between names such as

ABC TRADING INC

and

ABC TRADING LTD

.

Use this purpose after you perform a search based on

Organization_Name

.

It is in essence the same purpose as Organization, except that tighter matching is performed and legal endings are not treated as noise.

To achieve a best score between

Address_Part2

and

Postal_Area

, pass

Postal_Area

as a repeat value in the

Address_Part2

field.

For example:

*Address_Part2*100 Main St*Address_Part2*06870***

In this example, the

Address_Part2

score uses the highest of the two scored fields.

The

Division Purpose

identifies an Organization at an Address. It is used after a search by

Organization_Name

or by

Address_Part1

, or both.

It is in essence the same purpose as Organization, except that

Address_Part1

is a required field. Thus, this purpose matches organization X at address Y or Z if multiple addresses are supplied.

To achieve a best score between

Address_Part2

and

Postal_Area

, pass

Postal_Area

as a repeat value in the

Address_Part2

field.

For example:

*Address_Part2*100 Main St*Address_Part2*06870***

In this example, the

Address_Part2

score uses the highest of the two scored fields.

The

Family

purpose identifies matches where individuals with the same or similar family names share the same address

or

the same telephone number.

This purpose is used after a tiered search (multisearch) by

Address_Part1

and

Telephone_Number

.

Emphasis is placed on the Last Name, or "Major Word" of the

Person_Name

field. This is one of the few cases where word order is important in the way the records are passed to SSA-NAME3 for matching.

However, a reasonable score is generated provided that a match occurs between the major word in one name and any other word in the other name.

To achieve a best score between

Address_Part2

and Postal_Area, pass

Postal_Area

as a repeat value in the

Address_Part2

field.

For example:

*Address_Part2*100 Main St*Address_Part2*06870***

In this example, the

Address_Part2

score uses the highest of the two scored fields.

The Purpose is provided for general nonspecific use. It is designed in such a way that there are no required fields. All field types are available as optional input fields.

One way this Purpose could be used is as a non-exact match filter before applying some other Match Purpose. For exact match filters, use the

Filter

Purpose. For example, before passing a record to the

Division

Purpose, use the

Fields

Purpose to eliminate any organization with

ID

numbers which do not score above 80%. To do this, the application first passes the

ID

numbers to SSA-NAME3 for matching using

PURPOSE=FIELDS

. It then decides based on the score returned whether to pass the full records for matching by the

Division

Purpose.

The

Filter

Purpose is provided so that the application can perform exact match filtering based on the setting of one or more flags in the records. One call to

ssan3_match

can use up to nine Filters

(Filter1-9)

.

Field	Required
Filter1-9	Yes

For example, say an index supported searching and matching across two types of names: Organization names (identified by a Name-Type-Flag of "C"), and Person names (identified by a Name-Type-Flag of "P"). A search application might need to support searches across both name types and within each name type. To support the "within each name type" search, the application can use the Filter Purpose to filter out exact matches based on the name type flag.

The fields

Filter1-9

can be any code or flag.

For non-exact filtering, use the

Fields

Purpose.

The Household purpose identifies matches where individuals with the same or similar family names share the same address.

This purpose is used after a search by

Address_Part1

. It is not practical to search by

Person_Name

. It is because ultimately one word from the

Person_Name

needs to match, and a one-word search does not perform well in most situations.

Field	Required
Person_Name	Yes
Address_Part1	Yes
Address_Part2	No
Postal_Area	No
Telephone_Number	No
Attribute1	No
Attribute2	No
Geocode	No
Code	No

Emphasis is placed on the Last Name, or "Major Word" of the

Person_Name

field. This is one of the few cases where word order is important in the way the records are passed to SSA-NAME3 for matching.

However, a reasonable score is generated provided that a match occurs between the major word in one name and any other word in the other name.

To achieve a best score between

Address_Part2

and

Postal_Area

, pass

Postal_Area

as a repeat value in the

Address_Part2

field.

For example:

*Address_Part2*100 Main St*Address_Part2*06870***

In this example, the

Address_Part2

score uses the highest of the two scored fields.

This Purpose identifies a specific individual by name and with either the same ID number or Date of Birth attributes.

It is typically used after a search by

Person_Name

.

Field	Required
Person_Name	Yes
ID	At least one
Date	of these two
Attribute1	No
Attribute2	No
Code	No

The Organization Purpose matches organizations primarily by name. It is targeted at online searches when a name-only lookup is required and a human is available to make the choice. Matching in batch requires other attributes in addition to name to make match decisions.

To achieve a best score between

Address_Part2

and

Postal_Area

, pass

Postal_Area

as a repeat value in the

Address_Part2

field.

For example:

*Address_Part2*100 Main St*Address_Part2*06870***

In this example, the

Address_Part2

score uses the highest of the two scored fields.

This Purpose identifies a person by name. It is targeted at online searches when a name-only lookup is required and a human is available to make the choice. Matching in batch requires other attributes in addition to name to make match decisions.

To achieve a best score between

Address_Part2

and

Postal_Area

, pass

Postal_Area

as a repeat value in the

Address_Part2

field.

For example:

*Address_Part2*100 Main St*Address_Part2*06870***

In this example, the

Address_Part2

score uses the highest of the two scored fields.

The

PublisherISBN

purpose identifies and matches the publishing organization for a specified book with an International Standard Book Number (ISBN). The ISBN can be a 10-digit number or a 13-digit number. You can use this purpose after a search by book number, publisher, or both.

You can provide the locality, state, or post or ZIP code in the

Address_Part2

field to achieve a best score. You can increase the weight of the post or ZIP code by using the

Postal_Area

field.

The Resident Purpose identifies a person at an address.

This purpose is used after a search by either

Person_Name

or

Address_Part1

, or both in a multi-search.

To achieve a best score between

Address_Part2

and

Postal_Area

, pass

Postal_Area

as a repeat value in the

Address_Part2

field.

For example:

*Address_Part2*100 Main St*Address_Part2*06870***

In this example, the

Address_Part2

score uses the highest of the two scored fields.

The

VIN_Manufacturer

purpose identifies and matches the manufacturer of a vehicle for a specified vehicle number. You can use this purpose after a search by vehicle number, vehicle manufacturer, or both. You can provide the locality, state, or post or ZIP code in the

Address_Part2

field to achieve a best score. You can increase the weight of the post or ZIP code by using the

Postal_Area

field.

You can provide the locality, state, or post or ZIP code in the

Address_Part2

field to achieve a best score. You can increase the weight of the post or ZIP code by using the

Postal_Area

field.

The

VIN_Owner

purpose identifies and matches the owner of a vehicle. You can use this purpose after a search by the person name who is the owner of the vehicle, vehicle number, or both. You can provide the locality, state, or post or ZIP code in the

Address_Part2

field to achieve a best score. You can increase the weight of the post or ZIP code by using the

Postal_Area

field.

You can provide the color and the body type of the vehicle as the

Attribute1

and

Attribute2

fields for a best score. You can increase the weight of the post or ZIP code by using the

Postal_Area

field.

This Purpose loosely identifies a contact within an organization, without regard to the location.

It is used after a search by

Person_Name

. However, a second search by

Organization_Name

can be used to get better quality.

The

Wide_Household

purpose identifies matches where the same address is shared by individuals with the same family name or with the same telephone number.

This purpose is used after a search by

Address_Part1

.

Emphasis is placed on the Last Name, or "Major Word" of the

Person_Name

field. This is one of the few cases where word order is important in the way the records are passed to SSA-NAME3 for matching.

However, a reasonable score is generated provided that a match occurs between the major word in one name and any other word in the other name.

To achieve a best score between

Address_Part2

and

Postal_Area

, pass

Postal_Area

as a repeat value in the

Address_Part2

field.

For example:

*Address_Part2*100 Main St*Address_Part2*06870***

In this example, the

Address_Part2

score uses the highest of the two scored fields.