| Previous Article | matchIT Hub Index | Next Article |
The following guides for integrating and using matchit Hub are available:
- Basic Configuration Guide
- Advanced Configuration Guide
- Configuration UI
- Integration Guide
- Language Reference Guides
- REST Service
- Spark Deployment
This topic gives you a quick start on a typical use case with Hub for lookup and batch deduplication, followed by notes on code samples and installation.
An easy way to try Hub for your matching needs is to integrate our REST Service - a typical use case for using the Hub Service in interactive Lookup mode is illustrated next, with notes on what you do differently for batch deduplication following on from that.
Create an engine
Firstly we tell the service to create an engine, e.g.
curl -X POST --data "activation_code=<activation_code>" http://localhost:8080/matchITHub/engines
{"status":"OK","engine":1}
Apply Settings
Now we give the engine some settings to use, e.g.
curl -X POST --data-urlencode "xml=<settings>...</settings>" http://localhost:8080/matchITHub/engines/1/settings
{"status":"OK"}
Add Data and tell the Service once all the data is loaded (EOF)
Now add your main universe of data into the engine and tell Hub once you've finished adding the data, e.g.
Upload a file of data:
curl -X POST --data-urlencode "filename=D:\testdata\inputfile.txt" --data-urlencode "delimiter=\t" --data-urlencode "encoding=UTF-8" --data "nomore=true" http://localhost:8080/matchITHub/engines/1/tables/1/files
{"status":"OK"}
Perform Lookups against the loaded data
You're now ready to perform lookups against your universe, e.g. searching with 'JOHN,TATTLE,,,BIRMINGHAM,,B3 3ER'
CURL call to execute the lookup:
curl -X POST --data-urlencode "data=,,JOHN,TATTLE,,,BIRMINGHAM,,B3 3ER" http://localhost:8080/matchITHub/engines/1/lookup/
Results:
{"status":"OK","results":["\t4\tJOHN TATTLE\tINFORMATION SYSTEMS MANAGER\tFRINTON WILKES PLC\t12 NEWHALL STREET\tBIRMINGHAM\tWEST MIDLANDS\tB3 3ER\t\t1\t117\t0\t0\t0\t0\t0","\t71\tMR J RATTLE\tIT MANAGER\tFRINTON WILKES LTD\tEDMUND HOUSE\t12 NEWHALL STREET\tBIRMINGHAM\tB3 3ER\t\t1\t97\t0\t0\t0\t0\t0"],"count":2}
Delete the engine, once you no longer need it:
e.g.
curl -X DELETE http://localhost:8080/matchITHub/engines/1
{"status":"OK"}
Batch Matching
If you’re performing batch matching (finding all the duplicates in a set of data rather than a single record lookup), then you would simply request your results having loaded the data, rather than performing lookups, e.g.
https://support.syniti.com/hc/en-us/articles/5875457158807-H5-3-7-Results
Code Examples
As well as the documentation here, there is a small demo program that will be found following install (on windows) which can be used to setup an engine and load some data for interactive lookup:
C:\Program Files\matchIT Hub Service\client
Additionally if you run the program under:
C:\Program Files\matchIT Hub Service\samples
– then it will install a whole set of code examples (under Documents\matchIT Hub Service on windows) showing how to call & integrate the service directly in various languages (Java, C# etc).
Postman
If you have Postman, then you can import a Postman collection which is any easy way to try out the REST methods – for documentation see below.
https://support.syniti.com/hc/en-us/articles/5875431467415 (documentation of postman collection)
Docker
If you’re interested in looking at our Docker container, then this is well covered here (including how to migrate to it from an existing installation):
https://hub.docker.com/r/360science/hub
Note that installation of the service on Windows is explicitly covered in the documentation since it’s as simple as just running the installer and following the on screen instructions. For Linux, we supply a TAR file that you simply extract on to your target server.
https://support.syniti.com/hc/en-us/articles/5875456691223-H5-2-REST-Service-Configuration
| Previous Article | matchIT Hub Index | Next Article |