SSA-NAME3 API Reference Guide

10.5 HotFix 1
- 10.5 HotFix 2
- 10.5
- 10.2 HotFix 1
- 10.2
- 10.1 HotFix 1
- 10.1
- 10.0 HotFix 1
- 10.0

Back Next

ssan3_get_ranges_encoded Controls

For ssan3_get_ranges_encoded, the

Controls

specify the fields in the data that you can use as the key fields to build search ranges, the search level, and the layout of the key field data.

Syntax


FIELD=field name
[SEARCH_LEVEL=search level]
[KEY_SIZE=5|8]
[NAMEFORMAT=name format]
[UNICODE_ENCODING=Unicode type]
[ENCODING=Unicode type]
[SEARCH_LIMIT=n]
[LIMIT_MODE=Y/N]
[LAYOUT=[field1,]offset1,length1,... ,
[fieldn,]offsetn,lengthn]
[DELIMITER=delimiter]
[MAX_ENTRIES=n]
[MUST_RETURNVALUES=Y/N]
[SECPROBE=Y/N]
[BATCHMODE=Y|S|N]
[GEOCODE_FORMAT=0|1]
[GEOCODE_RADIUS=n]
[NM3KEYWORDS=FIRSTMINORPROBE|ORIGWORDRANGE|CONCMINORRANGE|INITRANGE|INITPROBE|DEBUG|FMTOVERRIDES|EXTRADATEDROP1PART|FIRSTWORDRANGEORKEY|BUILDPROBEDROPFIRSTINIT|EXTRACODEPROBES]
[DEBUG_ENABLE=Y/N]
[DEBUG_FILE=file name]
[NONULLKEY=Y/N]

Definitions

Field	Description
FIELD	Defines 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 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: 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.
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.
LIMIT_MODE=[Y/N]	Removes the ranges that exceed the value set by the SEARCH_LIMIT option. If there are no ranges left to return, SSA-NAME3 returns the response 1 . Use the LIMIT_MODE=Y option in combination with the SEARCH_LIMIT option. The LIMIT_MODE=Y option changes the default behaviour of the SEARCH_LIMIT option. By default, the SEARCH_LIMIT option applies to all the ranges, and if the limit exceeds, SSA-NAME3 does not return any ranges. If you set the LIMIT_MODE=Y option, the limit applies to each range and SSA-NAME3 removes or discards the ranges that exceed the search limit. Default is N .
MAX_ENTRIES	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]	Forces SSA-NAME3 to return the keys. Set this field to Y when you get a key stack overflow error. Default is N .
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: Y Converts secondary name searches from ranges to probes and custom set ranges to probes. S Removes all the secondary name searches and converts custome set ranges to probes. N Turns off BATCHMODE.
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: 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.
NM3KEYWORDS	Optional. Indicates the additional keys that you want to build based on the keywords you specify. 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_NameThe 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. EXTRADATEDROP1PART . Builds additional keys for dates after splitting the date into multiple parts. A date in the yyyy-mm-dd format is split into the following parts: yy-mm yy-dd mm-dd For example, if you want to find the dates 2000-10-11 , 2000-10-13 , and 2002-10-11 , the EXTRADATEDROP1PART keyword builds keys after splitting the date into the following parts: YYYY-MM and MM-DD FIRSTWORDRANGEORKEY . Builds an additional key if the first word in the word stack is a skip word and the NAMEFORMAT keyword is set to L . BUILDPROBEDROPFIRSTINIT . Builds an additional probe for the words with a leading initial followed by at least two non-initial words. For example, the names MR M Dan Houting and Dan Houting match with the additional probe. EXTRACODEPROBES . Builds an additional probe for each code with five or more characters in the word stack after formatting. The keys contain alphanumeric characters. Use this keyword to support model numbers for products that might not have digits. For more information about other valid keywords that the ssan_get_ranges_encoded control supports, see the NAMESET function keywords section in the Informatica SSA-NAME3(EXTN) 10.2 Service Group Definition and Customization Guide .
DEBUG_ENABLE=[Y\|N]	Verifies the input parameters and writes debug information about the parameters to a specified log file. Default is N .
DEBUG_FILE	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.

Rename Saved Search

Table of Contents

SSA-NAME3 API Reference Guide

SSA-NAME3 API Reference Guide

ssan3_get_ranges_encoded Controls

ssan3_get_ranges_encoded Controls

Syntax

Definitions