Tell us what you think

We want to create the best possible experience for our learners. Your feedback helps us to improve the experience for everyone.

Executing Custom Integration

Objective

After completing this lesson, you will be able to utilize the Query API to access data stored in the SAP Field Service Management Cloud from external systems effectively.

Field Service Management APIs

Image showing various APIs for SAP Field Service Management

SAP Field Service Management exposes multiple Application Programming Interfaces (APIs) that offer many ways to access the data and functionalities of Field Service Management from external systems. These APIs are used by Field Service Management itself, or can be leveraged to support custom integrations and enhancements.

Provided FSM APIs include the following:

Query API: to query data stored in the SAP Field Service Management Cloud.
Data API: provides full access to the data stored on the SAP Field Service Management Cloud.
Bulk API: an extension of the Data API v4 used to create/update and delete resources in bulk.
Service API: to create, maintain, and process service calls and activities in FSM.
Reporting API: provides reporting capabilities exposed as a set of web services, based on a Jasper Reports engine.
Best Matching Technician API: to automatically find the best matching technician for an activity.
Appointment Booking API: to help find appropriate technicians and appointment times for activities.
Re-Optimization API: to asynchronously reschedule assigned jobs in an autonomous and optimized manner.
Crowd Partner API: to invite subcontractors to join the SAP Field Service Management Crowd platform.
Crowd Technician API: to create and manage the Crowd technicians who accept assignments and complete work as part of the SAP Field Service Management Crowd platform.
Crowd Partner Dispatching API: to make requests from a third-party application to SAP Field Service Management, to manage activities assigned to a crowd partner.
Access API: for enabling applications to obtain limited access to SAP Field Service Management.
User API: to create and manage user records and user access rights for SAP Field Service Management applications.
SCIM API: based on the System for Cross-domain Identity Management (SCIM), which is an open standard for automating the exchange of user data between different user identity domains.

All FSM APIs use the HTTP protocol and apply the Representational State Transfer (REST) paradigm. A basic understanding of these concepts is necessary to use them.

To consume the APIs, it's recommended to use a specialized tool that provides assistance for API testing, like Postman or Insomnia. Alternatively, a command line tool could be used.

All interactions are based on requests sent from the client system which are then processed by the server system (FSM in this case). After processing the request, the server sends a response with the result, for example the content of the resource that was queried.

Requests and responses contain resources that are exchanged between server and client. A resource is a piece of information that represents an entity in the context of the specific API. The client can query the server for a resource, but also send resources in order to create or update them on server side. In both cases, the server will include the processed resources in its response.

The key to properly interacting with the FSM Cloud APIs lies in the composition of valid HTTP requests that can be processed by the specific API. The structure of an HTTP request consists of three distinct parts:

Request line
Header fields
Message body

While the message body is specific to each API, both request line and header fields share a number of common characteristics in most FSM APIs.

Challenge Question

Challenge Yourself: Putting Your Knowledge to the Test

In this lesson, you'll have the opportunity to apply the concepts and knowledge you've gained throughout the unit. We've designed an engaging Challenge Question that will put your critical thinking skills to work. Take a moment to reflect on what you've learned, and then use that understanding to craft your own unique solution to the question at hand.

To make the most of this exercise, we encourage you to write down your answer on a separate piece of paper. This will help you organize your thoughts and measure your learning progress. Once you've completed your answer, compare it to the expert response provided. This will give you valuable insight into how well you've grasped the material and where you might need to focus your attention for further growth.

Remember, this is an opportunity to apply your understanding in a practical way, so don't hesitate to think creatively and explore different approaches. Your active participation in this lesson will reinforce your learning and prepare you for success in the real world.

Scenario:

You are the IT Lead of a manufacturing company leveraging SAP systems for your operations. Recently, your company implemented SAP Field Service Management (FSM) for enhanced service operations management. Your task is to ensure smooth integration between FSM and your existing SAP and non-SAP back-end systems.

Write a plan on addressing the integration of your SAP ECC, SAP S/4HANA (Cloud and On-premise), and SAP CX Service Cloud with FSM using appropriate integration platforms.
Determine which Master and Transactional data objects would be most relevant for your organization to replicate in the integration process.
Describe how you would use the FSM Cloud Connector for integration. What are its components and how do they function?
Explain the flow of transactional data through the FSM Connector and its configuration.
Outline your approach for addressing any errors during the integration process.

Expert Consultant Response

To address the integration of various SAP systems, I would use the Proaxia-provided FSM Cloud Connector for SAP ECC and SAP S/4HANA integrations. For CX Service Cloud, I would use SAP Cloud Integration (formerly CPI).
Relevant Master data objects to integrate might include Business Partners, Products, Product Stock, and Employees. Transactional data could include Service Orders, Service Items, and the corresponding Efforts, Expenses, and Materials related to each service call.
The FSM Cloud Connector would play a vital role in this integration. Its three components, the Business Integrator (an ABAP add-on providing the necessary technical components and process logic), Message Broker (running on a Windows server and providing data handling and conversion between the Business Integrator and the Transporter), and the Transporter (securing data submission between SAP and FSM Cloud using HTTPS), would be configured and managed to ensure smooth data transfer.
The standard flow of transactional data would start with the replication of a service order from SAP to FSM, which includes related activities and components. The scheduled and released activity allows for recording efforts, expenses, and unplanned material consumption on the offline mobile app by the technician. The final confirmation of completed work, time efforts, and goods movement is created after the T&M Journal approval.
Addressing errors during integration would involve monitoring the FSM Connector Errors section in the admin portal. It helps identify issues when sending objects to the configured third-party in the FSM Connector. In the event of an error, the Retry button allows for re-sending the data.

Lesson Recap

In this lesson, we focused on understanding the integration scenarios and procedures between SAP Field Service Management (FSM) and various back-end systems, which is crucial in ensuring seamless communication and efficient data transfer.

Highlights from the unit include the following:

Understanding Different Integration Technologies: We discussed how different integration platforms are used depending on the back-end system. They include FSM Cloud Connector by SAP Partner Proaxia, SAP Integration Suite, and SAP B1 Cloud Connector.
Master and Transactional Data Integration: We explicated the types of data that these integrations cover, such as master data (business partners, products, stock) and transaction data (service orders, items, reserved materials).
FSM Cloud Connector: We discussed the functioning of the FSM cloud connector and its three key parts: the business integrator, the message broker, and the transporter.
Integration with SAP S/4HANA: This covered how FSM integrates with SAP S/4HANA (Cloud and On-premise), and the replication of data between the two systems.
Master Data Integration (MDI): We explained how MDI provides a standardized and consistent representation of master data across a hybrid landscape, based on the SAP One Domain Model.
Coverage of Standard Integrations: We talked about standard integrations available with SAP Commerce Cloud, SAP Analytics Cloud, and SAP Asset Central.
Usage of the FSM Connector: The lesson discussed how the FSM Connector supports the flow of transactional data and setting up of the connector to match business requirements.

Continue to quiz