Set Up the ERBESSD INSTRUMENTS® Integration
| Platform: | AvailableWebNot availableMobile |
|---|---|
| Plan Type: | Not availableBasicNot availableEssentialNot availablePremiumAvailableEnterprise |
| User Type: | Not availableRequesterNot availableFull UserAvailableAdministrator |
The ERBESSD INSTRUMENTS integration is a fully managed integration. Contact your MaintainX® representative to get started with the onsite installation of the PHANTOM® sensors and gateway.
Setting up the integration in MaintainX requires creating a connector instance and generating the token that your PHANTOM Gateway uses to authenticate. You then add the token to the gateway, as described in Configure the PHANTOM Gateway.
Create a Connector Instance and Access Token​
To connect your PHANTOM Gateway to MaintainX, you need an access token. The token authenticates the PHANTOM Gateway with the MaintainX platform. For security purposes, every connector instance must have its own token.
Keep your token secure. Don't share it with unauthorized users.
- Log in to MaintainX as an Administrator.
- From the sidebar, select Settings. Under Organization Settings, select Integrations.
- On the Integrations page, go to the Connectors tab.
- On the ERBESSD INSTRUMENTS tile, select Connect (or Manage if you've already set up an integration). The ERBESSD INSTRUMENTS dialog appears.
- Select + Create New Instance.
- In the Instance name field, enter a descriptive name (for example,
Plant 1 Lathe A). - Follow the steps to create a new connector instance until the Token appears.
- Copy the Token and save it for later use. You add it to the gateway, as described in Configure the PHANTOM Gateway.
- Select Connect to finish provisioning the connector instance with the token you saved.
- When the confirmation message appears, select Done to close the dialog.
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 gateway successfully sends its first reading.
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.
Running the PHANTOM Gateway with an invalid or revoked token stops data flow until you generate a new token and update your configuration.
To revoke a token:
-
Log in to MaintainX as an Administrator.
-
From the sidebar, select Settings. Under Organization Settings, select Integrations.
-
On the Integrations page, go to the Connectors tab.
-
On the ERBESSD INSTRUMENTS tile, select Manage.
-
In the ERBESSD INSTRUMENTS dialog, go to the Instances list and select the connector instance whose token you want to revoke.
-
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:
- Select Generate New Token.
- Copy the new token from the Token field.
- On the PHANTOM Gateway, replace the old token in the Auth token field with the new one. For more information, see Point the Gateway at MaintainX.