SAP Cloud ALM

How to Set Up SAP Cloud ALM

Follow these steps to connect your SAP Cloud ALM tenant and start publishing diagrams.

Prerequisites

• Required role: Global Account Administrator in the SAP Cloud ALM global account
• Access: SAP BTP (Business Technology Platform) cockpit

Step 1: Configure Entitlements in SAP BTP Cockpit

Open the SAP BTP cockpit and select the subaccount containing your SAP Cloud ALM subscription. Go to Entitlements → Edit → Add Service Plans, select SAP Cloud ALM API with plan standard, then save.

Required role: Global Account Administrator in the SAP Cloud ALM global account.

If SAP Cloud ALM API is already listed under Entitlements, you can skip this step.

Step 2: Create or Update the Service Instance

Go to Services → Instances and Subscriptions.

A new SAP Cloud ALM tenant may already have an instance named sap-cloud-alm-api. Check before creating a new one — if it exists, just update it with the scopes below.

No Existing Instance:

Click Create, set Service to SAP Cloud ALM API, Plan to standard, Runtime Environment to Other, and enter an instance name (e.g. sap-cloud-alm-api, max 32 chars, alphanumeric, hyphens, underscores only).

Instance Already Exists:

Click the actions menu (⋮) → Update. Replace &<your service instance> in the JSON below with your instance's name or GUID.

On the parameters step, paste the following JSON (replacing &<your service instance> with your instance name or GUID):

  "xs-security": {
    "xsappname": "<your service instance>",
    "authorities": [
      "$XSMASTERAPPNAME.calm-api.analytics.read",
      "$XSMASTERAPPNAME.calm-api.bsm.read",
      "$XSMASTERAPPNAME.calm-api.csa.read",
      "$XSMASTERAPPNAME.calm-api.demo-tasks.read",
      "$XSMASTERAPPNAME.calm-api.documents.read",
      "$XSMASTERAPPNAME.calm-api.event-situations.write",
      "$XSMASTERAPPNAME.calm-api.exm.read",
      "$XSMASTERAPPNAME.calm-api.features.personal.read",
      "$XSMASTERAPPNAME.calm-api.features.read",
      "$XSMASTERAPPNAME.calm-api.hm.read",
      "$XSMASTERAPPNAME.calm-api.iep.read",
      "$XSMASTERAPPNAME.calm-api.integration-monitoring.read",
      "$XSMASTERAPPNAME.calm-api.jobs.read",
      "$XSMASTERAPPNAME.calm-api.landscape.read",
      "$XSMASTERAPPNAME.calm-api.logs.write",
      "$XSMASTERAPPNAME.calm-api.metrics.write",
      "$XSMASTERAPPNAME.calm-api.processauthoring.read",
      "$XSMASTERAPPNAME.calm-api.processmanagement.delete",
      "$XSMASTERAPPNAME.calm-api.processmanagement.write",
      "$XSMASTERAPPNAME.calm-api.projects.write",
      "$XSMASTERAPPNAME.calm-api.rum.read",
      "$XSMASTERAPPNAME.calm-api.sum.read",
      "$XSMASTERAPPNAME.calm-api.tasks.read",
      "$XSMASTERAPPNAME.calm-api.testcases.delete",
      "$XSMASTERAPPNAME.calm-api.testcases.read",
      "$XSMASTERAPPNAME.calm-api.tests.personal.read",
      "$XSMASTERAPPNAME.calm-api.traces.read",
      "$XSMASTERAPPNAME.calm-api.traces.write"
    ],
    "oauth2-configuration": {
      "credential-types": ["binding-secret"]
    }
  }
}

Click Create (or Update).

Step 3: Create a Binding and Copy the Credentials

Click on the created instance, then choose (⋮) → Create Binding. Enter a binding name (avoid the format &<sysID>_&<client>_>sysNum< to prevent conflicts), then click Create.

View the binding to see the service credentials JSON. Copy these fields into the form below:

• endpoints.Api → Base URL
• uaa.url + /oauth/token → Token URL
• uaa.clientid → Client ID
• uaa.clientsecret → Client Secret

Step 4: Save and Validate

Enter the credentials in the form below, click Save config, then click Validate connection. A successful validation confirms diagrams can be published.

Step 5: Publish a Diagram

Open any BPMN or Value Chain diagram in the repository and click Publish to SAP Cloud ALM. On first publish you can select an existing Solution Process and Business Process, or create a new one automatically.

Advanced fields — Project ID, Process Hierarchy ID, Probe Path, Publish Path, and API Path Prefix are only needed if your Cloud ALM tenant uses non-standard paths or you want to target a specific implementation project. Leave them blank for standard deployments.

SAP Cloud ALM Connection

Configure the tenant-scoped SAP Cloud ALM connection used for publishing BPMN and Value Chain diagrams as Solution Processes.

Advanced Fields

Enable live publish
Keep this off until the SAP sandbox contract is confirmed. Dry run remains available either way.

Sync target

• Draft — Syncs the BPMN diagram to Cloud ALM as a draft. Changes stay in draft until manually published in Cloud ALM.
• Published — Syncs and automatically publishes. Handles published → published and approved → published transitions.

Default: Draft

Note: Editing this integration requires the tenant.setting.write permission.

Using the Sync

Once connected, follow these steps to publish diagrams to SAP Cloud ALM.

1. Save and Validate the Connection

Enter your credentials in the form above, click Save config, then click Validate connection. A successful validation confirms diagrams can be published.

2. Set Your Default Business Process (Optional)

In Cloud ALM, go to Process Management → Business Processes and copy the ID of the business process you want diagrams published under. Paste it into the Business Process ID field above. If left blank, a business process named "BPMN Diagrams" is auto-created on first publish.

3. Publish a Diagram

Open any BPMN or Value Chain diagram in the repository and click Publish to SAP Cloud ALM. Choose a version and confirm. On first publish you can select an existing Solution Process and Business Process, or let the system create a new one automatically.

4. Re-publish After Changes

After updating a diagram, return to the repository and publish again. The integration will sync the new version into the existing Cloud ALM Solution Process, updating the flow diagram content in place.

5. Import a Diagram from Cloud ALM

To bring an existing Cloud ALM diagram into the repository, go to the Cloud ALM tab in the repository and browse the remote Solution Processes. Click Import next to any flow diagram to fetch its BPMN content and create a local copy.

Legacy processes: If an import fails with a message about BPMN content not being available, the diagram was created in the old Cloud ALM editor and has no BPMN data yet. To fix this, open the diagram in SAP Cloud ALM, click Edit, and save it without making any changes. Then try importing again.

Entity Mapping

How Arreteq entities map to SAP Cloud ALM:

Note: Only BPMN 2.0 and Value Chain diagrams are compatible with SAP Cloud ALM sync.

Integration Guide

Download our comprehensive integration guide to get started with SAP Cloud ALM. The guide includes detailed setup instructions, configuration steps, and troubleshooting tips.

Supported Features

Need Help?

For support with the SAP Cloud ALM integration or technical questions, please contact our team.