4 Integrating with Capscan Matchcode
This chapter includes the following sections:
Software Requirements
You must have the Capscan Matchcode software installed on a system that is accessible to the EDQ Server. For more information, see the GBGroup Matchcode website found at http://www.gbgplc.com/products/matchcode/
.
Integrating the Capscan Matchcode Libraries into EDQ
EDQ includes a connector to the Capscan Matchcode API. EDQ includes a connector to the Capscan Matchcode API from GBGroup. This API provides address verification and cleansing features. This API provides address verification and cleansing features. Integrate the Capscan Matchcode Libraries into EDQ as follows:
Customizing the Matchcode API
Various aspects of the Capscan Matchcode API behavior can be controlled using the capscan.properties
file. It allows you to set the following properties:
-
capscan.jar
-
The location of the
capscan.jar
client API file in the EDQ installation. If you specify a relative path, the path must be relative to one of the directories in the EDQ configuration path. The default value is the relative pathcapscan/capscan.jar
. -
server.host
-
The IP address of the machine where Capscan Matchcode is running.
-
connection.timeout
-
A timeout period, in seconds, after which the Capscan Matchcode API will abort the search and return (a timeout period of zero indicates that there is no time limit on searches).
-
connection.type
-
The connection mode to use when communicating with the Capscan Matchcode API. The default connection mode is
CONNECTIONLESS
. The remaining options are:-
CONNORIENTED
-
STATELESS
-
WEBCONNECTION
-
ONDEMAND
For information about these connection modes, refer to the Capscan Matchcode API documentation.
-
-
number.capscan.connections
-
The number of connections that EDQ should make to the Capscan Matchcode API.
-
number.threads
-
The number of threads that should be used when communicating with the Capscan Matchcode API.
The default contents of the capscan.properties
file are as follows:
# This configuration file is configuring the CapScan processor # to be able to communicate with the CapScan server # # Capscan server name server.host = 127.0.0.1 # # Connection timeout in seconds (0 means no time out) connection.timeout = 30 # # The connection type to make to the CapScan server. # Possible values are: # # CONNORIENTED # CONNECTIONLESS # STATELESS # WEBCONNECTION # ONDEMAND connection.type = CONNECTIONLESS # # The number of connections the director server should # make to the CapScan server number.capscan.connections = 1 # # The number of threads that should be used to # communicate with the CapScan server number.threads = 1