Zapcode

Example Name: ZCDWebService

Language: VB

API type: ActiveX

API component filename: ZcClicon.dll

Environment: Windows 2000, XP, Vista, Windows 7 (Using Visual Studio 2008, .Net Framework 3.5)

What does it do?

Demonstrates the use of, communicating with the Capscan Pool Manager, searching, and working with ambiguity lists.

Also demonstrates calling the web service from a web form.

Could be used as a starting point for:

Capturing or verifying an address from a web interface using a postcode. 

Where to find the example code:

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

C:\Program Files\Capscan\SDK\Zapcode Client API\ActiveX\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?

ZCDWebService.asmx.vb The web service code file.

ZcClicon.Interop.dll You need to add a reference to this file if you are going to be calling the ActiveX from a .net application.

ZCDWebService.sln Visual Studio 2008 solutions file.

ZCDWebService.dll The web service binary built by this project.

Spider.ini Capscan Client/Server configuration file.

Test Form Folder containing a web form for testing the web service.

Preparing to run the example:

Please make sure that you have:

1. Installed the Capscan Pool Manager and that it is up and running.

2. Installed and configured Microsoft IIS.

3. Registered the ActiveX control. To do this:

i. Open a DOS prompt in the same folder as ZcClicon.dll.

ii. At the prompt type in the following and press enter:

regsvr32 ZcClicon.dll

Running the example:

1. Make sure that the API library is in the search path.

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

3. In the solution Explorer, under References, make sure that there is a valid entry for the ZcClicon.Interop.dll.

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

5. In the solution Explorer expand the Test Form folder.

6. Right click on ZCDWebForm.asmx and from the context menu select View in Browser.

7. Enter a postcode in the Input field and then click the search button.

Trouble-shooting and hints:

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 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.

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

Api\zcd_cs\win32\client\zapcode

4. To deploy a web service in a live environment you will need to copy the binary to the wwwroot/bin folder under IIS.

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