Feed Square Data into FineReport

The CData JDBC Driver for Square fully implements the JDBC standard and can provide Square data connectivity to a wide variety of BI, reporting, and ETL tools and custom applications. In this article, we explain how to set Square data as JDBC data source in FineReport and view Square data as a table in the Report Designer.

Set Up a JDBC Data Source of Square Data

Follow the instruction below to set Square data as a FineReport database connection.

1. Copy the cdata.jdbc.square.jar file from the lib folder in the CData JDBC Driver for Square installation directory to the lib folder of the FineReport installation directory. You will need to copy the cdata.jdbc.square.lic file as well.
2. From the Server tab, select Define Data Connection, click to add a new connection, and click JDBC.
👁 FineReport Server Tab (Salesforce is shown.)

Next we will set up the data connection definition in the window.

1. Database: Others
2. JDBC Driver: cdata.jdbc.square.SquareDriver
3. URL: A standard JDBC connection string using semicolon-separated connection properties.

   Square uses the OAuth authentication standard. To authenticate using OAuth, 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.

   👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
   

   When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

   A typical JDBC URL is below:

    jdbc:square:OAuthClientId=MyAppId;OAuthClientSecret=MyAppSecret;CallbackURL=http://localhost:33333;LocationId=MyDefaultLocation;InitiateOAuth=GETANDREFRESH;
    

👁 FineReport data connection definition window (Salesforce is shown.)

4. Click Connection pool attributes and set Test before getting connections to No.
👁 FineReport connection pool (Salesforce is shown.)

Click Test connection to ensure you have configured the connection properly. With the connection to Square set up, you can use it as FineReport data source.

Select Square Data in the Report Designer.

1. Click to add a new template data set and select DB query to open the database query window.
👁 Adding a new DB query.

2. Choose the JDBC connection that you created from the dropdown list.
3. The Square entities will appear as tables on the left pane.
4. Write a SELECT statement for the Square data tables and columns that you want to load.
👁 FineReport database query (Salesforce is shown.)

5. Click preview and data is shown as table.
👁 FineReport database query preview (Salesforce is shown.)

With these simple steps, Square can be used as a JDBC data source in FineReport.