OData connector

• Startup
• Business
• Enterprise
• On-Premise
• Add-on

About OData connector

Etlworks OData connector allows fast, real-time access to OData services. The connector works just like any other database connector.

Etlworks partnered with CData to provide access to the OData services using industry-standard JDBC protocol. Read about CData OData JDBC connector.

When to use OData connector

Use this connector to create Flows that extract data from and load data into OData services. 

Prerequisites

Enable OData connector for your Etlworks account. Contact support@etlworks.com to enable connector.

Create a Connection

Step 1. In the Connections window, click +, and type in odata.

Step 2. Enter Connection parameters.

Connection parameters

• URL: the JDBC Connection string which starts with jdbc:odata:URL=. The URL must point to the specific OData endpoint. Example: jdbc:odata:URL=https://services.odata.org/V3/(S(uzwr4imlpgdk22ptxqifa1fc))/OData/OData.svc/;
• User: the user name
• Password: the password

Use Other parameters to specify the Connection string options. Read about available Connection string options.

OAuth2 authentication with OData service

Etlworks OData connector supports two-step OAuth2 authentication with OData service. In the first step the connector calls the authentication endpoint and receives the refresh and access tokens. It then uses an access token for all consecutive calls.  The entire process is fully automated and requires only a configuration change.

1. Enter the API endpoint used to receive an access token in the Authentication URL field. For example: https://data.company.com/oauth/token
2. Enter an authentication payload into the Authentication Request Payload field. The following tokens are accessible as part of the payload: {refresh_token}, {user}, {password}. For example: {"client_id":"{user}","client_secret":"{password}"}
3. Select a value for the Authentication Request Content Type field. The default is application/json.
4. Enter client credentials into User and Password fields.

Use client-side SSL certificate with OData Connection

Etlworks OData connector supports mutual authentication, which allows the user to present a certificate as well as the server. 

To configure OData Connection with the client-side SSL certificate (assuming that you already have a certificate):

Step 1. Use the field Client SSL Certificate to upload the certificate. The following Formats are supported: jks, pfx, p12, p11.

Step 2. Select SSL certificate type in the Client SSL Certificate Type field.

Step 3. Enter Passphrase in the Client SSL Password field.

Work with OData

OData data model

Read about the OData data model. 

Stored procedures

Stored Procedures are available to complement the data available from the REST Data Model. Sometimes, it is necessary to update the data available from a view using a stored procedure because the data does not provide direct, table-like, two-way updates. In these situations, the retrieval of the data is done using the appropriate view or table, while the update is done by calling a stored procedure. Stored procedures take a list of parameters and return back a data set that contains the collection of tuples that constitute the response.

Read about available stored procedures. 

To call stored procure from the SQL flow or from Before/After SQL, use EXEC sp_name params=value syntax. Example:

EXEC Search Url = 'url'

Extract data from OData service

Extracting data from OData service is similar to extracting data from the relational database.

Step 1. Create OData Connection which will be used as a source (FROM).

Step 2. Create a destination Connection, for example, a Connection to the relational database, and if needed a Format (Format is not needed if the destination is a database or well-known API).

Step 3. Create a Flow where the source is a database and the destination is a Connection created in step 2, for example, a relational database.

Step 4. Add a new source-to-destination transformation.

Step 5. Select OData Connection created in step 1 as a source Connection and select the endpoint you are extracting data from.

Step 6. Select TO Connection, Format (if needed), and object (for example, database table) to load data into.

Step 7. Click MAPPING and optionally enter Source Query (you don't need a query if you are extracting data from the OData endpoint unconditionally).

Step 8. Optionally define the per-field Mapping.

Step 9. Add more transformations if needed.

Load data in OData service

Loading data in OData is similar to loading data into a relational database.

Step 1. Create a source Connection and a Format (if needed).

Step 2. Create a destination OData Connection.

Step 3. Create a Flow where the destination is a database.

Step 4. Add new source-to-destination transformation.

Step 5. Select FROM and TO Connections and objects (also a FROM Format if needed).

Step 6. Optionally define the per-field Mapping.

Step 7. Add more transformations if needed.

Browse data in OData service

You must have OData Connection to browse objects and run SQL queries.

Use Etlworks Explorer to browse data and metadata in OData as well as execute stored procedures, DML and SELECT queries against OData Connection.