Skip to content

OData

This page shows how to use the Xtract OData component.
The Xtract OData component can be used to extract data provided by SAP OData services.

Note

The Xtract OData component ist still in beta phase. This means, the Xtract OData component is subject to change. Extractions that use the Xtract OData component can stop working with future updates and might require manual changes.

About OData Services

The Xtract OData component in Xtract IS consumes the data provided by SAP OData services. The OData (Open Data) protocol defines a set of rules to create, edit and consume resources through RESTful interfaces (HTTP requests). Furthermore, the OData protocol describes the data and the data model, meaning the data has its respective metadata, including the following items:

  • Column name
  • Description
  • Length
  • Data type

OData services can be build in SAP on-premise systems using the SAP Gateway Service Builder. On SAP cloud systems, the OData services are accessible via Communication Arrangements.

The Xtract OData component supports OData V2 and OData V4.

Tip

For information on how to create OData services that provide ODP based data, refer to the Knowledge Base Article: Create OData Services using the SAP Gateway Builder.

Prerequisites

  • Enable the follwing Communication Scenarios in the SAP Cloud:
    • General communication integration:
      • SAP_COM_0A06 (Communication System Read Integration)
      • SAP_COM_0A07 (Communication Arrangement Read Integration)
      • SAP_COM_0A48 (Communication Management Integration)
    • Metadata integration:
      • SAP_COM_0181 (OData Metadata Integration)
    • To extract CDS data:
      • SAP_COM_0531 (SAP Datasphere - ABAP CDS Extraction - OData Integration)
      • SAP_COM_0532 (SAP Datasphere - ABAP CDS Extraction - WebSocket Integration)
  • Expose SAP OData services to 3rd party systems using Communication Arrangements, see SAP Learning: Setting up Communication Management. For more information on predefined OData services in the SAPS/4HANA Public Cloud, see OData V4 List and OData V2 List.
  • Create an XTRACT_ODATA connection manager.

Add an Xtract OData Component

Follow the steps below to add an Xtract OData component to your SSIS package:

  1. Drag&drop the Xtract OData component from the SSIS toolbox into your data flow task.
    New

  2. Double-click the component. A connection manager is automatically assigned to the component and the main window of the component opens.

    Note

    If there are multiple connection managers, the window "Select Connection Manager" opens, see SAP Connection. Once a connection manager is selected, the main window of the component opens.

The majority of the functions of the component can be accessed in the main window.

Look up OData Services

  1. In the main window of the component, click [ ]. The window “Service Selection” opens.
    Open-Look-Up-ODP
  2. In the field Search pattern, enter the technical service name of an OData V2 service or the service ID of an OData V4 service . Use wildcards (*), if needed.
  3. Click [Search]. Search results are displayed. Look-Up-ODP
  4. Click [] to select a service . The SAP objects that are available via the service are displayed in the right screen of the menu.
  5. Select a service entity and click [OK] to confirm.

The application now returns to the main window of the component.

Define the Xtract OData Component

The Xtract OData component offers the following options for data extractions:

  1. In the section Service Fields, select the items to extract.
    Datasource Preview
  2. Click [Load Preview] to display a live preview of the first 100 records.
  3. Optional: edit selections to apply (dynamic) filters. For more information, see Edit Selections.
  4. Check the Settings before running the SSIS package.
  5. Click [OK] to save the component.

You can now run the SSIS package.

Note

The OData data types DateTime and DateTimeOffset (original format: yyyy-mm-ddThh:mm[:ss[.fffffff]]) are truncated to the following format: yyyyMMdd.

Last update: December 10, 2025