MOR-PLN-079 Version 1 (WIP) Last Review Date: May, 2025
MEX-CMMS - MoreCore Integration
1. Overview
This document provided detail on the MEX-CMMS integration. This integration provides a two way data transfer between Endeavour's (CBC client) MEX intance and CBC's CMMS instance. Boomi is utilised as integration logic middleware.
1.1. Integration ID
The ID for this integration is MEX-CMMS.
1.2 Teams Group
Some discussion regarding the integration, as well as working files, can be found here: https://teams.microsoft.com/l/team/19%3APw_XcBeTQzbdiZKjCUrCV-Cy2TSX_X-LSzL7fFYYcWA1%40thread.tacv2/conversations?groupId=ee1d78ca-25bd-432a-8d39-7baf7f3dda47&tenantId=72fc6d1b-c12d-484b-b104-eeb0b0980273 (opens in a new tab)
Teams group admin: Bryce Marshall
1.3 Key Stakeholders
1.3.1. CBC
| Name | Role | |
|---|---|---|
| Andrew Horton | a.horton@cbcgroup.com.au | Primary CBC Contact / Endeavour Contract Manager |
| Josh Ryan | j.ryan@cbcgroup.com.au | Operations Manager |
| Kristen Magagnino | k.magagnino@cbcgroup.com.au | Managing Director |
| Georgia Rolls | g.rolls@cbcgroup.com.au | Contract Admin / User |
| CBC Helpdesk | helpdesk@cbcgroup.com.au | User group |
1.3.2. Endeavour
| Name | Role | |
|---|---|---|
| Peter Robinson | p.robinson@endeavour.com.au | Client liason |
1.3.3. MoreCore Team
| Name | Role | |
|---|---|---|
| Bryce Marshall | b.marshall@cbcgroup.com.au | Lead |
| Sam Tapping | s.tapping@cbcgroup.com.au | Lead Tester |
| Shane Rose | s.rose@cbcgroup.com.au | |
| MEX-CMMS | cmms_mex_integration@cbcgroup.com.au | CMMS account and email contact point for errors |
1.4. Operations Documentation
A user guide for this integration is here: MEX-CMMS Integration User Guide
2. Scope
High-level Scope is here: https://cbconlinecomau.sharepoint.com/:x:/r/sites/MEXCMMAIntegration/Shared%20Documents/General/MEX-CMMS%20Integration%20-%20High-level%20Scope.xlsx?d=w4976d11b8464423cba77874d165128dc&csf=1&web=1&e=2qYfKs (opens in a new tab)
3. Architecture
3.1 Platforms
The the key applications and platforms involved in this integration are:
3.1.1. MoreCore (CMMS)
CBC's CMMS platform.
Implementation Notes
- Integration settings have been configured at the Tenant level, and are linked to the 'cmms_mex_integration@cbcgroup.com.au' user.
- The user is assigned to the Endeavour contracts, and has the Contract Manager role, allowing it to perform the necessary API actions only on the required contracts.
Environment Variables
Environment variables are established in Boomi.
Authentication
UI Access to the CMMS UI is via API API access is managed in the Azure APIm settings. See the APIm article for more details.
3.1.2. Boomi
Boomi is a middleware solution that provides a graphical interface to build integration logic. It sits between the primary platforms and coordinates secure data transfer.
The Boomi graphical UI is managed and hosted by Boomi itself. Through this UI, the created processes are compiled and then punblished to a 'Boomi Atom'. Atom's are hosted on a Virtual Machine that MoreCore manages. There are two instances of Boomi Atom and two VM's, one for the dev environment and one for production.
The Boomi platform is a shared enviroment for all integrations we build.
Details on the Boomi environment can be found on MOR-PLN-095.
3.1.3. MEX
MEX is an asset and maintenance management software package, operated by CBC's client Endeavour.
Environment Variables
Authentication
- User accounts are managed by Endeavour.
3.1.4 Azure Virtual Machine
The two VMs host the Boomi Atoms and are effectively the host of the integration logic. The VMs are hosted within the CBC Azure Tenancy. Entries exist in the CBC DNA service to provide the VM's with a CBC subdomain. The VM's NSG and internal firewall have been modified to allow HTTPS traffic on port 9093.
| Field | Production | Development |
|---|---|---|
| Azure Resource | ||
| URL | https://boomiciprod.cbcgroup.com.au (opens in a new tab) | https://boomici.cbcgroup.com.au (opens in a new tab) |
| Public IP | 52.255.60.29 | 4.198.72.252 |
| HTTPS Port | 9093 | 9093 |
Authentication
Access to the VM's
3.2 Major Components
3.2.1 Processes
| ID | Component Name | Description | Boomi Listener |
|---|---|---|---|
| PR-03 | MEX-CMMS.PR-03.[MEX] Work Order > [CMMS] Work Order/Request | MEX Work Order changes are detected and changes propagated to CMMS. | NA |
| PR-05 | MEX-CMMS.PR-05.(Webhook) [CMMS] Work Order Live | Event CMMS Work Order Live is triggered and changes propagaged to MEX. | /ws/simple/updateMEX-CMMS-WorkOrderLive |
| PR-06 | MEX-CMMS.PR-06.(Webhook) [CMMS] Work Order Updated | Event CMMS Work Order Updated is triggered and changes propagaged to MEX. | /ws/simple/updateMEX-CMMS-WorkOrderUpdated |
| PR-13 | MEX-CMMS.PR-13.(Webhook) [CMMS] Work Order Document Approved | Event CMMS Work Order Document Approved is triggered and the document propagated to MEX. | /ws/simple/updateMEX-CMMS-WorkOrderDocumentApproved |
| PR-15 | MEX-CMMS.PR-15.(Webhook) [CMMS] Quote Submitted | Event CMMS Quote Submitted is triggered and changed propagated to MEX. | /ws/simple/updateMEX-CMMS-QuoteSubmitted |
| PR-19 | MEX-CMMS.PR-19.(Webhook) [CMMS] Quote Document Approved | Event CMMS Quote Document Approved is triggered and the document propagated to MEX. | /ws/simple/updateMEX-CMMS-QuoteDocumentApproved |
| PR-21 | MEX-CMMS.PR-21.(Webhook) [CMMS] Debtor Invoice Submitted | Event CMMS Debtor Invoice Submitted is triggered and changed propagated to MEX. | /ws/simple/updateMEX-CMMS-DebtorInvoiceSubmitted |
NOTE: Initial planning included the need for additional processes, however these ultimately proved unneccesary. This is the reason that the processes do not have sequential numbers. Some of the abandoned processes were commenced in Boomi, however these are not deployed nor should they be, unless scope changes or further works occur.
COMMON Process Flow Documentation
MEX-CMMS Process Flow Documentation
3.2.2. Cross Reference Tables
| ID | Component Name | Description | Status |
|---|---|---|---|
| XR-01 | MEX-CMMS.XR-01.[CMMS] Work Status <> [MEX] Status | Matches CMMS WO Work Status with MEX Status | Active |
| XR-02 | MEX-CMMS.XR-02.[CMMS] Site > [MEX] Asset | Matches CMMS WO Site with MEX Asset | Not In Use |
| XR-03 | MEX-CMMS.XR-03.[CMMS] Priority <> [MEX] Priority | Matches CMMS WO Priority with MEX Priority | Active |
| XR-04 | MEX-CMMS.XR-04.[CMMS] Contract <> [MEX] Contractor | Matches CMMS Contract with a MEX Contractor | Active |
| XR-06 | MEX-CMMS.XR-06.[CMMS] Contract/Site > [CMMS] Asset | Matches a CMMS Contract and Site combo with a CMMS Asset | Active |
| XR-08 | MEX-CMMS.XR-08.[CMMS] Work Order Type <> [MEX] Job Type | Matches CMMS Work Order Type with MEX Job Type | Active |
| XR-09 | MEX-CMMS.XR-09.[MEX] Asset > [CMMS] Site | Matches a MEX Asset to a CMMS Site | Active |
3.3. Components
All components, including Dynamic Document Properties and Dynamic Process Properties are documented according to their designation as common or integration-specific.