FIELD=field name
[SEARCH_LEVEL=search level]
[NAMEFORMAT=name format]
[UNICODE_ENCODING=Unicode type]
[SEARCH_LIMIT=n]
[COMBINE=field name[:combine option]]
[GEOCODE_FORMAT=0|1]
[GEOCODE_RADIUS=n]

FIELD (Required)

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

Person_Name
Organization_Name
Address_Part1
Geocode
Product_Name

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

SEARCH_LEVEL (Optional)

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

Typical
Exhaustive
Extreme
Narrow

The default value is Typical.

The

SEARCH_LEVEL

control is not applicable to the Geocode field. If you specify the

SEARCH_LEVEL

control with a

Geocode

field, SSA-NAME3 ignores the

SEARCH_LEVEL

control.

NAMEFORMAT L/R (Optional)

Defines whether the major word in a 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

.

UNICODE_ENCODING (Optional)

Instructs

MDM Registry Edition

to accept Unicode data input, and specifies the Unicode format of the data that you want to pass.

SEARCH_LIMIT (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.

For the

Search_Limit

to be useful, the Population must include a Scalar Frequency Table. See the Population Override Manager for more details.

COMBINE (Optional)

This Control option concatenates multiple data fields. If

COMBINE

option is specified, any multiple data fields for which ranges need to be generated, are concatenated together before the range building process. The

COMBINE

fieldname must be the same as the FIELD parameter.

An optional combine option may be associated with the fieldname and can have the following possible values:

DELIM-NONE

: If this option is set, when concatenating multiple data fields there is no space embedded.

DELIM-SPACE

: If this option is set, when concatenating multiple data fields there is a space embedded. This is the default and need not be explicitly specified.

GEOCODE_FORMAT (Optional)

Indicates the order of the latitude and longitude coordinates that you specify to build key 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.

GEOCODE_RADIUS (Optional)

Indicates the search radius to build key 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=1000

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.