OData Source Connector
The OData source connector in DataSync lets you retrieve data from any OData-compliant service for loading or synchronizing in your data warehouse. After creating all required source connections, configure your destination connection to finalize the setup.
Create a source connection in DataSync
- Log in to DataSync.
- From the welcome screen, select Connections.
- Next to Source Connections, click New.
- Select OData.
- In the Connection Properties panel, enter the connection properties.
- (Optional) In the Additional Connection Properties panel, select Add property and enter the parameters for each property.
- In the Advanced Settings panel, configure the settings, including the Tracking Type and other values according to your requirements.
- Click Save.
Parameters
Connection properties
| Parameter | Description |
|---|---|
| Description | Unique name for the connection. Example: OData |
| URL | Address of the OData endpoint. Example: https://services.odata.org/TripPinRESTierService |
| Authentication Mode | Authentication method used by the connector: Basic or OAuth2. |
| Username | Username credentials with required permissions for accessing OData (Basic authentication only). Example: admin |
| Password | Password for the specified username (Basic authentication only). |
| Callback URL | Redirect URL automatically generated by DataSync. Must be added to the OAuth application in your identity provider (OAuth2 only). |
| Client ID | Identifier assigned to the OAuth application during registration (OAuth2 only). |
| Client Secret | Secret generated for the OAuth application (OAuth2 only). |
| Authorization URL | URL used to obtain the authorization code. Provided by the identity provider (OAuth2 only). |
| Access Token URL | URL used to exchange the authorization code for an access token. Provided by the identity provider (OAuth2 only). |
| Scope | Permissions requested from OData (OAuth2 only). Default: openid, api, offline_access. |
| Convert all dates and times to GMT | Conversion of OData DateTime values to GMT. |
| Use client-side paging | Paging capability for large datasets. |
| Page Size | Maximum results to return per page when client-side paging is enabled. Larger values return more rows per page but may cause timeouts. |
| Timeout | Time in seconds to wait for connection opening and query execution before timeout. |
| Data format | Format for retrieved data: ATOM or JSON. |
| Verbosity |
|
| Enable Pooling | Connection pooling option for performance. |
| Pool idle timeout | Maximum idle time for connections before returning them to the pool, in seconds. |
| Max Pool Size | Maximum number of connections allowed in the pool. |
| Pool wait time | Maximum wait time for connection allocation before error is thrown, in seconds. |
Additional connection properties
Additional connection string properties not specified in the Connection Properties panel. For each property added, you can choose Visible or Encrypted. Selecting Encrypted hides the value from the interface and stores it encrypted in the back end, such as when defining passwords.
| Parameter | Description |
|---|---|
| Property | Connection string property that defines the action or behavior. Example: ReadOnly |
| Value | Value for the property. Example: True |
| Type | Visibility of the property: Visible or Encrypted. |
Advanced settings
Advanced settings control how the OData connector tracks changes, handles regional and time configuration, and processes data batches during extraction. These options allow fine‑tuning for performance and accuracy, and should be configured according to your system environment and operational requirements.
| Setting | Description |
|---|---|
| Tracking Type | Method for tracking changes: None or Date. |
| Region | Region setting for the connector, if required by your setup. |
| Time Zone | Time zone matching the OData application server. |
| Time Offset | Refresh offset in seconds to compensate for timing issues in record selection. Minimum value is 0; maximum is 3600 seconds. |
| Batch Size | Quantity of records processed in each batch during extraction. Larger batch sizes increase memory usage but can improve performance up to a point. The default value is 2000 and the maximum should not exceed 10000 records. Adjust according to your network speed and disk performance; in most cases the default (2000) works best. |