Integration of deployment tools

Deployment orchestration is an essential part of change enablement and SAP Cloud ALM supports the integration of different deployment tools to serve this purpose. By enabling the deployment management, you can orchestrate the deployment of transport requests through your implementation landscape. 

Please be aware that transport-related data will be pushed to SAP Cloud ALM from your managed systems by setting up the integration.

The integration with the deployment tools and the respective solutions in the table below is already available. 

Deployment ToolIntegrated Solutions
Change and Transport System (CTS)SAP S/4HANA Cloud, private edition
CTSSAP S/4HANA
CTSSAP NetWeaver Application Server for ABAP on-premise

Change and Transport System (CTS) integration

Before you can start enabling the transport management for SAP S/4HANA Cloud, private edition or SAP NetWeaver Application Server for ABAP on-premise, please fulfill the following prerequisites.

Note: In case you want to enable the transport management for ST-PI 7.40 SP15 please contact our product management directly.

  • Check that the profile parameter icm/HTTPS/client_sni_enabled is set to TRUE. For more information, refer to SAP Note 510007. Transaction code RZ11 can be used to check for the parameter setting.
  • Check that DigiCert Global Root CA is imported in STRUST under SSL Client (Anonymous) and SSL Client (Standard).   

Create a Space and Configure Entitlements

As a first step, you need to create a space and configure your entitlements in the subaccount containing your SAP Cloud ALM subscription.

To do this, perform the steps described in Enabling SAP Cloud ALM API until you reach the section Create a New Instance. Then, proceed as described below.

Create a New Instance

1) Choose Cloud Foundry > Spaces.

2) Select the created space. You now see the application list of your created space.

3) Choose Services > Instances

4) Choose the Create dropdown and click on Service Instance.

5) Under Basic Info provide the following details:

  • Service: SAP Cloud ALM API

  • Plan: standard

  • Instance Name: Enter a meaningful name, for example CALMFeatureDeployment.

6) Choose Next.

7) When creating a service instance for feature deployment, the following configuration in json format is needed in order to assign the required scopes to the service instance.

Paste the following JSON code into the text editor:

{

    "xs-security": {

        "xsappname": "<Your Instance Name>",

        "authorities": [

            "$XSMASTERAPPNAME.imp-cdm-feature-manage-ui"

        ]

    }

}

  • Replace <Your Instance Name> with your instance name. Make sure it's not already used in another service instance and doesn't contain spaces or special characters.

  • Authorities: Make sure to use exactly the string provided above.

8) Choose Create.

9) When your instance has been created, it's added to the instance list. To show the details of the instance click on the newly created instance.

Create a Service Key

The service key allows you to configure the transport management in the managed system so that it can connect to an SAP Cloud ALM API service instance.

1) Choose (Actions) and select Create Service Key.

2) Enter a name for your service key, such as sap_cloud_alm_key.

3) Choose Create.

4) Next to your newly created service key, choose  (Actions) and select View.

5) You can now see your service key in JSON format.

The service key is structured in the following way:

  • Endpoints: e.g.,eu20.alm.cloud.sap
  • OAuth URL: Service Key parameter.
  • Client ID: Service key parameter clientid.
  • Client secret: Service key parameter clientsecret.

Copy this newly created service key in JSON format to the clipboard because it's needed later in the Maintain HTTP Destination section of this guide.

 

As prerequisite please make sure that your TMS is configured properly. For SAP S/4HANA Cloud, private edition systems you need to make sure that URL *alm.cloud.sap is enabled on your proxy. Please verify / request it via Service Request.

Required Authorizations

You need to consider two users in the managed ABAP system for the setup. Please note that the authorization steps are only needed for system client 000. For other clients these steps can’t be performed.

  • To run transaction /SDF/ALM_SETUP, the user needs the PFCG role SAP_SDF_ALM_SETUP.
  • For a SAP S/4HANA Cloud, private edition system you can request user CUST_TC for client 000. The user is authorized to run the setup transaction.

Note (not relevant for SAP S/4HANA Cloud, private edition system): In role SAP_SDF_ALM_SETUP, you need to maintain the authorization field S_BTCH_NAM > BTCUNAME either with “*” or with the user name of the user you plan to use as data collection background job user.

  • The user you specify as background user, requires the PFCG role SAP_SDF_ALM_METRIC_PUSH_FND and the role SAP_BC_TRANSPORT_ADMINISTRATOR.
  • For SAP S/4HANA Cloud, private edition systems user BATCH_USER can be specified as background user.

Note: Download the latest version of the role SAP_SDF_ALM_METRIC_PUSH_FND from SAP Note 3104662 .

Configuration of PUSH data provider

Log on to ABAP system client 000 and start transaction /n/SDF/ALM_SETUP. If you start the transaction the first time, it will look like this: 


In transaction /SDF/ALM_SETUP please perform the following steps:

  1. Target SAP Cloud ALM Destination: 
  • To create a new SAP Cloud ALM Destination, enter a name (e.g. SAP Cloud ALM) and choose the Enter key.
  • To change an existing SAP Cloud ALM destination, select one from the F4 input help and choose the Enter key.
  • After pressing the Enter key, the subsequent fields are filled out.

2  Maintain HTTP Destination:

  • Choose Update Destination
  • Copy and paste the content from the JSON file created during the enablement of the Enabling SAP Cloud ALM API by clicking Paste Service Keys.
  • Alternatively, you can enter the required fields for connecting SAP Cloud ALM manually:
    • Token Endpoint: Enter the SAP Cloud ALM OAuth URL.
    • Client ID: Enter SAP Cloud ALM client ID.
    • Client Secret: Enter SAP Cloud ALM client secret.
    • Proxy User (if necessary)
    • Proxy Password (if necessary)
    • Proxy Host (if required by your network infrastructure. For SAP S/4HANA Cloud, private edition, enter value: proxy)
    • Proxy Port (if required by your network infrastructure. For SAP S/4HANA Cloud, private edition, enter value: 3128)
  • Choose Ok to close the popup.
  • To delete a destination choose Delete Destination.

3  Enter Registration Target:

  • Enter the target SAP Cloud ALM root url depending on your region e.g. https://eu10.alm.cloud.sap.
  • Enter the background user you created to perform the data collection.
  • Choose Register to call SAP Cloud ALM and register the system. If it’s successful, an LMS ID is retrieved and is displayed.
  • To unregister a system, choose Unregister.

Note: This stops all data collection and heartbeat measurements.

4. Select the use cases you want to collect and push data for: 

The push mechanism supports the following use-cases:

  • For the domain controller: Feature Deployment: Read Transport Landscape
  • For development systems: Feature Deployment: Manage Transports
  • All other systems (test or production): Feature Deployment: Import Transports

5. If everything is set up correctly, it should look like this:

6. Activate following usecases:

  • Feature Deployment: Read Transport Landscape: It reports the STMS landscape configuration to SAP Cloud ALM. You need to setup on one system per domain only. Currently supported landscapes are:

a) Landscapes with at least two systems per route (also virtual systems)

b) Landscapes with basic consolidation and/or delivery targets (no target groups, delivery confirmation procedures, workflow-driven transports)

c) Landscapes with client-specific transport routes (CTC, optional)

  • Feature Deployment: Manage Transports: It reports transport requests to SAP Cloud ALM for assignment to features. It’s only necessary to set up on source systems, specifically DEV systems.
  • Feature Deployment: Import Transports: This task queries to-be-imported requests from SAP Cloud ALM and triggers the import job. It's only necessary to set up on consolidation and target systems for import (that is, QA and PRD)