Install and configure the SAP BTP edition of ABAP SDK for Google Cloud

This document describes how to install and configure SAP BTP edition of ABAP SDK for Google Cloud in the SAP BTP, ABAP environment.

This document is intended for SAP administrators, Google Cloud administrators, and other SAP and Google Cloud security professionals.

Overview

ABAP SDK for Google Cloud provides client libraries in the form of ABAP classes for developers to programmatically access Google Cloud APIs. By encapsulating essential functions such as security, authentication, data serialization and deserialization, and error handling as reusable components, these client libraries reduce the amount of code that developers need to write. For a complete list of client libraries that the ABAP SDK for Google Cloud provides, see ABAP SDK for Google Cloud client libraries.

As an ABAP developer, you can build and deploy ML and AI-driven solutions using a wide range of Google Cloud services such as Vertex AI, Document AI Warehouse, BigQuery, Dataproc, Pub/Sub, Google Workspace APIs, and Google Maps Platform.

For communication between SAP and Google Cloud APIs, the ABAP SDK for Google Cloud uses HTTPS protocol with SSL.

Before you begin

Before you install the SAP BTP edition of ABAP SDK for Google Cloud, do the following:

Subscribe to the SAP BTP Landscape Portal. For information about subscribing to the Landscape portal, see Subscribing to the Landscape Portal in the SAP BTP cockpit.
You have a valid S-User ID associated with a customer number that has an active SAP support contract.
If you're new to Google Cloud, then create an account on https://cloud.google.com.
If you don't have a Google Cloud project already, then create a project:

Go to project selector
Make sure billing is enabled for your project. For more information, see Verify the billing status of your project.
Enable the supported APIs that you plan to access using the SDK. For information about how to enable Google Cloud APIs, see Enabling APIs.

Upload the Google certificates

To secure communication between SAP BTP, ABAP environment and Google servers, you need to upload the required Google certificates into the Maintain Certificate Trust List app of your SAP BTP, ABAP environment.

To upload the certificates into the SAP Maintain Certificate Trust List app, you must have access to the business catalog SAP_CORE_BC_SEC. This business catalog is included in the predefined business role SAP_BR_ADMINISTRATOR.

To upload the Google certificates, perform the following steps:

Download the following certificates from the Google Trust Services repository:
- GTS Root R1
- GTS CA 1C3
Sign in to the SAP BTP Cockpit. For more information, see the SAP page Access the Cockpit.
Select the subaccount where your ABAP environment is hosted.
Go to Instances and Subscriptions > Instances, and click your ABAP instance.
In your ABAP environment that opens, go to All spaces > Administration > Security.
Open the Maintain Certificate Trust List app.
Click Add.
Select the certificates that you downloaded from the Google Trust Services repository.
Click Upload. The certificates are added to the trust list.

Install the SAP BTP edition of ABAP SDK for Google Cloud

You install the SAP BTP edition of ABAP SDK for Google Cloud using SAP BTP Landscape Portal.

To install the SAP BTP edition of ABAP SDK for Google Cloud, perform the following steps:

Get the ABAP SDK for Google Cloud product available in your Landscape Portal.
1. Under the component BC-CP-ABA, open a medium priority case with SAP using one the following options:
  - Open a case through the SAP for Me application. For guidelines to open a case, see the SAP page Submitting a Case.
  - Open a case through the Landscape Portal. For guidelines to open a case, see the SAP page Create Support Tickets.
2. In the case description, enter the following details:
```
We would like the following product registered to our Landscape Portal:
* Product: /GOOG/ABAP_SDK
* Publisher: Google
```
3. Provide other details as appropriate and submit the case.
After SAP has confirmed that the product is registered to your Landscape Portal, proceed to the next step.

It can take up to 3 business days for the ABAP SDK for Google Cloud to be registered in your Landscape Portal. If the SDK is still not registered after this time, then contact Cloud Customer Care for assistance. For information about contacting Customer Care, see Getting support for SAP on Google Cloud.

Note: The requirement to submit a case to SAP for obtaining the ABAP SDK for Google Cloud is only a temporary approach until a permanent distribution mechanism is established.
Deploy the ABAP SDK for Google Cloud product:
1. In the Landscape Portal, open the Deploy app.
2. In the Product field, select /GOOG/ABAP_SDK.
3. In the Target version field, select 1.0.1.
4. Under Available systems, select the ABAP instance where you need to install the SDK.
5. Click Deploy. The Product Version Deployment Status section shows the deployment completion status.

Add Fiori apps to the launchpad

The SAP BTP edition of ABAP SDK for Google Cloud provides SAP Fiori apps for SDK configurations and application logging. As an administrator or developer, you use these Fiori apps to configure the SDK and configure application logging. The SDK also provides dedicated Fiori apps only for viewing authentication configurations, logging configurations, and analyzing the SDK logs.

Administrators or developers who configure the SDK and logging, or those users who only need to view the SDK configurations and logs, must have access to the relevant Fiori apps. To grant access to SDK Fiori apps, you need to add the business catalogs of ABAP SDK for Google Cloud to the business role of users who perform the SDK configuration or need to view the configurations and logging. The SAP BTP edition of ABAP SDK for Google Cloud includes business role templates that contain business catalogs required for accessing the Fiori apps.

The following table lists the business role templates and related Fiori apps that they provide access to.

Business role template	App name	Description
`/GOOG/BRT_SDK`	Google SDK: Main Configuration	Use this app to configure authentication to securely connect with Google Cloud APIs.
	Google SDK: Application Log Configurations	Use this app to configure logging to capture errors, warnings, and info messages into SAP application logs.
	Google SDK: Application Logs Display	Use this app to view the SDK application logs.
`/GOOG/BRT_SDK_DISPLAY`	Google SDK: Display Main Configuration	Use this app to view the SDK configurations.
	Google SDK: Display Log Configuration	Use this app to view the application log configurations.
	Google SDK: Application Logs Display	Use this app to view the SDK application logs.

To add the business catalogs of ABAP SDK for Google Cloud to the business role of users using the provided business role templates, you must have access to the business catalog SAP_CORE_BC_SEC. This business catalog is included in the predefined business role SAP_BR_ADMINISTRATOR.

Create a business role

In your ABAP environment, go to All spaces > Administration > Identity and Access Management.
Open the Business Role Templates app.
Search for and select a business role template as appropriate:
- /GOOG/BRT_SDK: provides access to the Fiori apps for configuring the SDK.
- /GOOG/BRT_SDK_DISPLAY: provides access to the Fiori apps for viewing the SDK configurations and logs.
Click Create Business Role.
In the Create Business Role from Template dialog that appears, enter a value for the following fields:
- New business role ID: enter a business role ID.
- New business role description: enter a description for the business role.
Click OK. The Maintain Business Roles page appears with the newly created business role.
Under Access categories, specify the access for the business role based on the selected business role template:
- /GOOG/BRT_SDK: In the Read, Write, Value Help field, select Unrestricted.
- /GOOG/BRT_SDK_DISPLAY: In the Read, Write, Value Help field, select No access.
Optionally, on the Assigned Business Catalogs tab, you can view the business catalogs of the Fiori apps that are associated with the business role.
Click Save.

Assign space to the business role

In your ABAP environment, go to All spaces > Administration > Identity and Access Management.
Open the Maintain Business Roles app.
Search for and select the business role that you created in the Create a business role section.
Go to the Assigned Launchpad Spaces tab, and click Add.
In the Add Launchpad Space dialog that appears, enter a value for the following fields:
- Assign space to business role: select Create New Space.
- Space ID: enter a space ID.
- Space description: enter a description for the space.
- Space title: enter a title for the space.
Click Create and assign space.
On the Assigned Launchpad Spaces tab, click the space ID of your space.
On the Space Details page that appears, go to the Pages tab, and then click the page ID.
On the Managed Launchpad Pages page that appears, go to the Page Content tab, and then click Edit.
In the Section Title field, enter a section title.
In the Derived from Role section, select the Fiori apps, and then click Add. These Fiori apps are displayed from the business catalogs of the ABAP SDK for Google Cloud.
Click Save.

Assign role to business users

To grant access to the SDK Fiori apps, you assign the newly created role to the business users who manage or view the SDK configurations and logs.

In your ABAP environment, go to All spaces > Administration > Identity and Access Management.
Open the Maintain Business Roles app.
Search for and select the business role you created in the Create a business role section.
Go to the Assigned Business Users tab, and click Add.
In the Add Business Users dialog that appears, search for and select the required users who need access the SDK Fiori apps.
Click OK. The users can see the assigned space and page with the SDK Fiori apps.

Configure authentication

To use the Google Cloud APIs, you must confirm your identity by authentication. For information about authentication options to Google Cloud and setup steps, see Authentication.

Configure logging

The SAP BTP edition of ABAP SDK for Google Cloud uses SAP application logs to save all messages raised during the execution of client library classes. Once you define a default log configuration, the SDK starts logging the messages.

The log object /GOOG/LOG_OBJECT and subobject /GOOG/LOG_SUBOBJECT are shipped with the SDK that you can use for creating your default log configuration.

You use the Google SDK: Application Log configurations app to create a log configuration.

You can view application logs using the Google SDK: Application Logs Display app. For more information, see View logs.

To create a log configuration, perform the following steps:

Access the SAP Fiori launchpad.
Go to the space that contains the Fiori apps for SDK configuration.
Open the Google SDK: Application Log Configuration app.
Click Create.
In the Create dialog that appears, enter a value for the following fields:
- Log config type: select OBJ_SUBOBJ.
- Object: select /GOOG/LOG_OBJECT.
- Subobject: select /GOOG/LOG_SUBOBJECT.
Click Continue.
Provide the following details:
- Retention days: specify the number of days the logs are going to be retained.
- Log level: specify the minimum log level. The supported values are:
  - I: Information, Warnings, and Errors
  - W: Warnings and Errors
  - E: Errors Only We recommend that you set the log level to I, so that most of the log messages are logged.
- End at: specify the end date till which this log configuration is going to be active. The default end date is 9999/12/31.
- Is default: To make this your default log configuration, select the checkbox.
Click Create.

Manage log configuration

If a log configuration is no longer required, then you can disable it.

To disable a log configuration, perform the following steps:

Open the Google SDK: Application Log Configuration app.
In the Editing status field, select a status as appropriate, and then click Go.
Click the log configuration entry that you need to disable.
Click Edit.
Set the End At to a past date.
Click Save.

Specify Google Cloud API endpoint

The SAP BTP edition of ABAP SDK for Google Cloud provides the following options for specifying the API endpoint when calling a Google Cloud API using the API client library class:

Default endpoints
Custom endpoint

Default endpoints

By default, each API class hardcodes global endpoints as a constant value. The client library uses these endpoints when a method is called to perform an operation on API resources. To use the default endpoints, no additional configuration is required.

Custom endpoints

In scenarios, where you need the flexibility to define your own endpoints, you can create custom endpoints. For example, you create a custom endpoint to establish connection to Google Cloud when you need to do the following:

Access region-specific endpoints of an API for regulatory or latency-sensitive applications.
Use specific APIs such as Vertex AI, which only offer regional endpoints.

To create a custom endpoint, you use the communication scenario /GOOG/COM_SDK_SRV that is shipped with the ABAP SDK for Google Cloud.

The following procedure illustrates how to create a regional endpoint for Pub/Sub API. You can follow the same procedure to create custom endpoints for other supported Google Cloud services.

Access the SAP Fiori launchpad of the BTP ABAP system where the ABAP SDK for Google Cloud is installed.
Go to All spaces > Administration > Communication Management.
Create a communication system:
1. Open the Communication Systems app.
2. Click New.
3. In the New Communication System dialog that appears, enter a value for the following fields:
  - System ID: enter a system ID.
  - System name: enter a system name.
4. Click Create.
5. In the Host name field, enter your custom endpoint. For example, enter a regional endpoint for the Pub/Sub service: https://asia-east1-pubsub.googleapis.com.
6. In the Port field, enter 443.
7. On the Users for Outbound Communication tab, click Add.
8. In the Authentication method field, select None.
9. Click Create.
10. To save the communication system, click Save.
Create a communication arrangement:
1. Open the Communication Arrangement app.
2. Click New.
3. In the New Communication Arrangement dialog that appears, enter the following details:
  - Scenario: select Outbound Communication for any API (/GOOG/COM_SDK_SRV).
  - Arrangement name: enter a name for the communication arrangement.
4. Click Create.
5. For the communication arrangement that appears, in the Communication System field, select the communication system that you created in the previous step.
6. Under Outbound communication, in the User name field, select None.
7. Click Save.
Create a communication map for an API service:
1. Go to the space that contains the Fiori apps for SDK configuration.
2. Open the Google SDK: Main Configuration app.
3. Select the client key against which you need to create a custom endpoint. It is assumed that you have already created a client key and a communication map for authentication. If not, then create a client key and a communication map for authentication. For more information, see the Authentication.
4. Click Create.
5. In the Create dialog that appears, select a service name. For example, select pubsub:v1.
6. Click Continue.
7. For the communication map that appears, in the Communication arrangement field, select the communication arrangement that you created in the previous step. The other communication artifacts are autopopulated.
8. Click Apply.
9. Click Save.
10. To validate the custom endpoint configuration, click Check connection. A green check for an entry indicates successful configuration. In case of any errors, visit the troubleshooting page for guidance to resolve common errors.

Usage metrics

The SAP BTP edition of ABAP SDK for Google Cloud collects usage metrics and sends them to Google for support purposes, in compliance with Google Cloud Privacy Notice (Service Data We Collect). These usage metrics are collected every time a Google Cloud API is called from the ABAP SDK for Google Cloud.

The SDK collects the following usage metrics:

Authentication method: information about the authentication method used for calling Google Cloud services.
ABAP SDK version: version no. of the SAP BTP edition of ABAP SDK for Google Cloud.
SAP_ABA release: version of the SAP_ABA software component.

Licensing

The SAP BTP edition of ABAP SDK for Google Cloud is made available as "Software" under the agreement governing your use of Google Cloud Platform, including the Service Specific Terms available at https://cloud.google.com/terms/service-terms. Without limiting the generality of the preceding terms, you may not modify or distribute ABAP SDK for Google Cloud without express written permission from Google.

ABAP SDK for Google Cloud software is offered at no cost. For clarity, your use of other "Software" and "Services" under the agreement governing your use of Google Cloud Platform, such as Cloud Translation API and Pub/Sub API may incur a cost.

ABAP SDK for Google Cloud does not include any license to SAP software, you need to separately procure an appropriate license to SAP software.

Support lifecycle

Google Cloud supports and maintains the current major version of the SAP BTP edition of ABAP SDK for Google Cloud for a period of at least 12 months following the publication of a notice of deprecation for the prior major version at Release Notes page for SAP on Google Cloud.

Get support

If you need help resolving problems with the ABAP SDK for Google Cloud, then do the following:

Refer to the ABAP SDK for Google Cloud troubleshooting guide.
Ask your questions and discuss ABAP SDK for Google Cloud with the community on Cloud Forums.
Collect all available diagnostic information and contact Cloud Customer Care. For information about contacting Customer Care, see Getting support for SAP on Google Cloud.