High- Level Specification

Functional Overview

The purpose of this document is to define the functional and configuration requirements to integrate SAP S/4HANA Private Cloud Edition (2025) with SAP Asset Performance Management (APM) on SAP BTP for SyWay Project.
SAP APM provides advanced reliability engineering tools (RCM, FMEA, Maintenance Strategy Optimization). For these tools to function, a seamless synchronization of Master Data (Technical Objects) and Transactional Data (Maintenance Orders/Notifications) is required between the S/4HANA core and the APM cloud tenants.

Scope and Objectives

The scope includes the end-to-end connectivity and data synchronization framework:

• Master Data Sync: Synchronization of Equipment, Functional Locations, and Classes/Characteristics.
• Transactional Data Sync: Integration of Maintenance Orders and Notifications for reliability analysis.
• Embedded IoT: Enabling the flow of sensor data/indicator values that are entered manually into Measuring Points in forms of Measurement Documents from S/4HANA to APM. Time Series Data ingestion for Sensors that are created as Local Indicators will be part of a different integration process documented in the following Functional Specification ERP-1446.
• UI Integration: Configuring the "Performance" tab in S/4HANA Asset Master via the APM side-panel.

Process Flow Diagram

Insert the flowchart and fill in the steps

Assumptions

• Each SAP APM tenant connects to one SAP ERP logical system.
• Communication Systems and Arrangements are handled in the APM Configuration Workbook, not this FS.

Dependencies

• The SAP Cloud Connector is already installed and paired with the BTP Subaccount.
• A destination is needs to be created in the BTP pointing to S/4HANA. Details can be found in the following link.
• Integration with Cloud Integration Automation Service (CIAS): Instead of manually setting up and onboarding SAP APM, it's also possible to subscribe to a free service Cloud Integration Automation Service in BTP, which helps to simplify the onboarding process through a guided approach.

Security, Integrity and Controls

• S/4HANA Service User: A technical user (System type) with authorizations for the SAP_COM_0573 scenario (which basically includes all the EAM-relevant roles/profiles). It should also have the authorization objects documented in the following link.
• BTP Roles: Reliability Engineers require APM_Reliability_Engineer and APM_Template_Admin roles in the BTP Subaccount.

Configuration Requirements

Asset Data Synchronization

• Technical Objects: The system must support the replication of Equipment and Functional Locations.
• Classes and Characteristics: APM requires the technical attributes to perform health assessments. Standard S/4HANA Classification (Class Type 002/003) must be synchronized.

 Maintenance Work Integration

• History: Last 2 years of Maintenance Order and Notification history should be initially synchronized for Reliability Centered Maintenance (RCM) analysis.
• Delta Sync: Any new Notification (IW21) or Order (IW31) created in S/4HANA should be updated in APM in near real-time.

Special Requirements

To enable the value help for selecting alerts and notifications in the Condition tab of the Manage Rules app, another destination for rules needs to be configured in the tenant.

Prerequisites

You have:

• Created the service instances and service keys for SAP Asset Performance Management. For more information, refer to Create Service Instances.

• Generated the service instance. For more information, refer to Creating Service Instances in Cloud Foundry.

• Generated the service keys. For more information, refer to Creating Service Keys in Cloud Foundry.

Context

You create a destination named RULES_EIOT_DESIGNTIME in the subscribing subaccount by providing the connection details to SAP Asset Performance Management Rules Service.

Procedure

1. Create a new destination of type HTTP.
2. Enter the name of the destination as RULES_EIOT_DESIGNTIME.
3. Enter the URL of the Rules API and replace the landscape in the URL.

   URL: https://rules-eiot-designtime-live.cfapps.{landscape}.hana.ondemand.com

   Replace {landscape} with your data center such as eu10, eu20, us10, or us20.

4. Enter the following details:
   1. Select Internet from the Proxy Type drop-down.
   2. Select OAuth2ClientCredentials from the Authentication drop-down.
   3. Enter Client ID/Client Secret. The service key that needs to be generated from the SAP Asset Performance Management service instance.
   4. Choose Dedicated Token Service URL type. Enter the Token Service URL.

      URL: {"url" from APM service key credentials}/oauth/token

5. Click Save to save the destination.

Design Rationale

This template section may be used to specify the custom API design. The requirement can be for an API provider which means the API will be designed in the system or can be for an API consumer which means that an API will be consumed in the system.

API Use

Following key components must be activated for the integration;

Interface Alert & Monitoring

This interface can be monitored from SAP APM using the app "Integration Monitor", for checking both Master Data & Configuration Data Synchronizations.

User Interface Requirements

• The APM Assessment UI must be embedded within the S/4HANA Fiori "Manage Technical Objects" app.
• Users should be able to trigger an RCM or FMEA assessment directly from the S/4HANA Equipment screen.

Sequencing

Please describe delivery requirements driven by message sequencing, i.e. specific order, impact of disruption of sequence, are duplicates allowed, etc.

Volumetrics

Provide volumetrics details: Initial load volumes, Number of Records, Expected Frequency, Expected Long term Growth)

Performance Consideration

• Deletion: If an Equipment is marked for deletion in S/4HANA, its status in APM should update to "Inactive."
• Conflict Resolution: S/4HANA remains the "System of Record" for Master Data. Changes made in APM do not overwrite S/4HANA Master Data fields directly (except via specific Recommendation workflows).

Error Handling

Detail how errors will be handled: Notification, Restart/ Recovery and Re-Processing Procedures

Testing

How to Test

Please provide some guidance and/or test data to help the developer unit test the interface. Please include both positive and negative testing (to validate error situations handling)

The developer will need to test repeatedly, so where appropriate provide instructions to reverse the actions performed so the test may be run again, or explain how to create new input data to the test. In particular, the developer will need logons for test users representing the various roles within the approval process.

Test Conditions and Expected Results

Test Considerations/Dependencies

List any considerations essential for application test planning (e.g., test this before ABC along with DEF separate from GHI). If the development encompasses a user interface, explain how to test it. List any insights as to how this component could be tested the most efficiently.

Other Information

Development Details

Package

Other Development Objects

Appendix

See also

Insert links and references to other documents which are relevant when trying to understand this decision and its implications. Other decisions are often impacted, so it's good to list them here with links. Attachments are also possible but dangerous as they are static documents and not updated by their authors.

Change log