Core Integration
Overview
Integriti’s Core Integrations allow key functionality from 3rd party systems to be monitored and controlled directly from the Integriti software suite, providing a single head-end for access control and intruder detection.
Key features:
- Events — Pull events from integrated 3rd party systems directly into Integriti Review, enabling associated video viewing, real-time monitoring, and automated actions.
- Control — Directly trigger 3rd party actions, manually from the integrated system/endpoint or automatically via Task Actions.
- Status — View current state of 3rd party devices from the device list or Schematics.
Prerequisites
Licensing
- Sufficient Integriti Version License for the integration version.
- Some integrations may require additional feature-specific licenses (check the integration’s Release Notes).
System Requirements
Refer to the individual integration’s manual for specific pre-requisites and system requirements. If none are listed, requirements match the minimum Integriti software release.
Version Matching
The same version of each integration must be installed on both the Integriti Integration Server and all client workstations.
Step-by-Step
Installation
- Close all Integriti software instances and stop all running Integriti services.
- Download and run the Integriti Integration installer on all Integriti servers first, then on all client workstations.
- After installation, restart all previously stopped services.
- If downgrading, uninstall the current version before installing an earlier version.
Enrolment
- In Integriti System Designer, select New Integrated Device from the System tab.
- Select the integration from the list and press Ok.
- If the integration does not appear, ensure both 32-bit and 64-bit Integriti Integration Servers are running.
- Give the new device a Name and optionally Notes.
- Set Persisted Connection Run Mode:
- Automatically Maintain Connection on Any Single Server (recommended) — ensures one server is always connected; in HA systems, connection auto-fails over.
- Maintain Connection on the Specified Server — use if only one server can connect.
- Simultaneously Maintain Connection on All Servers — may cause duplicate Review records.
- Disabled — use only if event/state monitoring is not required.
- On Device Properties tab, configure Connection Configuration — details for connecting to the 3rd party system.
- Click Save.
- Click Refresh Device to load configuration details (available events, commands) from the 3rd party system.
- Click Refresh Child Devices and confirm — this populates child integrated device endpoints:
- Queries the 3rd party system for configured devices.
- Or performs a network scan for compatible devices.
- Or creates devices based on child devices configured in the integrated system.
- Existing devices are updated (Integriti config preserved); new devices are added with defaults; removed devices are deleted.
- Save and close — a persisted connection will start automatically.
Associating Integriti Entities
Associate entities (Doors, Areas, Inputs) with integrated endpoints to enable:
- Showing Associated CCTV Footage — view video from cameras associated with the same entities.
- Automatic Input Triggering — automatically trigger/restore inputs when specific events are received.
Monitoring Events
- Once enrolled (with persisted connection enabled), the integration begins receiving events/alarms.
- Review Records are automatically generated; text is prepended with the integration name in square braces.
- View in CCTV/Integration Review window (Window tab in System Designer, Home tab in Gatekeeper).
Filtering Events:
- Connection Configuration — may include checkboxes or dropdowns to enable/disable event types.
- Generate Review Transitions — select specific Categories to generate review records; unselected categories are not monitored. Configurable at both Integrated Device and Integrated System levels.
Monitoring Device State
(Supported integrations only)
- States monitored: online/offline, active alarms.
- Initial state loaded on integration startup.
- View state from:
- Integrated Device List — Status and Summary columns.
- Review — if Generate Review Transitions is configured.
- Schematics — add integrated devices to a Schematic with Element Presenters for live status indication.
Automatic Input Triggering
- Open the editor for the Integrated System or Device.
- For a device: set Auto Input Triggers Mode to Use Selected (otherwise Inherit From Parent).
- Select Review Categories under Auto Input Triggers.
- Set Input Restore Mode to Use Selected and choose restore Categories, or set to None if inputs should not auto-restore.
- Under Associations tab, add the Inputs to be triggered/restored.
Using Events as Triggers
Integration events can trigger Scheduled Tasks and Alerts:
- In Alert Definition: add a Review Filter Alert Source. In Scheduled Task: add a Review Trigger.
- Select required Categories.
- Set grouping type to And (not Or).
- Add a Text Contains
[<IntegrationName>]row to filter by specific integration. - Add a Text Contains
<DeviceName>row to filter by specific device. - Save — matching events will activate the alert/scheduled task.
Viewing Video from Associated CCTV Cameras
If video streaming is not natively supported by the integrated device, associate it with entities that are also associated with CCTV cameras. Viewing video for the integrated device will then show footage from those cameras.
Invoking Commands
(Supported integrations only)
- Right-click a supported integrated system/device and select Invoke Integrated Device Command.
- Choose the command, configure options, press Ok.
- Automate via Invoke Integrated Device Command Task Action in Scheduled Tasks, Alert Definitions, or Guard Tours.
Verification
- After enrolment, verify the connection is active by checking device status.
- Trigger an event in the 3rd party system and confirm a Review Record appears in Integriti Review.
- Verify associated CCTV footage displays correctly (if CCTV integration is also configured).
- Test Automatic Input Triggering by triggering the configured event and checking the associated input changes state.
- Test Invoke Command manually from the context menu, then via an automated Task Action.
Troubleshooting
| Issue | Resolution |
|---|---|
| Plugin does not appear in ‘New Integrated Device’ list | Ensure both 32-bit and 64-bit Integriti Integration Servers are running. Restart both servers and System Designer. |
| Events not generating Review Records | Verify Persisted Connection Run Mode is not Disabled. Check Generate Review Transitions — ensure desired categories are selected. Check Connection Configuration event filters. |
| Child devices not populating | Verify Connection Configuration is correct. Check network connectivity to the 3rd party system. Ensure the 3rd party user has sufficient permissions to query devices. |
| Device state not updating | Confirm the integration supports state monitoring. Verify Persisted Connection is enabled. |
| Commands not available | Check the integration’s capabilities guide — not all integrations support Invoke Command. |