Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

Pega Field Service integration with the Google Maps API

Updated on February 16, 2021

Pega Field Service uses the Google Maps API to create locations, present map information, calculate drive time, and enable route optimization of daily and weekly trip schedules. To use this capability, you must provide a Google Maps API Key.

Note: Google Maps API is licensed separately from Google resellers and is not included as a part of the Pega Field Service application.

Before using the Google Maps API, you must enter a Google license key in Field Service Admin portal settings and then configure it. For more information on registering and acquiring the license key, refer to the Google Maps API webpage.

When you receive your key, you can configure and use Google Maps by completing the following steps:

  1. Log in to the Field Service Admin portal.
  2. On the navigation pane, click Configuration and then click the Settings tab.
  3. In the Update Google API key field, enter the license key value that you received from Google.

The following table lists the APIs that are used in the Pega Field Service application.

Note: If an API key is configured with any restrictions under the Application restrictions type, you cannot use it for both the JavaScript API (Maps JavaScript API and Directions API) and server-side APIs (Geocoding API, Time Zone API, and Distance Matrix API). In addition, the API Documentation URL links and Connect REST URL links are subject to change.
Google APIPortalUsageAPI Documentation URLConnect REST URL
Geocoding APIAdmin, Dispatcher, and Job ManagementCaptures the latitude and longitude values for a given address. For example, the latitude and longitude of a customer location and a field worker’s address in the Admin portal.https://developers.google.com/maps/documentation/geocoding/start

https://maps.googleapis.com/maps/api/geocode/xml

Time Zone APIAdmin and Job ManagementCaptures the time zone for a given address. For example, the time zone of a customer location and a field worker’s address.https://developers.google.com/maps/documentation/timezone/introhttps://maps.googleapis.com/maps/api/timezone/xml
Distance Matrix APIDispatcher, Job Management, and Interaction portal

Captures the distance and drive time for two or more locations.

Note: The Advanced Jobs application uses the Haversine formula for calculating the distance between two locations. In the AdvJobsExtensions data transform, the IsFWDistanceByHaversine property is set to True.

https://developers.google.com/maps/documentation/distance-matrix/intro

https://maps.googleapis.com/maps/api/distancematrix/json

Maps JavaScript APIDispatcher portalDisplays custom maps.https://developers.google.com/maps/documentation/javascript/tutorialJavaScript API
Directions APIDispatcher portal

Calculates optimized and unoptimized trip routes, captures directions between multiple locations, and renders the route directions on the custom map for a given set of locations.

Note: This is used only for daily and weekly trip scheduling.
https://developers.google.com/maps/documentation/directions/introJavaScript API
  • Previous topic Updating the Google API Key from the Dispatcher portal

Tags

Pega Field Service 7.4 - 8.3 Pega Field Service

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Visit the Support Center

Did you find this content helpful?

Yes
No

Want to help us improve this content?
Suggest an edit

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us