SAP ALM API & Integration: Tasks/Defects/Requirements to External Systems

[Xavier]

In this series of blog post, we cover different use-cases of integration between SAP Cloud ALM and external ALM services.

All Integration scenario of SAP Cloud ALM are based on the public APIs listed in the SAP Business Accelerator Hub.

 

Objectives

You want to forward SAP Cloud ALM tasks events to external systems like chat tools.

 

Prerequisites

Any chat tool or external system can be connected to SAP Cloud ALM using the provided External API Integration capabilities.

• Integration with Microsoft Teams:
  
  
  
  • SAP Cloud ALM provides a ready-to-use integration with Microsoft Teams including a pre-defined API mapping.
  
  
  
  


• Simple Integration with Other Tools
  
  
  
  • The external tool must:
    
    
    
    • Expose REST APIs to receive messages.
    
    
    • Expose an API endpoint accessible from your SAP Cloud ALM BTP sub-account.
    
    
    • Support one of the following Authentication protocol described in the following documentation.
    
    
    • Support a compatible payload for REST operations. The list of supported mapping rules can be found in the help.sap.com.
    
    
    
    
  
  
  
  


• Complex Integration with Other Chat Tools
  
  
  
  • If the external tools do not match the requirements for a simple integration, an integration can still be achieved by using SAP Integration Suite or third-party API Integration HUB platform.
  
  
  
  

 

Procedure Overview

• Configure a SAP BTP destination to enable to connectivity to your external system.


• Configure a SAP Cloud ALM web-hook to enable to connectivity to your external system and SAP Cloud ALM.


• Create a SAP Cloud ALM mapping to define transformation rules to apply to the messages exchanges between SAP Cloud ALM and the external REST API.


• Add a SAP Cloud ALM subscription to associate the external system with the event types raised by SAP Cloud ALM.


• Configure your SAP Cloud ALM Project to associate SAP Cloud ALM subscriptions to the different tasks types.

 

 

Configure SAP BTP destination

In your SAP BTP Cockpit create a destination to your external system.

• The SAP BTP destination enables the connectivity from your SAP BTP tenant to your external system:

 

 

Configure SAP Cloud ALM Web-hook

In the SAP Cloud ALM External API Management application, create a web-hook for your destination with the following parameters:

• External resource type: Task.


• Destination type: (ex: Microsoft Teams or any string identifying your external system).

Check the help.sap.portal for more information.

 

Configure SAP Cloud ALM mapping

The mapping defines the transformation rule to apply before sending the request and after receiving the response of the external system.

Check the help.sap.portal for more information.

 

 

Configure SAP Cloud ALM subscription

Create a subscription based on your web-hook and your mapping with the following parameters:

• Resource type: CALM Task to use this subscription for events raised for resources managed by the project and task applications.


• Type: Built-in to apply a transformation payload.

Check the help.sap.portal for more information.

 

 

Configure SAP Cloud ALM project

In the Subscriptions panel of the SAP Cloud ALM Project Management application, associate the subscription to the selected task type.

In this case, tasks events will be sent for Project Tasks and User Story. Other tasks types events are ignored.

All changes events for the selected tasks types (Creation, Update and Deletion) will be managed by the selected subscriptions.

Check the help.sap.portal for more information.

 

 

Monitor resources changes events

In the SAP Cloud ALM External API Management application, you can monitor the events exchanged with your external system

 

More Information

• Support Portal


• SAP Cloud ALM API Guide