Adding a Spectrum Global Geocoding Database Resource

Whenever you install a new database resource or modify an existing database resource you must define it in the Management Console in order for it to become available on your system. This procedure describes how to add or modify a Spectrum Global Geocoding database resource.

  • Before configuring multiple database resources, confirm if there are any applications using the REST API from Spectrum Global Geocoding. REST API calls will need to be modified to include the database name so it does not conflict with any new database resources.
  • If you want to use this capability and you have existing data flows, review and update any data flow database resources. Otherwise, no changes to data flow database resources are necessary.
    Note:
    In terms of backwards compatibility, when older flows are imported, they will default to the latest database created on 2019.1.
  1. If you haven't already done so, install the dataset files on your system, using the command line interface (CLI) commands. For instructions on installing databases, see the Geo Addressing SDK Installation Guide.
  2. In Management Console, under Resources, choose Spectrum Databases.
  3. To create a new database resource, click the Add button . To make changes to an existing database resource, select it, then click the Edit button . To delete a database resource, select it, then click the Delete button .
    Note:
    You can copy a Global Geocoding database resource to use for another installed module; however, a copy of a database resource cannot be made for the Spectrum Global Geocoding since it can only have one database resource.
  4. If you are creating a new database resource, on the Add Database page, enter a name for the database resource in the Name field.
  5. In the Pool size field, specify the maximum number of concurrent requests you want this database to handle.

    The optimal pool size varies by module. You will generally see the best results by setting the pool size between one-half to twice the number of CPUs on the server, with the optimal pool size for most modules being the same as the number of CPUs. For example, if your server has four CPUs you may want to experiment with a pool size between 2 (one-half the number of CPUs) and 8 (twice the number of CPUs) with the optimal size possibly being 4 (the number of CPUs).

    Tip:
    You should conduct performance tests with various settings to identify the optimal pool size and runtime instance settings for your environment.
  6. In the Module field, select GlobalGeocode. In the Type field, use the default shown, Global Geocode Dataset.
    If you had extracted your .SPD files and placed them in the \server\app\dataimport folder, Spectrum would automatically add them to the \repository\datastorage folder. You will see a list of datasets in the Add Database screen.
  7. Select the dataset(s) you want to add to the database as a resource. Use the Filter text box to search for a dataset when you have a long list.
    If you are configuring the database resource for use by a dataflow that produces CASS certificated output files and USPS CASS Form 3553 reports, select only the following datasets. Make sure all the bundles have the same vintage.
    • DPV
    • LACSLink
    • RDI
    • SuiteLink
    • USA-USPS
  8. Save the database.
  9. If you have a custom dictionary you wish to geocode against, click the Add button and provide a name, country and path to the dictionary. Do not use the Add button to add datasets to the standard database.
    A custom database is a user-defined database that contains addresses and latitude/longitude coordinates that you can use for geocoding.
    Note:
    You must have a licensed standard database on your system in order to configure and geocode to a custom dictionary.
  10. If there are any open Enterprise Designer sessions, click the refresh button to see the new stage.
  11. If necessary, select the Override advanced settings checkbox to adjust Java Properties, Environment Variables, or supply command line processing arguments. If you are configuring the database resource for use by a dataflow that produces CASS certificated output and reports, you must edit Java Properties to enable CASS Certification.
Note:
If the database fails to configure due to insufficient resources, you may need to increase the Java Virtual Machine (JVM) initial heap size (Xms) and/or add the max heap size (Xmx) value by modifying the java properties values as shown in the below section.

Adding Java Properties

This feature provides a way to define extra command line arguments in Spectrum Management Console, rather than setting up a property file that you would reference for processing. This makes it easier to define and maintain database settings across Spectrum Technology Platform, especially in a clustered environment.

  1. To add a new Java property or environment variable:
    1. Select either Java Properties or Environment Variables to expand the list of existing properties.
    2. Select the Add button to display a blank input line.
    3. Add a Name and Value for the new entity.
    4. Click Enter to save the new entity.
  2. To delete a property or variable:
    1. Select either Java Properties or Environment Variables to expand the list of existing definitions.
    2. Select the checkbox next to the entity to delete.
    3. Click the Delete button , above the entity list, to delete the setting.
      Note:
      You will not see a confirm message when you select the delete button.
  3. To configure the database resource for a dataflow used to produce CASS certified output and reports:
    Set the Java Properties setting CASS_CERTIFICATION value to true.
  4. Specifying command line properties:
    Use this field to define command line properties that are not memory-related settings and cannot be expressed as Java properties.
    Note:
    We suggest that you change these settings with caution, as they can affect processing globally.