run_client.sh

--config=configuration_file_name

--operation=GETMULTISEARCHLAYOUT

[--outputfile=output_file_name]

--rule=matching_rules_file_name

run_client.sh --config=/usr/local/tree/configuration.xml --operation=GETMULTISEARCHLAYOUT --outputfile=/usr/local/tree/output.json --rule=/usr/local/conf/matching_rules.xml

{
   "sortField":"",
   "searchType":"Football",
   "resultlimit":0,
   "scoreThreshold":0,
   "ignoreMatch":false,
   "searchinput":{

   },
   "searchlayout":{
      "PINCODE":"optional",
      "NAME":"mandatory for the match rulesets: 00"
   },
   "searchResults":[

   ],
   "searchToken":-1,
   "pageLimit":10,
   "pageOffset":0,
   "totalCount":0,
   "completeDetails":false,
   "prSearchType":"Detailed",
   "debug":false,
   "resultCount":0,
   "messages":{
				"Comment":"specify all the mandatory fields of at least one match ruleset." 
   }
}

sortField

Optional. Column name based on which you want to sort the search results lexicographically.

You can use one of the columns that you define in the

PZMAP

section of the configuration file to sort the search results. You can also use the parameter value as

score

to sort the results in the descending order of the search result scores. For example,

"sortField":"score"

searchType

Name for the search.

resultlimit

Optional. Maximum number of records that you want to return. Default is 0, which indicates to return a maximum of 200 records.

scoreThreshold

Optional. Minimum matching score of the records that you want to include in the results. Default is 0, which indicates to include all the records in the results.

ignoreMatch

Optional. Indicates whether to perform matching on the records retrieved based on the key ranges. Set to true to ignore matching, and set to false to perform matching. Default is false.

searchlayout

List of required search fields that you must specify.

Use the following format to specify a search field:

"<Field 1>": "<Field Value>"

searchToken

Optional. Indicates whether to enable pagination for the search results when you perform a search for the first time. If you enable pagination, the search request returns a token with the search results. You can use the token in the subsequent requests to get the search results from cache to avoid performing the search again.

When you run a search request for the first time, set

searchToken=0

to enable pagination. In the subsequent requests, you can use the token that the search request returns. For example,

searchToken=1994262671816343815

. Set

searchToken=-1

to disable pagination. By default, pagination is disabled.

pageLimit

Optional. Maximum number of search results to return. The

pageLimit

parameter is applicable if you enable pagination. For example,

pageLimit=20

returns 20 search results. Default is 10.

pageOffset

Optional. Number of search results to skip. The

pageOffset

parameter is applicable if you enable pagination. For example,

pageOffset=40

indicates to skip the first 40 search results and return search results starting from 41. Default is 0.