Overview #
FieldAx uses Google Maps for several features — the Dispatch Board Map, engineer route views, traffic-aware routing, and location-based dispatching. This requires a Google API Key. FieldAx ships with a default API key pre-configured, so Google Maps features work immediately after installation with no setup required. This section covers how the API key is managed, and how to configure your own key if you’d prefer not to use the FieldAx default.
Understanding the API Key Fields #
FieldAx manages its Google API Key through a Custom Metadata Type called GoogleApis, on a record named Google Map Api. This record contains two relevant fields:
Key #
- Holds FieldAx’s default, pre-configured API key
- Field Manageability: Upgradable (managed by FieldAx; not meant to be edited)
- Used automatically if no customer-owned key is provided
Customer Owned Key #
- Empty by default
- Field Manageability: Subscriber editable
- Enter your own Google API key here to override the default
- Not affected by future FieldAx package upgrades
Configuring Your Own Google API Key #
Step 1: Access Custom Metadata Types #
- Navigate to Setup → Custom Metadata Types
- Click Manage Records next to GoogleApis
Step 2: Open the Google Map Api Record #
- Click on the Google Map Api record
- Click Edit
Step 3: Enter Your API Key #
- Locate the Customer Owned Key field
- Enter your Google Cloud API key (with Maps JavaScript API, Directions API, and Geocoding API enabled, as applicable)
- Leave the Key field untouched — this holds the FieldAx default and should not be modified
Step 4: Save #
- Click Save
- The new key takes effect immediately across all Google Maps requests in FieldAx — no deployment or restart needed
Reverting to the Default Key #
- Open the Google Map Api record
- Clear the Customer Owned Key field
- Click Save
- FieldAx will automatically fall back to the default key in the Key field
