About OData 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
Enable OData connector for your Etlworks account. Contact firstname.lastname@example.org to enable connector.
Creating a connection
Step 1. In the Connections window click the
+ button and type in odata.
Step 2. Enter connection parameters
- URL - the JDBC connection string which starts with
jdbc:odata:URL=. The URL must point to the specific OData endpoint. Example:
- User - the user name
- Password - the password
Use Other parameters to specify the connection string options. Read about available connection string options.
Using 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.
Working with OData
OData data model
Read about the OData data model.
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'
Extracting 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 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.
Loading data in OData service
loading data in OData is similar to loading data into 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.
Browsing data in OData service
You must have OData connection to browse objects and run SQL queries.
Use Explorer to browse data and metadata in OData as well as execute stored procedures, DML and SELECT queries against OData connection.