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 Tool||Integrated Solutions|
|Change and Transport System (CTS)||SAP S/4HANA Cloud, private edition|
|CTS||SAP NetWeaver Application Server for ABAP on-premise|
|Cloud Transport Management service (CTMS)||SAP Integration Suite (more under supported content types)|
|CTMS||SAP BTP Cloud Foundry environment (more under supported content types)|
|CTMS||SAP BTP Neo environment (more under supported content types)|
SAP Cloud ALM is receiving the information of the transport routes from the managed systems or SAP Cloud Transport Management directly. Assigned transports will follow the defined transport routes in STMS for CTS and the Transport Routes section of CTMS. There is no need to assign the corresponding clients / tenants to the system groups in SAP Cloud ALM.
To use the transport capabilities of SAP Cloud ALM in conjunction with the Change and Transport System (CTS), you've to establish a connection between SAP Cloud ALM and your managed systems.
This guide will lead you through the steps that are needed to establish the connection.
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.
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
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.
"xsappname": "<Your Instance Name>",
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.
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:
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. We recommend to configure client-specific transport routes and please make sure that "Automatic recording of changes" is set for client-specific objects (transaction SCC4).
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.
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.
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:
2 Maintain HTTP Destination:
3 Enter Registration Target:
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:
5. If everything is set up correctly, it should look like this:
6. Activate following usecases:
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)
In order to release transports within a feature you must activate the use case Feature Deployment: Manage Transport per Client in each development client you want to release transports for.
Transports cannot be assigned
Important: As "xsappname" you must enter the Instance Name your chose in the "Basic Info" step before.
Make sure to activate the following two use cases in the ABAP Configuration UI /SDF/ALM_SETUP:
Import is not working
Special Case - System Copy
To use the transport capabilities of SAP Cloud ALM in conjunction with the SAP Cloud Transport Management service, you've to establish a connection between SAP Cloud ALM and the SAP Cloud Transport Management service.
SAP Cloud Transport Management will be subscribed automatically in your SAP Cloud ALM subaccount during provisioning of SAP Cloud ALM. Using this SAP Cloud Transport Management tenant in conjunction with SAP Cloud ALM is free of charge. It is not possible to use an existing SAP Cloud Transport Management tenant in conjunction with SAP Cloud ALM.
This guide will lead you through the steps that are needed to establish the connection for the SAP Cloud Integration use case.
Please note that all the steps below only refer to an exemplary setup for SAP Cloud Integration as part of the SAP Integration Suite. For other integration solutions, the steps are similar but may differ in certain aspects. In this case, refer to the documentation of your integration solution.
You can skip this step in case Cloud Transport Management is already showing up in the Instances and Subscriptions area as application to which your subaccount is currently subscribed.
To use the SAP Cloud Transport Management service in SAP Cloud ALM, you have to subscribe to the service in your SAP Cloud ALM subaccount in SAP BTP. Before you subscribe, check if you're entitled to use the SAP Cloud Transport Management service.
Go to your SAP BTP global account and choose your SAP Cloud ALM subaccount.
To check your entitlements, go to Entitlements and choose Configure Entitlements.
Search for the Cloud Transport Management service in the search bar. If no results are shown in the service list, choose Add Service Plans.
Check the checkbox Standard (Application) Standard Plan and choose Add 1 Service Plan
Now, the Cloud Transport Management service appears in the service list. Choose Save.
Go to Instances and Subscriptions and choose Create.
In the New Instance or Subscription, select Service Cloud Transport Management and the standard plan in the Plan dropdown. Then choose Create.
You're now subscribed to the SAP Cloud Transport Management service.
Now, you can assign members of your team to roles. Usually, the two roles you need are TMS_Viewer_RC and TMS_LandscapeOperator_RC.
You can assign the roles in the User Management app in SAP Cloud ALM.
Now, you can access the Cloud Transport Management service from within your subaccount in the SAP BTP cockpit by choosing Go to Application.
As a first step, you've to enable content transport in the Cloud Foundry environment by subscribing to the Content Agent (using the ContentAssemblyService) and Service Broker (using the Process Integration Runtime). Please follow the steps described in the Enabling Content Transport, Cloud Foundry Environment guide.
Not every step is required in every case. For example, if you already created a space for transport management within your subaccount, you can skip certain steps.
After you've followed all the steps in this guide, please proceed with the next step.
Creating HTTP Destinations, Cloud Foundry Environment
In the next step, you need to create destinations in your SAP BTP subaccount in order to transport integration packages from a source tenant to the target tenant.
Please follow the steps described in the Creating HTTP Destinations, Cloud Foundry Environment guide.
The URLs you've extracted in step a. and that you've to use in step b. are structured in the following way:
The URL you can find in the section uaa in the JSON file relates to the token endpoint. You can identify this URL by checking if the term "authentication" is included in the URL. The URL above the uaa section of the JSON file relates to the service endpoint. (see screenshot below)
To do this, perform the steps described in Enabling SAP Cloud ALM API. Please make sure to add the correct scope for the integration use case SAP Cloud Transport Management Service as described in step 7 of section Maintain an Instance.
Paste the following JSON code into the text editor:
"xsappname": "<Your Instance Name>",
The following section deals with the creation of destinations, transport nodes, and transport routes to configure the content transport landscape.
To set up the SAP Cloud Transport Management service destination, please follow the steps in the Creating HTTP Destinations and Transport Route guide. When you open the guide, choose the blue box called Cloud Transport Management to see the information relevant to you.
The following linked documentation refers to Enabling Content Transport, Neo environment but also applies to Enabling Content Transport, Cloud Foundry environment.
Proceed directly to step 2 and enter your credentials from the SAP Cloud ALM API instance according to the table. Step 1, the creation of CloudIntegration, has already been covered in the first section Set Up SAP Cloud Integration in this guide.
In the URL section for the endpoint, you enter the URL of your SAP Cloud ALM API instance that follows a pattern like this: https://eu10.alm.cloud.sap/api/imp-cdm-transport-management-api/v1. The first part of the URL until /api depends on your company account and is variable.
Now, you've set up the connection of the SAP Cloud Transport Management service with SAP Cloud ALM.
Note: More information about which roles are required to accomplish the various tasks related to SAP Cloud Integration can be found here: Tasks and Permissions.
The task that is needed here, is WorkspacePackagesTransport and has to be assigned to a role. Because there's no custom role assigned to the WorkspacePackagesTransport task, you've to create a role. You can freely choose a name by yourself, for example CTMS_Admin.
After you've created a new role, you can assign the new role to a user. This can either be done in the SAP BTP cockpit or in the User Management app of SAP Cloud ALM.
For more information about how to assign roles to users in SAP Cloud ALM, refer to the information described in Assign Roles to Users in SAP Cloud ALM.