Getting Started Cameras & Video Detection & Recording Automation & Events Actions Integration & Connectivity Network & Discovery AI & Remote Control MQTT Modbus ZeroMQ System & Administration Use Cases Troubleshooting About & Legal
Home / Documentation / Agent Connector
Knowledge base

Agent Connector

Agent Connector establishes a WebRTC connection to a remote Banalytics Agent instance. Once running, it acts as an event consumer so that local events can be forwarded to the remote agent via the Forward Event To Consumer action.

Connect to a remote agent instance

Use Agent Connector when two Banalytics Agent deployments need to exchange events. A typical setup has a field agent that detects and processes events, and a hub or central agent that aggregates them, applies further rules, or delivers notifications.

You need the remote agent's UUID and the shared password before you configure the connector. Both values are set on the remote agent side and must match exactly.

01

Add the connector

In the Banalytics server view, open the component section, click the plus button, and select Agent Connector from the component type list.

02

Enter the remote agent UUID and password

Set Agent UUID to the UUID of the target remote agent and Password to the shared connection secret. Both must match the corresponding values on the remote agent side.

03

Start the component and verify connectivity

Start the connector and confirm it reaches the RUN state. A connector that fails to connect will show an error state. Verify network access and credentials before using the connector in production rules.

Configuration parameters

ParameterRequiredDescriptionDefault
Title
YesDisplay name for this connector instance. Use a name that identifies the remote agent, for example Central hub or Site B monitor.None
Agent UUID
YesUUID of the target remote Banalytics Agent. This value must exactly match the identifier assigned to the remote agent instance.None
Password
YesShared connection secret used to authenticate the WebRTC session with the remote agent. Must match the password configured on the remote side.None

Bridge two agents for event routing and control

Agent Connector is a connectivity component. When running, it maintains a peer-to-peer WebRTC channel to the remote agent and registers itself as an available event consumer in the local agent. Event Manager rules or action chains can then select it as the target for Forward Event To Consumer, routing filtered local events across the link.

COM

Remote agent link

Represents a persistent WebRTC session to another Banalytics Agent. The component must be in RUN state for forwarding actions to deliver events through it.

EVT

Event consumer

Registers as an event consumer in the local agent. Forward Event To Consumer can select it as a destination so that local events are relayed to the remote agent.

NET

WebRTC transport

Uses WebRTC for peer-to-peer communication between agents. Both agents must be network-reachable to each other for the connection to establish and stay active.

Agent-to-agent event routing scenarios

01

Central event aggregation

Deploy Agent Connector on each field agent pointing to a central hub agent. Use Forward Event To Consumer on the field agents to route filtered events to the hub, where a single Event Manager instance applies unified rules across all sites.

02

Cascaded notification pipeline

A field agent detects events and forwards them through Agent Connector to a hub agent that has email or portal delivery configured. This separates detection logic from notification infrastructure and lets you add or change delivery without reconfiguring every field agent.

03

Multi-site event mirror

Forward events from one agent to another when both sites need visibility into the same event stream. Each site runs its own rules, but security-relevant or cross-site events are mirrored through the connector for centralized audit.

04

Remote action triggering

When the remote agent processes forwarded events with its own Event Manager rules, it can trigger actions on the remote side in response to events that originated locally. This allows distributed automation without coupling the two agents' rule sets.

05

Connectivity verification

Start the connector and confirm it reaches RUN state to verify that two agent deployments can reach each other over WebRTC before building production rules that depend on the link.

Operational notes

01

Must be in RUN state before forwarding actions fire

Forward Event To Consumer delivers events through the connector only when it is running. Start the connector and confirm the RUN state before enabling any Event Manager rules that depend on it.

02

Agent UUID and password must match exactly

The Agent UUID must be the exact UUID of the target remote agent. The Password must match the credential configured on the remote side. A mismatch on either value prevents the WebRTC session from establishing.

03

Network path between agents is required

WebRTC requires that both agents can reach each other over the network. Firewalls, NAT configurations, or isolated network segments may block the connection. Verify bidirectional reachability before deployment.

04

Restart after credential changes

Changing Agent UUID or Password requires restarting the connector so the new credentials take effect and the WebRTC session is re-established.

05

Filter events before forwarding

Use Event Manager filters and conditions to select only the events that should cross the link. Forwarding every raw detector event can saturate the WebRTC channel and create noise in the remote agent's event history.

06

Multiple connectors for multiple remote agents

Create a separate Agent Connector instance for each remote agent. Each instance manages its own WebRTC session and credentials independently.

Related pages

Related components and pages