Neptune DXP Documentation
Neptune DXP - SAP Edition · 24.14 LTS

Install and configure SAP Integration Hub in SAP S/4HANA Cloud Public Edition

Install the SAP Integration Hub add-on in your SAP S/4HANA Cloud Public Edition tenant and configure it so that developers can define APIs in the Hub API Designer. You perform these steps once per tenant. For how this flavor differs from the transport-based flavors, see SAP Integration Hub for SAP S/4HANA Cloud Public Edition.

The configuration spans two systems and is usually split between several people:

Step System Role

1. Install the add-on

SAP S/4HANA Cloud Public Edition tenant, gCTS

SAP administrator

2. Expose the inbound endpoint

SAP S/4HANA Cloud Public Edition tenant, communication management apps

SAP administrator

3. Set up authorizations

SAP S/4HANA Cloud Public Edition tenant

SAP administrator

4. Connect Neptune DXP - Open Edition

Neptune DXP - Open Edition Cockpit

Neptune DXP administrator

5. Verify the configuration

ABAP Development Tools (ADT) and the Hub API Designer

ABAP developer

Prerequisites

  • You have a license extension for Neptune DXP - Open Edition that covers SAP Integration Hub. Without it, the SAP Integration Hub tile group does not appear in the Cockpit.

  • Neptune DXP - Open Edition 24.15 or higher is installed. Principal propagation requires Neptune DXP - Open Edition 25.0 or higher.

  • gCTS is available in your SAP S/4HANA Cloud Public Edition tenant for multi-off delivery.

  • You have a business user with a business role that contains the business catalog SAP_CORE_BC_COM, for example SAP_BR_ADMINISTRATOR. This is required for the communication management apps.

  • You have a developer user, for example based on the business role template SAP_BR_DEVELOPER. This is required to create and release data provider classes in ADT.

  • Your named technical contact has received the read-only access token for the delivery repository from Neptune Software.

1. Install the add-on

You perform this step in the SAP tenant as an SAP administrator.

Follow the SAP procedure Consuming ABAP Extensions in Multi-Off Delivery in the SAP Help Portal, with the following values:

Setting Value

Repository URL

https://github.com/neptune-software/dxp-sap-integration-hub-public-s4

Branch

main

Credentials

The read-only access token issued by Neptune Software

Version

The version agreed with Neptune Software during onboarding

Check that gCTS reports the pull as successful, and record the version you pulled. Neptune Support asks for it in every ticket about the add-on. If the pull fails, resolve the failure before you continue. The later steps require the delivered objects to be present in the tenant.

Store the access token only in the gCTS repository configuration. The token has an expiry date. Renew it with Neptune Software before it expires, so that a later update pull is not blocked.

2. Expose the inbound endpoint

You perform this step in the SAP tenant as an SAP administrator.

All APIs that you define in the Hub API Designer are served through one inbound HTTP endpoint, so no configuration is needed per API. The add-on delivers the communication scenario /NEPTUNE/DXP_CS_INBND with the inbound service /NEPTUNE/DXP_HTTP. You do not create your own communication scenario.

  1. In the Maintain Communication Users app, create a communication user for Neptune DXP - Open Edition. Record the user name and password, or the certificate details.

  2. In the Communication Systems app, create a communication system that represents your Neptune DXP - Open Edition installation. Add the communication user as a user for inbound communication, and select the authentication method.

  3. In the Communication Arrangements app, select New and select the communication scenario /NEPTUNE/DXP_CS_INBND.

  4. Assign the communication system, check that the inbound service /NEPTUNE/DXP_HTTP is active, and save.

  5. Note the inbound service URL that the saved arrangement generates. Pass it and the communication user details to the Neptune DXP administrator for step 4.

The inbound service supports basic authentication with a communication user, OAuth 2.0, and client certificates. Use basic authentication only for initial testing and non-productive systems. For production, use principal propagation, so that each call carries the identity of the calling user instead of a shared technical user.

3. Set up authorizations

You perform this step in the SAP tenant as an SAP administrator.

There is no separate logon to SAP Integration Hub in the tenant. Neptune DXP - Open Edition reaches the tenant through the inbound endpoint with the communication user from the previous step.

For business users who administer the add-on in the tenant, create a business role from the delivered business role template /NEPTUNE/DXP_BRT_ADMIN. Assign it to the administrators according to your own role management process.

Access to Neptune DXP - Open Edition and to the Hub API Designer is controlled by the user and role administration of Neptune DXP - Open Edition.

4. Connect Neptune DXP - Open Edition

You perform this step in the Neptune DXP - Open Edition Cockpit as a Neptune DXP administrator. You create a remote system with the inbound service URL and a proxy authentication for the communication user.

For the procedure, see Connect to SAP Integration Hub in SAP S/4HANA Cloud Public Edition in the Neptune DXP - Open Edition documentation.

5. Verify the configuration

You perform this step in ADT and in the Hub API Designer as an ABAP developer. Create a small test API and call it.

  1. In ADT, create a class in your customer namespace with the ABAP language version ABAP for Cloud Development. Add the interface /neptune/if_dxp_api_dpc to its public section, and add a method to expose as an API operation. For the class requirements, see Data provider class.

  2. Release the class under contract C1 for use in cloud development.

  3. In the Hub API Designer, create an API for the remote system, select the class, add an operation for the method, and save. For details, see Create an API in the Hub API Designer.

  4. On the Swagger UI tab of the API, execute the operation.

A successful response confirms that the communication arrangement, the communication user, the remote system, and the proxy authentication work together. A successful gCTS pull and a successful API call are the two criteria for a completed installation.

If the call fails, check the following in this order:

  1. The inbound service /NEPTUNE/DXP_HTTP is active in the communication arrangement.

  2. The communication user is valid and assigned to the communication system.

  3. The sap-client header matches the client you intend to call.

  4. The class is released for use in cloud development.

Logging

Logging is switched off after installation, and the add-on persists no log data until you enable it. There is no automatic deletion of log data yet. Before you enable logging, see Logging and data growth.

Update the add-on

You perform the update in the SAP tenant as an SAP administrator.

  1. Plan a time for the update and inform the consumers of your APIs. APIs served by the add-on can be unstable or unavailable while the pull runs.

  2. In gCTS, pull the newer version from the main branch.

  3. Check that gCTS reports the pull as successful, and record the version you pulled.

  4. Call one of your APIs to confirm that it responds.

If the update fails, raise a ticket in the Neptune Software support portal and attach the gCTS log.

Related topics

Was this page helpful?

What made the biggest difference for you?
What went wrong? (Your feedback helps us fix it.)

Please don't include personal or sensitive data.