SearchAssociations method

Overview

Returns the search matches for one or more search terms.

The search results depend on the search context.

See: SearchCombinationOptions

This type of search is also called smart search.

Parameters

Name	Description	Type
qOptions	Information about the search fields and the search context.	SearchCombinationOptions
qTerms	List of terms to search for.	Array of String
qPage	Array of pages to retrieve. This parameter is mandatory.	SearchPage

Name

Description

Type

qOptions

Information about the search fields and the search context.

SearchCombinationOptions

qTerms

List of terms to search for.

Array of String

qPage

Array of pages to retrieve.

This parameter is mandatory.

SearchPage

Name	Description	Type
qSearchFields	List of the search fields. If empty, the search is performed in all fields of the app.	Array of String
qContext	Search context. The default value is LockedFieldsOnly.	One of: Cleared: In this mode, the first step is to clear any current selections in the app. The second step is to search for one or more terms in the values of the app. LockedFieldsOnly: In this mode, the search applies only to the values associated with the selections made in locked fields, ignoring selections in any unlocked field. If no locked fields, the behavior is identical to the Cleared context. You cannot make any new selections in a locked field. You can get search hits for the associated values of a locked field but you cannot get the search hits for the non associative values. CurrentSelections: In this mode, the current selections are kept (if any). Search for one or more terms in the values of the app. New selections are made on top of the current selections. If no selections were made before the search, this mode is identical to the Cleared context.

Name

Description

Type

qSearchFields

List of the search fields.

If empty, the search is performed in all fields of the app.

Array of String

qContext

Search context.

The default value is LockedFieldsOnly.

One of:

Cleared: In this mode, the first step is to clear any current selections in the app. The second step is to search for one or more terms in the values of the app.
LockedFieldsOnly: In this mode, the search applies only to the values associated with the selections made in locked fields, ignoring selections in any unlocked field. If no locked fields, the behavior is identical to the Cleared context. You cannot make any new selections in a locked field. You can get search hits for the associated values of a locked field but you cannot get the search hits for the non associative values.
CurrentSelections: In this mode, the current selections are kept (if any). Search for one or more terms in the values of the app. New selections are made on top of the current selections. If no selections were made before the search, this mode is identical to the Cleared context.

Name	Description	Type
qOffset	Position from the top, starting from 0. If the offset is set to 0, the first search result to be returned is at position 0.	Integer
qCount	Number of search results to return.	Integer
qMaxNbrFieldMatches	Maximum number of matching values to return per search result. The default value is -1: all values are returned.	Integer

Name

Description

Type

qOffset

Position from the top, starting from 0.

If the offset is set to 0, the first search result to be returned is at position 0.

Integer

qCount

Number of search results to return.

Integer

qMaxNbrFieldMatches

Maximum number of matching values to return per search result.

The default value is -1: all values are returned.

Integer

Outputs

The following is returned in the output:

Name	Description	Type
qResults	List of the association results.	SearchAssociationResult

Name	Description	Type
qFieldNames	List of the fields that contains search associations.	Array of String.
qSearchTerms	List of the search terms.	Array of String.
qFieldDictionaries	Information about the fields containing search hits.	Array of SearchFieldDictionary.
qSearchTermsMatched	List of search results. The maximum number of search results in this list is set by qPage/qCount.	Array of SearchMatchCombinations
qTotalSearchResults	Total number of search results. This number is not limited by qPage/qCount.	Integer

Name

Description

Type

qField

Position of the field in the list of fields, starting from 0.

The list of fields is defined in qResults/qFieldNames and contains the search associations.

Integer

qResult

List of the matching values.

The maximum number of values in this list is set by qMaxNbrFieldMatches.

Array of SearchTermResult

Name	Description	Type
qText	Text of the associated value.	String
qElemNumber	Element number of the associated value.	Integer
qRanges	List of ranges. For example, if the user searches the term read and the associative value is Reading, then the corresponding range would be Read in Reading.	Array of SearchCharRange.

Name

Description

Type

qText

Text of the associated value.

String

qElemNumber

Element number of the associated value.

Integer

qRanges

List of ranges.

For example, if the user searches the term read and the associative value is Reading, then the corresponding range would be Read in Reading.

Array of SearchCharRange.

Name	Description	Type
qCharPos	Starting position of the match in the associative value.	Integer
qCharCount	Length of the match in the associative value.	Integer
qTerm	Position of the term in the list of search terms, starting from 0.	Integer

Name	Description	Type
qSearchMatchCombinations	Array of search combinations.	Array of SearchMatchCombination

Name	Description	Type
qId	Index of the search result, starting from 0.	Integer
qFieldMatches	Information about the search matches.	Array of SearchFieldMatch.

Name	Description	Type
qField	Position of the field in the list of fields, starting from 0. The list of fields is defined in qResults/qFieldNames and contains the search associations.	Integer
qValues	Positions of the matching values in the search results. The maximum number of values in this list is defined by qMaxNbrFieldMatches.	Array of Integer
qTerms	Positions of the search terms, starting from 0.	Array of Integer
qNoOfMatches	Number of search hits in the field. The number of values in qValues and the value of qNoOfMatches are equal if qMaxNbrFieldMatches is -1.	Integer

Learn more

Search for one or more terms in the values of an app

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here