When connecting to a database system using the OData (Open Data Protocol) service/endpoint from the Syniti Knowledge Platform (SKP), provide the following connection properties to establish a secure and reliable connection. This article explains each property to understand what information is required and how it is used.
SKP allows you to connect to an OData endpoint for the following usage types:
Construct
Metadata Scanning
Replication
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 service root URL of the OData endpoint. | This is the base URL of the data service and represents the entry point. |
Authentication Type (Required) | SKP supports the following authentication types to connect to an OData service:
| Not applicable |
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. |
OAuth2.0: 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). For SAP S/4HANA, it is generated in SAP Business Technology Platform (BTP) > Security > OAuth 2.0 Clients as a UUID. |
OAuth2.0: 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 or in SAP BTP. |
OAuth2.0: 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 or in SAP BTP, as the access token obtained here will be used to authenticate all subsequent requests to the OData service |
OAuth2.0: 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 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. |
Add Tables to a OData Datastore
In the newly created 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.
In the Service URL field, enter the partial entity URL and click Discover Entity Sets. The SKP discovers and lists all the entity sets available under this service URL.
You can either select all or select the required entity sets.
Click Add Entity Sets.
The selected entity sets are now added as tables for your OData datastore connection. Repeat the steps above for different service URLs.
After adding entities (tables), a metadata scan is automatically triggered, importing all objects and their metadata into your datastore. The Service URL you entered is saved as the Description field for each table.
Add CDI-CDS Entities as Tables
To add and ingest metadata of Cloud Data Integration (CDI) and Core Data Services (CDS) entities:
In the newly created 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 Browse CDI-CDS Views to search for all those entities available in your OData Base URL.
Select the required CDI-CDS entities and click Discover Entity Sets. Note that only the Service ID of these entities are displayed. Once the entity is added as a table, you can view its metadata with Entity Set Name and Service URL.
Click Add Entity Sets.
A metadata scan automatically triggers, importing all object definitions and metadata.
