Matchcode

 

Example Name:                                          MCD

 

Language:                                                   VB

 

API type:                                                       .Net

 

API component filename:                        Capclasm.dll

 

Standalone server components:           CPSVRMC5.DLL, MCENG.DLL 

 

Environment:                                              Windows 2000, XP, Vista,

                                                                        Windows 7, (Using Visual Studio

                                                                        2008, .Net Framework 3.5) 

 

 

What does it do?

 

Demonstrates the use of, Focusing, Selecting, working with ambiguity lists, working with additional data-sets, and  searching using, Cross Match, Single Search, Rapid Addressing (searching using a postcode) and Quick Browse.

 

This example has been designed to work with, Capscan Client/Server (PoolMan), Capscan OnDemand (hosted web service) and Capscan Standalone server (single user installation) .

 

This example will work with both UK and international PAF files.

 

 

Could be used as a starting point for:

 

Creating an application to capture or verify a UK and/or international addresses, where you may need to have more of a flexible search option, EG: Organisation, Street…etc.   

 

 

Where to find the example code:

 

After running the setup from the Matchcode CD to install the client APIs you will find these examples installed (by default) in:

 

C:\Program Files\Capscan\SDK\Matchcode Client API\DotNet\Examples\VB

 

If you have installed to another location you will need to change the path where necessary.

 

 

What each file does:

 

File name                                         What does it do?

 

ConnectionDialog.vb                     Form used to select the server running the Capscan Pool                  Manager and to select the required pool.

 

InfoDialog.vb                                        Form used to display the pool information and available fields.

 

MatchcodeForm.vb                            The main form for searching and displaying the results.

 

Mcd.sln                                                 Visual Studio 2008 solutions file.                  

 

Spider.ini                                              Capscan Client/Server configuration file.

 

Standalone.ini                                     Standalone server configuration file.

 

 

Preparing to run the example:

 

Standalone Server:

 

1.       Obtain a Capscan User key and create the licence file.

 

2.       Copy the CPSVRMC5.DLL and MCENG.DLL to the folder containing the target application, this is usually bin/debug.

 

3.       Install the PAF data file and any additional dataset

 

 

Client/Server:

 

1.       Make sure that that you have installed the Capscan Pool Manager and that it is up and running.

 

 

Running the example:

 

1.       Make sure that the required libraries are in the search path.

 

2.       Open the MCD.sln solution file using Visual Studio 2008.

 

3.       In the solution Explorer, under References, make sure that there is a valid entry for the CAPCLASM.DLL.

 

4.       Make sure that the Solution Configuration is set to Debug.

 

5.       Press F5 to run the example.

 

6.       From the Connection window select the connection type, host server name (and for OnDemand, you account details) and pool and click OK.

 

7.       Once you have connected to the Capscan Pool Manager or OnDemand server you will presented with the main window where you can enter an address to search on.

 

8.       Enter an address or partial address in the Input field and then select one of the search types from the Search menu.

 

 

Trouble-shooting and hints:

 

Client/Server and OnDemand:

 

1.       If you are running on a LAN make sure that the Capscan Pool Manager is running correctly.  To do this you can use the PoolMan Admin application that is installed along with the Capscan Pool Manager.

 

2.       If you are using the Capscan OnDemand service make sure that you can see the Internet.

 

3.       If you are using a firewall make sure that it is not blocking this example or the Capscan Pool Manager.  By default the Capscan Client/Server uses port 27920 for sending and receiving data.

 

4.       Try installing and running the Matchcode DC application to test that the Capscan Pool Manger is working correctly.  The installation for Matchcode DC can be found on the CD under:

 

Api\mcd_cs\win32\client\dc.

 

5.       For more hints and tips please see the SDK bookshelf documentation.

 

 

Standalone Server:

 

1.       Check that Standalone.ini file is configured with the right paths for the data files and licence file.

 

2.       For more hints and tips please see the SDK bookshelf documentation.