Skip to main content

Set Up the AVEVA CONNECTâ„¢ Integration

availability
Feature availability by platform, plan type, and user type
Platform:AvailableWebNot availableMobile
Plan Type:Not availableBasicNot availableEssentialNot availablePremiumAvailableEnterprise
User Type:Not availableRequesterNot availableFull UserAvailableAdministrator

Setting up the AVEVA CONNECT integration requires creating an OAuth client in your AVEVA CONNECT tenant, then using its credentials to create a connector instance in MaintainX®. From there, you can edit streams, manage your connector instances, and troubleshoot your connection as needed.

Before you begin, review the requirements for your AVEVA CONNECT tenant and your MaintainX account. For more information on how the integration connects, see AVEVA CONNECT Integration Architecture.

Create an OAuth Client in AVEVA CONNECT​

MaintainX authenticates to your AVEVA CONNECT tenant using an OAuth client with client credentials. Create one in your AVEVA CONNECT tenant.

danger

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

  1. Log in to the AVEVA CONNECT portal.
  2. Go to Data Services.
  3. Go to Security > Clients, and select + Add Client.
  4. Enter a name for the client.
  5. Choose a token lifetime. We recommend a token that doesn't expire.
  6. Keep the default role, and select Next.
  7. Select Save.
  8. Copy the Client ID and Client Secret and save them somewhere secure.
note

AVEVA CONNECT displays the client secret only once, when you create the client. If you lose it, create a new client in AVEVA CONNECT and a new connector instance in MaintainX. For more information, see Edit a Connector Instance.

Create a Connector Instance in MaintainX​

Using the OAuth client credentials you created, create a connector instance in MaintainX and connect it to your AVEVA CONNECT namespace.

tip

Your Tenant ID, Namespace ID, and Region are visible from the Developer Tools > API Console section of the AVEVA CONNECT portal, or in the URL of your Data Services endpoint.

  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 AVEVA CONNECT tile, select Connect (or Manage if you've already set up an integration). The AVEVA CONNECT page appears.
  5. Select New Instance.
  6. Under General Settings, in the Instance Name field, enter a descriptive name (for example, Plant 1 Fan A).
  7. Select the Region that matches where your AVEVA CONNECT tenant is hosted.
  8. Under Account & Environment Scoping, enter your Tenant ID.
  9. Enter your Namespace ID.
  10. Under Authentication & Credentials, enter your Client ID and Client Secret. You created both credentials in Create an OAuth Client in AVEVA CONNECT.
  11. Select Validate to confirm your credentials with AVEVA CONNECT. If validation fails, double-check each value against your AVEVA CONNECT tenant and try again.
  12. In the Choose data streams section, select the streams and properties you want to bring into MaintainX. For more information, see Add Streams to the Connector Instance.
  13. Select Subscribe data streams.

After you create the connector instance, it appears under Active Instances, and MaintainX begins polling your selected streams. For more information, see Data Freshness.

After the connector instance is created, map your tags to meters. For more information, see Map Tags to Meters.

Manage Connector Instances​

Each connector instance appears on the AVEVA CONNECT page. From there, you can edit, pause, archive, and delete it.

Edit a Connector Instance​

You can rename a connector instance and add or remove its streams at any time.

note

You can't change the client ID or client secret of an existing connector instance. To use new credentials, create a new connector instance and archive the old one. To avoid replacing credentials later, choose a token lifetime that doesn't expire when you create the OAuth client.

To edit a connector instance:

  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 AVEVA CONNECT tile, select Manage.
  5. Under Active Instances, select Edit for the connector instance.
  6. Change the instance name or streams, and then select Save.

Pause and Resume a Connector Instance​

Pause a connector instance to stop polling without deleting it. MaintainX doesn't backfill readings recorded in AVEVA CONNECT while the connector instance is paused. For more information, see Data Freshness.

To pause a connector instance:

  1. On the AVEVA CONNECT page, go to Active Instances.
  2. For the connector instance, select Pause.

To start polling again, select Resume.

Archive and Delete a Connector Instance​

Archive a connector instance you no longer use. Archived connector instances move to Archived Instances, where you can unarchive or delete them.

To archive a connector instance:

  1. On the AVEVA CONNECT page, go to Active Instances.
  2. Open the connector instance's actions menu, and select Archive.
  3. In the confirmation dialog, confirm that you want to archive it.

To unarchive or delete a connector instance:

  1. On the AVEVA CONNECT page, go to Archived Instances.
  2. For the connector instance, select Unarchive or Delete.
  3. If you selected Delete, confirm in the dialog.

Limitations​

  • Each connector instance connects to one AVEVA CONNECT namespace. For more information, see Namespace.
  • Each connector instance supports up to 1,000 selected properties. For more information, see Add Streams to the Connector Instance.
  • You can't change the client ID or client secret of an existing connector instance. For more information, see Edit a Connector Instance.
  • MaintainX polls selected streams approximately every 2 minutes and doesn't backfill historical data or gaps. For more information, see Data Freshness.
  • MaintainX reads from AVEVA CONNECT and doesn't write back to it. For more information, see Read-Only Access.
  • MaintainX ingests new readings only. Updates and deletions to existing readings in AVEVA CONNECT aren't reflected in MaintainX.
  • The integration only supports the value data types listed in Supported Data Types.