Set up and Connect the Ignition Module

availability

Feature availability by platform, plan type, and user type

Platform:	AvailableWebNot availableMobile
Plan Type:	Not availableBasicNot availableEssentialAvailablePremiumAvailableEnterprise
User Type:	Not availableRequesterNot availableFull UserAvailableAdministrator

This article explains how to set up the MaintainX® Ignition Module (referred to as the Ignition module): download and install it, create a connector and access token, and connect it to your MaintainX organization. It also covers how to update the module, manage access tokens, and troubleshoot your connection.

After the module is connected, configure which tags it monitors. See Configure Ignition Tags.

Download the Ignition Module

To set up the Ignition module, you need to download the .modl file. .modl files are used to install third party modules in Ignition.

1. Log into MaintainX as an Administrator.
2. From the sidebar, select Settings. 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 Download to get the latest version of the .modl file.

Install the Ignition Module in Ignition Gateway

Installing the Ignition module loads it on your Ignition Gateway, allowing it to synchronize data with MaintainX.

1. Open the Ignition Gateway web UI.
2. Go to Platform, then select Modules.
3. Scroll down and select Install or Upgrade Module.
4. Upload the .modl file you downloaded.
5. Read and accept the license agreement.
6. Select Install Module.

Create Your Connector Instance and Token

To connect the Ignition module to MaintainX, you need an access token. The token authenticates the Ignition module with the MaintainX platform.

danger

Keep your token secure. Do not share it with unauthorized users.

1. Log into MaintainX as an Administrator.

2. From the sidebar, select Settings. 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. Follow the steps to create a new instance until the Token appears.

7. Copy the Token and keep it somewhere secure for later use. This is the only time MaintainX displays it.

8. Select Connect to finish provisioning the Ignition module connector with the token you saved.

9. When the confirmation message appears, select Done to close the dialog.

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.

Add a Connector in the Ignition Gateway

To send tag data to MaintainX, you need to add a connector in the Ignition Gateway. The connector uses the access token you created to authenticate and route data to the correct MaintainX organization.

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

   • Select Home, then select Configuration (under MaintainX).

2. Select + New Connector and complete the required fields:

   • In the Connector Name field, name the connector according to your naming conventions.
   • Set the Connector Status to Enabled.
   • In the API Token field, paste the Token you generated when you created your connector token.

3. Select Save.

info

Each gateway supports up to 100 connectors, and each connector supports up to 6,000 tags. For the full list of limits, see Limitations.

After you add a connector, configure which tags it monitors. See Configure Ignition Tags.

Update the Ignition Module

We recommend updating the Ignition module once a quarter to receive security patches and compatibility improvements. Updates can be installed at any time and don't affect your existing configuration or interrupt data flow to MaintainX.

1. Open the Ignition Gateway web UI.
2. Go to Platform, then select Modules.
3. Select Install or Upgrade Module.
4. Upload the .modl file you downloaded. For more information, see Download the Ignition Module.
5. Select Install.

Manage Access Tokens

Regenerate the connector's access token whenever:

• You can't retrieve the original token (it's only shown once) or the token has been exposed to anyone who isn't a trusted administrator.
• An administrator with access to the token leaves your organization or you rotate credentials as part of a security review.
• The MaintainX UI or module logs show Invalid API Token, which indicates that the token was revoked.
• While troubleshooting connectivity issues, MaintainX Support instructs you to reissue the token.

warning

Running the connector with an invalid or revoked token stops data flow until you generate a new token and paste it into the Ignition module.

Revoke 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 a token:

1. Log into MaintainX as an Administrator.

2. From the sidebar, select Settings. 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 the Token field shows Revoked.

Ignition Module Statuses

The Ignition module's status shows whether it's healthy and exchanging data with MaintainX. To view it, open the Ignition Gateway, go to Platform, then select Modules.

Status	Description
Disabled	The module is currently disabled.
Initializing	The module is initializing its connection with MaintainX.
Migrating	The module is performing a database migration.
Syncing	The module is syncing tags to monitor with MaintainX.
Sync Error	An error occurred while syncing tags.
Running	The module is enabled and ready to send tag values to MaintainX.
Shutting Down	The module is shutting down.
Fatal Error	The module is in a fatal error state.

MaintainX Connector Statuses

A connector's status shows whether it's healthy and exchanging data with MaintainX. To view it, open the Ignition Gateway, select Home, then select Configuration (under MaintainX).

Status	Description
Disabled	This connector is currently disabled.
Running	The connector is enabled and sending tag values to MaintainX.
Invalid API Token	The connector has an invalid API token.
Syncing	The Ignition module is syncing tags to monitor with MaintainX.
Sync Error	An error occurred while syncing tags.

MaintainX Redundancy Statuses

In a redundant Gateway setup, the Ignition module's redundancy status shows whether it's actively streaming tag data to MaintainX or holding in standby to take over if the Master Gateway fails. For more information, see Use Ignition Gateway Redundancy.

Status	Description
Active	The module is active and sending data to MaintainX.
Standby	The module is waiting for failover and not sending data to MaintainX.

Troubleshooting

If the Ignition module isn't behaving as expected, use the steps below to identify and resolve common issues.

Not Seeing Data in MaintainX

• In the Ignition Gateway, go to Status, then select System to verify that the module status is Running.
• Confirm the connector status is Running on the Ignition module.
• Confirm your tag paths are valid and exist in Ignition.
• Double-check that the access token is correct and hasn't been revoked.
• In the Ignition Gateway, go to Status, then select Logs to check for any Ignition module errors.

The Ignition Module Is in a Sync Error State

The Ignition module shows Sync Error when one or more connectors have a tag synchronization issue. To resolve the error, identify the affected connector and follow the instructions in The Connector in the Module is in a Sync Error State.

The Connector in the Module Is in a Sync Error State

A connector displays Sync Error when one or more configured tag paths are invalid or not found in Ignition. Valid tags will continue to be monitored, but invalid ones aren't added to MaintainX.

To identify the invalid tags, check the Ignition Gateway logs: go to Status, then select Logs. Each invalid tag path will be logged with an error message.

The Ignition Module Is in a Fatal Error State

If the Ignition module is in a Fatal Error state, it means that the module encountered an unrecoverable error and can't continue running. You can restart the module to try to recover from the error.

To restart the module:

1. In the Ignition Gateway, go to Platform, then select Modules.
2. Locate the MaintainX Module and select Restart.

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.

The Connector is Unable to Reach the MaintainX Service

If the connector can't reach the MaintainX service, it usually means your Ignition Gateway can't reach MaintainX. Common causes include:

• A firewall rule blocking outbound traffic.
• The Gateway not using the proxy server configured in your organization.

For the required network settings, see Secure Outbound Communication.

To test whether your Ignition Gateway can reach MaintainX:

1. Open the Ignition Designer for your Gateway.

2. From the top menu, select Tools, then select Script Console.

3. Paste the following script and run it:

   from java.lang import Exception as JavaException
   
   url = "https://agent.maintainx.com/"
   
   try:
       client = system.net.httpClient()
       response = client.get(url)
       status = response.getStatusCode()
   
       if status >= 200 and status < 500:
           print "MaintainX is reachable."
       else:
           print "MaintainX is unreachable."
   
   except JavaException as e:
       print "MaintainX is unreachable."
       print str(e)

4. If the output shows MaintainX is unreachable, your Gateway can't connect to MaintainX. Review the network settings with your IT administrator.

Still Stuck?

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