Configuring the SAP Build Integration

Overview

You can use SAP extension discovery to link SAP Build projects to new or existing fact sheets in SAP LeanIX. Using SAP Build Process Automation as a gateway, you can connect SAP LeanIX workspaces to SAP Build instances and their components in the SAP Business Technology Platform (SAP BTP). This includes SAP Build Apps, SAP Build Code, and SAP Build Process Automation. Once connected, the SAP extension discovery feature also retrieves contextual information from the SAP Cloud Management Service for SAP BTP.

📘

Note

You do not need to use SAP Build Process Automation regularly to access SAP extension discovery.

Configuration

This section outlines the prerequisites and steps necessary to establish a seamless connection between SAP LeanIX and SAP Build Process Automation.

Prerequisites

1. In SAP LeanIX:
   1. Administrator access to your workspace.
2. Admin access to SAP Build Process Automation.
3. Admin access to a service instance of SAP Cloud Management Service for SAP BTP with the service plan “central-viewer.”

📘

Note

The integration uses a service key to access the SAP Build Process Automation API. This method allows you to manage access without relying on individual user accounts.

Step 1: Creating an SAP Build Process Automation Instance and Service Key

If you're not yet using SAP Build Process Automation, follow the instructions in the following guides to set up the service:

1. Subscribe to SAP Build Process Automation (Standard Plan).
2. Create an SAP Build Process Automation Service Instance.
   1. Under Service Plan, select Standard.
   2. Under Parameters, add the following JSON parameters:
   JSON

   {"permissions": ["buildtime.administer"],"authorized-environments": ["$all"],"authorized-projects": ["$all"]}
   

3. Create a Service Key for the SAP Build Process Automation Instance.

Step 2: Creating an SAP Cloud Management Service Instance and Service Key

If you aren’t using SAP Cloud Management Service in the same SAP BTP subaccount as SAP Build, follow the instructions in the guide Getting an Access Token for SAP Cloud Management Service APIs.

📘

Note

Your SAP Cloud Management Service Instance needs the "central-viewer" service plan (recommended) or higher.

Step 3: Connecting SAP LeanIX to the SAP Build instance

When you use SAP extension discovery, SAP LeanIX uses the SAP Build Process Automation API to discover your SAP Build instances. This process is independent of your use of SAP Build Apps or SAP Build Code.

To connect SAP LeanIX to SAP Build, do the following:

1. In the administration area of SAP LeanIX, go to Integrations.
2. Choose Add Integration.
3. Select SAP Build and choose Configure.
4. Provide an integration name and choose Next.
5. Copy and paste the service key in the JSON format generated in the section "Creating an SAP Cloud Management Service Instance and Service Key," and choose Next.
6. Copy and paste the service key in the JSON format generated in “Step 2: Creating an SAP Build Process Automation Instance and Service Key,” and chose Verify credentials.
7. Choose Finish.

Linking Discovered Items to Fact Sheets

After you set up the integration, the discovery process identifies your SAP Build projects and lists them in the SAP Discovery Inbox. In the inbox, you can review the discovered items and link them to existing fact sheets, or you can create and link new fact sheets. For more information, refer to SAP Discovery Inbox.

When you link an SAP Build project to an application fact sheet, the corresponding reference catalog items automatically link to that fact sheet. This linking ensures that catalog information is automatically synchronized and continuously updated in the linked fact sheets. It also keeps IT component and provider information current in their respective fact sheets.

📘

Note

The specific information that gets updated depends on the data fields you select for synchronization. For more details, refer to Applications in the Reference Catalog and IT Components in the Reference Catalog.

Viewing SAP Extension Discovery Synchronization Logs

Every 24 hours, SAP extension discovery generates synchronization logs for each discovery run. It retrieves this data from SAP Build. You can use the synchronization logs to identify integration issues and get details on each failed integration run.

To access the synchronization logs, do the following:

1. In the administration area of SAP LeanIX, go to Integrations.
2. Choose Sync Log.
3. Use the filters to find SAP Build in the table.

For more information on synchronization logs, refer to Synchronization Logging.