MaintainX CMMS

Overview

MaintainX is a computerized maintenance management system (CMMS) that helps organizations manage assets, work orders, and maintenance schedules. This guide explains how to connect your MaintainX account to the system and manage the connection.

To access the Data Source management page, click on the Settings → Data Source menu in the left navigation panel.

Connect to MaintainX

To connect a new MaintainX data source, follow these steps:

1. In the Data Source list page, find the MaintainX card.

2. Click the Connect button on the card.

3. A configuration dialog will appear. Enter a Connection Name to identify this connection.

4. The MaintainX Base URL is pre-filled with the default value (https://api.getmaintainx.com/v1) and cannot be modified.

5. Enter your API Key from your MaintainX account. You can obtain this from your MaintainX settings.

6. Click the Authorize button to complete the connection. After successful authorization, the connection will appear in your data source list.

Form Fields

The following table describes the fields required to connect to MaintainX:

View Connection Details

After connecting to MaintainX, you can view and manage the connection details. Click on the MaintainX connection in the data source list to enter the detail page.

The detail page contains four tabs:

• Connection Info - View connection status and perform connection operations

• Tools - View available MaintainX API tools

• Schemas - View database tables and field definitions

• Prompts - View and edit tool usage guidelines

Connection Info Tab

The Connection Info tab displays the basic information of your MaintainX connection:

• Connection Name - The name you assigned to this connection

• MaintainX Base URL - The API endpoint URL

• OAuth Status - Shows "Authorized" (green) if the connection is valid, or "Unauthorized" (red) if there is an issue

Test Connection

To verify that your MaintainX connection is working correctly:

1. In the Connection Info tab, click the Test Connection button.

2. The system will attempt to connect to MaintainX using your stored credentials.

3. A notification will appear indicating whether the connection test was successful or failed.

Re-authorize Connection

If your API key has changed or the connection becomes unauthorized, you can re-authorize the connection:

1. In the Connection Info tab, click the Re-authorize button.

2. A dialog will appear with the Connection Name and Base URL displayed (these cannot be changed).

3. Enter your new API Key.

4. Click Authorize to save the new credentials. After successful re-authorization, the OAuth Status will change to "Authorized".

Tools Tab

The Tools tab displays a list of available MaintainX API tools. Each tool represents an API endpoint that can be used to query or manage data in your MaintainX system. The table shows the tool name and its description.

Schemas Tab

The Schemas tab displays the database tables and their field definitions from MaintainX. This information helps you understand the data structure when building queries.

• Click on a table name to expand and view its fields

• Each field shows its name, data type, and description

• Click the table name again to collapse the field list

Prompts Tab

The Prompts tab allows you to view and edit the usage guidelines for each tool. These prompts are displayed in Markdown format and provide instructions on how to use each API tool effectively.

Edit Prompts

To edit a tool's prompt:

1. In the Prompts tab, find the tool you want to edit.

2. Click the Edit button (pencil icon) on the right side of that tool.

3. A dialog will open with a text editor containing the current prompt content in Markdown format.

4. Edit the content as needed. You can use Markdown syntax for formatting.

5. Click Save to apply your changes. The updated prompt will be displayed immediately.

Important Notes

• API Key security: Your API key is stored securely and is never displayed in plain text after initial entry.

• Permissions required: You need the "data_source:edit" permission to create, modify, or delete MaintainX connections.

• Connection status: If your connection shows "Unauthorized" status, use the Re-authorize function to update your API key.

• Trial users: Trial users may have restrictions on connecting new data sources. Contact your administrator for access.