IR WIKI

EkoTek Listener Service

5 min read

Overview

The Integriti EkoTek Listener Service leverages EkoTek’s Remote Logging feature to receive events from EkoTek systems for use within Integriti. It enables:

  • Live location updates for Users through association of EkoTek Pagers/Fobs with Integriti Users.
  • Personal Security Alarms (Duress, Man Down, etc.) reflected in associated Integriti Entities.
  • Repeater/Hub association with Integriti Locations and Areas.
  • Review generation for all accepted logs (except Maintenance, which generates Integriti Log entries).

Other Integriti features such as Schematics and Scheduled Tasks can leverage the status changes and Review generated by the Listener.

Version: This document is based on Version 1.0 of the EkoTek Listener documentation.

Prerequisites

  • Integriti License: “EkoTek User Location System Integration” license (part number 996928).
  • Bi-directional Paging (optional): To send alerts/events from Integriti to EkoTek, the “Communicator - Email, SMS & Pager Communications” license (part number 996930) is required for the Pager Message Sender.
  • Network: The EkoTek Listener Service receives EkoTek Logs over UDP. Ensure the Integriti server can receive UDP traffic on the configured port (default: 514).
  • Custom Fields: Custom fields must be configured for Users, Areas, and Locations before use. These can be verified under Administration → Custom Fields.

Step-by-Step

1. Create the Communication Handler

  1. Navigate to Administration → Communication Handlers → Add New.

  2. Give the Listener Service a Name and add any necessary details in the Notes field.

  3. Set Handler Type to EkoTek Listener Service.

  4. Configure parameters:

    • Listening Port: Set to 514 (the port on which EkoTek Hubs send logs).

    • Log Types: Select which log types the Listener will process:

      • For an Alarm Log to be processed, both the Reason and Type must be selected. Example: For a Raised Duress alarm, select both “Raised” Type and “Manual (Duress)” Reason.
      • Review is generated for all accepted logs except Maintenance (which generates an Integriti Log entry).
      • Location Updates do not generate Review unless the option is explicitly selected.
      • Important: Raised Personal Security logs automatically generate System Warnings for the Subject of the Alarm; Claimed logs clear them. It is recommended to check “Claimed” Type if you are also checking “Raised” Type.

    • Populate Unassociated Lists With Received Entities: Enable to allow assigning unassociated EkoTek hardware via the Listener’s unassociated hardware lists.

    • Auto Associate Areas with Repeaters: Enable to let the Listener automatically match Repeaters with Areas and Locations by name (see Automatic Association section below).

  5. Save the Listener Service.

2. Verify Status

  1. Check that the Status column displays similar to: Running.
  2. Verify that Custom Fields have been added to Users, Areas, and Locations under Administration → Custom Fields.

3. Assign EkoTek Hardware

The Listener allows Operators to assign Hardware to Users or Areas/Locations. Hardware is collected from Location logs received from the EkoTek system.

  1. Ensure the Listener is running.
  2. Move pagers between Repeaters in the EkoTek system so they appear in Location Updates.
  3. Open the Communication Handler editor and use the edit buttons:
    • Edit Pager/Fob Associations: Displays Pagers and Fobs from Location Updates. Assign them to Integriti Users.
    • Edit Repeater Associations: Displays Repeaters. Assign them to Areas or Locations, and optionally a User for map location purposes.
  4. Click the … button in the “Assoc. Entity” column and select the desired Entity.
  5. Click OK to save associations. The Hardware IDs (Hardware No. + Serial No.) are added to the associated Integriti Entities and removed from the unassociated lists.

Note: Only one Pager/Fob can be associated with a User at a time. Assigning a new Pager/Fob overrides the previous association.

To check an Entity’s associated EkoTek Hardware, view the EkoTek Listener Custom Fields on that User, Location, or Area.

4. Automatic Area/Location Association

When “Auto Associate Areas With Repeaters” is enabled, Areas and Locations are automatically matched with incoming unassociated Repeaters by name:

  • An Area/Location matches when its name begins with “EkoTek”, followed by the beginning of a Repeater’s name.
  • Example: An Area named “EkoTek Office” matches Repeaters “Office Front” and “Office Back”, but not “Front Office”.
  • A Location named “EkoTek Office Space” matches Repeater “Office Space Front”.

5. Bi-Directional Communication (Optional)

The EkoTek Communication Handler itself is not capable of bi-directional communication — it is a listener only. However, Integriti can send pager messages to EkoTek systems:

  1. Set up a Pager Message Sender Communication Handler (see Pager Message Sender documentation).
  2. Configure the Serial Connection settings (Baud Rate, etc.) to match the EkoTek Hub’s settings.
  3. Use Scheduled Task Actions with the Pager Message Sender to send messages to:
    • Specific pagers via Users with associated EkoTek Pager/Fob IDs (Custom Field).
    • Pager groups: Create Users with custom field values of 0 (broadcast to all) or 1-32 (pager groups 1 through 32).

Verification

Review Output Examples

Location Updates:

  • With associations: EkoTek Location Log: User John Doe with pager/fob Primary has moved to EkoTekOffice
  • Without associations: EkoTek Location Log: Pager/Fob Primary has moved to @Office Front

Personal Security Logs:

  • EkoTek Personal Security Log: Man Down Alarm Raised by John Doe
  • EkoTek Personal Security Log: Man Down Alarm Raised by John Doe has been Accepted by "Jane Doe"
  • EkoTek Personal Security Log: Man Down Alarm Claimed by John Doe
  • EkoTek Personal Security Log: Manual (Duress) Alarm raised in EkoTekOffice

Paging Logs:

  • With associations: EkoTek Paging Message: A Pager message was sent to John Doe: "Meeting in Office in 15 mins"
  • Without associations: EkoTek Paging Message: A Pager message was sent to Primary: "Meeting in Office in 15 mins"

Troubleshooting

IssueCheck
No events receivedVerify UDP port 514 is open and not blocked by firewall. Confirm EkoTek Hub is sending logs to the Integriti server’s IP.
Hardware not appearing in listsMove pagers between Repeaters to generate Location Updates. Ensure the Listener is Running.
Alarms not generating System WarningsVerify both Reason and Type are selected for the alarm in Log Types settings.
Auto-association not workingEnsure Area/Location names start with “EkoTek” followed by the Repeater name prefix.
License errorsVerify license 996928 is active. For paging out, verify license 996930.

Graph View

Backlinks