Forwarders
Forwarders can stream points and processed events to sinks.
The configuration of the forwarders determines which data to forward, along with possible extra forwarder specific settings for the sink.
General Configuration
When configuring a forwarder, the following fields are available:
Name
Description: Enter a unique name
Description
Description: Enter a description (Optional)
Enabled
Description: Enable/disable the forwarder
Sink
Description: Select the sink to forward to. The list shows the configured sinks with their type; the forwarder type follows from the sink you pick.
SparkplugB forwarder configuration
The SparkplugB forwarder uses the same selector as the generic MQTT forwarder, so it also has the Forward points on measurements, Forward points on asset properties and On change toggles described under the generic MQTT forwarder. Select measurements only appears once Forward points on measurements is enabled.
Reload interval
Description: Enter a reload interval, this interval determines how often the forwarder checks for objects to forward Default: 5m
Good points only
Description: Toggle whether or not to only forward points with status Good Default: disabled
Select assets
Default: disabled
- Toggle All assets to forward all points OR
- Select asset-properties for which to forward the points
A SparkplugB forwarder forwards points only. Events are forwarded by the generic MQTT forwarder, which is the only one that offers a Forward events toggle.
Select measurements
Default: disabled
- Toggle All measurements to for points for all measurements/calculations OR
- Select measurement labels for which to forward points
Generic MQTT forwarder configuration
Reload interval
Description: Enter a reload interval, this interval determines how often the forwarder checks for objects to forward Default: 5m
Forward points on measurements
Description: Toggle whether to forward measurement data Default: disabled
Forward points on asset properties
Description: Toggle whether to forward asset property data Default: disabled
Good points only
Description: Toggle whether or not to only forward points with status Good Default: disabled
On change
Description: Toggle whether to only send points when the value changes Default: disabled
Forward events
Description: Toggle whether to forward events Default: disabled
Select measurements
- Toggle All measurements to for points for all measurements/calculations OR
- Select measurement labels for which to forward points
Select assets
- Toggle All assets to forward all events/points OR
- Select assets for which to forward the events
- Select asset-properties for which to forwards the points
Measurement topic template
Description: Enter the topic to forward measurements on
There are a couple of template variables available to determine the topic based on the data
- Asset property topic template Enter the topic to forward asset property points on
- Event topic template Enter the topic to forward events on
For both topics there are a couple of template variables available to determine the topic based on the data
Message templating
For measurements, the MQTT message can be templated. There are a couple of example templates available to get you started.
For a detailed overview of the capabilities of the templating engine, see the templating documentation.
Once you’ve written your template, you can test it by clicking the Test button.
Event Publishing
Events are published once once they get the state Processed.
When configuring the event publishing, you can specify the MQTT topic where these events will be sent. The topic can be customized using template variables to dynamically generate the topic name based on the event data. This allows for more flexible and organized event management.
For example, you might use a topic structure like events/{{.Asset}}/{{.EventType}} to categorize events by asset and type, making it easier to subscribe to specific types of events in your MQTT client. The event topic template has exactly three fields available: Asset, AssetPath and EventType.
Additionally, you can control which events are forwarded by selecting specific assets or event types, providing fine-grained control over the event data that is published.