Timebase Ignition Module Overview
The Timebase Historian Module for Ignition connects Inductive Automation's Ignition platform to Timebase Historian
Overview
The Timebase Historian Module for Ignition connects Inductive Automation's Ignition platform to Timebase Historian. Once installed, Ignition tags with history enabled automatically write their data to Timebase and read it back — no custom scripting required. From Ignition's perspective, Timebase appears as a native historian provider alongside any other historians you have configured.
The module supports reading, writing, browsing, and tag metadata, with built-in Store and Forward buffering so no data is lost when Timebase is temporarily unreachable.
Requirements
| Requirement | Version / Detail |
|---|---|
| Ignition Platform | 8.3.3 or later |
| Ignition Historian Module | Required — must be installed before this module |
| Timebase Historian | Compatible REST API (see your Timebase version) |
| Timebase Pulse | Required only if OAuth2 authentication is enabled |
The Historian Module (com.inductiveautomation.historian) is a standard Inductive Automation module available from the Ignition Module Marketplace. It must be installed and running before the Timebase module will activate.
What the Module Does
Once configured, the module provides:
- Write — Ignition tags with history enabled write data to Timebase automatically, routed through Ignition's Store and Forward pipeline for reliability.
- Read — Historical data stored in Timebase appears in Ignition's tag history charts, Easy Chart components, and scripting functions.
- Browse — The Timebase tag tree is navigable in Ignition's Tag History Browser. Datasets appear as top-level folders; tag hierarchies are navigable within each dataset.
- Tag metadata — Engineering units, descriptions, format strings, and custom tag properties are sent to Timebase and displayed alongside the data.
- Store and Forward — If Timebase is unreachable, Ignition buffers writes in memory and drains them automatically when connectivity is restored.
How Datasets Are Named
Each Ignition Tag Provider maps to a Timebase dataset. The dataset name is formed by combining the optional Historian Dataset Prefix with the Tag Provider name:
<Historian Dataset Prefix><Tag Provider name>
For example, with a prefix of Gateway-042-:
- The
[default]Tag Provider → datasetGateway-042-default - The
[OtherProvider]Tag Provider → datasetGateway-042-OtherProvider
The prefix allows multiple Ignition Gateways to write to the same Timebase Historian without their datasets colliding. If no prefix is configured, the dataset name is just the Tag Provider name.
Installing the Module
- Obtain the signed
.modlfile from Flow Software. - In the Ignition Gateway web interface, navigate to Config > System > Modules.
- Click Install or Upgrade a Module.
- Upload the
.modlfile. - Restart the Gateway when prompted.
After restarting, the module appears in the modules list as Timebase Historian. You can then create one or more historian provider instances under Config > History > History Providers > Create new History Provider > Timebase Historian.
Note: If the module shows a fault at startup, confirm that the Ignition Historian Module is installed and running. The Timebase module depends on it and will not activate without it.
Troubleshooting
| Symptom | Likely cause | What to do |
|---|---|---|
| Module shows fault immediately after installation | The Ignition Historian Module is not installed | Install com.inductiveautomation.historian from the Ignition Module Marketplace, then restart. |
| Module installs but no "Timebase Historian" option appears when creating a history provider | Module did not load correctly | Check the Gateway Status page for errors. Review the gateway logs for messages from com.flowsoftware.timebase.historian. |
| Tags are enabled for history but data is not appearing in Timebase | History provider not configured, or tags not pointing to the Timebase provider | Verify that tags have History Provider set to your Timebase historian instance, and that the historian instance is running without faults. |
| Gateway fails to restart after module installation | Incompatible Ignition version | Confirm your Ignition version is 8.3.3 or later. Earlier versions are not supported. |