Windows DSN Configuration
The CData ODBC Driver for OData 2017 can be configured using the Microsoft ODBC Data Source Administrator. Once the driver is installed, you will see the CData OData Source data source name listed under the User DSN tab of the ODBC Data Source Administrator. Select a DSN and click the Configure button to set connection properties in the driver configuration window.
Connecting to OData
To connect, you need to set the Url to a valid OData service root URI in addition to the authentication values.Also, you can specify a Cache Location to store the metadata of your OData organization. This will keep the CData ODBC Driver for OData 2017 from having to send requests for metadata on each connection.
Fine-Tuning Data Access
Set the following properties to control how the driver models OData APIs as a database:
- NavigationPropertiesAsViews: By default, the driver models navigation properties as views. This enables access to related entities, even though these entities may not be linked by a foreign key in your OData service.
- SupportsExpand: If your API does not support the $expand parameter, set this property to avoid an error when NavigationPropertiesAsViews is set. If this is the case for your API, specify the base entity’s primary key in the WHERE clause to access navigation properties.
- DataFormat: Set this property to JSON or XML. Otherwise, the driver uses the default format defined by the service.
- ODataVersion: Use this to override the version detected by the driver. This is useful if your application supports an older OData version.
- UseIdUrl: By default the driver returns the direct URL to an entity as the primary key. By setting this to false, the entity key is returned.
- UseSimpleNames: Set this to true to return only alphanumeric characters in column names. This can help you to avoid SQL escapes and errors in SQL-based tools.
Authenticating to OData
The driver supports the major authentication schemes, including HTTP and Windows.
Set AuthScheme to use the following authentication types.
The driver simplifies OAuth configuration. See Using OAuth for a how-to.
The driver supports authentication with HTTP Basic, Digest, and custom headers. To use Basic or Digest, set the User and Password. You can specify other authentication values in CustomHeaders.
Set the Windows User and Password to connect and set AuthScheme to “NTLM”.
Kerberos and Kerberos Delegation
To authenticate with Kerberos, set AuthScheme to NEGOTIATE. To use Kerberos Delegation, set AuthScheme to KERBEROSDELEGATION. If needed, provide the User, Password, and KerberosSPN. By default, the driver attempts to communicate with the SPN at the specified Url.
Securing OData Connections
By default, the driver attempts to negotiate SSL/TLS by checking the server’s certificate against the system’s trusted certificate store. To specify another certificate, see the SSLServerCert property for the available formats to do so.