Creating a New Geocoder Configuration

Spectrum Spatial Analyst can supports multiple Geocoding databases. While creating a new global Geocoding configuration, administrators can select a database and the supported country in Spectrum Spatial Manager. As a result, when a Spectrum Spatial Analyst user searches for an address, ZIP Code or place name, the search results are fetched from the selected database and country only.

To create a new geocoder configuration:

  1. Open the Geocoder Configuration page.
  2. Click on the Create New button.
    A new Geocoder Configuration page appears.
  3. Enter the name of the geocoder in the Name text box.
    Note: Any special characters are not supported in name. You cannot create a configuration with the an existing name.
  4. Enter the repository path in the Repository folder text box to save the new geocoding configuration.
  5. You can also click on the button. The Select a Folder dialog box opens.
  6. Click on the New Folder button to create a new folder or you can select a folder from the list.
  7. Select one of the following Deployment option.
    • OnPremise. For more information see, OnPremise.
    • Spectrum-on demand. For more information see, Spectrum-on demand.
    • Precisely Developer APIs. For more information see, Precisely Developer APIs.
      Deployment Option Possible Geocoding Configuration
      OnPremise
      1. Global Geocoder with GBR
      2. Only Interactive Geocoder
      3. Global Geocoder with Interactive - A global geocoder with interactive configuration will display address as well as address range on the Spectrum Spatial Analyst search result. An address within the address range will point to the same location. For example, a multi-level building at a location may have different commercial establishments at different levels. They will all have same location but different addresses.
      Spectrum-on demand
      1. On-Demand GBR
      Precisely Developer APIs
      1. LI-API Geocode USA
      2. LI-API Geosearch GBR
      3. LI-API GeosearchGeocodeGBR
  8. Select any one Deployment option. You can select from On Premise or Spectrum-on demand or Developer APIs.
  9. If you select On Premise option, you will get following options:
    OptionDescription
    Base URL Enter the service URL in the Base URL text box. For example, http://<server>:<port>/
    User name Enter the user name.
    Password Enter the password.
    Verify Click to verify the Base URL. The Save option is available only when the verification is successful. In case of wrong credentials, the save option will be disabled.
    List of Available Services Click to see the list of available services for GCM, EGM and GGM.
    Country Code Enter the country code.

    For more information, refer to Country Reference Listing and ISO 3166-1 Country Codes in the Global Geocoder Country Codes Guide on support.precisely.com.
  10. If you select Spectrum-on demand option, you will get following options:
    Option Description
    Database URL Enter the Database URL.
    Username Enter the user name.
    Password Enter the password.
    Verify Click to verify the Base URL.
    Service Select the service from the drop-down list. You can select from
    • EGM (Enterprise Geocoding Module)
    • GGM (Global Geocoding Module)
    Country Code Enter the country code.
    Database Enter the name of used database.
    Note: This option is available only for GCM.
    Geocode Preferences This option is available with GGM only. Using the Geocoding preferences options enables the geocoder to attempt to return a less precise geocode when an address-level geocode cannot be determined.
    Fallback to postal It attempts to return a postal code centroid.
    Fallback to geographic It attempts to return a centroid of a geographic area.
    Match Mode Match modes determine the leniency used to make a match between the input address and the reference data. Select a match mode based Match Mode String on the quality of your input and your desired output. The following match modes are available:
    Standard Requires a close match and generates a moderate number of match candidates. Default.
    Relaxed Allows a loose match and generates the most match candidates, which increases the processing time and Relaxed results in more multiple matches. Use this mode if you are not confident that your input is clean; free of misspellings and incomplete addresses.
    Exact Requires a very tight match. This restrictive mode generates the fewest match candidates, which decreases Exact the processing time. When using this mode, ensure that your input is very clean; free of misspellings and incomplete addresses
    Custom Allows you to define the matching criteria by setting Custom Mode Must Match Fields
    >Interactive Available in single-line address matching only. This mode is designed to better handle the specific matching Interactive challenges presented by interactive matching. Interactive mode permits for more flexible matching patterns and may, in some cases, return additional possible matches than relaxed match mode.
    Note: It should be used only for USA. Please refer the Spectrum document once.
    CASS Imposes additional rules to ensure compliance with the USPS CASS regulations. The purpose of this match mode CASS is to create mailable addresses for USPS mailing discounts. Use this mode to standardize your input for mailing. This mode generates a large number of match candidates.
    Note: It should be used only for USA. Please refer the Spectrum document once.
  11. If you select Developer APIs, you will get following options:
    Option Description
    API

    Select Geocode or Geosearch from the API drop-down list.

    • If you select Geocode, you need to provide the URL of Geocode.
    • If you select Geosearch, you need to provide the URL of Geosearch. Optionally, you can also provide the Geocode URL.

    Geosearch API returns an auto-completed list of an address or point of interest on a web client. When Geosearch service is configured, the search will list a range of addresses in Spectrum Spatial Analyst. This is useful when a user enters a partial address in the search, the Geosearch API auto-completes the list of corresponding full addresses so that the user can easily select the accurate address from the list. When a user chooses an address from the list (address range), Spectrum Spatial Analyst will zoom and center the map to the selected location.

    If LI API Geocode service is also configured along with the Geosearch, Spectrum Spatial Analyst will make an additional request to the LI API geocode service to get the accurate building level address and place a marker on the map.
    LI API Geocoder URL Enter the URL.

    For example,

    https://api.precisely.com/geocode/v1/transient/basic/geocode
    API Key Enter the API key
    Note: API Key & Secret code can be obtained on successful registration here https://developer.precisely.com/
    Secret Enter the secret code
    Get Capabilities Click to check if the connection is successful or not. When connection is successful, you get following options.
    Country Code Enter the country code.
    Geocode Preferences This option is available with GGM only. Using the Geocoding preferences options enables the geocoder to attempt to return a less precise geocode when an address-level geocode cannot be determined.
    Fallback to Postal It attempts to return a postal code centroid.
    Fallback to Geographic It attempts to return a centroid of a geographic area.
    Match Mode Match modes determine the leniency used to make a match between the input address and the reference data. Select a match mode based Match Mode String on the quality of your input and your desired output. The following match modes are available:
    Standard Requires a close match and generates a moderate number of match candidates. Default.
    Relaxed Allows a loose match and generates the most match candidates, which increases the processing time and Relaxed results in more multiple matches. Use this mode if you are not confident that your input is clean; free of misspellings and incomplete addresses.
    Exact Requires a very tight match. This restrictive mode generates the fewest match candidates, which decreases Exact the processing time. When using this mode, ensure that your input is very clean; free of misspellings and incomplete addresses
    Custom Allows you to define the matching criteria by setting Custom Mode Must Match Fields
    >Interactive Available in single-line address matching only. This mode is designed to better handle the specific matching Interactive challenges presented by interactive matching. Interactive mode permits for more flexible matching patterns and may, in some cases, return additional possible matches than relaxed match mode.
    Note: It should be used only for USA. Please refer the Spectrum document once.
    CASS Imposes additional rules to ensure compliance with the USPS CASS regulations. The purpose of this match mode CASS is to create mailable addresses for USPS mailing discounts. Use this mode to standardize your input for mailing. This mode generates a large number of match candidates.
    Note: It should be used only for USA. Please refer the Spectrum document for more information.
  12. Click Save to save the new geocoder configuration. It is listed on the left-hand side of the screen under the Geocoder Configurations.
  13. Click Cancel to move back to previous page without creating geocoder configuration.