Explore LABS


S7 - matchIT SQL Reporting outputs

Previous Article matchIT SQL Index Next Article 

matchIT SQL is able to produce a summary report on completion of certain stored processes.  These reports can be output to a file using one of the several available formats (note that the ‘type’ attribute is used within XML configuration files to specify the reports’ format):


  • PDF (Portable Document Format; type=pdf).
  • RTF (Rich Text Format; type=rtf).
  • Microsoft Excel (97-2003; type=xls).
  • Microsoft Excel (97-2003; raw data only; type=xls2).
  • HTML 3.2 (tables; type=html3).
  • HTML 4.0 (type=html4).
  • Crystal Report (type=rpt).


Additionally, report statistics are output to a new uniquely-named table within the data source.

Reports are produced for the following stored procedures.  In most cases the collected data is either self-explanatory or uses standard helpIT systems terminology unless detailed below:

  • GenerateKeys – Note excluded records can be identified if the first character of a mkDataFlags value is an ‘X’.
  • BulkGenerateKeys - See GenerateKeys.


Note that you can use the setting outputSettings->reports in your configuration file to specify whether reports should be generated or not on a process by process basis. Look for the outputSettings node, then the reports node, and change its enabled attribute to false

Alternatively you can permanently disable reporting by editing the necessary configs and templates with a text editor

- C:\matchIT SQL\SSIS\templates (if you're using SSIS only you can likely stop here and ignore the rest of the article, we suggest using a copy of the template so you're safe from losing changes from a reinstall/upgrade)

- C:\matchIT SQL\config (optional if you're using SSIS only)

- C:\matchIT SQL\demo (optional)

It is also possible to disable reporting in the registry which will prevent reporting being re enabled the next time you reinstall which will occur if you are using the default SSIS templates. If you're just getting started it would likely be easier to uninstall then reinstall without reporting. Otherwise you will need to remember to make the changes in above every time you reinstall or upgrade if you are using the default templates.

Disabling reporting in the Registry:

Run regedit.

Locate the matchIT SQL key (HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\matchIT SQL).

Edit the Features value; change REP=1 to REP=0 (be careful here!).

Close regedit.


It is possible to incorporate a custom logo into the reports in place of the default matchIT SQL logo that displays on the top right of the first page of each report.  To do this, simply save your logo as “ReportLogo.jpg” and place it in the matchIT SQL bin directory (which by default is C:\Program Files\matchIT SQL\bin).  Once in this location, the report creation process will automatically detect and use the custom logo you have provided.  With regards to the dimensions of the logo, to match the size of the default matchIT SQL logo you should create the logo on a canvas of 371px wide by 106px high.

As well as incorporating a custom logo into the report, it is also possible to include a website address and contact name (each of which appears in that order under the logo on the top right of the report).  To do this, simply add a ‘contactWebsite’ and ‘contactName’ to the ‘reports’ node in the XML configuration file that is being called by the stored procedures (or the template being used in the case of SSIS).  An example of this can be seen here. Note that the attribute names are case sensitive.

<reports enabled="true" path="C:\matchIT SQL\reports" format="pdf" schema="reports" index="index" maxIndexEntries="1000" contactName="John Smith" contactWebsite="www.domain.com">


7.1      GenerateCorrectedAddresses Summary Report

The GenerateCorrectedAddresses Summary report is produced at the end of the GenerateCorrectedAddresses process and will look similar to the following screenshot.


The report provides general figures reflecting the number of records falling into each verification level. These figures are also displayed in the form of a bar graph and a pie chart, to make general inspection easier to read and any problematic results easier to notice.


7.2      FindMatches Summary Report

The FindMatches Summary report is produced at the end of the FindMatches process and will look similar to the following screenshot.


The FindMatches process produces the following information:


Reporting Category


Total Records

‘Total records’ refers to both the total number of records in the table, for each key, and the sum of these.

Records Read

‘Records read’ refers to the number of records that are considered for further comparison by the matchIT API. If pre-clustering is enabled (the default) then this figure will usually be substantially lower than the total number of records in the table.


‘Comparisons’ refers to the number of record pairs that are compared by the matchIT API.


‘Duplicates’ refers to both the number of duplicates found by a particular key and to the sum of these.


‘Matches’ refers to a final number of unique duplicates (for example, one particular match might be found using two different keys, causing a duplicate count of 2 but a correct match count of just 1).

Large clusters

‘Large clusters’ refers to groups (clusters) of potential matches that are too big to be processed (i.e. the number of records exceeds the maximum cluster size).


‘Errors’ refers to processing errors within the matchIT API; details of such records are logged (wherever possible, please forward these records to 360Science).



7.3      FindOverlap Summary Report

See FindMatches.


7.4      GroupMatches Summary Report

This report is produced at the end of the GroupMatches process and will look similar to the following screenshot.



  • Proportion of Duplicates – indicates the percentage of records that matchIT SQL has identified as being duplicated records.
  • Matches by Score Range - indicates the number of matches in each scoring range, based on the minimum and maximum matching scores.

7.5      GroupOverlap Summary Report

See GroupMatches.

7.6      FindExactMatches Summary Report

See FindMatches. Note, however, that records are not compared using the matchIT API, two records are deemed exact matches simply if their composite key values are identical.


- ‘Records skipped’ refers to records that have a blank composite key value; blank key components are indeed permitted, but they can’t all be blank. (For example, if the composite key is ‘mkNameKey+mkAddressKey+mkPostOut+mkPostIn’, then a record will be skipped if all of these keys are blank; two records will be considered an exact match if any key is not blank and their composite key values are identical.)

7.7      FindExactOverlap Summary Report

See FindExactMatches.

7.8      GroupExactMatches Summary Report

See GroupMatches.

Note, however, that there is no ‘scores’ section (exact matches are not given a score, they either exactly match or they don’t).

7.9      GroupExactOverlap Summary Report

See GroupExactMatches.


Previous Article matchIT SQL Index Next Article
Was this article helpful?
0 out of 0 found this helpful


Please sign in to leave a comment.