MDM Registry Edition
- MDM Registry Edition 10.5 HotFix 2
- All Products
FIELD=field name [KEY_LEVEL=key level] [KEY_SIZE=5|8] [NAMEFORMAT=name format] [UNICODE_ENCODING=Unicode type] [ENCODING=Unicode type] [LAYOUT=[field1,]offset1,length1,... , [fieldn,]offsetn,lengthn] [DELIMITER=delimiter] [MAX_ENTRIES=n] [MUST_RETURNVALUES=Y/N] [GEOCODE_FORMAT=0|1] [NM3KEYWORDS=KEY-TABLE|FMTOVERRIDES|FIRSTWORDRANGEORKEY|EXTRACODEPROBES] [DEBUG_ENABLE=Y/N] [DEBUG_FILE=file name] [NONULLKEY=Y/N]
Field
| Mandatory/Optional
| Description
|
---|---|---|
FIELD
| Mandatory
| Defines the field for which you want to build keys. With most standard populations, you can use one of the following predefined fields:
|
KEY_LEVEL
| Optional
| Indicates the type of key level that you want to build. With most standard populations, you can use one of the following predefined values:
|
KEY_SIZE=[5|8]
| Optional
| Specifies the length of the SSA-NAME3 keys that you want to return. 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
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 is capable of passing 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 .
|
PREFKEYONLY Y/A
| Optional
| Returns only the preferred key for the input record. If the input record contains multiple values, then
PREFKEYONLY=A returns the preferred key for each value.
PREFKEYONLY=Y only returns one key regardless of the number of values that pass for the field.
|
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.
|
LAYOUT
| Optional
| Specifies the offset and length pairs (Scatter / Gather format) of the data to be passed for key building in the
Key Field Data parameter. Refer to the section on Function parameters for more information. If this control is omitted then the data is expected to be in Tagged Data Format.
|
DELIMITER
| Optional
| Overrides the default delimiter - asterisk (*) if you pass the key field data by using the Tagged Data Format.
|
MAX_ENTRIES
| Optional
| Controls the maximum number of keys that SSA-NAME3 returns in the
Required Keys parameter. By default, SSA-NAME3 returns a maximum of 1024 keys. The control accepts integer values up to 65535. If a name generates more keys than the number specified by
MAX_ENTRIES , a Response Code of 1 is returned with an empty Keys array.
|
MUST_RETURNVALUES=[Y|N]
| Optional
| Forces SSA-NAME3 to return the keys. Set this field to Y when you get a key stack overflow error.
Default is
N .
|
GEOCODE_FORMAT=[0|1]
| Optional
| Indicates the order of the latitude and longitude coordinates that you specify to generate keys.
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.
|
NM3KEYWORDS
| Optional
| Indicates the additional tasks that SSA-NAME3 must perform when it builds keys.
Use one or more of the following keywords:
For more information about other valid keywords that the
ssan_get_keys_encoded control supports, see the NAMESET function keywords section in the
Informatica SSA-NAME3(EXTN) Service Group Definition and Customization Guide .
|
DEBUG_ENABLE=[Y|N]
| Optional
| Verifies the input parameters and writes debug information about the parameters to a specified log file.
Default is
N .
|
DEBUG_FILE
| Optional
| When
DEBUG_ENABLE is set to
Y ,
DEBUG_FILE specifies the name of the log file to which you want to write the debug information about the input parameters.
|
NONULLKEY=[Y|N]
| Optional
| Specifies whether to include null keys in the SSA-NAME3 functions. When set to
N , SSA-NAME3 returns a null key. When set to
Y , SSA-NAME3 doesn't return a null key and returns 0 for the count of keys.
|