Overview
The 3rd Party Review Receiver allows review data to be streamed from a third-party TCP client to the Integriti server for review logging. It acts as either a TCP server, TCP client, or serial port receiver, accepting formatted review records from external systems and logging them into Integriti’s review database.
This is the counterpart to the Review Sender — the Review Receiver ingests review data from external sources, while the Review Sender streams Integriti review data out to third-party systems.
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 sender.
- If using TLS/SSL: appropriate certificates installed and configured.
Step-by-Step
1. Create the Communications Handler
- Open the Communications Handlers panel from the Administration tab.
- Click the Add New button.
- Give the handler a name and add any necessary notes.
- Choose Handler Type of 3rd Party Review Receiver.
2. Basic Configuration
- Message Header String — Specify a string that indicates the start of a valid review record.
- Message Trailer String — Specify a string that indicates the end of a valid review record.
At least one of Header or Trailer must be specified.
Escape sequences for special characters:
\n— newline (U+000A)\r— carriage return (U+000D)\\— backslash- Most other C escape sequences are supported.
- Suppress Review for Connect/Disconnect — Toggle to hide review events when the sender connects or disconnects.
- Review Received Acknowledgement — Optionally specify a string sent back to the sender to acknowledge receipt. Same escape sequences apply.
3. Connection Settings
Choose a Connection Type: TCP Client, TCP Server, or Serial.
TCP Client
| Setting | Description |
|---|---|
| Port | Port number to connect on. |
| Remote Server | Address of the review receiver server. |
| Retry After | Wait time before retrying on connection failure (milliseconds). |
| Security Type | Choose TLS/SSL for encrypted transmission. |
| Client Certificate Store | (SSL only) System certificate store for client certificate. |
| Remote Certificate Thumbprint | (SSL only) Optional — the required server certificate thumbprint. Leave blank for any trusted certificate. |
| Check Certificate Revocation | (SSL only) Check server certificate revocation status. |
TCP Server
| Setting | Description |
|---|---|
| Port | Port number to listen on. |
| Incoming Connection Type | Optional — restrict allowed hosts (single hostname or IP range). |
| Security Type | Choose TLS/SSL for encrypted transmission. |
| SSL Certificate Filename | Absolute path to certificate file (.pfx, .p12, or .cer). For X.509, the private key must be in the Personal certificate store. |
| Require Client Certificate | If enabled, clients must present a certificate. |
| Remote Certificate Thumbprint | Optional — required client certificate thumbprint. |
| Check Certificate Revocation | Check client certificate revocation status. |
Serial
| Setting | Description |
|---|---|
| Retry After | Wait time before retrying on connection failure (milliseconds). |
| COM Port | Serial port name (e.g. COM1). |
| Serial Parameters | Baud rate, data bits, parity, stop bits, flow control. |
4. Start the Handler
- Save the handler. It should appear as Running in the Communications Handlers panel.
- The third-party system can now connect and begin sending review records.
Verification
- Check the Communications Handlers panel — the handler should show status Running.
- When a third-party connects, a review message appears:
"- [remote IP] is connected". - Send test data from the third-party system matching your configured Header/Trailer strings — verify the review records appear in Integriti’s Review window.
Example Outputs
Format 1 (simpler):
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 and controller fields):
12/13/2012 11:06:30 AM - Alarm Activated on C01:Z01 (A...............)
- InputChange - Head Office - C01:Z01 -
12/13/2012 11:06:31 AM - Xmit Alarm Activated on C01:Z01 by Area 1 -
XmitInputChg - Head Office - C01:Z01 - A1
Troubleshooting
| Problem | Resolution |
|---|---|
| Third-party cannot connect | Verify the handler is Running. Check network connectivity and that the configured port is open through firewalls. For TCP Server mode, verify Incoming Connection Type allows the client’s IP. |
| Review records not appearing | Verify the Message Header and Message Trailer strings exactly match what the sender transmits (including escape sequences). At least one must be specified. |
| TLS/SSL connection fails | Check certificate paths, thumbprints, and certificate store permissions. Ensure the correct Security Type is selected. |
| Serial connection fails | Verify the COM port name and serial parameters match the connected device. Check that no other application is using the port. |