Connect to Workable Data in RapidMiner

This article shows how you can easily integrate the CData JDBC driver for Workable into your processes in RapidMiner. This article uses the CData JDBC Driver for Workable to transfer Workable data to a process in RapidMiner.

Connect to Workable in RapidMiner as a JDBC Data Source

You can follow the procedure below to establish a JDBC connection to Workable:

1. Add a new database driver for Workable: Click Connections -> Manage Database Drivers.
2. In the resulting wizard, click the Add button and enter a name for the connection.
3. Enter the prefix for the JDBC URL:

   jdbc:api:
   

4. Enter the path to the cdata.jdbc.api.jar file, located in the lib subfolder of the installation directory.
5. Enter the driver class:

   cdata.jdbc.api.APIDriver
   

   
6. Create a new Workable connection: Click Connections -> Manage Database Connections.
7. Enter a name for your connection.
8. For Database System, select the Workable driver you configured previously.
9. Enter your connection string in the Host box.

   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 connection string is below:

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

10. Enter your username and password if necessary.

You can now use your Workable connection with the various RapidMiner operators in your process. To retrieve Workable data, drag the Retrieve operator from the Operators view. With the Retrieve operator selected, you can then define which table to retrieve in the Parameters view by clicking the folder icon next to the "repository entry." In the resulting Repository Browser, you can expand your connection node to select the desired example set.

Finally, wire the output to the Retrieve process to a result, and run the process to see the Workable data.