Migration from Neptune DXP - SAP Edition Rest API to Integration Hub API

Migration is only possible in a system where both Neptune DXP - SAP Edition and the SAP Integration Hub are installed.

Prepare the data provider class

For more information about data provider classes in the SAP Integration Hub framework, see Data provider class.

Add the Hub API interface /neptune/if_dxp_api_dpc to the data provider class you want to migrate. To continue using the API in the Neptune DXP - SAP Edition API Designer simultaneously, ensure you retain the old interface /neptune/if_restapi. Once the migration is complete and the class is no longer used in the Neptune DXP - SAP Edition API Designer, the old interface can be removed.

If the system supports setting the ABAP Language Version, set it to ABAP for Cloud Development and release the class for use in Cloud Development.

As there is a new interface for the Hub API, any manual handling of data in /neptune/if_restapi~data_request or /neptune/if_restapi~data_response must be manually migrated to the corresponding /neptune/if_dxp_api_dpc~data_request and /neptune/if_dxp_api_dpc~data_response.

To use the DPC in both the Neptune DXP - SAP Edition API Designer and the SAP Integration Hub API Designer simultaneously, the data need to be read from and/or set in the structures for both interfaces.

Create the Hub API

In the SAP Integration Hub API Designer, when running in Neptune DXP - SAP Edition, or in Neptune DXP - Open Edition connected to a remote system with Neptune DXP - SAP Edition Rest APIs, a Migrate button will be available. This allows you to select from a list of available Neptune DXP - SAP Edition Rest APIs to migrate.

When you select a Neptune DXP - SAP Edition Rest API, a corresponding new Hub API will open in creation mode with all supported data populated. Messages will appear indicating any unsupported features or issues, such as the DPC class not implementing the Hub API interface.

Unlike the Neptune DXP - SAP Edition API, Hub API operations require you to explicitly set which attributes or parameters to expect as query parameters. If you rely on query parameters for an operation, ensure these are set as required.

Upon successfully saving, the new corresponding Hub API is created.

Switching in the App Designer

Adjusting apps to use the Hub API instead of the Neptune DXP - SAP Edition Rest API is a manual process involving a few steps.

Add the Hub API object

  1. Drag and drop the Hub API object as a resource into the app tree.

  2. Name it accordingly, select the Hub API and operation, and set up its events and properties as required. The feature set is identical to the Neptune DXP - SAP Edition Rest API, so there should be a 1:1 match.

  3. Set the required model Send/Receive flags for the operation.

Adjust model sources

  • Replace all model sources from the Neptune DXP - SAP Edition Rest API with the corresponding source in the Hub API.

Adjust scripts

  • Replace any calls to the Neptune DXP - SAP Edition Rest API function getOnline<APIObjID> (for example, getOnlineGetSomeData();) with the new Hub API function hubApi<HubAPIObjID> (for example, hubApiGetSomeData();). All parameters are compatible, so existing arguments can be kept as is.

Delete the Neptune DXP - SAP Edition Rest API object

  • After verifying that everything is working as expected and the Hub API object is in use instead of the Rest API object, you can disable or delete the unused Rest API object.

Related topics