Cached Query Results

By default, when you run a report, JReport Engine fetches data from the database using the JDBC driver. For reports that are built on queries (and also business views, imported SQL files, stored procedures and user defined data sources), JReport Designer enables you to create cached result files and save them somewhere in your machine. Then, when you view these reports, you can choose to use the data from the cached query result file as opposed to the database. This is very useful for working on the design of a report while you are off-line and do not have a DBMS connection. Also, it is helpful when you have problems with your reports and need to send the reports with data resources to Logi Analytics for reproducing the problems.

Creating cached query results

JReport Designer provides you with two ways to create cached query results, the first is with the Catalog Manager and the second is with the Data panel.

Creating a cached query result file in the Catalog Manager

In the Catalog Manager, select the query for which you intend to create the cached query result file.
Right-click the query, and select Create Cached Query Result from the shortcut menu.
In the Save Cached Query Result dialog, specify the file name with or without an extension and the folder where you want to save the result file. It is recommended to use an extension such as .cqr to help you identify the files. JReport does not provide a default extension.
Click Save and the cached query result file will be saved to the specified folder.

Creating a cached query result file in the Data panel

In the Data panel, right-click the query on which the report is built and select Create Cached Query Result from the shortcut menu.
In the Save Cached Query Result dialog, specify the file name with or without an extension and the folder where you want to save the result file and then click Save.

Applying cached query results

To make a library component or a page report created using query resources run using cached query result, you can set the Data Driver property on the dataset appropriately in the Report Inspector. You can specify the property value by inputting manually or selecting a predefined data source driver from the drop-down list.

The input format is as follows: jrquery:/jet.universe.resultfile.UResultFileResultSet;Fullpath_of_cached_query_result

For example, if the cached query result has been saved to C:\JReport\Designer\Cached with the file name test, the property value should be jrquery:/jet.universe.resultfile.UResultFileResultSet;C:\JReport\Designer\Cached\test.

However, the Data Driver property is not available to web reports or page reports that are created based on business views. In order to apply cached query result to them, you can check the option Use cached query result in the Catalog category of the Options dialog. Then whenever you view a report in JReport Designer, a dialog will prompt you to choose a cached query result to run the report.

Generating data source drivers for cached query results

When specifying the Data Driver property for a dataset, you may find it inconvenient to input a property value that is long and complicated. To help you with this, JReport Designer provides a tool for generating data source drivers for cached query results. Then the generated drivers will be available on the Data Driver drop-down list for selection.

Assume that a cached query result file orderstat_cached has been created for the query OrderStat in the catalog file SampleReports.cat and saved in C:\JReport\Designer\Cached. To create a data source driver for the cached query result, follow the steps below:

Make sure SampleReports.cat is the currently open catalog file. If not click File > Open Catalog to open it from <install_root>\Demo\Reports\SampleReports.

In the Catalog Manager, click Data Source Drivers on the toolbar. The Data Source Drivers dialog appears.

Data Source Drivers dialog

All the added drivers will be listed in the Data Source Drivers box. If you want to remove a driver, select the driver and click the Remove button. To edit a driver, select the driver and click the Edit button.

Click the New button, and the Data Source Editor appears.

Data Source Editor

Enter a name for the driver in the Driver Name box. Here, we name it OrderStat.

Check the URL radio button and input the URL as follows:

jrquery:/jet.universe.resultfile.UResultFileResultSet;Fullpath_of_cached_query_result

In the example, the URL is jrquery:/jet.universe.resultfile.UResultFileResultSet;C:\JReport\Designer\Cached\orderstat_cached

Note: If you check the Driver radio button to specify the driver, you will need to input the class name and parameter of the driver as follows:

Class Name: jet.universe.resultfile.UResultFileResultSet
Parameter: Full path of the cached query result (C:\JReport\Designer\Cached\orderstat_cached in this example)

Then, a URL will be generated according to your input information.

Click OK to add the driver.

Click OK in the Data Source Drivers dialog to close it.

Now you can choose the driver from the Data Driver property's drop-down list directly without inputting the long value manually.