Custom Dataset Builder Commands
Custom Dataset Builder commands are executed from the command line from the root of the installed location of the tool. Each command has a leading – (hyphen). The available commands are:
- help: Provides the user a list of commands which Custom Dataset Builder offers
to the customer, and educates them on how to utilize those to onboard their data
effectively
java -Xmx512m -jar cdb-<version>.jar –help
- findCountryWithLanguage: This command enables you to understand what countries
are supported by the CDB to create custom data. In addition, it provides information about
the language of the data. Both are being written to a text file (placed parallel to the
cdb-<version>.jar) that the user can use later to generate the initial configuration
per country per supported language.
Parameters for the findCountryWithLanguage command:Usage: java -Xmx512m -jar cdb-<version>.jar –help
- folderLocation: value will be parent folder location where all the SPD’s are placed
in extracted format
java -Xmx512m -jar cdb-<version>.jar -findCountryWithLanguage -folderLocation="$folderLocation"
- folderLocation: value will be parent folder location where all the SPD’s are placed
in extracted format
- createConfig: This command enables the user to create a country-specific configuration, which is a JSON file, which contains the step-by-step mapping of the user data information to onboard their data.
Parameters for the createConfig command
- folderLocation: value will be parent folder location where all the SPD’s are placed in extracted format
- country: mandatory information, which is required for generating any of the configuration which user needs to provide and country for which the configuration file needs to be created. Country information is passed as a 3-letter ISO code only.
- language: optional field, which provides the user to specify the language of the data user wants to onboard. In addition, this field needs to match with the current offering by Pitney Bowes geocoding software. By default the value of this field is set to “en” – which is Latin or plain English.
- datatype: optional parameter which specifies the type of data being intended to onboard – Ranged data maps to “Street” while the point data maps to “AP”. Example: datatype=Street
- userProfile: optional parameter. Based upon the technical aspect of the user, the configuration can be basic or advanced. Basic being default. Basic creates default JSON without having any advanced configuration in it.
Advanced persona of the user profile has the entire configuration as offered by the basic, but also offers some additional config elements and is not supported for DEU, CAN and USA.
java -Xmx512m -jar cdb-<version>-.jar -findCountryWithLanguage -folderLocation="$folderLocation"
- buildAll: Similar to the createConfig command, the buildAll command enables the user to create a configuration of all the supported countries and languages at once.
Parameters for the createConfig command
- folderLocation: value will be parent folder location where all the SPD’s are placed in extracted format
- userProfile: optional parameter.
Usage: java -Xmx512m -jar cdb-^<version>.jar -buildAll -folderLocation= "$folderLocation" -userProfile="basic/advance"
- createDictionary: Once the user is done with all the relevant configuration as described in the createConfig command, the command lets the user to hit the switch to initiate the build process of onboarding the user data into the Pitney Bowes geocoding software consumable format
Parameters for the createDictionary command
- configFilePath: argument is the absolute path of the JSON file.
- folderLocation: value will be parent folder location where all the SPD’s are placed in extracted format
USA Configuration
USA Configuration
You need to provide certain values in USA_DataManagerSettings.properties for creating custom datasets with USA data. The properties file is located alongside the cdb-<version>.jar.
DICTIONARY_PATH1: value will be the path of the folder where the USA address dictionaries are present in extracted format.
LIB_PATH: value will be the path of the OS-specific DLL’s available in the GGM module’s bin. Example:
LIB_PATH="..\Spectrum\server\modules\GlobalGeocode\bin"
java -Xmx512m -jar cdb-<version>.jar -createDictionary -folderLocation="$folderLocation" -configFilePath="$configFilePath"