Skip to content

OData

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

Note

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

Warning

Timeout Error
Extractions of large data sets may run into timeouts. This is a known issue that will be fixed in the next update.

About OData Services

The OData extraction type in Board Connector consumes the data provided by SAP OData services. OData services can be build in SAP using the SAP Gateway Service Builder.

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

The OData extraction type supports OData V2 and OData V4.

Prerequisites

  • Enable the fllowing Communication Scenarios:
    • 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 SAP connection of type OData.

Create an OData Extraction

  1. In the main window of the Designer, click [New] to create a new extraction. The window "Create Extraction" opens.
    New
  2. Select an SAP Connection of type Odata from the drop-down menu Source.
  3. Enter a unique name for your extraction.
  4. Select the extraction type OData and click [OK]. The main window of the extraction type opens automatically.

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

Look up OData Services

  1. In the main window of the extraction type, 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 extraction type.

Define the OData Extraction Type

The OData extraction type 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. Check the General Settings before running the extraction.
  4. Click [OK] to save the extraction type.

You can now run the extraction, see Run Extractions.

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: January 30, 2025