Ready to get started?

Learn more about Sage US Connectivity Solutions

Learn More

Create Sage US Reports on JasperReports Server

Deploy the CData JDBC Driver on JasperReports Server to provide real-time Sage US data access from reports, embedded analytics, and more.

The CData JDBC Driver for Sage US enables you to provide access to Sage US data across the enterprise. This article shows how to deploy the driver on JasperReports server and create a simple report based on a reporting domain, a business view of Sage US data.

Deploy the Driver JAR

Follow the steps below to deploy the driver JAR on JasperReports Server. The instructions below contain specifics for Sage US and the Tomcat server bundled with JasperReports Server. If you are using JBoss AS 7 instead of Tomcat, you can follow the standard process to deploy the Sage US JDBC Driver on JBoss.

  1. Copy the driver JAR and .lic file, located in the lib subfolder of the installation directory, to the lib subfolder of the apache-tomcat folder, located in the JasperReports Server installation directory.
  2. Navigate to apache-tomcat -> webapps -> jasperserver-pro -> META-INF and add the following resource entry to the context.xml file:

    <Resource name="jdbc/sage50us" auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.sage50us.Sage50USDriver" url="jdbc:sage50us:ApplicationId=8dfafu4V4ODmh1fM0xx;CompanyName=Bellwether Garden Supply - Premium;" maxActive="20" maxIdle="10" maxWait="-1" factory="com.jaspersoft.jasperserver.tomcat.jndi.JSCommonsBasicDataSourceFactory"/>

    Specify the required connection properties in the JDBC URL -- the url attribute.

    The Application Id and Company Name connection string options are required to connect to Sage as a data source. You can obtain an Application Id by contacting Sage directly to request access to the Sage 50 SDK.

    Sage must be installed on the machine. The Sage.Peachtree.API.dll and Sage.Peachtree.API.Resolver.dll assemblies are required. These assemblies are installed with Sage in C:\Program Files\Sage\Peachtree\API\. Additionally, the Sage SDK requires .NET Framework 4.0 and is only compatible with 32-bit applications. To use the Sage SDK in Visual Studio, set the Platform Target property to "x86" in Project -> Properties -> Build.

    You must authorize the application to access company data: To authorize your application to access Sage, restart the Sage application, open the company you want to access, and connect with your application. You will then be prompted to set access permissions for the application in the resulting dialog.

    While the compiled executable will require authorization only once, during development you may need to follow this process to reauthorize a new build. To avoid restarting the Sage application when developing with Visual Studio, click Build -> Configuration Manager and uncheck "Build" for your project.

    Built-in Connection String Designer

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

    java -jar cdata.jdbc.sage50us.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.

  3. Navigate to jasperserver-pro -> WEB-INF and add the following reference to the web.xml file: Sage US data JSP jdbc/sage50us javax.sql.DataSource Container
  4. Restart the server.

Create the Sage US JDBC Data Source

Follow the steps below to map the Sage US JDBC driver to a JDBC data source:

  1. Log into JasperReports Server and click Create -> Data Source.
  2. In the Type menu, select JNDI Data Source.
  3. In the Service Name box, enter the JDNI lookup defined in the resource definition in the web.xml file. In the example, the lookup is "jdbc/sage50us".
  4. Click Save to create the Data Source.

Create a Domain

A domain is a metadata and access-control layer that surfaces a relevant business view to report creators. Follow the steps below to select Sage US columns, apply filters, and execute SQL to create a domain.

  1. Click Create -> Domain. Enter an Id for the domain and select a save location.
  2. Click Browse in the Data Source section and select the Sage US data source you created.
  3. In the Domain Design section, click Create with Domain Designer.
  4. Select the schema containing your tables.
  5. On the Tables tab, select a table in the Data Source pane and then click the arrow to add them to the Selected Tables pane.
  6. On the Derived Tables tab, you can define domains based on SQL queries. For example,
      SELECT Name, LastInvoiceAmount FROM Customer
      
  7. On the Joins tab, you can join tables by selecting the columns you want to build the join condition and selecting the join type.
  8. On the Pre-Filters tab, drag and drop columns to define search criteria that filters the data exposed through the domain.
  9. On the Display tab, select Sage US data into the data sets presented to the user.
  10. Click OK to accept your changes and click Submit to create the domain.

Explore Data in Real Time

After you have created a domain, you are ready to connect to data. Follow the steps below to create an Ad Hoc View in the Ad Hoc Editor.

  1. Click Create -> Ad Hoc View.
  2. In the resulting dialog, select the Sage US domain you created.
  3. On the Choose Data page, select columns that you want to use in the view. In the Pre-Filters section, you can create filters based on the selected fields. In the Display section, you can modify column information as presented by the domain.
  4. After completing the wizard, select the view type and add columns to the view. JasperSoft uses the metadata of the driver to detect the available dimensions and measures, based on the data type. Drag dimensions and measures onto the Columns and Rows boxes. Right-click a measure to change the summary calculation. Drag the Columns slider to the the desired data level in the Filters section.
  5. To access updates to the data as you design the view, change the menu selection from Sample Data to Full Data in the design mode toolbar. As you make changes, JasperSoft Server executes the underlying SQL queries to the driver.
  6. Save the view.

Create a Real-Time Report

You can now create reports hosted on JasperSoft Server. To do so from the Ad Hoc Editor, click Save Ad Hoc View and click Create Report.