Multidomain MDM
- Multidomain MDM 10.4 HotFix 2
- All Products
Parameter
| Description
|
---|---|
RecordsToReturn
| Number of records to return.
|
MatchColumnField or RecordsToMatch
| Specifies which match columns or match rules are used for matching:
|
SiperianObjectUid
| Package or base object to search.
|
MatchType
| Specifies how match rules are used in the search. If you do not specify the MatchType,
SearchMatch uses the default MatchType of
NONE .
You can specify one of the following match types:
|
Parameter
| Description
|
---|---|
includePending
| includePending determines if
SearchMatch includes pending records in the results.
true :
SearchMatch includes pending records in results. "Enable match on pending records" must be enabled for the base object in the Match Merge Hub setup.
false :
SearchMatch does not include pending records in results. The default is
false .
This parameter has no effect for base objects for which State Management is not enabled. See the
Multidomain MDM Configuration Guide for more information on State Management.
|
sortCriteria
| A string containing a comma-separated list of column names and a sort direction. For example, "LAST_NAME ASC, FIRST_NAME ASC" returns the search results sorted by last name and then first name, in ascending order. Use DESC to sort in descending order. The results are returned in random order if you do not specify the sort order, unless the MatchType is
NONE .
If the MatchType is not
NONE , RecordsToReturn is specified, and sortCriteria is not specified, then the records are sorted based on the match score.
|
MatchRuleSetUid
| A string containing the name of a match rule set. If a match rule set is not specified using this parameter, SearchMatch uses the default match rule set.
You must use one of the following formats:
|
setDisablePaging
| This parameter determines if paging is disabled.
true : paging is disabled.
false : paging is enabled. The default is
false .
GetSearchResults to fetch subsequent pages of search results.
|
Field
| Description
|
---|---|
DEFINITIVE_MATCH_IND
| Indicates whether a match was made using a match rule enabled for automatic merging. Matches made using auto-merge match rules typically result in closer matches than those made using manual-merge match rules.
1 : Match made using an auto-merge match rule.
0 : Match made without using a manual-merge match rule.
|
RULESET_NAME
| Indicates which match rule set was used to make the match. The value for RULESET_NAME is
GENERATED SEARCH when the MatchType is
NONE .
|
RULE_NUMBER
| Indicates the rule number of the match rule that was used to make the match. The value for RULE_NUMBER is
1 when the MatchType is
NONE .
|
MATCH_SCORE
| Indicates the match score of the result.
If MatchType is equal to
NONE , SearchMatch returns the match score, if available, so that the search results can be ranked by the match score.
The match score is ignored when sorting if you specify a sort order using the sortCriteria parameter.
|
SearchMatchRequest request = new SearchMatchRequest(); request.setRecordsToReturn(5); request.setSiperianObjectUid("PACKAGE.PARTY_ADDRESS_READ_PKG"); Field orgNameField = new Field("Organization_Name"); orgNameField.setStringValue("EXAMPLES CORP"); request.addMatchColumnField(orgNameField); request.setSortCriteria("NAME DESC"); SearchMatchResponse response = (SearchMatchResponse) sipClient.process(request);
SearchMatchResponse response = new SearchMatchResponse(); int i=0; for(Iterator iter=response.getRecords().iterator(); iter.hasNext();) { //iterate through matched records System.out.println("Printing matched record " + i); Record record = (Record) iter.next(); BigDecimal definitiveMatch = record.getField("DEFINITIVE_MATCH_IND").getBigDecimalValue(); if(definitiveMatch.intValue()==1) System.out.println("Matched on an auto-merge rule"); Collection fields = record.getFields(); for(Iterator fieldIter=fields.iterator(); fieldIter.hasNext();) { //iterate through rest of fields Field f = (Field) fieldIter.next(); System.out.println(f.getName() + ": " + f.getValue()); } }