Set Up the Ignition Integration

availability

Feature availability by platform, plan type, and user type

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

Setting up the Ignition integration requires downloading and installing the MaintainX® Ignition Module (referred to as the Ignition module), creating a connector and access token, and connecting it to your MaintainX organization. From there, you can update the module, manage access tokens, and troubleshoot your connection as needed.

After the module is connected, you can configure which tags to monitor. For more information, 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 in to 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. On the Ignition Module tile, select Connect (or Manage if you've already set up an integration). The Ignition Module dialog appears.
5. Select your version of Ignition, and then select Download to get the .modl file.

Install the Ignition Module in Ignition Gateway

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

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

Create a Connector Instance and Access Token

To connect the Ignition module to MaintainX, you need an access token. The token authenticates the Ignition module with the MaintainX platform. For security purposes, every connector instance must have its own token.

danger

Keep your token secure. Don't share it with unauthorized users.

1. Log in to 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. On the Ignition Module tile, select Connect (or Manage if you've already set up an integration). The Ignition Module dialog appears.
5. Select + Create New Instance.
6. In the Instance name field, enter a descriptive name (for example, Plant 1 Fan A).
7. Follow the steps to create a new connector instance until the Token appears.
8. Copy the Token and save it for later use.
9. Select Connect to finish provisioning the connector instance with the token you saved.
10. When the confirmation message appears, select Done to close the dialog.

note

The token is only displayed once when you create the connector instance. If you lose the token for a connector instance, you can revoke it and create a new one. For more information, see Revoke an Access Token.

After you create the connector instance, it appears in the Instances list with the status Waiting for Connection. It changes to Connected once the Ignition module connects to MaintainX.

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 Settings page in the Ignition Gateway:

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

2. Select + New Connector.

3. Name the connector according to your naming conventions.

4. In the API Token field, paste the token you generated when you created your connector token.

5. Select Save Changes.

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. For more information, 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 Config, then select Modules.
3. Select Install or Upgrade a Module.
4. Upload the .modl file you downloaded. For more information, see Download the Ignition Module.
5. Select Install.

Manage Access Tokens

Each connector instance authenticates with MaintainX using an access token, which is displayed only once, when you first create the connector instance. If you lose the token or need to replace it, you can revoke it and generate a new one.

Revoke an Access Token

Revoke an access token if it's been lost, exposed to anyone outside your trusted network, or if you're rotating credentials as part of a security review.

warning

Running the connector with an invalid or revoked token stops data flow until you generate a new token and update your configuration.

To revoke a token:

1. Log in to 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. On the Ignition Module tile, select Manage.

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

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

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

Regenerate an Access Token

Once you revoke a token, generate its replacement from the same Manage Instance dialog.

To regenerate a token:

1. Select Generate New Token.
2. Copy the new token from the Token field.
3. In the Ignition Gateway, paste the new token into the connector's API Token field.

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 Config, 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, go to Config, then select Overview, and in the Connections section, select Configure the MaintainX Module.

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.

Limitations

• The Ignition module only supports non-complex tag types.
  • For more information, see Supported Data Types.
• The module can connect to a maximum of 100 connectors.
• Each connector can subscribe to a maximum of 300 tag paths.
• Each connector can handle up to 6,000 tags.
• The module supports a maximum of 20,000 tags total across all connectors (subject to the per-connector limit above). For more information about connector and tag limits, see Rate Limiting.