Skip to main content

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

  1. Log in to DataSync.
  2. From the welcome screen, select Connections.
  3. Next to Source Connections, click New.
  4. Select OData.
  5. In the Connection Properties panel, enter the connection properties.
  6. (Optional) In the Additional Connection Properties panel, select Add property and enter the parameters for each property.
  7. In the Advanced Settings panel, configure the settings, including the Tracking Type and other values according to your requirements.
  8. Click Save.

Parameters

Connection properties

ParameterDescription
DescriptionUnique name for the connection. Example: OData
URLAddress of the OData endpoint. Example: https://services.odata.org/TripPinRESTierService
Authentication ModeAuthentication method used by the connector: Basic or OAuth2.
UsernameUsername credentials with required permissions for accessing OData (Basic authentication only).
Example: admin
PasswordPassword for the specified username (Basic authentication only).
Callback URLRedirect URL automatically generated by DataSync. Must be added to the OAuth application in your identity provider (OAuth2 only).
Client IDIdentifier assigned to the OAuth application during registration (OAuth2 only).
Client SecretSecret generated for the OAuth application (OAuth2 only).
Authorization URLURL used to obtain the authorization code. Provided by the identity provider (OAuth2 only).
Access Token URLURL used to exchange the authorization code for an access token. Provided by the identity provider (OAuth2 only).
ScopePermissions requested from OData (OAuth2 only). Default: openid, api, offline_access.
Convert all dates and times to GMTConversion of OData DateTime values to GMT.
Use client-side pagingPaging capability for large datasets.
Page SizeMaximum results to return per page when client-side paging is enabled. Larger values return more rows per page but may cause timeouts.
TimeoutTime in seconds to wait for connection opening and query execution before timeout.
Data formatFormat for retrieved data: ATOM or JSON.
Verbosity
  • 1 – Log queries, row counts, execution start/end, errors.
  • 2 – Includes level 1 plus cache queries, HTTP headers.
  • 3 – Includes level 2 plus request/response bodies.
  • 4 – Includes level 3 plus transport-level communication.
  • 5 – Includes level 4 plus all interface commands.
Enable PoolingConnection pooling option for performance.
Pool idle timeoutMaximum idle time for connections before returning them to the pool, in seconds.
Max Pool SizeMaximum number of connections allowed in the pool.
Pool wait timeMaximum 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.

ParameterDescription
PropertyConnection string property that defines the action or behavior. Example: ReadOnly
ValueValue for the property. Example: True
TypeVisibility 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.

SettingDescription
Tracking TypeMethod for tracking changes: None or Date.
RegionRegion setting for the connector, if required by your setup.
Time ZoneTime zone matching the OData application server.
Time OffsetRefresh offset in seconds to compensate for timing issues in record selection. Minimum value is 0; maximum is 3600 seconds.
Batch SizeQuantity 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.