Connect to Square Data in RapidMiner

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

Connect to Square in RapidMiner as a JDBC Data Source

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

1. Add a new database driver for Square: 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:square:
4. Enter the path to the cdata.jdbc.square.jar file, located in the lib subfolder of the installation directory.
5. Enter the driver class: cdata.jdbc.square.SquareDriver
6. Create a new Square connection: Click Connections -> Manage Database Connections.
7. Enter a name for your connection.
8. For Database System, select the Square driver you configured previously.
9. Enter your connection string in the Host box.

   Square uses the OAuth authentication standard. To authenticate using OAuth, you will need to register an app with Square to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL. See the "Getting Started" chapter of the help documentation for a guide to using OAuth.

   Additionally, you must specify the LocationId. You can retrieve the Ids for your Locations by querying the Locations table. Alternatively, you can set the LocationId in the search criteria of your query.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Square JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   java -jar cdata.jdbc.square.jar

   Fill in the connection properties and copy the connection string to the clipboard.

   A typical connection string is below:

   OAuthClientId=MyAppId;OAuthClientSecret=MyAppSecret;CallbackURL=http://localhost:33333;LocationId=MyDefaultLocation;InitiateOAuth=GETANDREFRESH
10. Enter your username and password if necessary.

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