EarthRanger to SMART Connect

Websites:

[SMART] https://smartconservationtools.org/en-us/ 
[EarthRanger] https://www.earthranger.com/ 

This integration require assistance from our support team for setup and configuration. Please contact our support team at support@earthranger.com and we’ll guide you through the process to ensure everything is set up correctly.

We are actively working to make this integration self-service in the future. Stay tuned for updates!

Scope

This integration depends on a bidirectional data exchange, ensuring EarthRanger events align with the SMART data model by pulling relevant data from SMART and automatically creating event categories and event types in EarthRanger.

Subjects

  • EarthRanger automatically creates subjects based on employee records in SMART CA.

Example

Employees in SMART:

Subjects created in EarthRanger:

Events

  • This integration automatically creates event categories and event types in EarthRanger using the data model as a reference.
  • This integration will also create event categories and event types in EarthRanger using configurable data models only if they have been configured in SMART Desktop with the flag “Use with SMART Integrate”. 
    • To enable “Use with SMART Integrate”: Open SMART Desktop, select the configurable data model, click "Edit," select the model, and mark the checkbox.

      Example

This configurable data model ("ខនិក គូលែន ព្រហ្មទេព 092022") will appear in EarthRanger as follows:

Important: Using this example, note that EarthRanger omits some hierarchical information from the configurable data model. For example, the event type name “Salt Lick” excludes the parent name “Features” from the original SMART model structure “Features > Salt Lick”.

 

 

  • Events created in EarthRanger are sent to SMART as independent incidents or waypoints.
    • Events in EarthRanger not linked to patrols are created or updated as “independent incidents” in SMART.

      Example
      Event in EarthRanger:

The event will show in SMART as an Independent incident:

Note: Once an EarthRanger event has been created in SMART as an independent incident (i.e., the event was not assigned to a patrol), assigning the event to a patrol in EarthRanger will result in the integration creating a patrol waypoint but will not delete the original independent incident from the SMART CA database.

 

  • Events in EarthRanger linked to patrols are created or updated as “patrol waypoints” in SMART.

    Example
    Event in EarthRanger:

Patrol Waypoint in SMART:

  • Attachments added to EarthRanger events are included in the corresponding incident or patrol waypoint in SMART.

    Example
    Attachment in EarthRanger:

Attachment in SMART:

 

Important: 

  • Use the event types created automatically by this integration. Event types created manually and event types created by other integrations are ignored and their events will not be sent to SMART.

Patrols

  • Patrols created in EarthRanger are synchronized and updated in SMART if they meet certain conditions:
    • The patrol is assigned to a patrol leader from the subjects generated by this integration.
    • The patrol has a start time.
    • The patrol has a start location.

Important: 

  • We strongly recommend against manually editing the patrol ID of a patrol created in SMART through this integration, as it may lead to unexpected errors.
  • This integration uses the patrol type “Foot” with key “foot” and patrol mandate “EarthRanger” with key “followup” in every case.
  • This integration does not sync patrol types, patrol teams, and/or mandates between SMART and EarthRanger.

Prerequisites

You will need to be sure that the following requirements are met in EarthRanger and SMART Connect.

EarthRanger

  • Token assigned to a superuser account in EarthRanger.

SMART

  • Server version 7.5.7, or later.
  • Conservation Area UUID.
  • SMART Connect Server URL and user credentials with access to the relevant CA.
  • Patrol mandate with followup key and patrol type with foot key. For more information, refer to the details. 

Requesting an Integration

Contact Support and provide the following information:

  • Your SMART Connect server URL and credentials.
  • Your SMART Connect server version.
  • Your Conservation Area UUID.
  • Your EarthRanger site URL.
  • The language your Conservation Area is configured to.

Data latency

Data latency is influenced by:

  • The synchronization frequency between SMART CA and its SMART Connect server.
  • The scheduled interval set by the Gundi team for fetching and pulling data (approximately every 4 hours).

If data is not available in SMART Connect with these considertations in mind, please contact our Support team for assistance.

Next Steps

  1. Verify that there is an Event Category in EarthRanger corresponding to your SMART CA data model. Each category created through this integration will have the CA name in parentheses.
    1. https://yoursite.pamdas.org/admin/activity/eventcategory/ 
  2. Ensure that there is an Event Category in EarthRanger for each “configurable data model” set up for Gundi in your CA.
    1. https://yoursite.pamdas.org/admin/activity/eventcategory/ 
  3. Check that the subjects in EarthRanger match your SMART CA employees list. Each subject created through this integration will have the CA name in parentheses.
    1. https://yoursite.pamdas.org/admin/observations/subject/
  4. To test the integration:
    1. Create an event in EarthRanger using one of the event types created by the integration.
    2. Wait for the scheduled job to transfer the data to SMART Connect (this typically takes around 4 hours). If this duration seems too long, please contact support.
    3. Sync your CA with the SMART Connect server.
    4. Confirm that the event has been downloaded by SMART Desktop and is listed as an independent incident.

Considerations

FAQ

My integration is not working, how can I troubleshoot it?

Kindly review the list of prerequisites and considerations. Contact us if you need additional assistance.

Will the integration pick up on changes I make to my SMART Data model?

Yes, every hour the integration will update EarthRanger’s event types based on changes it detects in your data models.

How often does the synchronization run?

There are two synchronization jobs:

  • Every hour (subject to change), the integration will update EarthRanger’s report categories and types to align with your CA’s data model and configurable data models.
  • Every 5 minutes (subject to change), the integration will update your CA with patrols and reports created in EarthRanger.

Why is the EarthRanger patrol not showing up in SMART?

In EarthRanger:

  • Check that the patrol has a start location and patrol leader assigned to it.

In the SMART CA:

  • Check that the patrol type foot and the patrol mandate followup exist.

Technical Notes for Support

Configuring Gundi v1

Go to Gundi v1 

1. Go to Outbound Configurations.

2. Click Add Integration

Follow the steps below to complete the form:

Name:  Enter a name for your connection (e.g., SMART Server Name).

Owner: Enter your organization.

Type: SMART Connect

Endpoint: SMART Connect Server  (e.g., https://XXXX.org/server) 

Login/Password: SMART Connect username and password.

State:

{}

Additional:

{
  "ca_uuids": [
    "{{UUID}}"
  ],
  "configurable_models_lists": {},
  "version": "7.5.7"
}

Include the CA UUID (ca_uuids) and the SMART Connect version (version). If the CA is not configured in English, please specify the language.  Example:

{
  "ca_uuids": [
    "e485dbf8-7f66-4fc0-bf7e-277a30ef0ae8"
  ],
  "configurable_models_lists": {},
  "version": "7.5.7"
}

3. In EarthRanger, create a superuser named “earthranger_to_smart” and define a password for it.

5. In Gundi v1, go to Inbound Integrations.

6. Click Add Integration.

Name:  Enter a name for your inbound (e.g., ER Site name).

Owner: Enter your organization.

Type: EarthRanger.

Provider_key: Leave empty.

Endpoint: EarthRanger site API (e.g., https://XXXXXX.pamdas.org/api/v1.0)

Token: Leave empty.

Login: Enter “earthranger_to_smart”

Password:  Enter the password previously defined for the user “earthranger_to_smart”.

4. Click Save.

5. To configure the Device Group, use the browser's search functionality and searching for the Outbound Integration you created in a previous step.

6. Click Save.

4. Wait for the periodic tasks to run (up to 4 hours), or ask the Gundi team to trigger it manually.

These periodic tasks need to be run one by one, with a minute of wait.

  • Maintain Smart Integrations: Download the datamodel, configurable data models, and patrol leaders.
  • Run SMART+ER Integrations: Push data to SMART Connect. 

5. Confirm if the EarthRanger event categories were created.

 
 

L2 Troubleshooting

1. Analyze Traces

Use GCP Trace Explorer to filter activity with the following:

Project: CDIP 

RootSpan: gundi_er_smart_sync

Optional Filters:

event_type: Event Number (without “ER-”)

event_title: Title

serial_number: Event Number

2. Analyze Code

Code location: cdip/cdip_admin/sync_integrations/er_smart_sync.py

3. Analyze Logs

Use GCP Log Explorer to filter activity with the following query

Project: CDIP 

"celery" OR jsonPayload.name="smartconnect" 
("configurable model"  OR "failed" OR "from ER"  OR "error" OR "event_types" OR "event_categories" OR "subject" OR "traceback" OR "exception" OR "patrol" OR "404")
-resource.labels.container_name="proxy"
"{{smart server}}" OR "{{ca name}}" OR "{{ca id}}"

 
 

 

 

 

Tags: Conservation Software, EarthRanger to SMART
Last Update: April 9, 2025



Was this article helpful?