Overview
OData (Open Data Protocol) is an HTTP-based protocol for querying and writing data through a REST-like service. In the Syniti Knowledge Platform (SKP), an OData endpoint is treated like any other datastore. The SKP allows you to connect to an OData endpoint for the following usage types:
Metadata Scanning
Cloud Replication
The OData connection type is used for interacting with OData services, both reading and writing, depending on the supported operations. In the case of SAP S/4HANA OData sources and targets, the OData connection type gains additional capabilities around Cloud Data Integration (CDI) enabled Core Data Services (CDS) Views. The System's Application Type (set when you create or select the System the connection belongs to) determines the metadata discovery behavior:
Application Type | Use for | Effect on Metadata Discovery |
|---|---|---|
Other | Any non-SAP OData v2/v4 service, or an SAP OData service without special CDS View handling needs | Standard discovery only. Refer to Case A or Case B sections. |
SAP S/4HANA (or other SAP Systems) | SAP S/4HANA sources | Standard discovery flow with Discover CDI CDS Views feature for pulling in CDI CDS views with Core Schema Notation (CSN) enriched metadata. Refer to Case B and Case B - Extended sections. |
Configure an OData Connection
Create a new connection and select OData as the connection type. Enter the following properties:
Property | Description | Notes |
|---|---|---|
Name | Name of the OData connection, unique in the SKP. | Not applicable |
Description | Enter a description that briefly states the purpose of this connection. | Not applicable |
Service Root URL | Enter the base URL of the OData service. This is the entry point for all metadata and entity discovery. | For example, * * S/4HANA Cloud Public Edition: * S/4HANA Cloud Private Edition or S/4HANA on-premise: |
Authentication Type (Required) | The SKP supports Basic and OAuth2.0 Client Credentials authentication types to connect to an OData service. | For OAuth2.0 client credentials, refer to the OAuth2.0 Properties section below. |
Basic Auth: Username and Password | Enter the Username and password used to connect to the OData endpoint. | This login account should be the one that your administrator has created for database access. |
Read Block Size | Enter the number of records to request from the OData server in each batch. This controls the pagination size when reading data. | Default Value: 10,000 records per request |
Validate Server Certificate | Controls whether to verify the OData server's SSL/TLS certificate against trusted certificate authorities. * When enabled: Provides security by verifying the server's identity * When disabled: Allows connections to any server regardless of certificate validity (reduces security) | Default Value: Enabled When to disable: * Only if the OData server uses a self-signed certificate or an untrusted certificate * Only for development/testing environments; not recommended for production |
Allow Legacy TLS Cipher Suites | Enables compatibility with OData servers that require older, less secure encryption algorithms for the TLS connection. | Default Value: Disabled Enable this toggle only if the OData server doesn't support modern TLS cipher suites and connection fails |
Timeout (seconds) | How long (in seconds) the SKP waits for a response from the OData server before failing the operation. Increase for large CDI/CDS extracts or slow networks. | Default Value: 60 seconds |
OAuth 2.0 Properties
Property | Description | Notes |
|---|---|---|
Client ID (Required) | Enter the application identifier issued by your Identity Provider. This uniquely identifies your SKP connection for OAuth2.0 authentication. | Registered in your IDP's admin console. Format varies by provider (alphanumeric string, UUID, or custom format). |
Client Secret (Required) | Enter the cryptographic secret issued with the Client ID. This is used to authenticate your SKP application during token exchange. | Issued when registering the OAuth client in your IDP. |
Token URL (Required) | Enter the OAuth2.0 token endpoint provided by your Identity Provider. SKP exchanges your Client ID and Secret at this URL to obtain a Bearer access token. | Example format: https://<identity-provider>.com/oauth/token or https://<tenant-id>.authentication.sap.hana.ondemand.com/oauth/token. Verify this URL with your Identity Provider's admin console, as the access token obtained here will be used to authenticate all subsequent requests to the OData service |
Scope | Enter the scope(s) required to access the OData service resources. Scope values define the authorization level and type of access granted by the access token. Use space-separated strings (for example, odata.read odata.write). | Refer to your OData service and Identity Provider documentation for valid scope values. If left blank, the default scope configured in your Identity Provider will be applied. |
Test and save the connection.
Discover Entities (Tables)
Note
The SKP uses two discovery patterns based on the OData service's metadata endpoint structure. Both use the connection properties you configured above.
Case A: Service Root URL Exposes All Metadata
When this applies: Your <Service Root URL>/$metadata returns metadata containing all the entity sets for the defined OData service URL.
Entities Metadata Scan Summary:
Create a datastore using this connection with Import All Tables = True.
In the newly created datastore, click Scan on the datastore; no manual table selection needed.
Every entity set exposed by the service root URL is ingested automatically.
For example, a public OData v4 service where the service root directly exposes all available data sources: https://mycomp-api.s4hana.cloud.sap/sap/opu/odata4/sap/api_bank/srvd_a2x/sap/bank/0003/
Case B: Individual Service Path Metadata Required
When this applies: Only <Service Root URL>/<individual service path>/$metadata returns the metadata you need; the service root alone does not expose what you're looking for.
Entities Metadata Scan Summary:
Create a datastore using this connection with Import All Tables = False.
In the newly created datastore, select the Tables tab and click Add Tables. In the Add Table dialog box, the Base URL of your OData connection is displayed.
In the Service URL field, enter the relative Service URL pointing to that service's metadata.
For example, if your Service Root URL is
https://mycomp-api.s4hana.cloud.sapand you need the sales order service, enter:/sap/opu/odata4/sap/api_salesorder/srvd_a2x/sap/salesorder/0001
Click Discover Entity Sets. The SKP queries the OData metadata.
Select the entity sets you want to ingest as tables, then click Add Entity Sets.
A metadata scan automatically triggers, importing all object definitions and metadata.
Note
Most SAP OData services follow this individual entity discovery pattern. The SAP Business Accelerator Hub (api.sap.com) is the primary source for discovering and understanding all SAP OData services. It provides comprehensive service documentation, API references, metadata specifications, and service endpoints organized by product and business domain.
Case B (Extended): Discovering CDI CDS Views
When this applies: The System's Application Type is set to SAP S/4HANA, and you want to ingest SAP’s CDI exposed CDS views with automatically enriched SAP metadata.
What are CDI CDS views?
CDI CDS views are virtual SAP data models exposed as OData entity sets. Each view exposes exactly one entity set, always named with a generic name MasterData, Facts, Texts, etc.). Because many unrelated views share these names, the SKP uses the view's Service ID as the unique identifier and applies it as the table name when imported.
Metadata Discovery Steps for CDI CDS views
When your System's Application Type is set to an SAP System, the Add Tables dialog box in a datastore displays a Discover CDI CDS Views button that simplifies this pattern:
In the newly created SAP OData datastore, select the Tables tab and click Add Tables. In the Add Table dialog box, the Base URL of your OData connection is displayed.
Click Discover CDI CDS Views. Unlike Case B’s individual entity discovery, you do not need to enter a relative service URL first. The SKP queries SAP's CDI CDS catalog API directly and returns the list of available views.
Select the required CDI CDS views and click Discover Entity Sets. Note that only the Service ID of these entities are displayed.
Click Add Entity Sets. The SKP runs entity-set discovery for each selected view automatically and ingests them, using each view's own name as the table name.
Once the entity is added as a table, you can view its metadata with Entity Set Name and Service URL. A metadata scan automatically triggers, importing all object definitions and metadata.

CSN Metadata Overlay (SAP Systems Only)
When you add an entity through CDI CDS Views, the SKP automatically enriches the generic OData metadata with SAP's Core Schema Notation (CSN) overlay, retrieved from a separate SAP metadata service, where available. The overlay provides:
Data Type Accuracy: Replaces generic OData types
Edm.String,Edm.Date, etc.) with accurate SAP data types. For example, an SAP currency field shows asCUKY(currency key) instead of genericEdm.String.Primary and Compound Keys: Identifies primary key columns and correctly handles compound keys. For example,
I_SalesOrderItemhas a compound key ofSalesOrder+SalesOrderItem.SAP's OData metadata alone does not always make this clear; the CSN overlay ensures SKP ingests the correct key structure.
Check Table (Association) Constraints: Populates foreign key constraints based on associated CDS views.
Column Descriptions: Sourced from the CSN overlay; useful when authoring rulebooks or documenting data lineage in Migrate.
Note
The CSN overlay currently works for most CDS views but not all. When the CSN extraction fails for a view, the SKP falls back to the generic OData metadata and data types for that view only.