Connect to Workable Data in CloverDX (formerly CloverETL)

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

Connect to Workable as a JDBC Data Source

1. Create the connection to Workable 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.

   Using API Key Authentication

   Workable uses API key authentication to control access to the API. To obtain an API Key:

   1. Log in to your Workable account.
   2. Navigate to Settings > Integrations > API Access Tokens.
   3. Click "Generate API Token".
   4. Copy the generated token.

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

   • AuthScheme: Set this to APIKey.
   Set the following in the ProfileSettings connection property:
   • APIKey: Set this to your Workable API Key.
   • Subdomain: Set this to your Workable account subdomain. For example, if your Workable URL is acmeinc.workable.com, then the Subdomain is 'acmeinc'.

   Example Connection String

   Profile=C:\profiles\Workable.apip;ProfileSettings='AuthScheme=APIKey;APIKey=my_api_key;Subdomain=acmeinc';
   

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Workable 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\Workable.apip;ProfileSettings='AuthScheme=APIKey;APIKey=my_api_key;Subdomain=acmeinc';

Query Workable 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 Workable JDBC data source from the drop-down menu.
3. Enter the SQL query. For example:

   SELECT ,  FROM Accounts 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 Accounts table. (You can also open this menu by right-clicking the input port for the UniversalDataWriter.)
6. Click Run to write to the file.