diff --git a/docs/_static/images/espocrm-extensions/map-plus/health-check-results.png b/docs/_static/images/espocrm-extensions/map-plus/health-check-results.png new file mode 100644 index 000000000..de4146465 Binary files /dev/null and b/docs/_static/images/espocrm-extensions/map-plus/health-check-results.png differ diff --git a/docs/espocrm-extensions/map-plus/index.md b/docs/espocrm-extensions/map-plus/index.md index fc8d9311f..d89293b06 100644 --- a/docs/espocrm-extensions/map-plus/index.md +++ b/docs/espocrm-extensions/map-plus/index.md @@ -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. --- @@ -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. diff --git a/docs/espocrm-extensions/map-plus/search-place-autocomplete.md b/docs/espocrm-extensions/map-plus/search-place-autocomplete.md index 7b537c467..f11c32c21 100644 --- a/docs/espocrm-extensions/map-plus/search-place-autocomplete.md +++ b/docs/espocrm-extensions/map-plus/search-place-autocomplete.md @@ -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. | @@ -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. ---