Working with Technical Aspects

Objectives

After completing this lesson, you will be able to:
  • Explore and explain available APIs
  • Explore and explain available CDS views
  • Explore and explain available migration objects
  • Explore configuring maintenance assistant

APIs For Maintenance Management

APIs: Maintenance Management

An application programming interface (API) is an interface that lets software systems communicate with each other and exchange data. By offering an API for your system, you can define which data should be exposed and thereby maintain control. As the consumer of an API, you don’t have to know how the other system works. Instead, you can focus on how it's integrated into your system. You can use the APIs available for SAP S/4HANA Cloud for these scenarios:

  • Connect business processes across your system landscape
  • Integrate with external systems
  • Develop your own dependent extensions or custom applications

Inbound and Outbound Services

APIs can either be inbound or outbound services.

With respect to SAP S/4HANA Cloud as the source system, inbound means that SAP S/4HANA Cloud provides a service that another system can consume.

Outbound means that SAP S/4HANA Cloud consumes a service that is provided by another system.

Synchronous and Asynchronous Services

APIs can either be synchronous or asynchronous services.

Synchronous means that when a system sends a request it waits for the receiving system to send a response. This approach is useful if an immediate and real-time response is required. However, both systems need to be online the entire time and if there’s an error, the request has to be sent again.

Asynchronous means that when a system sends a request it waits for the receiving system to acknowledge receipt of the message. However, it doesn’t wait for the receiving system to send a response. This way you can loosely couple systems and there’s less dependency on the availability of the other system. Additionally, the sender system isn’t blocked after sending a request and can send further requests. With this approach, you get no immediate response and a response message needs to be implemented and routed separately.

The following table contains all APIs available in Maintenance Management.

APIs In Maintenance Management

NameTypeCommunication Scenario
EquipmentODATAAsset Management Master Data Integration (SAP_COM_0395)
Functional LocationODATAAsset Management Master Data Integration (SAP_COM_0395)
Measuring PointODATAAsset Management Master Data Integration (SAP_COM_0395)
Measurement DocumentODATAPlant Maintenance Execution Integration (SAP_COM_0398)
Maintenance NotificationODATAMaintenance Processing Integration (SAP_COM_0397)
Maintenance Order Operation ConfirmationODATAPlant Maintenance Execution Integration (SAP_COM_0398)
Maintenance Task ListODATAAsset Management Master Data Integration (SAP_COM_0395)
Maintenance PlanODATAMaintenance Planning Integration (SAP_COM_0396)
Maintenance ItemODATAMaintenance Planning Integration (SAP_COM_0396)
Catalog Type Coding - ReadODATAMaintenance Processing Integration (SAP_COM_0397)
Catalog Type Overview of Damage - ReadODATAMaintenance Processing Integration (SAP_COM_0397)
Catalog Type Object Parts- ReadODATAMaintenance Processing Integration (SAP_COM_0397)

For more details on the APIs refer to the link Equipment | SAP Help Portal

CDS Views for Asset Management

Overview of CDS views for maintenance management.

Several CDS views have been released for BW data extraction. The CDS views are modeled for usage as a DataSource in SAP Business Warehouse (SAP BW). We strongly recommend that you use them only for this purpose.

The following CDS (Core Data Services) views are available for Asset Management in SAP S/4HANA Cloud, public edition:

CDS View NameCDS ViewPurpose
EquipmentI_EquipmentUse this CDS view to get information about a piece of equipment.
Equipment DataI_EquipmentDataUse this CDS view to get the details of an equipment.
Text for EquipmentI_EquipmentTextUse this CDS view to get the short description of a piece of equipment.
Functional LocationI_FunctionalLocationUse this CDS view to get information about a functional location.
Functional Location DataI_FunctionalLocationDataUse this CDS view to get the details of a functional location.
Text for Functional LocationI_FunctionalLocationTextUse this CDS view to get the short description of a functional location.
Text for Functional Location CategoryI_FlocCategoryTextUse this CDS view to get the description of the functional location category in all languages.
Text for Technical Object TypeI_TechnicalObjectTypeTextUse this CDS view to get information what technical object types are available in the system (in all languages).
Text for ABC IndicatorI_ABCIndicatorTextUse this CDS view to get the description of the ABC indicator used for Plant Maintenance (in all languages).
Location Analysis CubeI_LocationAnalysisCubeUse this CDS view to get location information of the header notification and the related technical objects.
Maintenance Activity TypeI_MaintenanceActivityTypeUse this CDS view to get the information which maintenance activity types exist in the system and can be set.
Text for Maintenance Activity TypeI_MaintenanceActivityTypeTextUse this CDS view to get the description of the maintenance activity type in all languages.
Maintenance Item DataI_MaintenanceItemDataUse this CDS view to get information about maintenance items.
Maintenance Notification Activity DataI_MaintNotificationActyDataUse this CDS view to get information about maintenance notification activities. You can get information about related technical objects as well as damage data, location data and account assignment details.
Maintenance Notification Cause DataI_MaintNotificationCauseDataUse this CDS view to get the details of the maintenance notification causes. You can get information about related technical objects as well as damage data, location data and account assignment details.
Maintenance Notification Item DataI_MaintNotificationItemDataUse this CDS view to get the details of the maintenance notification items. You can get information about related technical objects as well as damage data, location data and account assignment details.
Maintenance Notification Task DataI_MaintNotificationTaskDataUse this CDS view to get the details of the maintenance notification tasks. You can get information about related technical objects as well as damage data, location data and account assignment details.
Maintenance Order Cube with Technical ObjectI_MaintOrderTechObjCubeUse this CDS view to get information about a maintenance order. You can get order data, such as the related technical objects, the assigned header notification, location details, scheduling details or account assignment data.
Maintenance Order Operation DataI_MaintOrderOperationDataUse this CDS view to get information about a maintenance order operation. You can get planning details as well as purchasing and accounting details of the order operation and view the completion confirmation number of the maintenance order operation, for example.
Maintenance Order Actual Cost DataI_MaintOrderActualCostDataCubeUse this CDS view to get information about the actual costs, such as the fiscal year or the type of cost that was incurred.
Maintenance Task List DataI_MaintenanceTaskListDataUse this CDS view to get details of a maintenance task list, such as location data or account assignment data.
Maintenance Task List Operation DataI_MaintTaskListOpDataUse this CDS view to get information about a task list operation, such as purchasing and delivery details or duration and capacity details.
Maintenance Package DataI_MaintenancePackageDataUse this CDS view to get information about a maintenance package, such as scheduling details or the maintenance strategy to which the maintenance package belongs.
Text for Maintenance PackageI_MaintPackageTextDataUse this CDS view to get the description of the maintenance package as well as the description of the maintenance package hierarchy and cycle in all languages.
Allocation of Maintenance Packages to Task List Operations DataI_PckgTaskListOpalLocDataUse this CDS view to get details of the maintenance task list and the maintenance package that is allocated to the task list.
Maintenance Planner GroupI_MaintenancePlannerGroupUse this CDS view to get information about the maintenance planner group that is assigned to a maintenance order. You can also view the contact details.
Maintenance Strategy DataI_MaintenanceStrategyDataUse this CDS view to get information about a maintenance strategy, such as the scheduling details or the total cycle duration.
Text for Maintenance StrategyI_MaintStrategyTextDataUse this CDS view to get the description of the maintenance strategy in all languages.
Measuring Point DataI_MeasuringPointDataUse this CDS view to get information about a measuring point, such as the measuring point category or if a measuring point is a counter. You can also get information about the technical object for which the measuring point was created.
Measurement Document DataI_MeasurementDocumentDataUse this CDS view to get information about a measurement document, such as the time and the values of a measurement reading or detailed counter information.
Priority DataI_GenericPriorityDataUse this CDS view to get priority data, such as the priority type or the color code.
Text for Priority DataI_GenericPriorityTextDataUse this CDS view to get the description of a priority in all languages.

You can find more details about the CDS views for Asset Management https://help.sap.com/viewer/0f69f8fb28ac4bf48d2b57b9637e81fa/latest/en-US/bea52cb1d9784702a17ecc9f1137cba1.html.

Object Migration

When implementing your SAP S/4HANA Cloud, public edition solution, you can migrate your master data and business data from SAP systems and non-SAP systems to SAP S/4HANA Cloud, public edition. To do this, you use SAP S/4HANA migration cockpit.

SAP S/4HANA migration cockpit is a tool that facilitates the transfer of business data from a source system to an S/4HANA system. Source systems can be SAP systems or non-SAP systems. The migration cockpit uses predefined migration objects to identify and transfer the relevant data. It allows you to download predefined Microsoft Excel templates, which the customer can use to enter data and upload it to SAP S/4HANA. Standardized Business Application Programming Interfaces (BAPIs) are used to import the data.

You can access SAP S/4HANA migration cockpit by choosing Migrate Your Data – Migration Cockpit tile.

Note

The following business roles is required to access the migration cockpit:

Configuration Expert - Data Migration (SAP_BR_CONFIG_EXPERT_DATA_MIG)

The corresponding role for each migration object is also required.

You can use this app to:

  • Select the migration objects that are relevant for your migration project (the app uses migration objects to identify and transfer the relevant data).

  • Generate staging tables for your migration objects and populate these staging tables with data by using template files. You can also populate the staging tables by using your preferred tools (for example SAP Data Services).

  • Simulate the migration before migrating your data to SAP S/4HANA Cloud, public edition, and monitor the status of the simulation process.

  • Migrate your data to SAP S/4HANA Cloud, public edition and monitor the status of the migration.

Migration Objects Available for Asset Management

List asset management migration objects.

SAP provides predefined migration objects that you can use to transfer your data. A migration object describes how to migrate data for a specific business object to SAP S/4HANA Cloud, public edition. It contains information about the relevant source and target structures, as well as the relationships between these structures. A migration object also contains mapping information for the relevant fields and any rules used to convert values that are migrated from source fields to target fields. SAP provides predefined migration objects that you can use to transfer your data.

Migration ObjectBusiness Object TypePredecessor Migration Objects
PM - EquipmentMaster data

Material BOM

PM - Equipment BOMMaster data

PM - Equipment

Product

PM - Equipment task listMaster data

PM - Equipment

PM - Functional locationMaster data 
PM - Functional location BOMMaster data

PM - Functional location

Product

PM - Functional location task listMaster data

PM - Functional location

PM - General maintenance task listMaster data 
PM - Maintenance planMaster data

PM - Equipment

PM - Equipment task list

PM - Functional location

PM - Functional location task list

General Maintenance task list

Work center/Resource

PM - Measurement documentMaster data

Measuring Point

PM - Measuring pointMaster data

Characteristic

PM - Equipment

PM - Functional location

PM - Maintenance notificationTransactional data 

You need the Maintenance Planner (SAP_BR_MAINTENANCE_PLANNER) role to migrate Asset Management business objects.

For more information refer to: https://help.sap.com/viewer/cc9ecc5f5f6b400a98d10e930324f7ad/latest/en-US/20607b6de19a4d34a41b0abec6186b01.html

Configuring SAP Maintenance Assistant

Prerequisite: Entitle Sub-accounts to SAP Maintenance Assistant Application

Procedure

  • Log into the SAP Business Technology Platform (SAP BTP) Global account.
  • Navigate to Entity Assignments and select the sub-account to which you want to deploy the app.
  • Click on the Configure Entitlements button next to the selected Sub-account. Click on Add Service Plans when the option appears.
  • Click Save

Installing the SAP Maintenance Assistant Client

When you first install and start the SAP Maintenance Assistant application, a demo version is loaded, complete with demo data. Use the demo version to acclimate yourself to the app before connecting to the SAP Business Technology Platform.

Download the SAP Maintenance Assistant application to your mobile device from the App Store (iOS) or SAP Software Download Center (Android). A demo version is initially loaded. When you are ready to begin working with the true application, exit the demo, log in, and begin working.

ProcedureIn the App Store Search box, type SAP Maintenance Assistant and tap Search. The application description opens.

  • Tap Free and then Tap Install
  • The SAP Maintenance Assistant client application is downloaded from the store. After the download, an SAP Maintenance Assistant application icon appears on the mobile device.
  • Tap the icon to open the application.

Result

The SAP Maintenance Assistant client is installed on your mobile device.

Log in to track your progress & complete quizzes