Previous Topic  Next Topic

Importing Parameter Values

When you view a report with parameters, the Enter Parameter Values dialog will be displayed, showing the parameters the report uses for you to input values. The default values shown in the dialog are fixed at development time. However, showing a default, fixed value often is not useful to users.

Logi JReport provides an interface for importing different default values from an outside class file so that the default values can be specified flexibly. There is only one method for this interface: public Hashtable promptValues(String paramsName[]);

The following are the general steps for importing parameter values from a class file:

1. Define a Java class file. For help, see the sample program ParamTest.java and TestParamList.java in <install_root>\help\samples\APIParameter. To import parameter values, implement the interface jet.util.ImportParamValues in your Java file. The class definition may be as follows:

   package help.; import java.util.*; import jet.util.*; public class ParamTest implements ImportParamValues { public ParamTest() { //Class body } public Hashtable promptValues(String paramsName[]) { //Class body } }

   The following explains the code:

   • The package name can be defined by yourself. In our sample code, we use help as the package name.
   • Since the interface ImportParamValues is in the package jet.util, you will have to import the class package jet.util.*.
   • A public constructor method without parameters is required.
2. Compile the Java file to generate the class file.
3. Append the class path to the ADDCLASSPATH variable of the file setenv.bat/setenv.sh in <install_root>\bin for both Logi JReport Designer and Logi JReport Server.
4. Start Logi JReport Designer with the modified batch file.
5. Open the report with the parameter value that you want to import.
6. In the Report Inspector, set the property Import Parameter Values of the report to be the class name that you just generated with the package name, and set Parameter List Auto to false.

The following two examples explain how to import parameter values and what you should be aware of while using this feature.

Example 1: Importing from a database

Example 2: Importing from a class file

Example 1: Importing from a database

In the sample program ParamTest.java in <install_root>\help\samples\APIParameter, different values were assigned to the parameter p_StartDate by accessing values from an HSQL database. In addition, the sample report CustomerAnalysis.cls uses this parameter in the query condition. So here, we use this demo report as an example to explain how to import parameter values from a database, so that you do not need to type in the values one by one while specifying the parameter default value (note that in this example we assume your Logi JReport Designer is installed in the default path, that is C:\Logi JReport\Designer).

Note that in the sample ParamTest.java, we use the method compareToIgnoreCase() to compare the parameter name in the class file with the one in your report. This method is not case sensitive when performing the comparison.

1. Compile ParamTest.java to generate ParamTest.class, and store the class file in C:\Logi JReport\Designer\help.
   
   javac -classpath c:\Logi JReport\Designer\lib\JREngine.jar; ParamTest.java
   
2. Append C:\Logi JReport\Designer\help to the ADDCLASSPATH variable of setenv.bat in C:\Logi JReport\Designer\bin.
3. Start Logi JReport Designer and open CustomerAnalysis.cls.
4. In the Report Inspector, find the report property Import Parameter Values, and input the class name with the full package name. In this example, input help.ParamTest, and then set the property Parameter List Auto to false.

   Tip: The report node is not shown in the resource tree of the Report Inspector by default. To have it shown, select the report tab node in the tree (in this example, the CustomerAnalysis node), and then select the Up button on the Report Inspector toolbar.

5. Save the report and catalog, and then view the report result.
6. In the Enter Parameter Values dialog, select the drop-down list of the parameter. You will find that all the values you specified in ParamTest.java have been imported into the list.
7. Select one of the values with which to view the report.
8. Publish the saved report CustomerAnalysis.cls to Logi JReport Server (for details, see Publishing resources remotely).
9. Append C:\Logi JReport\Designer\help to the ADDCLASSPATH variable of setenv.bat in <server_install_root>\bin.
10. Start Logi JReport Server with the modified batch file.
11. Load your web browser to access the Logi JReport Server Console Page. You will then have the same parameter values as you did in Logi JReport Designer.

Example 2: Importing from a class file

In addition to Example 1, another example of applying the feature of importing parameter values is to specify your required default values. When you group/sort data dynamically with a parameter, when viewing the report, a dialog will be displayed, in which you will find many default values in the drop-down list. However, since you do not need so many values with which to group/sort, you can specify your required default values in a Java class, and then import them. For help, refer to the sample program TestParamList.java in <install_root>\help\samples\APIParameter.

To specify the default parameter values in a class file and then import them, follow the steps below:

1. Compile TestParamList.java to generate TestParamList.class, and store the class file in <install_root>\help.
2. Append <install_root> to the ADDCLASSPATH variable of setenv.bat in <install_root>\bin.
3. Start Logi JReport Designer.
4. Create a report with a dynamic group/sort using the parameter ImportPara (for details, see Grouping data dynamically and Sorting data dynamically).
5. Set the report property Parameter List Auto to true in the Report Inspector, and view the report. Many values will be listed in the Enter Parameter Values dialog.
6. Set Parameter List Auto to false, Import Parameter Value to TestParamList, and view the report again. You will now see that only four values are displayed as defined in TestParamList.java.

Previous Topic  Next Topic