Previous Topic  Next Topic

Using the Exit Functions

When you run a report, Logi Report Engine accomplishes the display of the report, and you have no control over this. However, Logi Report enables you to interact with this mechanism at three points:

• After Logi Report initiates the parameter a report uses.
• At the point Logi Report Engine is about to run the report. If the report contains parameters, Logi Report Engine has initiated the parameters at this stage, and you have given the parameter values.
• Immediately after Logi Report Engine displays the report result.

At any or all of these three points, you have the option of executing a class of your choice. Logi Report develops three Exit functions for you: After Init Parameter, Before Run, and After Run. These functions enable you to develop an action that you want to call before, after, or during the process of running a report, and return a status to Logi Report Engine. If the returned status is true, Logi Report Engine goes on running; if false, Logi Report Engine stops at this point. This topic describes the properties and interfaces of the Exit functions, and how you can use the Exit functions.

This topic contains the following sections:

• Exit Function Properties
• Executive Interfaces of the Exit Functions
• Using the Exit Functions
  • Example 1: Using Parameters in the Exit Functions
  • Example 2: Using Formulas in the Exit Functions

Exit Function Properties

Open a report in Designer, then in the Report Inspector, select the node that represents the report tab and you can find the three Exit function properties: After Init Parameter, After Run, and Before Run.

• After Init Parameter
  Calls a program developed by yourself after you specify parameters for running the report.
• After Run
  Calls a program developed by yourself after running the report.
• Before Run
  Calls a program developed by yourself just before running the report.

For more information about the three properties, select here.

Executive Interfaces of the Exit Functions

Logi Report provides you with three interfaces to implement the Exit functions.

jet.util.JURLExecutor

This interface provides the following method:

• public boolean exec(String[] params) throws JURLExecuterException - Gets the status of Logi Report Engine.
  • Parameter
    params - Array of strings. You need to define and parse each element by yourself. You can specify the PARAMETERs in the Report Inspector. If you do not specify any PARAMETERs, params.length is zero.
  • Return
    Boolean value. If true, Logi Report Engine continues running; if false, Logi Report Engine stops at this point.

jet.util.JURLEngineExecutor

This interface provides the following method:

• public boolean exec(String[] params, EngineExecutor executor) throws JURLExecutorException - Gets the status of Logi Report Engine.
  • Parameter
    params - Array of strings. You need to define and parse each element by yourself. You can specify the PARAMETERs in the Report Inspector. If you do not specify any PARAMETERs, params.length is zero.
    executor - Executor of EngineExecutor, which is another interface Logi Report provides for exporting a report to HTML, TXT, or PDF within the Exit functions.
  • Return
    Boolean value. If true, Logi Report Engine continues running; if false, Logi Report Engine stops at this point.

jet.util.EngineExecutor

This interface provides three methods:

• public boolean exportToHtml(String htmlFileName, boolean bChartApplet, boolean isMultiFile, boolean bUsingTable, boolean bHyperlink, boolean bPageNum, boolean bAbsolute, int iBrowser) - Exports the report result to HTML.
  • Parameter
    HtmlFileName - Name of the HTML file with full path.
    bChartApplet - A Boolean value which specifies whether or not a chart in an HTML file is an applet. This parameter is deprecated and not recommended to use.
    isMultiFile - A Boolean value which specifies whether to generate the HTML output in one or multiple files.
    bUsingTable - A Boolean value which specifies whether or not to use the HTML table format for exporting HTML files.
    bHyperLink - A Boolean value which specifies whether or not to generate hyperlinks.
    bPageNum - A Boolean value which specifies whether or not to generate page number.
    bAbsolute - A Boolean value which specifies whether or not the font size is absolute or relative.
    iBrowser - An int value which specifies whether or not the web browser is IE.
  • Return
    Boolean value for exporting status. If true, the method exports the report successfully, and vice versa.
• public boolean exportToPdf(String pdfFileName) - Exports the report result to PDF.
  • Parameter
    PdfFileName - The name of the PDF output with a full path.
  • Return
    Boolean value for exporting status. If true, the method exports the report successfully, and vice versa.
• public boolean exportToText(String textFileName, boolean isNormalText, boolean isRepeat, char delimiter) - Exports the report result to text format.
  • Parameter
    TextFileName - Name of the text format result file with full path, where "true/false" sets whether or not the text file is of normal text format or of standard data format. A standard data format text file is a text file where each row represents a single record in a report. You can use it as a text data source for exchanging data with other applications.
    isNormalText - A Boolean value which specifies whether or not a text file is in normal text format.
    isRepeat - A Boolean value which specifies whether or not the contents are repeated.
    delimiter - A character which is be used in SDF (Standard Data Format). The method applies the delimiter only when the "true/false" parameter is set to false. Delimiters can be ',' (the CSV format) or any other character. The default is a blank, which is the SSV format.
  • Return
    Boolean value for exporting status. If true, the method exports the report successfully, and vice versa.

Using the Exit Functions

The following two examples show using the Exit functions to achieve specific goals.

Example 1: Using Parameters in the Exit Functions

In this example, we provide a simple application which runs at all the three points, Before Run, After Init Parameter, and After Run.

1. Develop your Java files to implement the methods. In the example, copy the following code and save it as testa.java to C:\(Undefined variable: Logi_Variables.LogiReport)\Designer\help (here it is assumed that you have installed your Designer to the default directory).

   import java.io.*;
   import java.awt.*;
   import java.net.*;
   import jet.util.*;
   
   public class testa implements JURLExecuter
   {
       public boolean exec(String[] params)
       {
           System.out.println("testa : ");
           for (int i = 0; i < params.length; i++)
    
           {
               System.out.print("\"" + params[i] + "\",");
           }
           System.out.println();
           return true;
       }
   }

2. Compile testa.java to generate the class file testa.class in C:\(Undefined variable: Logi_Variables.LogiReport)\Designer\help.
3. Modify the batch file setenv.bat in C:\(Undefined variable: Logi_Variables.LogiReport)\Designer\bin by appending the path C:\(Undefined variable: Logi_Variables.LogiReport)\Designer\help into the batch file's ADDCLASSPATH variable:

   set ADDCLASSPATH=%JAVAHOME%\lib\tools.jar;C:\(Undefined variable: Logi_Variables.LogiReport)\Designer\help;

4. Start Designer.
5. Open a report with parameter.
6. In the Report Inspector, select the node that represents the report tab and specify the class and give parameters for the three functions, for example:

   

   JURL:/ - The standard format, and followed by the class name.
   testa - The class name in this example.
   aa;bb;cc and 123;234;345 - The string type parameters of the class, which are divided by semicolons.
   Param - A predefined Logi Report parameter used in the current report, which is introduced by the "@" symbol.

   As shown above, Designer supports two types of the Exit function parameters. They are:

   • String type parameters, such as "aa" and "C:\". In this case, Designer passes the string directly to the Exit function.
   • Logi Report predefined parameters used in the current report, which are introduced by the "@" symbol. In this case, Designer passes the parameter to the Exit function.
7. Run the report, Logi Report Engine calls the class that you specify in the Report Inspector.

Example 2: Using Formulas in the Exit Functions

You can use formulas in the Exit functions. To do this, you need to use the Data Container Link feature which can return value of any formula to a parameter. Using the parameter in the Exit functions, you can get the value of the formula in the Exit functions.

1. Create a formula and insert it into a report. You should place the formula in the child data component.
2. Create a parameter with the same data type as the formula, leaving other options blank, and then insert it into the parent data component.
3. Right-click the parent data component and select Data Container Link on the shortcut menu.
4. In the Data Container Link dialog box, select the Return Value tab, add the formula in the Fields in Child Data Container box to the Return Value box, then select OK.

   Now, you have finished passing value of the formula to a parameter.

5. Use this parameter in the Exit functions with the method described in Example 1. Designer then returns the final value of the formula in the Exit functions.

• When you use a Logi Report parameter as the parameter of the Before Run function, the function returns no Logi Report parameter value, instead, the return value is the Logi Report parameter name with the "@" symbol.
• If you want to use Logi Report parameters as the Exit function parameters, you must use them in a report; otherwise, the function returns no value.
• When you want to publish a report that applies the Exit functions to Server and run it there, you should publish both the report and the catalog file to Server. In addition, you should add the path to the -classpath option in the batch file that starts Server.
• You can also apply formulas in the Exit functions by using returning values in subreports. In this case, you need to pass value of a formula in the subreport to a parameter in the primary report.

Previous Topic  Next Topic