Connect to Deel Data in CloverDX (formerly CloverETL)

The CData JDBC Driver for Deel enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Deel as sources. In this article, you will use the JDBC Driver for Deel to set up a simple transfer into a flat file. The CData JDBC Driver for Deel enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Deel as sources. In this article, you will use the JDBC Driver for Deel to set up a simple transfer into a flat file.

Connect to Deel as a JDBC Data Source

1. Create the connection to Deel data. In a new CloverDX graph, right-click the Connections node in the Outline pane and click Connections -> Create Connection. The Database Connection wizard is displayed.
2. Click the plus icon to load a driver from a JAR. Browse to the lib subfolder of the installation directory and select the cdata.jdbc.api.jar file.
3. Enter the JDBC URL.

   To authenticate to Deel, you can use API Key (Bearer Token) authentication.

   Using APIKey Authentication

   You can authenticate using a Deel API Key. Create an API key in your Deel account settings under Settings > API or Developer Settings. Make sure to grant appropriate permissions based on the data you need to access (e.g., read access for invoices, timesheets, contracts, workers, etc.).

   After creating your API Key, set the following connection properties:

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your Deel API Key (Bearer token).

   Example APIKey connection string

   Profile=C:\profiles\Deel.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_deel_api_key';
   

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Deel JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   java -jar cdata.jdbc.api.jar
   

   Fill in the connection properties and copy the connection string to the clipboard.

   

   A typical JDBC URL is below:

   jdbc:api:Profile=C:\profiles\Deel.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_deel_api_key';

Query Deel Data with the DBInputTable Component

1. Drag a DBInputTable from the Readers selection of the Palette onto the job flow and double-click it to open the configuration editor.
2. In the DB connection property, select the Deel JDBC data source from the drop-down menu.
3. Enter the SQL query. For example:

   SELECT ,  FROM Invoices WHERE  = ''

Write the Output of the Query to a UniversalDataWriter

1. Drag a UniversalDataWriter from the Writers selection onto the jobflow.
2. Double-click the UniversalDataWriter to open the configuration editor and add a file URL.
3. Right-click the DBInputTable and then click Extract Metadata.
4. Connect the output port of the DBInputTable to the UniversalDataWriter.
5. In the resulting Select Metadata menu for the UniversalDataWriter, choose the Invoices table. (You can also open this menu by right-clicking the input port for the UniversalDataWriter.)
6. Click Run to write to the file.