Skip to content

CDSFlow Services

This page shows how to use the CDSFlow service type.
The CDSFlow service type extracts data from CDS Views and supports incremental loads when supported by the CDS View.

About CDSFlow

The CDSFlow service type enables you to extract data from SAP S/4HANA CDS Views. It supports both full and delta loads for CDS Views that provide delta extraction capabilities. This allows you to process only changed data after the initial load. The CDSFlow service type requires no custom function modules to be installed in the SAP system.

Supported SAP Systems:

  • SAP S/4HANA On-Premise 1909 or higher
  • SAP S/4HANA Private Cloud
  • SAP S/4HANA Public Cloud

Supported SAP objects:

  • CDS Views
  • CDS View Entities

Note

Database Views and Views created by joining tables in SAP transaction SE11 are not supported.

Prerequisites

CDS Views:

  • CDS Views must be exposed using the ABAP annotation @Analytics.dataExtraction.enabled = true.

Delta loads:

  • The SAP user used in the SAP connection has sufficient user rights, see SAP Authorization Objects.
  • CDS Views must be delta enabled using the ABAP annotation @Analytics.dataExtraction.delta.changeDataCapture.automatic: true.

SAP Public Cloud:

  • Create a Client PSE to connect to SAP Cloud Systems and add the PSE file to the input/pse/ directory inside the volume used by the Xtract Universal.iQ container.
  • The Communication Scenarios SAP_COM_0532 and SAP_COM_0576 must be accessible in the SAP Public Cloud, see SAP Help: Setting Up Communication Management.
  • The SAP connection used for the CDSFlow service uses WebSocket RFC connectivity, see WebSocket.
    • The hostname is the API server address of the cloud system, e.g. yourinstance-api.s4hana.ondemand.com.
    • The client number is 100 and the port number is 443.
    • The checkbox User Name is Alias is enabled and the username is a Communication User Aliasname.

Tip

The public CDS View I_DataExtractionEnabledView was introduced in SAP S/4HANA version OP2020 / CE2008 and can be used to check which extraction-enabled CDS views are released under the C1 contract and are delta-enabled.

Create a CDSFlow Service

To create a new CDSFlow web service in Xtract Universal.iQ:

  1. Open the Services menu.
  2. Click [Add Service].
  3. Enter a unique name and a description.
  4. Optional: Activate the checkbox Enable MCP Access and add an MCP description to expose the service via the Xtract Universal.iQ MCP Server.
  5. Select an existing SAP connection from the Connection dropdown. If no connection is available, create a connection, see Connect to SAP.
  6. Select CDSFlow from the Type dropdown.
  7. Select a target environment from the Destination dropdown. By default, Xtract Universal.iQ services return SAP data in HTTP response of the service (HTTP destination).
  8. Click [Save].

The service is now listed in the Services menu.

Next, select the SAP object you want to extract.

Look Up CDS Views

To select a CDS View from your SAP source system:

  1. Create a new service of service type CDSFlow.
  2. In the CDS View section of the service, click [Select CDS View]. The "Search CDS Views" menu opens.
  3. Enter the name of the CDS View or CDS View Entity that you want to look up:
    • For CDS Views, enter the SQL name of a CDS View. For information on how to look up the SQL name of a CDS View in SAP, see Look Up SQL Names of CDS Views.
    • For CDS View Entities, enter the entity name defined in the data definition of the CDS View Entity.
  4. Click [Search] to display the search results.
  5. Select a CDS View from the list of search results. The "Search CDS Views" menu closes.

Xtract Universal.iQ loads and displays the metadata of the CDS View in the service.

Next, configure the remaining service settings.

Configure the CDSFlow Service

After creating the service, configure the service using the following workflow:

  1. Go to the output columns section and select the columns you want to extract. By default all columns are selected.
  2. Select an update mode, e.g., to initialize delta loads.
  3. Optional: Edit the Service Settings to define how the data is extracted from SAP.
  4. Optional: Edit the Destination Settings to define the output of the service.

For more information, see CDSFlow Settings.

Initialize Delta Loads

To initialize delta loads from CDS Views in Xtract Universal.iQ:

  1. Create a CDSFlow service.
  2. Look up the CDS View you want to track.
  3. Check if the CDS View supports delta loading. If the field Delta enabled below the [Select CDS View] button is set to True, delta loading is supported.
  4. Open the Update Mode section and select Delta Load from the Update Mode dropdown.
  5. Click [Subscribe]. If successful, a status message "Initialization successful" opens in the bottom right corner of the window.
  6. Click [Run]. The service settings are saved and the "Run" menu opens.
  7. Click [Run]. The initial load is executed and all data is extracted from the source CDS View.

The service is configured to extract delta data in subsequent service runs.

Run and Automate the Service

Last update: September 15, 2026