Pager Message Sender
Overview
The Pager Message Sender is a Communications Handler that streams Integriti review (event) data to a third-party TCP client. It formats review events using a configurable format string and sends them in real time as they occur in the Integriti system.
The handler can connect to the 3rd party system in three modes:
- TCP Client — Integriti initiates the connection
- TCP Server — Third-party client connects to Integriti
- Serial Port — Direct serial connection
Prerequisites
- Integriti software with Communications Handler support
- A third-party TCP client or serial device to receive review data
- Network connectivity between the Integriti Application Server and the receiving system
- Optional: SSL certificate if using encrypted transmission
Step-by-Step
1. Create the Communications Handler
- Open the Communications Handlers panel from the System tab.
- Click Add to create a new handler.
- Give it a Name and add notes.
- Choose a Sender Type of Review Sender.
2. Configure Format String
The format string controls how each review event is formatted. It can mix literal text with review fields surrounded by % characters.
Default format:
%Your Local Time% - %Text%\r\n
Available review fields:
| Field | Description |
|---|---|
%1st Entity% through %5th Entity% | IDs of entities referenced in the review text |
%Actor's Local Time% | Controller (or server) local time |
%Actor's UTC Time% | Controller (or server) UTC time |
%Analog Value% | Value of the analog device |
%Classification% | Review level classification |
%Controller% | Controller where the event originated |
%ControllerSN% | Controller Serial Number |
%Data% | Hexadecimal raw review data |
%Level% | Review Level |
%Priority% | Review priority level |
%Record% | Controller review record index |
%Source% | Where the event came from |
%Text% | Review Text |
%Transition% | Type of transition at the time of event |
%Type% | Review Type |
%UTC Time Received% | UTC time on database server when review received |
%Your Local Time% | Local time on the Application Server |
Literal text can include escape characters: \n (newline), \r (carriage return), and other C-like escape sequences.
3. Set Port and Connection Parameters
- Port — Port to listen on or connect to (default is fine for most cases).
- Review Pagesize — Database efficiency parameter (rarely needs adjustment).
- Synchronisation — If enabled, a start date/time must be sent before streaming begins (e.g.,
"Start 08/10/2012 11:45").
4. Configure Security (Optional)
- Enable Security — Use for encrypted transmission over the internet. Requires the consumer to be familiar with SSL/TLS.
- SSL Certificate Filename — Absolute path to certificate on the server (e.g.,
C:\MyCerts\XYZCo.cer). - Require Client Certificate — Tick if the client must present a certificate.
- SSL Protocol Type — Options: None, SSL2, SSL3, TLS, Default (SSL3 or TLS).
5. Configure Incoming Connections
- Incoming Connection Type:
- Any — Accept from any listener
- Range IP Address — Accept from a specific IP range (start/end IP boxes appear)
- Named Host — Accept only from a specific hostname
6. Heartbeat Signal (Optional)
A configurable literal string sent periodically as a heartbeat to verify the connection is alive.
Verification
- After saving, the Comms Handler should show as Running.
- Connect a TCP client to the configured port and verify review events are received in the expected format.
- Generate a test event (e.g., badge a card at a door) and confirm it appears at the receiving end.
Example Outputs
Format 1 (default):
%Your Local Time% - %Text%\r\n
Output:
12/13/2012 10:56:30 AM - Alarm Activated on C01:Z01 (A...............)
12/13/2012 11:02:45 AM - Installer Card Access at R01:Rdr02 into Door 2
Format 2 (extended):
%Your Local Time% - %Text% - %Type% - %Controller% - %1st Entity% - %2nd Entity%\r\n
Output:
12/13/2012 11:06:30 AM - Alarm Activated on C01:Z01 (A...............) - InputChange - Head Office - C01:Z01 -
12/13/2012 11:17:32 AM - Installer Card Access at R01:Rdr02 into Door 2 - UserAccess - Head Office - D2 - U1
Troubleshooting
| Issue | Resolution |
|---|---|
| No review data received | Verify TCP connection is established; check port and firewall settings. |
| Data format incorrect | Review the format string syntax — fields must be surrounded by % characters. |
| Connection drops | Check heartbeat configuration; verify network stability. |
| SSL/TLS errors | Verify certificate path, protocol type, and that client certificate matches if required. |
| Synchronisation not working | Ensure the start date/time string is sent in the correct format before streaming. |