Search

User Guide

User Guide

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

Back Next

Search Definition

Search Definition

A Search Definition is used to define parameters for a search executed by the Search Server. Search Definitions are used exclusively by the Batch Relate or Batch DupFinder Utilities. 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 Clustering-Definition nor Multi-Search Definition names in the same Project.
IDX=	This is a character string that identifies the IDT to be searched. This is a mandatory parameter.
COMMENT=	This is an optional text field that is used to describe the Search’s purpose.
SORT-WORK1-PATH=, SORT-WORK2-PATH=	DCE may create sort work files when sorting a large result set. These parameters control the placement of these files and override the value possibly given in the Project-Definition . DCE does not support spaces in file or PATH names.
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 IDX-Definition ). Refer to the Search 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 . This is a mandatory parameter unless at least one of the other SCORE-LOGIC parameters is specified. Refer to the Score Logic section for details.
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.
KEY-SCORE-LOGIC=	This optional parameter describes the normal matching logic used to refine the set of candidate records found by the Key-Logic . Refer to the Search Logic section for details.
KEY-PRE-SCORE-LOGIC=	This optional parameter describes the light-weight matching logic used to refine the set of candidate records found by the Key-Logic . Refer to the Search 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 previously defined key. Valid formats are: FORMAT_TEXT 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 DCE Search Server 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, which can 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 and/or the best candidates have been found.
OPTIONS=	A comma separated list of keywords used to control various search options: FIRST stop on first accepted match. Used for specialized applications where any acceptable match should terminate the search process. HIDDEN prevents this search from being listed by the Search Clients such as Relate and DupFinder if the search is not designed to be used independently (ie. it should only be used as part of a Multi- Search). IGNORE-NOTCH-OVERRIDE Ignore any adjustments made to the match levels by a search client ( Relate or DupFinder ) that requests a particular Match-Tolerance. The tolerance is honored but the adjustments are ignored. 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. Note that the entire partition value must be null for this to work. 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. UNIQUE-KEYS specifies that no duplicate sort keys will be returned. Sort keys are defined with the SORT= keyword. UNMATCHED-STATS Used when an output view contains performance counters (e.g. the number of candidates) and the search result set is empty. When enabled, the Search Server will return a dummy IDT record filled with asterisks as a vehicle to return the performance counters. Otherwise statistics are not returned when the set is empty.

Watch

Comments

0 COMMENTS

We’d like to hear from you! Log in to comment.