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

Overview

Search for one or more terms in the values of an app by using the SearchAssociations method.

Examples

Example 1:

The first step of the example is to create a chart with one dimension City (set in qFieldDefs ) and one measure Count(Rainfall) (set in qDef).

1. Create the chart object BC01.

The client sends:

{ "jsonrpc": "2.0", "id": 2, "method": "CreateSessionObject", "handle": 1, "params": [ { "qInfo": { "qId": "BC01", "qType": "Chart" }, "qHyperCubeDef": { "qDimensions": [ { "qLibraryId": "", "qDef": { "qFieldDefs": [ "City" ], "qFieldLabels": [ "Label" ], "qSortCriterias": [ { "qSortByLoadOrder": 1 } ], "qReverseSort": false } } ], "qMeasures": [ { "qLibraryId": "", "qDef": { "qLabel": "Chart HC Properties measures label", "qDef": "Count(Rainfall)" } } ], "qSuppressZero": true, "qSuppressMissing": true, "qInitialDataFetch": [ { "qTop": 0, "qHeight": 1, "qLeft": 0, "qWidth": 2 } ] } } ], }

The engine returns:

{ "jsonrpc": "2.0", "id": 2, "result": { "qReturn": { "qType": "GenericObject", "qHandle": 2 } }, "change": [ 2 ] }

The chart object is created and the handle is 2.

2. Search for the values associated to Oakmont in the app (qTerm is Oakmont).

All the values in the app are in optional state. The search context is LockedFieldsOnly (default value). Since there are no locked fields, the search is performed on all values.

The number of search results that contain search hits is limited to 4 (value of the parameter qCount ) and the number of matching values in each search result is limited to 2 (qMaxNbrFieldMatches).

The client sends:

{ "jsonrpc": "2.0", "id": 3, "method": "SearchAssociations", "handle": 1, "params": [ {}, [ "Oakmont" ], { "qOffset": 0, "qCount": 4, "qMaxNbrFieldMatches": 2 } ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 3, "result": { "qResults": { "qFieldNames": [ "GolfCourseKey", "Golf Course", "City", "Course Address1", "Description" ], "qSearchTerms": [ "Oakmont" ], "qFieldDictionaries": [ { "qField": 0, "qResult": [ { "qText": "Oakmont East Golf Course_Oakmont_Pennsylvania_United States", "qElemNumber": 40, "qRanges": [ { "qCharPos": 0, "qCharCount": 7, "qTerm": 0 }, { "qCharPos": 25, "qCharCount": 7, "qTerm": 0 } ] }, { "qText": "Oakmont Country Club_Oakmont_Pennsylvania_United States", "qElemNumber": 41, "qRanges": [ { "qCharPos": 0, "qCharCount": 7, "qTerm": 0 }, { "qCharPos": 21, "qCharCount": 7, "qTerm": 0 } ] } ] }, { "qField": 1, "qResult": [ { "qText": "Oakmont East Golf Course", "qElemNumber": 40, "qRanges": [ { "qCharPos": 0, "qCharCount": 7, "qTerm": 0 } ] }, { "qText": "Oakmont Country Club", "qElemNumber": 41, "qRanges": [ { "qCharPos": 0, "qCharCount": 7, "qTerm": 0 } ] } ] }, { "qField": 2, "qResult": [ { "qText": "Oakmont", "qElemNumber": 7, "qRanges": [ { "qCharPos": 0, "qCharCount": 7, "qTerm": 0 } ] } ] }, { "qField": 3, "qResult": [] }, { "qField": 4, "qResult": [ { "qText": "Oakmont East Golf Course This course is hilly on the front nine and predominantly flat on the back nine. There are no water hazards and only a few sand bunkers to contend with. Most all the fairways ar", "qElemNumber": 40, "qRanges": [ { "qCharPos": 0, "qCharCount": 7, "qTerm": 0 } ] }, { "qText": "Oakmont Country Club This club, which has been established as a National Historic Landmark, is famous for hosting many national championships, including the National Amateur, the PGA Championship, and", "qElemNumber": 41, "qRanges": [ { "qCharPos": 0, "qCharCount": 7, "qTerm": 0 } ] } ] } ], "qSearchTermsMatched": [ [ { "qId": 0, "qFieldMatches": [ { "qField": 2, "qValues": [ 0 ], "qTerms": [ 0 ], "qNoOfMatches": 1 } ] }, { "qId": 1, "qFieldMatches": [ { "qField": 1, "qValues": [ 0, 1 ], "qTerms": [ 0 ], "qNoOfMatches": 4 } ] }, { "qId": 2, "qFieldMatches": [ { "qField": 0, "qValues": [ 0, 1 ], "qTerms": [ 0 ], "qNoOfMatches": 5 } ] }, { "qId": 3, "qFieldMatches": [ { "qField": 4, "qValues": [ 0, 1 ], "qTerms": [ 0 ], "qNoOfMatches": 5 } ] } ] ], "qTotalSearchResults": 5 } } }

The list of search terms is returned. In this example, there is only one term that is searched (in qSearchTerms).

The list of fields containing some search hits (in qFieldNames) and the list of search results (in qSearchTermsMatched) are returned. For each search result, the matching values are returned.

qField in qFieldDictionaries returns the index of the field in the list of fields defined by qFieldNames. In this example, qField set to :

0 corresponds to the field GolfCourseKey
1 corresponds to the field Golf Course
2 corresponds to the field City
3 corresponds to the field Course Address1
4 corresponds to the field Description

qText in qFieldDictionaties returns the value of a search hit.

qCharPos sets to:

0 means that the search term is located at position 0 in the value of the search result
25 means that the search term is located at position 25 in the value of the search result

qCharCount sets to 7 means that the length of the search term is 7.

The number of values returned by qResult in qFieldDictionaries is limited by the value of the parameter qMaxNbrFieldMatches. In this example, the maximum number of values per field containing search results is 2.

The list of search results (qSearchTermsMatched) is returned . The number of search results per field is limited by the value of the parameter qCount. In this example, the maximum number of search results is 4.

The index of each search result is given in qId. For each search result is given:

the position of the field in the list of fields containing the search hits
the positions of the matching values in the search results. In this example since the number of values per field is limited to two, qValues can only be [0] or [0,1].

The number of search matches in a field (given in qNoOfMatches ) is returned. This value is not limited by the value of the parameter qMaxNbrFieldMatches.

See: SearchAssociations method.

The figure below shows the result of the global associative search in the Qlik Sense interface:

3. Select the values related to the search result with index 0 (qId is 0). This search result corresponds to the field in position 2 (qField is 2) which is City. The search string is Oakmont. There are no current selections.

In this example, qMatchIx is 0 (equals to qId) and qTerms is [Oakmont].

The client sends:

{ "jsonrpc": "2.0", "id": 4, "method": "SelectAssociations", "handle": 1, "params": [ {}, [ "Oakmont" ], 0 ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 4, "result": {}, "change": [ 1 ] }

The matching values in the field City are selected.

See: SelectAssociations method.

4. Get the layout of the chart object. The handle of the request is 2 because the handle of the chart is 2.

The client sends:

{ "jsonrpc": "2.0", "id": 5, "method": "GetLayout", "handle": 2, "params": [] }

The engine returns:

{ "jsonrpc": "2.0", "id": 5, "result": { "qLayout": { "qInfo": { "qId": "BC01", "qType": "Chart" }, "qSelectionInfo": {}, "qHyperCube": { "qSize": { "qcx": 2, "qcy": 1 }, "qDimensionInfo": [ { "qFallbackTitle": "Label", "qApprMaxGlyphCount": 30, "qCardinal": 7532, "qSortIndicator": "A", "qGroupFallbackTitles": [ "Label" ], "qGroupPos": 0, "qStateCounts": { "qLocked": 0, "qSelected": 1, "qOption": 0, "qDeselected": 0, "qAlternative": 7531, "qExcluded": 0, "qSelectedExcluded": 0, "qLockedExcluded": 0 }, "qTags": [ "$text" ], "qDimensionType": "D", "qGrouping": "N", "qNumFormat": { "qType": "R", "qnDec": 14, "qUseThou": 1, "qFmt": "##############", "qDec": ".", "qThou": "," }, "qIsAutoFormat": true, "qGroupFieldDefs": [ "City" ] } ], "qMeasureInfo": [ { "qFallbackTitle": "Chart HC Properties measures label", "qApprMaxGlyphCount": 1, "qCardinal": 0, "qSortIndicator": "N", "qNumFormat": { "qType": "I", "qnDec": 0, "qUseThou": 1, "qFmt": "###0", "qDec": "." }, "qMin": 2, "qMax": 2, "qIsAutoFormat": true, "qAttrExprInfo": [] } ], "qEffectiveInterColumnSortOrder": [ 0, 1 ], "qGrandTotalRow": [ { "qText": "2", "qNum": 2, "qElemNumber": -1, "qState": "X", "qIsTotalCell": true } ], "qDataPages": [ { "qMatrix": [ [ { "qText": "Oakmont", "qNum": "NaN", "qElemNumber": 7, "qState": "S" }, { "qText": "2", "qNum": 2, "qElemNumber": 0, "qState": "L" } ] ], "qTails": [ { "qUp": 0, "qDown": 0 } ], "qArea": { "qLeft": 0, "qTop": 0, "qWidth": 2, "qHeight": 1 } } ], "qPivotDataPages": [], "qStackedDataPages": [], "qMode": "S", "qNoOfLeftDims": -1 } } } }

The city Oakmont is selected.

Example 2:

The first step in this example is to create a list object with one dimension City (set in qFieldDefs ).

1. Create the list object LB01. The dimension is City.

The client sends:

{ "jsonrpc": "2.0", "id": 2, "method": "CreateSessionObject", "handle": 1, "params": [ { "qInfo": { "qId": "LB01", "qType": "ListObject" }, "qListObjectDef": { "qStateName": "$", "qLibraryId": "", "qDef": { "qFieldDefs": [ "City" ], "qFieldLabels": [ "Country Label" ], "qSortCriterias": [ { "qSortByLoadOrder": 0, "qSortByAscii": 1 } ] }, "qInitialDataFetch": [ { "qTop": 0, "qHeight": 5, "qLeft": 0, "qWidth": 1 } ] } } ], "cont": false, "delta": false }

The engine returns:

{ "jsonrpc": "2.0", "id": 2, "result": { "qReturn": { "qType": "GenericObject", "qHandle": 2 } }, "change": [ 2 ] }

The list object is created and the handle is 2.

2. Search for the values containing Aachen in the field City.

The client sends:

{ "jsonrpc": "2.0", "id": 3, "method": "SearchAssociations", "handle": 1, "params": [ { "qSearchFields": [ "City" ] }, [ "Aachen" ], { "qOffset": 0, "qCount": 4, "qMaxNbrFieldMatches": 2 } ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 3, "result": { "qResults": { "qFieldNames": [ "City" ], "qSearchTerms": [ "Aachen" ], "qFieldDictionaries": [ { "qField": 0, "qResult": [ { "qText": "Aachen", "qElemNumber": 7414, "qRanges": [ { "qCharPos": 0, "qCharCount": 6, "qTerm": 0 } ] } ] } ], "qSearchTermsMatched": [ [ { "qId": 0, "qFieldMatches": [ { "qField": 0, "qValues": [ 0 ], "qTerms": [ 0 ], "qNoOfMatches": 1 } ] } ] ], "qTotalSearchResults": 1 } } }

There is one matching value: the city Aachen. The identifier linked to the field City is 0 (in result/qResults/qSearchTermsMatched/0/0/qId).

See: SearchAssociations method.

3. Select the value associated to Aachen in the field City (qMatchIx is 0).

There are no current selections in the app and the search context is LockedFieldsOnly (default value). Therefore there is only one value to be selected: the city Aachen (as returned by the SearchAssociations method in the previous step).

The client sends:

{ "jsonrpc": "2.0", "id": 4, "method": "SelectAssociations", "handle": 1, "params": [ { "qSearchFields": [ "City" ] }, [ "Aachen" ], 0 ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 4, "result": {}, "change": [ 1 ] }

The value Aachen in the field City is selected.

See: SelectAssociations method.

4. Get the layout of the list object. The handle of the request is 2 because the handle of the list object is 2.

The client sends:

{ "jsonrpc": "2.0", "id": 5, "method": "GetLayout", "handle": 2, "params": [] }

The engine returns:

{ "jsonrpc": "2.0", "id": 5, "result": { "qLayout": { "qInfo": { "qId": "LB01", "qType": "ListObject" }, "qSelectionInfo": {}, "qListObject": { "qStateName": "$", "qSize": { "qcx": 1, "qcy": 7532 }, "qDimensionInfo": { "qFallbackTitle": "Country Label", "qApprMaxGlyphCount": 30, "qCardinal": 7532, "qSortIndicator": "A", "qGroupFallbackTitles": [ "Country Label" ], "qGroupPos": 0, "qStateCounts": { "qLocked": 0, "qSelected": 1, "qOption": 0, "qDeselected": 0, "qAlternative": 7531, "qExcluded": 0, "qSelectedExcluded": 0, "qLockedExcluded": 0 }, "qTags": [ "$text" ], "qDimensionType": "D", "qGrouping": "N", "qNumFormat": { "qType": "R", "qnDec": 14, "qUseThou": 1, "qFmt": "##############", "qDec": ".", "qThou": "," }, "qIsAutoFormat": true, "qGroupFieldDefs": [ "City" ] }, "qExpressions": [], "qDataPages": [ { "qMatrix": [ [ { "qText": "100 Mile House", "qNum": "NaN", "qElemNumber": 1252, "qState": "X" } ], [ { "qText": "108 Mile House", "qNum": "NaN", "qElemNumber": 2784, "qState": "X" } ], [ { "qText": "Aachen", "qNum": "NaN", "qElemNumber": 7414, "qState": "S" } ], [ { "qText": "Aalbaek", "qNum": "NaN", "qElemNumber": 6097, "qState": "X" } ], [ { "qText": "Aalborg", "qNum": "NaN", "qElemNumber": 6098, "qState": "X" } ] ], "qTails": [], "qArea": { "qLeft": 0, "qTop": 0, "qWidth": 1, "qHeight": 5 } } ] } } } }

The city Aachen is selected.

5. Search for the values associated to Aalborg in the field City. The search context is LockedFieldsOnly (default value). Since there are no locked fields, the search is performed on all values of the field City.

The client sends:

{ "jsonrpc": "2.0", "id": 6, "method": "SearchAssociations", "handle": 1, "params": [ { "qSearchFields": [ "City" ] }, [ "Aalborg" ], { "qOffset": 0, "qCount": 4, "qMaxNbrFieldMatches": 2 } ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 6, "result": { "qResults": { "qFieldNames": [ "City" ], "qSearchTerms": [ "Aalborg" ], "qFieldDictionaries": [ { "qField": 0, "qResult": [ { "qText": "Aalborg", "qElemNumber": 6098, "qRanges": [ { "qCharPos": 0, "qCharCount": 7, "qTerm": 0 } ] } ] } ], "qSearchTermsMatched": [ [ { "qId": 0, "qFieldMatches": [ { "qField": 0, "qValues": [ 0 ], "qTerms": [ 0 ], "qNoOfMatches": 1 } ] } ] ], "qTotalSearchResults": 1 } } }

There is one matching value: the city Aalborg. The identifier linked to the field City is 0 (in result/qResults/qSearchTermsMatched/0/0/qId).

See: SearchAssociations method.

6. Select the value associated to Aalborg in the field City (qMatchIx is 0).

There are some current selections in the app and the search context is LockedFieldsOnly (default value). Therefore the new selection (the city Aalborg) will replace the current selection.

The client sends:

{ "jsonrpc": "2.0", "id": 7, "method": "SelectAssociations", "handle": 1, "params": [ { "qSearchFields": [ "City" ] }, [ "Aalborg" ], 0 ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 7, "result": {}, "change": [ 1, 2 ] }

The value Aalborg in the field City is selected.

See: SelectAssociations method.

7. Get the layout of the list object. The handle of the request is 2 because the handle of the list object is 2.

The client sends:

{ "jsonrpc": "2.0", "id": 8, "method": "GetLayout", "handle": 2, "params": [] }

The engine returns:

{ "jsonrpc": "2.0", "id": 8, "result": { "qLayout": { "qInfo": { "qId": "LB01", "qType": "ListObject" }, "qSelectionInfo": {}, "qListObject": { "qStateName": "$", "qSize": { "qcx": 1, "qcy": 7532 }, "qDimensionInfo": { "qFallbackTitle": "Country Label", "qApprMaxGlyphCount": 30, "qCardinal": 7532, "qSortIndicator": "A", "qGroupFallbackTitles": [ "Country Label" ], "qGroupPos": 0, "qStateCounts": { "qLocked": 0, "qSelected": 1, "qOption": 0, "qDeselected": 0, "qAlternative": 7531, "qExcluded": 0, "qSelectedExcluded": 0, "qLockedExcluded": 0 }, "qTags": [ "$text" ], "qDimensionType": "D", "qGrouping": "N", "qNumFormat": { "qType": "R", "qnDec": 14, "qUseThou": 1, "qFmt": "##############", "qDec": ".", "qThou": "," }, "qIsAutoFormat": true, "qGroupFieldDefs": [ "City" ] }, "qExpressions": [], "qDataPages": [ { "qMatrix": [ [ { "qText": "100 Mile House", "qNum": "NaN", "qElemNumber": 1252, "qState": "X" } ], [ { "qText": "108 Mile House", "qNum": "NaN", "qElemNumber": 2784, "qState": "X" } ], [ { "qText": "Aachen", "qNum": "NaN", "qElemNumber": 7414, "qState": "X" } ], [ { "qText": "Aalbaek", "qNum": "NaN", "qElemNumber": 6097, "qState": "X" } ], [ { "qText": "Aalborg", "qNum": "NaN", "qElemNumber": 6098, "qState": "S" } ] ], "qTails": [], "qArea": { "qLeft": 0, "qTop": 0, "qWidth": 1, "qHeight": 5 } } ] } } } }

The city Aalborg is selected and the city Aachen is no longer selected.

8. Select the value associated to Aachen in the field City (qMatchIx is 0).

There are some current selections in the app and the search context is CurrentSelection. Therefore the new selection is added to the current selection.

The client sends:

{ "jsonrpc": "2.0", "id": 9, "method": "SelectAssociations", "handle": 1, "params": [ { "qContext": "CurrentSelections" }, [ "Aachen" ], 0 ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 9, "result": {}, "change": [ 1, 2 ] }

The value Aachen is selected.

9. Get the layout of the list object. The handle of the request is 2 because the handle of the list object is 2.

The client sends:

{ "jsonrpc": "2.0", "id": 10, "method": "GetLayout", "handle": 2, "params": [] }

The engine returns:

{ "jsonrpc": "2.0", "id": 10, "result": { "qLayout": { "qInfo": { "qId": "LB01", "qType": "ListObject" }, "qSelectionInfo": {}, "qListObject": { "qStateName": "$", "qSize": { "qcx": 1, "qcy": 7532 }, "qDimensionInfo": { "qFallbackTitle": "Country Label", "qApprMaxGlyphCount": 30, "qCardinal": 7532, "qSortIndicator": "A", "qGroupFallbackTitles": [ "Country Label" ], "qGroupPos": 0, "qStateCounts": { "qLocked": 0, "qSelected": 2, "qOption": 0, "qDeselected": 0, "qAlternative": 7530, "qExcluded": 0, "qSelectedExcluded": 0, "qLockedExcluded": 0 }, "qTags": [ "$text" ], "qDimensionType": "D", "qGrouping": "N", "qNumFormat": { "qType": "R", "qnDec": 14, "qUseThou": 1, "qFmt": "##############", "qDec": ".", "qThou": "," }, "qIsAutoFormat": true, "qGroupFieldDefs": [ "City" ] }, "qExpressions": [], "qDataPages": [ { "qMatrix": [ [ { "qText": "100 Mile House", "qNum": "NaN", "qElemNumber": 1252, "qState": "X" } ], [ { "qText": "108 Mile House", "qNum": "NaN", "qElemNumber": 2784, "qState": "X" } ], [ { "qText": "Aachen", "qNum": "NaN", "qElemNumber": 7414, "qState": "S" } ], [ { "qText": "Aalbaek", "qNum": "NaN", "qElemNumber": 6097, "qState": "X" } ], [ { "qText": "Aalborg", "qNum": "NaN", "qElemNumber": 6098, "qState": "S" } ] ], "qTails": [], "qArea": { "qLeft": 0, "qTop": 0, "qWidth": 1, "qHeight": 5 } } ] } } } }

The cities Aalborg and Aachen are selected.

Example 3:

The first step in this example is to create a list object with one dimension City (set in qFieldDefs ).

1. Create the list object LB01. The dimension is City.

The client sends:

The engine returns:

{ "jsonrpc": "2.0", "id": 2, "result": { "qReturn": { "qType": "GenericObject", "qHandle": 2 } }, "change": [ 2 ] }

The list object is created and the handle is 2.

2. Create the list object LB02. The dimension is Country.

The client sends:

{ "jsonrpc": "2.0", "id": 3, "method": "CreateSessionObject", "handle": 1, "params": [ { "qInfo": { "qId": "LB02", "qType": "ListObject" }, "qListObjectDef": { "qStateName": "$", "qLibraryId": "", "qDef": { "qFieldDefs": [ "Country" ], "qFieldLabels": [ "Country Label" ], "qSortCriterias": [ { "qSortByLoadOrder": 0, "qSortByAscii": 1 } ] }, "qInitialDataFetch": [ { "qTop": 0, "qHeight": 5, "qLeft": 0, "qWidth": 1 } ] } } ], "cont": false, "delta": false }

The engine returns:

{ "jsonrpc": "2.0", "id": 3, "result": { "qReturn": { "qType": "GenericObject", "qHandle": 3 } }, "change": [ 3 ] }

The list object is created and the handle is 3.

3. Select the values associated to Aachen and Aalborg in the field City.

The client sends:

{ "jsonrpc": "2.0", "id": 4, "method": "SelectAssociations", "handle": 1, "params": [ { "qSearchFields": [ "City" ] }, [ "Aachen", "Aalborg" ], 0 ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 4, "result": {} }

The cities Aachen and Aalborg are selected.

See: SelectAssociations method.

4. Get the layout of the list object LB01. The handle of the request is 2 because the handle of the list object is 2.

The client sends:

{ "jsonrpc": "2.0", "id": 5, "method": "GetLayout", "handle": 2, "params": [] }

The engine returns:

{ "jsonrpc": "2.0", "id": 5, "result": { "qLayout": { "qInfo": { "qId": "LB01", "qType": "ListObject" }, "qSelectionInfo": {}, "qListObject": { "qStateName": "$", "qSize": { "qcx": 1, "qcy": 7532 }, "qDimensionInfo": { "qFallbackTitle": "Country Label", "qApprMaxGlyphCount": 30, "qCardinal": 7532, "qSortIndicator": "A", "qGroupFallbackTitles": [ "Country Label" ], "qGroupPos": 0, "qStateCounts": { "qLocked": 0, "qSelected": 2, "qOption": 0, "qDeselected": 0, "qAlternative": 7530, "qExcluded": 0, "qSelectedExcluded": 0, "qLockedExcluded": 0 }, "qTags": [ "$text" ], "qDimensionType": "D", "qGrouping": "N", "qNumFormat": { "qType": "R", "qnDec": 14, "qUseThou": 1, "qFmt": "##############", "qDec": ".", "qThou": "," }, "qIsAutoFormat": true, "qGroupFieldDefs": [ "City" ] }, "qExpressions": [], "qDataPages": [ { "qMatrix": [ [ { "qText": "100 Mile House", "qNum": "NaN", "qElemNumber": 1252, "qState": "X" } ], [ { "qText": "108 Mile House", "qNum": "NaN", "qElemNumber": 2784, "qState": "X" } ], [ { "qText": "Aachen", "qNum": "NaN", "qElemNumber": 7414, "qState": "S" } ], [ { "qText": "Aalbaek", "qNum": "NaN", "qElemNumber": 6097, "qState": "X" } ], [ { "qText": "Aalborg", "qNum": "NaN", "qElemNumber": 6098, "qState": "S" } ] ], "qTails": [], "qArea": { "qLeft": 0, "qTop": 0, "qWidth": 1, "qHeight": 5 } } ] } } } }

The cities Aachen and Aalborg are selected.

5. Get the handle of the field City.

The client sends:

{ "jsonrpc": "2.0", "id": 6, "method": "GetField", "handle": 1, "params": [ "City" ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 6, "result": { "qReturn": { "qType": "Field", "qHandle": 4 } } }

The handle of the field City is 4.

6. Lock the field City. The handle of the request is 4 because the handle of the field City is 4.

The client sends:

{ "jsonrpc": "2.0", "id": 7, "method": "Lock", "handle": 4, "params": [] }

The engine returns:

{ "jsonrpc": "2.0", "id": 7, "result": { "qReturn": true }, "change": [ 1, 2, 4 ] }

The selected values are locked.

7. Get the layout of the list object LB01. The handle of the request is 2 because the handle of the list object is 2.

The client sends:

{ "jsonrpc": "2.0", "id": 8, "method": "GetLayout", "handle": 2, "params": [] }

The engine returns:

{ "jsonrpc": "2.0", "id": 8, "result": { "qLayout": { "qInfo": { "qId": "LB01", "qType": "ListObject" }, "qSelectionInfo": {}, "qListObject": { "qStateName": "$", "qSize": { "qcx": 1, "qcy": 7532 }, "qDimensionInfo": { "qFallbackTitle": "Country Label", "qApprMaxGlyphCount": 30, "qCardinal": 7532, "qLocked": true, "qSortIndicator": "A", "qGroupFallbackTitles": [ "Country Label" ], "qGroupPos": 0, "qStateCounts": { "qLocked": 2, "qSelected": 0, "qOption": 0, "qDeselected": 0, "qAlternative": 7530, "qExcluded": 0, "qSelectedExcluded": 0, "qLockedExcluded": 0 }, "qTags": [ "$text" ], "qDimensionType": "D", "qGrouping": "N", "qNumFormat": { "qType": "R", "qnDec": 14, "qUseThou": 1, "qFmt": "##############", "qDec": ".", "qThou": "," }, "qIsAutoFormat": true, "qGroupFieldDefs": [ "City" ] }, "qExpressions": [], "qDataPages": [ { "qMatrix": [ [ { "qText": "100 Mile House", "qNum": "NaN", "qElemNumber": 1252, "qState": "X" } ], [ { "qText": "108 Mile House", "qNum": "NaN", "qElemNumber": 2784, "qState": "X" } ], [ { "qText": "Aachen", "qNum": "NaN", "qElemNumber": 7414, "qState": "L" } ], [ { "qText": "Aalbaek", "qNum": "NaN", "qElemNumber": 6097, "qState": "X" } ], [ { "qText": "Aalborg", "qNum": "NaN", "qElemNumber": 6098, "qState": "L" } ] ], "qTails": [], "qArea": { "qLeft": 0, "qTop": 0, "qWidth": 1, "qHeight": 5 } } ] } } } }

The cities Aachen and Aalborg in the field City are locked.

8. Search for the values associated to Canada in the field Country. The search context is LockedFieldsOnly (default value). Since the field City is locked, the search is performed on all locked values of the field City.

The city Aachen is associated to the country Germany and the city Aalborg is associated to the country Denmark.

The client sends:

{ "jsonrpc": "2.0", "id": 9, "method": "SearchAssociations", "handle": 1, "params": [ { "qSearchFields": [ "Country" ] }, [ "Canada" ], { "qOffset": 0, "qCount": 5, "qMaxNbrFieldMatches": 2 } ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 9, "result": { "qResults": { "qFieldNames": [], "qSearchTerms": [ "Canada" ], "qFieldDictionaries": [], "qSearchTermsMatched": [], "qTotalSearchResults": 0 } } }

There is no matching value: the country Canada is not associated to any of the locked values (i.e. the cities Aachen and Aalborg).

See: SearchAssociations method.

9. Search for the values associated to Denmark in the field Country. The search context is LockedFieldsOnly (default value). Since the field City is locked, the search is performed on all locked values of the field City.

The city Aachen is associated to the country Germany and the city Aalborg is associated to the country Denmark.

The client sends:

{ "jsonrpc": "2.0", "id": 10, "method": "SearchAssociations", "handle": 1, "params": [ { "qSearchFields": [ "Country" ] }, [ "Denmark" ], { "qOffset": 0, "qCount": 5, "qMaxNbrFieldMatches": 2 } ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 10, "result": { "qResults": { "qFieldNames": [ "Country" ], "qSearchTerms": [ "Denmark" ], "qFieldDictionaries": [ { "qField": 0, "qResult": [ { "qText": "Denmark", "qElemNumber": 1, "qRanges": [ { "qCharPos": 0, "qCharCount": 7, "qTerm": 0 } ] } ] } ], "qSearchTermsMatched": [ [ { "qId": 0, "qFieldMatches": [ { "qField": 0, "qValues": [ 0 ], "qTerms": [ 0 ], "qNoOfMatches": 1 } ] } ] ], "qTotalSearchResults": 1 } } }

There is one matching value: the country Denmark.

See: SearchAssociations method.

10. Unlock the field City. The handle of the request is 4 because the handle of the field City is 4.

The client sends:

{ "jsonrpc": "2.0", "id": 11, "method": "Unlock", "handle": 4, "params": [] }

The engine returns:

{ "jsonrpc": "2.0", "id": 11, "result": { "qReturn": true }, "change": [ 1, 2, 4 ] }

The field City is no longer locked.

11. Search for the values associated to Canada in the field Country. The search context is LockedFieldsOnly (default value). Since the field City is no longer locked, the search is performed on all values.

The client sends:

{ "jsonrpc": "2.0", "id": 12, "method": "SearchAssociations", "handle": 1, "params": [ { "qSearchFields": [ "Country" ] }, [ "Canada" ], { "qOffset": 0, "qCount": 5, "qMaxNbrFieldMatches": 2 } ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 12, "result": { "qResults": { "qFieldNames": [ "Country" ], "qSearchTerms": [ "Canada" ], "qFieldDictionaries": [ { "qField": 0, "qResult": [ { "qText": "Canada", "qElemNumber": 3, "qRanges": [ { "qCharPos": 0, "qCharCount": 6, "qTerm": 0 } ] } ] } ], "qSearchTermsMatched": [ [ { "qId": 0, "qFieldMatches": [ { "qField": 0, "qValues": [ 0 ], "qTerms": [ 0 ], "qNoOfMatches": 1 } ] } ] ], "qTotalSearchResults": 1 } } }

There is one matching value: the country Canada.

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