Standard Fields

This table lists some of the standard fields you come across in matching tasks, and gives description of these fields.

Fields Descriptions
CandidateGroup This field identifies a grouping of a suspect record and its candidates. Each suspect record is given a CandidateGroup number. The candidates for that suspect are given the same CandidateGroup number. For example, if John Smith is a suspect record and its candidate records are John Smith and Jon Smth, then all three records would have the same CandidateGroup value.
CollectionNumber Identifies a collection of duplicate records. The possible values are 1 or values greater than 1. Records flagged with same value are duplicate records.
CollectionRecordType Identifies the template and best of breed records in a collection of duplicate records. The possible values are:
  • Primary: The record is the selected template record in a collection.
  • Secondary: The record is not the selected template record in a collection.
  • BestOfBreed: The record is the newly created best of breed record in the collection.
ExpressMatchIdentified Indicates whether the match was obtained using the express match key. The possible values are Yes or No.
HasDuplicates Identifies whether the record is a duplicate of another record. The options are:
  • Y : The record is a suspect record and has duplicates.
  • N : The record is a suspect record and has no duplicates.
  • D : The record is a candidate record and is a duplicate of the suspect record.
  • U : The record is a candidate record but is not a duplicate of the suspect record.
MatchRecordType Identifies the type of match record in a collection. The possible values are:
  • Suspect : A record that other records are compared to in order to determine if those are duplicates of each other. Each collection has one and only one suspect record.
  • Duplicate : A record that is a duplicate of the suspect record.
  • Unique : A record that has no duplicates.
MatchScore Identifies the overall score between two records. The possible values are 0-100, with 0 indicating a poor match and 100 indicating an exact match. Scores are generated basis the match rule is configured.
TotalMatchCount This field indicates the total number of matches that were made during processing.
TransactionRecordType It can be one of these:
  • Suspect: A suspect record is used as input to a query.
  • Candidate: A candidate record is a result returned from a query.