Design Guide

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

Back Next

Search Definition

SEARCH-DEFINITION

is used to define parameters for a search executed by the Identity Resolution. It begins with the

SEARCH-DEFINITION

keyword.

Field	Description
NAME=	This is a character string that identifies the Search-Definition. This is a mandatory parameter. The name must not match any Loader-Definition nor Multi-Search Definition names in the same System.
IDX=	This is a character string that identifies the IDT to be searched. This is a mandatory parameter.
COMMENT=	This is a text field that is used to describe the Search’s purpose.
SORT-WORK1-PATH=	IIR may create sort work files when sorting a large result set. This parameter controls the placement of these files and overrides the value in the System-Definition.
SORT-WORK2-PATH=	IIR may create sort work files when sorting a large result set. This parameter controls the placement of these files and overrides the value in the System-Definition.
FILTER=	An optional string containing an SQL expression used to remove some candidates from the Candidate Set. Refer to the SQL Filters section in this guide for information about when and how to use filters.
SEARCH-LOGIC=	This parameter describes the Search-Logic to be used to generate search ranges to find candidate records from the IDT. It may differ from the Key-Logic used to generate keys for the IDT (as defined in the IDXDefinition). Refer to the Key Logic section for details. This is a mandatory parameter.
SCORE-LOGIC=	This parameter describes the normal matching logic used to refine the set of candidate records found by the Search-Logic. Refer to the Score-Logic section for details. This is a mandatory parameter.
PRE-SCORE-LOGIC=	This optional parameter describes the lightweight matching logic used to refine the set of candidate records found by the Search-Logic. Refer to the Score-Logic section for details.
SORT=	A comma-separated list of keywords used to control the sort order of records returned by the search. Multiple sort keys are permitted. The keys will be used in the order of definition. If not specified, the records will be sorted using a primary descending sort on Score, and a secondary ascending sort using the whole record. Memory(recs) The maximum number of records to sort in memory. If the set contains more than recs records, the sort will use temporary work files on disk. The default is 1000 records. Field(fieldname) The name of the field to be used as the sort key. In addition to IDT field names, you may specify the following values: sort_on_score will sort on the Score sort_on_record will sort on the whole record. Type(type) The type of the sort for the previously defined key. Valid types are: A Ascending D Descending Format(format) The format of the sort key. Valid formats are: FORMAT_TEXT text data FORMAT_SHORT native signed short FORMAT_USHORT native unsigned short FORMAT_LONG native long FORMAT_ULONG native unsigned long FORMAT_FLOAT native float FORMAT_DOUBLE native long float FORMAT_NN_SHORT non-native short FORMAT_NN_USHORT non-native unsigned short FORMAT_NN_LONG non-native long FORMAT_NN_ULONG non-native unsigned long
CANDIDATE-SET-SIZE-LIMIT=n	Informs the Identity Resolution to optimize the matching process by eliminating any duplicate candidates that have already been processed. n specifies the maximum number of unique entries in the list. The default limit is 10000 records. A value of 0 disables this processing. If there are more than n unique candidates, only the first n duplicates are removed. Any candidates that do not fit into the list may be processed several times, and if accepted by matching, added to the final set several times. The TRUNCATE-SET option will terminate the search for candidates once the list becomes full. It is used to prevent very wide searches. However, if a search is terminated prematurely there is no guarantee that any of the candidates will be accepted or the best candidates have been found.
OPTIONS=	A comma-separated list of keywords used to control various search options: UNIQUE-KEYS specifies that no duplicate sort keys will be returned. Sort keys are defined with the SORT= keyword. SEARCH-NULL-PARTITION any search for a record containing a Null-Partition value will search all other partitions. Any search for a record with a non-null partition value will search the null-partition as well. The entire partition value must be null for this to work SEQUENCES specifies that detailed matching information is to be saved for each record in the search set. This information can be retrieved using ids_search_get_complete . TRUNCATE-SET modifies the behavior of CANDIDATE-SET-SIZE-LIMIT . Searches normally continue until all candidates have been considered. Truncate-Set will terminate the selection of candidates once the candidate set is full, thereby limiting the number of candidates that will be considered. Response code 1 is returned to the caller of ids_search_start or ids_search_dedupe_start when the set is truncated. HIDDEN prevents this search from being listed by the Search Clients if the search is not designed to be used independently (that is it should only be used as part of a Multi-Search) IGNORE-NOTCH-OVERRIDE Ignore any adjustments made to the match levels on an API call which requests a particular Match-Tolerance. The tolerance is honored but the adjustments are ignored. FIRST stop on first accepted match. Used for specialized applications where any acceptable match should terminate the search process. FILTER-APPEND Append dynamic filter to static filter defined in this Search-Definition. Refer to the SQL Filters section of this guide for details. FILTER-REPLACE Allow dynamic filters to replace the static filter defined in this Search-Definition. Refer to the SQL Filters section in this guide for details. UNMATCHED-STATS Deprecated. Exists only for backward compatibility.

Simple Search is a type of search where multiple entities of varying types can be searched using a single consolidated index. The index and search definitions must use a population that supports the

Generic_Field

. Simple search uses all columns in the index as possible search and match fields. Search definition of a Simple Search requires that the columns be combined in the

SEARCH/SCORE

logic using

COMBINE=<field name>:DELIM-NONE

. See the Populations and Controls Guide for further details on

COMBINE

option.

System Section

Download Guide

Watch

Comments

Communities

Knowledge Base