Creating a New Geocoder Configuration

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. The repository name starts with root /.
  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 an existing folder from the list.
    You can view the folders in Tree view or List view. The Search option is availabe in the List View.
  7. Select a folder and click Select.
  8. Select any one Deployment option. You can select from On Premise or Spectrum-on demand or PB 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://stratusopwin2k8:8080/
    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 succeeeful. 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.
  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
    • GGM
    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 PB Developer APIs option, you will get following options:
    Option Description
    LI API Geocoder URL Enter the URL.

    For example,

    https://api.pitneybowes.com/location-intelligence/geocode-service/v1/transient/basic/geocode
    API Key Enter the API key
    Note: API Key & Secret code can be obtained on successful registration here https://developer2.pitneybowes.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 once.
  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.