SSA-NAME3 API Reference Guide

Back Next

Updated Controls

The following controls are used with composite keys.

FIELD=: To specify more than one field provide a list to the
FIELD=control
.
FIELD=Person_Name,Address_Part1
LAYOUT=: Field name is allowed in
LAYOUT
control.
LAYOUT=Person_Name,0,50,Address_Part1,50,60
KEY_LEVEL=: Multiple key levels may be specified.

KEY_LEVEL=standard,limited

KEY_LEVEL
may now be specified when calling
ssan3_get_ranges
for all fields except the rightmost field.

For example, for a
ssan3_get_ranges
call:

FIELD=Person_Name,Address_Part1 KEY_LEVEL=limited SEARCH_LEVEL=narrow

FIELD=Person_Name,Address_Part1,Telephone_Number KEY_LEVEL=limited,standard SEARCH_LEVEL=narrow

For example, for a
ssan3_get_keys call
(also showing
LAYOUT
example):

FIELD=Person_Name,Address_Part1 Key_Level=standard,limited -

LAYOUT=Person_Name,0,10,Person_Name,11,13,Address_Part1,25,10
KEY_SIZE=: A list of key size can be specified.

KEY_SIZE=8,8

For composite field the code keys (size of
12
) will default to
16
and name keys (size of
5
, default is
8
) will default to
8
.
NONULLKEY=Y: Supports composite key as well as single field key.
UNICODE_ENCODING: The field name can now be specified.
UNICODE_ENCODING=Person_name:utf-8
NM3KEYWORDS: The field name must be specified with composite key otherwise this will be ignored.

NM3KEYWORDS=Person_Name:INSERTNULLCLOSINGKEY
is valid.

However,
NM3KEYWORDS=INSERTNULLCLOSINGKEY
will be silently ignored.