- Introduction to WorkXpress
- Building Your Application
- Examples and Best Practices
- Technical Manual
This shows you the differences between two versions of the page.
|
enterprise service bus - geocode [2016/09/14 18:19] |
enterprise service bus - geocode [2016/09/14 18:19] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | ====== Enterprise Service Bus Data Source - WorkXpress Geocode ====== | ||
| + | |||
| + | ===== Purpose ===== | ||
| + | |||
| + | The Geocode Enterprise Service Bus allows the Software Developer to track usage of Geocoding services inside the application. When an address is geocoded it begins by using the free service, which returns the Longitude and Latitude information as well as a quality indicator. Depending on the quality of the information given the service, and the data that the free service has available, it may find a Long/Lat that is of sufficient quality to use, or it may not. When the quality is low, and a Billing Term is setup to allow Premium Geocoding to take place, a second call is made to the premium service which is more extensive and has the capability to return higher quality results. To discuss rates and enable premium geocoding, contact [[billing@workxpress.com]]. | ||
| + | |||
| + | Geocoding can occur at several points in an application such as : | ||
| + | * [[Field Type - Address|Address field]] saved with the [[Field Setting - Geolocation|Geolocation setting]] enabled. | ||
| + | * Filtering records with an address field on a [[Form Type - List|list form]], looking for records within X Miles of an address. | ||
| + | * When the [[Expression Function - Validate City State Postal Code|VALIDATE_CITY_STATE_POSTAL_CODE]] or [[Expression Function - Suggest Postal Code|SUGGEST_POSTAL_CODE]] expression functions are used. | ||
| + | * While using some [[Form Type - Map|map form]] Features. | ||
| + | |||
| + | //This feature will be available in Platform Version 14.05.941.// | ||
| + | ===== Supporting Elements ===== | ||
| + | |||
| + | There are many possible ways that tracking of geocode call usage may be implemented. The two most common would be fields on the user that store a total number of calls or a series of records that contain the counts each time a geocode call is made. | ||
| + | |||
| + | To store the count in a Field on the User the software developer could create up to 3 different fields, one [[Field Type - Number| Number Field]] for premium calls, one [[Field Type - Number| Number Field]] for free calls, and one [[Field Type - Short Text|Short Text Field]] for the last reason message. The software developer could also use one [[Field Type - Long Text|Long Text Field]] an generate a log of calls. | ||
| + | |||
| + | For the record based tracking method the software developer would need to create a [[Table|Table]] for history records that contains 3 fields, one [[Field Type - Number| Number Field]] for premium calls, one [[Field Type - Number| Number Field]] for free calls, and one [[Field Type - Short Text|Short Text Field]] for the reason message. A [[Field Type - Date Time|Date Time]] for when the geocode was done would also be useful. | ||
| + | |||
| + | ===== Options ===== | ||
| + | |||
| + | There are no configuration options for this data source. | ||
| + | |||
| + | ===== Data Handlers ===== | ||
| + | |||
| + | There is currently only one data handler available for this data source. | ||
| + | |||
| + | * [[Enterprise Service Bus Data Handler - WorkXpress Geocode Actions|WorkXpress Actions: Geocode]] - This data handler allows the software developer to generate actions to save values on records like the currently logged in user or to create new records and save the values on them. The full power of the actions system is available. | ||
