Configuring SAP Landscape Discovery

Gain comprehensive and consistent transparency by discovering your SAP landscape through SAP Cloud ALM. Learn how to set up SAP Cloud ALM and connect your LeanIX workspace to SAP Cloud ALM via API.

Introduction

The SAP landscape discovery feature in LeanIX uses SAP Cloud ALM to access and gather landscape information from SAP Cloud ALM and other SAP systems. SAP Cloud ALM's underlying discovery functionality provides a continuous view of your SAP landscape, ensuring that the data in LeanIX is up-to-date and accurate.

Active or regular usage of SAP Cloud ALM is not required for the SAP landscape discovery to work. LeanIX uses SAP Cloud ALM as a gateway to connect with your SAP backend repository to retrieve data from various SAP tools, including SAP Solution Manager and Focused Run. This means there is no need to switch from SAP Solution Manager to SAP Cloud ALM to derive value from this integration.

📘

Scope of SAP Landscape Discovery

Currently, the discovery focuses on cloud-based services, with plans to include on-premises systems in the future. Check our product roadmap for more detail - SAP On-Premise Application Landscape Discovery.

📘

SAP Cloud ALM

SAP Cloud ALM is an application lifecycle management offering for cloud-centric customers. It is included in cloud subscriptions containing SAP Enterprise Support. To learn more, see SAP Cloud ALM.

Using the SAP landscape discovery feature involves the following steps:

  1. Leveraging an existing or setting up a new SAP Cloud ALM instance.
  2. Auto-discovering the services & systems in SAP Cloud ALM.
  3. Enabling read-only API access to SAP Cloud ALM.
  4. Connecting your LeanIX workspace to the SAP Cloud ALM API.
  5. Linking new and existing fact sheets in your inventory to the discovered SAP services after reviewing them in the SAP discovery inbox.

📘

Note

Only users with admin rights can configure and manage this integration.

👍

Managing Access

The integration uses a service key to access the Cloud ALM API instead of being tied to a specific user or password. This allows you to manage access independently of individual users.

Setting Up an SAP Cloud ALM Instance

If you are not yet using SAP Cloud ALM, to set up and access the system, follow the instructions in these guides:

Auto-Discovering the Services and Systems through SAP Cloud ALM

Once SAP Cloud ALM is set up, enable SAP Cloud ALM to auto-discover your services and systems by setting up landscape management. To set up landscape management in SAP Cloud ALM, see Landscape Management.

You can find the discovered cloud services and systems under Landscape Overview in the SAP Cloud ALM user interface.

Discovered Cloud Services and Systems in SAP Cloud ALM

Discovered Cloud Services and Systems in SAP Cloud ALM

Enabling API Access to SAP Cloud ALM

🚧

Requirement

Access to the SAP BTP Cockpit is required for this step.

LeanIX requires access to SAP Cloud ALM's API. To learn how to enable the API, see Enabling SAP Cloud ALM API. Ensure you create a new API instance to avoid affecting any existing API keys and other API users.

To create a new API instance, enter basic information for your instance with an appropriate instance name. Then, configure the instance parameters in JSON format. Use the JSON code below as the ‘Binding Parameters'. This limits access to the landscape data in Cloud ALM. Make sure to replace<your-instance-name> with an appropriate instance name. If the API instance is created without a dedicated name, use the 'instance id' (a UUID) instead.

🚧

Note

Make sure you use the following JSON code to ensure correct permissions are passed in the authorities attribute.

{
  "xs-security": {
    "xsappname": "<your-instance-name>",
    "authorities": [
      "$XSMASTERAPPNAME.calm-api.landscape.read",
      "$XSMASTERAPPNAME.calm-api.subscriptions.read"
    ]
  }
}
Creating a New API Instance in SAP Cloud ALM

Creating a New API Instance in SAP Cloud ALM

Validating the Cloud ALM Service Key

We recommend validating the proper functioning of the service key by using the 'Try out' functionality for the Cloud ALM REST API. To access it, visit SAP Business Accelerator Hub.

If the request fails, double-check that the binding parameters were correctly registered for the service key and ensure that the 'xappname' matches the name of the Cloud ALM API instance.

Connecting LeanIX to the SAP Cloud ALM API

To connect LeanIX to SAP Cloud ALM API, do the following:

  1. In the administration area of LeanIX, navigate to the Integrations section.
  2. Click Add Integrations.
  3. Locate SAP Landscape Discovery and click Configure.
  4. Download the service key from the SAP BTP cockpit that you previously created and input it under Authenticate via API.
  5. Click Save.
Connecting LeanIX to the SAP Cloud ALM API

Connecting LeanIX to the SAP Cloud ALM API

Troubleshooting

The table below lists common errors that you may encounter and how to resolve them.

👍

Requesting Support

If the issues persist, contact us through the support functionality on the screen. You can also contact support through SAP LeanIX Support.

Errors Screenshot Potential Solution
When pasting the API service key, you receive the message: “This does not look like JSON config, please add a different JSON config.“ Image 2 Ensure the JSON is exactly as downloaded from the BTP cockpit. In this example, the values were enclosed in single quotes (') instead of the needed double quotes (").
When pasting the API service key, you receive the message: “Authentication Failed. The JSON API credentials you've provided are incorrect or not recognized. (…)“

Validate the service key as described in Validating the Cloud ALM Service Key.

Check if the key has expired.

Check if any parts of the secret are missing.

Check if necessary ‘Binding Parameters' are absent.

When enabling the SAP Cloud ALM API, you receive the message: “Your credentials are valid, but your service key does not have the necessary permissions to access the resource.” Image 2

Ensure you use the correct JSON code as given in the section Enabling API Access to SAP Cloud ALM and not the JSON code in the guide Create or Update an Instance. This ensures correct permissions are passed in the authorities attribute.

Viewing Synchronization Logs for the Integration Runs

Every 24 hours, SAP landscape discovery generates synchronization logs for each discovery run by pulling data from the SAP landscape via SAP Cloud ALM. With synchronization logs, you can promptly identify any integration issues and get details on each failed integration run.

You can view the details of integration runs in the Sync Logging section of the administration area. You can also access it in the Integrations section by clicking View Sync Logging. For more information on synchronization logs, see Synchronization Logging.

Linking Discovered Services to the Fact Sheets

Once the integration is successfully set up, the discovery run discovers your SAP cloud products and lists them in the SAP Landscape Discovery Inbox. In the inbox, you can review the discovered items and link them to existing fact sheets or create and link new fact sheets. To learn more, see SAP Landscape Discovery Inbox.