GIS Service configuration

There are several configuration values needed to enable address correction and service area validation. These features rely on an external Esri service and are not compatible with other geolocation services.
The address correction feature may be enabled on its own, but service area validation depends on address correction being enabled.
Configure Address Correction
​ESRI_ADDRESS_CORRECTION_ENABLED - Boolean
Enables the feature that allows address correction for address questions.
​ESRI_FIND_ADDRESS_CANDIDATES_URL - String
The URL CiviForm will use to call Esri’s findAddressCandidates service.
Configure Service Area Validation
​ESRI_ADDRESS_SERVICE_AREA_VALIDATION_ENABLED - Boolean
Enables the feature that allows for service area validation of a corrected address. ESRI_ADDRESS_CORRECTION_ENABLED needs to be enabled.
​ESRI_ADDRESS_SERVICE_AREA_VALIDATION_LABELS - String[]
Human readable labels used to present the service area validation options in CiviForm’s admin UI.
Example value: ["Seattle"]
​ESRI_ADDRESS_SERVICE_AREA_VALIDATION_IDS - String[]
The value CiviForm uses to validate if an address is in a service area.
Example value: ["Seattle"]
​ESRI_ADDRESS_SERVICE_AREA_VALIDATION_URLS - String[]
The URL CiviForm will use to call Esri’s map query service for service area validation.
Example value: ["https://gisdata.your city.gov/server/rest/services/City_Limits/MapServer/1/query"]
​ESRI_ADDRESS_SERVICE_AREA_VALIDATION_ATTRIBUTES - String[]
The attribute CiviForm checks from the service area validation response to get the service area validation ID.
Example value: ["CITYNAME"]
​ESRI_EXTERNAL_CALL_TRIES - Integer
The number of tries CiviForm will attempt requests to external Esri services.

Email configuration

Upgrading to a New Release

Last modified 7mo ago