IR WIKI

RTLS

6 min read

Overview

Integriti RTLS Integrations allow key functionality from 3rd party Real-Time Location Systems (RTLS) to be monitored and controlled directly from the Integriti software suite. This provides a single head-end for access control, intruder detection, and RTLS functionality.

Supported features:

  • Monitoring Assets — RTLS tags from a 3rd party system can be monitored directly from Integriti, including viewing CCTV footage for RTLS assets in a camera’s field of view.
  • Events — Events from an integrated RTLS system are logged into Integriti’s Review, enabling map display, associated video, and automated actions.
  • Control — Direct control of the 3rd party RTLS system via commands triggered manually or through Task Actions.

RTLS Asset properties tracked in Integriti include: Asset Type, Associated User, Device ID, Parent Device, Area/Location, State, Status, X/Y/Z Coordinates, Input State, Battery Voltage/State, Heart Beat, and Is Moving.

Prerequisites

Licensing

  • RTLS Integration License (996928) — Required for the integration to run.
  • Integriti Version License — A specific version of Integriti must be licensed. The installer warns if the requirement is not met; the integration will be disabled until a sufficient version license is added.
  • Other Licenses — Some integrations require additional licenses. Refer to the individual integration’s Release Notes.

System Requirements

Refer to the individual integration’s manual for specific system specifications or pre-installed software. If none are mentioned, the integration shares requirements with the minimum supported Integriti version or installs prerequisites via its own installer.

CCTV (Optional)

To use CCTV features (viewing associated footage), a separate CCTV Integration must be installed. See CCTV.

Step-by-Step

1. Installation

  1. Close all instances of the Integriti software suite on the target PC.
  2. Stop all running Integriti services (if installing on the Integriti server).
  3. Download and run the Integriti RTLS Integration installer on all Integriti servers first, then on all client workstations that will interact with the integration.
  4. Restart all services that were stopped.

If reverting to an earlier version, uninstall the currently installed version first.

2. Enrolment

  1. In Integriti System Designer, select New Integrated Device from the Integrations tab.
  2. Select the RTLS integration from the list and press Ok.
  3. Give the device a Name and optionally Notes.
  4. Persisted Connection Run Mode — Choose one:
    • Automatically Maintain Connection on Any Single Server (recommended) — One server always connected; fails over in HA setups.
    • Maintain Connection on the Specified Server — Runs only on one specified server.
    • Simultaneously Maintain Connection on All Servers — Connection on every Integration Server (may cause duplicate Review records).
    • Disabled — No persisted connection (use only if event/state monitoring is not needed).
  5. Connection Configuration — Under the Device Properties tab, configure integration-specific properties for connecting to the 3rd party system. Refer to the individual integration’s manual.
  6. Events/Alarms — Configure Generate Review Transitions to filter which events/alarms generate Review Records.
  7. Permissions — Optionally select an Integriti Operator to limit permissions.
  8. Click Save.
  9. Click Refresh Device (if visible/enabled) to load RTLS Tags, maps, events, and commands from the 3rd party system.
  10. Click Refresh Child Devices if indicated by the integration’s manual (typically greyed out for RTLS).
  11. Save and close — a persisted connection will automatically begin if enabled.

3. Configuring RTLS System in Integriti

Map Configurations

  1. Set up a map configuration in the 3rd party RTLS system.
  2. Create a corresponding Integriti Schematic Map using the same background image (see Integriti Software — Schematics manual).
  3. Add Areas to outline regions within the map.
  4. Add CCTV cameras if required.
  5. Add an Alert Presenter in the Alert Element Presenter field under the Schematic Map’s Properties tab.
  6. Save, close, and add the map to a Schematic Map Group.
  7. Ensure CCTV camera Associated Entities contain the Area the camera is in (see CCTV).

Map Associations

Specify the map association between the 3rd party RTLS system and Integriti in the RTLS Integration configuration editor. This converts 3rd party map coordinates to GPS coordinates used by Integriti Schematic Maps. Refer to the individual integration’s manual for the specific method.

Configuring Alerts for RTLS Alarms

  1. Set the Alert Source to Review Filter.
  2. Under Trigger Events, select RTLS Alarm (or relevant categories).
  3. For Asset-specific alarms, set Grouping to Group By Format String with format {Object_1}.
  4. Under the Basic tab, enable Refresh Alerts On Location Change.
  5. Optionally add Control Workstation actions on Created/Retriggered/Claimed to auto-show the Asset on the relevant Schematic Map.

4. Monitoring

Monitoring RTLS Events/Alarms

Once enrolled with Persisted Connection enabled, the integration automatically receives events/alarms and logs them as Review Records. Review text is prepended with the integration name in square brackets. Categories allow filtering by event type.

Filtering Events/Alarms

Two methods (can be combined):

  • Connection Configuration — Enable/disable event types in the top-level Integrated Device properties.
  • Generate Review Transitions — Select specific Categories to generate Review Records. No categories selected = no monitoring.

Monitoring RTLS Device State

Not supported by all RTLS integrations. When supported:

  • State changes for all RTLS assets loaded via Refresh Device are monitored.
  • Assets no longer in the 3rd party system are marked Offline.
  • Initial state is loaded on integration startup.

View RTLS asset state from:

  • RTLS Asset List — Status and Summary columns.
  • Review — State change events if device state categories are enabled.

Tracking RTLS Assets on Schematic Maps

  • GateKeeper: RTLS Position Update events automatically update asset positions on Schematic Maps via alerts.
  • RTLS Asset List: Right-click an asset → Show on Map.
  • Review Event: Right-click an RTLS review record → Show on Map.

Viewing Associated Footage

  • From Review: Right-click a review record → Show CCTV Footage (playback at event time). Or drag-and-drop a Review Record onto an existing viewer.
  • From RTLS Asset List: Right-click an asset → Show Associated CCTV Footage (live view).

5. Invoking Commands

Not supported by all RTLS integrations.

  1. Right-click the RTLS Server in the Integriti device list → Invoke Integrated Device Command.
  2. Select the command from the dropdown.
  3. Configure options and press Ok.

Task Action: Use Invoke Integrated Device Command Task Action in Scheduled Tasks, Alert Definitions, or Guard Tours for automated triggering.

Verification

  • Persisted connection establishes successfully (check logs/review for connection messages).
  • RTLS events and alarms appear in Integration Review window.
  • RTLS assets populate in the RTLS Asset list after Refresh Device.
  • Asset positions update on Schematic Maps in GateKeeper.
  • Show CCTV Footage option is available and displays correct camera streams.

Troubleshooting

IssueChecks
Plugin does not appear in New Integrated Device listEnsure both 32-bit and 64-bit Integriti Integration Servers are running. Restart both servers and System Designer client.
Events/Alarms not being receivedIs Persisted Connection enabled? Can it connect to the RTLS server? Does Generate Review Transitions contain review categories?
Asset location not updating on mapIs Persisted Connection enabled and connected? Is RTLS Position Update event received? Are map associations configured?
Show CCTV Footage option not availableDoes the Schematic Map contain at least one Area and CCTV Camera? Is the Area added to camera associated entities? Are positions allocated for Schematic Map elements?

Graph View

Backlinks