Custom Dataset Builder Commands - 23.1

Spectrum Global Geocoding Guide

Product type
Software
Portfolio
Locate
Product family
Spectrum
Product
Spectrum > Geocoding > Global Geocoding
Version
23.1
Language
English
Product name
Spectrum Technology Platform
Title
Spectrum Global Geocoding Guide
Topic type
Installation
Overview
How Do I
Reference
Configuration
Copyright
2023
First publish date
2007
ft:lastEdition
2024-02-17
ft:lastPublication
2024-02-17T09:43:31.076389
Note: Before using the Custom Dataset Builder commands, identify the paths to all installed Spectrum Global Geocoding datasets.

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 Custom Dataset Builder 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) the user can use later to generate the initial configuration per country per supported language.
    java -Xmx512m -jar cdb<version>.jar
    -engine="Typeahead/Geocoding" -findCountryWithLanguage-folderLocation="$folderLocation" -usePackagedLib
    Parameters for the findCountryWithLanguage command:
    • engine: optional parameter [Typeahead/Geocoding] defines which type of supported countries and languages will be fetched.

      -engine=Typeahead will fetch Typeahead-supported countries and languages.

      -engine=Geocoding will fetch Geocoding-supported countries and languages.

      If a parameter is not provided, it will fetch geocoding-supported countries and languages by default .

    • folderLocation: value will be parent folder location where all the SPD’s are placed in extracted format
    • usePackagedLib: optional parameter [required for USA] that uses the libraries bundled with the Custom Dataset Builder tool instead of using the library from the SPD.
  • 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.
    java -Xmx512m -jar cdb<version>.jar –createConfig
    -engine="Typeahead/Geocoding" -folderLocation="$folderLocation"
    -country="$country_code"-dataType="$data_type" -language="$language_code"
    -userProfile="basic/advance" -usePackagedLib
    Parameters for the createConfig command
    • engine: optional parameter [Typeahead/Geocoding] defines which type of JSON file the Custom Dataset Builder will generate.

      -engine=Typeahead will generate Typeahead-specific JSON.

      -engine=Geocoding will generate Geocoding-specific JSON.

      If a parameter is not provided, it will generate Geocoding-specific JSON by default.

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

      This option only applies when the -engine=Geocoding argument is provided or no -engine is provided. It does not apply for -engine=Typeahead because there will be no advanceConfig element in the Typeahead JSON file.

      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.

    • usePackagedLib: optional parameter [required for USA] that uses the libraries bundled with the Custom Dataset Builder instead of using the library from the SPD.
  • 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.
    java -Xmx512m -jar cdb-<version>.jar -buildAll -engine="Typeahead/Geocoding" -folderLocation=
    "$folderLocation" -userProfile="basic/advance" -usePackagedLib

    Parameters for the buildAll command

    • engine: optional parameter [Typeahead/Geocoding] defines which type of JSON file the Custom Dataset Builder will generate.

      -engine=Typeahead will generate Typeahead-specific JSON for all supported countries and languages.

      -engine=Geocoding will generate Geocoding-specific JSON for all supported countries and languages.

      If a parameter is not provided, it will generate Geocoding-specific JSON by default.

    • folderLocation: value will be parent folder location where all the SPD’s are placed in extracted format
    • 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.

      This option only applies when the -engine=Geocoding argument is provided or no -engine is provided. It does not apply for -engine=Typeahead because there will be no advanceConfig element in the Typeahead JSON file.

      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.

    • usePackagedLib: optional parameter [required for USA] that uses the libraries bundled with the Custom Dataset Builder tool instead of using the library from the SPD.
  • createDictionary: Once the user is done with all the relevant configuration as described in the createConfig command, the command lets the user initiate the build process of onboarding the user data into the Precisely geocoding software consumable format.
    java -Xmx512m -jar cdb<version>.jar -engine="Typeahead/Geocoding" -createDictionary
    -folderLocation="$folderLocation"
    -configFilePath="$configFilePath" -usePackagedLib
    Parameters for the createDictionary command
    • engine: optional parameter [Typeahead/Geocoding] defines which type of user data the Custom Dataset Builder will create.

      -engine=Typeahead will create Typeahead-specific user data.

      -engine=Geocoding will generate Geocoding-specific user data.

      If a parameter is not provided, it will generate Geocoding-specific user data by default.

    • 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
    • usePackagedLib: optional parameter [required for USA] that uses the libraries bundled with the Custom Dataset Builder tool instead of using the library from the SPD.