Home
Foundation Setup for iMaintenance Deployment
Before iMaintenance can connect to SAP and expose APIs, the core environment must be initialized. This setup includes seeding MongoDB with configuration data, enabling SAP inbound services, mapping dependencies, and starting the microservices that power the application.
Configure Application Microservices
iMaintenance relies on multiple micro-services to handle authentication, integration, asset data, forms, reports, and AI-driven tasks. These services must be deployed and running for the application to function end-to-end.

Title and Copyright
Copyright and Terms of Use page for iMaintenance Installation.
Preface
Understand audience, know related documents and products and conventions followed in this document.
Introduction
The iMaintenance Deployment & Setup Guide gets iMaintenance running safely in your enterprise landscape.
Foundation Setup for iMaintenance Deployment
Before iMaintenance can connect to SAP and expose APIs, the core environment must be initialized. This setup includes seeding MongoDB with configuration data, enabling SAP inbound services, mapping dependencies, and starting the microservices that power the application.
- Verify Prerequisites
  Before initializing the environment, ensure the following prerequisites are in place. Missing even one will cause deployment failures later.
- Clear Existing MongoDB Collections (Optional)
  When switching SAP environments or reinitializing the system, you may need to clear existing MongoDB collections. This provides a clean start for reseeding and prevents conflicts with outdated data.
- Seed MongoDB with Core Data
  MongoDB must be initialized with seed data so that iMaintenance has its baseline configuration — roles, forms, dashboards, preferences, and integration templates. Without this step, the application will launch with missing or incomplete data.
- Insert SAP Data into MongoDB
  This step ingests master and transactional data from SAP into MongoDB. It enables iMaintenance to work with real SAP objects instead of placeholders. By the end, inbound services will be active, and collections updated with the correct status.
- Map Dependent Fields
  Some fields, such as Plant, require mapping in MongoDB to ensure correct alignment between SAP data and iMaintenance. This step uses the seed mapping script to establish those dependencies.This topic explains how to map dependent fields, such as Plant, in MongoDB by running the seed mapping script located at RACE/backend/SapInbound/src/integration-v2/startSeed.js. It also outlines final steps, including stopping the SAP Inbound container and updating the Integrations collection in MongoDB Atlas when switching SAP environments.
- Configure Application Microservices
  iMaintenance relies on multiple micro-services to handle authentication, integration, asset data, forms, reports, and AI-driven tasks. These services must be deployed and running for the application to function end-to-end.
- Set Up Cron Jobs
  Scheduled jobs automate recurring tasks in iMaintenance, such as syncing incremental updates and refreshing asset dashboards. These must be configured to ensure the system stays current without manual intervention.
Configure SAP iMaintenance Roles and Authorizations
Before iMaintenance can integrate with SAP, specific roles and authorizations must be configured. These roles control access to master data, transactional posting, and integration endpoints.
Secure API Access with IP Whitelisting
Secure connectivity for Innovapptive-hosted applications is enforced by restricting inbound traffic to trusted client IPs and permitting outbound traffic only to approved Innovapptive domains. This ensures that only authorized systems can exchange data with iMaintenance while preventing unauthorized access.
Install Supporting Systems and iCWP Integration Suite
Enable SAP NetWeaver Gateway and configure virus scan handling so iCWP OData services can run securely.
SAP BTP and On-Premise Integration via Cloud Connector
Set up secure connectivity between SAP BTP and your on-premise SAP systems with the SAP Cloud Connector. This enables iCWP OData services to be consumed on BTP without exposing inbound firewall ports.
Configure API Management in SAP BTP
Create an API Proxy in SAP BTP to expose iCWP OData services from your connected SAP system. The proxy uses the API Provider details from Cloud Connector and makes the service available for policy enforcement and external consumption.
Configure OAuth 2.0 Authentication
Enable OAuth 2.0 authentication in SAP API Management so external consumers can securely obtain and use access tokens when calling iCWP APIs.
Handle CSRF Tokens in API Management
Enable server-to-server authentication between SAP API Management and the backend system, so API consumers don’t need direct backend credentials.
Troubleshoot API Errors and Metadata Issues

Configure Application Microservices

iMaintenance relies on multiple micro-services to handle authentication, integration, asset data, forms, reports, and AI-driven tasks. These services must be deployed and running for the application to function end-to-end.

Key Micro-services and Their Purpose


Micro-service	Purpose
ai-chatbot-service	Digital Work Instruction
ai-localisation-service	Language Translation
asset360-service	Asset 360’s Dashboard & Data Prep
alert-api-service	Alerts & Push Notifications
auth-api-service	Authentication
authored-form-api-service	Field Configuration Forms
erp-master-data-api-service	General Dropdowns
erp-outbound-consumer-service	Post Transaction Data to SAP
erp-outbound-producer-service	Listen for Transaction Events
integration-manager-api-service	(Details not specified)
master-configuration-api-service	Plant/Asset/Functional Location Master Data
mobile-app-preference-api-service	Global/Transactional Preferences
my-forms-api-service	Form Templates
operator-rounds-api-service	Observations, Issues, Actions
report-api-service	Dashboard Reports
sap-inbound-api-service	Initial SAP Data Ingestion
settings-api-service	General Settings
storage-api-service	Attachment Handling
user-service-api-service	Users, Roles, Permissions, Groups
workorder-api-service	MCC (Work Order Management)
platform-dev → auth-service	oAuth (Google/Microsoft) Authentication
AI Issue Detection Service	Autonomous Issue Detection
AI WorkOrder	Autonomous Work Order Creation

Deployment Notes

Each microservice is typically packaged as a Node.js service (often containerized).
They should be started and monitored individually or through your orchestration platform.
Validate that each service is running before proceeding to cron jobs and higher-level configurations.