Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

Version 1 Next »

Table of Content

(tick) In Scope

The following actions are supported in this integration, and performed on every Sync.

SMART to EarthRanger:

  • EarthRanger subjects are created from SMART CA patrol model members.

  • EarthRanger event types are created from active SMART CA Datamodels.

 

EarthRanger to SMART:

  • Independent incidents are created in SMART CAs from EarthRanger events not associated with patrols.

  • Patrols are created in SMART from EarthRanger patrols. These EarthRanger patrols must have a start location and subject assigned.

  • Waypoints are created in SMART From EarthRanger events associated to EarthRanger patrols.

  • Attachments in EarthRanger are sent to the respective SMART independent incidents and waypoints. [supported after version Smart 7.5.3]

Note that a single EarthRanger site can be linked to one or multiple SMART Conservation Areas.

🚫 Out of Scope

  • This integration creates and updates objects. Delete operations are not implemented.

  • This integration is mostly a one direction integration, pushing data in EarthRanger to SMART.

  • Functionality in SMART and EarthRanger that is not included in the previous section is not part of the integration.

(question) FAQ

  • Do I need a certain version of SMART in order to utilize this integration?

    • Yes, SMART Desktop 7.5.3 and are needed for full integration functionality.

    • SMART Desktop 7.0 → 7.4 only supports independent incident creation.

  • How often does the synchronization run?

    • Every hour, subject to change.

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

    • Yes, on each poll, the integration will update ER event types based on changes it detects in the data models.

  • Will the objects in SMART reflect updates made in ER?

    • Yes.

    • An update scenario that is not yet covered as of now is re-association. Example: If a report is added in ER site, the sync process runs and adds it as an independent incident to SMART. Then that report is associated to a patrol. Right now the report on that patrol will not be created as a waypoint on the patrol because it will break a constraint on the SMART side. This functionality should become available in SMART v 7.5.3.

  • What types of ER patrols will be synced to SMART?

    • The sync process will pull all patrol types from SMART and assume they are “routine“ patrols and created as “foot“ patrols in SMART.

  • How does the system determine which SMART CA to send the reports or patrols to if multiple are configured?

    • There will be an event type category generated for each linked CA based on the CA label. The report will sync to the CA linked to the category the report is selected from.

    • If a patrol is created and does not yet have reports added to it, the patrol will be synced with the CA the subject assigned to the patrol was imported from.

  • How will I know which Subject to choose from Earth Ranger forms if the same employee spans multiple CA’s and is created as multiple subjects in ER?

    • It is important that the subject corresponding to the correct CA is chosen in ER flows as the subject assigned to objects may be referenced to determine which CA to send the data to.

    • The CA identifier will be added as a suffix to each subjects name as a visual indicator for differentiation

    • The ca_uuid is also saved in the “additional“ field of the Subject object and can be analyzed from the admin portal of the ER site

⚙️ Getting Configured

  1. Capture the SMART CA UUIDs for the conservation areas you want to sync with the EarthRanger site

  2. Gundi Portal Configurations

    • Create an Inbound Integration for ER. You will require:

      • The EarthRanger site URL

      • A user (with superuser status) associated with the token.

        • Otherwise the user will not have read permissions on events created by this integration.

 

  1. Create an Outbound Integration for SMART Connect.

  • Configure the additional field of outbound integration.

    • ca_uuids: List of Conservation Area UUIDs.

    • er_integration_id: UUID of the Gundi inbound integration that represents the same system.

    • version: SMART Connect version, The absence of this will assume SMART Connect version 7.5. In order to use previous versions of SMART Connect, version should be specified in the config like below

    • Example

      {
  "ca_uuids": [
    "8a0a2bea-13ed-4cc7-8f76-1717347ea18a",
    "8f7fbe1b-201a-4ef4-bda8-14f5581e65ce"
  ],
  "er_integration_id": "9e0d298a-01e0-4bfa-acc3-f0b446037095",
  "version": "7.0"

 

  • No labels