Provider-Specific CMMS Integration Guides
Provider-specific CMMS and EAM guides should be created after the project confirms the source system, access method, required fields, and customer-approved operating model. Use this page as the planning framework for provider-specific guides.
Provider Guide Structure
Each provider-specific guide should follow the same structure:
Prerequisites
| Requirement | Why it matters |
|---|---|
| Confirmed provider | The guide should name a real provider and version or customer integration profile |
| Customer access model | REST, database view, export, middleware, or file drop changes the implementation path |
| Field dictionary | Required fields, optional fields, enums, and custom fields need customer confirmation |
| Ownership model | Read-only, handoff, synchronization, and write-back modes need separate rules |
| Test records | Real open, blocked, completed, canceled, and reopened records are needed for validation |
| Security approval | Provider credentials and network paths need customer approval |
Source Data Inputs
| Input | Use |
|---|---|
| Provider API or export schema | Defines fields and data types |
| Work-order sample set | Validates lifecycle, priority, and closeout mapping |
| Asset and location sample set | Validates MDM alignment |
| Attachment sample set | Validates ECM import and access behavior |
| Status transition examples | Confirms provider workflow meaning |
| Permission matrix | Confirms read, draft, write-back, and attachment access |
| Error examples | Supports troubleshooting and retry behavior |
Candidate Provider Guides
| Guide | When to write it |
|---|---|
| IBM Maximo Integration | Customer uses Maximo work orders, assets, failure codes, and service records |
| SAP Plant Maintenance Integration | Customer uses SAP PM orders, functional locations, equipment, notifications, and closeout data |
| Infor EAM Integration | Customer uses Infor EAM work orders, assets, status values, and maintenance records |
| Custom REST CMMS Integration | Customer or provider exposes a project-specific REST API |
| Contractor Work-Order System Integration | Service providers maintain their own dispatch or ticketing system |
| Scheduled Export Integration | Customer provides CSV, SFTP, database view, or data-lake extracts |
Provider Guide Procedure
For each provider, write:
- Scope and supported integration mode.
- Required source access.
- Required work-order fields.
- Asset and location mapping.
- Status, priority, SLA, and closeout mapping.
- Attachment handling.
- Authentication and service-account requirements.
- Import and synchronization cadence.
- Write-back or handoff behavior when approved.
- Validation checklist and sample test cases.
- Troubleshooting table.
Expected Output
A provider-specific guide should produce:
- provider scope and supported operating mode;
- field mapping table;
- status and priority mapping table;
- asset identity mapping plan;
- attachment and ECM plan;
- permission and service-account plan;
- test cases and acceptance criteria.
Validation Checklist
- The guide is based on a confirmed customer or provider schema.
- Required fields are validated with real sample records.
- Custom fields and enum values are documented.
- Provider ownership rules are clear.
- Write-back behavior has explicit customer approval.
- Troubleshooting examples match observed provider responses.
Troubleshooting
| Symptom | Check |
|---|---|
| Provider guide does not match customer system | Provider version, custom fields, middleware layer, and export schema |
| Required field is absent | Customer field dictionary, optional source module, and alternate mapping rule |
| Status meaning differs by service line | Service category, site-specific workflow, and provider configuration |
| Write-back behavior is unclear | Ownership model, provider permission, and customer approval record |