Objective
This document explains key concepts in integrating the Augury Machine Health platform with a customer’s CMMS/EAM system.
This is accomplished using the Augury API.
Follow this guide to learn how to use Augury’s Machine Health insights in order to automatically generate Work Orders and other maintenance actions in your CMMS/EAM system.
Who should use this document?
Users scoping and deploying integrations between Augury and a CMMS/EAM platform. This includes:
Augury platform users
Customer IT/OT teams
System integrators
Overview
Linking Augury to your CMMS system can enhance your Machine Health program by automating the creation of Work Orders.
This will reduce response time for maintenance actions, eliminate double data entry, and increase maintenance engagement in the Augury platform.
The Augury API supports bi-directional communication with CMMS platforms.
An overview of the typical data flow is described below.
In the Augury platform, machine data is analyzed by the Augury AI and confirmed by an Augury Vibration Analyst. If a machine fault is detected, the machine status is elevated to Monitor, Alarm, or Danger. This indicates that the maintenance team needs to take action to fix the fault condition.
When the Machine Health status is elevated, a webhook is triggered, and the API sends information about the fault diagnoses to a specified URL.
Using the API for the CMMS, a Work Request or Work Order is created, including the data about the fault.
The maintenance team performs the necessary work and closes out the work order or enters additional comments.
Work order status (Completed, In Progress, etc.) and comments are returned to Augury and recorded for review by Augury vibration Analysts.
When the Work Order is completed, the Vibration Analyst will review the live machine data to confirm that the maintenance action fixed the fault condition.
If the machine data supports the completed work order, the Vibration Analyst will return the health status to Acceptable.
Architecture
There are many options for Integration as a Service (iPaaS) platforms or other middleware that can host an integration between Augury and CMMS systems.
To integrate your CMMS with Augury, choose a solution that supports the following:
Communicates with REST APIs
Connects to your CMMS systems APIs or other connectivity type
Is capable of transforming data between both applications
Can listen for a webhook event from the Augury API
Performs error handling
If you do not have a preferred iPaaS offering, consult an Augury Sales Engineer to discuss recommendations or options for Augury-hosted integrations.
Using the API
This section will focus on the typical endpoints used for a CMMS integration to create Work Orders automatically.
Client credentials and a sandbox for development can be provided by an Augury Sa.
Instructions for authentication and a full list of the available endpoints are included in the Augury API documentation found here.
Machine Health Webhook
Webhooks are event-based communications between two applications.
The Machine Health webhook sends information about a Machine Health status change to an external system.
The triggering event is a change in the Machine Health status of any machine (e.g. Acceptable >> Alarm, Acceptable >> Danger).
This webhook is the mechanism that is used to trigger the creation of a work order in the CMMS.
See the API documentation section on Webhooks here.
Below is an example of the payload that gets sent when a Machine Health status changes and the webhook is triggered.
In the webhook payload, pay attention to the following:
ID
It is important to record the Augury machine ID in the CMMS Work Order.
When comments and status updates are made to the work order, the machine ID will be used to replicate the updates to the correct machine in Augury.
assetId
The assetId field represents the ID of the asset in the CMMS system.
Before the integration, work with an Augury Sales Engineer to upload the CMMS asset IDs into Augury for each machine. When the webhook triggers, this field will tell the CMMS which asset to create a Work Order for.
locationId
The locationId field is the detailed location from the CMMS. This is sometimes called Functional Location or may go by another term.
Locations can be exported from a CMMS and uploaded into Augury, and therefore, they can be used to look up assets as part of the work order creation process.
If locations are used, consult an Augury Sales Engineer about adding locationId data to your assets in Augury.
Level - The Machine Health status level is in Augury.
In the CMMS, this level will be used to determine the priority for the work order.
Logic should be created to map Augury levels to CMMS priorities.
See the example below.
Augury Machine Health Status | Corresponding CMMS Priority |
Acceptable | No WO created; machine is healthy |
Monitor | 4 - Low or No WO created; machine is healthy |
Alarm | 2 - High |
Danger | 1 - Urgent |
CMMS priority levels and maintenance practices vary.
Use the Machine Health level definitions below to choose a mapping that is appropriate for your maintenance team.
Components
The components array contains information about which machine component and bearing has the fault, along with detailed information about the fault and recommended maintenance.
These fields are typically included in the Work Order's description field.
Creating a Work Order (WO)
When the WO is created in the CMMS, a new WO should also be created in Augury that includes information from the CMMS WO.
This informs the Vibration Analyst the work has been planned.
Use Create a new work order to create the Augury work order.
Once created, it will appear in the Augury platform as a scheduled Repair, with a tag to show that it is linked to the CMMS.
Below is an example of how the WO will appear.
The data that is included in the WO will appear in the repair’s extended information.
Note the scheduled Start and End times, which should be included to let Augury vibration analysts know when the work is planned to be completed.
Updating a Work Order
Status and data updates
If updates are made to the WO in the CMMS, replicate these updates to the WO in Augury.
These may be updates to status, scheduled time, duration, cost, or any other available field.
To update, use the Update an existing work order endpoint.
Include the externalId of the WO in the request (this is the ID of the WO defined by the CMMS).
Adding Comments
Comments entered in the CMMS system can also be added to work orders in Augury. Comments provide a way for the maintenance team to provide observations or questions to the Augury vibration analyst.
Use the Create a new work order comment endpoint. Comments are visible in the WO extended information shown below.
Completing a Work Order
The maintenance team will complete the work order and update its status in the CMMS.
The completed status should be automatically updated in Augury when it is completed in the CMMS.
Update the status of the work order in Augury using the Update an existing work order endpoint.
Once the WO is marked complete, it will show as “Being Reviewed” in Augury.
The Augury vibration analyst will review the repair against available vibration data.
If the issue is resolved, then they will mark it as “Successful” and leave a comment as shown below.
Augury status vs. CMMS status
CMMS platforms may have many different statuses.
For our purposes in the Augury platform, we only track if the WO is open, closed, or canceled.
When the WO is completed in the CMMS, update the Augury WO to “closed”.
The CMMS status can also be tracked in Augury using the externalStatus field. Users looking at vibration data in the Augury platform can easily see open work orders and the current status from the CMMS.
When a WO is completed, you may also update the Augury WO with the actual duration of the maintenance, repair cost, and other data from the CMMS.
This extra data can help the Augury team understand the impact on your maintenance and reliability operations.
A note on CMMS workflows and APIs
Notifications vs. Work Orders
This guide refers to creating work orders in a CMMS system. In some platforms, there may be intermediate steps before creating work orders.
For example, in SAP Plant Maintenance, alerts from Augury are first entered as Notifications.
A customer maintenance planner or scheduler then reviews the notification and creates a Work Order.
Your platform may have its own workflow. From the Augury standpoint, the Machine Health status change webhook can trigger whatever action is needed (WO, Notification, Work Request, etc.) . It is recommended to consult with your maintenance team or CMMS vendor and adhere to best practices for this workflow.
Webhooks vs. Polling
Some CMMS systems will include a webhook that can update the integration middleware when a work order is updated or the status has changed. If this is the case, your integration layer can listen for the updates and subsequently post those updates to Augury.
If there is no webhook capability, you may need to periodically request WO status from the CMMS to check if any updates have been made.
Read Next - Testing Integrations Using Sandbox
Download a PDF of this article by clicking on the attachment below.