We are proud to share our inclusion in the 2024 Gartner Magic Quadrant for Data Integration Tools. We believe this recognition reflects the differentiated business outcomes CData delivers to our customers.
Get the Report →Design BIRT Reports on Square Data
Provide current Square data to your embedded analytics.
The CData JDBC Driver for Square integrates connectivity to Square APIs into your data-driven Java applications. You can use the CData JDBC Driver for Square with the BIRT (Business Intelligence Reporting Tools) platform to create BIRT reports that reflect changes to your data in real time.
- If you have not already done so, install the BIRT Framework plugin and the Database Development plugin for Eclipse.
- Click File -> New -> Report. The Report Design perspective is opened.
- In the Data Explorer, right-click Data Sources and click New Data Source.
- Select the Create from a Data Source Type in the Following List option and select JDBC Data Source.
- Click Manage Drivers and add the driver JAR, located in the lib subfolder of the installation folder.
- In the Database URL box, enter the JDBC URL containing the connection string.
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.
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
- Right-click the Data Sets folder and select the JDBC data source for Square.
- In the resulting dialog, build the SELECT query to be used to retrieve the data for the report. This article uses the following query:
SELECT Reason, RefundedMoneyAmount FROM Refunds
- In the Palette, drag a Chart onto the editor. The chart wizard is displayed.
- After selecting the chart type, drag columns onto the chart fields on the Select Data tab.
- Click Run -> View Report -> In Web Viewer to view the report.
Your BIRT reports can now pick up any updates to Square data.
To publish the report to your application server, add the driver JAR to the BIRT Viewer's classpath. For more information, see the CData KB for guides to deploying the JDBC Driver on Java application servers.