Connection to OData

The DQC Platform supports connections to OData v2 and v4 services — including SAP-based APIs. This guide explains how to configure an OData connector with the required URL, credentials, and optional headers.

Add an OData connector

To begin:

Go to the Data Connectors screen
Click the OData Server button
Fill in the required fields as described below

Start by selecting OData as the integration type

Required connection information

Field	Example	Description
Connector Name	`SAP OData – Production`	A name for this connection
Service URL	`https://server/sap/opu/odata/sap/API_PRODUCT_SRV` or `https://<cpi-host>/gw/odata/SAP/<Service>;v=1`	Base URL of your OData service (for example from SAP Gateway or SAP BTP Cloud Integration)
OData Version	`OData v4` or `OData v2`	Version of the API; v4 is preferred where available (SAP CPI OData API projects default to v2)
Authentication Method	`Basic Auth` or `OAuth 2.0`	Use `OAuth 2.0` (Client Credentials) for SAP BTP or `Basic Auth` for technical user login
Username / Password	`user_name` / `********`	Required when Authentication Method is `Basic Auth`
OAuth Client ID / Secret	`<client_id>` / `********`	Required when Authentication Method is `OAuth 2.0`
OAuth Token URL	`https://<subdomain>.authentication.<region>.hana.ondemand.com/oauth/token`	Token endpoint URL (required when Authentication Method is `OAuth 2.0`)
OAuth Scope	(optional)	Optional scope for the OAuth 2.0 token request
Custom Headers	`{"x-api-key": "your-api-key"}` (optional)	Optional JSON object with custom HTTP headers

Note: Do not append /$metadata, an EntitySet name, or query parameters (such as ?sap-client=...) to the Service URL.

Best practices for access control

When configuring an OData connection, make sure the user credentials are authorized to access the desired entities or data services.

SAP-specific setup

OData is one of several ways to bring SAP data into DQC. For a side-by-side comparison with SAP HANA and third-party connectors, see Connecting to SAP systems.

You can connect to SAP OData services in two ways:

Via SAP BTP Cloud Integration (CPI / SAP Integration Suite): Expose your SAP data as an OData v2 or v4 endpoint in SAP Cloud Integration (https://<cpi-runtime-host>/gw/odata/SAP/<Service_Name>;v=1) and authenticate with OAuth 2.0 using a Process Integration Runtime (integration-flow) Service Key with role ESBMessaging.send. Ensure the CPI integration flow supports /$metadata, <EntitySet>/$count (returning > 0), and pagination (__next or $top/$skip). See the dedicated guide: Connection to SAP OData via SAP BTP.
Directly via SAP NetWeaver Gateway / S/4HANA: Use the service root URL (for example https://server/sap/opu/odata/sap/API_PRODUCT_SRV). Ensure the service is active in SICF / /IWFND/MAINT_SERVICE and grant OData authorizations by adding the service to a PFCG role (go to PFCG Role Maintenance, add the OData service to the role menu, assign the role to the technical user, and ensure start and business authorizations).

For further details visit: OData and SAP

Whitelist the DQC Platform static IP

Ensure that the OData endpoint (or the reverse proxy/firewall in front of it) accepts traffic from:

3.123.94.228

Troubleshooting

When DQC cannot connect to OData or load its tables, it shows the reason with a short fix and links to this section. Look up the beginning of the message:

Message in DQC	Likely cause	Fix
`Unable to connect to OData service at '…', likely due to incorrect credentials.`	The service answered `$metadata` with an error: wrong credentials, wrong service path, or a login page of an SSO proxy	Open `<service URL>/$metadata` in a browser with the same user, then fix the credentials or the URL
`… likely due to incorrect service URL or entity. …`	The service URL is malformed	Enter the full URL starting with `https://`
`List Table names: unable to connect to OData service at '…'.`	OData V4: the service or its `$metadata` cannot be read	Check URL, credentials and OData version
`Table '…' not found in OData service at '…'. …`	The entity set was renamed or removed	Pick an entity set from the list of available entities
`Cannot specify both basic authentication and OAuth credentials`	Both methods are filled in	Keep only one authentication method
`Could not connect to the data source. …`	Network error, failed OAuth token request, or invalid custom headers	Check that the host allows the DQC IP address, the OAuth token URL, client and secret, and that custom headers are a JSON object
`Table not accessible anymore …`	The table was renamed, moved or deleted, or the user lost access to it after the last sync	Restore the table or the access, then resync the connector

Synchronization failed: when a sync cannot connect, the connector shows Failed on the Data sources screen and the badge links to this section. Edit the connector and click Load tables or Save: DQC tests the connection again and shows the current reason.
Entity sets missing from the table list: DQC lists only entity sets that return rows and support $count.
The connection test on Save does not contact the OData service; click Load tables to check URL and credentials before saving. A wrong URL otherwise shows up as a failed sync.
Still stuck? Write to support@dqc.ai with the connector name, the time of the attempt and the full message.

Notes

Use OData v4 where possible for better performance and schema management
If using SAP, confirm the service is active and reachable from external IPs
Learn more: Supported data sources, Connection to Power BI, Connection to SAP OData via SAP BTP