Design BIRT Reports on Reckon Accounts Hosted Data

The CData JDBC Driver for Reckon Accounts Hosted integrates connectivity to Reckon Accounts Hosted APIs into your data-driven Java applications. You can use the CData JDBC Driver for Reckon Accounts Hosted with the BIRT (Business Intelligence Reporting Tools) platform to create BIRT reports that reflect changes to your data in real time.

1. If you have not already done so, install the BIRT Framework plugin and the Database Development plugin for Eclipse.
2. Click File -> New -> Report. The Report Design perspective is opened.
3. In the Data Explorer, right-click Data Sources and click New Data Source.
4. Select the Create from a Data Source Type in the Following List option and select JDBC Data Source.
5. Click Manage Drivers and add the driver JAR, located in the lib subfolder of the installation folder.
6. In the Database URL box, enter the JDBC URL containing the connection string.

   The connector makes requests to Reckon Accounts Hosted through OAuth. Specify the following connection properties:

   • SubscriptionKey: Required. You get this value when you created your developer account.
   • CountryVersion: Defaults to 2021.R2.AU.
   • CompanyFile: Required. The path to the company file.
   • User: Required. The username of the company file.
   • Password: Required. The password of the company file.
   • InitiateOAuth: Set this to GETANDREFRESH to let the driver handle access tokens.
   • CallbackURL: The redirectURI of your Custom OAuth App.
   • OAuthClientId: The client id of your Custom OAuth App.
   • OAuthClientSecret: The client secret of your Custom OAuth App.

   CData provides an embedded OAuth application that simplifies OAuth desktop authentication. See the Help documentation for information on other OAuth authentication methods (web, headless, etc.), creating custom OAuth applications, and reasons for doing so.

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.reckonaccountshosted.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:reckonaccountshosted:SubscriptionKey=my_subscription_key;CountryVersion=2021.R2.AU;CompanyFile=Q:/CompanyName.QBW;User=my_user;Password=my_password;CallbackURL=http://localhost:33333;OAuthClientId=my_oauth_client_id;OAuthClientSecret=my_oauth_client_secret;InitiateOAuth=GETANDREFRESH
7. Right-click the Data Sets folder and select the JDBC data source for Reckon Accounts Hosted.
8. 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 Name, Balance FROM Accounts WHERE IsActive = 'true'
9. In the Palette, drag a Chart onto the editor. The chart wizard is displayed.
10. After selecting the chart type, drag columns onto the chart fields on the Select Data tab.
11. Click Run -> View Report -> In Web Viewer to view the report.

Your BIRT reports can now pick up any updates to Reckon Accounts Hosted 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.