Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
49 changes: 48 additions & 1 deletion docs/espocrm-extensions/map-plus/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ description: Add Google Maps integration to EspoCRM address, link, list, and rou
- **Address Map Controls**: Use draggable markers, route-out buttons, current-location controls, and optional polygon overlays on map-enabled address views.
- **Location and Review Entities**: Store Google Places records, photos, reviews, opening hours, business status, rating history, plus codes, and street view inside EspoCRM.
- **Scheduled Google Places Sync**: Keep saved Location records updated automatically through the `GooglePlacesCrawler` scheduled job.

- **Google Maps Health Check**: Validate API key configuration, Geocoding API access, and Places API availability directly from the Google Maps Integration settings.
<!-- DOC:FEATURES END -->

---
Expand Down Expand Up @@ -87,6 +87,53 @@ All features require a valid Google Maps API key with the relevant Google servic

![Google Maps Integration Settings](../../_static/images/espocrm-extensions/map-plus/api-key.png)

### Google Maps Health Check

To simplify troubleshooting and Google API configuration validation, Ebla Map Plus provides a built-in **Health Check** tool directly within the Google Maps Integration settings.

The Health Check verifies the most common configuration requirements and helps administrators quickly identify setup issues.

**Checks performed:**

* API Key Configured
* Geocoding API
* Places API

**How to use:**

1. Navigate to **Administration** -> **Integrations** -> **Google Maps**.
2. Click the **Health Check** button next to the API key help link.
3. Review the results displayed directly below the button.

The Health Check reports:

* **PASS** when a service is correctly configured and responding.
* **FAIL** when a service is unavailable, disabled, restricted, or misconfigured.
* **SKIPPED** when a prerequisite check has failed.

Example:

```text
API Key Configured PASS
Geocoding API PASS
Places API PASS
```

Or:

```text
API Key Configured PASS
Geocoding API FAIL
Places API SKIPPED
```

![Google Maps Health Check Results](../../_static/images/espocrm-extensions/map-plus/health-check-results.png)

!!! note

If the Geocoding API check fails, the Health Check will display the error returned by Google whenever possible, helping you identify invalid API keys, disabled APIs, quota issues, or access restrictions.


### Available Settings

- **Language**: Forces the Google Maps and Places response language.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ These global integration options directly affect autocomplete behavior:
| Setting | Description |
|-------------------------------------| --- |
| `Language` | Forces the response language for Places and other Google requests. |
| `Autocomplete Restricted Countries` | Limits autocomplete results to specific ISO country codes. |
| `Autocomplete Restricted Countries` | Limits autocomplete results to specific ISO country codes. **(Max 5 countries allowed due to Google API limits)**. |
| `Country Name` | Stores country values in short or long format. |
| `State Name` | Stores state values in short or long format. |
| `City Name` | Stores city values in short or long format. |
Expand All @@ -84,6 +84,11 @@ To limit suggestions to specific countries:
2. Set **Autocomplete Restricted Countries** to the ISO 3166-1 alpha-2 country codes you want to allow, for example `tr`, `us`, or `de`.
3. Save.

!!! note

Google API Country Limitation :
The field is restricted to a **maximum of 5 countries**. This is a strict limitation enforced by the Google Places API. If you select more than 5 countries, Google will automatically process only the first 5 and ignore any additional selections. For more details, see the [Google Places Documentation](https://developers.google.com/maps/documentation/javascript/legacy/place-autocomplete#add-autocomplete).

If **Restrict Country Selection** is enabled, users can only save country values that belong to this allowed list.

---
Expand Down