Skip to main content

OData Source Connector

The OData source connector lets DataSync retrieve data from any OData-compliant service and load it into your data warehouse. DataSync supports two authentication modes: Basic and OAuth 2.0.

Once your source connection is ready, configure your destination connection to finish the setup.

Create the source connection in DataSync

  1. Log in to DataSync.
  2. From the welcome screen, select Connections.
  3. Next to Source Connections, click New.
  4. Select OData.
  5. Enter all required connection properties.
  6. (Optional) In the Additional Connection Properties panel, click Add property and enter any extra parameters you need.
  7. Configure the advanced settings to match your environment, including Tracking Type.
  8. Click Save.

Connection properties

PropertyWhat to enter
DescriptionUnique name for the connection. Example: OData.
URLAddress of the OData endpoint. Example: https://services.odata.org/TripPinRESTierService.
Authentication ModeBasic or OAuth2.
UsernameBasic only Login account for accessing the OData service. Example: admin.
PasswordBasic only Password for this account.
Callback URLOAuth only Redirect URL automatically generated by DataSync. Must be added to the OAuth application in your identity provider.
Client IDOAuth only Identifier assigned to the OAuth application during registration.
Client SecretOAuth only Secret generated for the OAuth application.
Authorization URLOAuth only URL used to obtain the authorization code. Provided by your identity provider.
Access Token URLOAuth only URL used to exchange the authorization code for an access token. Provided by your identity provider.
ScopeOAuth only Permissions requested from the OData service. Default: openid, api, offline_access.
Convert all dates and times to GMTConverts all DateTime values to GMT. Recommended when your OData service runs in a different time zone and you need consistent timestamps across your data.
Use client-side pagingEnables client-side paging for large datasets. When enabled, data is retrieved in pages rather than all at once.
Page SizeMaximum number of results returned per page when client-side paging is enabled. Larger values return more rows per page but may increase timeout risk.
TimeoutTime in seconds to wait before a connection attempt or query execution times out.
Data formatFormat for retrieved data: ATOM or JSON.
VerbosityControls how much detail the connector writes to the log. Each level includes everything from the level below it, plus additional detail.

  • 1 logs queries, row counts, execution start and end times, and errors.
  • 2 adds cache queries and HTTP headers.
  • 3 adds request and response bodies.
  • 4 adds transport-level communication.
  • 5 adds all interface commands.
Enable PoolingEnables connection pooling, which keeps a set of database connections open and reuses them across extractions instead of opening a new connection each time. This reduces overhead and improves performance when multiple extractions run at the same time.
Pool idle timeoutTime in seconds a connection can stay idle before returning to the pool.
Max Pool SizeMaximum number of connections allowed in the pool at the same time.
Pool wait timeTime in seconds DataSync waits for an available connection before throwing an error.

Additional connection properties

Use this panel to enter connection string properties not available in the Connection Properties panel. For sensitive values such as passwords, set the type to Encrypted. The value is hidden in the interface and stored encrypted in the back end.

PropertyWhat to enter
PropertyConnection string property that defines the action or behavior. Example: ReadOnly
ValueValue for the property. Example: True
TypeVisibility settings: Visible or Encrypted.

Advanced settings

These settings control how the connector tracks data changes, handles time and regional configuration, and processes records during extraction. Configure them to match your OData environment so that results stay accurate and consistent.

SettingWhat to select
Tracking TypeMethod for tracking data changes: None or Date.
RegionRegion setting for the connector, if required by your setup.
Time ZoneTime zone matching your OData environment.
Time OffsetRefresh offset in seconds to compensate for timing issues in record selection. Minimum 0, maximum 3600.
Batch SizeNumber of records processed per batch during extraction. Larger batches can improve performance but use more memory. Default is 2000, maximum is 10000. Adjust based on your network speed and disk performance. The default works well in most cases.

Basic authentication example setup

OData basic authenticaton source connection in DataSync
Completed OData basic authenticaton source connection in DataSync, with all properties and settings filled in.

OAuth authentication example setup

OData OAuth authentication source connection in DataSync
Completed OData OAuth authentication source connection in DataSync, with all properties and settings filled in.