Connect to DeTrack Data in RapidMiner
This article shows how you can easily integrate the CData JDBC driver for DeTrack into your processes in RapidMiner. This article uses the CData JDBC Driver for DeTrack to transfer DeTrack data to a process in RapidMiner.
Connect to DeTrack in RapidMiner as a JDBC Data Source
You can follow the procedure below to establish a JDBC connection to DeTrack:
- Add a new database driver for DeTrack: Click Connections -> Manage Database Drivers.
- In the resulting wizard, click the Add button and enter a name for the connection.
- Enter the prefix for the JDBC URL:
jdbc:api: - Enter the path to the cdata.jdbc.api.jar file, located in the lib subfolder of the installation directory.
- Enter the driver class:
cdata.jdbc.api.APIDriver
- Create a new DeTrack connection: Click Connections -> Manage Database Connections.
- Enter a name for your connection.
- For Database System, select the DeTrack driver you configured previously.
- Enter your connection string in the Host box.
Start by setting the Profile connection property to the location of the DeTrack Profile on disk (e.g. C:\profiles\DeTrack.apip). Next, set the ProfileSettings connection property to the connection string for DeTrack (see below).
DeTrack API Profile Settings
DeTrack uses API Key authentication. Your DeTrack API key is used to authenticate all requests via the X-API-Key header. You can obtain your API key from your DeTrack account settings at app.detrack.com under Settings > API & Webhooks.
After setting the following connection properties, you are ready to connect:
- AuthScheme: Set this to APIKey.
- APIKey: Set this to your DeTrack API key.
Built-in Connection String Designer
For assistance in constructing the JDBC URL, use the connection string designer built into the DeTrack JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.
java -jar cdata.jdbc.api.jarFill in the connection properties and copy the connection string to the clipboard.
A typical connection string is below:
Profile=C:\profiles\DeTrack.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key'; - Enter your username and password if necessary.
You can now use your DeTrack connection with the various RapidMiner operators in your process. To retrieve DeTrack 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 DeTrack data.