Configure Ignition Tags
| Platform: | AvailableWebNot availableMobile |
|---|---|
| Plan Type: | Not availableBasicNot availableEssentialAvailablePremiumAvailableEnterprise |
| User Type: | Not availableRequesterNot availableFull UserAvailableAdministrator |
Tags you add to the MaintainX® Ignition Module (referred to as the Ignition module) define which Ignition tag data the module monitors and how it sends that data to MaintainX. Tag limits and smart filtering keep data volume within platform limits.
Prerequisites​
- MaintainX connector instance and access token: Created in MaintainX when you set up the integration. For more information, see Set Up the Ignition Integration.
- Ignition connector: A connector for your connector instance added in the Ignition Gateway.
Identify Your Ignition Tag Paths​
Before MaintainX can monitor your Ignition tags, you need to provide their paths:
- Copy the Path value only (e.g.,
[default]Boiler1) to monitor all tags in the folder. - Copy the Path value with the tag name appended (e.g.,
[default]Boiler1/Temperature) to monitor a specific tag.
Supported Data Types​
The Ignition module supports the following data types:
IntegerFloatStringTextDatetimeBoolean
MaintainX also streams member tags of the types listed above from User Defined Type (UDT) instances. For more information, see Add Tags to the Ignition Module.
If you provide a folder path as input, invalid tags are ignored.
Add Tags to the Ignition Module​
Tag paths tell MaintainX which Ignition tags to monitor. Each connector supports up to 300 distinct tag paths and a total of 6,000 tags. For more information, see Limitations.
If your Ignition tag tree uses User Defined Types (UDTs), MaintainX flattens UDT member paths into tag names by joining the UDT instance name and member with a slash (/). For nested UDTs (UDTs that include other UDTs as members), the separator stacks at each level. For example:
- A member tag inside a UDT instance:
PumpA/Temperature - A member tag inside a nested UDT:
CompressorSkid01/MainMotor/RPM(CompressorSkid01andMainMotorare UDT instances, andRPMis the tag)
When you enter a tag path for a UDT instance, MaintainX subscribes to all of the member tags beneath it. You can also enter the path to a single member tag inside a UDT instance to subscribe to just that tag.
You can enter your tag paths using the tag browser (recommended). The tag browser lets you navigate your live Ignition tag tree and select folders, UDT instances, or individual tags using checkboxes. You can also enter tag paths manually by typing them directly.
To enter your tag paths:
- Use the tag browser (recommended)
- Enter paths manually
-
In the Ignition Gateway, select Home > Configuration (under MaintainX).
-
On the connector you set up earlier, select the Actions icon to open the Connector Configuration panel.
-
In the Tag Paths section, select Open Tag Browser. The Select Subscription side panel opens.
-
From the Select a provider dropdown, choose the tag provider you want to browse (for example,
default). -
The tag tree displays your folders, UDT instances, and tags. Select the expand arrow (›) next to any folder or UDT instance to view its contents.
-
Use the checkboxes to select what you want to subscribe to:
- Check (folder) to subscribe to all atomic tags beneath it.
- Check (UDT instance) to subscribe to all of its member tags (including members of any nested UDT instances).
- Check (individual tag) inside a UDT instance or folder to subscribe to only that tag.
As you make selections, the panel at the bottom of the side panel updates to show the number of tag paths selected and lists the resolved tag path for each selection.
-
When you're done, choose Select. The tag paths are added to the Tag Paths list in the Connector Configuration panel.
-
Select Save.
If you already know your tag paths, you can type them directly.
- In the Ignition Gateway, select Home > Configuration (under MaintainX).
- On the connector you set up earlier, select the Actions icon to open the Connector Configuration panel.
- In the Tag Paths section, select + Add Path Manually. A new Enter Tag Path field appears.
- Type the tag path you want to monitor. For example:
- A specific tag:
[default]Boiler1/Temperature - All tags in a folder:
[default]Boiler1 - All member tags in a UDT instance:
[default]EnterpriseData/UDTSim/Pump1
- A specific tag:
- To add more paths, select + Add Path Manually again and repeat.
- Select Save.
If you add tags to a folder that's already monitored, they're automatically discovered and added to MaintainX. Folders are automatically rescanned every hour to ensure new tags are picked up.
To force a rescan, go to the MaintainX Module Configuration page in the Ignition Gateway, locate and edit the connector you want to rescan, and select Save.
Map Tags to Meters​
At this point, MaintainX has tag data flowing in, but each tag still needs to be mapped to a meter before it can update readings, trigger work orders, or power automations. Smart tag mapping uses AI to suggest a meter, unit, and asset for each tag, so you don't have to configure every mapping manually.
For more information, see Map Tags to Meters.
Verify Data Is Flowing​
After you map your tags to meters, confirm that readings are reaching MaintainX.
- From the sidebar, select Meters.
- From the list, find a meter that's mapped to one of your Ignition tags.
- Select the meter to open it.
- In the Readings section, select See All Readings to confirm new readings are arriving.
Allow a few minutes after the Ignition module starts syncing for the first readings to arrive. After that, readings arrive as tag values update in the Ignition Gateway. If no readings appear, see Not Seeing Data in MaintainX.