MaintainX Integration Setup

Introduction

Create a streamlined connection between Front Line Workers and your Maintenance Team by automatically creating work orders and updating meters in MaintainX through MachineMetrics Workflows. If you'd like to learn more about this integration's capabilities, take a look here or watch the video below!

Topics covered in this article: 

• Integration Features
• Initial Configuration
• Map Assets: MachineMetrics and MaintainX
• Create Work Requests/Orders in MaintainX
• Update your MaintainX Meters

Note: This integration requires the Premium tier of MaintainX for workorders and the Enterprise tier for metering.

Integration Features

• Create MaintainX Work Requests from MachineMetrics alarms, downtimes, or manually triggered workflows.

• Automatically update MaintainX meters using MachineMetrics in-cycle time and number of cycles data.

Initial Configuration

To start setting up your MaintainX integration, navigate to the Integration Portal. Once there, select the MaintainX integration and click Authorize.

Before the integration can function, it needs three pieces of credentials to give it access.

1. First is a MachineMetrics API Key. Navigate to the API Keys page, and click the Create API Key button at the bottom right.

2. Check the reporting scope checkbox. Copy the API key and paste it into the Enter MachineMetrics API Key field.

3. Next, you'll need a MaintainX JWT. Navigate to the Integrations page in MaintainX and click the New Key button at the top right of the page.

4. Name your key, then click Generate Key. Copy the JWT and paste it into the Enter MaintainX JWT field.

5. Create your own secret (i.e. A password). Make sure to record it, as you'll need to add this to the workflows you create to trigger the integration.

Map Assets: MachineMetrics and MaintainX

This integration relies on a custom MaintainX field to determine which asset in MachineMetrics matches its equivalent in MaintainX. This way, a machine in MachineMetrics could be called "CNC Mill 1" while the same machine is called "CNC 1" in MaintainX and still send the data to the right place between the two systems.

If you're currently in contact with MaintainX, you could request they add the "MMid" asset custom field for you. Otherwise, we built this integration to create it for you!

1. Create a workflow in MachineMetrics with any trigger (Operator triggers manually or scheduled are easiest),

2. Give the workflow the Webhook action and give it the following settings.

URL: https://maintainx.integrations.johnson.m12s.com/setup

Secret: The secret you created when authorizing the MaintainX integration

3. Trigger the workflow. If you selected Operator triggers manually, open the Operator Dashboard and access the workflow via the menu at the bottom left.

Once it has run, refresh MaintainX and edit one of your assets to see if they now have the MMid field.

Now you're ready to tell the integration which asset is which between the two systems. Navigate to the Machine Settings page in MachineMetrics. Click on a machine to open its settings. Copy the value listed after Import ID and paste it into the MMid of the corresponding asset in MaintainX.

Create Work Requests/Orders in MaintainX

1. Open to your MachineMetrics Workflows page via the Automations drop-down along the top navigation menu.

2. Click the New Workflow button at the top right of the page.

3. Name your workflow and configure the trigger. Currently, the MaintainX integration is compatible with the Downtime categorized as, Alarm occurs, and Operator triggers manually triggers.

4. Select Webhook as the Action.

5. If you’d like the workflow to trigger as soon as the trigger conditions are met, set the Delay to 0.

6. In the Enter URL field, first put your Integration URL followed by “/WorkRequest”. Or, if you'd like to create a work order instead of a request, follow the URL with "/WorkOrder".
   
   Ex. https://maintainx.integrations.johnson.m12s.com/WorkRequest
   
   

7. For the Enter Secret field, press the Create New button to the right, then enter the secret MachineMetrics provided to you during the initial setup of your integration.

8. Press the Save Changes button to finish creating your workflow! Now when this workflow is triggered, a corresponding work request will be created in MaintainX.

Update your MaintainX Meters

1. Open to your MachineMetrics Workflows page via the Automations drop-down along the top navigation menu.

2. Click the New Workflow button at the top right of the page.

3. Name your workflow and configure the trigger. You can use any trigger, but Scheduled is highly recommended.

4. Select Webhook as the Action.

5. If you’d like the workflow to trigger as soon as the trigger conditions are met, set the Delay to 0.

6. In the Enter URL field, first put your Integration URL followed by “/Meter”.
   
   Ex. https://maintainx.integrations.johnson.m12s.com/Meter
   
   

7. For the Enter Secret field, press the Create New button to the right, then enter the secret MachineMetrics provided to you during the initial set up of your integration.

8. Press the Save Changes button to finish creating your workflow! Now when this workflow is triggered, it will update all time-in-cycle and cycle meters for each machine.