Ignition Module
The Ignition Module connection allows for browsing, reading, and writing tag data and UDTs to and from Ignition, and for reading tag history. The connection requires that the HighByte Ignition Module be installed on the Ignition server. For details on downloading and installing the module, please see the install section.
With the module installed in Ignition, the Intelligence Hub connects securely to the module using secure web sockets.
Connection Settings
Host
The IP address or domain name of the Ignition server.
Port
The port used to connect. By default the port is 45280. This port must be open and available on the Ignition server.
Password
The password used to authenticate the connection. This is set in Ignition under the module configuration (see module installation).
Connect Timeout (seconds)
How long to wait for a connection before failing.
Request Timeout (ms)
How long to wait for a read or write to complete before failing.
Input Settings
Inputs can read tags, folders, UDTs, or tag history from any Tag Provider in Ignition. Tag Path and UDT Instances input reads are subscribed and serviced from cache during read. If a Tag Provider is changed, for example a tag is added or deleted, the module automatically detects this change and reflects the changes in the next read.
| Type | Description | Data Flow Support |
|---|---|---|
| Tag Path | Reads all tags, folders, and UDT instances at the tag address. | Polled & Event |
| UDT Instances | Reads a list of the UDT instances at the tag address. | Polled & Event |
| Tag History | Reads the history of one or more tags over a time range, as raw samples or aggregates. Requires Ignition 8.3 or later. | Polled Only |
Tag Path and UDT Instances inputs support subscriptions and can be used as a source in an Event Trigger. When used as an event source data updates are change-based using Ignition subscriptions. The _name and _model keys are always
included with UDT instances for identification purposes. Reading an input used as an event source returns the latest cached data associated with that address. The Ignition Module buffers tag changes in 100ms intervals to produce data change events. Data changes are not lost unless the journal limit of 10K is exceeded in any given 100ms interval. Event log messages are logged any time the data change journal overflows.
Tag Address
The full tag address of a Tag Path or UDT Instances input, as defined by Ignition. This includes the Tag Provider and the path. The address can point to a tag, folder or UDT. When reading a folder or UDT, all child tags, folders, and UDTs are also read. Examples are provided below.
// Read a line and all child data
[default]/site/are/line
// Read a tag
[default]/mytag
// Read the entire tag provider
[default]
Type: Tag Path
Recursively reads the Tag Provider namespace at the specified address and returns all tags, folders, and UDT instances.
Type: UDT Instances
Recursively reads the Tag Provider namespace at the specified address and returns a list of UDT instances according to the UDT Inclusion Filter.
UDT Include Filter
Specifies the User Defined Types to match when searching the specified address. The input always produces a list of UDT instances. If empty, the list contains UDT instances of all types.
Include Metadata
For Tag Path and UDT Instances inputs, when enabled, the tag value is nested under a value field alongside the following metadata fields:
| Field | Description |
|---|---|
_tagName | The full tag path. |
_tagQuality | The server quality of the tag. |
_tagTimestamp | The source, server, or fetch timestamp of the tag. |
Type: Tag History
Reads the values Ignition has recorded in tag history for one or more tags over a time range. Values can be read as the raw samples stored by the historian, or as aggregates Ignition calculates over fixed intervals. Each tag must have history enabled in Ignition.
| Setting | Description | Default |
|---|---|---|
| Tag Addresses | The Ignition tag paths to read history for, such as [default]Line1/Temperature. A folder, UDT instance, or tag provider address reads every history-enabled tag beneath it. At least one address is required, and every address must be from the same tag provider, otherwise the read fails. | |
| Query Type | Raw returns the values recorded by the historian. Aggregate applies an aggregate over each interval between the Start Time and End Time. | Raw |
| Start Time | The start of the time range, as an ISO 8601 date and time (for example 2026-09-01T00:00:00Z) or an epoch time in milliseconds (for example 1788220800000). A timestamp without an offset is read as UTC. Samples at the Start Time are included. | |
| End Time | The end of the time range, in the same format as Start Time. It must be later than the Start Time. Samples at the End Time are excluded, so the next read can start at it. | |
| Aggregate | The aggregate applied to every tag. Only available when Query Type is Aggregate. See the supported aggregates below. | Time-Weighted Average |
| Interval | The width of each aggregate window between the Start Time and End Time. Only available when Query Type is Aggregate. | 1 hour |
| Include Metadata | When enabled, the tags are nested under a value key alongside a _metadata object describing the query and each tag. See the example below. | Disabled |
Aggregates
Aggregates are calculated by Ignition. The windows start at the Start Time, and each aggregate value is timestamped at the start of its window. Only complete windows are returned, and a window that would end after the End Time is dropped. For example, an Interval of 1 hour over a 3.5 hour time range returns three windows. An Interval longer than the time range returns no data.
The following aggregates are supported. The Metadata Value column shows the name reported in the aggregate field of the metadata.
| Aggregate | Metadata Value | Description |
|---|---|---|
| Time-Weighted Average | Average | The average of the values in each window, weighted by how long each value was held. |
| Simple Average | SimpleAverage | The average of the values in each window, not weighted by time. |
| Minimum | Minimum | The minimum value in each window. |
| Maximum | Maximum | The maximum value in each window. |
| Sum | Sum | The sum of the values in each window. |
| Count | Count | The number of values in each window. |
| Last Value | LastValue | The last value in each window. |
| Range | Range | The difference between the maximum and minimum values in each window. |
| Standard Deviation | StdDev | The standard deviation of the values in each window. |
| Variance | Variance | The variance of the values in each window. |
| Percent Good | PctGood | The percentage of each window in which the tag had good quality. |
| Percent Bad | PctBad | The percentage of each window in which the tag had bad quality. |
| Duration On | DurationOn | The time, in seconds, that the value was on (true) in each window. |
| Duration Off | DurationOff | The time, in seconds, that the value was off (false) in each window. |
| Count On | CountOn | The number of times the value changed to on (true) in each window. |
| Count Off | CountOff | The number of times the value changed to off (false) in each window. |
Tags that are not numeric or Boolean, such as String or DateTime tags, only support Count, Last Value, Percent Good, and Percent Bad. Any other aggregate returns an error for those tags.
Tag History Examples
Each tag is keyed by its full tag path. Each sample includes the value, its time in ISO 8601 UTC format, and its Ignition quality. Below is an example result for a Raw read of two tags.
{
"[default]Line1/Temperature": [
{ "value": 71.2, "time": "2026-09-01T00:00:00.000Z", "quality": "Good" },
{ "value": 71.6, "time": "2026-09-01T00:00:05.000Z", "quality": "Good" }
],
"[default]Line1/Pressure": [
{ "value": 14.7, "time": "2026-09-01T00:00:00.000Z", "quality": "Good" }
]
}
When Include Metadata is enabled, the tags are moved under a value key and a _metadata object is added. The metadata reports the time range read and the query type and, for each tag, its name, dataType, and
historyProvider, or the error if the tag failed. Aggregate reads also report aggregate and interval. For an aggregate read, endTime is the end of the last complete window, so the next read can start there.
The example below is an aggregate read from 2026-09-01T00:00:00Z to 2026-09-01T02:30:00Z with an Interval of 1 hour, where the third tag does not have history enabled.
{
"_metadata": {
"startTime": "2026-09-01T00:00:00.000Z",
"endTime": "2026-09-01T02:00:00.000Z",
"queryType": "Aggregate",
"aggregate": "Average",
"interval": "1 hour",
"tags": [
{ "name": "[default]Line1/Temperature", "dataType": "Float8", "historyProvider": "Core Historian" },
{ "name": "[default]Line1/Pressure", "dataType": "Float8", "historyProvider": "Core Historian" },
{ "name": "[default]Line1/Setpoint", "error": "History is not enabled for this tag" }
]
},
"value": {
"[default]Line1/Temperature": [
{ "value": 71.4, "time": "2026-09-01T00:00:00.000Z", "quality": "Good" },
{ "value": 71.9, "time": "2026-09-01T01:00:00.000Z", "quality": "Good" }
],
"[default]Line1/Pressure": [
{ "value": 14.7, "time": "2026-09-01T00:00:00.000Z", "quality": "Good" },
{ "value": 14.8, "time": "2026-09-01T01:00:00.000Z", "quality": "Good" }
],
"[default]Line1/Setpoint": []
}
}
Output Settings
Outputs can write to or create tag providers, tags, folders, and UDTs (both definitions and instances). Outputs automatically detect changes to a Tag Provider and reflect those changes on the next write.
Tag Address
The tag address to write to. This address must exist if Create is disabled, otherwise the write fails. Like inputs, the tag address must include the tag provider and full path.
Timestamp
Sets the timestamp of the write. When left blank, the timestamp is taken from _timestamp in the outgoing payload. If no timestamp is provided and the payload doesn’t contain _timestamp, the timestamp is set to the time of the write.
This setting supports dynamic outputs, so the timestamp can be pulled from the payload. As an example, {{this.mytimestamp}} pulls the timestamp from a mytimestamp attribute in the data. The timestamp can be in UTC ISO 8601 format or UTC epoch milliseconds.
Create
Enable this option to create tag providers, tags, folders, and UDTs if they don’t exist. See below examples of write payloads and how these map to the Ignition Address space.
Assume all the examples write to [myTagProvider] with Create enabled. If myTagProvider doesn’t already exist, it’s created.
The following write payload will create [myTagProvider]/myTag1 as an integer and [myTagProvider]/myFolder/mySubFolder/myTag2 as a string.
{
"myTag1": 23,
"myFolder": {
"mySubFolder": {
"myTag2": "hello world"
}
}
}
The following payload creates a UDT definition named “injection” with temp and cycleCount attributes. It also creates folder hierarchy for line1/area1 as well as two UDT instances named machine1 and machine2.
{
"line1": {
"area1": {
"machine1": {"_model": "injection", "temp": 100, "cycleCount": 1},
"machine1": {"_model": "injection", "temp": 75, "cycleCount": 20}
}
}
}
The following payload created a single “injection” UDT definition, and a UDT instance named “injection1”.
{"_model": "injection", "temp": 100, "cycleCount": 1}