Not available in Community Designer

When running on IBM Java (e.g. in WebSphere), make sure to add the following JVM parameter to prevent AddressDoctor from crashing the JVM:

-Xmso2048k

See IBM WebSphere in CloverETL Server Manual.

When using AddressDoctor with CloverETL Server, paths to the libraries need to be configured differently. The AddressDoctor5.jar java library needs to be placed on the classpath of the application server. This is specific for each application server, for example with Tomcat you need to place it into the lib directory of your Tomcat installation. Path to the directory with the native library needs to be added to the java library path via the java.library.path Java property. This is also application server specific, in Tomcat you can create the bin/setenv.bat (or bin/setenv.sh) file and add the following line set "CATALINA_OPTS=%CATALINA_OPTS% -Djava.library.path=path/to/AddressDoctor/library/directory".

Continue with AddressDoctor 5 Configuration

The Configuration dialog enables you to set up database location and Unlock Code using graphical user interface.

Open the attribute Configuration and set up a path to database file on DataBase tab.

Do not forget your database is supplied in one of the modes (e.g. BATCH_INTERACTIVE) and thus you have to set up a matching Type (applies to Enrichment databases set in Parameters, too).

Figure 55.1. DataBase Configuration

To use the database you need to set up Unlock Code on tab UnlockCode.

Warning

AddressDoctor engine is shared by all components running in the same JVM. That means that all AddressDoctor components in the same graph should have the same Configuration (or Configuration file). If the configurations differ, AddressDoctor engine will be initialized with the settings from one of the components, but the settings will be used by all of them. Note that in CloverETL Server environment, the settings are shared between all running graphs. Therefore it is recommended to set the configuration globally using the com.opensys.cloveretl.addressdoctor.setConfigFile Java system property: -Dcom.opensys.cloveretl.addressdoctor.setConfigFile="<absolute path to SetConfig.xml>"

Tip

By default, AddressDoctor engine is initialized on demand when a graph with AddressDoctor component is executed and de-initialized when it is not needed. This lowers memory requirements, but introduces re-initialization overhead. Setting the com.opensys.cloveretl.addressdoctor.persistent Java system property to true will prevent AddressDoctor engine from being de-initialized: -Dcom.opensys.cloveretl.addressdoctor.persistent=true

Database Configuration File enables to set up address database location and Unlock Code.

Create a configuration file a set up Config file attribute to point to the configuration file.

The configuration file contains following lines:

<?xml version="1.0" encoding="utf-8"?>
<SetConfig>
	<General WriteXMLEncoding="UTF-16" WriteXMLBOM="NEVER" MaxMemoryUsageMB="1024" MaxAddressObjectCount="10" MaxThreadCount="1"/>

	<UnlockCode>Here place your code ...</UnlockCode>
	<DataBase CountryISO3="ALL" Type="BATCH_INTERACTIVE" Path="C:/AddressDoctor" PreloadingType="NONE"/>
</SetConfig>

You should replace text Here place your code ... by your valid Unlock Code.

Parameters controls what transformation will be performed. Particular settings are highly specific and should be consulted with the official AddressDoctor 5 documentation.

For instance in the Process tab of the dialogue, you can configure various Enrichments. The enrichments allow you to add certificates of the address format. The certificates guarantee that a particular address format matches the official format of a national post office. Note that adding Enrichments usually slows the data processing and can optionally require an additional database.

Figure 55.2. AddressDoctor Parameters

Input mapping determines what will be processed. You work with a wizard that lets you do the settings in two basic steps:

Output mapping - here you decide what will be mapped to the output, i.e. the first output port. Optionally, you can map data to the second "error" port (if no such mapping is done, error codes and error messages are generated).

Similarly to Input mapping, you do the configuration by means of a clear wizard comprising these steps:

The Number of threads attribute can be used to increase the throughput of the component by using additional threads for address processing.

Multithreading is also influenced by the Configuration attribute. Max thread count is a total limit on the number of threads concurrently accessing the AddressDoctor library (e.g. from multiple AddressDoctor components). Typically it can be set to the same number as Number of threads attribute if using one AddressDoctor component. Additionally, for each thread requested by Number of threads two address objects will be used (see Max address object count in Configuration).

Multithreading preserves the order of output records.

	Tip
	It is recommended to use full database preloading to prevent the threads from blocking on file system calls. The Max memory usage option should be configured accordingly to accommodate all the used databases and address objects.