VOOZH about

URL: https://www.cdata.com/kb/tech/aha-jdbc-rapidminer.rst

โ‡ฑ Connect to Aha! Data in RapidMiner


Connect to Aha! Data in RapidMiner

๐Ÿ‘ Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Integrate Aha! data with standard components and data source configuration wizards in RapidMiner Studio.

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

Connect to Aha! in RapidMiner as a JDBC Data Source

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

  1. Add a new database driver for Aha!: 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
    
    ๐Ÿ‘ The JDBC driver configuration. (Salesforce is shown.)
  6. Create a new Aha! connection: Click Connections -> Manage Database Connections.
  7. Enter a name for your connection.
  8. For Database System, select the Aha! driver you configured previously.
  9. Enter your connection string in the Host box.

    Start by setting the Profile connection property to the location of the Aha! Profile on disk (e.g. C:\profiles\aha.apip). Next, set the ProfileSettings connection property to the connection string for Aha! (see below).

    Aha! API Profile Settings

    The Aha! API uses OAuth-based authentication.

    You will first need to register an OAuth app with Aha!. This can be done from your Aha! account under 'Settings' > 'Personal' > 'Developer' > 'OAuth Applications'. Additionally, set the Domain, found in the domain name of your Aha account. For example if your Aha account is acmeinc.aha.io, then the Domain should be 'acmeinc'.

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

    • AuthScheme: Set this to OAuth.
    • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
    • OAuthClientId: Set this to the client_id that is specified in you app settings.
    • OAuthClientSecret: Set this to the client_secret that is specified in you app settings.
    • CallbackURL: Set this to the Redirect URI you specified in your app settings.
    • Domain: Set this in the ProfileSettings to your Aha domain.

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the Aha! 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.

    ๐Ÿ‘ Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

    A typical connection string is below:

    Profile=C:\profiles\aha.apip;ProfileSettings='Domain=acmeinc';Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
    
  10. Enter your username and password if necessary. ๐Ÿ‘ The connection to the JDBC data source. (Salesforce is shown.)

You can now use your Aha! connection with the various RapidMiner operators in your process. To retrieve Aha! data, drag the Retrieve operator from the Operators view. ๐Ÿ‘ A Retrieve operation to select data. (Salesforce is shown.)
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.

๐Ÿ‘ The Repository Browser window you can use to select an example set. (Salesforce is shown.)

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

๐Ÿ‘ The results of the Retrieve operation. (Salesforce is shown.)