Agent
Learn how to create, deploy and use Agents (also called Edge Connectors).
The Heisenware Agent is an executable program that securely integrates data and systems from a private network with your Heisenware workspace. It is the solution for connecting to data sources or sinks (like PLCs or local databases) that are not accessible from the public internet.
You create and configure an Agent in the App Builder, download it, and then run it on a machine within your private network. Once running, it establishes a secure connection back to your workspace, making its configured connectors and their functions available in the Flow Builder.
How It Works: Technical Overview
Connection: The Agent establishes a secure, outbound-only connection to your Heisenware workspace via MQTTS (encrypted MQTT) on port 8883.
System Requirements: The Agent can be run on most 64-bit hardware, with dedicated versions for:
MacOS
Windows
Linux (including a separate Alpine version)
ARM64 (for Industrial PCs)
Creating and Deploying an Agent
Create and Download the Agent
In the Functions Library, click the Create Agent icon [].
In the creation dialog, select the connectors you want to bundle into your Agent.
Select the target operating system for the machine where the Agent will run.
Optionally, define a Prefix (see the advanced guide below for details).
Click Submit. The Agent will be built, and the download will start automatically.
Deploy and Run the Agent
Move the downloaded Agent file to a computer within the private network (e.g., an industrial PC on the OT network). This machine must be able to access the system you want to integrate (e.g., the OPC UA server).
Run the executable. On Linux and MacOS, you may need to make the file executable first (
chmod +x <agent-file-name>).
Use the Agent in the Flow Builder
Once the Agent is running and connected, the Agent and its configured connectors will automatically appear in the Functions Library. You can then expand it and drag its functions onto the Flow Builder canvas just like any other function.
Troubleshooting Tip: Check Port 8883
The Agent requires port 8883 to be open for outbound traffic. If the Agent runs but does not appear in your Library, speak with your IT administrator to ensure this port is not blocked by a firewall.
Using a Prefix for Fleet Deployment
The Prefix option changes how an Agent identifies itself, which is extremely useful for managing a fleet of similar machines or devices.
Without a Prefix (Default): The Agent has a built-in, unique ID. This means you can only run one instance of this executable at a time. You can move the file to different computers, but it will always be recognized as the same single Agent.
With a Prefix: The Agent generates a new, unique ID upon its first launch in a specific directory. This allows you to deploy the exact same executable file on multiple machines. Each one will run simultaneously, connecting as a separate entity in your Functionality Panel, making it easy to manage entire fleets of identical endpoints.
Do not move an Agent that was created with a prefix after it has been run for the first time, as it relies on a hidden ID file in its directory to maintain its identity.
Available Connectors
The Agent acts as a "transport vehicle" for bringing connectors into a private network. The following connectors are currently available to be included in an Agent.
Currently available:
OS: Read and display server stats.
InfluxDB: Connect to an InfluxDB database.
SQL: Connect to a SQL database (PostgreSQL, MySQL, etc.).
HTTP: Connect to an internal HTTP server or web API.
Files: Read from and write to files on a local file system.
Modbus: Connect to Modbus devices.
Siemens S7: Connect to a Siemens PLC.
OPC UA Client: Connect to an OPC UA Server.
OPC UA Server: Deploy and configure a new OPC UA Server.
MQTT Client: Connect to an MQTT Broker on the local network.
Serial port: Connect to devices via RS-232/485 interfaces.
Busylight: Control Kuando Busylight devices.
Last updated