Connect to Perigon Data in RapidMiner

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

Connect to Perigon in RapidMiner as a JDBC Data Source

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

1. Add a new database driver for Perigon: 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 Perigon connection: Click Connections -> Manage Database Connections.
7. Enter a name for your connection.
8. For Database System, select the Perigon driver you configured previously.
9. Enter your connection string in the Host box.

   Using API Key Authentication

   To use the Perigon API, you need to obtain an API key from your Perigon account. Navigate to the Perigon dashboard and generate an API key from your account settings.

   After setting the following connection properties, you are ready to connect:

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your Perigon API key.

   Example connection string:

   Profile=C:\profiles\Perigon.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key"
   

   Available Tables

   The Perigon profile provides access to the following tables:

   • Articles - News articles retrieved from the Perigon news intelligence API
   • Headlines - Story clusters grouping related headline articles
   • Sources - News sources tracked by the Perigon news intelligence API
   • Journalists - Journalist profiles tracked by the Perigon news intelligence API

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Perigon 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\Perigon.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key"
   

10. Enter your username and password if necessary.

You can now use your Perigon connection with the various RapidMiner operators in your process. To retrieve Perigon 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 Perigon data.