IR WIKI

Review Sender

5 min read

Overview

The Review Sender streams Integriti review events to a third-party TCP client in real time. It supports flexible output formatting, filtering, synchronization, and heartbeat monitoring. Connection types include TCP Client, TCP Server, and Serial.

This is the counterpart to the Review Receiver — the Review Sender pushes Integriti review data out, while the Review Receiver pulls third-party review data in.

Prerequisites

  • License: 996931 — Event Review I/O Communications. View and update licenses from the License Manager in the Administration tab.
  • Network connectivity between the Integriti server and the third-party receiver.
  • If using TLS/SSL: appropriate certificates installed and configured.

Step-by-Step

1. Create the Communications Handler

  1. Open the Communications Handlers panel from the Administration tab.
  2. Click the Add New button.
  3. Give the handler a name and add any necessary notes.
  4. Choose Handler Type of Review Sender.

2. Basic Configuration

Format String

  1. Enter a Format String defining how review data is formatted. Mix literal text with review record fields enclosed in curly braces {}.

Click the ellipsis (...) button to open the field chooser.

FieldDescription
{Entity_1} through {Entity_5}IDs of entities referenced in the review text
{LocalTimeGenerated}Time generated in the source’s local time
{UTCTimeGenerated}Time generated in UTC
{AnalogValue}Value of the analog device
{Classification}Review level classification
{ControllerName}Controller where the event originated
{ControllerSN}Controller Serial Number
{RawData}Hexadecimal raw review data
{Level}Review Level
{Priority}Review priority level
{Record}Controller review record index
{Source}Controller or server that generated the record
{Text}Review text
{Type}Review type

Default format string: {LocalTimeGenerated} - {Text}\r\n

Escape sequences: \n (newline), \r (carriage return), \\ (backslash), and most C escape sequences.

Additional Basic Settings

  1. Review Page Size — Maximum review records to retrieve from the database at once. Default is fine for most users.
  2. Filter — Optionally restrict which review records are processed. Click the ellipsis to open the Filter Stack Editor (see section below).

3. Synchronization (Optional)

  1. Enable Synchronization — If enabled, a start date/time must be sent to the application server before streaming (e.g. START 2022-10-08T01:45:00+11:00). The date, time, and UTC offset must be included; a zero UTC offset can use Z. Otherwise streaming starts from the server’s current time.
  2. Review Search Mode — Choose how old review events are allowed to be (relevant when offline controllers come back online).

4. Heartbeat (Optional)

  1. Enable Heartbeat — Choose whether to send periodic heartbeat messages.
  2. Heartbeat String — The string to send (supports escape sequences).
  3. Heartbeat Timeout — Frequency in milliseconds.

5. Connection Settings

Choose a Connection Type: TCP Client, TCP Server, or Serial.

TCP Client

SettingDescription
PortPort number to connect on.
Remote ServerAddress of the review receiver server.
Retry AfterWait time before retrying on failure (milliseconds).
Security TypeChoose TLS/SSL for encrypted transmission.
Client Certificate Store(SSL only) System certificate store for client certificate.
Remote Certificate Thumbprint(SSL only) Optional — required server certificate thumbprint.
Check Certificate Revocation(SSL only) Check server certificate revocation status.

TCP Server

SettingDescription
PortPort number to listen on.
Incoming Connection TypeOptional — restrict allowed hosts (single hostname or IP range).
Security TypeChoose TLS/SSL for encrypted transmission.
SSL Certificate FilenameAbsolute path to certificate file (.pfx, .p12, or .cer).
Require Client CertificateIf enabled, clients must present a certificate.
Remote Certificate ThumbprintOptional — required client certificate thumbprint.
Check Certificate RevocationCheck client certificate revocation status.

Serial

SettingDescription
Retry AfterWait time before retrying on failure (milliseconds).
COM PortSerial port name (e.g. COM1).
Serial ParametersBaud rate, data bits, parity, stop bits, flow control.

6. Start the Handler

  1. Save the handler. It should appear as Running in the Communications Handlers panel.

Filter Stacks

Filter stacks allow granular control over which review messages are sent. Use the + and - buttons to add or remove groups and rows.

  • Group — A set of conditions combined by a logical operator (AND or OR).
  • Row — A single condition with three properties: criteria, operator, and operand value.
  • Groups can be nested for complex filtering logic.

Filter Example

To send only access control events for a specific door:

  1. Generate the event in the system.
  2. Double-click the review message in the Review window.
  3. Expand Entities to see which entity fields map to the door.
  4. Build a filter using the correct Entity fields.

Verification

  • Check the Communications Handlers panel — the handler should show status Running.
  • Connect a third-party TCP client to the configured port and verify review events stream in real time.
  • If using Synchronization, send a START command and verify events from the specified time appear.
  • If using Heartbeat, verify the heartbeat string appears at the configured interval.

Example Outputs

Format 1 (default — {LocalTimeGenerated} - {Text}\r\n):

12/13/2012 10:56:30 AM - Alarm Activated on C01:Z01 (A...............)
12/13/2012 10:56:31 AM - Xmit Alarm Activated on C01:Z01 by Area 1

Format 2 (with type, controller, entity fields):

12/13/2012 11:17:32 AM - Installer Card Access at R01:Rdr02 into Door 2 - UserAccess - Head Office - D2 - U1
12/13/2012 11:17:32 AM - Door 2 Timed Unlocked for 00005 secs ... - DoorEvent - Head Office - D2 - R01

Troubleshooting

ProblemResolution
No review events being sentVerify the handler is Running. Check the Filter — ensure it’s not excluding all events. Verify the third-party client is connected to the correct port.
TLS/SSL connection failsCheck certificate paths, thumbprints, and certificate store permissions. Ensure the correct Security Type is selected.
Synchronization not workingVerify the START command format: START YYYY-MM-DDThh:mm:ss+HH:MM with date, time, and UTC offset all included. Use Z for UTC.
Serial connection failsVerify the COM port name and serial parameters match. Check no other application is using the port.
Heartbeat not appearingEnsure Enable Heartbeat is checked and the Heartbeat Timeout is set to a reasonable value.

Graph View

Backlinks