Defines the field on which you want to build search ranges. With most standard populations, you can use one of the following predefined fields:

You can use only one key field in a function call.

Optional. Specifies the type of search level that you want to perform. With most standard populations, you can use one of the following predefined values:

Typical
Exhaustive
Extreme
Narrow

The default value is Typical.

Optional. Specifies the length of the SSA-NAME3 keys that you want to return. Use the same value that you have set for the ssan3_get_keys function. The default key-size for both the ssan3_get_keys and ssan3_get_ranges functions is 8 bytes.

For some applications and database designs, you can use a smaller and more compressed key. In this case, specifying the

KEY_SIZE

to 5 instructs SSA-NAME3 to build the 5-byte binary key instead of the 8-byte character key.

In IBM DB2 UDB, set the

IDENTITY

option when you create the database so that the collating sequence of the 8-byte character keys is correct. Alternatively, you can use the 5-byte binary keys.

Optional. Defines whether the major word in the name or address is on the left end or the right end. For example, in Western person names, the family name is on the right end of the names.

Use the

NAMEFORMAT

control to override the default name format. For more information about the default name format for a given standard population field and its effects, from the

Help

menu of SSA-NAME3 Workbench, click

Population Documentation

.

Optional. Instructs SSA-NAME3 to accept Unicode data input, and specifies the Unicode format of the data that you want to pass.

Optional. Specifies the maximum percentage of the file that is allowed to be returned in any one search. This can be helpful in preventing costly searches. The percentage value is a number up to 2 decimal places. When the function is called, the Search Strategy is evaluated before any database I/O is done. If it is calculated that the search would return a greater percentage of the file than allowed, an error message will be returned to the calling program.

Optional. Indicates the order of the latitude and longitude coordinates that you specify to build search ranges.

If

GEOCODE_FORMAT=1

, SSA-NAME3 considers the geographic coordinates in the following order:

*Geocode*<Longitude> <Latitude>***

If

GEOCODE_FORMAT=0

, SSA-NAME3 considers the geographic coordinates in the following order:

*Geocode*<Latitude> <Longitude>***

The default value is 0.

Optional. Indicates the search radius to build search ranges according to the latitude and longitude coordinates that you specify. The default value is 1000 m, and the default unit is meter.

For example:

FIELD=GEOCODE GEOCODE_FORMAT=1 GEOCODE_RADIUS=100

Use the following guidelines when you specify the geocode radius:

SSA-NAME3 considers the radius to be in meters even if you specify any other unit.
SSA-NAME3 ignores the decimal values and uses the whole number as the radius. For example, if you specify the radius as 850.8, SSA-NAME3 considers the radius as 850.

Use one or more of the following keywords:

FIRSTMINORPROBE
.
Builds an additional probe for the first minor word. For example, if the name is
PEPE JONES
, the
FIRSTMINORPROBE
keyword builds an additional probe for the first minor word,
PEPE
.
ORIGWORDRANGE
. Builds an additional search range based on the unformatted words after cleaning and stabilization, but without processing the Edit-list definitions.
CONCMINORRANGE
. Builds an additional search range after concatenating the first two minors. For example, if the name is
JONG KU LEE
where
LEE
is the major word, the
CONCMINORRANGE
keyword builds a search range for
JONGKU LEE
.
INITRANGE
. Builds an additional search range for the acronym of the name. For example, if the name is
THE ATLANTIC AND PACIFIC TEA COMPANY
, the
INITRANGE
keyword builds a range for
APT*
.
INITPROBE
. Builds an additional probe for the acronym of the search name. For example, if the name is
THE ATLANTIC AND PACIFIC TEA COMPANY
, the
INITRANGE
keyword builds a range for
APT!
.
DEBUG
. Builds additional data that explains how SSA-NAME3 constructs each key based on the word stack order for troubleshooting purposes.
FMTOVERRIDES
. Specifies whether to disable or override a list of category names and category types.
Use the following format:
FMTOVERRIDES=*cX,cX,cX,cX*
The format uses the following values:
c. Use one of the following values:
N
- Disables the specified edit-list category names during key generation process.
T
- Disables the specified edit-list category types during key generation process.
X
- Overrides the specified edit-list category type with another category type.
Y
- Overrides the specified edit-list category name with another category type.
X. Denotes the category name or the category type in the edit-list that you want to disable or override.
The following sample configuration indicates that SSA-NAME3 must override
Noise Words
category name with
Skip
category type:
Controls: 'FIELD=Organization_Name
NM3KEYWORDS=FMTOVERRIDES=*,,YNWS,*'
Key Field Data: '*Organization_Name*The David Ford***'
For the preceding sample configuration, SSA-NAME3 retains the word
THE
in the word stack because of the value
YNWS
in the
FMTOVERRIDES
keyword.
The FMTOVERRIDES keyword is also applicable for extended fields.