Page History
| Table of Contents | ||
|---|---|---|
|
Overview
This transformation step utilizes Users can utilize the PitneyBowes forward geocoding API to extract longitude and latitude coordinates from the input of an address, and then convert them into a GeoPoint value. This is ideal for enhancing customer addresses.
This is type of transformation can be done by using the PB - Forward Geocode step in the Data Transformation module.
Set Up
In order to use this step, you must install the PitneyBowes Geocode plug-in in your Yellowfin environment.
...
Advanced configuration: In this mode, individual elements of an address are specified separately. Any fields that are left blank, or values that are null will be ignored. As this is more specific it will tend to produce better results than the full address version.
Tip You can also concatenate a split up address in separate fields together by using the Calculated Field step, and stringing each field with a plus (+) operator.
- API Key and API Secret: These are your credentials to the PitneyBowes API. These values are necessary to run the geocoding step. To obtain an API key see: https://www.pitneybowes.com/us/developer/geocoding-apis.html
- Preview Mode Row Limit: The PitneyBowes API has usage rate limits/uses a system of credits that can be quickly be consumed when configuring and testing a transformation flow. You can use this field to set a safety limit on the amount of credits that will be processed consumed by this step in the a preview moderun. If this value is set to 0, then no limit will be applied. The number you specify here will affect the number of rows resulting in the data preview panel, as each data row uses a credit. This Note, however, that this safety limit will not apply be enforced when the flow is published and run, thereby using up the credits.
Step Output
The API will return a list of possible longitude/latitude coordinates, based on the level of detail provided for an address. This step will select the primary match from this list. If the API does not return any matches (which could happen if insufficient address details were provided), then a null value will be displayed.
...
This value can then be converted to geometry objects for map display using database functions (such as SQLServer) or Yellowfin’s view-level Well Known Text or WKT converter.
...