Skip to main content

Configure up the Ignition Module

availability
Platform:WebMobile
Plan Type:BasicEssentialPremiumEnterprise
User Type:RequesterFull UserAdministrator

This article explains how to configure the MaintainX Ignition Module and troubleshoot your configuration.

Create Your Connector Instance and Token​

To configure the MaintainX Ignition Module, you need an access token. The token authenticates the MaintainX Ignition Module with the MaintainX platform.

danger

It's important to keep your token secure. Do not share it with unauthorized users.

  1. Log into MaintainX as an Administrator.

  2. From the sidebar, select Settings, and under ORGANIZATION SETTINGS, select Integrations.

  3. On the Integrations page, go to the Connectors tab.

  4. Navigate to the Ignition Module tile, and select Connect. An Ignition Module dialog appears.

  5. Select + Create New Instance.

  6. Select Auto Create Meters to automatically create meters in MaintainX for new tags that the connector discovers.

  7. Follow the steps to create a new instance until the Token appears.

  8. Copy the Token and save it for later use.

info

The Token is only displayed once when you create the Ignition Module connector. If you lose the token for an Ignition Module instance, you can revoke it and create a new one. See Revoke and Regenerate an Ignition Module Access Token.

Enter Your Token to the MaintainX Ignition Module​

  1. Go to the MaintainX Module Settings page in the Ignition Gateway:

    • Navigate to Config > Overview.
    • In the Connections section, select Configure the MaintainX Module.

  2. Enable the Module and paste the token on the MaintainX Module Settings page:

    • Set the Integration Status to Enabled.

    • In the API Token field, paste the Connector Token you generated earlier.

Locate Your Ignition Tag Paths​

  1. In the Ignition Gateway:

    • Navigate to Status > Tags.

  2. To browse to the tags you want to monitor:

    • Select Browse on a specific folder to see other folders and tags underneath it.

    • Select Details on a specific tag.

    • After you find the tag you want to monitor and navigate to its details page:

      • Copy the Path value only (e.g., default/Boiler1) to monitor all the tags in the folder.
      • Copy the Path value with the tag name appended (e.g., default/Boiler1/Temperature) to monitor the specific tag.

Enter Your Ignition Tag Paths in the MaintainX Module​

  1. Go to the MaintainX Module Settings page in the Ignition Gateway:

    • Navigate to Config > Overview.
    • In the Connections section, select Configure the MaintainX Module.

  2. Enter the tag paths you want to monitor in the Tag Paths field:

    • Add the tag paths:
      • For a specific tag example: default/Boiler1/Temperature
      • To monitor all tags in a folder, for example: default/Boiler1

  3. Select Save Changes.

Update the MaintainX Module​

note

Updating the module will not affect your existing configuration. It will only update the module to the latest version.

  1. Open the Ignition Gateway web UI.

  2. Go to Config > Modules.

  3. Select Install or Upgrade a Module.

  4. Upload the .modl file you downloaded.

  5. Select Install.

Revoke and Regenerate an Ignition Module Access Token​

The access token for an Ignition Module connector is only displayed once, when you first create it. If you lose the token, you can revoke it and generate a new one.

To revoke and regenerate a token:

  1. Log into MaintainX as an Administrator.

  2. From the sidebar, select Settings, and under ORGANIZATION SETTINGS, select Integrations.

  3. On the Integrations page, go to the Connectors tab.

  4. Navigate to the Ignition Module connector, and select Manage.

  5. In the Ignition Module dialog, go to the Instances list and select the instance whose token you want to revoke.

  6. In the Manage Instance dialog, select Revoke Token.

    The instance's Status changes to Disconnected, and in the Token field shows Revoked.

  7. Refer to the section on generating a new token and applying the token.

What Happens Next​

Once configured, the MaintainX Ignition Module:

  • Automatically sync your Ignition Tags with MaintainX Sensors.
  • Subscribes to the tags you specified.
  • Sends tag value changes to MaintainX as Sensor readings.
  • You can view and manage these under your connector instance in MaintainX under Settings > Integrations > Connectors > Ignition Module.

Auto Create Meters​

Instead of manually creating meters, you can enable an option to automatically create them when a new Ignition tag is discovered via a connector. The meter name will reflect the path of the tag in Ignition.

To use auto create meters:

  1. Log into MaintainX as an Administrator.

  2. From the sidebar, select Settings, and under ORGANIZATION SETTINGS, select Integrations.

  3. On the Integrations page, go to the Connectors tab.

  4. Navigate to the Ignition module tile, and select Connect.

  5. Toggle Auto Create Meters on.

  6. Follow the steps to create a new Ignition instance and token.

When a new tag is discovered, meters will be created automatically, using data reported by the tag.

MaintainX Module Statuses​

StatusDescription
DisabledThe module is currently disabled.
InitializingThe module is initializing its connection with MaintainX.
SyncingThe module is syncing tags to monitor with MaintainX.
Sync ErrorAn error occurred while syncing tags.
RunningThe module is enabled and sending tag values to MaintainX.
StandbyThe module is in standby mode in a redundant environment, awaiting failover activation.
Shutting DownThe module is shutting down.
Invalid API TokenThe module has been provided an invalid API token.
Fatal ErrorThe module is in a fatal error state.

Troubleshooting​

Not seeing data in MaintainX​

  • Verify that the module is running on your Ignition Gateway:

    • Go to the Status page and check the System section. Check if the MaintainX status is set to running.

  • Confirm your tag paths are valid and exist in Ignition.

  • Double-check that the token is correct and has not expired.

  • Check the Logs of the MaintainX Module in the Status > Logs page in Ignition for any errors.

The MaintainX Ignition Module is in a Sync Error State​

If the MaintainX Module is in a Sync Error state, some of the provided tags are invalid or not found in Ignition. All valid tags will still be monitored, but the invalid ones will not be added to MaintainX.

You can check the logs in the Ignition Gateway to see which tags are invalid. The logs will contain an error message with the tag path that caused the error.

The MaintainX Ignition Module is in a Fatal Error State​

If the MaintainX Module is in a Fatal Error state, it means that the module encountered an unrecoverable error and cannot continue running. You can restart the module to try to recover from the error. To do this, go to the Config > Modules page in the Ignition Gateway and select Restart for the MaintainX Module.

If the error persists, you can contact our support team at support@getmaintainx.com. Make sure to download your logs and share them with us to help us investigate the issue.

Still Stuck?​

Contact MaintainX Support. Make sure to download your logs and share them with us to help us investigate the issue.