JReport Enterprise Viewer for JREntServer Manual

Transcription

1 JReport Enterprise Viewer for JREntServer Manual

2 Table of Contents Installing and Launching JReport Enterprise Viewer...1 Installing JReport Enterprise Viewer...1 Installing on Windows...1 Installing on UNIX...1 Launching JReport Enterprise Viewer...2 Launching on Windows...2 Launching on Unix...4 JReport Enterprise Viewer Interface...7 Graphic Interface...7 Menu...7 File...7 View...8 Help...8 Address & Tools Bars...8 Tab Area...8 Explorer...8 Schedule...9 Active...10 Completed...11 Viewing Reports with JReport Enterprise Viewer...12 Introduction...12 Viewing Reports Locally...12 Viewing Reports Remotely...13 Case 1: When JReport Enterprise Server is running as an independent web server...13 Case 2: When JReport Enterprise Server is running as a servlet...15 Scheduling with JReport Enterprise Viewer...17 Introduction...17 Publishing Reports to the Versioning System...17 Publishing Reports to the File System...20 Defining Value based Triggers...21 Publishing Reports to a Printer...22 Publishing Reports to Rpt Task...23 Publish to Fax...23 Publishing Reports to E mail...26 Shortcut Menus on the Explorer Tab...27 Introduction...27 Shortcut Menu for the Resource Folder Panel...27 Properties...27 Deploy...29 Delete...29 Shortcut Menus for the Reports in Folder Panel...29 Run...30 AdvancedRun...30 New Schedule...30 Versions...30 Properties...33 JReport Client API...36 Introduction...36 Installation...36 Packages...36 Package jet.client.api...36 I

3 Table of Contents Package jet.client.api.gui...37 Illustrative Examples for Using Client API...37 Example 1: ResultVersionView.java...38 Example 2: ScheduleDemo.java...41 JReport Viewer Dialogs...44 Connection Dialog...44 New Schedule Dialog...45 Report Tab...45 Task&Time Tab...47 Notification Tab...49 Advance Run Dialog...50 Report Tab...50 Edit Archive Tab...51 Application Association Dialog...53 Viewing Results on Local Computer...53 Viewing Results on Server...54 Options Dialog...54 Select Directory Dialog...56 Deployment Settings Dialog...57 II

4 Installing and Launching JReport Enterprise Viewer Installing JReport Enterprise Viewer Installing on Windows Please follow the steps listed below to install JReport Enterprise Viewer: 1. Download the JReport Enterprise Viewer install program EntViewSetup.exe from the Jinfonet web site: 2. Run EntViewSetup.exe. JReport Enterprise Viewer Installer program will search for a suitable JVM to load the InstallShield wizard. If no suitable JVM is found, the installation process will be terminated. You can run the setup again by using the option is:javahome <JAVA HOME DIR>. 3. Welcome Screen Once the InstallShield is successfully loaded, the Welcome screen will appear. Click Next to continue. 4. EULA Screen Read the End User License Agreement carefully, click I accept the terms of the license agreement, and then click Next. The installation process will not continue unless you accept all the terms stated in the EULA. 5. Select JDK Screen Select the JDK version with which JReport Enterprise Viewer will be installed. The selected JDK will be used to execute JReport Enterprise Viewer. The InstallShield collects and lists all the available JDK versions installed on your machine, you can highlight to select one of the JDK versions from the list. Click Next to continue. Note: The InstallShield doesn't list JRE versions found on your machine, and the lowest JDK version we support is 1.3, please use v1.3 or above. 6. Specify Install Location Provide the absolute path where to install JReport Enterprise Viewer. Click Browse to navigate to the destination folder. Click Next to continue. 7. Add Additional Classpaths A class path is necessary when using a JDBC driver or User Defined Object. A class path is composed of a file path plus a zip file, jar file, or directory path, for example, C:\jdk1.3\lib\tools.jar. If you want to add additional classpaths, check the Add additional classpaths to locate external system components option. Type the class path in the Select additional class paths field, you can also click the Select button to locate the class file. Click Add to add the selected class paths to the class path list. Click Delete to delete the selected class path from the class path list. Click Next, the InstallShield will start to install JReport Enterprise Viewer. 8. Information Screen Read the information and click Finish to dismiss the InstallShield wizard. Installing on UNIX 1. Download JReport Enterprise Viewer installation file for UNIX EntViewSetup.sh from our Web site at 1

5 Installing and Launching JReport Enterprise Viewer 2. Execute the installation of the executable file EntViewSetup.sh to launch the InstallShield wizard. Start it from a console. The dollar symbol($) in the following commands is supposed to be the prompt string and should not be copied. Open a console window. Change the current directory to the one where EntViewSetup.sh is located. Typically the command shown is similar to $ cd thepath. To make EntViewSetup.sh executable, type the command $ chmod +x EntViewSetup.sh. To run EntViewSetup.sh, use the command $ sh./entviewsetup.sh. After you execute the EntViewSetup.sh file, JReport Enterprise Viewer Installer program will search for a suitable JVM to load the InstallShield wizard. If no suitable JVM is found, the installation process will be terminated. You can run the setup again by using the option is:javahome <JAVA HOME DIR>. 3. Welcome Screen Once the InstallShield is successfully loaded, the Welcome screen will appear. Click Next to continue. 4. EULA Screen Read the End User License Agreement carefully, select I accept the terms of the license agreement, and then click Next. The installation process will not continue unless you accept all the terms stated in the EULA. 5. Specify Install Location Provide the absolute path where to install JReport Enterprise Viewer. Click Browse to navigate to the destination folder. Click Next to continue. 6. Add Additional Classpaths A class path is necessary when using a JDBC driver or User Defined Object. A class path is composed of a file path plus a zip file, jar file, or directory path, for example, /usr/jdk1.3/lib/tools.jar. If you want to add additional classpaths, check the Add additional classpaths to locate external system components option. Type the class path in the Select additional class paths field, you can also click the Select button to locate the class file. Click Add to add the selected class paths to the class path list. Click Delete to delete the selected class path from the class path list. Click Next, the InstallShield will start to install JReport Enterprise Viewer. 7. Information Screen Read the information and click Finish to dismiss the InstallShield wizard. Launching JReport Enterprise Viewer Launching on Windows You can start JReport Enterprise Viewer on Windows with either command line or batch files. Starting JReport Enterprise Viewer from the Command Line jet.client.ui.jrviewer is the class to start JReport Enterprise Viewer. Use the following command: java classpath <classpath> Dreporthome=<reporthome> jet.client.ui.jrviewer [options] Where 2

6 Installing and Launching JReport Enterprise Viewer Examples: <reporthome> Location of where your JReport Enterprise Viewer is installed. classpath The classpath must include the following packages originally in your <install_root>\lib: C:\JREntViewer\lib\JREntViewer.zip [options] help: Print out this message. vdebug: Enable output debug message. verror: Enable output error message. log[:<file>]: Output message to.\jrviewer.log or.\<file>. server<server URL >: Indicate JReport Server URL address. report<report URL >: Indicate the report URL to view new result from the command line. params<parameters>: Indicate parameters of the reports to view result from the command line. showbrowser: Indicate whether to display the browser of JReport Enterprise Viewer while running and viewing new report results from the command line. user<user name>: Indicate user name. password<password>: Indicate password. proxyhost<proxy host>: Indicate proxy host. proxyport<proxy port>: Indicate proxy port. proxyuser<proxy user name> Indicate proxy user name. proxypassword<proxy password> Indicate proxy password. Assume that you installed JReport Enterprise Viewer at C:\JREntViewer. 1. java classpath C:\JREntViewer\lib\JREntViewer.zip Dreporthome=c:\jrentviewer jet.client.ui.jrviewer vdebug verror reporthttp:// :8888/hsqldemo/tutorial.cat/phaseorder.cls " paramsstartdate=5/10/1998,enddate=7/10/1998" useradmin passwordadmin With this command line, you will view the result of report phaseorder.cls which belongs to catalog /hsqldemol/tutorial.cat on JReport Enterprise Server that is located at The user name and password are both admin, and the parameter values for report phaseorder.cls are startdate,5/10/1998,and enddate, 7/10/ java classpath C:\JREntViewer\lib\JREntViewer.zip Dreporthome=c:\jrentviewer jet.client.ui.jrviewer vdebug verror reporthttp:// :8888/hsqldemo/tutorial.cat/phaseorder.cls " paramsstartdate=5/10/1998,enddate=7/10/1998" useradmin passwordadmin showbrowser With this command line, in addition to viewing the results of the specified report, the main frame of the JReport Enterprise Viewer will be loaded as well. java classpath C:\JREntViewer\lib\JREntViewer.zip Dreporthome=c:\jrentviewer jet.client.ui.jrviewer vdebug verror serverhttp:// :8888/hsqldemo useradmin passwordadmin With this command line, connect with JReport Enterprise Server located at using the initial path /hsqldemo, and then loading the main frame of JReport Enterprise Viewer. java classpath C:\JREntViewer\lib\JREntViewer.zip Dreporthome=c:\jrviewer jet.client.ui.jrviewer vdebug verror Load the main frame of JReport Enterprise Viewer directly. 3

7 Installing and Launching JReport Enterprise Viewer Starting JReport Enterprise Viewer with Launcher After you install JReport Enterprise Viewer, a set of utilities are generated automatically under %installroot%\bin. All of these batch files have their own functions and can be edited or tailored to certain circumstances. JREntViewer.bat Run viewer with options. Usage: JREntViewer [options] [options] is the same as what we described above. Use? for more detailed information. DJREntViewer.bat Run viewer with debug and log information. The output log file is JReport.log under the current directory. In case of problems, you may run this batch to reproduce the problem. Usage: DJEntViewer [option] Use? for more detailed information NJREntViewer.bat Run Viewer without JIT option. If your viewer often crashes with JIT option, try this batch file instead of JREntViewer.bat. Usage NJREntViewer [options] Use? for more detailed information. Launching on Unix Starting JReport Enterprise Viewer from the Command Line java classpath <classpath> Dreporthome=<reporthome> jet.client.ui.jrviewer [options] Where <reporthome> Location of where your JReport Enterprise Viewer is installed. classpath The classpath must include the following packages originally in your /<install_root>/lib: /JREntViewer/lib/JREntViewer.zip [options] help:print out this message. vdebug: Enable output debug message. verror: Enable output error message. log[:<file>]: Output message to./jrviewer.log or./<file>. server<server URL >: Indicate JReport Server URL address. report<report URL >: Indicate the report URL to view new result from the command line. params<parameters>: Indicate parameters of the reports to view result from the command line. showbrowser: Indicate whether to display the browser of JReport Enterprise Viewer while running and viewing new report results of a from the command line. user<user name>: Indicate user name. password<password>: Indicate password. proxyhost<proxy host>: Indicate proxy host. proxyport<proxy port>: Indicate proxy port. proxyuser<proxy user name> Indicate proxy user name. proxypassword<proxy password> Indicate proxy password. Examples: Assume that you installed JReport Enterprise Viewer at /JREntViewer. 4

8 Installing and Launching JReport Enterprise Viewer 1. java classpath /JREntViewer/lib/JREntViewer.zip Dreporthome=/JREntViewer jet.client.ui.jrviewer vdebug verror reporthttp:// :8888/hsqldemo/tutorial.cat/phaseorder.cls " paramsstartdate=5/10/1998,enddate=7/10/1998" useradmin passwordadmin With this command line, you will view the result of report phaseorder.cls which belongs to catalog /hsqldemo/tutorial.cat on JReport Enterprise Server that is located at The user name and password are both admin, and the parameter values for report phaseorder.cls are startdate,5/10/1998,and enddate, 7/10/1998. Java classpath /JREntViewer/lib/JREntViewer.zip Dreporthome=/JREntViewer jet.client.ui.jrviewer vdebug verror reporthttp:// :8888/hsqldemo/tutorial.cat/phaseorder.cls " paramsstartdate=5/10/1998,enddate=7/10/1998" useradmin passwordadmin showbrowser 2. With this command line, in addition to viewing the results of the specified report, the main frame of the JReport Enterprise Viewer will be loaded as well. 3. java classpath /JREntViewer/lib/JREntViewer.zip Dreporthome=/JREntViewer jet.client.ui.jrviewer vdebug verror serverhttp:// :8888/hsqldemo useradmin passwordadmin With this command line, connect with JReport Enterprise Server located at using the initial path /hsqldemos, and then loading the main frame of JReport Enterprise Viewer. 4. java classpath /JREntViewer/lib/JREntViewer.zip Dreporthome=/JREntViewer jet.client.ui.jrviewer vdebug verror Load the main frame of JReport Enterprise Viewer directly. Starting JReport Enterprise Viewer with Launcher After you install JReport Enterprise Viewer, a set of utilities are generated automatically under %installroot%/bin. All of these batch files have their own functions and can be edited or tailored to certain circumstances. To make these files executable, first type the command such as: $ chmod a+x JREntViewer.sh JREntViewer.sh Run viewer with options. Usage: $ sh./jrentviewer.sh [options] [options] is the same as what we described above. Use? for more detailed information. DJREntViewer.sh Run viewer with debug and log information. The output log file is JReport.log under the current directory. In case of problems, you may run this batch to reproduce the problem. Usage: $ sh./djentviewer.sh [option] Use? for more detailed information NJREntViewer.sh Run Viewer without JIT option. If your viewer often crashes with JIT option, try this batch file instead of JREntViewer.bat. Usage $ sh./njrentviewer.sh [options] Use? for more detailed information. 5

9 Installing and Launching JReport Enterprise Viewer 6

10 JReport Enterprise Viewer Interface Graphic Interface After installing and launching JReport Enterprise Viewer successfully, the following interface will appear. As shown, the interface contains a main menu, address & tools bars and tab area. Menu File Open Remote Views report result in a remote JReport Enterprise Server. Open Local Views the result file (*.rst) on your local disk. Connect Connects to another JReport Enterprise Server. Refresh Refreshes information on both the Explorer and Schedule panels based on the JReport Enterprise Server to which you are currently connected. For more information on Explorer and Schedule panels, refer to the Tab Area section later in this chapter. 7

11 JReport Enterprise Viewer Interface Change Password Changes password for login. Logout Logouts from the JReport Enterprise Server to which you are currently connected. You can login again either by clicking the Refresh button, or by selecting the Connect menu item from the File menu. Exit Logouts and close JReport Enterprise Viewer. View Address & Tools Bar Shows/hides the address & tools bar. Application Association Specifies the associated applications to run files of different formats. Reference Note: JReport Enterprise Viewer Manual Application Association Dialog. Options Selects options for JReport Enterprise Viewer. If the full address and the initial path are directed to browse JReport Enterprise Server, JReport Enterprise Viewer will automatically connect to the server next time it is started. Reference Note: JReport Enterprise Viewer Manual Options Dialog. Help Help Displays the index for JReport Enterprise Viewer manual. About JReport Enterprise Viewer Provides a piece of information about this product. Address & Tools Bars The Address bar, which can be shown and hidden, displays the address input line. It also provides a method for connecting to JReport Enterprise Server and accessing the directories. The full URL includes the following part: path> Example: A web server is runnning on a machine whose host name is websvr and port is JReport Enterprise Server is running as a servlet of that web server. The servlet path is /jrserver, and you want to browse the path /tutorial in JReport Enterprise Server. You can input the address as follows: The following commands are available on the main menu and also on the tools bar: Refresh, Connect, Logout, Help and Exit. Tab Area Four tabs exist in this area Explorer, Schedule, Active and Completed. Explorer 8

12 JReport Enterprise Viewer Interface Resource Folder in Server This panel lists accessible paths in the remote JReport Enterprise Server. At first, only the initial path is transferred from the Server. However, as sub nodes are expanded, JReport Enterprise Viewer will ask the Server to transfer additional paths. This allows you to browse the entire tree step by step. If a node in the Resource Tree has ever been expanded, its sub nodes will be cached in the Viewer. Next time, when the node is expanded again, its sub nodes will be loaded from the cache in the Viewer rather than from the remote server. By clicking the Refresh button, the tree will be updated from the remote server. (Note: Only folders can be selected in the Resource Tree.) If you input the entire URL in the Address Input Line, and press the Enter key, the Resource Tree will be updated accordingly. Below are examples detailing how JReport Enterprise Viewer will function under certain conditions when connecting to a server with the URL You are NOT connected to any server. First, JReport Enterprise Viewer will attempt to connect to JRServer:8888. If it succeeds, the directory /jrserver will be transferred from that remote server to the Resource Tree. You are connected to a server, but not JRServer:8888. JReport Enterprise Viewer will first attempt to connect to the server JRServer:8888. If it succeeds, the directory /jrserver will be transferred from that remote server to Resource Tree. If the connection fails, the Viewer will continue attempting to connect to that server, or you can choose to stop these connection attempts. You are connected to JRServer:8888. The Resource Tree will be updated automatically. Reports in Folder This panel lists all the reports and sub folders belonging to the folder currently selected in the Resource Tree. You can view reports by double clicking on report name or clicking AdvancedRun on the shortcut menu. Note: All nodes are cached after the first time the tree was gotten and changes being made will be reflected on the Explorer panel simultaneously. Reference Note: JReport Enterprise Server Manual Viewing Reports with JReport Enterprise Viewer. Schedule This panel lists all schedules that have been defined. After a schedule starts a task, it will automatically move to the Active panel. Once the task is completed, it will move to the Completed panel, where it will remain until it is deleted. However, if a schedule is defined to perform a task repeatedly, it cannot be removed automatically until it finishes all tasks for the specified periods. Due to the fact that schedules can be modified in the remote server, you should refresh the Schedule pane often. To refresh the schedules, simply click on the Refresh button on the tools bar, or select the menu View Refresh. Task ID The internal ID for this schedule. Catalog 9

13 JReport Enterprise Viewer Interface Full path name of the catalog. Report The report name. Submitter Name of the user submitting the schedule. Launch Type Instant The task will be performed immediately upon submission. One Time The task specified will be performed at a specific time. Repeatedly The task specified will be performed periodically, for example, once a week. Next Run At The next time a task in this schedule is scheduled to begin. Last Run At The last time a task in this schedule was performed. Is Successful Status that indicates whether or not the last task was completed successfully. Task Type The result of a report can be published to Version System, File System, or Printer. Is Enabled Status that indicates whether or not the task is enabled for running. Reference Note: JReport Enterprise Viewer Scheduling with JReport Enterprise Viewer. Active This pannel lists all schedules currently running. Task ID The internal ID for this schedule. Started Time The time at which the task began. Engine Status The running status of the engine. Catalog Full path name of catalog. Report The Report name. Launch Type Three launch types exist: Instant, One time and Repeatedly. Task Type The result of a report can be published to Version System, File System, or Printer. 10

14 JReport Enterprise Viewer Interface Submitter Name of the user submitting the schedule. Parameter File If the report has parameters, all the parameters will be listed in this file. Completed This panel displays the schedules that have been completed. Task ID The internal ID for this schedule. Completed Time The time when the task completed. Is Successful Whether or not the task was completed successfully. Catalog Full path name of catalog. Report The report name. Parameter File If the report has parameters, all the parameters will be listed in this file. Result File(s) After the task is completed, report result will be listed in this file. Launch Type There are three types: Instant, One time and Repeatedly. Task Type The result of a report can be published to Version System, File System, or Printer. Submitter Name of the user submitting the schedule. Error Message Whether or not errors occurred during completion. Started Time The time at which the task began. ID The unique key of the task. Index 11

15 Introduction Viewing Reports with JReport Enterprise Viewer JReport Enterprise Viewer is the client end of a remote JReport Enterprise Server. You can view reports either on a remote server or on your local disk. You can also set up schedules to view reports at specific times. Viewing Reports Locally 1. Assuming JReport Enterprise Viewer is installed in /JREntViewer, it can be started by running the following command in the Command Prompt: $ cd /JREntViewer/bin $ sh JREntViewer.sh 2. The Connect dialog box allows you to connect to a remote server. When viewing reports locally, click Cancel to ignore this option. 3. Go to the File menu, select Open Local... to open a local result file. 4. Select the result file (.rst) to be viewed, then click Open. 5. The selected report is shown below. 12

16 Viewing Reports with JReport Enterprise Viewer Viewing Reports Remotely Case 1: When JReport Enterprise Server is running as an independent web server JReport Enterprise Viewer is installed in /JREntViewer. 1. Start JReport Enterprise Viewer using the following command: $ cd /JREntViewer/bin $ sh JREntViewer.sh 2. Input the host name and port of the JReport Enterprise Server to which you would like to connect. 3. After successful login, select the catalog and report to be viewed under Explorer tab. ( Reference Note: JReport Enterprise Viewer Manual Interface ) 4. Double click on the selected report, click the AdvancedRun command on the shortcut menu, or select File Open Remote. The window below will appear. Click on the Run button to view the report. 13

17 Viewing Reports with JReport Enterprise Viewer If the report has parameters, they can be viewed by clicking Parameters. These parameters can be modified as well. 5. The result report is shown below. 14

18 Viewing Reports with JReport Enterprise Viewer Case 2: When JReport Enterprise Server is running as a servlet When JReport Enterprise Server is running as a servlet, JREntViewer can connect to the server with SSL (Secure Socket Layer) support. 1. Preparation for using SSL If you are using JDK 1.2or 1.3, you should download JSSE software at html. After you log in or register, you can download a zip file. Unzip this file, you will get three Executable Jar Files: jcert.jar, jnet.jar, jsse.jar under %jsse1.0.3_unzip_root%/jsse1.0.3/lib. Copy these files to /JREntViewer/lib. Modify /JREntViewer/bin/JREntViewer.sh as below: CLASSPATH="${CLASSPATH}":/JREntViewer/lib/JREntViewer.zip:/JREntViewer/lib/unicode.zip: /JREntViewer/lib/PatchedItext.zip:/JREntViewer/lib/Itext.zip:/JREntViewer/lib/poiHSSF_151 export CLASSPATH exec /usr/java/j2sdk1.4/jre/bin/java Dinstall.root=/JREntViewer/ Dreporthome=/JREntViewer Dresourcezip="/JREntViewer/lib/JREntViewer.zip" jet.client.ui.jrviewer "$@" JDK 1.4 has a version of JSSE already bundled. If you are using JDK 1.4, skip this step. 15

19 Viewing Reports with JReport Enterprise Viewer Notes: 2. Assume JReport Enterprise Server is integrated with Weblogic 6.1. Start Weblogic 6.1 server from Start menu. 3. Connect to JReport Enterprise Server using SSL. Launch JReport Enterprise Viewer. In the Connect dialog, input the host name or IP address, server port and servlet path. Assume Weblogic 6.1 is installed on the computer, which you are using is the default port for the Weblogic server. /jrserver is the default servlet path. Check the SSL box to connect to JReport Enterprise Server with SSL support. 4. After successful login, select the catalog and report to be viewed under Explorer tab. We recommend using JDK1.2 or higher. If you use JDK1.1 when installing JReport Enterprise Viewer, SSL is not supported. If you want to export a report to an Applet in browser with SSL support, you must use JDK 1.4 or JDK 1.2 or 1.3 with 1.4 plug in. Index 16

20 Scheduling with JReport Enterprise Viewer Introduction The JReport Enterprise Viewer provides task scheduling functionality similar to the JReport Enterprise Server Administrator function. Whether you need to run weekly reports, publish monthly HTML report results, or schedule a particular task to occur just once, the JReport Enterprise Viewer enables you to run reports when you want, as often as you want. The JReport Enterprise Viewer can: Publish reports to the Versioning System Publish reports to a File System Define value based triggers to automatically run a task Publish reports to a Printer Publish reports to Rpt Task Publish reports to E mail Publishing Reports to the Versioning System This task runs a specified report and saves the result as a unique version in the Report Versions list, which is also maintained by the remote server. This version can be accessed at any time. Reference Note: For more information on how to view result versions of a report, refer to the JReport Enterprise Viewer Manual / Viewing Reports with JReport Enterprise Viewer. Example: To schedule a task to run hourly, every day, from 9:00 AM to 5:00 PM, follow the instructions below. In this example, the report will be run, printed, and published to the version list 1. Click on the Schedule tab to get the Schedule page, and then click on the New button to set up a new schedule request. 2. On the Task & Time tab of the New Schedule dialog, select Publish to Versioning System in the Task field. Click the Edit button to specify Result Expires In 30 Days to keep the version for 30 days, then click OK. 17

21 Scheduling with JReport Enterprise Viewer On this tab again, check Run this task periodically to specify Day(s) and Time for the task. 3. Select the Report tab to specify Report, Report Version, Catalog and Catalog Version respectively. By clicking the button, you can search for the available reports and catalogs. Check Print Result to print the selected report. 18

22 Scheduling with JReport Enterprise Viewer Note: If you use JDK or above, the network printer will be available and you can print the report to any available network printer. If you use a JDK below JDK1.3.02, no matter what printer you choose, the result of the selected report will be printed to the default printer. 4. To send e mail notifications when the task is successfully completed or fails, click the Notification tab to edit the notification job. In the screenshot below, two individuals will be notified when the scheduled task is run successfully. 19

23 Scheduling with JReport Enterprise Viewer 5. Click OK. Now the newly scheduled task is listed under the Schedule tab. The report will be run, printed, and published to the version list according to settings on the Task&Time tab. Publishing Reports to the File System This task runs a specified report and publishes its result to the remote server. The result can be published in any of the following formats: Result File (.rst file ) HTML PDF Text Excel PostScript RTF XML To publish to the File System, please take the steps below. 1. Selected the task Publish to File System and specify the time to execute the task. 2. Click on the Edit button to access the New Publish to File System dialog. On the left panel of the dialog, check the format in which the report is to be published. On the Options panel, specify the available options of each format. 20

24 Scheduling with JReport Enterprise Viewer 3. In the example below, PDF is selected. From the Type drop down list, specify where the files will be published. If Publish to server resource tree is selected, use the button to locate the directory to which you want to publish the files. If Publish to server disk path is selected, specify the directory path by your own. Notes: You must provide a file name for each selected format. If you select to publish the file to PDF, you can set a password for the PDF file as you wish. Reference Notes: For additional information on the options available, please refer to the JReport Designer Manual / User's Guide / Exporting Report Result. 4. On the Report tab, specify Report, Report Version, Catalog and Catalog Version respectively. 5. On the Notification tab, edit the notification job to send e mail notifications when the task is successfully completed or fails. 6. Click OK to return to the interface. When the task runs, the files will be saved to the physical location to which the resource node in the server is mapped. Defining Value based Triggers This task runs the selected report and triggers another report to run according to its Boolean field value. First select the task Value based Trigger and specify the time to run the task. Click Edit to view the New Value based Trigger dialog as shown below. 21

25 Scheduling with JReport Enterprise Viewer In this dialog, 1. Specify the report and catalog to be scheduled by clicking the button. Please note that the selected report should have Boolean fields to be used to trigger another report. 2. Select the report version and catalog version that are to be scheduled from the corresponding drop down lists. 3. Give the task a name in the Task Name field. 4. On the Setting panel, select Trigger Task in the left box to edit the task. In this example, we chose the field named Shipped in the first trigger line by clicking the cell and selecting it from the drop down list. Set Shipped to true in the same way. 5. By clicking the cell in the To Run Task column, you can define another task to be triggered when the Shipped field returns true. Triggered tasks include all the tasks listed in this section. The only difference is that the triggered task must be run immediately if it is triggered, and it cannot be scheduled to run periodically. 6. Select DB User, Language, Style Group and Print in the left box respectively to specify available options. 7. You can check the second trigger line, and select another Boolean field to trigger another task. You can also add and delete a task by click the Add and Delete button. Publishing Reports to a Printer This task runs a specified report and prints the result to a printer on the remote server. The procedures for publishing to a printer are similar to other tasks described in this section. You can define the task by selecting Publish to Printer, and check the Print Result option. Next, under the Report tab, select the preferred network printer. You can either choose a printer from the drop down list, or input the printer name in the text box directly. 22

26 Scheduling with JReport Enterprise Viewer Publishing Reports to Rpt Task All the above mentioned publishing options including: To Versioning System (To Version), To File System (To Disk), To E mail, To Printer and To Fax are included in Publish to Rpt Task. Users can schedule with this task using one to five publishing types and what has been specified will be passes to the Server only when the OK button on the New Schedule dialog box is clicked. Within this task, To Version differs from To Versioning System detailed above. Unlike To Versioning System, which only supports publishing to result format (.rst) and listing results in the Report Versions list, To Version in Publish to Rpt Task allows you to publish results to eight formats (as pictured above). Publish to Fax 23

27 Scheduling with JReport Enterprise Viewer In this dialog box, 1. Specify the quality of the fax by checking the corresponding box. 2. Check if to include the cover sheet. 3. Fill in the following items that will be displayed on the fax cover sheet. To Information of the recipient. From Information of the sender. Company Information of the company. Date The day on which the fax is sent. Fax Number The fax number of the recipient. Phone Number The phone number of the sender. Re The subject of the fax. Comments The comments of the fax. Urgent 24

28 Scheduling with JReport Enterprise Viewer Specifies whether the fax is urgent or not. For Review Only to view the fax is OK. Please Comment Comments is needed for the fax. Please Reply A reply is needed for the fax. Furthermore, clicking the Advanced button at the right bottom opens the Version Advanced dialog box, which allows you to specify where results should be published: to Report Versions list, My Reports or Public Reports. If the Build in Version Folder is selected, results will be published to the systems default path. If My Reports is selected, results will be published to a private folder and regarded as private and sensitive. Comments of My Reports cannot be shared. If Public Reports is selected, results will be published to the Public Folder and regarded as public and shareable. The owner of the report designates privileges to users or roles. Archive This function is active when My Folder or Public Folder is selected. It enables users to set an archive policy for report management. Report can be archived as a new version or replace the old version. Enable User Permissions This function is active only when Public Folder is selected. The following five end user permissions exist: Visible, Read, Write, Delete and Grant. Version Auto delete This function is active when any Archive Location is selected. It enables users to specify when versions will be deleted. When all selections are made, click OK to store the parameters for the Advanced option. Otherwise, click Cancel. Note: Advanced parameters are passed to the Server only when the OK button is clicked on the New Publish to Rpt Task dialog box. 25

29 Scheduling with JReport Enterprise Viewer Publishing Reports to E mail This task publishes the report results to E mails. Before running this task, it is necessary to configure the JReport server with the mail server information. 1. Under the Schedule tab in the interface, click New to get into the New Schedule dialog. 2. In the New Schedule dialog, on the Task & Time tab, select Publish to E mail in the Task box field. Then check Run this task immediately. 3. Click on the Edit button to edit the task. In the New Publish to E mail dialog, click on the New button, then input the necessary information and choose whether to specify the Java Archive Compress. You can also click the Format button on the New E mail dialog box to specify the output format in the Edit E mail Dialog. Then, click OK to return to the New Schedule dialog. 4. Switch to Active and Completed tab to check task status. When it goes to the Completed tab and the status " Is Successful' is true, the result has been sent by E mail successfully. Reference Note: JReport Enterprise Server Manual / User's Guide / Configuring JReport Enterprise Server. Index 26

30 Shortcut Menus on the Explorer Tab Introduction Two panels exist on the Explorer tab: the Resource Folder Panel is the panel on the left and the Reports in Folder Panel is the panel on the right. This section describes the commands found on menus within these two panels. Shortcut Menu for the Resource Folder Panel The Catalog drop down list allows you to choose a catalog for the report. Properties Properties for My Reports The Properties dialog box (pictured below) is very similar for the root node folder My Reports and folders within the root node. 27

31 Shortcut Menus on the Explorer Tab Name, Type, Description & Last Modified These fields display respective information about the folder. This information can not be modified directly. Resource real path Specifies a resource real path for folder. Map shared disk Option to map shared disks. Enable resource from real path Option to enable resource from real path. Once checked, it is required that you specify a real path in the Resource real path field. Resource node name Displays the node name of the report. This name cannot be modified. Resource description Displays resource description of folder. Archive policy When checked, an archive policy can be specified for the folder. Options include Archive as a new version or Replace the old version. When archiving as a new version, the maximum number of versions to be maintained can be specified. If the number is set to zero, all versions will be maintained. Properties for Public Reports As with the My Reports folder, the Properties dialog box is also very similar for the root node folder Public Reports and folders within the root node folder. 28

32 Shortcut Menus on the Explorer Tab In addition to the functionality in the My Reports Properties dialog box, the Public Reports Properties dialog box allows you to enable users permissions. Seven types of user permissions exist and can be enabled for a user or a role: Visible, Read, Write, Delete, Execute, Schedule and Grant. Note: As with the My Reports root node folder, the Resource node name for the root node folder Public Reports cannot be modified either. Deploy Deploys resources in JReport Enterprise Viewer. For detailed information on how to deploy resources in JReport Enterprise Viewer, please refer to the Deployment Settings Dialog. Delete Deletes a resource from server. Note: The Delete command cannot be used on root nodes (My Reports and Public Reports). Shortcut Menus for the Reports in Folder Panel Commands on the shortcut menus vary by object type within the reports in folder panel. These commands are accessible by right clicking on object types. 29

33 Shortcut Menus on the Explorer Tab Run If the object type is a folder, commands available on the shortcut menu are Properties, Deploy and Delete. If the object type is a result, commands available on the shortcut menu are Versions, Properties and Delete. If the object type is a report, commands available on the shortcut menu are Run, Advanced Run, New Schedule, Versions, Properties and Delete. Runs the selected report using the default output format. AdvancedRun Advanced runs the selected report. Advanced run provides you with options for running reports. Reference Note: Viewing Reports with JReport Enterprise Viewer Viewing Reports Remotely New Schedule Schedules the selected report. Reference Note: Scheduling with JReport Enterprise Viewer Publish to Versioning System Note: Unlike when you are creating a new schedule for a selected report using the Schedule tab, the Report and Catalog are already defined and no Directory option exists for you to edit. Versions Versions for Objects in My Reports Versions for Report Type Two tabs exist on the report versions dialog box (pictured below): Result Versions and Report Versions. Result Versions Tab Within the Result Versions tab, you can define the maximum number of versions allowed and double click each record to view result versions. If you right click on a record, a shortcut menu with the following commands will appear: Parameters (if the result has parameters), View As and Properties. 30

34 Shortcut Menus on the Explorer Tab Submit Submits the maximum number of versions identified by you. If the number is set to 0, all versions will be maintained. Refresh Refreshes the version table. Delete Deletes the selected record(s). Parameter Views parameters of the selected result version. View As Views the results in certain format. Formats available depend on running result. Properties Opens the Version Properties dialog. You can specify the way to auto delete result doc on this dialog box. Report Versions Tab Lists versions of the report. You can right click on each of them to view the properties. 31

35 Shortcut Menus on the Explorer Tab Versions for Result Type For the result type, only one tab exists on the Versions dialog box Doc Versions. You can double click on each record to view result versions. You can also right click on these records to get the shortcut menu with commands of Parameter, View As and Properties. Versions for Objects in Public Reports Versions for Report Type Versions dialog box for report type within Public Reports is the same as the Versions dialog box for report type within My Reports. Two tabs exist on the report versions dialog box (pictured below): Result Versions and Report Versions. You can right click records on either tab to access the shortcut menu. Within the Result Versions tab, you can double click each record to view information about that version. The Version Properties dialog that appears by making a selection from the shortcut menu is different. On the Result Versions Tab This Versions Property dialog box provides result versions property information, and also a user defined Result 32

36 Shortcut Menus on the Explorer Tab doc auto delete option. If this option is checked, you can further specify the expiration date of result records. On the Report Versions Tab The Version Properties dialog box (pictured below) allows you to Enable users permissions. Seven types of user permissions exist and can be enabled for a user or a role: Visible, Read, Write, Delete, Execute, Schedule and Grant. Versions for Result Type Properties The Versions dialog box for result type within Public Reports is also the same as that within My Reports. You can double click to view the result versions and right click on record to access the shortcut menu. This Version Properties dialog box for result type is different from the Version Properties dialog for report type (as pictured above). You have both the options to specify Result doc auto delete and / or Enable users permissions. Properties for Report / Result in My Reports The Properties dialog boxes for both report and result types in My Reports are the same. 33

37 Shortcut Menus on the Explorer Tab Properties for Report / Result in Public Reports As with My Reports, the report and result types within Public Report have the same properties dialog boxes. 34

38 Shortcut Menus on the Explorer Tab 35

39 JReport Client API Introduction JReport Client API is intended for users who want to compile the program by themselves, or integrate JReport Enterprise Viewer with their own java application. JReport Enterprise Viewer and JReport Viewer Bean are all based on JReport Client API. Just like JReport Enterprise Viewer, JReport Client API allows users to view reports in the server and set up scheduled tasks. Installation When you install JReport Enterprise Viewer, JReport Client API will be installed at the same time. After installation, you should have the components <JREntViewer_Install_Dir>\lib\JREntViewer.zip. Notes: Client API classes are stored in the archive files JREntViewer.zip. You need to set the CLASSPATH environment variable before you compile and run the program. Append the following string to your CLASSPATH starting the client API: <JREntViewer_Install_Dir>/lib/JREntViewer.zip;<JREntViewer_Install_Dir>/lib/log4j jar Packages Client API mainly includes two packages: API package and GUI package. The API package offers methods for compiling the program, getting some information and viewing result versions etc., the GUI package offers the interface to view the report. Package jet.client.api This package includes the following classes: APIUtil Provides some static methods, such as getting error messages, returning URL strings, getting response message, getting task information etc. Active Contains displaying information of an active task from the report server. Completed Contains displaying information of a completed task from the report server. JRClient Represents a client of JReport Enterprise Server. It provides methods to run reports, view result versions and create/edit schedules etc. NodeInfo Contains information of a resource node in a report server for scanning catalogs or directories in the report server. ResourcePathInfo Contains the path information of a resource node in a report server. The path information includes the servlet path, the path info, the catalog and the report of a resource in the report server. For example: for the URL where The servlet path is "/servlet/jrservlet". The path info is "/hsqldemo/tutorial.cat/invoice.cls". The catalog is "/hsqldemo/tutorial.cat". The report is "invoice.cls". VersionRecord 36

40 JReport Client API Represents a result version record of a report from a report server. Package jet.client.api.gui This package includes the following interfaces and classes. Interfaces Classes CatPanelListener This interface defines the listener for getting current path changes of a catalog panel. DirPanelListener This interface defines the listener for getting the current path changes of a directory panel. CatalogPanel Class CatalogPanel is a panel to browse catalogs in the report server. CliOpenCatDlg Class CliOpenCatDlg is a dialog box to select a catalog in the report server. CliOpenDirDlg Class CliOpenDirDlg is a dialog box to select a directory in the report server. DirectoryPanel Class DirectoryPanel is a panel to browse directories in the report server. JRClientGUI Class JRClientGUI represents a client of JReport enterprise server. It provides methods to run reports, view result versions and create/edit schedules etc. ScheduledDlg Class ScheduledDlg is a dialog box to create/edit a scheduled task. TaskListHolder Class TaskListHolder is a holder that holds a panel of the scheduled tasks, active tasks or completed tasks. With the class, you can refresh the task list or set a new report server for the task list. ViewerThread Class ViewerThread is a thread to view a report result. It brings up a report viewer (frame) when the thread starts. Reference Notes: For more details about methods, refer to JREntViewer javadoc jet.client package which includes all the documents generated by Javadoc. You can go to for the manual related materials. Illustrative Examples for Using Client API After you have installed JReport Enterprise Viewer, you will find the illustrative demo programs under <installroot>\help\viewer material. Or you can find them at with the manual related materials. ReportBrowser.java browse catalogs and their reports and view report results. ResultVersionView.java view a result version ScheduleDialogs.java create/edit scheduled tasks ScheduleDemo.java create/edit schedule tasks without GUI TasksInfo.java list scheduled tasks, active tasks and completed tasks RunTaskDemoTo .java run a task immediately. And demonstrates how to run a "Publish To " task. ViewerThreadDemo.java about viewer thread ExportResult.java export report results Below are two examples, with which we will explain how they work and how they use the methods provided with Client API. 37

41 JReport Client API Example 1: ResultVersionView.java ResultVersionView.java is designed to view a result version and export to different formats. Import First of all, you should import the classes of Client API by adding the following import statements at the beginning of your program. import jet.client.api.*; import jet.client.api.gui.*; Set Connection Information After getting the values of command line arguments such as report URL, user, password etc., set the connection information with the following methods in class jet.client.api.jrclient. 1. Set the proxy infomation for the client JRClient.setProxy(proxyHost, proxyport); The methods setproxy (String proxyhost, String proxyport) set the proxy for the client. Parameters: proxyhost The proxy host name or IP address. If it is null, no proxy will be used. proxyport The proxy port. 2. Set the user ID JRClient.setUser(user); The method setuser(string user) sets the user ID of the report server at the client end. 3. Set the client password JRClient.setPassword(password); The method setpassword(string password) sets the user password. Login JRClient.login(null, report); The method(frame frame, string jrsvrurl) is used to login to the report server jrsvrurl. pop up to enter user ID and password. A login dialog box will Parameters: frame The frame of the login dialog box. If the frame is null, JRClient would create a frame and the login dialog box would still pop up when a login is needed (a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response). jrsvrurl The URL string of the JRServlet. For examples: or Get Result Versions of the Report Vector versions = JRClient.getResultVersions(null, report); The method getresultversions(frame frame, String reporturl) returns the result versions of a report in a report server. Parameters: 38

42 JReport Client API frame The frame of the login dialog box. If the frame is null, JRClient would create a frame and the login dialog box would still pop up when a login is needed (a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response). rpturl The URL string of the report in a report server. For example: Export the Result to JReport Result, HTML, PDF, TEXT, Excel, Postscript and RTF boolean[] succinfo = JRClient.exportVersionResult(report, ver.getresultfilename(), // the result version localfilename + ".rst", // To report result. localfilename + ".html", // To HTML. localfilename + ".pdf", // To PDF. localfilename + ".txt", // To TEXT. localfilename + ".xls", // To Excel. localfilename + ".ps", // To Postscropt. localfilename + ".rtf", // To RTF(Rich Text Format). false, // isnormaltext false, // isrepeat ';', // delimiter true, // ismultifiles true, // ischartapplet true, // hashyperlink false, // haspagenumber false, // usetable false, // relfontsize 0, // webbrowser 0 IE, 1 Netscape. false); // drilldown The method exportversionresult is used to export a version result to different formats. It returns whether it is successful or not. boolean[0]: if successfully exported to JReport result boolean[1]: if successfully exported to HTML boolean[2]: if successfully exported to PDF boolean[3]: if successfully exported to TEXT boolean[4]: if successfully exported to Excel boolean[5]: if successfully exported to PS There are a couple of exportversionresult methods with different parameters. The method being used in the demo has following parameters: rpturl The URL string of the report in a report server. versionresult The version result filename of the report on the server side. rstfile The local filename with the full path, to which tempresult will be exported as a JReport result file. htmlfile the local filename with the full path, to which tempresult will be exported as an HTML file. pdffile the local filename with the full path, to which tempresult will be exported as a PDF file. txtfile the local filename with the full path, to which tempresult will be exported as a TEXT file. excelfile the local filename with the full path, to which tempresult will be exported as an Excel file. psfile the local filename with the full path, to which tempresult will be exported as a PS file. rtffile the local filename with the full path, to which tempresult will be exported as an RTF file. isnormaltext Indicate whether this text file is in normal text format or not (To TEXT). isrepeat Indicate whether the same contents are repeated (To TEXT). delimiter A character which will be used in SDF (Standard Data Format) format. A delimiter could be a ',' (the CSV format) or any other characters. The default is ' ' (a blank), that is, the SSV format (To TEXT). ismultifiles Indicate whether html is generated to a file or to multiple files (To HTML). ischartapplet Indicate whether the chart in html file is an applet (To HTML). hashyperlink Indicate whether the hyperlink is generated (To HTML). 39

43 JReport Client API haspagenumber Indicate whether to generate page number (To HTML). usetable Indicate whether to use an HTML table to generate the HTML page (To HTML). relfontsize Indicate whether to generate HTML pages with relative font size (To HTML). webbrowser Indicate which Web browser HTML pages are being generated for (To HTML). 0 IE; 1 Netscape. drilldown Indicate whether to drilldown the HTML result (To HTML). Note: The method exportversionresult() is deprecated. Above JREntViewer version 3.0, it is replaced by exportversionresult(string rpturl, String versionresult, String rstfile, String htmlfile, String pdffile, String txtfile, String excelfile, String psfile, boolean isnormaltext, boolean isrepeat, char delimiter, boolean ismultifiles, boolean ischartapplet, boolean hashyperlink, boolean haspagenumber, boolean usetable, boolean relfontsize, int webbrowser). View theversion in a Thread ViewerThread vt = JRClientGUI.viewResultVersion(report,ver.getResultFilename(), "Result Version " + ver.getcreatedtimedisplaystring()); The method viewresultversion(string rpturl, String resultversion, String title) views a report result version and returns a ViewerThread object. A report viewer frame is brought up by the ViewerThread. Parameters: rpturl The URL string of the report in a report server. For example: resultversion The result version name can be got from getresultfilename() of VersionRecord. The VersionRecord list of a report can be got from the method getversionlist(...) of this class. title The title of the report viewer that will be brought up. Show the Parameters of this Result Version JRClientGUI.showVersionParamValues(null, report, ver.getversionid(),"parameters " + ver.getcreatedtimedisplaystring()); The method showversionparamvalues(frame frame, String jrsvrurl, String versionid, String title) brings up a dialog box to show the report parameter values of the result version. Parameters: frame The frame of the login dialog box. If the frame is null, JRClient would create a frame and the login dialog box would still pop up when a login is needed (a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response). jrsvrurl The URL string of the JRServlet. versionid The result version ID can be got from getversionid() of VersionRecord. The VersionRecord list of a report can be got from the method getversionlist(...) of this class. title The title of the dialog box. Exit vt.setsystemexitwhenwindowclosed(); The method setsystemexitwhenwindowclosed() sets the system to exit when the result viewer is closed. Compile and Run Assume that the demo program is under C:\JREntViewer\help\api, and JReport Enterprise Viewer is installed in c:\jrentviewer. To compile and run the demo program, you should add the some files with their paths into the classpath. For example, use the following command to compile the test program: C:\JREntViewer\help\api>javac classpath c:\jrentviewer\lib\jrentviewer.zip;c:\jrentviewer\lib\log4j jar ResultVersionView.java 40

44 JReport Client API When you run the programs, you should provide parameters. help: Display the usage of the program (optional). report: The report URL to view its result from command line. params: Parameters of the report to view its result from command line. user: The user ID (optional). password: The user password (optional). proxyhost: The proxy host (optional). proxyport: The proxy port (optional). An example to run the program: C:\JREntViewer\help\api>java classpath c:\jrentviewer\lib\jrentviewer.zip;c:\jrentviewer\lib\log4j jar;C:\JREntViewer\help\api ResultVersionView reporthttp://jrserver:8888/hsqldemo/tutorial.cat/invoice.cls paramsptoday5/21/98 useradmin passwordadmin Running the program, you can view the result of report "invoice" and its parameter as shown below. Example 2: ScheduleDemo.java This example is designed to submit a schedule without GUI to generate a report version every hour from 9:00 to 17:00 daily. Also, the version manager will keep each of the generated results for 30 days from the day they are generated. Import Import the classes of Client API by adding the following import statements at the beginning of your program. import jet.client.api.*; Set Connection Information After getting the values of command line arguments such as report URL, user, password etc., set the connection 41

45 JReport Client API information with the same methods used in example one. // set the HTTP proxy for the client. if (proxyhost!= null) { JRClient.setProxy(proxyHost, proxyport); } // set the user ID for the client. JRClient.setUser(user); // set the password for the client. JRClient.setPassword(password); Login Use the same method used in example one to login into the server. JRClient.login(null, server); Set Properties of Task and Time Hashtable httask = new Hashtable(); //set properties about task info httask.put("jrs.task_class", "jet.server.schedule.jrtasks.updaterpttask"); httask.put("jrs.catalog", "/hsqldemo/tutorial.cat"); httask.put("jrs.report", "invoice.cls"); httask.put("jrs.expire_days", "30"); httask.put("jrs.if_print", "false"); //set parameter values httask.put("jrs.param$ptoday", "May 20, 1998"); httask.put("jrs.param$termsdays", "31"); //set properties about time info httask.put("jrs.launch_type", "8"); httask.put("jrs.days_id", "0"); httask.put("jrs.day", "1"); httask.put("jrs.is_weekday", "false"); httask.put("jrs.is_hourly", "true"); httask.put("jrs.hours", "1"); httask.put("jrs.is_between", "true"); httask.put("jrs.is_pm", "false"); httask.put("jrs.hour", "9"); httask.put("jrs.min", "0"); httask.put("jrs.at_min", "0"); httask.put("jrs.is_pm2", "true"); httask.put("jrs.hour2", "5"); httask.put("jrs.min2", "0"); Get Scheduled Tasks from the Server Vector tasks = JRClient.getScheduled(null, server); The method getscheduled(frame frame, String jrsvrurl) returns the scheduled tasks from the report server. Parameters: frame The frame of the login dialog box. If the frame is null, JRClient would create a frame and the login dialog box would still pop up when a login is needed (a server returns the Unauthorized response or a proxy 42

46 JReport Client API Index returns the Proxy Authentication Required response). jrsvrurl the URL string of the JRServlet. Compile and Run Compile the demo program as you do in example one. For example, use the following command to compile: C:\JREntViewer\help\api>javac classpath c:\jrentviewer\lib\jrentviewer.zip;c:\jrentviewer\lib\log4j jar ScheduleDemo.java When you run the programs, you should provide the parameter " server" which indicates the server URL. For example, use the following command to run the demo program. C:\JREntViewer\help\api>java classpath c:\jrentviewer\lib\jrentviewer.zip;c:\jrentviewer\lib\log4j jar;C:\JREntViewer\help\api ScheduleDemo serverhttp://jrserver:8888 There are also the following optional parameters: help: Display the usage of the program user: The user ID password: The user password proxyhost: The proxy host proxyport: The proxy port Running the program, you will submit a schedule task and get the information about this task. 43

47 JReport Viewer Dialogs Connection Dialog Host The server name or IP address. Port The sever port or connection. Servlet Path The servlet path for the sever. SSL Option to connect to JReport Enterprise Server with SSL support. Remember connection information If checked, the connection information, that is the information about host, port and servlet path, will be remembered so that there is no need to key in them next time when connecting to server. User Name Enters the user name. Password Enters the user password. Examples: Suppose JReport Enterprise Server is running as a servlet of a web server. The web server runs on the machine whose host name is websvr and the port is JReport Enterprise Server is running as a servlet of that web server through the path /servlet/jrserver. 44

48 JReport Viewer Dialogs Host : websvr Port: 8080 Servlet path: /servlet/jrserver Suppose JReport Enterprise Server is running as an independent web server, and it runs on the machine whose host name is jrserver and the port is Host : jrserver Port: 8888 Servlet path: /jrserver Note: You can also leave the Servlet Path blank in this situation. Index New Schedule Dialog Report Tab Index Report Selects the appropriate report you are scheduling by clicking the button. 45

49 JReport Viewer Dialogs Report Version Selects the report version that should be utilized from the drop down list. Catalog Selects the catalog that should be utilized by clicking the button. Catalog Version Selects the catalog version that should be utilized from the drop down list. Max Version Amount Option to specify the maximum version numbet for this task, availble only when publishing to versioning system. Task Name Specifies the name of the task. Using Language Report result will appear in the selected language. Note: This option is only available when NLS (National Language Support) is used in the selected report. Enable Style Group Option to enable a style group from the drop down list. Enable Converting Encoding Specifies to enable the conversion of encoding. From the Before converting and After converting drop down lists, select an encoding as wanted. Encoding Selects the encoding used to design the report Use the default DB user and password defined in Catalog If checked, the user name and password used to connect to a database will be used. Use the DB user If you would like to define another DB user, check Use the DB user, then input a new user ID and password. Print Result Option to print the result and select a printer from the drop down list. Note: The report tab will become gray when you select the task Value based Trigger. In this case, user should click the Edit button to specify the report and catalog on the opened New Value based Trigger dialog as below. 46

50 JReport Viewer Dialogs Task&Time Tab 47

51 JReport Viewer Dialogs Task The following tasks options can be selected from the drop down list in the Task field: Edit Edits the selected task. Publish to Versioning System Runs the specified report and save the result in the Version list. Publish to File System Runs the specified report and publish result to the file system. Reports can be published in different formats, including Result File, HTML, PDF, Text etc. Value Based Trigger Runs the specified report and trigger the running of another report based on a Boolean field value. Publish to Printer Asks JReport Enterprise Server to print the result of the specified report. Publish to Rpt Task Runs the specified report and publish result to Version, to Disk(to the file system), to E mail or to Printer. Reports can be published in different formats, including Result File, HTML, PDF, Text, Excel. PostScript, RTF and XML. Publish to Runs the specified report and publish the result to e mails. Add TaskListener to be invoked Option to add a task listener to be invoked. 48

52 JReport Viewer Dialogs Date and Time Specifies the date and time to run the scheduled task at a specific time. Run this task at If checked, the task will be run at the time specified in Date and Time. Run this task immediately If checked, the scheduled task will be run immediately. Run this task periodically Specifies the time and frequency when the specified task should be run if it is checked. Tasks can be scheduled to occur daily, weekly, or monthly at any time. Time Zone Selects the appropriate time zone from the drop down list. The server will schedule the task according to the date and time in the specified time zone. Notification Tab Sets the E mail Notification task by completing To, Cc, Bcc, Subject and Comments fields respectively. When Success If checked, e mails notification will be sent out when the scheduled task is completed successfully. 49

53 JReport Viewer Dialogs When Failure If checked, e mails notification will be sent out when the scheduled task fails to run. In addition, a string "(Failure)" will be added in the subject line of the e mail. Index Index Advance Run Dialog The Advance Run dialog appears when you double click any report in the Reports in Folder Panel. Report Tab Run Report Path of the report that is to be run. Catalog Selects a catalog for the task from the drop down list. Report Version 50

54 JReport Viewer Dialogs Specifies a report version for the task from the drop down list. Catalog Version Specifies a catalog version for the task from the drop down list. Enable Style Group Option to enable a style group from its drop down list. Enable Converting Encoding Specifies to enable the conversion of encoding. From the Before converting and After converting drop down lists, select an encoding as wanted. Encoding Selects the encoding used to design the report. Using Language Your report result will appear in the selected language. ( Note: This is available when NLS (National Language Support) is used in the selected report.) Region Selects a region from its drop down list. (Note: This is available when NLS (National Language Support) is used in the selected report.) Use the default DB user and password defined in catalog If checked, the user and password defined when you connected to a database will be used. Use the DB user If you would like to define another DB user, check Use the DB user, then input the new user ID and password. Add TaskListener to be invoked Option to add a task listener that is to be invoked. Parameters Browses the parameters of the selected version. Edit Archive Tab 51

55 JReport Viewer Dialogs Auto archive after running To edit archive, check this option first. Result Location Build in Version Folder If checked, results will be saved to the system's default path. Custom Folder If checked, you can use the button to specify the location in the server resource tree. And, input a name in the Result Name field. Apply Archive Policy This function is available only when Custom Folder is selected. It enables users to set an archive policy for report management. Report can be archived as a new version or replace the old version. Max result doc version amount Specifies the maximum amount of result doc versions that can be kept. If zero is specified, it means the result doc versions that can be kept is unlimited. Result doc auto delete Specifies when the result doc will be deleted automatically. Enable User Permission Specifies permissions for a user or role. This option is available only when the result location is checked 52

56 JReport Viewer Dialogs to be Custom Folder. Index Index Application Association Dialog In order to view files of different format with an application you want, you can designate an associated program for each format in the Application Association dialog. Viewing Results on Local Computer If you want to view results on your local computer, check the View the results on local computer radio button, and the Application Association dialog box is pictured as below. To specify a preferred application to view files of different format, follow the procedure below: 1. Select a format within the left format panel to activate the buttons on the right. 2. Click the button behind Application text field to specify an associated application. 3. If you want to run this specified application with some arguments, click the button and choose one from the appearing menu. The selected argument will be added to the intended place in the command. If no place is designated, the argument will be added at the end of the command. You can also add in several arguments by selecting them one after another using this button. Arguments can be the following: File Path, File Directory, File Name, File Extension, Current Directory, Resource Path, Version Number. 4. Click the button behind Initial Folder text field to specify the working directory of the program. 5. When done, click the OK button to accept the designation or Cancel to quit. 53

57 JReport Viewer Dialogs Viewing Results on Server If you want to view results on your local computer, check the View the results on server radio button, and the Application Association dialog box is pictured as below. Click the Browse... button to specify an application on the Web to run files of all formats. If you open a file for the first time using this way, an authorization by server is required. If you do not close the program that is being used, when you use it to open other files later, no authorization is needed. Notes: If no program is specified, In Windows platform, JReport Enterprise Viewer will search the operating system for a preferred application to run files of this format. If no application can be found, an Open With dialog will pop up. In non Windows platforms, JReport Enterprise Viewer will search Netscape to run files. If Netscape hasn't been installed, you will be given a warning message dialog telling an application is needed to be specified. You can choose whether to specify the application or not. Index Index Options Dialog When you fill in the full address to JReport Enterprise Server, as well as the initial path in this dialog, JReport Enterprise Viewer will automatically connect to JReport Enterprise Server when it starts up next time. 54

58 JReport Viewer Dialogs Home Encoding Auto Refresh Host of Server Either a numeric host or a named host of a web server. For example, it could be JRServer or Port The sever port or connection. Path to JReport Servlet The servlet path when JReport Enterprise Server is running as an independent servlet in the remote web server. If the JReport Enterprise Server runs as an independent web server, the path can be blank. Initial Path The path to browse when connecting with JReport Enterprise Server. If JReport Enterprise Server is running as an independent web server, it can be blank. Encoding Chooses an encoding formart for JREntViewer. Auto refresh the comments every... If checked, the resource tree, schedules, active schedules, and completed schedules will be refreshed automatically for the specified time period 55

59 JReport Viewer Dialogs Proxy Server Access JReport Enterprise Server through a proxy server If checked, JReport Enterprise Server is connected via proxy server. Address The proxy server host. Port The proxy server port. Socket timeouts in When the request is sent from the client end to JReport Enterprise Server, if there is no response in the specified time, the connection will be disconnected automatically. Export from local When viewing a report, JReport Enterprise Viewer will get the.rst file of the report from JReport Enterprise Server and export the report to any format on your local sever. Index Index Select Directory Dialog Clicking the button in some dialogs opens the Open directory dalog. 56

60 JReport Viewer Dialogs Directory Lists all the directories in the resource tree on the remote JReport Enterprise Server. Expand the resource node and select the directory for the report to be scheduled. If the node has previously been expanded, all its subnodes are cached. The tree will not be updated until you click on the Refresh button to refresh it. Files Lists all the files available in the selected folder. Flie name Displays the name of the file that has been selected. Files of type Specifies the type of the file. Refresh Refreshes the resource tree in the server. OK Applies your selection and exit the dialog. Cancel Closes the dialog and discard all changes. Help Displays this help document. Index Index Deployment Settings Dialog Right clicking on any node within the Resource Folder Panel and choosing Deploy on the shortcut menu opens the Deployment Settings dialog as pictured below. 57

61 JReport Viewer Dialogs To deploy resources in JReport Enterprise Viewer, follow the procedure below: 1. Click on the Browse... buttons to specify where the resource is to be deployed as well as from which path the resource comes. If JReport Enterprise Viewer and Server are at the same machine, please check the Deploy from local directory box, which means there is no need to upload files from client to server. 2. Specify a resource type from the Resource Type drop down list. Resource type can be one of the following: 3. Press the Load Tree button to load the resource tree. Resource that has been gotten will be listed in the left panel. You can specify which catalog, folder or report is to be deployed by checking the box ahead of them accordingly. 4. The right panel consists of two tabs. On the Properties tab, you can specify resource name, description, real path for the selected catalog, folder or report in the corresponding box. 5. If deploying a folder in the cluster environment, please make sure the Map Shared Disk option is checked, then the folder will be mapped instead of be copied. 6. Check the Archive Policy option to apply archive policy to the resource. 58