Skip to main content

Appendix E - Configuration Guide - Post-Matching Rule Functions

Lauren Wheeler
  • Updated
Previous Article matchIT Hub Index Next Article 

The following functions can be used in Advanced Post-Matching Rules.

Functions returning True/false

  • LEVEL(matching_level) - Returns true if the match is at the specified level (see below for a definition of matching_level);
  • KEY(integer_value) - Returns true if the specified key was used to find the match (keys are numbered sequentially in the order they are defined in the config starting from 0);
  • RULESET(integer_value) - Returns true if the specified ruleSet was used to find the match (ruleSets are numbered sequentially in the order they are defined in the config starting from 1);
  • ACRONYMMATCH() - Returns true if acronym matching was used;
  • CONTAINS(field1,field2) - Returns true if field1 contains field2;
  • CONTAINS(field,string_value) - Returns true if field contains the specified string literal;
  • NAMEMATRIX(matrix_index1,matrix_index2,matrix_index3) - Returns true if the specified name matrix entry was used (see below for a definition of matrix_index);
  • ORGANIZATIONMATRIX(matrix_index1,matrix_index2,matrix_index3) - Returns true if the specified organization matrix entry was used;
  • RECORD(logical_expression) - Returns the Boolean value of the logical expression when applied to a single record. For example, “Record(ForeNames==Lastname)” returns true if ForeNames matches Lastname in either record.;
  • MATCHES(field) - Returns true if the specified field is the same within the two matched records. For example, “Matches(Town)” returns true if the town is the same in both records;
  • BOTHEMPTY(field) - Returns true if the specified field is blank within both records;
  • ONEEMPTY(field) - Returns true if the specified field is blank within one (but not both) of the records;
  • SOUNDSEQUAL(field) - Returns true if the specified field sounds equal;
  • APPROX(field) - Returns true if the specified field matches approximately;
  • SOUNDSAPPROX(field) - Returns true if the specified field sounds approximately;
  • LOCATIONMATCH - Returns true if the location is matched; (From version 2.0.3)
  • PREMISELOOSE - Returns true if the premise is loosely matched; (From version 2.0.3)
  • PREMISETIGHT - Returns true if the premise is tightly matched; (From version 2.0.3)
  • PREMISEONEEMPTY - Returns true if one of the records in the match has an empty premise; (From version 2.0.3)
  • DIRECTIONALUNMATCHED - Returns true if the directional is unmatched; (From version 2.0.3)
  • NUMERICSTREETUNMATCHED - Returns true if a numeric street is unmatched; (From version 2.0.3)
  • BUILDINGMATCH - Returns true if the building is matched; (From version 2.0.3)
  • BUILDINGONEEMPTY - Returns true if one of the records in the match has an empty building; (From version 2.0.3)

Functions returning a string

N.B. The string functions RECORD1() and RECORD2() are really only meaningful in overlap mode, where record 1 comes from the main table and record 2 comes from the overlap table.

  • RECORD1(field) - Return the value of the field from record 1;
  • RECORD2(field) - Return the value of the field from record 2;

Functions returning an integer

  • LENGTH(field) - Returns the length of a field;

Where:

  • matching_level is one of:
    • IndividualLevel
    • FamilyLevel
    • AddressLevel
    • BusinessLevel
    • Custom
  • matrix_index is one of:
    • EqualIndex
    • SoundsEqualIndex
    • BothEmptyIndex
    • OneEmptyIndex
    • ApproxIndex
    • SoundsApproxIndex
    • ContainsIndex
    • UnequalIndex

Logical operations involving the LENGTH() or CONTAINS() functions are true if the condition applies to both records. If you want to test the length or value of either record use the RECORD() function - i.e.: Record(Length(field) LT 4)

Previous Article matchIT Hub Index Next Article 

 

Related articles