Skip to main content

External Hydrants Integration (ESO)

Peter Grammatas
  • Updated

ESO Hydrants Integration: Setup and Functionality

 

This article provides an overview of how to set up and utilize the IamResponding ESO Hydrants integration, allowing you to display ESO hydrant data directly within your IamResponding maps.

 

External Integrations Page

 

 

Overview

 

The IamResponding External Integrations page is where you can configure your IaR system to integrate with external vendors, including ESO.

Navigation

 

You can access the External Integrations page by following these steps:

  1. Navigate to the Administrative Functions page.

  2. From the "Settings" sidebar menu option, select "External Integrations".

 

 

Generating an External Integration

 

To integrate IamResponding with an external vendor, you'll need to create a new integration:

  1. Select "Add New".
  2. This will generate a new external integration, allowing you to select the type of integration you'd like to configure.

 

Basic Information

 

This section contains basic fields for any external integration you create:

  • Integration Type:
    • ESO RMS: IaR will automatically export incident data to ESO RMS.
    • ESO Properties: IaR will populate ESO property data as pre-plans within IaR.
    • ESO Hydrants: IaR will populate ESO hydrant data within IaR as hydrant markers.

    • Universal HTTPS POST: Automatically export CAD incident data from IaR to external services.

      Our "Universal HTTP Post" external integration automatically exports CAD incident data from IamResponding to third-party services (such as Alpine Software). 

      Take notice:  HTTP post currently only works for CAD data received via the CAD API.  It will not work with CAD data received via SMTP or SNPP.

      This is currently the exclusive integration option for all venders, excluding ESO.

  • Description: A brief description of the integration will be provided.
  • Active: Use this switch to activate or deactivate an integration. Integrations default to active upon creation.

 

ESO Hydrants - Integration Type Fields

 

This section contains fields specific to the ESO Hydrants integration:

  • Key: You'll need to input the IamResponding key provided by ESO. This links your IamResponding and ESO systems.
    • Note: The API key provided by ESO will be the same for both the hydrants and properties integrations.
  • Show Info: This switch will show/hide the text entered in the "Key" field.

 

Accessing the ESO IamResponding API Key

 

To utilize the ESO Hydrants integration within IaR, your agency must have purchased the Fire Properties API through ESO and the ESO Hydrants module.

Follow these steps to access your API key within ESO:

  1. Within ESO, navigate to "API Management" in the ESO admin page.
  2. Select "Subscriptions".
  3. If not already visible, your agency will need to request to enable the IamResponding subscription within ESO by contacting APISupport@eso.com.
  4. Once enabled, you will be able to generate keys for IamResponding. You may use either the primary or secondary key, which you will then paste into the "Key" field of the ESO Hydrants integration page within IaR.
  5. If a subscription has not been purchased, please contact esoam@eso.com to connect with your ESO sales representative.

 

 

Save Changes

 

Once all required fields are completed:

  1. Select "Save Changes" at the top right corner of the page.
  2. You will then see the newly created integration listed.

Notes:

  • Hydrant data is updated daily. Changes made within ESO may take up to 24 hours to reflect within IaR.
  • You may edit or delete an external integration by selecting the three dots on the right side of the integration list.

 

Access

 

Agency:

The external integrations page will not be visible to users unless it has been enabled for your agency by IamResponding.

Users:

The external integrations page will not be accessible to users unless they have the permission, "Permitted to edit System Functions", enabled within their individual member profile.

  • Note: User permissions are managed by the agency IaR administrator.

 

ESO Hydrant Data in IamResponding

 

 

Overview

 

IamResponding will display ESO hydrant data directly within IaR maps as a map marker. ESO hydrants will appear using the existing IamResponding hydrant markers, color-coded based on their flow rate in accordance with NFPA standards.

 

Hydrant Card

 

When a hydrant is selected, the hydrant card will display all data imported from ESO for that hydrant, including:

  • Flow Rate
  • Water Source Type
  • Location
  • In/Out of Service

 

 

Related articles