Table of Contents
Patriot Systems Integration
Patriot is alarm monitoring automation software used by Alarm Receiving Centres. TetherX sends alarms to a Patriot control room over Patriot's own interface rather than by email, so every signal is confirmed as it is recorded, arrives with the camera identified, and carries the verification image with it.
What this gives you
| Benefit | Description |
|---|---|
| Confirmed delivery | Patriot answers only once the alarm is recorded in its database. If it cannot be recorded, TetherX retries and reports the failure instead of assuming it arrived. |
| Named cameras | Each camera reports under its own number, so the operator sees which camera fired rather than a site-wide alarm. |
| Typed events | Person, vehicle, line crossing, loitering, tamper, camera offline and the rest arrive as distinct Patriot event types, so your control room can give each one its own action plan. |
| Verification image included | The snapshot travels inside the signal, so the operator sees it in Patriot without leaving the alarm. |
| Site position | The site's coordinates go with each alarm and appear on the account's Map tab. |
| No port forwarding | As with every TetherX integration, nothing is opened on the customer's network. |
What your control room sets up first
Ask your Alarm Receiving Centre to confirm all of the following. Each is a Patriot requirement, not a TetherX one.
- Internet Client Access with Extended Logins. The Patriot API is served by the control room's ICA host, and signal logging needs Extended Logins.
- A security group with the Log Signal right, and a user in that group created for TetherX. One user covers every site the control room monitors for you.
- That user assigned to each account TetherX will report against. Patriot refuses a signal for an account the user is not assigned to.
- The Standard Media Camera module, with the account's Camera Type set to Standard Media, if the operator is to see the verification image.
- An event type template covering the TetherX event numbers, so each alarm has a description and an action plan. Your control room can request the template from TetherX support.
Ask them for the ICA address, the username and password for the TetherX user, and this site's client number in Patriot, which includes the area and port, for example 0013BASE01.
Patriot documents these steps, with screenshots of each screen, in its own library:
- Setting up a JSON API user (opens in a new tab) - the security group, the user, and assigning it to an account
- Standard Media Camera (opens in a new tab) - the camera type that shows verification media to the operator
- Network Video Stream (opens in a new tab) - live video inside Patriot
- Test mode (opens in a new tab) - suppressing an account during maintenance
Setting it up in TetherX
Select the Patriot Systems tab.
Enter the connection details your control room gave you:
- Patriot Address: the ICA web address, for example
https://ica.example.com - Client Number: this site's Patriot account number, including area and port
- Username and Password: the Patriot user created for TetherX
- Module Number: leave at 0 unless your control room asks otherwise
- Send Verification Image: leave on so the snapshot goes with each alarm
Switch Enable Integration on. TetherX asks for the connection details first, so that a site cannot be left switched on with nothing to report to.
Once enabled, TetherX AI detections, camera analytics and VMD Events for this site are logged in Patriot as they happen, along with device and camera communication failures.
Camera numbers
Patriot identifies a camera by number within the account. TetherX assigns each camera a number the first time it raises an alarm, and keeps it for the life of the camera.
The Camera Numbers list on the Patriot Systems tab shows the number for each camera at the site. Send that list to your control room so they can name each zone in Patriot. The operator then sees "Person Detected - Loading Bay" rather than a bare number.
Adding live video
Alarms carry a still image. For live video inside Patriot, your control room can add each camera as a Network Video Stream camera, which plays the stream in the operator's normal Patriot screen and in Patriot's web client.
- Go to the Control Rooms page
- Copy the URL for each camera
- Send them to your control room to enter against the matching camera zone
If alarms are not arriving
- Check the site is armed. A disarmed site reports nothing, by design.
- Check the client number. Patriot rejects a signal whose account number it does not recognise, including a number missing the area and port.
- Check the user assignment. Patriot refuses a signal if the TetherX user is not assigned to that account.
- Ask your control room to check the event type template. A signal that arrives with no matching event type reaches the operator without a description.
TetherX reports a rejected signal to support with the reason Patriot gave, so raise a ticket if the settings look right and alarms are still missing.
Related Articles
- Control Room Software Integration - IMMIX, CONXTD and HikCentral
- Definitions - Event types and terminology
- Tunnelling to Network Devices - Remote access to on-site devices
Referenced in: