MDM Registry Edition
- MDM Registry Edition 10.0 HotFix 1
- All Products
FIELD=field name [SEARCH_LEVEL=search level] [KEY_SIZE=5|8] [NAMEFORMAT=name format] [UNICODE_ENCODING=Unicode type] [ENCODING=Unicode type] [SEARCH_LIMIT=n] [LAYOUT=[field1,]offset1,length1,... , [fieldn,]offsetn,lengthn] [DELIMITER=delimiter] [MAX_ENTRIES=n] [SECPROBE=Y/N] [BATCHMODE=Y|S|N] [GEOCODE_FORMAT=0|1] [GEOCODE_RADIUS=n]
Field
| Required/Optional
| Description
|
---|---|---|
FIELD
| Required
| 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.
|
SEARCH_LEVEL
| 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:
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.
|
KEY_SIZE=[5|8]
| 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.
To use the 5-byte keys, check that your database supports the storage and access of binary keys and that your application environment can pass binary values around unchanged.
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.
|
NAMEFORMAT L/R
| 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 .
|
UNICODE_ENCODING
| Optional
| Instructs SSA-NAME3 to accept Unicode data input, and specifies the Unicode format of the data that you want to pass.
|
ENCODING
| Optional
| Functions similar to the
UNICODE_ENCODING keyword.
|
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.
|
SECPROBE Y/N
| Optional
| Changes secondary name ranges from a range to a probe and narrows the searches that use secondary names.
|
BATCHMODE=[Y|S|N]
| Optional
| Adjusts secondary name searches and custom set ranges for batch applications. You can convert secondary name searches from ranges to probes and custom set search ranges to probes, and you can remove secondary name searches. Use one of the following values:
|
GEOCODE_FORMAT=[0|1]
| 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.
|
GEOCODE_RADIUS
| 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:
|