Welcome to the JReport Server User's GuideThis User's Guide describes JReport Server. JReport Server is a 100% Java report generation and management tool that can be deployed to any Java EE application server. By leveraging its high performance report generation engine, JReport scales to meet the most demanding requirements. Using the report scheduling, distributing and alerting capabilities of the JReport Server, reporting can be integrated into the workflow of the application. This guide is written for report administrators or system administrators of Java application that embed JReport reports into their application. Other JReport documentation This guide is one in the complete JReport documentation set. The documentation set includes the following: q Getting Started with JReport JReport Tutorial JReport Designer User's Guide JReport Desktop Viewer User's Guide JReport Server Monitor User's Guide Server API Javadoc Designer and Catalog API Javadoc q q q q q q What's New in This Release This document introduces the new features and significant enhancements of JReport in this release. JReport Server Live Improved Usability via a simpler interface and more tools that enhance productivity q Simplified Installation of Server Cluster: Server cluster can now be configured using properties files or via a browser UI in the Cluster > Configuration panel of the JReport Administration page. Enhanced User Interface is better organized for more intuitive use r q Component titles for web reports are now customizable directly at runtime Added option to show or hide the catalog and report file extensions displayed on the JReport Console and JReport Administration pages Consistent concept between Page Reports and Web Reports: Reports in Report Set have been replaced with a more intuitive Report Sheets in Page Report Format enhancement such as TTF with Bold/Italic support r r r q Extended End User Reporting Capabilities at runtime allow actions such as filtering, sorting and others to be saved along with the report, and then re-run, scheduled or exported with it Enhanced Data Source r q Support Web Services (both WSDL 1.1 and 2.0) as data sources XML data source with Target Namespace support r JReport Designer q Enhanced Chart r Additional chart properties including constant values and average values can be displayed graphically as an average line or a constant line Control whether or not to show the nodes at the highest or lowest point in each chart line with a defined color Control the position on X axis to show the data points and labels Pattern support on multiple lines as well as line nodes Customizable legend marks r r r r q Support for Google Maps Component helps users to visualize their data by combining it with geographic information More Robust, User Friendly Parameter Features q r End users can now specify cascading values to sort data in an ascending or descending order, or by using other fields as the cascading group Special characters can now be interpreted literally by JReport to replace the special characters with another string according to your database requirements JReport now permits the Special Field "UserName" to query data sources such as Imported SQLs, stored procedures, and user defined data sources in addition to JDBC connections, controlling data security easily via different server logins r r JDashboard (Beta) JDashboard provides enhanced information delivery to end users via rich visual components such as charts, maps, tables and web controls with a robust set of interactions. In no time your business questions can be answered directly, and results can be shared instantly with other key players across the organization. r Rich Internet Application (RIA) s Running components in Flash in addition to AJAX for a superior visualization experience Easy-to-use tools for developing rich, interactive applications Support most commonly used components such as Charts, Tables, Crosstabs, Sliders, Filter controls and etc. s s r User Friendly Dashboard Design s Predefined JReport library components enable end users to create a dashboard by only a few clicks and drag-and-drop Precise and pixel perfect layout with snap-to-grid option plus drag-and-drop operations for users to easily create and organize the dashboards s r Intuitive Interactions s One click for drilling down to detail On-screen filter, slider control for easier range filtering Linked report, runtime summary creation, etc s s r Auto-synchronous Components: JDashboard provides the mechanism for multiple components to instantly reflect a data change in one component and update all other components to keep information consistent Component Library: The Component Library can be customized to provide predefined complex components including 40+ chart types, tables, crosstabs, and web controls for users to use Open Architecture: API connectivity to 3rd party gadgets and widgets like Google Maps r r Resolved/Known Issues in This Release This document describes the resolved issues and any known issues for JReport Server in this release. Resolved issues Item 1 Case # 57991 Issue When JReport Server is running on a Linux system, the file history-parameter.xml now can be created automatically in <install_root>\realm\defaultRealm\<user name> after user checks Enable Saving Parameter Values, sets Maximum Number of Auto Complete Parameters List on JReport Administration page and then runs a report with parameters using the saved values. Resolved the java.lang.NullPointerException error when user runs a report using multivalue parameters with the option 'All' selected in the Enter Values dialog and then exports the report to Excel format. Now user can go to My Tasks > New Schedule to create a schedule successfully if he has been granted the corresponding schedule permission. Continue to support showing the status message for exporting reports. Reports using user's UDS data can now run completely on JReport Server. Adding labels to a web chart report is now supported in JReport Server 10.1 version. The European numerical format can now take effect on user's web reports after he sets -Duser.country and -Duser.language into his start up script files of JReport Server. Display chart labels in web reports. The Clear icon on the filter component can now work normally on DHTML reports running with IE browser. Now when user exports a report to Excel using JRClient, the summary cell can be adjusted automatically in the result file. JReport now works well in deleting contents under temp folder when shutting down JReport Server. JReport no longer mistakenly creates cache for each of user's dataset instances when the parameter's Allow Multiple Values property is set to true in JReport Designer. Users can insert, delete, or edit parameter form control now. Now when user selects or enters a new date parameter to a web report and then submits the parameter form control, the start date parameter is rendered as a text field with a calendar selector icon. Resolved the node displaying error when user tries to schedule a report using My Tasks > New Schedule. The e-mail address can now be displayed and modified normally after user schedules a report with an e-mail address that contains special characters such as single quote. The date parameter value are displayed normally in web reports if user sets the parameter option Use Current Date-Time When Blank to true in JReport Designer. Resolved the OutOfMemoryError when user tries to publish a zip file containing large catalog files using the option Publish to Remote Server on the JReport Console page. The NLS settings on user's main report can now be transferred to link report and detail report successfully. Resolved the java.lang.NullPointerException error when user does go-to actions in a DHTML report. 2 58195 3 4 5 6 7 58444 58554 58761 58783 58901 8 9 10 11 12 13 14 58932 59104 59172 59231 59388 59418 59429 15 16 17 18 19 20 59430 59446 59454 59457 59511 59772 21 22 59785 60076 Resolved the OutOfMemoryError when user runs a report on JReport Server. When exporting reports to DHTML, charts are rendered in the PNG format instead of JPEG format. Known issues Compiling formulas in JReport under JDK 6 or higher gets warnings Since generic type is introduced to JDK 6 or higher version, when compiling formulas in JReport under JDK 6 or higher, you may come across warning messages as follows: q Note: Test.java uses unchecked or unsafe operations. Note: Recompile with -Xlint:unchecked for details. q You may see that the situations are logged as Javac errors. However, the warning messages do not prevent Javac from creating .class files and reports can still run correctly. In this case, you can simply ignore the messages and logged errors. TOC Browser tree doesn't work well for reports with cached report bursting When end user runs a report which has been defined with some cached report bursting policy in JReport Viewer, if he opens the TOC Browser, he will be displayed with all the groups the report has instead of the ones he is supposed to view. In addition, no matter a group is allowed for him or not, he cannot click the group name from the TOC tree to get corresponding details. JReport will further enhance the cached report bursting feature in future release to resolve this issue. Report data get cut off in PDF result When you export a report to PDF format, if the report contains a large amount of data but its page mode was specified to be continuous page mode when it was designed in JReport Designer, or its page size was set to be larger than 200 inches, you will find that in the PDF result some data of the report are cut off. This is because in one PDF page, the data displayed can no larger than 200 inches. Derby cannot auto start in cross-computer integration By default, JReport Server uses the embedded Derby as the system database, and automatically starts the Derby database server (the start of Derby requires the JDK path). If you build a WAR/EAR on computer A and then integrate it into an application server on computer B, it is probable that the Derby database server cannot auto start using the JDK path on computer A. If you want to use Derby in an integration environment, you should update dbconfig.xml when building the WAR/EAR, and remove the following line from dbconfig.xml: <auto-start-derbyservice>true</auto-start-derbyservice> Then JReport will not try to auto start the embedded Derby server, and you need to start it by yourself. Derby can be started and stopped by using the batch files in <install_root>/derby/bin. There you will find startNetworkServer.bat/sh and stopNetworkServer.bat/sh. No entry for relogin after logging out with Google Chrome After logging out of JReport Console page with Chrome, there is no entry prompted for the login again. If you would like the relogin entry to be shown, you can set web.ie.login.use_new_realm_name=true in server.properties in the <install_root>\bin directory. API change jet.formula.ParamDesc.value has been set to private now. You can use getDisplayValue(DbValue paramvalue, java.util.Locale locale) instead. For example: ParamDesc desc = new ParamDesc(); ... ... desc.getDisplayValue(desc.getValue(), Locale.getDefault()); JReport Product Overview JReport is a complete Java reporting solution that provides sophisticated enterprise reporting, ad hoc reporting, and data analysis. A 100% Java EE architecture and a rich set of APIs allow JReport to be seamlessly embedded into any application, providing end users with a transparent interface to easily generate reports, share information, and analyze data. With JReport, any report can be made interactive, extending the "life" of a report by allowing users to easily sort, group, navigate, and filter via the Web. This wide range of functionality, including the ability to drill down on data, enables users to quickly derive value from their business intelligence. This chapter describes the JReport product in the following sections: q Features of JReport JReport product architecture Reporting a problem or requesting a feature Visiting our web pages for more information q q q Features of JReport JReport Designer supports report development. It provides the following key features: q Interactive IDE Sophisticated report design Precise, flexible layout Reusable report objects Access any data source q q q q JReport Server supports report generation and management. It has the following key features: q High performance engine Scale to any workload Seamless integration SDK Pure Java EE deployment Scheduling, distribution, alerting & versioning q q q q JReport Web supports information delivery. It has the following key features: q Interactive DHTML technology Dynamic sort, filter, drill, pivot, convert Ad hoc reporting Taglib to customize JSPs Flexible output formats: PDF, Excel, XML, RTF, e-mail and more q q q q JReport product architecture The JReport solution spans a 3-tier architecture. JReport Designer is a Swing-based Integrated Development Environment (IDE) that enables sophisticated report design and presentation of critical business data. It provides an intuitive interface, reusable report components, flexible layout, and a toolset for designing and testing reports. With JReport Designer, you can build reports using simple drag and drop techniques or by using the Report Wizard. Data can be accessed from any data source to design and preview reports in order to deliver information to end users in the most relevant and intuitive manner. Rapid creation and modification of report templates is accomplished by toggling between design mode and view mode where the report will be displayed with the actual dataset. Once report design is complete, the template is published to the JReport Server for generation, delivery, and management. JReport Server is a 100% Java report generation and management tool. It enables efficient management, sharing, scheduling, versioning, and delivery of reports and enables reporting to be integrated into the workflow of any Java application. The high-performance engine can scale to any workload. Report results can be saved to a versioning system, sent to enterprise/workgroup printers, or e-mailed. With JReport, reports can be viewed in any modern enterprise format including DHTML, HTML and standard business documents, such as PDF, Excel, and RTF. JDashboard delivers information using a user portal user interface rather than a report. Users can freely choose the objects they want to display in the dashboard, without having to know how these objects were created, what data sources to use, what styles to set, etc. A dashboard can hold multiple data components so that when browsing the dashboard users are able to see multiple data aspects. Within a dashboard, data components are able to communicate with each other via the message mechanism. This allows actions such as common filters to be applied to all the components of a dashboard even when coming from different data sources. JReport Viewer and JReport Studio enable reports to be accessed through a web browser via Dynamic HTML, or AJAX. With JReport Viewer and JReport Studio, reports can be modified using dynamic filter, sort, and drill capabilities. Using JReport Viewer and JReport Studio's advanced capabilities, users can drag and drop columns to and from an existing report, dynamically change chart types, pivot crosstabs, add groups, convert report components or create an entirely new report. JReport SDK - All JReport functionality can be accessed through Java APIs using JSP pages, servlets, or standalone applications. Reporting a problem or requesting a feature If you are having trouble running JReport Server or encounter any problems during reporting, take the following steps. 1. Check whether the system on which JReport Server is running meets the system requirements. 2. Check the JReport FAQ pages for frequently-asked questions and their solutions. If the problem persists, report it to Jinfonet Support (
[email protected]) with the following information: 1. Describe the precise steps leading to the problem. 2. Run the batch file jrenv.bat in the <install_root>\bin subdirectory. Running this batch file will generate a file called report.env in the current directory. Send this file to Jinfonet Support. Also, describe the operating environment, including machine type, CPU, memory, OS, and Java version. 3. If you are running JReport in an integrated Java application server, click the Server Information button on the JReport Administration page to list the environment. 4. Send Jinfonet Support the log file with the recorded JReport Server problems. r For a standalone server Start JReport with the batch file DJRServer.bat (.sh on Unix). Running this batch file will record the most detailed logging information and write them to the log files in the <install_root> \logs directory. Try to reproduce the problem, and send the log files along with the other information. For an integrated JReport Server If your JReport Server runs as a servlet inside a Java application server, send the log files generated by the JReport Engine in the application server. When the JReport Servlet is installed, a property file is generated which is used to define the class and arguments of the JRServlet. For example, if you integrated JReport Server into WebLogic, find the WebLogic properties file located in the installation path of WebLogic. Edit the file to use the option -vDebug -vError. Your file should then contain the following content: vError=true vDebug=true In addition, you can also directly add the java option -Dlogall=true (or -DvError=true, DvDebug=true) to the java command line within the launch file of the application server. After restarting your application server, reproduce the problem and send the log files to Support. r 5. Send Support the log files recording all of the logging information of engine and server (including event, error, debugging, access, management, and performance). r Change the configuration to record all logging events by starting the server and accessing the JReport Administration page through http://localhost:8889. a. Go to the Configuration > Log panel. b. Set the trace level of all logs to TRIVIAL, and set the error level of all logs to WARN. c. After that, reproduce your problem and send Support the log files in <install_root> \logs. In addition, you can also directly modify the logging configuration file LogConfig. properties in <install_root>\bin. If you set the server property log.config.update to true (all server properties are managed within the file server.properties in <install_root> \bin), any changes to the configuration file will automatically take effect at runtime after the specified update interval (set by the server property log.config.update.interval). r If your JReport Server runs as a servlet within a Java application server, in the address bar of a web browser, type in http://<hostname>/jreport/admin, where jreport is the servlet context path. 6. To reproduce your problem of running reports with JReport Server, we will often need your report, catalog and data information. a. Send Support the catalog file (*.cat and *.fml) and the report file *.cls that you are having problems with. b. In order to resolve technical issues that you have reported, we will need to access your report data so that we can recreate and analyze the problem. Your database may be very large. However, we will only require access to the data returned by the query of the troublesome report, and if necessary we will sign a confidentiality agreement with you. To extract the report data, in the Catalog Browser of JReport Designer, right-click the query that your report is using, select the menu item Create Cached Query Result. Then, input the data file name and click the Save button. The query result will then be saved in this file. Send Support all of the files generated (including the description file). Visiting our web pages for more information q Products information http://www.jinfonet.com/products/jreport-suite Release information http://www.jinfonet.com/products/whats-new News center http://www.jinfonet.com/news/jreport-news-highlights Demo center http://www.jinfonet.com/products/jreport-demo Products download center http://www.jinfonet.com/downloadjreport/ White papers http://www.jinfonet.com/products/white-papers JReport product documentation http://www.jinfonet.com/kbase.htm JReport Javadoc http://www.jinfonet.com/kbase.htm JReport technical support center http://www.jinfonet.com/support/ q q q q q q q q Installing and Uninstalling This chapter presents how to install JReport Server using a variety of different methods. It covers issues associated with installing, removing and solving problems encountered during installation. q System requirements JReport licenses Supported databases Installing using the Installation Wizard Installing silently Installing using the console interface Installing on Unix manually Uninstalling Solving installation problems JReport Server reporthome directory overview q q q q q q q q q System requirements The following table displays the basic system requirements for installing JReport Server. Check your system to make sure that all the requirements are met before installation. JReport Server System Requirements Recommended Requirements Minimum Requirements OS: CPU: Memory: Disk: JDK: Windows, Unix, Linux, z/Linux Intel Dual Core Xeon 2.8GHz 3 GB 1 GB free 6 or above Windows, Unix, Linux, z/Linux Intel P4 Xeon 3.0GHz 2 GB 1 GB free 6 or above Client Requirements Recommended Internet Explorer 6, Firefox 3, Google Chrome 5, and higher versions. You can download a JDK version at http://java.sun.com/javase/downloads/index.jsp. Notes: q Jinfonet supports Java VMs released by Sun and IBM to run with JReport Server. You can try using other Java VMs, but their compatibility cannot be guaranteed. Reports of any problems you find with other Java VMs are welcome. If you want to use JReport Server on a z/Linux system, you must download the JDK specially used for IBM from http://www-03.ibm.com/servers/eserver/zseries/software/java/ and the version should be at least V6. q JReport licenses JReport Server has 3 add-on licenses which can be added in addition to the JReport Server license. These licenses enable some specific features in JReport: JReport Live license, JReport Server cluster license, and JDashboard license. Contact your Jinfonet Software account manager to obtain your required license. JReport Live license The JReport Live license enables the use of web reports and ad hoc page reports and all their related functions. JReport Designer and JReport Server have separate live licenses. Live license for JReport Designer A JReport Live license for JReport Designer controls the data sources for ad hoc page reports and web reports and the creation of web reports from those data sources on JReport Designer. The Live license allows you to utilize the following features on JReport Designer: q Create and edit report cubes, business cubes, and business views. These are meta-data descriptions created in JReport Designer to be used as data sources for ad hoc page reports and web reports. They can be created on any type of data source such as JDBC, ODBC, XML and Web Services. Create web reports from business views. Export and print web reports. The following functions also require that JReport Server has a Live license: r q q q Preview web reports in JReport Studio. Publish web reports to JReport Server. Download reports which use business views, report cubes or business cubes as the data source from JReport Server. r r Live license for JReport Server A JReport Live license for JReport Server controls the real time ad hoc and analysis reporting on JReport Server. The Live license allows you to utilize all of the following features and functions on JReport Server: q Create, view, run, edit, export, print, and publish ad hoc page reports and web reports. The data sources for these reports are created in JReport Designer, which requires JReport Designer has a Live license. All actions in JReport Viewer (the browser for opening a DHTML format page report) involving report cube/business cube or changes of report template: r q Create new page reports or page report tabs Delete report tabs from a page report Add components and data fields into reports r r r Remove components from reports Move and resize components Edit component properties Drill Change chart type Rotate tables and crosstabs Convert between crosstab and chart Create query filters Display the Resource View panel which shows the data resources for the current open report tab r r r r r r r r JReport Server cluster license JReport Server cluster license enables a group of JReport Servers to work together with shared resources, load balancing, and failover in a distributed cluster. JDashboard license A JDashboard license enables the use of JDashboard and all related functions. JReport Designer and JReport Server have separate JDashboard licenses. Since JDashboard requires using business views as data sources, the JReport Live license is also required. JReport Designer and Server have separate Live licenses too. JDashboard license for JReport Designer A JDashboard license for JReport Designer allows for creation of library components which are used to build dashboards and publishing of library components to JReport Server. JDashboard license for JReport Server A JDashboard license for JReport Server enables the management of library components in the component library, the creation of dashboards using library components, and the use of dashboards. Supported databases JReport supports all of the current mainstream databases as well as most databases which support ODBC or JDBC drivers. The following table lists the databases and JDBC drivers that have been tested with JReport. If you are using any of the databases listed below, you are recommended to use the corresponding driver version with JReport although any driver which the DBMS supplier recommends is also fine. Also, if you encounter problems when using a database or driver version that is not listed here, you can contact Jinfonet Support (
[email protected]) for help. Database MS SQL Server MS SQL Server MS SQL Server MS SQL Server Oracle Version 2005 Driver File Name sqljdbc.jar JDBC Driver com.microsoft. sqlserver.jdbc. SQLServerDriver com.microsoft.jdbc. sqlserver. SQLServerDriver Example URL jdbc:sqlserver://<host>:1433;user=sa; password=1234;database=test jdbc:microsoft:sqlserver://<host>:1433 2000 msbase.jar; msutil. jar; mssqlserver.jar Opta2000.jar tds-1.0.3.jar JDK1.2&1.3: classes12.zip; JDK1.4: ojdbc14.jar JDK1.2&1.3: classes12.zip; JDK1.4: ojdbc14.jar classes12.jar 2000 2000 9i com.inet.tds.TdsDriver jdbc:inetdae7:<host>:1433? database=test net.sourceforge.jtds. jdbc.Driver oracle.jdbc.driver. OracleDriver oracle.jdbc.driver. OracleDriver oracle.jdbc. OracleDriver jdbc:jtds:sqlserver://<host>:1433/test jdbc:oracle:thin:@<host>:1521:ora9i Oracle 10.1.0.2.0 (10g) 11.1.0.6.0 (11g) 8.1 8.1 8.2 jdbc:oracle:thin:@<host>:1521:ora9i Oracle DB2 DB2 DB2 jdbc:oracle:thin:@<host>:1521:ora11g jdbc:db2://<host>/test Db2java.zi; db2jcc.jar com.ibm.db2.jdbc.net. DB2Driver Db2java.zip Db2jcc.jar; db2jcc_license_cu.jar (Linux, Unix and Windows); db2jcc_license_cisuz. jar (Linux, Unixand Windows, z/OS, OS/390,z/OS, iSeries etc) Db2java.zip redbrick.jar com.ibm.db2.jdbc.app. jdbc:db2:test DB2Driver com.ibm.db2.jcc. DB2Driver jdbc:db2://<host>:50000/test DB2 RedBrick warehouse Informix 8.2 com.ibm.db2.jdbc.app. jdbc:db2:test DB2Driver redbrick.jdbc. RBWDriver com.informix.jdbc. IfxDriver org.postgresql.Driver jdbc:rbw:protocol:<host>:5050/test/ jdbc:informix-sqli://<host>:1526/ stores_demo:informixserver=DBSC jdbc:postgresql://<host>:5432/test jdbc:mysql://<host>:3306/test 9.30 ifxjdbc.jar postgresql-8.0-310. jdbc3.jar PostGre SQL 8.0 MySql mysql5.0.18win32 mysql-connector-java- com.mysql.jdbc.Driver 5.0.3-bin.jar MySql mysql 4 mysql-connector-java- com.mysql.jdbc.Driver 3.0.14-production-bin. jar jdbc:mysql://<host>:3306/test MySql mysqlmysql-connector-java- com.mysql.jdbc.Driver 5.0.2-alpha- 3.1.5-gamma-bin.jar win mysql4.1.12win32 mysql 5 mysql-connector-java- com.mysql.jdbc.Driver 3.1.10-bin.jar mysql-connector-java- com.mysql.jdbc.Driver 5.0.4-bin.jar hsqldb.jar 12.5 12.5 jconn2.jar jconn3d.jar postgresql-8.0-310. jdbc2.jar CacheDB.jar derby.jar org.hsqldb.jdbcDriver jdbc:mysql://<host>:3306/test MySql jdbc:mysql://<host>:3306/test MySql HSQL Sybase Sybase jdbc:mysql://<host>:3306/test jdbc:hsqldb:D:\JReport\Demo\db \SampleDB com.sybase.jdbc2.jdbc. jdbc:sybase:Tds:<host>:5000/master SybDriver com.sybase.jdbc3.jdbc. jdbc:sybase:Tds:<host>:5000/master SybDriver org.postgresql.Driver com.intersys.jdbc. CacheDriver jdbc:postgresql://<host>:5432/test jdbc:Cache://<host>:1972/samples PostGre SQL 8.0 Cache Derby Cache 4 10.5.1.1 org.apache.derby.jdbc. jdbc:derby:D:\derby\demo\databases EmbeddedDriver \toursdb Note: If you want to use the DB2 app connection, you need to install the client and configure the net address first. Installing using the Installation Wizard Installing JReport Server with the Installation Wizard is intuitive. You only need to follow the screens and enter the required information. The Installation Wizard provides two installation types: q Typical Installation for Standalone Server Installs JReport Server with the default configuration settings. Custom Installation for Standalone Server Installs JReport Server in a standalone environment. If you choose this installation type, you can configure the server in the Installation Wizard. q This document shows you how to install the server to different systems with the Installation Wizard and configure the server according to your requirements. Installing on Windows To install JReport Server on a Windows platform, take the following steps: 1. Download the JReport Server installation file for Windows SvrSetup.exe from the Jinfonet download center: http://www.jinfonet.com/downloadjreport/. 2. Run SvrSetup.exe and follow the prompts to install. During installation, pay attention to the following: q The installer requires that you choose a Java JDK to complete the installation. You can download the appropriate JDK from http://java.sun.com or your computer vendors web site. The Installation Wizard will first find a JVM to get started. If no JVM is found, the JReport installer will fail to launch. To solve this issue, you can try either way: r q Set JAVA_HOME in system environment. Install JReport Server from a DOS command by specifying the LAX_VM option for the Installation Wizard as follows: SvrSetup.exe LAX_VM "C:\jdk1.6.0_17\bin\java.exe" The JDK path should use absolute path and be quoted by "". r q The installer provides a chance for you to add additional class paths. You can also choose to add them manually into the setenv.bat in <install_root>\bin after installation. If you select to install JReport Server in a folder that already contains an existing copy, the installer will replace the packages and create new batch/script files. Meanwhile, a copy of the old batch/script files will be kept for your reference. You should use the batch/script files that come with the installer in order to make sure that all new packages are added to the class path and manually merge any changes you made into the new version. q Installing on Unix JReport Server supports Solaris, Linux, HP-Unix, and AIX. In the following process, an X server is running and Java 1.5 or above is available, otherwise ask your administrator for help. Installing and running JReport Server requires that an X server has been configured. 1. Download the JReport Server installation file for Unix SvrSetup.bin from the Jinfonet download center: http://www.jinfonet.com/downloadjreport/. If you need to transfer the installation file from your download machine to your Unix box, you should transfer it using FTP in binary mode. 2. Click the executable file SvrSetup.bin to launch the Installation Wizard. Alternatively, you can open a console window, and change the directory to the location of the SvrSetup.bin file. Following are examples of the commands that can be used: $ cd /opt/JReport/Server (or your preferred install location) To make SvrSetup.bin executable, type the command: $ chmod +x SvrSetup.bin Run SvrSetup.bin: $ ./SvrSetup.bin The Installation Wizard will first locate a JVM to get started. If no JVM is found, the installer will fail to launch. To solve this issue, you can try either way: r Set JAVA_HOME in system environment. Specify a JVM for Installation Wizard with the option LAX_VM as follows: $ ./SvrSetup.bin LAX_VM "/opt/jdk1.6.0_17/bin/java" The JDK path should use absolute path and be quoted by "". r 3. Once the Installation Wizard has successfully loaded, you can follow the standard prompts to install JReport Server. Installing on z/Linux JReport Server supports Linux on IBM system z. In the following process, an X server is running and a JDK specially used for IBM is available, otherwise ask your administrator for help. Installing and running JReport Server requires that an X server has been configured. 1. Download the JReport Server installation file for z/Linux SvrSetup.bin from the Jinfonet download center: http://www.jinfonet.com/downloadjreport/. If you need to transfer the installation file from your download machine to your z/Linux box, you should transfer it using FTP in binary mode. 2. Click the executable file SvrSetup.bin to launch the Installation Wizard. Alternatively, you can open a console window, and change the directory to the location of the SvrSetup.bin file. Following are examples of the commands that can be used: $ cd /opt/JReport/Server (or your preferred install location) To make SvrSetup.bin executable, type the command: $ chmod +x SvrSetup.bin Run SvrSetup.bin: $ ./SvrSetup.bin The Installation Wizard will first locate a JVM to get started. If no JVM is found, the installer will fail to launch. To solve this issue, you can try either way: r Set JAVA_HOME in system environment. Specify a JVM for Installation Wizard with the option LAX_VM as follows: $ ./SvrSetup.bin LAX_VM "/opt/ibm-java2-sdk-6.0/bin/java" The JDK path should use absolute path and be quoted by "". r 3. Once the Installation Wizard has successfully loaded, you can follow the standard prompts to install JReport Server. Configuring the server When installing JReport Server using the Installation Wizard, if you choose Custom Installation for Standalone Server, you can configure the server according to your requirements during the installation. You can configure the following items: q Service Cluster E-mail Cache r q q q Cache Loaded Catalogs Specifies whether to keep a catalog in memory, or to remove it from memory after a report is completed. Normally, after a report has been generated, the catalog that is used to generate the report will be removed from memory. However, if you specify this option, the catalog will be cached rather than removed. Cache Loaded Reports Specifies whether to keep the reports in memory or remove them from memory after they have been generated. q Performance Pre-loading the Java classes and fonts which are used by catalogs, reports and JReport Engine at startup time will improve performance when these classes are needed at runtime. r Preload Catalog Referred Classes Pre-loads the Java classes that are used for a catalog. Preload Report Referred Classes Pre-loads the Java classes that are used for a report. Preload Engine Referred Classes Pre-loads the Java classes that are used by JReport Engine to generate reports. Preload Fonts Specifies to load the fonts when JReport Server is started rather than when they are first used. r r r r Maximum Number of Concurrent Reports in the Queue Specifies the maximum number of concurrent reports in the queue, which must be less than or equal to the number that the license permits. Advanced Data Source q q Installing silently JReport provides two files for installing JReport Server silently without user participation in the installation process. It is ServerInstall_typical.properties for the Typical Installation for Standalone Server type and ServerInstall_custom.properties for the Custom Installation for Standalone Server type. Follow the steps below to install JReport Server silently: 1. Download the appropriate file from the Jinfonet website according to your requirement. 2. Some built-in demo reports (\SampleReports\*.cls) with Derby as the data source (install_root\db \SampleDB.script) have been provided. At the end of the installation, the installer will configure the reports and catalog to the correct data path. This calls some AWT classes that require GUI support. So, if you have an X server installed, you should set the Display variable so that this step can be performed successfully. $ DISPLAY=hostname(or IP address):0.0 $ export DISPLAY Note: If you do not have X server or a pure text environment, this step can be ignored. However, you may find that the demo reports will not be able to run after you start the JReport Server due to having the wrong default data source path. In this case, you can use JReport Designer to publish some working reports for testing purposes. 3. Run the following command, and JReport Server will be installed in the designated path: $ ./SvrSetup.bin -i silent -f ServerInstall_typical.properties Notes: q When installing JReport Server silently, make sure you do not use overwrite installation, instead, install the server to a new directory. When you install the Update or Service Pack silently, edit the file update.properties in <install_root>\help\server\en\samples to your own requirements. This file is used to create an option file (i.e. response file) for the Installation Wizard. It predefines all the information that is required for the installation. You can also create a property file and save it as follows: USER_INSTALL_DIR=/usr/local/JReport/Server USER_KEY=UID USER_PASSWORD=Password Modify the above lines according to your own environment and configurations. q Installing using the console interface JReport enables you to perform an interactive installation from a command prompt on platforms that do not have GUI. In this way, you are able to see the installation status and follow the installation process. Take the following steps to perform console installation: 1. Download the installation program (SvrSetup.bin for Unix and z/Linux, SvrSetup.exe for Windows) from the Jinfonet download center: http://www.jinfonet.com/downloadjreport/. 2. Run the following command: For Unix and z/Linux: $ chmod +x SvrSetup.bin $ ./SvrSetup.bin -i console For Windows: SvrSetup.exe -i console 3. Make decisions following the installation process. Installing on Unix manually In some rare cases, JReport Server may fail to install on Unix directly. In this case, follow the steps below to install it manually: 1. Install JReport Server on Windows following the steps in Installing on Windows, but don't start it. 2. Prepare a directory on Unix where you will copy the installation, for example /opt/JReport/ Server. 3. Modify javahome and reporthome in the following files to the Unix directories where the Java JDK is located and the directory you are going to copy the release to. Be sure to modify them carefully. Any mistake will cause problems starting JReport. report.ini servlet.properties setenv.sh 4. Delete the file server.properties from <install_root>\bin if it exists and remember to reset the required configuration settings on the JReport Administration page (8889 as the default port) after launching JReport Server on Unix. The server.properties file is created if you use the custom format to install. 5. Make a zip or jar archive of the above folders, and then copy it to your Unix system (use binary format if using FTP). 6. Extract the folder in the destination directory in accordance with the path defined in the property files. 7. Use the dos2unix command to convert all the .sh files under <install_root>/bin to the format that can be recognized by Unix. You can execute the command like this: $ dos2unix *.sh 8. Use the chmod command to set the converted files under <install_root>/bin to have read, write and execute permission. You can execute the command like this: $ chmod 777 *.sh 9. Start a shell (Console) and login as root or become the root user by running the su command. Make JRServer.sh executable and then start JReport Server by running ./JRServer.sh. Note: If you fail to intall JReport Server on your z/Linux system directly, you can also follow the above steps to install the server manually. Uninstalling Use either of the following methods to remove JReport Server: q From the Control Panel, open Add or Remove Programs, and then select JReport Server 10.1 to uninstall it. Run uninstaller.exe (uninstaller on Unix) in <install_root>\_uninst. q Note: The uninstaller will remove all the files generated by the installer, while the files that are created later by the program will be retained. They should be removed manually. Solving installation problems This section is trying to help you solve the problems you encounter during the installation. Where to find log information If error occurs during the installation, you can check the log information recorded to find out what the problem is. Where logs are generated depends on when the installation process get stuck: q If the installation is cancelled before you click the Install button on the installation wizard, logs are created on the desktop for Windows and in the userhome directory for Unix/Linux. If the installation is cancelled after you click the Install button on the installation wizard, logs are created in the logs folder in the installation root directory. q Besides, on a Windows platform, you can choose to specify the log destination that should use absolute path and log file name when launching the installation wizard: SvrSetup.exe -D$INSTALL_LOG_NAME$="Install.log" -D$INSTALL_LOG_DESTINATION$="D:\temp" or $ ./SvrSetup.bin -D$INSTALL_LOG_NAME$="Install.log" -D$INSTALL_LOG_DESTINATION$="/opt/ temp" Feel free to send your questions to
[email protected]. An issue on Windows Vista Problem When running JReport Server's installer on Windows Vista, the installer cannot find the installed JDKs. Reason By default Vista's security settings are stricter than Windows 2000, XP, and 2003. The children processes do not inherit the execution right from their parent process. Solution Make the compatibility property of the installer file (.exe) available: 1. Right-click the installer file, and select Properties from the shortcut menu. 2. In the Compatibility mode panel of the Compatibility tab, check the Run this program in compatibility mode for option, and then select Windows 2000 from the drop-down list. 3. Click OK. 4. Run the installer. JReport Server reporthome directory overview This section provides a general view of the directories in the JReport Server installation root, including what they contain, what they are used for, and how to set their location if possible. The following is a list of the server reporthome directories: Directory _uninst bin db Demo dynamicclasses Contents Files used for uninstalling the JReport Server Command, configuration, and properties files Demo reports' database Demo reports used in the tutorial lessons UDS jar/zip files Directory location Configurability Fixed. Fixed. Fixed. Fixed. The directory location can be specified by the server.dynamic.class.dir property in the server.properties file in <install_root>\bin. The directory location can be specified by -Djreport.server.font.path or by the server.font.path property in the server. properties file in <install_root>\bin. Fixed. font TTF font help Help documents introducing the function, features and usage of JReport Server and JReport Designer together with Tutorial manual. Version files history The directory location can be specified by the servlet.jrserver.initArgs property in the servlet.properties file in <install_root>\bin. Fixed. Fixed. images jreports Public images for DHTML Demo reports. When scheduling a task to disk, the directory refers to the destination root of the server resource tree. lib logs ntservice Library files required by JReport runtime Log files Files for C program and for writing a Windows NT-service to run JReport Server Reads customized configuration for launching JReport Console and Administration pages from the Start menu. Profiling related files Default location for JReport Server realm database Fixed. The directory is the default location for log files. Fixed. prestart Fixed. profiling properties Fixed. The directory location can be specified using the URL option on the JReport Administration page > Data > Realm DB > Configuration tab. Fixed. public_html Standalone web app folder realm resources scratchdir Realm files Language packages for specifying JReport Server UI language. Output files of compiled JSPs Fixed. Fixed. The directory location can be specified by the servlet.jspservlet.initArgs property in the servlet.properties file in <install_root>\bin. Fixed. The directory location can be specified by stylePath in the report.ini file in <install_root>\bin. For Engine temp files, the directory location can be specified by tempPath in the report.ini file in <install_root>\bin. Fixed for Server temp result files. script_files style Script files for creating and deleting system database tables CSS style files and style group files temp Engine temp files and Server temp result files txtdriver Demo reports' flat data files Optional. Upgrading from a Previous Version Upgrading a standalone JReport Server and an integrated JReport Server involves different processes while sharing some common steps. Both updated JReport Servers require converting the report resources in the old version in order to comply with the new server version. Upgrading in a standalone environment JReport Server 10.1 provides two migration tools in <install_root>\bin folder, which can help you to convert all the resources on the previous version of JReport Server before version 6.0. Resources the migration tools cover include the security information (realm, user, group, protection, and ACL), report resources (catalog and reports), scheduled tables, completed tables, version and version tables, and other relevant information (such as fonts, NLS, and style groups). For versions later than V6.0 (included), the upgrade is performed automatically by JReport Server 10.1. You need only install JReport Server 10.1 into the same directory as the old server version. Note: When installing the JReport Server 10.1 into the same directory as the old version, the report level resources in the old version will be maintained and not be replaced by the report resources of V10.1. Upgrading a version between V5.2 Build 590 (included) and V6 (excluded) to V10.1 You can make the upgrade using the migration tool MigrationV52.bat (MigrationV52.sh for Unix) that is available in the <install_root>\bin folder. This tool is used to convert all the resources of the versions between V5.2 Build 590 (included) and V6 (excluded) to the resources of JReport Server 10.1. If you install the new version to the same folder as the old one, the parameter can be omitted. q Usage MigrationV52 [orgReportHome] Options r q orgReporthome The reporthome of the original JReport Server. If this parameter is not provided, the reporthome of JReport Server 10.1 will be used as its value. Case 1: Installing JReport Server 10.1 to a new folder (recommended) 1. Provided that the old JReport Server is located in C:\JREntServer595. Install JReport Server 10.1 to a new folder C:\JReport\ServerV10.1. DO NOT start the newly installed JReport Server. 2. In the DOS window, switch to <install_root>\bin, and run MigrationV52 C:\JREntServer595. Case 2: Installing JReport Server 10.1 to the folder where the old version resides 1. Provided that the old JReport Server is located in C:\JREntServer595. Install JReport Server 10.1 to the same location. DO NOT start the newly installed JReport Server. see Building a WAR/EAR file to include a self-contained JReport Server. If you install the new version to the same folder as the old one.bat.1 to the folder where the old version resides 1.2 Build 590 (excluded): in the DOS window. q Usage MigrationBV52 [orgReportHome] Options r q orgReporthome The reporthome of the original JReport Server. and run MigrationV52. Case 2: Installing JReport Server 10.2 Build 590 (included) and V6 (excluded): in the DOS window. the parameter can be omitted. Provided that the old JReport Server is located in C:\JREntServer580. and run MigrationBV52. switch to <install_root>\bin. if the previous version of JReport Server is later than V6. If the parameter is not provided. Upgrading in an integration environment 1. whether it is installed directly or upgraded from a previous version.1 to the same location.2 Build 590 to the resources of JReport Server 10. For a previous version between V5.1. 3.2 Build 590 (excluded) to V10. Provided that the old JReport Server is located in C:\JREntServer580. But if the previous version is earlier than V6. switch to <install_root>\bin. DO NOT start the newly installed JReport Server. and run MigrationBV52.bat (MigrationBV52. switch to <reporthome>\bin. 2. For information on how to create the WAR/EAR. switch to <reporthome>\bin. 2. DO NOT start the newly installed JReport Server.2. In the DOS window. In the DOS window.1.1 to a new folder (recommended) 1. This tool is used to convert all the resources of versions lower than V5. Use the JReport Server 10.1 to a new folder C:\JReport\ServerV10. In this step you need not convert the old version reports. .sh for Unix) that is available in the <install_root>\bin folder. 2.0 (included). By now.1 You can do the upgrade using the migration tool MigrationBV52. Upgrading a version earlier than V5. Suppose that you already have a standalone JReport Server 10. Use the Java application server that integrates the previous version of JReport Server to deploy the new self-contained WAR/EAR and update the old WAR/EAR with the new.bat. Case 1: Installing JReport Server 10.1. Install JReport Server 10.0. In the DOS window.bat. the reporthome of JReport Server 10. and run MigrationV52. For a previous version earlier than V5.1 to create a self-contained WAR/EAR file.1 will be used as its value. 4. the integrated JReport Server has already been upgraded to V10. go to step 4 and you need do further upgrade.bat.1. and run MigrationBV52 C:\JREntServer580. switch to <install_root>\bin. Install JReport Server 10. . Launching After you have installed JReport Server. The following topics are discussed in this chapter: q Setting up the reporting environment Running as a standalone server Running as an OS service Running within an application server q q q . This chapter provides you with detailed information of how to run JReport Server in different running modes. you must set up the reporting environment and start it before you can access it via a web browser. q q Data sources You may have your own catalogs and reports that you developed. JReport Server has its own resource tree with each node mapping to a folder or file in your physical drive. In order to do this. However. JReport Server is a high performance server for running reports on demand or unattended on a scheduled basis. It facilitates easy re-use of the report's layout. it is better to first check the reporting environment to see whether you have published the reports including the catalog files. That not only the report files. In addition. For example.Setting up the reporting environment Now that you have installed JReport Server. but also the catalog files (including the . Today. thousands of clients may view. Additional class paths If your reports reference any external classes. computing is a service-based model in which web based applications are rapidly replacing monolithic fat-client hosted and maintained software applications. you will need to add them to the class path option in the batch file and command line that starts JReport Server. one directory can only contain one catalog. Report files built with JReport Designer can then be published to JReport Server for running in the thin-client/server mode. it is recommended that you check: q Whether the report files reside somewhere in the server machine. and set up the data sources. If you are using JReport Server embedded in an application server. So when publishing report files to the server. User data source Append the class path of your user class files to the first item of the class path set in your batch file or command line that starts JReport Server. Whether the files are mapped in the resource tree. However. it can contain many report files which use that catalog. if your reports contain user defined objects (UDO) or user defined formula functions. and want them to be run and be distributed by JReport Server. you can start it. do not forget to add them to the class path or to the WAR file. . add your user class files to the WAR file used to deploy JReport Server. In this environment.fml file) exist and are in the same directory. the data sources used by your catalogs must be correctly set to the runtime environment of JReport Server. print and generate new reports. Report publishment & creation The separation of the report file and the data is powerful. added the necessary class paths. q Starting using launch files Starting using Java Sending commands to JReport Server from Java Running without a GUI q q q . This section explains how to start JReport Server as a standalone report server. how to send commands to the server and how to use the batch files in the <install_root>\bin directory.Running as a standalone server JReport Server can be started from the web application server contained in the JReport Server package. bat/CmdSender. -w The admin password. the JVM system property "reporthome" must be defined so that CmdSender.bat This tool detects the default client browser and installation path. localshutdown Shuts down the local server.Starting using launch files After you have installed JReport Server. gc Run the Java garbage collector. make sure that you understand their functions when you want to edit them. All of these batch files can be edited to suit different circumstances.bat. If the option "-s" or "-p" is not used. The following are the JReport Server launch files. -p The administration port. q q q q q q q . It is invoked by launchpad. many batch files are automatically generated in <install_root>\bin.sh will use it to get data from the local machine. local The administration tasks are available to local host only. Usage cmdsender [-s:<server> -p:<port> -u:<user>] -w:<password> admin|shutdown|localshutdown|(local:on|off) Options q -s The server host name. CmdSender. -u The admin user name.sh This tool is for sending commands to JReport Server.bat/CmdSender. browser. However. They are for assisting you with using and maintaining JReport Server. shutdown Shuts down the server. server <host:port>|-cleanup] Options q -? Prints this help message. DJRServer.sh This tool is for administrators to backup and restore JReport Server data. q .sh This tool is used to launch JReport Server with debug and log information. -cleanup Checks integrality of the server data and cleans up the invalid data. you may run this batch to reproduce the problem. Usage DJRServer [-?|-p <port>|-ap <adminport>|-realm <realmname>|-l backlog|-m <max> |-t <timeout>|-s <filename>|-web <directory>|-env|-silent| |-local|-vDebug|-vError|-jrs.com if you are unable to resolve the problem. The output log files are in the <install_root>\logs directory.bat/DJRServer.dat. Open the files to see the detail information and find out the problem. you can type: DBMaintain -Rrealmtables:c:\jsback. For example. Send the log files to
[email protected] q q q -B0realmtables:<filename> Only backup the data in the realm database.DBMaintain. you can type: DBMaintain -Brealmtables:c:\jsback. It is invoked by the following command line: Usage DBMaintain -[?|cleanup|B<[systemtables|realmtables|profiling]:<filename>>|R<[systemtables| realmtables|profiling]:<filename>>] Options q -? Displays the usage information and then exits. -Bsystemtables:<filename>/-Brealmtables:<filename>/-Bprofiling:<filename> Backup the data in the database with the related data to a specified file. For example.bat/DBMaintain. -p <port> The port number to listen on.dat. for backing up the server data realmtables to file c:\jsback.admin. for restoring server data realmtables from the file c:\jsback.dat q q -R0realmtables:<filename> Only restore the data in the realm database. -Rsystemtables:<filename>/-Rrealmtables:<filename>/-Rprofiling:<filename> Restore the data including the related data outside the database from a specified file. In case of problems. If this option is not used. -local The administration tasks are available on local host only. q q q q q q q q q q q q q JRServer. -cleanup Checks integrality of the server data and cleans up the invalid data. -web <directory> The root directory when accessing the server via the web. its default value is <intall_root> \public_html. -vDebug Enables JReport Engine to output messages to a file and sets all log files' trace levels to INFO and error levels to WARN. -m <max> The maximum number of connection handlers. -s <filename> The servlet property file name. you can start server by double-clicking on JRServer.q -ap <adminport> The port number which is used by the administration tools. -env Prints the environment. the file servlet. If you cannot start the server successfully in this way.bat. -silent No output is sent to the console. the reason will be displayed in the MS-DOS command prompt.properties in <install_root> \bin will be used as the servlet property file when launching JReport Server. -t <timeout> The connection timeout in milliseconds. Usage JRServer [-?|-p <port>|-ap <adminport>|-realm <realmname>|-l backlog|-m <max> .sh This tool is used to launch JReport Server in standalone mode without any predefined options. On Windows.bat/JRServer.server <host:port> The admin server host and RMI port.admin. -l <backlog> The maximum queue length for incoming connections. -jrs. -realm <realmname> Specifies the active realm. -vError Enables JReport Engine to output messages to a file and sets all log files' trace levels to OFF and error levels to ERROR. -env Prints the environment. -p <port> The port number to listen on.server <host:port> q q q q q q q q q q q q q q q q . -logall Sets all loggers' trace level to INFO and error level to WARN.properties in <install_root> \bin will be used as the servlet property file when launching JReport Server. -vError Enables JReport Engine to output messages to a file and sets all log files' trace levels to OFF and error levels to ERROR. -t <timeout> The connection timeout in milliseconds. -ap <adminport> The port number which is used by the administration tools. -local The administration tasks are available on local host only. -silent No output to the console.admin. -m <max> The maximum number of connection handlers. -realm <realmname> Specifies the active realm. -jrs.|-t <timeout>|-s <filename>|-web <directory>|-env|-silent| |-local|-vDebug|-vError|-logall|-jrs. -web <directory> The root directory when accessing the server via the web. -l <backlog> The maximum queue length for incoming connections. its default value is <intall_root> \public_html. -log[:file Name] (deprecated) Outputs JReport Engine messages to the log file as specified and uses the -vDebug level. -s <filename> The servlet property file name.admin. If this option is not used. -vDebug Enables JReport Engine to output messages to a file and sets all log files' trace levels to INFO and error levels to WARN.server <host:port>|-cleanup] Options q -? Prints this help message. the file servlet. makewar.encoding option in the file to start JReport Server in order to view characters correctly. the value of "reporthome" of new JReport Server will be used as its value.bat/MigrationBV52.bat/makewar.bat/MigrationV52. the parameter can be omitted.env in the current directory.sh This tool is used to convert all the resources of which the versions are between V5. Usage MigrationBV52 [orgReportHome] Options q orgReporthome The reporthome of the original JReport Server. You may also need to set an appropriate -Dresolution option in the file to start JReport Server in order to set the system resolution in DPI.sh This tool is for generating the report environment file report. MigrationBV52.2 Build 590 to the resources of JReport Server V8. This file can help the Jinfonet support staff assist you when you run into problems.sh See here. q -cleanup Checks integrality of the server data and cleans up the invalid data.2 Build 590 (included) and V6 (not included) to the resources of JReport Server V8. If this parameter is not provided.The admin server host and RMI port. q jrenv. Usage MigrationV52 [orgReportHome] . launchpad. Notes: q You may need to set an appropriate -Dfile. the parameter can be omitted.bat/jrenv.bat This tool is used to launch JReport Server in the standalone mode and open the JReport Server Launch Pad page. MigrationV52.sh This tool is used to convert all the resources from JReport versions which are lower than V5. If you install the new version to the same folder as the old one. If you install the new version to the same folder as the old one. the value of "reporthome" of new JReport Server will be used as its value. try this batch file instead of JRServer. -env Prints the environment. -ap <adminport> The port number which is used by the administration tools. -realm <realmname> Specifies the active realm. its default value is <intall_root> \public_html.server <host:port>|-cleanup] Options q -? Prints this help message. -m <max> The maximum number of connection handlers.Options q orgReporthome The reporthome of the original JReport Server. Usage NJRServer [-?|-p <port>|-ap <adminport>|-realm <realmname>|-l backlog|-m <max> |-t <timeout>|-s <filename>|-web <directory>|-env|-silent| |-local|-vDebug|-vError|-logall|-jrs.admin. If your server often crashes with JIT option. q q q q q q q q q q q .sh This tool is used to launch JReport Server without JIT option. -t <timeout> The connection timeout in milliseconds. If this option is not used. -s <filename> The servlet property file name. the file servlet. -local The administration tasks are available on local host only.bat/NJRServer. -web <directory> The root directory when accessing the server via the web.properties in <install_root> \bin will be used as the servlet property file when launching JReport Server. -p <port> The port number to listen on. NJRServer. -silent No output to the console. -l <backlog> The maximum queue length for incoming connections.bat. If this parameter is not provided. If only input this argument. JReport Server uses the authentication file to secure remote objects. -vError Enables JReport Engine to output messages to a file and sets all log files' trace levels to OFF and error levels to ERROR. If no argument was provided.q -vDebug Enables JReport Engine to output messages to a file and sets all log files' trace levels to INFO and error levels to WARN.sh This tool is for replacing user ID and license key.bat It is invoked by browser.auth" will be created in <install_root>\bin.sh This tool is used to generate the rmi authentication file. Usage . -logall Sets all loggers' trace level to INFO and error level to WARN. the userid and install key of JReport Server will be used to create the authentication file. userid The user ID.bat/RMIAuthFileCreator. authFileName The RMI authentication file name. -jrs.bat. which will be used to generate the contents of the authentication file. Usage RMIAuthFileCreator [authFileName [userid key]] Options q ? Shows the usage message. -cleanup Checks integrality of the server data and cleans up the invalid data.admin. q q q q q register.server <host:port> The admin server host and RMI port. q q q rp. an authentication file named "rmi. key The key which will be used to generate contents of the authentication file. RMIAuthFileCreator. -log[:file Name] (deprecated) Outputs JReport Engine messages to the log file as specified and uses the -vDebug level. using the userid and install key of JReport Server.bat/rp. cls". the converted reports are saved in the same directory as the source reports and named as "converted_SourceReportName".xml" This will convert C:\JReport\Server\jreports\SampleReports\InvoiceReport. and name it as "1. If both "-r" and "-target" are not specified. save the converted report to C:\temp. including the reports in all subdirectories. If this option is set.xml" (if license allows). rptconv "-source=C:\JReport\Server\jreports\SampleReports\InvoiceReport. Usage rptconv "-source=source_path" ["-target=destination_path"] [-r] [-s] Options q -source Specify the source path of the reports that are to be converted.cls. q q q -s Convert all the reports in the specified directory.rp UID Key rptconv. save the converted report in the same directory. -target Specify the destination path for the converted reports.cls" "– target=C:\temp" This will convert C:\JReport\Server\jreports\SampleReports\InvoiceReport. rptconv "-source=C:\JReport\Server\jreports\SampleReports\InvoiceReport. Examples q To convert a single report: rptconv "-source=C:\JReport\Server\jreports\SampleReports\InvoiceReport. rptconv "-source=C:\JReport\Server\jreports\SampleReports\InvoiceReport.cls.cls. . -r Replace the source report with the converted version.cls" -r This will overwrite C:\JReport\Server\jreports\SampleReportss\InvoiceReport. and name it as "converted_InvoiceReport.cls" "– target=C:\temp\1.cls. *. The converted reports use the same file names as source reports.sh This tool is for converting old report schema to be current version.cls" This will convert C:\JReport\Server\jreports\SampleReports\InvoiceReport. q To convert all reports (*.cls.xml) in a directory: rptconv "-source=C:\JReport\Server\jreports" "–target=C:\temp" This will convert all the reports in C:\JReport\Server\jreports and save the converted reports to C: \temp. ["-target=destination_path"] is ignored.rpt.bat/rptconv. *. *.cls to C:\temp \InvoiceReport.cls.clx.cls.cls. sh.rptconv "-source=C:\JReport\Server\jreports" "–target=C:\temp" -s This will convert all the reports in C:\JReport\Server\jreports and in the subdirectories and save the converted reports to C:\temp. rptconv "-source=C:\JReport\Server\jreports" -r -s This will convert all the reports in C:\JReport\Server\jreports and in the subdirectories.bat/rptconv.sh . rptconv "-source=C:\JReport\Server\jreports" This will convert all the reports in C:\JReport\Server\jreports. The converted reports take the same file names and directory structure as source reports. If the reports to be converted contain UDO or UDF.bat This tool is used to exit JReport Server from the Start menu.cls" in C:\JReport\Server\jreports \SampleReports and save the converted reports to C:\temp. Notes: q There must be one and only one catalog file in the directory where the reports to be converted reside.cls". All the converted reports are saved in the same directory and named as "converted_SourceReportName". make sure the corresponding classes or jars are included in the class path of rptconv. stopServer.bat This tool is used to launch the JReport Administration page from the Start menu after the server is started. q startAdministration. q To convert a type of reports with same suffixes in a directory: The usage is similar to converting a directory. for example: rptconv "-source=C:\JReport\Server\jreports\SampleReports\*. startConsole. You can specify the wildcard to filter reports.bat This tool is used to launch the JReport Console page from the Start menu after the server is started.cls" -s This will convert all the reports in C:\JReport\Server\jreports and in the subdirectories and save the converted reports to C:\temp. stopServer. The converted reports take the same directory structure as source reports and the suffixes of their file names are all changed to ". rptconv "-source=C:\JReport\Server\jreports" "–target=C:\temp\*.cls" "–target=C:\temp" This will convert all the reports with the suffix ". The converted reports overwrite the source reports. This tool is used to exit JReport Server. . jar. You can start JReport Server with the following command instead of using the generated batch files: JAVA -classpath <classpath> -Djava. The server will then record a warning message in the log file. template and the help path. For example: java .server.encoding=8859-1. Active realm when the server starts up. Open report. the system default resolution will be used. Maximum number of connection handlers. However.. and you will find the configuration information.encoding Specifies the encoding to encode/decode escape characters in the server data. When you set the reporthome.realm. for example. -Djreport. -Dreporthome This is where JReport Server is installed. otherwise the server will use an existing realm as the active realm..jar. This is not a required option. Servlet property file name.dat is the License control file. -Dresolution Sets the system resolution in DPI.2.active property in the server. JReport will use the temp path to export the temporary files so you should make sure that the temp folder specified in report.. The specified realm should exist. For example: java . and set the selected active realm by the server. default is 8889.compiler=NONE This is without JIT.. Connection timeout in milliseconds.ini. the system default encoding will be used.JREntServer. The port number that the remote administration uses. -Djreport.dat and report. default is 8888. including the temp. you can try turning off the JIT compiler and then running again. -Dresolution=96.server. if you encounter problems running the server and you think that they relate to the Java VM.. This option is required.ini exists and has space available. JReport will try to find the jslc. log4j-1. If not specified. If not specified. JREngine.jar. -Dfile.encoding Specifies the encoding to encode/decode escape characters in URL strings.url. It is the Destination Location you specified when you installed it.properties file.. which is the resolution of your monitor. q q q q q q . JREntServer.ini files in <install_root>\bin and check whether they are valid. Jslc. servlet. [options] Option -? -p port -ap adminport -l backlog -m max -t timeout -s filename -realm realmname Description Print brief help message. upon launching.encoding=8859-1.compiler=NONE -Dreporthome=<install_root> jet. Maximum length of queue for incoming connection indications.url. If not specified. The port that this server listens on.jar.8. the system default encoding will be used.Starting using Java The class of the standalone server is jet.. JREntServer [options] q -classpath The class path must include the following packages originally in your <install_root>\lib: JRESServlets. -Dfile. -Djava.jar.. Notes: q For detailed information on how to configure the logging and debugging information. Outputs JReport Engine messages to the log file as specified and uses the vDebug level.-web directory -local -vDebug -vError -env -silent -log[:file Name] (deprecated) -logall -jrs. Checks integrality of the server data and cleans up the invalid data.properties file in <install_root>\bin. You can find these in the <install_root>\bin directory. not even the server start information. The admin server host and RMI port. Administration on local host only. Enables JReport Engine to output messages to a file and sets engine log file's trace level to INFO and error level to WARN.admin. Enables JReport Engine to output messages to a file and sets engine log file's trace level to OFF and error level to ERROR. Some of the common options will be used in later chapters. JReport has automatically generated some batch files for you so that you do not have to write a complicated command line. default is <intall_root> \public_html. Outputs nothing. q . In addition. Print environment settings when the server starts up. read the LogConfig. Sets all loggers' trace level to INFO and error level to WARN.server host:port -cleanup Web application server root directory. jar. you can send commands to the server to either shut it down or pop up the user interactive interface for administration. -Djava. -w:password Password of the admin user. local:on A command sent to the server asking to only allow the administration commands sent by the local machine.CommandSender. JREntServer.compiler=NONE This is without JIT. server. The full command is as follows: JAVA -classpath <classpath> -Djava. you can try turning off the JIT compiler and running again. Example: -w:admin. The default value is false which indicates that the error message will not be displayed. -Dpoperror=true This property is used to control whether to pop up a message to show error information. This is not a required option. if you encounter problems running the server and you think that they relate to the Java VM. However. It is required only if you do not execute the command from the local host on which JReport Server is running.compiler=NONE [-Dreporthome=<install_root>] jet. -p:port The port JReport Server used for administration.jar. The default value is 8889. local:off A command sent to the server asking to accept administration commands from anywhere. It is the destination location you specified when you installed it.Sending commands to JReport Server from Java After JReport Server has been started as a standalone server. -Dreporthome This is where JReport Server is installed.CommandSender [-s:server -p:port] -w:password [-?]|admin|shutdown|gc|(local:on| off) q -? Prints brief help message. All of these can be done through the class jet. -s:server Host name on which JReport Server is running. admin A command sent to the server asking to pop up the user interactive interface for administering JReport Server. q q q q q q q q q q q . shutdown A command sent to the server asking it to shut down.server. -Classpath The class path must include the following packages originally in your <install_root>\lib: JRESServlets. bat for you so that you do not have to write a complicated command line. In addition. Note: Some of the common options will be used in the later chapters. .q gc A command sent to the server asking the JVM to schedule the Java Garbage Collector. JReport has automatically generated the batch file CmdSender. there are some Solaris binaries on certain sites.xfree86. XVFB is freeware and can be obtained from x. such as mainframe machines and dedicated servers. Install XVFB.wrc.org/pub/XFree86/4. Running with XVFB XVFB is an acronym of the Xserver Virtual Frame Buffer.6/binaries/Solaris ftp.1/binaries/Solaris ftp. Add -Djava. To launch JReport Server in a headless environment: 1.org/pub/XFree86/4.gov/Ferret/FAQ/graphics/Solaris_Xvfb. 2.3. or XVFB. Start JReport Server.wrc. Using Java headless implementation JReport Server runs fluently in headless environments. What you need to do is make some simple configuration changes before starting JReport Server in headless environments. JReport Server supports Java headless implementation. or mouse. Using a third-party tool (deprecated) The method of using a third-party tool is no longer needed but is still available in this release.1/binaries/Solaris-8 http://ferret.noaa. It runs without a head or graphics card. The following introduces three ways to run JReport Server on Unix without GUI. Note: If JDK 6 is used.gov/Ferret/FAQ/graphics/Solaris_Xvfb.headless manually. in order to run JReport in a non-GUI environment. 2.awt.Running without a GUI Many environments. Compiling it is supposedly difficult.0. including: q http://ferret. however. keyboard.0.xfree86. For example. It may be removed in the future.html q q q q Take the following steps to run JReport Server with XVFB: 1. if it is headless.html ftp.headless=true as a JVM parameter before starting JReport Server. the true value will be given.xfree86.awt. because JDK 6 can automatically give a value to the parameter according to the environment the server will run. it is not necessary to add the parameter -Djava.org/pub/XFree86/3. do not support a display. To have XVFB start up automatically when a workstation boots. such as PJA. It can provide a virtual Xserver and release you from the need of a real Xserver. in which case you do not have to install a third-party tool. XWindows.org's X11R6 distribution.noaa. you can add the Virtual Frame . Assuming that SvrSetup.Buffer to the Automatic Startup. This command will continue running programs specified by you and enables JReport Server to ignore hangup signals. This is a Java library for drawing graphics developed by eTeks. Set DISPLAY to screen 1 (assuming that JReport Server is running on machine jaguar).d/xvfb as below. a PJA (Pure Java AWT) Toolkit is supported to run JReport Server.d/xvfb /etc/rc2. go to http://www. you can start JReport Server.d/S98xvfb If you need not to start XVFB automatically. write a script /etc/init. nor XVFB available. 2.4/lib/pjatools. modify the file JRServer. To use it: 1.sh in <install_root>\bin by appending /pja_2.jar to the . To avoid this. Install PJA.sh has been used to install JReport Server on a Non-GUI platform. Logging out the terminal may result in JReport Server shutting down. 3. #!/bin/sh mode=$1 case "$mode" in 'start') # start the X Virtual Framebuffer (Xvfb) if [ -f /usr/X11R6/bin/Xvfb ]..eteks.0 export DISPLAY Then. esac exit 0 Then create a soft link to /etc/rc2. *) echo " Usage: " echo " $0 start (start XVFB)" echo " $0 stop (stop XVFB .. That is.not supported)" exit 1 . you can first start JReport Server in the background using the command nohup: nohup . It supplies a replacement AWT toolkit and eliminates the requirement of an X display. you can manually start up XVFB: /usr/X11R6/bin/Xvfb :1 -screen 0 1152x900x8 & 3./JRServer &. DISPLAY=jaguar:1. Install JReport Server. and make it executable. then echo "***Starting up the Virtual Frame Buffer on Screen 1***" /usr/X11R6/bin/Xvfb :1 -screen 0 1152x900x8 & fi . The PJA package is not included in our product.d/S98xvfb: ln -s /etc/init. Running with PJA toolkit When there is neither X Window.com/pja/en/ to download PJA and install it. jar: $REPORTHOME/lib/jasper-runtime.class path.PJAToolkit .usePlatformFont=false .jar: $REPORTHOME/lib/jsch-0.sh that is used to start up JReport Server: #!/bin/sh CLASSPATH=$REPORTHOME/lib/commons-net-ftp-2.JREntServer "$@" Notes: q Printing reports is not supported.1.java2d.eteks.jar:$ADDCLASSPATH cd $REPORTHOME/bin $JAVAHOME/bin/java -Dawt.jar in jre\lib should be added to -Xbootclasspath.properties to the user.fonts=/usr/j2se/jre/lib/fonts: /JREntServer/font:/usr/openwin/lib/X11/fonts/TrueType -Dinstall. RasterOutputManager calling the native method getPlatformFontVar().awt. -Djava.font.properties file can be found. the file charsets.jar:$REPORTHOME/lib/xml-apis.root=$REPORTHOME/ -Djreport.jar:$REPORTHOME/lib/JRWebDesign.jar:$REPORTHOME/lib/servlet.4.home=dir with dir equal to the directory where the sub directory lib containing PJA font.This enables the changing of the Graphics environment.jar: $REPORTHOME/derby/lib/derbyclient.usePlatformFont=false -Djava.toolkit=com.jar:$JAVAHOME/lib/tools.jar .5.(changing class path is not enough).30.jar: $REPORTHOME/derby/lib/derbytools.jar: $REPORTHOME/lib/ant. To support multiple encoding.0.eteks.ttf files can be found. -Djava2d.jar:$REPORTHOME/lib/JREntServer.8.encoding=UTF-8 -Xmx512m -Dreporthome=$REPORTHOME jet.jar: $REPORTHOME/lib/itext_1.url.PJAGraphicsEnvironment -Djava2d.jar:$REPORTHOME/lib/tar. For the q .eteks.jar: $REPORTHOME/lib/sac.PJAGraphicsEnvironment .jar: $REPORTHOME/lib/jai_core. only the default encoding (iso8859-1) can be applied to JReport.2.jar:$REPORTHOME/lib/JREngine.jar: $REPORTHOME/lib/xercesImpl.jar: $REPORTHOME/lib/activation-1.font.With path equal to the directory where the Lucida *. r -Xbootclasspath/a:pja.awt.jar:$REPORTHOME/lib/mail-1. or add lib/font.2. -Djava. Without this Jar file. -Dawt.jar: $REPORTHOME/lib/JRESServlets.java2d.awt.awt.jar: $REPORTHOME/lib/maintain.java2d.jar:$REPORTHOME/lib/poiHSSF_151.This enables the changing of AWT Toolkit.jar:$REPORTHOME/lib/jasper-compiler.jar:$REPORTHOME/lib/log4j-1.home system property.jar: $REPORTHOME/lib/hsqldb. Either -Duser. You can add to the path other directories containing True Type Fonts by using a separator.jar:$REPORTHOME/derby/lib/derby.PJAToolkit -Djava.This avoids the class sun.graphicsenv=com.jar:$REPORTHOME/lib/jai_codec.jar:$REPORTHOME/derby/lib/derbynet.server.loops.1.fonts=path .toolkit=com.jar: $REPORTHOME/lib/commons-codec-1. which can cause a JVM crash.eteks. and add the following options.graphicsenv=com.0.awt. r r r r r Below is an example of the modified file JRServer.awt.4. you should add the location of the Lucida*.0 $ export DISPLAY Then. Starting from a telnet session with an X server installed If you are using telnet to start JReport and your Unix has an X server installed. .2/docs/guide/intl/encoding.sun.jar.ttf files directory to -Djava.awt. you can run JReport Server or your application with JReport embedded.4. you can directly point your display to your X server: $ DISPLAY=hostname(or IP address):0. q If you are using other True Type Fonts instead of the fonts in X11.encoding types which are supported by charsets.html. refer to the website http://java.doc.fonts.com/ j2se/1. q Running as a Windows Service Running as a service on Unix Running as a service on Linux q q . Unix and Linux. This section shows you how to run JReport Server as a service of Windows XP.Running as an OS service JReport Server can be configured as an OS service. However. This tool JRservice. You will get the following information if you run JRservice. q q Configuring JReport Server service The parameters for the Windows service of JReport Server are read from the file NTService. If you open the Services item in the Control Panel. the service installed will be run in interactive mode. when you start the service. However. you will then be prompted to re-start your computer for the service installation to take effect. q JRService -install Running JRservice. before you run this. JRService -install -interactive If you use the -interactive option together with -install. exe can be found in <install_root>\bin.ini in <install_root>\bin. you will find a service named JReport Server in the list. the Command Prompt Window will not be displayed on the window when you start the service. if you don't specify this option when you install the service.exe with the -install option will install JReport Server as a Windows Service. In this file you will find three parameters specified.exe without any options: Usage: JRService -install [-interactive] to install the service JRService -remove to remove the service -interactive to enable JReport Server service to interact with the desktop StartServiceCtrlDispatcher being called.exe with -remove option removes the Windows service of JReport Server from Windows. a Command Prompt Window will pop up.Running as a Windows Service A tool is provided to assist you in installing JReport Server as a Windows Service. Please wait. JRService -remove Running JRservice. This may take several seconds. you should stop the service. After you have installed JReport Server as a service. That is. as shown in the following example: . see Starting JReport Server using Java.2.root=C:\JReport\Server" -classpath "C:\JReport\Server\lib\JREntServer. In the example above..8. Stopping the service There are three ways for you to stop the JReport Server service: . This will be called when the service is started.0_17\jre\bin\java. Open the Services list. you will need to append -logall at the end. -Djava.JREntServer ShutdownArg= "-Dinstall.server.6.jar.server. the service will start automatically each time Windows is started.jar.server.jar...C:\JReport\Server\lib\servlet. ShutdownArg The Java command line for shutting down JReport Server. select it and click the Start button.C:\TEMP" -Djava...compiler=NONE -Dreporthome=C:\JReport\Server jet.JavaVM="C:\jdk1.CommandSender localshutdown q JavaVM The path of the Java VM. You can directly start the service through the Services item in the Control Panel. q q Starting the service There are two ways to start the JReport Server service.C:\JReport\Server\lib\servlet. as in the following example: ..JREntServer -logall .C:\TEMP".jar.jar. Reference: For more information on the options available.C:\JReport\Server\lib\servlet. C:\JReport\Server\lib\log4j-1. without otherwise modifying the Control Panel.root=C:\JReport\Server" -classpath "C:\JReport\Server\lib\JREntServer.jar. find JReport Server on the list.exe" StartArg= "-Dinstall.jar. q You can change the options in the file NTService. it is by default configured to start automatically each time.jar.compiler=NONE -Dreporthome=C:\JReport\Server jet. C:\JReport\Server\lib\JREngine. In other words. there are no options specified in StartArg. q After the server has been installed as a service..C:\TEMP" . C:\JReport\Server\lib\JREngine.jar. C:\JReport\Server\lib\JREngine.root=C:\JReport\Server" -classpath "C:\JReport\Server\lib\JREntServer. If you would like to set all error log levels to WARN and trace log levels to INFO. StartArg The Java command line for launching JReport Server as an independent web application server. This is called when the service is stopped.jar. StartArg= "-Dinstall.ini in <install_root>\bin before you start the service. -Djava.compiler=NONE -Dreporthome=C:\JReport\Server jet.. 0. remove any old ones from the User DSN. To establish JReport Server as a service. User data sources can only be used by the current user and are visible only to that user. To do this. System data sources can be used by all users on a computer. define the data source in the System DSN. \\127. double-click the Services item. q q Notes: q All ODBC data sources used by the JReport Server Service belong to the System DSN. Also. q .g. and add the data source used by JReport Server to the System DSN panel. That is. you should choose System Data Source. Z).q Open the Control Panel.g.bat localshutdown. for example: <install_root>\bin\CmdSender. When using NT service to start JReport Server. select JReport Server. You should use UNC path (e. Run the batch file CmdSender. the mapped disk in path cannot be accessed due to JVM limitation. open Data Source (ODBC) in Control Panel. and are visible to all users on the computer and system-wide services.bat in <install_root>\bin with the localshutdown argument.0. Use the Shut Down the Server button on the JReport Administration page. and then click the Stop button if it is not disabled. go to Administrative Tools. such as Microsoft Windows services.1\public_write) instead of the mapped disk it is mapped to (e. esac exit 0 2. ln -s /etc/init.. 1.sh localshutdown & fi . and make it executable. 'stop') if [ -d /user/report/jns ] then echo "Stopping JReport Server" /user/report/jns/bin/CmdSender.d/jrserver /etc/rc2. ln -s /etc/init. Create a soft link to /etc/rc2.d/K99jrserver.d/jrserver /etc/rc0. *) echo " Usage: " echo " $0 start (start JReport Server)" echo " $0 stop (stop JReport Server)" exit 1 .d/K99jrserver ..sh & fi .d/S99jrserver. Write a script /etc/init.d/jrserver as below. Create a soft link to /etc/rc0.Running as a service on Unix Assuming that JReport Server has been installed to /user/report/jns.d/S99jrserver 3. #!/bin/sh mode=$1 if [ ! -d /user/report/jns ] then # JReport not installed exit 1 fi case "$mode" in 'start') if [ -d /user/report/jns ] then echo "Starting JReport Server" /user/report/jns/bin/NJRServer.. 0 export DISPLAY /JReport/Server/bin/JRServer -silent "$@" 2.d/S97xvfb. Write a script /JReport/Server/bin/JRServer as shown below. Setting up XVFB 1.d/jrserver as below. *) echo " Usage: " echo " $0 start (start XVFB)" echo " $0 stop (stop XVFB not support)" exit 1 esac exit 0 3. #!/bin/sh mode=$1 case "$mode" in 'start') echo "start xvfb " if [ -f /usr/X11R6/bin/Xvfb ] then /usr/X11R6/bin/Xvfb :1 -screen 0 1152x900x8 & fi .d/S97xvfb Using rc to run JReport Server as a service Assuming that JReport Server has been installed to /JReport/Server. and make it executable.. 1. 2. Write a script /etc/init. . #!/bin/sh DISPLAY=127.d/xvfb as below.d/xvfb /etc/rc5. Write a script /etc/init.0. and make it executable. Create a soft link to /etc/rc5.1:1. Here it is assumed that JReport Server is running on a machine with IP address 127.0. Install XVFB.0. ln -s /etc/init.1. and make it executable. Here it is assumed that your default start up rc is rc5.Running as a service on Linux Running JReport Server as an OS service on Linux is more or less the same as with running on Unix.0. Create a soft link to /etc/rc5.#!/bin/sh mode=$1 if [ ! -d /JReport/Server ] then # JReport not installed exit 1 fi case "$mode" in 'start') if [ -d /JReport/Server ] then echo "Starting JReport Server" cd /JReport/Server/bin/... ln -s /etc/init.d/S98jrserver. *) echo " Usage: " echo " $0 start (start JReport Server)" echo " $0 stop (stop JReport Server)" exit 1 .. ln -s /etc/init. JRServer -silent & fi .d/jrserver /etc/rc5.d/S98jrserver 4. Create a soft link to /etc/rc5.d/K98jrserver If all has been carried out successfully.d/jrserver /etc/rc5. JReport Server is now ready to run as a daemon process. 'stop') if [ -d /JReport/Server ] then echo "Stopping JReport Server" /JReport/Server/bin/CmdSender localshutdown & fi . esac exit 0 3.d/K98jrserver. . the installation of the service will now have finished. Since JReport Server is implemented using servlets and JSPs. JReport Server can also run as a servlet inside a Java application server.Integrating with a Java Application Server. There is a separate chapter about integration with different application servers . it can work with any servlet-enabled web application server by assembling and deploying JReport Server as a Web Application Archive (WAR) or Enterprise Application Archive (EAR).Running within an application server In addition to running as a standalone server and as a service. It provides a general method for creating the deployable archive and detailed procedures for deploying the archive into some popular application servers. . You can first go through this chapter to gain a general understanding about JReport Server before you use it. Also. while you are using JReport Server. if you do not understand any of the basic concepts. This chapter discusses the following JReport Server main concepts: q Background tasks Interactive reporting Scheduling Resource Version Security Integration JReport Server cluster q q q q q q q . you can refer to this chapter to get help.Basic Concepts This chapter gives you some basic JReport Server concepts. Status information includes: report name. which shows the status information of tasks submitted using the Run. time elapsed since the task is performed. report path and name. q q q . catalog path and name. and the status of the task.Background tasks JReport Server provides a background running system. The records saved in the background running system are cleared under the following conditions: q JReport Server is restarted. The maximum time limit specified for the interval between a user logout and login has been reached. or Background Run mode. If the number of records exceeds the number specified for the background task list (by default it is 100 records). By default it is 86400 seconds (24 hours). running format. time when the task is started/ completed. It allows you to view detailed information in a timely fashion. Advanced Run. the latest 100 records will be retained. The maximum time limit specified for the report result life has been reached. By default it is 300 seconds. DHTML allows you to control objects such as images. customize and navigate report views. and drop-down lists.filter. The DHTML toolbar and interactive web objects can be embedded into reports or JSPs at design time. text fields. Related topics: q JReport Viewer . you can dynamically modify .reports to obtain unique and personal data views. enabling you to control. sort and drill .Interactive Reports . search.Interactive reporting JReport Server provides you with interactive reporting of DHTML reports. radio buttons. With interactive DHTML output. checkboxes. buttons. You can define report criteria and layout at runtime to generate interactive ad hoc reports. JReport further extends interactive reporting by empowering applications with ad hoc reporting. You can submit a scheduled task from web page and URL or by calling the Server and Client API methods. Triggers can also work together with time conditions for activating a scheduled task. User Task In order to provide the means to run tasks defined outside of JReport on JReport Server. task type and its launch type. Trigger conditions are based on event driven modes. The server does not care whether a customized condition is ready. Triggers are managed by name in JReport Server. and then fire the trigger to activate the task at anytime. JReport provides a task named User Task. you can submit the user task from a web page. catalog. you can then submit the task either from a server web page or by calling Server API methods. Trigger The scheduling mechanism supports trigger conditions in addition to time conditions. so each trigger must have a unique name. Related topics: q Scheduling reports . you can submit a task that is bound with the trigger. and to just use JReport Server's schedule function. It only waits there for trigger firing events. or by calling JReport Server API methods.api package and adding the class to the class path. The task can then be run by the server at the scheduled times just as if it were a report. you can also customize notification messages to notify others of whether or not the task is executed successfully.server. you must first specify the report. However. Therefore. In addition. After creating a trigger. With this task. After creating a class that implements the UserTask interface in the jet. you can implement a customized task with the schedule properties. Also.Scheduling JReport Server provides a scheduling system which you can customize to suit your requirements. before you can do this. you determine whether the condition is ready before firing a trigger. and you would like to organize these files and folders into the Resource Tree. A resource can only hold versions of the same type. which function as the leaves of the resource tree. such as catalogs.Public Reports and My Reports. reports.Support and Marketing. The resource tree consists of the following three layers: q Folder layer: Basic resource tree element that builds the main framework for the resource tree. and the resource tree conforms to this file. your company has two departments . and their results. Resource tree All the resources are organized in a folder-tree structure. There are different types of resources. Now. To be exact. a resource refers to report or dashboard related material. The following diagram may help you to figure out the framework on which you should build the resource tree. There are two built-in folders in the root of the resource tree -.Resource JReport Server provides a resource system for managing a group of archive versions that can be processed or organized.xml. suppose you are the administrator. JReport Server defines an XML file called admin. where the archive versions reside for executable resources. What is a resource Generally. dashboards. A folder can be mapped to a real file path. For example. library components. q q Public Reports and My Reports . Archive layer: A concrete layer. There are some report documents that are submitted by the departments located on the machine where JReport Server runs. Resource layer: An abstract layer. a resource in the JReport Server reporting system is a conceptual node. Each department has its reports on their own machine. This file is maintained automatically by JReport Server. based on the Folder layer that hosts various types of archive versions and provides user access to the versions. You can create your own folders in either of them. A folder in a component library can have no more than one catalog. you need to create multiple folders in the component library. As for the other formats. if DHTML is set as the default report view format. This folder is the default output location for reports run by the user. When using scheduling to publish a page report to the versioning system or to disk. It is accessible to server administrators. The My Reports folder is a personal folder. the page report with all its report tabs will be run. the report with all selected report tabs will be output to a single file. specified by the administrator when the user account is created.There are two built-in folders in the resource tree root . When viewing a page report directly. and can be accessed by everyone. scheduling and managing of reports. The Public Reports folder and the My Reports folder cannot be deleted. The Public Reports folder contains public report documents and executable reports. each selected report tab will be output to a separate file but you still have the convenience of scheduling all the report tabs with a single schedule entry. Component Library A component library is a repository on JReport Server for storing and managing library components. It contains personal report documents and executable reports. and the user has full control over his/her personal folder. therefore when your library components require different catalogs. that is. The background run/scheduled/ active/completed record are based on report level. Library components are designed using JReoprt Designer. while a web report has no report tabs and is always displayed as a web layout report with just one page. the DHTML and JReport Result formats are based on the report level. you can only select one report tab in the page report to run. Otherwise. Each user has one personal folder. and then are published to the component library for use when creating or modifying dashboards. only the default selected report tab will be run. When using Advanced Run to run a page report. Report There are two types of reports in JReport: page reports and web reports. JReport Server supports viewing. The My Reports folder can only be accessed by its owner. A page report is a collection of report tabs and each report tab can have multiple pages. All folders except for the personal folders are public folders. advanced running. Related topics: q Managing resources .Public Reports and My Reports. the resource tree and the built-in version folder. and your resources might change over time. while those generated in the built-in version folder can only be bound with their respective reports. Information of these versions is stored in the System DB database that JReport Server uses. first you have to understand the resource mechanism in JReport Server. JReport Server uses a versioning system to create and manage resources that have changed in content and properties owing to updates issued upon them. you can choose an archive location to generate the report result. Result Version The version of a report result file. q . You can generate the report result in the built-in version folder. the My Reports folder or the Public Reports folder in the resource tree. A version is the fundamental unit of the resource tree. To understand what the versioning system is. All the resources in the resource tree have versions. which holds a group of archive versions that can be processed or organized in JReport Server. Different version types The versions in JReport Server fall into the following major categories: q Catalog Version The version of a catalog file. When you schedule a report to publish to the versioning system. while version files are saved in the directory . A resource in the JReport reporting system is a conceptual node. The report results generated in the resource tree are standalone results and can have their own versions.<reporthome>\history. Report Version The version of a report file. What is a version All the server resources in the resource tree are controlled by versions. The report result can be generated and maintained in two places .Version JReport Server provides a versioning system for controlling the resources contained in the resource tree. A large portion of resource management tasks are done by managing resource versions. Library Component Version The version of a library component file. q q q Dashboard Version The version of a dashboard file. cls. Remember that version information is stored to a database.cls report result resource on the server interface. the report version's real path is <reporthome>\history\1 \JReport_System_User894485281\InvoiceReport. when you click the InvoiceReport. only the path to it is stored in the database. The archive policy can be applied to a single resource individually. you will find its real path.cls. You can control whether or not to use multiple versions for a specific resource.Real path of versions If you check the property of a version. you can define the maximum number of versions that can be listed in the version table. For the report InvoiceReport. which is the actual report result path on disk and stored in the server database. or to many resources in a folder as a whole. and version files are stored in the directory <reporthome>\history. And this works the same for the other types of versions. Also. That is. Related topics: q Managing versions . you are accessing it on the disk. Archive policy JReport Server uses an archive policy to control the resource versions. A realm is identified by a unique name. and thus groups or roles can inherit the permissions of other roles. which represents an organization of user accounts. JReport Server comes with two built-in role accounts. which represent an aggregate of permissions. which can contain any characters other than forward slash (/) and backward slash (\). is available for managing users. The builtin role accounts cannot be deleted. At runtime. you must have a user account. help you to efficiently assign the appropriate user rights and permissions to users. The admin user account can neither be deleted nor disabled. Users or groups can then be added into a group as its child members. only one realm can be active and only the users and resources in the active realm are accessible.Security JReport Server provides a security system for setting up and maintaining security on it. There can be more than one realm on the server and each realm is independent from others. in order to ensure that only valid users have access. allowing you to protect your resources from inappropriate access by other users. which consists of a unique user name and password. JReport Server verifies your identity when you type your user name and password and then logs you on. Roles. group accounts and role accounts. which are administrators and everyone. If your user account has been disabled or deleted. and therefore inherit the resource and folder permissions from the group. The authentication entities consist of user accounts. The resources and authentication entities that reside in different realms are different. To help you understand security in detail. the following security features with their concepts are described below: Realm A realm is an abstract security concept. which are admin and guest. Group The principle group. . The administrator role account can neither be deleted nor disabled. User To use JReport Server. JReport Server prevents you from accessing the services that JReport Server provides. A role can also be assigned to other groups or roles. The built-in user accounts cannot be deleted. Assigning roles to users gives them the user rights and permissions that they require to perform their jobs with. Role Users must have certain user rights and permissions in order to perform tasks on resources. which hosts the resources and authentication entities on JReport Server. JReport Server comes with two built-in user accounts. folder contents. q q Alias JReport Server organizes files and directories into a Resource Tree. Allows or denies granting permissions to other users. changing the properties (not including permission settings) of the objects in the resource tree or version table. Aliases are used to provide different "views" of the tree for different users. are the rules that are granted to users to control their access to resources and folders. Advanced properties The privilege of viewing advanced information of version properties such as catalog connections and report related resources. such as folders. and Update Status. so that she can only see the marketing resource node and can directly enter into the report folder she is interested in. Delete. Allows or denies updating report status. and modifying version table settings. if it is a folder. and can grant these seven permissions except the Grant permission itself. and if it is a folder. and archive versions. resources. the status of reports in the folder. and. Allows or denies running resources in normal and Advanced mode (report type resources only). Allows or denies submitting resources to schedules (report type resources only). An alias is a combination of users and resource nodes. Allows or denies deleting objects in the resource tree or version table. Users. Write. such as folders. and archive versions. Privilege of JReport Server manages the following access permissions for users: q Publish The privilege of publishing resources to JReport Server. resources. versions. Allows or denies publishing folders and resources. Read. Message Table Manipulation The privilege of mapping fields from different data sources in a dashboard. groups or roles that have obtained the Grant permission are also endowed with the other seven permissions . and archive versions. For example. resources. you may set an alias resource tree (based on the resource tree) for Tanya. associated with resources and folders. Execute. Execute Schedule Delete Grant Update Status Privilege Privilege is a mode which manages permissions.Permission Permissions. Allows or denies viewing object properties. Permissions in JReport Server include: Permission Visible Read Write Description Allows or denies viewing object names in the resource tree or version table. It can be used to manage different access permissions unrelated with nodes. groups or roles. Related topics: q JReport Security System . Schedule.Visible. such as folders. q Managing security . Related topics: q Integrating with a Java Application Server . It contains a rich set of APIs that allow for seamless integration and is implemented using Java Servlet technology and Java Server Page (JSP). These servlets and JSP pages enable the user to work with any Java EE compliant application server that supports a Servlet Container and administer the JReport Server remotely through a web browser.Integration JReport Server can be seamlessly integrated with any other Java application server to meet the information delivery needs of a single department or an entire enterprise. all clustered servers play exactly the same role and any one can exit from the cluster any time. the tasks sent to it will be allocated to the other servers.JReport Server cluster A JReport Server cluster is a distributed cluster in which a group of servers work together to provide cluster-wide shared resources. High-Availability: When one server fails to perform.Every clustered server has the same responsibility. In a JReport Server cluster. q q There are many nodes (clustered servers) in a JReport Server cluster. remotely. schedules and version services. security. If a server has already been fully utilized. Related topics: q Clustering . You can set a clustered server to perform a specific role in a JReport Server cluster by configuring its properties. The JReport Server cluster provides the following major benefits: q Manageability: All users and resources can be controlled from a clustered server. the tasks running on it will be re-allocated to other servers. Scaleable: You can add or remove servers dynamically according to your needs. JReport Desktop Viewer. Both JReport Desktop Viewer and JReport Viewer Bean are based on the Client API. you can access JReport Server from one of our products: Client API. or the JReport Viewer Bean. This chapter presents to you two modes in which you can access JReport Server: q Accessing in browser/server mode Accessing in client/server mode SSL in standalone JReport Server q q . you can use a web browser to access JReport Server. In browser/server mode. In client/server mode.Accessing You can access JReport Server in either browser/server mode (B/S) or in client/server mode (C/S). or Chrome. Click OK and the JReport Administration page will be displayed. 3. the port for accessing the JReport Console page is 8888). or open a web browser and set the URL to http://ip_or_hostname:port (by default./JRServer. q To access the JReport Administration page: 1. Tip: If you don't know the IP address of the machine on which the server runs. assume that JReport Server has been installed in C:\JReport\Server on Windows or /opt/JReport/Server on Linux. 2. the port for accessing the JReport Administration page is 8889). Click OK and the JReport Console page will be displayed. the default user name and password are admin. Run the startup file from a command prompt or shell. the default user name and password are admin. you can use localhost instead of the IP address.1 > Server > JReport Server Administration. Click Start > All Programs > JReport 10.sh q q q Then. Type your user name and password as assigned by the administrator. you can type the following commands: C:\>cd JReport\Server\bin C:\JReport\Server\bin>JRServer. q To access the JReport Console page: 1. You can also . For first time users.1 > Server > Start JReport Server. first start the server via one of the following ways: q Double-click the JReport Server 10.Accessing in browser/server mode This section shows you how to access JReport Server through a web browser such as Internet Explorer.1 shortcut on your desktop.sh file located in <install_root>\bin. Type your user name and password as assigned by your administrator. Run the JRServer. Click Start > All Programs > JReport 10.bat/JRServer. Starting and logging onto JReport Server To log onto JReport Server.1 > Server > JReport Server Console. 3. On the Welcome to JReport User Console page. For first time users. 4. 2. or open a web browser and set the URL to http://ip_or_hostname:port (by default. For example.bat $cd /opt/JReport/Server/bin $. Firefox. Click Start > All Programs > JReport 10. and if it is the same machine where you run JReport Server. click the Login Now button. click Start > All Programs > JReport 10. your request for login will be prompted with a confirmation page asking you whether or not to close the existing extra user session. Logging off and shutting down JReport Server To log off JReport Server. If an extra user session has already been created and it is still valid. Only a normal user session can use a client viewer to log onto JReport Server. Fast launch pad for local users Local users can also access JReport Server in a fast way with the launch pad. shut down the application server according to the vendor's q . Otherwise. not the extra user session. Note: If all normal user sessions have been used up. The launch pad provides some key functions of JReport Server by setting up the connections to corresponding JReport Server JSPs. Additional login channel for admin users JReport Server provides a special channel that creates an extra user session for management purposes if the license limit of the maximum number of concurrent users has been reached. Only one extra valid user session can be created and used within this special channel at any time. click the Logout link on the upper right corner of the JReport Administration/ Console page.open a console window such as telnet on the server machine and type hostname. In an integrated environment. It can only be used by admin users for performing management operations. a request from a client viewer will be denied permission to log onto JReport Server. To shut down JReport Server normally: q In a standalone environment. you will not be allowed to log onto JReport Server. The extra user session cannot be used to run reports or submit schedules. which is a convenient entry to access the server without having to start it. If your JReport Server license has a bounded limit to the maximum number of concurrent users.1 > Server > JReport Server Launch Pad. this feature will take effect. which are: q Viewing the JReport sample reports Creating new reports Scheduling to run reports by time or event Configuring server profiles to customize the server interface and functionality Managing security principals Visiting the JReport Demo Center q q q q q To access the launch pad. or click Start > All Programs > JReport 10. a new extra user session will be created for you to perform management operations. If you select Yes. click the Shut Down the Server button on the JReport Administration page. then the name of the host will be displayed.1 > Server > Stop JReport Server. . or a system-wide event such as user logoff or system shutdown.instructions. such as typing ^C. Also. JReport provides a feature for handling an abnormal system exit that enables the program to close itself gracefully when the Java virtual machine (JVM) is terminated in response to a user interrupt. Reference: For details about the usage of JReport Desktop Viewer. With this you can schedule and view reports at any time and as often as you want. servlet path. an important feature of JReport Desktop Viewer is that it enables you to manage reports such as adding/deleting reports and defining their properties. 1. you will see a resource tree in the Explorer tab of JReport Desktop Viewer (or alias resource tree if defined). It is based on the Client API but with a Swing based GUI. 2. 5. and allows faster access but has more limited functionality. Then. However. it does not support using the JReport Web features such as sorting and filtering. After being authenticated. Launch JReport Server using the batch file JRServer. Compared with a web browser. In the Connect to JReport Server dialog.Accessing in client/server mode Besides a web browser. JReport Desktop Viewer also includes task scheduling functionality. The default servlet path is /jrserver.com/downloadjreport/additional.bat in <server_install_root>\bin if it is not already running.sh on Unix) in <viewer_install_root>\bin. Follow the installation wizard to install JReport Desktop Viewer (by default.bat (JRViewer. . check the SSL option. Client API and JReport Viewer Bean. you can go to the Jinfonet website and read the online help at http://www. jinfonet. strictly speaking there are two viewers: thin-client through a web browser and thick-client using the Client API. JReport Server supports three other viewers to browse reports from a client: JReport Desktop Viewer. Download JReport Desktop Viewer for Windows or for Unix from Jinfonet website at http://www. JReport Client API and JReport Viewer Bean. After JReport Server is started. refer to JReport Desktop Viewer User's Guide in <viewer_install_root>\help\userguide if you have installed it on your machine. port number.htm.jinfonet. viewing reports and scheduling. launch JReport Desktop Viewer using the batch JRViewer. 6. it is installed to C: \JReport\Viewer). it has better compatibility with JReport Server. 3. Since JReport Desktop Viewer. user name and password of JReport Server. Accessing via JReport Desktop Viewer JReport Desktop Viewer is a thick-client way to connect to JReport Server. JReport Desktop Viewer contains basic features such as exploring the resource tree. which corresponds to that of JReport Server. Also.htm. If you want to connect to JReport Server with SSL support. click Connect to complete the connection. JReport Client API. Finally. and JReport Viewer Bean are based on the Client API. You can view existing reports in server either on a remote server or on your local disk. you can publish reports to different formats. 4. Also.com/kbase/viewer10/userguide/index. You need to use JReport Desktop Viewer and JReport Server of the same version (the same build number). enter the host. For details about using the Client API. Applet). You can go to http://www. RTF. e-mail and printer. There are sample code files you can refer to in <viewer_install_root>\help\samples. Text. Client API has more flexibility including the scheduling feature. JReport Viewer Bean enables you to connect with JReport Server to run reports. . XLS.jinfonet.jar for Client API is also installed to <viewer_install_root>\lib at the same time. refer to the JReport Desktop Viewer User's Guide in <viewer_install_root>\help\userguide. PostScript.htm to download JReport Viewer Bean in which some demo sample code files are included. Firefox. Since the Client API and JReport Viewer Bean share some functions.Accessing via Client API The usual method to connect to JReport Server is through a web browser. or with JReport Desktop Viewer. you can call methods in either of them. For the usage of JReport Viewer Bean. Both JReport Desktop Viewer and JReport Viewer Bean are based on the Client API. Accessing via JReport (Client) Viewer Bean JReport Viewer Bean is also based on Client API. and export report results to other formats (HTML. PDF. CSV. When you install JReport Desktop Viewer. JReport Viewer Bean is most often used in running reports and exporting report results to other formats or printers. Google Chrome.com/downloadjreport/ additional. the archive file JREntViewer. However. what if you want to integrate the client viewer into your own applications? The answer is you can. view report results. refer to JReport Desktop Viewer User's Guide in <viewer_install_root>\help\userguide. However. such as Microsoft Internet Explorer. Click Configuration on the system toolbar. q . 3. Restart JReport Server in order for the settings to take effect. 7. By default. Click Save. 6.com/app/docs/doc/819-4674/ gdwpf?l=zh_TW&a=view.enable to true. 2. 4. 4.ssl to meet your requirements. The default port is 8889. 2. This can be done either on the JReport Administration page or in the server. You need to enable it and configure corresponding settings in order to use HTTPS schema to visit JReport Server UI. Notes: q JReport does not provide a keystore file since Jinfonet is not a trusted certificate authority and just provides a Keystore File Path option for you to configure the location of your trusted keystore file. Sun is one of them. The URL for visiting JReport Server via HTTPS schema is like this: https://IP_address or localhost:6888 SSL support is disabled by default. Set the other properties starting with httpserver. Make sure that Secure Port and Secure Administration Port use different port numbers from Port and Administration Port.properties file.ssl.properties file: 1. To enable SSL function via the administration UI: 1. Open the server.mi 3. Restart JReport Server in order for the settings to take effect.SSL in standalone JReport Server JReport Server supports HTTPS requests in standalone mode. JReport Server Monitor does not support SSL. 5. 5. Log onto the JReport Administration page.sun. To enable SSL function in the server. port 6888 and 6889 are set as the secure ports separately for accessing JReport Console UI and JReport Administration UI. Set httpserver. Save the server. Secure ports for HTTPS requests should use different ports from non-secure ports for HTTP requests.properties file located in the <install_root>\bin directory. Check the Enable Secure Socket Layer Connection option.properties file located in the <install_root>\bin directory. There are many trusted authorities that can provide keystore files. and then select Service from the drop-down menu. Here is an example of creating a keystore file provided by Sun: http://docs. Specify the other settings about Keystore. . and predefine the properties for each export format which will be applied when you run or schedule a report on this page. run them via URLs. Pick a task from the following: q Running reports Scheduling reports Using JSPs to print reports q q Tip: You can customize the JReport Console > Reports page to suit your requirements by setting your own preferences. set which columns will be shown in the resource information table. then specify the settings in the Preferences dialog as required.Working with Reports After successfully logging onto the JReport Console page using the user name and password assigned by your administrator via a web browser. click Tools > Preferences on the task bar of the Reports page. you can then perform tasks according to your requirements. For example. and schedule tasks for the reports. For example. you can view reports in different formats. you can specify the default viewing format when directly run a report from this page. To do this. q q The following topics describe how to run reports in detail: q Viewing reports Running reports in Advanced mode Running reports via URL q q . simply click the name of the report.Running reports To run reports on JReport Server: q If you just want to view a report in the browser. you can use the Advanced Run mode to get the required report result. on the JReport Console > Reports page. If you want to run the report in a specified format and save the report result document. You can also input the URL of a report directly into the address bar of the web browser to run it. for the page report. browse to the report. . all the report tabs will be opened in DHTML format when you view this report on JReport Server. Put the mouse pointer over the report row and click the Run button on the floating toolbar. then do one of the following: q Click the name of the report in the Name column of the Reports page. on the JReport Console > Reports page. Select the report row. the viewing format will be determined by the Default Format for Viewing Report option on the JReport Administration/Console page > Profile > Customize Server Preferences > General tab. However. If this property of the report tab or the web report is set to Server Setting. Select the report row and click Run > Run on the task bar of the Reports page. no matter what viewing formats the other report tabs in this report are defined as in JReport Designer.Viewing reports To view a specified report. if the viewing format of the report tab is DHTML. right-click in the row and select Run from the shortcut menu. q q q Then. the last-time focused report tab in the page report when it was saved in JReport Designer or the web report will be displayed according to its Default Format for Viewing Report property setting in JReport Designer. choose a format to view the report result. and ask JReport Server to cancel the task or to notify you or someone else of the task status via e-mail if the task has not yet finished running when the task duration is up. On the JReport Console > Reports page. specify the other options as required. can be localized according to your requirements. Select the report row. By default. Click Finish to view the report in the format you specified. the Enable Task Duration option on the JReport Administration page > Configuration > Advanced panel must be checked. When you run a report in Advanced mode in HTML format. Then. right-click in the row and select Advanced Run from the shortcut menu. specify the parameter values as required (for details. Previous. see Task-level timeout for advanced run and schedule tasks. the Duration tab is not displayed in the Advanced Run dialog. and saving the report result version according to your requirements. Notes: q If you choose to view the report result in DHTML format. and set the other settings. see General tab . browse to the report you want to run in Advanced mode. then on the task bar of the Reports page. Next. archive the report result version according to your requirements. To make it available. For detailed information. all the other report tabs in the report will also be run. If the report has parameters. 7. In the Format tab. and Last. 5. in the Duration tab. 6. In the Archive tab. select the report tab in the report you want to run (only one report tab in a report can be run in Advanced mode at a time). refer to Localizing the page navigation links in HTML report outputs. See also Advanced Run dialog for details about options in the dialog. such as First. In the General tab. on the r r The Advanced Run dialog is then displayed. the names of page navigation links in the report. specify a time duration for the task. 2. To run a report in Advanced mode: 1. q q . 4.Running reports in Advanced mode Apart from simply running a report to view it in the specified default format. If you want to limit the amount of time that the report is allowed to run.Parameters). click Run > Advanced Run. 3. besides the selected report tab. Put the mouse pointer over the report row and click the Advanced Run button floating toolbar. Do either of the following: r Select the report row. For details. JReport Server also supports viewing a report in other formats. q Running reports via URL with protocols or commands Running reports via URL with authentication parameters Running reports via URL using the POST method Specifying parameter values using dialog when running reports via URL Example 1: Accessing reports via URL using the switching database command at runtime Example 2: Sending a large report result by e-mail upon finishing Example 3: Running a report tab in a page report via URL q q q q q q Related topics: q Setting dynamic parameter values when running or scheduling a report via API . you may want to reach a specific page by typing a full URL in a web browser instead of clicking hyperlinks from the JReport Console page.Running reports via URL Sometimes. This section explains to you how to run reports via URL in different ways. delete_resource Description: Deletes the resource node from the resource tree.cls Response: Report version list. you can directly type the whole URL in a web browser to access the destination.cat&jrs. HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver?jrs.cat Response: Resource node properties. q jrs.cmd=jrs. q jrs.report=/ SampleReports/EmployeeInformation.cmd=jrs.cmd=jrs.cls Response: Result versions list.get_cat_vers .get_rst_vers&jrs. report and result) of a folder.catalog=CATALOG&jrs. The HTTP methods GET and POST are available for almost all of the commands.cls q jrs. HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver?jrs.get_rpt_vers&jrs. HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver?jrs.cmd=jrs.delete_resource&jrs. q jrs.get_rpt_vers&jrs.get_cat_rpts_new/jrs.catalog=/ SampleReports/SampleReports.path=/ SampleReports/EmployeeInformation.report=REPORT URL Example: http://localhost:8888/jrserver?jrs.get_rst_vers Description: Gets a result version list of a report.cmd=jrs.delete_resource&jrs.cmd=jrs.cmd=jrs.get_subnodes Description: Gets all resource nodes (folder.report=/SampleReports/EmployeeInformation.get_node_prop&jrs. q jrs.path=RESOURCENODE URL Example: http://localhost:8888/jrserver?jrs. HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver?jrs.get_rst_vers&jrs.get_rpt_vers Description: Gets a report version list of a report.cmd=jrs.get_cat_rpts_new&jrs.path=/ SampleReports/SampleReports.path=RESOURCENODE URL Example: http://localhost:8888/jrserver?jrs. report=REPORT_SET URL Example: http://localhost:8888/jrserver?jrs.Running reports via URL with protocols or commands With the commands below.path=/ SampleReports Response: Resource nodes list.get_node_prop&jrs. q jrs.cmd=jrs. catalog.get_cat_rpts_new&jrs. HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver?jrs. get_node_prop Description: Gets the properties of a resource node. path=RESOURCENODE URL Example: http://localhost:8888/jrserver?jrs.cmd=jrs. drilldown=TRUE/FALSE] [&jrs.file=FILE_NAME URL Example: http://localhost:8888/jrserver?jrs. The result document can be generated by advanced running or scheduling a report.get_ver_rst_page&jrs.get_ondemands Description: Gets a list of reports run in background mode.view_ver_rst Description: Views a result version of a report. HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver?jrs.cat Response: Catalog versions list.cat/ InvoiceReport.rst Response: HTML page for viewing the result file with the ViewerApplet.has_hyperlink=TRUE/FALSE][&jrs.get_ondemands URL Example: http://localhost:8888/jrserver?jrs.file=1%5cJReport_System_User327406359% 5cInvoiceReport.cmd=jrs. HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver?jrs.no_margin_pdf=TRUE/FALSE][&jrs.Description: Gets a catalog versions list of a catalog. HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver?jrs.catalog=/ SampleReports/SampleReports.result_type=RESULT_TYPE&jrs.get_cat_vers&jrs.is_multi_files=TRUE/FALSE] [&jrs.cmd=jrs.catalog=CATALOG URL Example: http://localhost:8888/jrserver?jrs.get_rst_doc_vers&jrs.cmd=jrs. q jrs. web_browser=BROWSER_TYPE][&jrs.cmd=jrs.get_rst_doc_vers Description: Gets a result versions list of a result document.rst Response: The result file from the version manager.relative_font_size=TRUE/FALSE][&jrs.get_ondemands Response: Background run report list.cmd=jrs.cmd=jrs.get_ver_rst Description: Gets an HTML page for viewing a result version of a report with the ViewerApplet.isjrsapltpg=TRUE/FALSE][&jrs.result=RESULT URL Example: http://localhost:8888/jrserver?jrs.cmd=jrs.get_ver_rst&jrs. q jrs. hist_file=RESULT_VERSION_FILE_NAME&jrs.is_applet_chart=TRUE/FALSE][&jrs. HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver?jrs.file=1% 5cJReport_System_User327406359%5cInvoiceReport.view_ver_rst&jrs. applet_type=APPLET_TYPE[&jrs. HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver/REPORT?jrs.result=/ SampleReports/EmployeeInformation Response: Result versions list. q jrs.get_ver_rst_page Description: Gets a result version of the report from the version manager.cmd=jrs.cls?jrs.no_margin_html=TRUE/FALSE][&jrs.cmd=jrs. q jrs.get_ver_rst&jrs.cmd=jrs.get_cat_vers&jrs. has_page_number=TRUE/FALSE][&jrs.get_rst_doc_vers&jrs. HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver/REPORT?jrs. q jrs.is_norm_txt=TRUE/FALSE] .use_table=TRUE/FALSE][&jrs.cmd=jrs.get_ver_rst_page&jrs.file=FILE_NAME URL Example: http://localhost:8888/jrserver/SampleReports/SampleReports. udchar_width=NUMBER][&jrs.cls q jrs. catalog=CATALOG&jrs.cmd=jrs.get_rpt_desc_page&jrs. catalog=CATALOG&jrs. no_margin_ps=TRUE/FALSE][&jrs.To Applet 1 .report=/SampleReports/InvoiceReport.cmd=jrs.cls?jrs. version_id=VERSION_ID URL Example: http://localhost:8888/jrserver/SampleReports/SampleReports.Java Plug-In 1.3 for Windows BROWSER_TYPE: 0 .version_id=103 .To TEXT 4 .udchar_height=NUMBER][&jrs.[&jrs.hist_file=1% 5cJReport_System_User327406359%5cEmployeeInformation.cmd=jrs.no_margin_rtf=TRUE/FALSE] URL Example: http://localhost:8888/jrserver/SampleReports/SampleReports.get_rpt_param_page&jrs.cat&jrs.cmd=jrs.del_rpt_ver&jrs.del_rpt_ver Description: Deletes a version of a report.To DHTML APPLET_TYPE: 2 .cmd=jrs.To Rich Text Format 7 . catalog=/SampleReports/SampleReports.rst&jrs. catalog=/SampleReports/SampleReports. HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver/REPORT?jrs.Firefox r r q jrs.cls?jrs.To PostScript 6 . HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver?jrs.cmd=jrs.get_rpt_desc_page Description: Gets an HTML page for entering parameter values and choosing the result type of a report.To Excel 5 .cat&jrs.To PDF 3 .IE or Chrome 1 .del_rpt_ver&jrs.get_rpt_param_page&jrs.To HTML 2 .Java Plug-In 1.cat/ InvoiceReport.2 for Windows 3 .result_type=1 Notes: r RESULT_TYPE: 0 .report=REPORT URL Example: http://localhost:8888/jrserver?jrs.view_ver_rst&jrs.get_rpt_desc_page&jrs.cmd=jrs.cls q jrs.To XML 8 .report=REPORT URL Example: http://localhost:8888/jrserver?jrs.get_rpt_param_page Description: Gets an HTML page for entering parameter values of a report.delimiter=DELIMITER][&jrs.report=/SampleReports/InvoiceReport. HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver?jrs.cat/ EmployeeInformation. is_applet_chart=TRUE/FALSE][&jrs.web_vw Description: Runs a report and views its result in a web browser.cmd=jrs.rpt_encoding=RPT_ENCODING][&jrs.db_pswd=123456&jrs. is_multi_files=true&jrs. result_type=RESULT_TYPE&jrs.del_rst_ver&jrs.cmd=jrs.cls?jrs.cmd=jrs.del_rstdoc_ver&jrs..cmd=jrs.param $NAME=true&jrs.cat/ InvoiceReport.del_rstdoc_ver&jrs. no_margin_html=TRUE/FALSE][&jrs.version_id=108 q jrs.named_wp=ExistedWhereportion][&jrs.del_rst_ver Description: Deletes a result version of a report. version_id=VERSION_ID URL Example: http://localhost:8888/jrserver/SampleReports/SampleReports.cmd=jrs.cat/ InvoiceReport.jdbc_driver=JDBC_DRIVER][&jrs.udchar_height=NUMBER][&jrs..is_multi_files=TRUE/FALSE][&jrs.result=/SampleReports/ InvoiceReport&jrs.cmd=jrs.rpt_language=en Notes: r RESULT_TYPE: 0 . HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver/REPORT?jrs.version_id=106 q jrs.has_page_number=TRUE/FALSE][&jrs.cat/ InvoiceReport. HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver/REPORT?jrs.cls?jrs.use_def_db_user=TRUE/FALSE][&jrs.To HTML .use_table=TRUE/FALSE] [&jrs.wp=DBField='value'] [&jrs.version_id=103 q jrs.param$State=New South Wales&jrs.use_def_db_user=false&jrs.cmd=jrs.isjrsapltpg=TRUE/FALSE] [&jrs.no_margin_pdf=TRUE/ FALSE][&jrs.drilldown=TRUE/FALSE][&jrs.web_vw&jrs.is_applet_chart=true&jrs.cmd=jrs.get_ver_param&jrs. version_id=VERSION_ID URL Example: http://localhost:8888/jrserver?jrs. rpt_language=RPT_LANGUAGE][&jrs.result_type=1&jrs.param$City=Sydney&jrs. no_margin_rtf=TRUE/FALSE][&jrs.param $Country=Australia&jrs. version_id=VERSION_ID URL Example: http://localhost:8888/jrserver/SampleReports/SampleReports.To Applet 1 .web_vw&jrs.param$NAME=VALUE.cls?jrs. HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver?jrs.q jrs.no_margin_ps=TRUE/FALSE][&jrs.relative_font_size=TRUE/FALSE][&jrs.][&jrs. db_user=dba&jrs.report_sheet$RPT_TAB_NAME=true] URL Example: http://localhost:8888/jrserver/SampleReports/SampleReports. has_hyperlink=TRUE/FALSE][&jrs.is_norm_txt=TRUE/FALSE][&jrs.web_browser=BROWSER_TYPE][&jrs.param$NAME=VALUE&jrs. db_pswd=DB_PASSWORD][&jrs.get_ver_param&jrs. udchar_width=NUMBER][&jrs.result=RESULT&jrs.del_rstdoc_ver Description: Deletes a version of a result document.jdbc_url=JDBC_URL][&jrs.get_ver_param Description: Gets the parameter file of a report's result version.db_user=DB_USER][&jrs.applet_type=APPLET_TYPE[_isMultiple_jrs.delimiter=DELIMITER][&jrs. HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver/REPORT?jrs.del_rst_ver&jrs. cmd=jrs. For example. jrs. 1998. You can then set a new WHERE portion such as.report_sheet$RPT_TAB_NAME=true to specify a report tab in the current page report. Here Region is the WHERE portion's name. For Example: jrs.is_applet_chart=TRUE/FALSE][&jrs.param$PM=3&jrs. r r r If you want to run a specific page report tab. where RPT_TAB_NAME is the report name of the specific report tab.param$PTODAY=May 21.no_margin_pdf=TRUE/FALSE][&jrs. For example.applet_type=APPLET_TYPE[&jrs.no_margin_html=TRUE/ FALSE][&jrs.is_applet_chart=true&jrs.Firefox Use jrs. r q jrs. is_norm_txt=TRUE/FALSE][&jrs.isjrsapltpg=TRUE/FALSE][&jrs. r If you want to define a new WHERE portion from the URL.api.ReportSheetInfo.. Where. For the detailed usages. result_type=1&jrs.jrs..has_hyperlink=TRUE/ FALSE][&jrs. you need to add _isMultiple_jrs. .param $TERMSDAYS=30&jrs.. to set the existed WHERE portion Region from URL.try_vw&jrs. use jrs. For example. is_multi_files=TRUE/FALSE][&jrs..relative_font_size=TRUE/FALSE][&jrs. HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver/REPORT?jrs. NAME is the parameter name and VALUE is the URL-encoded parameter value. and you want to restrict the field Customer Region to CA in the URL. ". named_wp.2 for Windows 3 .jrs.has_page_number=TRUE/FALSE][&jrs. For example: &_isMultiple_jrs. result_type=1&jrs.web_browser=BROWSER_TYPE][&jrs. not the display name. you can choose the property jrs.delimiter=DELIMITER][&jrs.report_sheet$Report2=true.wp. you should use the property jrs. you can make use of the API methods getName() and getDisplayName() in the interface jet.param$NAME=VALUE to set parameter values of the report.Java Plug-In 1.2 3 4 5 6 7 8 r - To To To To To To To PDF TEXT Excel PostScript Rich Text Format XML DHTML APPLET_TYPE: 2 . result_type=RESULT_TYPE&jrs. While..wp=Customers.udchar_width=NUMBER][&jrs. see JReport Server Javadoc located in <install_root>\help\server\en \api.IE or Chrome 1 . the report has a DBField Customer Region. param$NAME=true before the parameter values to declear that the parameter supports multiple values. drilldown=TRUE/FALSE][&jrs.3 for Windows BROWSER_TYPE: 0 .use_table=TRUE/FALSE][&jrs. param$PM=16.is_applet_chart=true&jrs. If you want to set an existing WHERE portion in the URL.server...param$PM=true&jrs.".".named_wp=Region.Java Plug-In 1.. when specifying values for a multi-value parameter. use ".try_vw Description: Tries to view a report in a web browser. To get the report name and display name of a page report tab.Region='CA'. cmd=jrs. HTTP Method: GET/POST .enable_schedule&jrs.enable_schedule&jrs.To XML 8 .cmd=jrs.cmd=jrs.disable_schedule Description: Disables a schedule.no_margin_rtf=TRUE/FALSE] [&jrs.no_margin_ps=TRUE/FALSE][&jrs.455 q jrs.db_user=DB_USER][&jrs.task_id=200312-11 11:09:16.To Applet 1 .db_pswd=DB_PASSWORD] [&jrs. HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver?jrs.To DHTML APPLET_TYPE: 2 .cmd=jrs.cmd=jrs.jdbc_driver=JDBC_DRIVER][&jrs.cmd=jrs.To Excel 5 .del_schedule&jrs.To PDF 3 .task_id=TASK_ID URL Example: http://localhost:8888/jrserver?jrs. HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver?jrs.3 for Windows BROWSER_TYPE: 0 .cat/ EmployeeInformation.To TEXT 4 .try_vw&jrs.IE or Chrome 1 . named_wp=ExistedWhereportion][&jrs.Firefox jrs. task_id=2003-12-11 11:09:16.To PostScript 6 .report_sheet$RPT_TAB_NAME=true] URL Example: http://localhost:8888/jrserver/SampleReports/SampleReports.get_schedules r r q Description: Gets the schedules list.del_schedule Description: Deletes a schedule.rpt_language=RPT_LANGUAGE] [&jrs.jdbc_url=JDBC_URL][&jrs.get_schedules URL Example: http://localhost:8888/jrserver?jrs.cls?jrs.wp=DBField='value'][&jrs.udchar_height=NUMBER][&jrs.To Rich Text Format 7 .get_schedules q jrs.use_def_db_user=TRUE/FALSE][&jrs.task_id=TASK_ID URL Example: http://localhost:8888/jrserver?jrs.Java Plug-In 1.cmd=jrs.455 q jrs.enable_schedule Description: Enables a schedule.result_type=1 Notes: r RESULT_TYPE: 0 .Java Plug-In 1.2 for Windows 3 . HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver?jrs.del_schedule&jrs.rpt_encoding=RPT_ENCODING][&jrs.To HTML 2 . cmd=jrs.id=RECORD_ID URL Example: http://localhost:8888/jrserver?jrs.get_active Description: Gets the active tasks list.cmd=jrs.cmd=jrs.cmd=jrs.cmd=jrs. catalog=CATALOG&jrs.get_active URL Example: http://localhost:8888/jrserver?jrs.del_completed Description: Deletes a completed task. task_id=TASK_ID URL Example: http://localhost:8888/jrserver?jrs.del_completed&jrs.disable_schedule&jrs.disable_schedule&jrs.report=/SampleReports/ EmployeeInformation. task_id=2003-12-11 11:09:16. task_id=2003-12-11 11:13:23.del_all_completed q jrs.cmd=jrs.get_edit_schd_page&jrs.cls q jrs.get_active q jrs.cat&jrs. HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver?jrs. id=1071119897006-154848108 q jrs.get_completed q jrs.cmd=jrs. catalog=/SampleReports/SampleReports.task_id=TASK_ID URL Example: http://localhost:8888/jrserver?jrs. HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver?jrs.get_completed URL Example: http://localhost:8888/jrserver?jrs.get_completed Description: Gets the completed tasks list.cmd=jrs.cmd=jrs. HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver?jrs.URL Format: http://HOST:PORT/jrserver?jrs.del_completed&jrs.02 q jrs.cmd=jrs.report=REPORT URL Example: http://localhost:8888/jrserver?jrs.get_new_schd_page&jrs.cmd=jrs.del_all_completed URL Example: http://localhost:8888/jrserver?jrs.get_new_schd_page&jrs.get_new_schd_page Description: Gets an HTML page in order to create a new schedule for the report with a web browser.del_all_completed Description: Deletes all completed tasks.get_edit_schd_page&jrs. HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver?jrs.cmd=jrs.get_edit_schd_page Description: Gets an HTML page to edit the schedule with a web browser. HTTP Method: GET/POST .455 q jrs. HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver?jrs. HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver?jrs.cmd=jrs.stop_task Description: Stops an active task.cmd=jrs. uid=admin&jrs. HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver?jrs. HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver?jrs.uid=admin&jrs. new_password=NEW_PASSWORD&jrs. HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver?jrs.cmd=jrs.get_preference_page URL Example: http://localhost:8888/jrserver?jrs.get_change_password_page URL Example: http://localhost:8888/jrserver?jrs. you can encrypt the PDF results by using the encrypting PDF properties.login Description: Logs into the JRServlet from a login dialog with web browsers or the JRViewer.login URL Example: http://localhost:8888/jrserver?jrs.cmd=jrs.logout Description: Logs out from the JRServlet.cmd=jrs.confirm_new_password=1234 q jrs.get_preference_page Description: Gets an HTML page in order to change the user preference settings with a web browser.task_id= 200312-11 11:13:23.cmd=jrs. HTTP Method: POST Form Action: http://HOST:PORT/jrserver?jrs.cmd=jrs.cmd=jrs.change_password&jrs. new_password=1234&jrs.password=ad&jrs.change_password&jrs.cmd=jrs.get_preference_page q jrs.logout q jrs.cmd=jrs.task_id=TASK_ID URL Example: http://localhost:8888/jrserver?jrs.cmd=jrs.password=CURRENT_PASSWORD&jrs.cmd=jrs.change_password Description: Changes the password for a user. .02 q jrs.stop_task&jrs.change_password Content Type: application/x-www-form-urlencoded Content: jrs.get_change_password_page q jrs.cmd=jrs. HTTP Method: GET/POST URL Format: http://HOST:PORT/jrserver?jrs.get_change_password_page Description: Gets an HTML page in order to change the password with a web browser.confirm_new_password=NEW_PASSWORD Content Example: jrs.logout URL Example: http://localhost:8888/jrserver?jrs.stop_task&jrs.cmd=jrs.cmd=jrs.login Tip: When running reports to the PDF format via URL.URL Format: http://HOST:PORT/jrserver?jrs. Example: If the user ID and password are both set as admin.cmd=jrs.auth_pwd=admin Note: The JRServlet does not check security when an HTTP request has no jrs.auth_uid=USER_ID. Note: The JRServlet does not check security when an HTTP request has no jrs. . if you want to avoid the login dialog in the web browser. Description: Loads the JRServlet and avoids the login dialog in web browsers.Running reports via URL with authentication parameters Sometimes you are required to give your user name and password before you can run reports.auth_uid and jrs.cmd in the HTTP query in the root path of the JRServlet.auth_uid and jrs.auth_uid and jrs. the URL will be as follows: http://localhost:8888/jrserver?jrs. Format of the value of the HTTP query field: Base64-encoded (userID:password).auth_pwd.authorization=YWRtaW46YWRtaW4%3D. Under this circumstance. authorization=YWRtaW46YWRtaW4%3D.authorization for the request http://localhost:8888/jrserver?jrs. Format of the value of the HTTP query field: jrs. then the value of the HTTP query field is Base64encoded("admin:admin")="YWRtaW46YWRtaW4=". Description: Loads the JRServlet and avoids the login dialog in web browsers. jrs. and also does not accept the jrs.cmd in the HTTP query in the root path of the JRServlet. use either of the following two parameters: q jrs.cmd=jrs. q jrs. and also does not accept the jrs. auth_pwd=admin. and the URL will be as follows: http://localhost:8888/jrserver?jrs. auth_pwd for the request http://localhost:8888/jrserver?jrs.get_subnodes&jrs.get_subnodes&jrs.auth_pwd=PASSWORD. Example: If the user ID and password are both set as admin.authorization. auth_uid=admin&jrs.auth_uid=admin&jrs.authorization Tag of the HTTP query field jrs.auth_pwd Tags of HTTP query field: jrs.path=/SampleReports&jrs. huc. "application/x-www-form-urlencoded").setRequestProperty("Content-Type".get_subnodes").cmd=jrs. } } } . if (uc instanceof HttpURLConnection) { HttpURLConnection huc = (HttpURLConnection)uc.JRClient. if (inStream != null) { BufferedReader reader = new BufferedReader(new InputStreamReader(inStream)). writer. huc.getOutputStream()).getConnection(). q In Java program For example: URL url = new URL("http://jrserver:8888"). OutputStreamWriter writer = new OutputStreamWriter(huc. //write the HTTP query to the output stream. String inputLine.Running reports via URL using the POST method q In HTML pages Specify the POST as the method of a form in an HTML page.readLine())) { System. URLConnection uc = url.write("jrs. //set use POST method. InputStream inStream = uc. useGetAsDefaultMethod() and ifUsePostAsDefaultMethod () can be used in the class jet.setDoOutput(true).client.out.getHeaderField(0). writer.getInputStream().println(inputLine).api. huc. //get the response content from the server. huc.close(). q Using JRClient API or JRViewer Bean Three methods: usePostAsDefaultMethod().setRequestMethod("POST"). while (null != (inputLine = reader. q q With the above three conditions fulfilled. However.Specifying parameter values using dialog when running reports via URL When running a report with parameters via URL. JReport provides you with the special JSP tryView. which enables to display the Enter Parameter Values dialog to manage parameters. if you click Cancel in the dialog. the most effective way to display the parameter dialog is that you do not specify parameters at all in the URL. However. . No parameter specified in the URL or the parameters provided in the URL fail to include all necessary parameters.jsp. JReport Server will append the values to the URL string for you and execute the URL. the Enter Parameter Values dialog will be displayed right after you finish the URL in the address bar and make it run. After setting the values and clicking OK in the dialog. you need to manually enter the parameter values in the URL string without any mistakes. The display of the parameter dialog requires: q The report has parameters. You may find this painful sometimes because it's not easy to remember all parameters in a report. Tip: If you want to specify parameters via dialog when running reports via URL. the URL running will be cancelled.jsp. The URL calls tryView. cls.cls?jrs.jdbc_url=jdbc:oracle:thin:@host:1521:demo 2.jdbc_url=jdbc:sybase:Tds:host:5000/product 4.try_vw&jrs. and later switch the connection to the SQL database named JTTest at runtime. You can use the switch database commands to set the JDBC connection or to change the user name/password in order to connect to another database.cat/Report1. Switching the connection and user/password in the same database 1.db_pswd=tiger 3. The URL for switching the connection: http://localhost:8888/jrserver/SampleReports/SampleReports.cls?jrs.try_vw&jrs.result_type=1&jrs. The URL for switching the connection: http://localhost:8888/jrserver/SampleReports/SampleReports. Set oracle815 connection when designing the report Report1.result_type=1&jrs.cls?jrs.try_vw&jrs.jdbc_url=jdbc:inetdae:host:1433? database=JTTest&sql7=true Switching the connection between different databases 1. Set the Oracle database named oracle815 connection when designing the report Report1.db_user=Scott&jrs.cls. you will then be free from having to build another similar catalog. Specify the user ID system/manager to ensure security when designing the report Report1.cat/Report1. Set the SQL database named MBA2000 when designing the report Report1.cls.Example 1: Accessing reports via URL using the switching database command at runtime To access reports via URL. and then switch the connection to Access database with the JDBC-ODBC driver named products at runtime.cat/Report1. As a result. cmd=jrs. and later switch the connection to the Oracle database named demo at runtime. The URL for switching the user ID and password: http://localhost:8888/jrserver/SampleReports/SampleReports. . The URL for switching the connection: http://localhost:8888/jrserver/SampleReports/SampleReports. The URL for switching the connection: http://localhost:8888/jrserver/SampleReports/SampleReports.cls.cat/Report1.result_type=1&jrs. and later switch the connection to the Sybase 12 database named product at runtime.result_type=1&jrs. Set the Sybase 12 database named master when designing the report Report1. you can switch the connection in the same database or between different databases at runtime with the commands listed in the section Running reports via URLs with protocols or commands.cat/Report1.cls?jrs.cls.cls?jrs. cmd=jrs. and then switch to the user ID Scott and the password tiger. if the databases you want to switch between have the same structure. cmd=jrs.try_vw&jrs. cmd=jrs. jdbc_url=jdbc:odbc:products 2. cmd=jrs.inet.TdsDriver&jrs.jdbc.cls?jrs.cls.cmd=jrs. Set oracle815 connection when designing the report Report1.odbc. The URL for switching the connection: http://localhost:8888/jrserver/SampleReports/SampleReports.try_vw&jrs. jdbc_url=jdbc:inetdae:JT_P05:1433?database=products&sql7=true .jdbc_driver=com.result_type=1&jrs.JdbcOdbcDriver&jrs. and then switch the connection to SQL server database named products at runtime.jdbc_driver=sun.result_type=1&jrs.cat/Report1.try_vw&jrs.tds. com&jrs.mailto=mail address jrs.result_type=1 (HTML) or 2(PDF) or 3(Text) or 4(Excel) or 5(PostScript) or 6(Rich Text) or 7(XML) jrs.mailto=person@company. or else it runs with the parameters specified in the URL.report=%2freport path%2freport name jrs. timeout_send_email=true&jrs.jsp to run a report without a parameter: http://localhost:8888/jinfonet/tryView. jsp.jsp functions the same as tryView. mailsubject=AboutTaskForTimeout&jrs. For
[email protected]$p_EndDate=12/31/2007&jrs.jsp to run a report with parameters: http://localhost:8888/jinfonet/runReport. the report runs with the default parameters if no parameter is specified.param$P_StartDate=01/01/2006&jrs. send mail) .mailcomments=mail content jrs.timeout_send_email=true&jrs. Take the following examples to publish a large report result by e-mail and to customize the message displayed in the web browser.cmd=jrs.timeout_send_email=true.mailsubject=TaskForTimeoutSendEmail&jrs. r When you use tryView.com&jrs.jsp?jrs.com When you use runReport.report=%2fSampleReports%2fCustomerAnalysis.result_type=1 q Servlet parameter specification jrs. runReport.cmd=jrs.cmd=jrs.timeout_send_email=true. When it has parameters.web_vw (when the report has parameter) jrs.cmd=jrs.timeout_send_email=true/[false] jrs. otherwise it will directly go to runReport.jsp The runReport.report_timeout=number (if timeout >number and jrs.catalog=% 2fSampleReports%2fSampleReports.try_vw&jrs. If the report has parameters and the parameters provided in the URL fail to include all necessary parameters.report_timeout=number (if timeout >number and jrs.mailsubject=mail subject jrs.try_vw (when the report has no parameter) jrs.jsp?jrs.jsp when the report has no parameter. see Specifying parameter values using dialog when running reports via URL.Example 2: Sending a large report result by e-mail upon finishing Here two ways are provided to publish a large report result via URL: JSP and servlet.report_timeout=5&jrs.mailfrom=person@company. the Enter Parameter Values dialog will be shown for you to specify parameters.report_timeout=1&jrs.report=%2fSampleReports%2fEmployeeInformation.mailfrom=mail address of sender jrs.catalog=%2fcatalog path%2fcatalog name jrs.catalog=% 2fSampleReports%2fSampleReports.jsp This is the normal method of accessing reports using URLs. mailcomments=IFTHEREPORTISFINISHEDTHERESULTWILLBESENT&jrs.cat&jrs. send mail) jrs. cls&jrs.result_type=1&jrs.web_vw&jrs.cat&jrs. q JSP parameter specification jrs. cls&jrs.timeout_sendmail_message=the message which you customize There are two server JSPs for running a report: r tryView.timeout_send_email=true/[false] jrs. <p>Its type is {3}.Catalog name/report <p> .cat/CustomerAnalysis.mailfrom=person@company.<p>It is a file whose type is {3}.param $p_EndDate=12/31/2007&jrs.timeout_sendmail_message=the message that you can customize When you use a servlet to run a report without a parameter: http://localhost:8888/jrserver/SampleReports/SampleReports.mail from {6} .mail to {2} .com&jrs.web_vw&jrs.
[email protected]=AboutTaskForTimeoutSendEmail&jrs.cmd=jrs. result_type=1&jrs.timeout_send_email=true&jrs.
[email protected]_timeout=1&jrs.cat/EmployeeInformation.an Enter key Example http://localhost:8888/jrserver/SampleReports/SampleReports.mailcomments=mail content jrs.cat/CustomerAnalysis. The subject is <mail subject> and has been sent to <mailto> from <mailfrom> It is a file whose type is <type>.mail subject {3} . cls?jrs.param$P_StartDate=01/01/2006&jrs.timeout_send_email=true&jrs.timeout_send_email=true&jrs.com&jrs.cmd=jrs..mailcomments=CustomerAnalysis&jrs.com&jrs.result_type=1 (HTML) or 2(PDF) or 3(Text) or 4(Excel) or 5(PostScript) or 6(Rich Text) or 7(XML) jrs.report_timeout=1&jrs.<p>The report is sent to {1} from {5}.param $p_EndDate=12/31/2007&jrs.mailsubject=AboutTaskForTimeoutSendEmail&jrs.cmd=jrs.
[email protected]_sendmail_message.. you want to display message as below: Running <report name> takes more than <Timeout> seconds. For example. <p>The subject of the mail is {2}.The report timeout {1} . This {6} is a large report whose runtime is over {0} seconds.mailsubject=TaskForTimeoutEmail&jrs.mailcomments=COUNTRECORDSPERPAGE When you use a servlet to run a report with a parameter: http://localhost:8888/jrserver/SampleReports/SampleReports. .result type {4} .cls? jrs.try_vw&jrs.mailsubject=mail subject jrs.mailto=mail address jrs. Where {0} .<p>The subject is {2} and has been sent to {1} from {5}.timeout_sendmail_message=Running {6} takes more than {0} seconds. result_type=1&jrs.mailfrom=mail address of the sender jrs.com&jrs.result_type=1&jrs. mailcomments=CUSTOMERORDER q Customize your message to be displayed in the web browser You can set a message by setting the parameter jrs.web_vw&jrs.report_timeout=1&jrs.mail comment {5} .param$P_StartDate=01/01/2006&jrs. Then you can set the parameter in URL: jrs.jrs.cls? jrs. timeout_sendmail_message=. .Note: You should type the sign " ' " twice if you use it in the message. jsp?jrs.result_type=8&jrs.ReportSheetInfo.cls is as below: http://localhost:8888/jinfonet/tryView. not the display name. The URL for running a report tab Applet within the report MultimediaObjects.try_vw&jrs. To get the report name and display name of a report tab.cmd=jrs.Example 3: Running a report tab in a page report via URL You can use the following command to specify a specific report tab in the current page report: jrs.cat/MultimediaObjects. see JReport Server Javadoc located in <install_root>\help\server\en\api. RPT_NAME is the report name of the specific report tab.report_sheet$RPT_NAME=true Where.try_vw&jrs.report_sheet$Report1=true Or http://localhost:8888/jrserver/SampleReports/SampleReports. cls&jrs. For the detailed usages.cmd=jrs.report=%2fSampleReports%2fMultimediaObjects.report_sheet$Report1=true .cat&jrs. you can make use of the API methods getName() and getDisplayName() in the interface jet.catalog=% 2fSampleReports%2fSampleReports.result_type=8&jrs.api.cls? jrs.server. can be localized according to your requirements. and if you schedule to publish the report to several formats and DHTML format is included at the same time. the names of page navigation links in the report. Next. When you schedule to publish a report to HTML format. For details. the link will not be available in the other format outputs either. The scheduled tasks will be recorded by the server according to their different executing status.Scheduling reports JReport Server can run reports at a specified time or periodically by scheduling tasks for reports. such as First. the link will no longer be supported. refer to Localizing the page navigation links in HTML report outputs. q . if the report is linked to another report. Previous. and Last. Pick a topic from the following for details about how to schedule tasks in JReport Server: q Scheduling reports with dialog Scheduling reports via URL Scheduling a task containing a bursting report Scheduling a customized task using User Task Recording scheduled tasks Viewing scheduled report results Importing and exporting scheduled tasks Adding TaskListener q q q q q q q Notes: q When you schedule to publish a report to DHTML format. in the DHTML result. and JReport Server will then perform the task. In the General tab. click Run > Schedule. publishing to e-mail. 6. and then set the settings for the specified type. specify the time for when the task is to be performed in the Time sub tab. In the Publish tab. In the Duration tab.Scheduling reports with dialog You can schedule tasks for a specified report with dialog as follows: 1. specify to notify someone via e-mail of when the task is finished and whether it is successful or unsuccessful. specify the parameter values as required (for details. see Scheduling a task containing a bursting report). specify the type of the task. publishing to printer. Select the report row. right-click in the row and select Schedule from the shortcut menu. 7. To make it available.Parameters). See also Schedule dialog for details about the task types and settings in each tab. Click Finish. specify a time duration for the task. On the JReport Console > Reports page. and ask JReport Server to cancel the task or to notify you or someone else of the task status via e-mail if the task has not yet finished running when the task duration is up. Six task types are provided by JReport Server: publishing to version. 3. then on the task bar of the Reports page. Then. and select or create a trigger to bind with the task in the Trigger sub tab. Put the mouse pointer over the report row and click the Schedule button toolbar. the Enable Task Duration option on the JReport Administration page > Configuration > Advanced panel must be checked. In the Conditions tab. specify the other options as required. If the report has parameters. see General tab . Do either of the following: r Select the report row. You can choose multiple normal report tabs or one bursting report at a time (for scheduling a bursting report. In the Notification tab. Choose the type you want to publish. 8. select the report tabs you want to run from the report. 2. For detailed information. browse to the report you want to schedule to run. publishing to disk. 5. the Duration tab is not displayed in the Schedule dialog. on the floating r r The Schedule dialog is then displayed. Note: By default. The following are some specific scheduling examples: q Example 1: Publishing a report to the versioning system Example 2: Publishing a report to the file system q . 4. publishing to fax and publishing to FTP. see Task-level timeout for advanced run and schedule tasks. q Example 3: Publishing a report to e-mail Example 4: Publishing a report to printer Example 5: Publishing a report to fax Example 6: Publishing a report to an FTP site q q q . In the General tab. In the Enter Parameters section. Check Use the default DB user and password defined in catalog. check the Enable Style Group checkbox and choose the style group. see Adding TaskListener). specify the parameter values as required. g. Specify a name for the task in the Schedule Name text box. l. select the report tabs you want to run from the report. select the Time sub tab. b. if the report has a style group. Expand the Report Information section. 2. Assign a priority to the task from the Priority drop-down list. Enter a name for the task in the Name of the schedule field. a task is set up and will be performed immediately. In the Publish tab. Set 0 for the Maximum Number of Versions. choose Run this task immediately. f. c. Expand the Advanced section. 1. then from the Time Type drop-down list. Check the Enable Auto Recover Task option to specify auto recovering settings. and input the class name (for details. Check the Enable Converting Encoding option if required and specify the encoding before and after converting from the corresponding drop-down lists. c. Check the Built-in Version Folder option in Archive Location to save the report result version in the built-in version folder. Define the encoding for the report by selecting from the drop-down list. select the report row. i. then check Publish to Versioning System. click Select Another Catalog to specify another catalog for the report if required. Check the Result Auto-delete option and define the result to expire in 30 days. 4. k. d. go to the . e.Example 1: Publishing a report to the versioning system In this example. j. define the time zone from the Time Zone dropdown list. 5. d. Select the required formats and set the format settings. m. a. Select the report version and catalog version from the corresponding drop-down lists. e. If the report has parameters. h. Check the Add TaskListener to be Invoked option. If you want to notify someone of when the task is finished by sending an e-mail. b. 3. a. The generated result is asked to be kept for 30 days. On the JReport Console > Reports page. Click the To Version sub tab. right-click in the row and select Schedule from the shortcut menu to display the Schedule dialog. In the Conditions tab. you will get the link Publish to Version System on the system toolbar of the JReport Console page.temp to true in the server. specify the settings in the Duration tab as required. you can see a record of it in the Running tab.from. click My Tasks on the system toolbar. . 2. follow the steps below: 1. Then. if you want to use the URL to get the . 6. q There is another way to publish the report result to version.properties file in <install_root>\bin. Click the link to publish the result to version. version. Put the existing XML schema file in <intall_root>\public_html. 7. If you have set the property server. Click Finish to have the task performed.Notification tab and then set the settings. While the task is being performed. or selected the option Enable "Publish to Versioning System" for Background Tasks View on the JReport Administration page > Configuration > Advanced panel. On completion it will be put into the Completed tab. Input http://IP address:8888/name of the existing XML schema file. If you want to specify a timeout for the task. Notes: q When publishing a report to XML format.xsd file. q q . Keep the Time settings as default. In the Publish tab of the Schedule dialog. In the Conditions tab. since when a fixed directory path is specified. 5. e.Example 2: Publishing a report to the file system In this example. then specify the trigger logic with time condition. you will learn how to set up a task to publish the report result in various file formats to the file system repeatedly at the start of each month. specify the result location. b. see Trigger tab. 6. then from the Time Type drop-down list. it will not stop being performed until you delete or disable it from the Scheduled tab. 1. define the time zone from the Time Zone drop-down list. you are able to input the dynamic directory path to avoid report management difficulties. Since you have not specified the duration Run until a time for this task. choose Run this task periodically. click My Tasks on the system toolbar. If you also want to set an event which needs to occur before running the report. If you want to notify someone of when the task is finished by sending an e-mail. specify the settings in the Duration tab as required. In the Duration box. the result will be put to the real path. Then. In order to keep the report result generated every time. In the Time sub tab. go to the Notification tab and set the settings. Similarly. specify a time period for when the task will be performed. you should use the dynamic result file name. too many results may be generated in one directory. If you use a fixed name to perform the task periodically. Otherwise it will be put to the default disk location where server resources are. select a trigger to bind with the task from the Select a trigger to bind drop-down list in the Trigger sub tab. see Appendix 5: Dynamic names. click the To Disk sub tab. Click Finish to have the task performed. d. Notes: q When you specify to publish the report result to the server resource tree. For more information. 2. 3. JReport Server will automatically create it. Take steps 1 and 2 as in Example 1. c. you will see that the scheduled task has been recorded in the Scheduled tab. If you specify to publish the report result to a non-existent folder on disk. Select Monthly from the Date drop-down list and keep the default to run the first day of every 1 month. a. 4. For detailed information about the logic between the trigger condition and the time condition. and set the format settings according to your requirements. If you want to specify a timeout for when the scheduled report will be allowed to run. only the most recently generated report result will be kept. select the required format. if the specified folder has a real path. . click My Tasks on the system toolbar. specify the settings in the Duration tab as required. you can see a record of it in the Running tab and on completion it will be put into the Completed tab. 6. then fill in every field. select the format in which you want to export the report result and set the settings according to your requirements. Take steps 1 and 2 as in Example 1. select the Time sub tab. In the Conditions tab.To E-mail. select to whom the report result will be sent. 4. you will learn how to set up a task to publish the report result to e-mail. Click Finish to have the task performed. 1. 5. When you choose to specify a report result as an attachment to e-mail. then from the Mail To list. For details about settings of creating a new e-mail. choose Run this task immediately. Then. define the time zone from the Time Zone dropdown list. click the Edit button to edit the specified e-mail. If you want to notify someone of when the task is finished by sending an e-mail. If you want to specify a timeout for the task. go to the Notification tab and set the settings. you need to specify a file name for the attachment. . If required. 3. If you want to create another e-mail. When the task is being performed. refer to Schedule dialog .Example 3: Publishing a report to e-mail In this example. In the Publish tab of the Schedule dialog. click the New button. then from the Time Type drop-down list. click the To E-mail sub tab. 2. you can see a record of it in the Running tab and on completion it will be put into the Completed tab. the server may crash or throw an exception. and you schedule to publish a report to a printer. b. 4. If you want to specify a timeout for the task. choose Run this task immediately. go to the Notification tab and set the settings. If you want to notify someone of when the task is finished by sending an e-mail. 5. 6.Example 4: Publishing a report to printer In this example. 2. click My Tasks on the system toolbar. Type a name with the path of the printer in the Printer field. Select a JDK print method for the report result in the Select Print Method field. Click Finish to have the task performed. a. Then. In the Publish tab of the Schedule dialog. then from the Time Type drop-down list of the Time tab. Note: When there is no printer connected with JReport Server. . When the task is being performed. In the Conditions tab. define the time zone from the Time Zone dropdown list. you will learn how to set up a task to publish the report result to a printer. c. select the Time sub tab. 3. Take steps 1 and 2 as in Example 1. specify the settings in the Duration tab as required. Select the To Printer sub tab and then check Publish to Printer. 1. check the Publish to Fax option and then fill in every field and set the settings according to your requirements. 2. When the task is being performed. In the Publish tab of the Schedule dialog. Take steps 1 and 2 as in Example 1. you must first have your modem configured. If you want to specify a timeout for the task. click My Tasks on the system toolbar. 6. you can see a record of it in the Running tab and on completion it will be put into the Completed tab. Before you can fax the report result. go to the Notification tab and set the settings. 3. you will learn how to set up a task to publish the report result to fax. 4. select the Time sub tab. choose Run this task immediately. . Click Finish to have the task performed. define the time zone from the Time Zone dropdown list. click the To Fax sub tab. If you want to notify someone of when the task is finished by sending an e-mail. 1.Example 5: Publishing a report to fax In this example. In the Conditions tab. 5. Otherwise a warning message will be displayed when you try to export to fax. specify the settings in the Duration tab as required. then from the Time Type drop-down list. Then. 4. Click the To FTP sub tab. In the Conditions tab. you will learn how to set up a task to publish the report result to an FTP site. . In the Publish tab of the Schedule dialog. you can see a record of it in the Running tab and on completion it will be put into the Completed tab. Note: Dynamic result name for FTP task is currently not supported. select the format in which you want to send the report results and then set the settings according to your requirements. go to the Notification tab and set the settings. Click Finish to have the task performed. If you want to specify a timeout for the task. define the time zone from the Time Zone dropdown list. When the task is being performed. Then. specify the settings in the Duration tab as required. 1. 5. select the Time sub tab. click My Tasks on the system toolbar. a. 3.Example 6: Publishing a report to an FTP site In this example. then click the New button to set up a new FTP site or click the Edit button to edit a specified FTP site in the FTP To list. b. Take steps 1 and 2 as in Example 1. Fill in every field. 6. choose Run this task immediately. If you want to notify someone of when the task is finished by sending an e-mail. 2. then from the Time Type drop-down list. If the report has no parameters then it directly run the URL. The display of the parameter dialog requires: q The report has parameters. You may find this painful sometimes because it's not easy to remember all parameters in a report. q q With the above three conditions fulfilled. JReport Server will append the values to the URL string for you and execute the URL. the most effective way to display the parameter dialog is that you do not specify parameters at all in the URL.scheduling reports via URL). the URL running will be cancelled. Tip: If you want to specify parameters via dialog when scheduling reports via URL.cls that uses the catalog /SampleReports/SampleReports.util.submit_schedule is called. The report CustomerAnalysis. the server then returns the parameter dialog for entering parameter values. The URL contains the command jrs. which enables to display the Enter Parameter Values dialog to manage parameters. q q q Specifying parameter values using dialog when scheduling reports via URL When scheduling a report via URL. q Constant: jet. Response: Returns the task ID to JRClient API.cat is used in these examples. HTTP Method: GET/POST. you need to manually enter the parameters in the URL string without any mistakes. if you click Cancel in the dialog. if the report contains parameters. .submit_schedule. However. The first is about time information and the second is about task information (for detailed information about each property. URL examples The following are some specific examples on how to schedule a report via URL. After setting the values and clicking OK in the dialog. and returns the scheduled tasks page to web browsers. The following is a description of this method. see Appendix 7: Properties .APIConst.Scheduling reports via URL A schedule contains two kinds of properties. the Enter Parameter Values dialog will be displayed right after you finish the URL in the address bar and make it run.CMD_SUBMIT_SCHEDULE Description: Submits a scheduled task to JReport Server.cs.submit_schedule. When reports are scheduled via URL in a web browser. No parameter specified in the URL or the parameters provided in the URL fail to include all necessary parameters. However. If the report has parameters and no parameter specified in the URL or the parameters provided in the URL fail to include all necessary parameters. the method jrs. JReport provides you with the special command jrs. uid=admin&jrs. report=%2fSampleReports%2fCustomerAnalysis.cls q If you want to publish the report to other formats.report_sheet$Report=true&jrs. you will need to change the parameter to jrs.schedule.launch_type=0&jrs. but you will need to modify the parameter jrs.cmd=jrs.catalog=%2fSampleReports% 2fSampleReports.catalog=%2fSampleReports% 2fSampleReports.hour=9&jrs.exe_min=00&jrs.param$P_StartDate=01/01/2006&jrs.cat&jrs. schedule_name=atTimeTask Publishing to the versioning system immediately and notifying others of success or failure To publish the report to the versioning system immediately.report_sheet$Report=true&jrs.is_hourly=true&jrs.jrtasks.schedule.to_version_rst=true&jrs.is_pm=false&jrs. . report=%2fSampleReports%2fCustomerAnalysis.to_version_rst=true&jrs.PublishRptTask&jrs.PublishRptTask&jrs.schedule. and support3 of success or failure.cat&jrs.task_class=jet. the URL used for this task could be as below: q To RST http://localhost:8888/jrserver?jrs.cat&jrs.server. For example. the URL used for this task could be as below: http://localhost:8888/jrserver?jrs.catalog=%2fSampleReports% 2fSampleReports. you can refer to the examples above.cat&jrs.cls To PDF http://localhost:8888/jinfonet/submitSchedPage.server. timezone=CTT&jrs. PublishRptTask&jrs.schedule.submit_schedule&jrs.cmd=jrs.to_version_excel=true.jrtasks.expire_days=30&jrs.catalog=% 2fSampleReports%2fSampleReports. the URL used for this task could be as below: http://localhost:8888/jrserver?jrs.cls&jrs.submit_schedule&jrs.hours=1&jrs.param$p_EndDate=12/31/2007&jrs.to_version_pdf=true&jrs.param$p_EndDate=12/31/2007&jrs. and notify the user support1. if you want to publish the report to Excel. PublishRptTask&jrs. uid=admin&jrs.uid=admin&jrs.jsp?jrs.uid=admin&jrs.exe_year=2008&jrs.submit_schedule&jrs.at_min=0&jrs.launch_type=1&jrs. is_weekday=false&jrs.jrtasks. to_version=true&jrs.cmd=jrs.schedule.param $p_EndDate=12/31/2007&jrs.exe_hour=12&jrs.day=1&jrs. December 1.to_version_pdf=true to suit the particular format that the report will be published to. 2008.param $P_StartDate=01/01/2006&jrs.to_version=true&jrs.min=0&jrs.expire_days=30&jrs.hour2=5&jrs.to_version=true&jrs.cat&jrs.jrtasks.server.server.submit_schedule&jrs. schedule_name=periodicalTask Publishing to the versioning system at a specific time To publish the report to the versioning system at 12:00:00 CST.task_class=jet.param $p_EndDate=12/31/2007&jrs.report=%2fSampleReports% 2fCustomerAnalysis. jrtasks.launch_type=8&jrs.cmd=jrs.cmd=jrs.task_class=jet.to_version_html=true&jrs.task_class=jet.rpt_language=en&jrs.launch_type=0&jrs. support2. is_pm2=true&jrs. catalog=%2fSampleReports%2fSampleReports.server.submit_schedule&jrs.PublishRptTask&jrs. the URL used for this task could be as below: http://localhost:8888/jrserver?jrs.task_class=jet.min2=0&jrs.param$P_StartDate=01/01/2006&jrs.exe_day=1&jrs.is_between=true&jrs. report=%2fSampleReports%2fCustomerAnalysis. exe_month=12&jrs. Publishing to the versioning system periodically To publish the report to the versioning system periodically.to_version=true&jrs.Publishing to the versioning system immediately To publish the report to the versioning system immediately.cls&jrs.param$P_StartDate=01/01/2006&jrs.days_id=0&jrs. catalog=%2fSampleReports%2fSampleReports.param$P_StartDate=01/01/2006&jrs.submit_schedule&jrs.cls& To PDF http://localhost:8888/jrserver?jrs. for example.launch_type=0&jrs.report=%2fSampleReports% 2fCustomerAnalysis.cmd=jrs.jrtasks.submit_schedule&jrs.param$p_EndDate=12/31/2007&jrs.cat&jrs.cls& q Note: If you want to publish a report to a disk path.mailsubject%3dreport&jrs.cmd=jrs.notification_emails=To%
[email protected]=jrs.pdf_dir=C:\ with jrs. the URL used for this task could be as below: q To RST http://localhost:8888/jinfonet/submitSchedPage.schedule.to_rst=true&jrs. the URL used for this task could be as below: http://localhost:8888/jinfonet/submitSchedPage.to_disk_pdf_path_type=1 in the above example and replace jrs.to_mail=true&jrs. catalog=%2fSampleReports%2fSampleReports.to_disk_rst_path_type=1&jrs. fail_notify=true&jrs. uid=admin&jrs.jsp?jrs. cls&jrs. for example.success_notify=true&jrs.report=%2fSampleReports%2fCustomerAnalysis.submit_schedule&jrs.server.jsp?jrs.schedule.report=%2fSampleReports%2fCustomerAnalysis. the URL used for this task could be as below: http://localhost:8888/jrserver?jrs. you can omit this parameter &jrs.schedule. launch_type=0&jrs.task_class=jet.pdf&jrs.param$P_StartDate=01/01/2006&jrs.cmd=jrs.task_class=jet.rpt_language=en Publishing to printer immediately To publish the report to a printer immediately.param$p_EndDate=12/31/2007&jrs.param$P_StartDate=01/01/2006&jrs. Publishing to e-mail immediately To publish the report to e-mail immediately.rst_dir=C:\.schedule.mailto%
[email protected] $p_EndDate=12/31/2007&jrs.com%0D%0ABcc%
[email protected]_class=jet.cls&jrs.server.rpt_language=en Publishing to fax immediately To publish the report to a fax immediately.rst_dir=%2fSampleReports.report=/SampleReports/CustomerAnalysis. PublishRptTask&jrs.cmd=jrs.expire_days=30&jrs.report=%2fSampleReports% 2fCustomerAnalysis.uid=admin&jrs.to_printer=true&jrs.task_class=jet. you can do the same as the example described above. jrmail0=jrs.param$P_StartDate=01/01/2006&jrs.PublishRptTask&jrs.com%0D%0A Publishing to the file system immediately To publish the report to the file system immediately.submit_schedule&jrs.param$p_EndDate=12/31/2007&jrs.server. Here SampleReports is the resource path.com%0D%0ACc%3A
[email protected]$P_StartDate=01/01/2006&jrs.catalog=%2fSampleReports% 2fSampleReports. to_version=true&jrs.pdf_dir=C:\&jrs.cat&jrs.catalog=% 2fSampleReports%2fSampleReports.pdf=CustomerAnalysis.PublishRptTask&jrs.report=%2fSampleReports% 2fCustomerAnalysis. launch_type=0&jrs.com%26jrs.rst&jrs.cat&jrs.cat&jrs.jrtasks. rst_dir=%2fSampleReports.cat&jrs. catalog=/SampleReports/SampleReports. jrs.jrtasks.to_pdf=true&jrs. jrs.submit_schedule&jrs.task_class=jet. If you want to publish a report to a resource tree. . jrtasks.PublishRptTask&jrs.jsp?jrs. uid=admin&jrs.PublishRptTask&jrs.schedule.server. to_disk=true&jrs.launch_type=0&jrs.rst_dir=C:\&jrs.server.to_version_rst=true&jrs. cls&jrs.launch_type=0&jrs.param $p_EndDate=12/31/2007&jrs. to_disk=true&jrs. the URL used for this task could be as below: http://localhost:8888/jinfonet/submitSchedPage.uid=admin&jrs.to_disk_pdf_path_type=1&jrs.cls&jrs.jrtasks.rst=CustomerAnalysis. 0.server.to_fax_is_include_cover=false&jrs.cat&jrs. uid=admin&jrs. the URL used for this task could be as below: http://localhost:8888/jrserver?jrs.param$p_EndDate=12/31/2007&jrs.launch_type=0&jrs. to_FTP=true&jrs.ftpUn%3dftpuser% 26jrs.to_fax=true&jrs.param $P_StartDate=01/01/2006&jrs.ftpLoc%3d%2ftest%26jrs.ftpPdf%3dtrue Related topics: q Setting dynamic parameter values when running or scheduling a report via API .PublishRptTask&jrs.catalog=%2fSampleReports% 2fSampleReports.168.ftp0=jrs.0%26jrs.submit_schedule&jrs.cls&jrs.param$P_StartDate=01/01/2006&jrs.jrtasks.launch_type=0&jrs.ftpHost%3d192.param$p_EndDate=12/31/2007&jrs.ftpPort%3d21%26jrs. task_class=jet.cmd=jrs.ftpPsd%3d1234%26jrs.schedule. to_fax_to_fax_number=888888 Publishing to FTP immediately To publish the report to an FTP site immediately.report=%2fSampleReports%2fCustomerAnalysis.uid=admin&jrs. and To Version sub tabs will be shown in the Bursting Result tab of the Publish tab for the bursting result. multiple reports can be scheduled at a time. only To E-mail. when scheduling to run a bursting report. The system will guarantee bursting tasks compete with normal tasks for system resources. however for bursting reports. To do this. direct running and advanced running actions support normal reports but not bursting reports. it must be scheduled. Text. There can be only one main bursting task for a sub bursting task. and then specify required parameter values in the General tab of the Schedule dialog. a bursting report has three bursting schemas: Schema 1 defines recipient E-mail and Disk. Excel. The following list tells which tab will be displayed in the Publish > Bursting Result tab of the Schedule dialog for which recipient address specified in bursting schema.Scheduling a task containing a bursting report In a large enterprise reporting deployment. Bursting reports can be distributed to e-mail or FTP addresses. to the JReport versioning system. Report bursting enables running a report once and distributing the report results to multiple recipients who each will receive a subset of the report results. On JReport Server. and PostScript. The bursting tasks can be given lower priority if desired (set queue. Sub bursting task: It is responsible for generating the report result according to split data and sending the result to the address of the bursting recipient. Scheduling a bursting report to generate bursting result Though a bursting report may have one or more bursting schemas. Recipient E-mail FTP Sub tab in the Publish tab To E-mail To FTP . and Schema 3 defines recipient JReport Server Version. or to the security system members such as users. it is important to handle both large amounts of data as well as a large number of users. select a bursting report and schemas. For a scheduled bursting task. Scheduling supports both types of reports excluding the combination of the two types: for normal reports. seven kinds of result file formats are supported: HTML. q For details about what is a bursting report and how to design a bursting report. see Report Bursting in the JReport Designer User's Guide. only one can be scheduled. XML. q Main bursting task: It is responsible for getting/splitting data and distributing work to the sub tasks. Then a tab named Bursting Result is displayed in the Publish tab and only the corresponding sub tabs are available that are defined in the selected bursting schemas' recipients in JReport Designer. you can make it generate not only the bursting result by applying bursting schemas but also the non-bursting result based on whole data without data splitting. If Schema 1 and Schema 3 are selected. For example. RTF. To Disk. PDF. Schema 2 defines recipient FTP. groups. you need apply one or more of them in order to get a bursting result. A report containing only bursting report tabs cannot be run directly. End users can submit a schedule task which contains only one bursting report to JReport Server. When a bursting task is activated. it will create a main bursting task and some sub bursting tasks. In addition.policy to 1). to disk. and roles. a warning message will be displayed asking the end user to select a normal report tab to run using advanced run. otherwise if the default focused report tab is a bursting report which cannot be run. Float.pdf. the resource name only supports up to 64-character length. For advanced running: It is allowed to only choose among the normal report tabs. only the normal report tabs are opened. connect each one by the character "_".User E-mail To E-mail When scheduling a bursting report. Converting to String When a bursting key is of one of the following data types. it will be run directly. q Scheduling a bursting report to generate non-bursting result . you are allowed to give a file name to the subset of report result instead of using the default name. However. for example: report1_USA_Maryland1.Disk JReport Server Version JReport Server User/Group/Role . Currency: Currency will be transferred to the number without the currency mark ($ or others). specifying the destination is suppressed in the Publish tab since the recipient addresses have been included in the bursting schema. Character: Same as Java. The bursting system will give it a name as generated by the system. it will be converted into String so as to make a valid result file name: q Integer. these data types are transferred to string directly.User Private Folder To Disk To Version To Version JReport Server User/Group/Role . When running it to other formats. an index will be appended to the result name. If a bursting result file name is longer than that. q q Name length In the JReport Server resource system.pdf. When running a report containing both normal and bursting report tabs: For direct running: When running it to DHTML format. In order to avoid using the same name in the same path. Date and Time: All data and time formats will be transferred to a date format: yyyy-MM-dd hh:mm: ss. report1_USA_Maryland2. if the default focused report tab is a normal report. When there are multiple bursting key columns. the system will trim it down automatically. Notes: q All bursting sub results will apply the security information of the bursting task submitter. Default name for bursting result files Sometimes you may not want to specify a file name for each bursting result when defining recipients. The default name format is: ReportName + "_" + BurstingKey + suffix (result format type). you can also generate non-bursting result for the report without applying any bursting definition. and To FTP .To Version. To E-mail. and all these sub tabs . To Disk. which is based on full data without data splitting. select the Non-bursting result option in the General tab of the Schedule dialog. Then a tab named Non-bursting Result appears in the Publish tab.Besides generating bursting result for a bursting report. To generate non-bursting result. To Fax. To Printer.are available in this tab for the non-bursting result. . . c. Set the user task class name to the property value of APIConst.ps=true&jrs. the values set to this property must be formatted to be separated with "&" character. Specify the settings in the General.TAG_TASK_CLASS.html=result_html 3. Conditions. On the JReport Console > Reports page. JReport provides a demo class APIDemoDynamicExportTask.java in <install_root>\help\server\en\samples for your reference. you can implement a customized task with the schedule properties.excel=true jrs.pdf=true&jrs. JReport has provided a task named User Task. Then. With this task. The task can then be run by the server. or by calling the JReport Server API methods. For example. and Duration tabs as required.user_task_prop is used to transfer multiple user task properties.Scheduling a customized task using User Task In order to meet the requested requirement to run tasks defined outside of JReport on JReport Server. You can find the interface in the jet. click Finish to submit the task. The b. To schedule a customized task using User Task: 1.server. Create a task class that implements the UserTask interface and add the path of the class file to the class path. the content of the properties file is: jrs. the name of the task class file you have defined that implements the UserTask interface and the task properties that define the export formats must be provided. r To submit the customized task by API methods: a. You can also submit the user task from a web page. Here the Publish tab settings should be switched to those of User Task by clicking the link on the right bottom of the tab.text=true jrs. Upon finishing. and to just use JReport Server's schedule function. b.api package available in <install_root> \help\server\en\api.html=result_html.excel=true&jrs.TAG_USER_TASK_PROP with the formats as follows: jrs. put the mouse pointer over the report row and click the Schedule button Schedule dialog is then displayed. Publish. Since the jrs. Define the user task properties with the property APIConst. browse to the desired report. on the floating toolbar. You can either input the task properties manually or import them from the task properties file that you have created. r To submit the customized task from a server web page: a. 2.rst=result_rtf&jrs.pdf=true jrs.ps=true jrs.user_task_prop= jrs.rst=result_rtf jrs. Submit the task either from a server web page or by calling Server API methods. text=true&jrs. Create a task properties file defining the formats of exporting the task. Click My Tasks on the system toolbar. see APIDemoPublishRpt. Except for the above properties. and vice versa. If you specify to schedule a report as a default task. define the other schedule properties as you do with a default task. Set a display name for the class with the property APIConst. Then following the API demo you can submit a customized task on the server.java in <install_root>\help\server\en\samples for reference. Note: You can either schedule to use the Default Task or the User Task at one time. you will not be able to schedule it as a user task. TAG_USER_TASK_DISPLAY_NAME. d. .c. When the task is being performed. you can see a record of it in the Running tab and on completion it will be put into the Completed tab. then the following tabs will be displayed: Scheduled. Click My Tasks on the system toolbar of the JReport Console page. Running. Related topics: q Managing tasks .Recording scheduled tasks JReport Server records every scheduled task. It will go to the Running table when it is running. A task is placed in the Scheduled table as soon as it is submitted by the user. it will then go to the Completed table. and Completed. The tasks are recorded in different tables according to their executing status. and when it is finished by JReport Server. 2. the scheduled results of different format types are listed in the Result column. On the JReport Console page. click My Tasks on the system toolbar. Viewing via the JReport Console page One way to view results that are scheduled to version on the JReport Console page is via the scheduled task records. locate the right task and click the name of the task in the Schedule Name column. 2. then click the Completed tab. Do either of the following: s Select the report row and click Tools > Version on the task bar of the Reports page. the links to different result formats are available for viewing in the To Version row. 3. And another way to achieve the same purpose is via the server resource tree which to some extent varies with the archive location type specified in the Publish > To Version tab: q If the archive location has been set to Built-in Version Folder: 1. In the Result Details table. To get the location information: 1. Viewing results scheduled to version To view report results that are scheduled to version. Click the format links or action buttons to view the results. 3. first of all you need to know the corresponding results' location. Select the report row. the location information of the scheduled results are available in the Details column. then click the Completed tab. which requires providing a path and a name for the scheduled result in the server resource tree: . where all the successfully scheduled tasks are recorded. you can choose whether to view via the JReport Console page or via URL. In the Report Result Versions tab. In the Result Details table. In the tab. Put the mouse pointer over the report row and click the Version button toolbar. you can view the results of the scheduled report as required. 2. To do this: 1. Click My Tasks on the system toolbar. Locate the task in the tab and click the name of the task in the Schedule Name column. q If the archive location has been set to My Reports Folder or Public Reports Folder. on the floating s s 3.Viewing scheduled report results When a scheduled task is finished. right-click in the row and select Version from the shortcut menu. On the JReport Console > Reports page. browse to the row that the original report is in. To view the results. path=/SampleReports/Banded_Link. you can also view them via URL.1. browse to the row that the result is in. you should add jrs. Using viewVersion. Using command jrs.view_ver_rst See the example: http://localhost:8888/jrserver/SampleReports/SampleReports.rst_version=10&jrs. Put the mouse pointer over the result row and click the Version button on the floating toolbar (or you can use one of the other two methods shown in the above procedure to display the version table).path=% 2fSampleReports%2fEmployeeInformation.rst&jrs.version. cls&type=drstfile&jrs.hist_file=1%5cJReport_System_User327406359%5cEmployeeInformation.cls? jrs. 2.view_ver_rst& jrs.report=/SampleReports/ Banded_Link.jsp?jrs. You can cancel the highlighting by setting the property web. you are required to provide a disk file path and file name . you can take the steps explained at the beginning of the document.is_pls_result=true in the URL.cls&type=rstfile&jrs. q If you choose Publish to Server Disk Path.view_ver_rst.properties file in <install_root>\bin. For example: http://localhost:8888/dhtmljsp/dhtml.is_pls_result=true&jrs. Viewing via URL For the report results that are scheduled to version. See details about the usage of the command jrs. for example: http://localhost:8888/dhtmljsp/dhtml. One important thing in the URL method is that you need to know the file name of the result that you want to view.path=/SampleReports/PLS.html& jrs.cat/EmployeeInformation.view_ver_def&jrs.cmd=jrs.cls q When viewing a scheduled DHTML report result with cached report bursting via URL. Click the format links or action buttons to view the results.rst_version=1&jrs.cls Notes: q To view RSD version results using JSP.jsp For example: http://localhost:8888/jinfonet/viewVersion. On the JReport Console > Reports page. rst_version=2&jrs. In the Result Versions tab.ver_suff=.report=%2fSampleReports%2fEmployeeInformation.mark_unviewed to false in the server.cls Viewing results scheduled to disk When scheduling a page report to disk. Tip: The unviewed version results are highlighted in bold. the scheduled results of different format types are listed in the Result column. result_type=1.report=/SampleReports/PLS. you should use dhtml. 3. To get this information.cls&type=rstfile&jrs.jsp instead of viewVersion.jsp.jsp?jrs.cmd=jrs.jsp? jrs. pdf r To follow the Public Reports folder. If the specified folder which is the parent folder of the result file has a real path. the generated result will be saved to <server_install_root>/jreports/. start with "/". r To follow the My Reports folder path. or FTP. fax. you can view the scheduled results if the specified addresses or locations are available to you.with correct format type as the suffix for each report tab in the report. you are required to provide a path following the server resource tree and file name with correct format type as the suffix for each report tab in the report.html. start with "/USERFOLDERPATH/admin/". . the generated result file will be saved to the real path. if the folder doesn't have a real path. printer. After scheduling succeeds. Example: /USERFOLDERPATH/admin/report1. For example. you can find the corresponding result files available at the specified location on the computer where JReport Server is installed. Viewing results scheduled to e-mail/printer/fax/FTP When a report is scheduled to e-mail. Example: /SampleReports/report2. q If you choose Publish to Server Resource Tree. which is the mapped disk path of the root node "/" in the specified path. you can click the Import old script from server link in the Import Script page to select an old script to import it to generate a scheduled task. then modify the script text in the Edit Script box as required. then select the Scheduled tab. Note: If you just updated from an older version of JReport Server. Click OK to generate a scheduled task. On the JReport Console page. Click New Schedule on the task bar of the My Tasks page. you can also right-click in the task row and select Export to Script from the shortcut menu. In order to use these old scripts. To export a scheduled task to a script file and save it in the disk: 1. 5. click My Tasks on the system toolbar. you must logon JReport Server as an administrator role. 2. On the JReport Console page. In the Scheduled tab. then click OK to import the specified script file and modify the script text in the Edit Script box as required. click My Tasks on the system toolbar. In addition. select the rows that one or more scheduled tasks are in. you can import a script file from the disk file to generate a scheduled task. on the floating . Click OK to export the specified scheduled task to a script file. Click the Browse button to select a script file from your disk file. In the New Schedule dialog. check the option Import Script to Create Schedule. 3. or put the mouse pointer over the task row and click the Export to Script button toolbar). 3. you can export a scheduled task to a script file which will then be saved on your own disk as a script file. To import a script file from your disk: 1. Specify the directory and name for this script file in the File download dialog. 4. there may be some old scripts saved in your server. Click Tools > Export to Script on the task bar of the My Tasks page (if only one task is selected. To use this link. 4. 2.Importing and exporting scheduled tasks In JReport Server. 5. in the method beforeRun or afterRun of the TaskListener class. as follows: prop. You can also define properties of your own and transmit them through ServerInfo. Print out the task and schedule properties before and after running the task. Compile TestTaskListener. add the path of the class file (c:\JReport\Server\tasklistener) to the ADDCLASSPATH variable in setenv.java to generate the class file. prop. To do this. JReport Server will stop there. "127.bat.put(APIConst. TAG_USERDEFINED_PROPERTY_PREFIX+"host_name". Develop your Java class to implement the interface. into the properties named prop. 4.put(APIConst. In this example. the corresponding methods in the listener will be invoked.api for receiving task events before or after running. Your applications will return true or false. Assuming that TestTaskListener has been saved in c:\JReport\Server\tasklistener. prop. check Add TaskListerner to be Invoked in the General tab of the Schedule dialog. You can get the value of the properties listed above through the server info object.0. Edit the batch file setenv. and then submit the task. then input the class name. While for false. In JReport Server. you will need to insert the properties. Start JReport Server and set up a schedule on a report.put(APIConst. JReport Server enables you to call your Java application before or after the process. 1. 2. 5. before calling the method runTask. host_ip and hosp_protocol.1"). The interface contains two methods: beforeRun and afterRun.java is used. You will then get task and schedule information in the command window before and after the task is run. See the example below: .bat in <install_root>\bin. TAG_USERDEFINED_PROPERTY_PREFIX+"host_protocol"+ "TCP/IP"). the class returns True.Adding TaskListener When viewing or scheduling a report. enabling you to set your Java application call before or after the process of viewing a report or setting up a schedule. Below is an example illustrating how to add TaskListener when setting up a schedule on a report. a TaskListener interface has been provided in the package jet.server. Here TestTaskListener. You can specify one Java class to implement this interface for a task event. serverInfo. TAG_USERDEFINED_PROPERTY_PREFIX+"host_ip". if you want to transmit the properties host_name. For example. "host"). which is used to start JReport Server. In this example. input TastListener. use APIConst. 3. JReport Server will go on running. which is available in <install_root>\help\server\en\samples.TAG_USERDEFINED_PROPERTY_PREFIX as the prefix for the properties. When the event of this task occurs. For true.0. TAG_USERDEFINED_ PROPERTY_PREFIX+"host_protocol"). host_ip=serverInfo. Note: All properties without the prefix APIConst.TAG_USERDEFINED_ PROPERTY_PREFIX+"host_name").get(APIConst.getTaskProperties().TAG_USERDEFINED_ PROPERTY_PREFIX+"host_ip").get(APIConst.getTaskProperties().get(APIConst.host_name=serverInfo.TAG_USERDEFINED_PROPERTY_PREFIX will be denied and discarded by JReport Server. host_protocol=serverInfo. .getTaskProperties(). getParameter(APIConst.cls".jsp Shows how to set parameters for printing the demo report CustomerAnalysis.getParameter (APIConst. In your own JSP.cls by using the ViewerApplet. and they are contained in the zip file printDemo.jsp Provides frames to load printCustomerlist.jsp.jsp.jsp.jsp using the URL http://localhost:8888/ jinfonet/printDemo. start JReport Server and access printDemo. The example JSP printCustomerlist. String cat = "/SampleReports/SampleReports. Before running the JSPs. This JSP calls printReport. q printDemo.jsp calls this JSP. Then. you should unzip and copy them to <intall_root>\public_html\jinfonet. TAG_CATALOG).jsp and printReport. printCustomerlist. q q printReport.zip in <install_root>\help\server \en\samples. The following page appears: . String rptName = "/SampleReports/CustomerAnalysis.Using JSPs to print reports JReport Server provides the following demo JSPs which enable you to print a report without any view in the client side.TAG_REPORT). //request.cat". If you want to print the other reports.jsp. you should modify the values of "cat" and "rptName".jsp Shows how to print reports by using the ViewerApplet. you can follow this JSP file as an example to write your own JSP. //request. .PrintInCurrentFrame Set to call printReport. PrintInHiddenFrame Set to call printReport.jsp and load applet of JReport Viewer Frame. Interactive If checked. Reset Reset the previous options. you could specify the print setup in the Print dialog.jsp without loading applet of JReport Viewer Frame. View View this report. After the print job is finished. . Wait If checked. UseJDK11 If checked. you have to wait until the print job is finished.Background If checked. the print job will run in the background. NotifyComplete This parameter is used with the parameter wait. a box will pop up to note you. the large page will be separated into several pages automatically. you will use instance PrintJob of JDK11 to print the report. Printer Specify the printer to implement the print job. SeparateLargePage If checked. and you could do any other work instead of keep on waiting. and save the results. JReport Viewer provides support for many features. save your report. enables you to quickly derive value from your business intelligence data. allowing you to create reports using report oriented data structures.Interactive Reports (Dynamic HTML Reports) With JReport Server. interactive information enables you to customize your view of business information. such as Filter. you can obtain report results in different formats. For the HTML format. This wide range of functionality. Sort. navigate. Search. such as HTML. and to analyze the data to glean useful business information. Drill-down.pure HTML or Dynamic HTML. This chapter covers the following topics to help you better understand how JReport Viewer makes reports interactive and how you will benefit: q JReport Viewer window elements Viewing reports in JReport Viewer General operations Ad hoc reporting DHTML based reporting Analytic reporting Applying a style Working with reports via URL Tuning JReport Viewer performance q q q q q q q q . and filter data via JReport Viewer. JReport Viewer provides a dynamic report view at the client side. extending the "life" of the report by allowing you to easily sort. JReport Viewer also supports a web design feature. any report can be made interactive. In short. Drill-to. including the ability to drill down on data. Drill-up.JReport Viewer . and Excel. and even save your custom modifications to existing reports. With JReport. Interactive information empowers you to slice and dice your business data. PDF. there are two viewing modes . to dynamically change your view of data. Navigation (TOC). You can change options which enable the results to be displayed to your requirements. Delete Report Tab Save Save As Export Page Setup Printable Version Exit Edit Undo . Exports the report result to disk or version in various formats. Shows the Printable Version dialog for you to print the current report result to a PDF/ HTML file. Close Report Tab Closes the current report tab if there is more than one report tab open in the report. toolbar. page report bar. or prompts you to close the report if there is only one report tab. TOC Browser. The options for browsing or controlling a DHTML report are as follows: Toolbar/ Menu File Button Tool Name New Page Report Tab Description Creates a new report tab to the current page report based on an existing business/report cube. This command is disabled when the last page of the current report tab does not display if Format Page on Demand in the Configure DHTML Profile > Properties > Advanced tab is selected. Resource View panel. Saves the report as a report version. and report area. Creates a new page report containing a report tab based on an existing business/ report cube. Shows the Page Properties dialog for you to specify the page layout settings for the report result. Deletes the current report tab if there is more than one report tab open in the report. Opens the Open Report Tabs dialog for you to open/close report tabs in current report. Toolbox. New Page Report Open Rename Report Opens the Rename Report Tab Tab dialog to give the open report tab a new name. Undoes the last operation. Saves a copy of the report. Closes the current report.JReport Viewer window elements The main page of JReport Viewer consists of the user information bar. menus. Redo Search View Toolbar Reverses the operation of Undo. Toolbox Shows or hides the Toolbox panel which allows you to insert a component into the report. the editing mark will not be shown when a report object receives focus. If the option is unselected. Shows the Search dialog for you to find specific text. which displays the user name. Shows or hides toolbars. If this option is enabled. and report objects cannot be moved or resized. Shows grids in the report area. Inserts a label into the report. Shows the Options dialog for you to set the skin and unit for JReport web. catalog name and report name. Snaps an object to grids when you move it by dragging and dropping in the report area. Inserts an image into the report. and to customize toolbars. Resource View TOC Browser Editing Marks Turn To Refresh Zoom Options Show Grids Snap to Grids Insert Label Image . with which you can navigate the report data. The Refresh operation fetches the data again. Provides a submenu for you to turn the report pages. Shows or hides the Resource View panel. User Shows or hides the User Information Bar Information Bar. Shows or hides the TOC Browser. press the ALT key as you move an object. Runs the report using previously provided parameters. Shows or hides editing marks (dashed outlines for objects and report body). aligning objects will be made easier. To temporarily override the setting. with which you can add cube elements to your report and create dynamic resources to use them in your report. Shows the Zoom dialog for you to set a zoom ratio for the report page. Allows you to apply dynamic formulas to control object properties. Filters the report records according to the filter criteria you specify. Converts a crosstab into a chart. Max Records Use Dynamic Formula in Property Style Help User's Guide . Inserts a crosstab into the report. Inserts a navigation control into the report. Sorts the report records or groups in ascending or descending order on the fields you select. Allows you to specify the maximum number of records retrieved by all components in the report. Inserts a table into the report. Allows you to apply a style to the report.Banded Object Table Crosstab Chart Parameter Control Parameter Form Control Filter Control Navigation Control Special Fields Report Query Filter Inserts a banded object into the report. Merge Split Merges selected tabular cells into one. Filter Sort To Chart To Crosstab Rotate Table Rotate Crosstab Rotates a crosstab to exchange the columns and rows in the crosstab in order to create a different view of the crosstab. Splits a tabular cell into the specified number of rows and columns. Inserts special fields into the report. Rotates a table to switch its appearance between the horizontal and vertical layout modes. Inserts a parameter form control into the report. Converts a chart into a crosstab. Inserts a filter control into the report. Inserts a parameter control into the report. Inserts a chart into the report. Opens JReport Viewer User's Guide. Applies a filter to the business/report cube used by certain component. Brings out the Open Report Tabs dialog for you to open/ close report tabs in current report. Shows the Sort dialog. Shows product information about JReport Web. Shows the Printable Version dialog for you to print the current report result to a PDF/ HTML file. Deletes the selected object. Saves a copy of the report. Enables you to enlarge or reduce the size of the report. Shows the Search dialog for you to find specific text. Exports the report result to disk or version in various formats. Click it again to hide the Resource View panel. with which you can filter the report records according to the filter criteria you specify. Accesses Jinfonet Technical Support. Shows the Filter dialog. Save Save As Export Printable Version Undo Redo Delete View Toolbar Toolbox Resource View Filter Sort Search Zoom Analysis Toolbar Rotate . Creates a new report tab based on an existing business/report cube. Rotates a crosstab or rotates a table. Saves the report as a report version. Undoes the last operation. with which you can add cube elements to your report and create dynamic resources to use them in your report.Jinfonet Software Home Page Technical Support About JReport Web Standard Toolbar New Report Tab Open Connects to Jinfonet Software Home Page. Shows the Toolbox panel for you to insert a component into the report. Click it again to hide the Toolbox. Shows the Resource View panel. Reverses the operation of Undo. with which you can sort the report records or groups in ascending or descending order on the fields you select. Displays the current page number. Goes to the next page. Goes to the previous page. . Center. after you perform some going or drilling actions on a report tab. Allows you to apply a style to the report.Chart Type Lists all available chart types for you to change the type of a selected chart. center or right aligned. If a report contains several reports tab. Or. Available only when a label or field is selected. Style Font format buttons Font Face. Underlined Left. the structure of the report tab will be displayed in the list in a hierarchical view. Allows you to specify the number of records retrieved by all components in the report. Available only when a label or field is selected. you can use this list to switch among the report tabs. Goes to the last page. with which you can return to any level of the report tab easily. You can also input a page number in the page box and press Enter on the keyboard to go to that page. Italic. Goes to the selected report tab or to the selected report tab level. italic or underlined style. Goes to the first page of the current report tab. Makes the selected font left. by clicking which you can get all the other toolbar commands the small window hasn't enough space for. Available only when a label or field is selected. Changes the face and size of the selected font. Font Size Bold. Right Page navigation buttons Max Records Page Number First Previous Next End Go To dropdown list Go To More Commands When the JReport Viewer window is not maximized in Interactive View mode. the button will be displayed on the toolbar. Makes the selected font in bold. Drills data to a lower dimension according to predefined hierarchies. Shows the Search dialog for you to search the report result for some text. Drill Up Drills data to a higher dimension according to predefined hierarchies. Sort Drill Down Drill To Drill to By Value Allows you to filter data based on dimensions while also obtaining a more detailed view of the data. when you create a new report in JReport Viewer. The above table only lists some typical shortcut menu items. Goes to the details of a group. Applies a filter to the business/report cube used by the specified data component. Go To Go Up Go Down Go to Detail Conditional Formatting Search Query Filter Refresh Properties Notes: q To simplify the toolbars. Enables you to obtain a different view of data by switching among dimensions. Provides submenu items for sorting records on the selected field in ascending/ descending order. Re-fetches data of the specified data component. click the Interactive View link on the toolbar. The shortcut menu contents vary with the objects you right-click. Goes up one group level to show the records of a higherlevel group. only some basic toolbar commands are displayed by default. Enables you to add conditional format to the currently selected field. Goes down one group level to show the records of a child group. However. Shows a dialog for you to define the object's properties. To access more report and analysis commands. q . you will be shown the full menu and toolbar commands. or removing the sorting. The following sections will guide you to use the shortcut menu for any object you may right-click. Goes to any group to show its record information.Shortcut Menu Filter Provides submenu items for filtering the data in a banded object/table or removing the filtering. when you run a report in JReport Viewer. Furthermore. q Viewing from the user interface Viewing by typing URLs Opening multiple reports in one session q q . you can simultaneously open multiple DHTML reports in respective windows or frames.Viewing reports in JReport Viewer You can view reports in JReport Viewer either from the user interface or from URLs. right-click in the row and select Advanced Run from the shortcut menu. Background if you want the report to run in background mode.Viewing from the user interface To view a report in JReport Viewer from the user interface. You can also specify to run DHTML reports automatically in background mode after a specified time period by setting preferences. 2. select any report tab in the report. Put the mouse pointer over the report row. On the JReport Administration page. if the report contains a large amount of data. you can also click the report name directly to run it in JReport Viewer. or choose to cancel the run. you have to remain on the report processing page. Start JReport Server and log onto the JReport Console page. on which you can choose to cancel the running of the report. and during this period. click Run > Advanced Run. 5. a dialog will prompt you to assign values to the parameters. . click the Background button. on the r r 4. The report processing page appears. Click Cancel on this page if you decide to cancel. you can choose whether to cancel the running query used by the report in the database at the same time by configuring the JdbcDriversConfig. Or on the JReport Console page. on the report processing page. then click the Advanced Run button floating toolbar. click Profile on the system toolbar. In the General tab. you need to wait several minutes before the report results are displayed. Now JReport enables you to switch running reports to background mode. For details. Select the report row. 3. then on the task bar of the Reports page. specify parameter values if any. Click Reports on the system toolbar. click Profile on the system toolbar and then select Configure DHTML Profile from the drop-down menu. Then if the report contains parameters. then browse to the folder that contains your report.properties file. or just wait for processing to complete for viewing and interacting with the report. To do this: 1. Use one of the following three methods to display the Advanced Run dialog: r Select the report row. then click the Format tab. When you cancel a report from running. then click Configure DHTML Profile on the task bar of the Profile page. or to make the report run in background mode. follow the steps below: 1. q Running a DHTML report in background mode When you run a report in DHTML format. Notes: q If you are sure that the viewing format of the last-time focused report is DHTML. refer to Canceling running query. To make a report running in DHTML to run in background mode. select DHTML from the Select Format drop-down list and click Finish. then when a report runs in DHTML format and the results have not yet been generated after the specified time. and so on. you can open it from the Background Tasks table. 3. stop. For example. running format. Click the Properties > Advanced tab. Check Background Mode Timeout and specify the time allowed for a DHTML report to run in foreground mode. such as report path and name. or restart tasks (for details. Reports running in background mode are listed in the Background Tasks table of the My Tasks page. Save the settings. you can choose to delete. . Also. When a report completes running in background. see Managing tasks in the task tables). time when the task is started/completed. 4.2. you can control the status of the reports running in background mode according to your requirements. catalog path and name. the task will automatically be removed from the table. it will be automatically switched to run in background mode. which shows detailed running information of the reports. and once the report is opened. tryView. Then it will be redirected to dhtml. cls?jrs.cat/ EmployeeInformation.catalog=/SampleReports/SampleReports.jsp.jsp.jsp This is the normal method of accessing reports using URLs. The image below illustrates the relationship between these JSPs that are used to run the DHTML reports: tryView. otherwise it will directly go to runReport.jsp when result type is set to the DHTML format. For example: q http://localhost:8888/jrdhtml/SampleReports/SampleReports. Using DHTML servlet You can call the servlet jrdhtml via URLs to run a report to the DHTML format. They are two Server JSPs.jsp and runReport.jsp?jrs. cls? http://localhost:8888/jrdhtml/SampleReports/SampleReports.report=% . If the report has parameters and the parameters provided in the URL fail to include all necessary parameters.path=/SampleReports.jsp.cls q Using JSPs You can use three JSPs to run a report to the DHTML format.jsp: http://localhost:8888/jinfonet/tryView.cat&jrs. and a DHTML JSP dhtml. or else will run to the specified format if the result type is set to other format. the Enter Parameter Values dialog will be shown for you to specify parameters.Viewing by typing URLs You can use DHTML servlet or JSPs to run a DHTML report.cat/EmployeeInformation.cmd=jrs.cat/EmployeeInformation.try_vw&jrs. The following is an example of running a report to the DHTML format using tryView. cat&jrs.report=% 2fSampleReports%2fEmployeeInformation.report=%2fSampleReports%2fEmployeeInformation.jsp If you want to include the DHTML JSPs into your own application without other server JSPs.jsp when the report has no parameter.cls&jrs. However. the report runs with the default parameters if no parameter is specified.jsp?jrs.2fSampleReports%2fEmployeeInformation. or else it runs with the parameters specified in the URL.cmd=jrs.catalog=%2fSampleReports%2fSampleReports.result_type=8 runReport.jsp?jrs.catalog=%2fSampleReports%2fSampleReports.jsp The runReport.result_type=8 dhtml. cat&jrs. cat&jrs. you can set the URL as follows: http://localhost:8888/dhtmljsp/dhtml. if you want JReport to automatically refresh the report data at certain intervals.report=/USERFOLDERPATH/admin/AutoRefresh/ autorefresh. auto_refresh_data=true&jrs. For example: http://localhost:8888/dhtmljsp/dhtml. you can use this method.jsp functions the same as tryView. See the following example: http://localhost:8888/jinfonet/runReport.jsp.cat&jrs. specify the DHTML format as the result type. When it has parameters.web_vw&jrs. To run a report to the DHTML format using runReport.cls Tip: When you run a report in DHTML using URL.cls&jrs.auto_refresh_data_time=10 .cls&jrs.catalog=/USERFOLDERPATH/admin/AutoRefresh/testauto.catalog=%2fSampleReports%2fSampleReports.jsp?jrs. you must specify the report parameter values in the URL if there are parameters used by the report. In order to illustrate how to view multiple frames in one window. Follow the steps below: 1.jsp. when working in the embedded mode. 2. This means that each time you run a DHTML report. Extract MutipleReports. Go to <install_root>\help\server\en\samples to find MultipleReports. you can assign frames to the reports. 3.zip. . a demo has been provided for you.Opening multiple reports in one session You can open multiple reports in JReport Viewer in one session. it will open in a new window. Also. Access JReport Server using http://localhost:8888/MultipleReports/test. so that more than one DHTML report can be viewed in one window at the same time.zip to <intall_root>\public_html and a folder named MultipleReports will be added in <intall_root>\public_html. General operations After having opened a report in JReport Viewer. renaming and deleting a report tab can also be accomplished by rightclicking the report tab and choosing the corresponding command from the shortcut menu. you can do the following general operations: q Managing report tabs A page report can include one or more report tabs. specify a new display name for the report tab. you can q Click the First Page button . q Turning the report pages a report tab includes more than one page. Clicking the display name of an inactive report tab will make it active. Deleting a report tab To delete a report tab. the close action will hide the active report tab. Note: A JReport Live license for JReport Server is required in order to delete report tabs. If you do not have a Live license please contact your Jinfonet Software account manager to obtain a license. The only report tab open cannot be deleted. and then click OK. In the Rename Current Report Tab dialog. first activate it. then click Menu > File > Delete Report Tab. If there are one or more report tabs open other than the active report tab. and press Enter to go to that page. a report tab can be shown or not. q . to turn between the report pages. and closing. click Menu > File > Close Report Tab . click Menu > File > Open (or the Open button on the Standard toolbar) to display the Open Report Tabs dialog. the close action will prompt you whether or not to close the report. Previous Page button . The Go To drop-down list on the toolbar panel or the tabs across the top of the report lists the display names of all the open report tabs in the current report. first activate it. you can easily activate a report tab in a report by clicking the tab representing the report tab on the report tab bar. uncheck the ones you want to close. in the case that the active report tab is the only report tab open. q Input a number into the page box q Click Menu > View > Turn To and then click the corresponding command on the submenu. or Last Page button on the View toolbar. Check the report tabs you want to open. Use the scroll bar or mouse wheel to scroll up/down the report tab. To open (show) a hidden report tab. You can manage report tabs in a page report easily as follows: r Opening and closing a report tab In a page report. r Tip: If the administrator has specified to switch report tabs using tabs in the DHTML preferences page. then click Menu > File > Rename Report Tab. Next Page button . r Renaming a report tab To rename a report tab. in which the report tabs open in the current report are marked with a check symbol. To close (hide) the active report tab. You can also do this to open an invisible toolbar. q Setting JReport Viewer options eport Viewer allows you to set the skin and customize toolbars. To load the default settings. then specify the toolbar name. To do this: 1. right-click anywhere on the toolbar area.Refreshing the report result fetch the data of the current report again. Click Menu > View > Options (or right-click anywhere on the toolbar area and select Options from the shortcut menu). Go to the Properties > Default tab. 5. set the skin of JReport Viewer user interface. select it in the Current Toolbar box. A user playing the dministrator" role may change the settings in the JReport Administration page so as to enable or disable me features. and report path and name. Tip: Administrators can make this bar open by default. q q Undoing/redoing actions or u can undo or redo some actions by clicking Menu > Edit > Undo or Redo (or the Undo button on the Standard toolbar). To delete a toolbar. 2. select it and click . and Analysis. To do this. Tip: To close a toolbar. q Showing/hiding user information e User Information bar shows the current user name. Click order of the tools on the toolbar. then on the shortcut menu. you can click Menu > View > Refresh. such as a newly-created one. JReport Viewer features available for you will be consistent with your new settings on the eport Console page. click OK to return to the Options dialog. see Configure DHTML Profile. click to show the New Toolbar Name dialog. For details. r To modify a toolbar. click Profile on the system toolbar and select Configure DHTML Profile from the drop-down menu. u can decide whether or not to enable the features which have been enabled on the JReport ministration page. Click OK to apply the settings. catalog path and name. u can click Menu > View > User Information Bar to show or hide the bar. including the skin. . and add required tools from the Available Tools box. log onto the JReport Administration page. or to adjust the r To add a toolbar. and ntrols whether the settings on the JReport Console page can be configured. and then check the User Information Bar option. r 4. that is. do button q Configuring JReport Viewer features e JReport Administration page provides default settings for you to use JReport Viewer features. and set the tools for the new toolbar. After you have made changes to JReport Viewer settings on the JReport Console page d saved them. In the Customize tab. remove those unnecessary items from the Selected Tools box. The open/close toolbar operation can also be achieved by clicking the corresponding item on the Toolbar submenu of the View menu. 3. select the item corresponding to the toolbar name. In the Option tab. namely Standard. Then you can configure JReport Viewer preferences on the JReport Console page. View. click the Restore Defaults button. and the three built-in toolbars. and the margins as required. . you can check Sort and/or Filter in this dialog save these changes with the report. In the Printable Version dialog. specify the page pe. Click Yes to save the report and close the report. or the close button of e browser window). click Menu > File > Page Setup. In case that you have modified the report without saving it. q Tuning report page magnification on the View u can zoom in or out the report page by selecting a magnification from the Zoom list olbar. If you have changed the sort and/or filter criteria. you can click Menu > Help > User's Guide to open the index page of JReport Viewer User's ide. The PDF/HTML result file will be opened in an associated program h which you can print the result to a printer. just click Menu > File > Exit (or the Exit tton which is always on the upper right corner of the JReport Viewer window. you can click the Help button in any dialog to show the help about the dialog. Closing the only report tab open will also prompt you whether or not to close the port. You can click Menu > View > Editing Marks to switch the status of the editing marks as quired. ving and resizing. To do this. q Setting up the page set up the report page. In the Page Properties dialog. By default. q Exiting the report you want to close the current report and release the resources. the editing marks are shown only when you create a new blank report in eport Viewer. q Printing the report result u can print the report result to a PDF/HTML file. specify the tings as required and then click OK. click Menu > File > Printable Version (or e Printable Version button on the Standard toolbar). q Asking for help any time.q Showing/hiding editing marks JReport Viewer. You can also click Menu > View > Zoom to show the Zoom dialog. you can use editing marks (dashed outlines of objects) for purposes such as aligning. You can o use the Help menu to open the User's Guide and access Jinfonet Software website for more information. Furthermore. JReport Viewer will prompt you to save e report. the orientation. and then specify the gnification. This section describes the following ad hoc reporting tasks: q Creating a report tab Adding report objects Applying web controls Making simple modifications to report objects Saving the report Exporting the report result q q q q q . These tasks are performed in the JReport Server environment and do not require use of JReport Designer. add new objects to an existing report. modify report objects. and save the report or report result.Ad hoc reporting Ad hoc reporting allows a business analyst or end user to create a new report. Creating a report tab In JReport Viewer. the reports created on business/report cubes in JReport Viewer cannot be edited in JReport Designer any further. click Menu > File > New Page Report Tab (or the button the Standard toolbar) to display the New Report Tab dialog. on . You can also create a new page report containing one report tab and then add report tabs to it. you can create a new report tab based on a predefined business/report cube to the current page report. In a JReport Viewer window. To create a report tab: 1. However. cat will create a new report using the embedded sample report catalog. r If Blank is selected as the layout. In the New Page Report dialog. In the Choose Report Layout box. click New Report > Report. Click OK to create the report tab. Specify the title of the report tab as required in the Report Title text box. create the page report containing a report tab as required. check the option Page Report and click Ok. you can directly create a new page report (containing a report tab) in a folder into which one or more catalogs containing some business/report cubes have been published. or Crosstab. select the required layout with which you want to create the report tab. Before you can create a report tab in JReport Viewer. 4. 3. To do this: 1. 4. on the JReport Console > Reports page. the New Page Report dialog will appear for you to create a page report with the first report tab in it. You may want to place a hyperlink directly in your application to create a new report.catalog=% 2fSampleReports%2fSampleReports. simply create a URL to your JReport Server and provide the catalog and user name. for example. On the task bar of the Reports page.If you click Menu > File > New Page Report. 2. http://localhost:8888/dhtmljsp/newreport. 2. If you select the layout as Banded. r Also. Chart. Open the folder and select the catalog for the new page report from the Catalog drop-down list. To do this. Table. the corresponding report wizard will then be displayed. a report tab which is blank will be created. In the Select Report Type dialog. Specify the settings according to your requirements. q q The following topics show in detail how to create a report tab from particular layouts: q Creating a banded report Creating a table report Creating a chart report Creating a crosstab report q q q . 3. Notes: q A JReport Live license for JReport Server is required in order to use this feature. you need to first make sure that the catalog corresponding to the current page report contains one or more business/report cubes and that the Pop-up Blocker is not enabled on your web browser. You can then use the Toolbox and the Resource View panels to add objects and cube elements to the report tab. If you do not have a Live license please contact your Jinfonet Software account manager to obtain a license.jsp?FromServer=true&jrs. Take steps 1 and 2 in Creating a report tab. In the Query Filter screen. go to the Summary screen. In the Data screen. . Select Banded as the layout and click OK to display the Banded Wizard. add the required fields from the Resources box to be displayed in the banded object. and is composed of several banded panels with which you can easily organize data fields and other elements. then add a measure object as the summary field. In the Display screen. 2. specify the filter you want to apply to the business/report cube. Click Finish to create the report. Modify the display name of any added field if necessary. To create a banded report. then specify the sorting direction of each group in the Sort column. See also Banded Wizard for details about options in the wizard. 8. this cube will be used to create the report by default. 4. 3. 9. In the Style screen. 6. To add summaries. 7. on which the banded object will be built. In the Group screen.Creating a banded report A banded object is a kind of component that can present grouped data and detailed data. 5. follow the steps below: 1. add the dimension objects as the grouping criteria. and the Data screen will be hidden from the wizard. This is the same case when there is only one style available to be applied to the report. Select the group to which the summary will be applied. apply a style to the banded object. Note: If there is only one cube in the current catalog. select the business/report cube in the current catalog. specify the filter you want to apply to the business/report cube. In the Query Filter screen. 5. 7. Take steps 1 and 2 in Creating a report tab. 9. A table is composed of row and columns. select the business/report cube in the current catalog. follow the steps below: 1. In the Style screen. With such a structure a table is a good way to show any two-dimensional dataset. Select Table as the layout and click OK to display the Table Wizard. and the Data screen will be hidden from the wizard. In the Data screen. In the Display screen. 2. then specify the sorting direction of each group in the Sort column. This is the same case when there is only one style available to be applied to the report. this cube will be used to create the report by default. See also Table Wizard for details about options in the wizard. 6. and each contains several cells. including placing fields. . Select the group to which the summary will be applied.Creating a table report Tables give you great control over how to present data. To create a table report. apply a style to the table. 4. then add a measure object as the summary field. Note: If there is only one cube in the current catalog. on which the table will be built. grouping them. 3. In the Group screen. To add summaries. add the dimension objects as the grouping criteria. Click Finish to create the report. and sorting them. add the required fields from the Resources box to be displayed in the table. 8. go to the Summary screen. Modify the display name of any added field if necessary. To replace the additional subtype. and an additional subtype will be added. or an additional value as the . c. If you want to create a combo chart. The Edit Additional Value dialog appears. To remove a subtype. DBFields. The thumbnails of the subtypes in this type will then be displayed in the Subtype box. the data of which will be displayed on the corresponding axis. select a chart type from the Chart Type box. trends. and even formulas. Take steps 1 and 2 in Creating a report tab. the chart paper. Select the required subtype to replace the default chart type. see Chart elements in the JReport Designer User's Guide. see Chart types in the JReport Designer User's Guide. 2. To add an additional value to a subtype: a. then select Constant Value/ Average Value. 5. Select the subtype in the Show Values box. specify the chart type as required. select it and click . then add a measure object data of the subtype. see How data is represented in a chart in the JReport Designer User's Guide. To replace it with another one. and labels make up the chart. For how charts present data. In the Data screen. To add more subtypes. summaries. DBFields can also be used as category names. A chart is based on the chart platform. In the Resources box. Click beside the Show Values box. b. 3. You can create a chart that contains only simple DBFields. select it. On the platform. To create a chart report. repeat the procedures. then specify the required type and subtype respectively in the Chart Type and Sub Type boxes. For details about the chart types JReport supports. Normally. groups. 4.Creating a chart report A chart organizes and graphically presents data in a way that makes it easy for end users to see comparisons. click <Add Combo Type> of Primary Axis or Secondary Axis in the Chart Type Groups box. expand the Additional Values node. select a dimension object in the Resources box and add it to the Category or Series box. follow the steps below: 1. In the Type screen. Select Chart as the layout and click OK to display the Chart Wizard. and patterns in data. For the elements that compose a chart. Select a subtype in the Show Values box. and formulas in a report are represented in a chart using chart data markers. summaries. In the Display screen. or a complicated chart that contains DBFields. It represents the report data in a visually straightforward form. select the business/report cube in the current catalog. the legend. and groups are used to produce category names and data series names. on which the chart will be built. A default chart type exists in the Chart Type Groups box. b. specify the display name for the constant/average value. or select a field based on which the average value will be calculated from the Based On drop-down list. Input the constant value with numeric type in the Value text box.d. specify in which order values on the category/ series axis will be sorted. click the Order/Select N button below the Category/Series box. f. Top or Bottom. If you want to define the sort order and Select N condition on the category/series axis of the chart. If you want to further modify a constant/average value. all category/series values will be shown in the chart. In the Name text box. the text field . In the Select N box. In the Edit Additional Value dialog. specify the Select N condition to All. To define a sort order and Select N condition on the category/series axis: a. and the defined constant/average value will be added to the subtype. Each added subtype shall have at least one measure object or additional value. 6. e. If All is selected. You can add more than one measure object or additional value to a subtype. then define the condition in the Order/Select N dialog. then click . Click OK. edit the value as required. if Top or Bottom is selected. select the value in the Show Values box. In the Order box of the Order/Select N dialog. this cube will be used to create the report by default. you can check the Other checkbox and the type a character string in the next text field. 9. so that the category/ series values beyond the first or last N range will be merged into the group with the name as that character string. Note: If there is only one cube in the current catalog. Click Finish to create the report. In the Query Filter screen. the order will be based on values of the summary field and the sort direction you specify in the drop-down lists next to the Based On checkbox. d. If you have selected Top or Bottom from the Select N drop-down list. apply a style to the chart.next to it will be enabled and you can specify an integer here. This is the same case when there is only one style available to be applied to the report. 8. 7. Check the Based On checkbox and specify values for the two drop-down lists that follow according to your requirement. the order of the first or last N category/series values will be based on what you specify in the Order box of the dialog. . and the Data screen will be hidden from the wizard. Click OK to accept the settings. In the Style screen. which means that the first or last N category/series values will be shown in the chart. specify the filter you want to apply to the business/report cube. See also Chart Wizard for details about options in the wizard. If Based On is unchecked. e. c. if you check it. 10. 2. and the Data screen will be hidden from the wizard. Click Finish to create the report. To create a crosstab report. 7. Take steps 1 and 2 in Creating a report tab. 5. Repeat this to add more group/aggregate fields. 6. edit the display names of the added group fields or aggregate fields if required. specify the filter you want to apply to the business/report cube. By default these are blank and no labels will be created. To adjust the order of the . select the business/report cube in the current catalog. Note: If there is only one cube in the current catalog. In the Query Filter screen. select a dimension object and click or to add it to the Columns or Rows box as a group field. columns and summaries when the report is displayed. 3. Select Crosstab as the layout and click OK to display the Crosstab Wizard. select a group/aggregate field and click or . These will label the rows. In the Display screen. this cube will be used to create the report by default. In the Sort column. on which the crosstab will be built. In the Display Name column. specify the sorting manner for the group fields. Select a measure object and click to add it to the Summaries box as an aggregate field. This is the same case when there is only one style available to be applied to the report. 8. In the Style screen. 9. If you want to remove any group/aggregate field. apply a style to the crosstab. In the Data screen. 4.Creating a crosstab report A crosstab summarizes data and presents the summaries in a compact row and column format. select it and click group/aggregate fields. follow the steps below: 1. See also Crosstab Wizard for details about options in the wizard. . 2. see Special fields in the JReport Designer User's Guide). then click the command corresponding to the object you want to add. If you specify to add a special field. Click Menu > Insert. special fields and web controls to the report. tables. charts. If you specify to add a banded object. Point to the destination where you want the object to be added. The following table lists the report areas that are valid targets for the various objects. tables. crosstab. see Insert Image dialog). If you specify to add an image. Report Layout Area Object Banded object Chart Crosstab Table Dimension object Detail information object Measure object Formula Label Special field Image Web control Page Header/ Footer Y Y Y Y Y Y Report Header/ Footer N Y Y Y Y Y Report Body Y Y Y Y Y Y Banded Detail Y Y Y Y Y Y Banded Page Header/ Footer Y Y Y Y Y Y Banded Header/ Footer Y Y Y Y Y Y Banded Group Header/ Footer Y Y Y Y Y Y Table Cell N N N N Y Y Tabular Cell Y Y Y Y Y Y N Y Y Y Y Y N Y N N N Y Y Y Y Y Y Y N Y Y Y Y Y N Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y N Y Y Y Y N N Y Y Y Y Y To add an object into a report: 1. tabulars. Specify the source of the image as required (for details. the Insert Image dialog will be displayed. Object placement Objects can be placed within banded objects. listed on the left. if the corresponding catalog contains business/report cubes. Specify the settings in the wizard according to your requirements (for details. banded objects. crosstabs. table. a label will be inserted there. r If you specify to add a label. and then click the mouse button. see the specific topic in Creating a report tab). r r r . the special field will be inserted there (for details about the usage of each special field. or chart. as well as onto an empty area of a report. the corresponding report wizard will be displayed. images.Adding report objects For a newly-created or an existing report. Edit the text of the label and format it according to your requirements. then you can add labels. For the usage of the navigation control. a navigation control will be inserted there. the corresponding insert control dialog will be displayed. see Applying web controls. you can also use the Toolbox panel to add objects other than special fields into a report by dragging them from the panel to the destination. If you do not have a Live license please contact your Jinfonet Software account manager to obtain a license. Note: A JReport Live license for JReport Server is required in order to use this feature. This setting can only be made by administrators. r Alternatively. However. in order to use the Toolbox panel to add components. you should make sure that this ad hoc feature is enabled in the specified DHTML feature profile. If you specify to add a navigation control. parameter form control. see Applying web controls. . or filter control.r If you specify to add a parameter control. For how to specify the settings in the dialog and the usage of the web control. Parameter controls do not support inserting cascading parameters. If you do not have a Live license please contact your Jinfonet Software account manager to obtain a license. . If you want to do this. Note: A JReport Live license for JReport Server is required in order to use this feature. r The Insert Parameter Control dialog is displayed. parameter form control. To insert a parameter control and use it to specify a parameter to a report: 1. Using parameter control to specify a parameter to a report A parameter control is a web control that is bound with a parameter used by the current report. Do either of the following: r Click Menu > Insert > Parameter Control. filter control. By specifying values to the parameter in a parameter control. Drag Parameter Control from the Toolbox panel to the destination in the report. you can pass the parameter values to JReport and run the report with the specified values. This section describes each of the web controls and how to use them.Applying web controls In JReport Viewer. these four types of web controls can be applied: parameter control. use parameter form controls instead. and navigation control. then point to the destination where you want to add the parameter control and click the mouse button. to specify a value using the calendar if the parameter is of Date. 3. r r . A parameter control will be added into the report. or DateTime type. then click OK.2. Using the calendar button Time. Select the parameter you would like to add to the parameter control. There are the following ways to specify parameter values according to the appearance of the parameter control which varies with the type and properties of the selected parameter: r Typing in the parameter values if the text field is editable. Selecting a parameter value from a drop-down list. r The Insert Parameter Form Control dialog is displayed. the parameter control will become invalid. r 4. Using parameter form control to run reports A parameter form control is a web control that is bound with the parameters used by the current report or other reports. To insert a parameter form control and use it to run report: 1. then point to the destination where you want to add the parameter form control and click the mouse button. By specifying values to the parameters in a parameter form control. Do either of the following: r Click Menu > Insert > Parameter Form Control.r Selecting or unselecting the checkbox to specify a Yes/No value. . you can make the reports run with the specified parameter values. the report will rerun with the new parameter value. Drag Parameter Form Control from the Toolbox panel to the destination in the report. Once the value in the parameter control changes. Note: If the specified parameter is no longer used in the report. Using the button to specify multiple values for the parameter in the Enter Values dialog. To run other reports. it is used to submit the parameter values you specified in the parameter form control. . you cannot finish the dialog. once you change the values of a parameter in the parameter form control. If Submit is not included. select Current Report. If all the selected reports contain no parameters. If Submit is included. the new values will be applied automatically. Specify the target reports to run using the parameter form control. r To run the current report.2. then specify the parameters used to run the report from the Select Parameters box. Specify whether to include the Submit button in the parameter form control. All the parameters used by the selected reports are displayed in the Parameter Information box. r 3. select Others. then select the reports you want to run. If there is no Submit button. specify values of the listed parameters. Do either of the following: r Click Menu > Insert > Filter Control. Click the Submit button if present to run the current report or the specified reports. the change of values in the parameter form control will trigger report rerunning. In the parameter form control. . Using filter control to filter report data A filter control is used to filter one or more data components. It lists the selected parameters for the current report or lists all parameters used by the specified reports. To insert a filter control and use it to filter report data: 1.4. Note: If you save or publish a report containing a parameter form control to another directory. in a report using the same data source. r The Insert Filter Control dialog is displayed. then point to the destination where you want to add the filter control and click the mouse button. and crosstabs. Click OK in the dialog to save the changes. the reports that you bind the parameter form control with will not be saved or published along with the report. The parameter form control is now inserted in the report. which refer to tables. charts. 5. banded objects. Drag Filter Control from the Toolbox panel to the destination in the report. 6. you can also insert a navigation control for undoing/redoing the value selection in the filter controls.2. Select the data components you want to apply the filter control to from the Apply To drop-down list. see Using navigation control to undo/redo value selection in filter controls. 3. . Specify the fields of the same type on which the filter control is based from the resource list in the Select Fields box. It lists all values of the specified fields. After inserting filter controls in the report. When done. The filter control is inserted in the report. 4. click OK. You can select one or more values to apply. For details about the usage of navigation control. q Properties Opens the Filter Control Properties dialog for editing the properties of the filter control. these options are available for managing the filter control. s Highlight All Specifies whether to highlight all matched text. Match Case Specifies whether to search for text that meets the case of the typed text. Match Whole Word Specifies whether to search for text that matches a whole word and ignore partial word matches. s s . X Closes the quick search toolbar. r r Lists the advanced options. on the title bar of the filter control to launch the q The following are details about the usage of the quick search toolbar: r Text field Type in the text you want to search for in the text field and the matched text will be highlighted among the field values. Search Displays the quick search toolbar right above the filter control which enables you to search values in the filter control.Managing a filter control After right-clicking the title bar of a filter control. You can also click outside of the quick search toolbar to achieve this. You can also click the button quick search toolbar. Clear q Cancels the selection of values in the filter control. Hide Hides the filter control. You can also use the close button on the title bar to remove the filter control. Delete Removes the filter control from the report and the filter you created with the filter control will be removed from the report too. but State values will not participate. Using navigation control to undo/redo value selection in filter controls A navigation control can be considered as an accessorial control for filter controls and is used to deal with the value selection operations in all the filter controls in the same report.r Highlights the next matched text. For example. Drag Navigation Control from the Toolbox panel to the destination in the report. q q Cascading relationship between filter controls When there are filter controls that apply to the same data components. since the selection of them will not affect the data components that the Country and City filter controls control. and when these controls' fields have cascading relationship. You select USA in the Country filter control. r Highlights the previous matched text. the cascading relationship will be revealed when you select values in the controls. In both cases all the values are selectable. This operation can be undone/redone. Country and City values will show cascading relationship. To insert a navigation control into a report. . The first two share one table while the third shares nothing with the other two. You can also use the button cancel the selection. the values in the City filter control will change as follows if the control has scroll bar: the cities belong to USA are displayed in the upper area of the filter control. there is a filter control based on the field Country. a filter control on City. In this case. and the other cities are put in the lower area and grayed out. do either of the following: q Click Menu > Insert > Navigation Control. q A navigation control is a combination of three buttons: q Back Goes back to the previous value selection status and refreshes the report data accordingly. For the case that the City filter control has no scroll bar: all the values remain their positions and the values not belonging to USA are grayed out. q on the title bar to Sort Sorts the values in the filter control in the ascending or descending order. and another on State. then point to the destination where you want to add the navigation control and click the mouse button. But the State values remain as before. q Clear Removes all the value selection histories and all the filter conditions based on the selections. q . Forward Goes forward to the next value selection status and refreshes the report data accordingly. and refreshes the report data accordingly. For a tabular. a JReport Live license for JReport Server is required in order to use all the other features introduced in this article. q Resizing an object To resize an object. Moving an object A table. you need to first make sure that the JReport Viewer window is in the Interactive View mode. What you need to do is click anywhere in the object. tabular. then drag the icon appearing at its upper left corner to the destination. For reports designed in JReport Designer. click anywhere in the object. Notes: q When resizing table rows: .Making simple modifications to report objects By virtue of JReport Viewer's powerful ad hoc functions. you can then drag the boundary to adjust the size of the related cells. you can drag the handle to resize the object. This will also resize all cells in the column or row. and the width or height of the field will change. only the objects whose Position property value is absolute. To adjust the width/height of a column/row in a table. click any value of this field to select it. For a crosstab. when the icon appears at its upper left corner. point to the boundary between two cells and the mouse pointer will become a doubleheaded arrow. click the icon to select the object. You can also do this for any label. and the DBFields or labels which have been defined as a cube element can be moved in JReport Viewer. can be easily moved to a new position. select it and move it to the new position. you can make simple modifications to report objects at runtime while viewing the report in DHTML. Point to a handle. If you do not have a Live license please contact your Jinfonet Software account manager to obtain a license. you can resize its rows and columns the same as you do with a table. Notes: q Before you can move any object in a report. For other objects. when the mouse pointer turns to a double-headed arrow. when the mouse pointer becomes a horizontal/vertical double-headed arrow. After JReport Viewer has finished processing. crosstab. To resize a panel in a banded object. then drag the right or lower resizing handle on its borders to a new position. To change the width and height of a field. banded object. drag the handle and the width/height of the column/row will change. the object will be redrawn in the new location. chart. Note: Except for showing/hiding objects. or image. select it and drag the resizing handle to the desired position. point to the right/lower boundary of the column/ row. then you will see that it is surrounded by a rectangle with three resizing handles. and these cells will be merged into one cell. If you resize the total column/row of a crosstab. banded object. chart. If it is a table. other rows/columns will not be affected. You can right-click a group header/footer panel in a banded object. other columns/rows will not be affected. q q . When resizing crosstab columns/rows: r q r If you resize the horizontal/vertical header of a crosstab. right-click the blank part of the report. To split a cell: 1. In the Split dialog. r Hiding/showing an object To hide a table. If you want to format the properties of the report. right-click on the object and select Properties from the shortcut menu. crosstab. the height of all rows in the table will be changed at the same time. However. then in the Report Properties dialog.r If you resize the table header. select the object name from the Show submenu. 2. select them one by one while holding the Ctrl key. crosstab. only the height of the header will be changed. If there are some groups in a table and the height of one group row is changed. Click OK and the cell will be split. To show a hidden object. fields. specify the settings as required. configure the properties as required. when the icon appears at its upper left corner. specify the number of rows and columns. when the icon appears at its upper left corner. To merge adjacent cells. and then select Group to show the Group Properties dialog in order to define the group properties. 3. right-click on the icon and click Properties on the shortcut menu. when you resize any row except the header. Select the cell and click Menu > Report > Split. In the corresponding properties dialog. select Report from the shortcut menu. banded object. or tabular. you can also right-click any field or cell in it and select Table from the shortcut menu to show the Table Properties dialog. For other objects such as text boxes. click on the object. q To format the properties of any object in a report. the other group rows will not be resized. For a table. or tabular. click anywhere on it. right-click the object containing it. Splitting and merging cells in a tabular Adjacent cells in a tabular which can form a rectangle may be merged into one cell. and labels. then on the shortcut menu. right-click on the icon and then select Hide from the shortcut menu. then click Menu > Report > Merge. Modifying object properties JReport Viewer allows you to modify object properties with the corresponding properties dialog. drop-down lists. right-click it and then select Hide to hide it. chart. tabular. q To delete a table. or you can drag the icon outside the report page. banded object. refer to the specific topics in JReport Viewer dialogs. Deleting an object An object can be removed from the report if it is no longer required. right-click on the icon and select Delete from the shortcut menu. Right-clicking and then selecting Delete is another way to achieve this. q . you can achieve it by simply selecting the field or label. you can drag any value of the field outside the report page to remove it. specify the settings according to your requirements. chart. You can also drag any label outside the report page to remove it. For detailed explanation about options in the properties dialogs. objects that are in a subreport cannot be deleted. then clicking the corresponding buttons on the toolbar. for example.q To set up report page properties. For a field. or image. then in the Page Properties dialog. Tip: If you just want to modify the text related properties for a field or label. Click OK in the message box so as to remove the component. click Menu > File > Page Setup. click on the object. when the icon appears at its upper left corner. However. crosstab. a message box will prompt. Then. asking for your confirmation. you want to change the text alignment or make the text bold. then click OK. The Sort and Save button Filter options in this dialog signify whether or not to include the sort and filter criteria when saving.Saving the report You can save your report in a JReport Viewer window. To do this. click Menu > File > Save (or the on the Standard toolbar). . If the report is newly created and has not yet been saved. the Save As dialog will be displayed. and the report will be saved as a report version. The Save Report Template dialog appears. Specify the options as required. enter the name of the report as required. You need to have Write access to the directory. and then click the Report Versions tab. With the criteria saved. If you want to save the report together with the sort and filter criteria. Specify the relationship between the saved report and the catalog used to run it (activated only when Select Catalog Linked Model is checked in the Profile > Configure DHTML Profile > Properties > Advanced tab): s Set Original Catalog as Linked Catalog into Saved Page Report If checked. 6. click Tools > Version on the task bar. Set Catalog Copy to Public Reports/My Reports If checked. 2. specify where the report will be saved: Public Reports or My Reports. Select a file format from the format drop-down list. a. browse to select the row that the report is in on the JReport Console > Reports page. click Menu > File > Save As (or the Save As button toolbar) to show the Save As dialog. JReport Viewer will automatically apply them to the report the next time it is opened. Click OK to save the report. 5. Notes: q on the Standard You will not be able to save the report to some locations if you do not have the required permissions. b. If one of the report tabs in a report contains subreports. From the Catalog drop-down list. s c.1. q q . Click the Advanced button to set the advanced settings for the report if required. the catalog will be copied to the directory where the report is saved and the saved report will run with the copied catalog. 3. when you save the report. changes you have made on the subreports will not be saved along with the primary report. From the Folder drop-down list. the saved report will run with the latest version of the catalog. further specify the directory in which the report will be saved. In the Report Name box. To save a copy of a report. 4. If later the catalog is updated. and then do as above. select the catalog for the report. the saved report will be linked with the catalog and the saved report will run with the catalog no matter whether the two are in the same directory. From the Directory drop-down list. To find a newly saved report version. Optionally. check Save Sort Criteria and Save Filter Criteria correspondingly. input some text in the Description box as a description for the report. . The following topics describe exporting report results in detail: q Exporting the result from a JReport Viewer window Exporting the result by using a JavaScript function Customizing buttons for one-step exporting Controlling user access to different export formats Customizing warning messages q q q q Note: If the report you are going to export is linked to another report. in the exported results.Exporting the report result When you are satisfied with the result of the active report. you may want to export it as a result version or as a local file to other formats. the link will no longer be available. . on the Standard toolbar) to display the Export 2. From the Select Report Result Format drop-down list. select the format in which to export the result: . Click Menu > File > Export (or the Export button dialog.Exporting the result from a JReport Viewer window You can export the report result from a JReport Viewer window to other formats by taking the following steps: 1. click More Options. To specify the additional setting of the selected format. or DHTML Result. In the File Name field. . see Export dialog). RTF. Save to File System: The web browser will prompt you to save the result file to a specified folder. Set the other properties for the selected format as required (for details about properties of each format. the style group property predefined for the specified export format in JReport Designer will be applied to export the report result to that format. Text. Specify the destination of the result: r Save to Version System: The result will be saved as a result version in JReport Server's versioning system.HTML. 6. If selected. Click OK to confirm. 7. 3. From the Style Group drop-down list. specify the name of the exported result file. Excel. you need to provide a name for the result file in the File Name field. r r 4. View Report Result: The result will be directly opened in the web browser if the format is supported by a plug-in of the web browser. PDF. select the style group you want to apply to the exported report result. XML. 8. otherwise it will prompt you to save the result file. If No Style is selected. PostScript. 5. type . true. Specifies whether or not to export chart in Java applet format. options) The following explains this function's two arguments.Firefox imagetype Specifies the type of the images in the result file. You can find this function in the file API. as shown below: function user_oneStepExport(type.HIDDEN 2 . Specifies whether or not to save the result to a local file. 0 .Decided by JReport 1 . Specifies the title for the HTML file.IE or Chrome 1 . Any integer between 1 and 4294967296 Any string true. q HTML = 0 PDF = 2 PS = 3 RTF = 4 TEXT = 5 EXCEL = 6 XML = 7 q q q q q q options .GIF 2 . The options and their usage are listed as follows: Key HTML to_ver to_open to_local browser Specifies whether or not to save the result to version. It is a string array whose member is of the format "key=value". type and options.Specifies the export format. 0 . false 0 .VISIBLE 1 . false true.VERFLOWCOUNT resolution title applet Specifies the HTML resolution. in detail. Specifies the web browser type.js in <server_install_root> \public_html\javascript\dhtml.JPG overflow Specifies the overflow type. false true.Specifies the values of the options of each format. Specifies whether or not to export and open the result file.Exporting the result by using a JavaScript function JReport Server provides you with a JavaScript function which allows you to open the report result or export it in a specified format. false 96 "" true 0 0 false false false 0 Description Available Value Default Value . Specifies whether or not to contain page numbers in the HTML file. false true. false file in the exported HTML file.Acrobat 5.Allows low resolutionprinting 2052 . Specifies whether or not to compress the images in the report. false Specifies whether or not to make the font size fixed true. true. false true. Specifies whether or not to export and open the result file. Any string Any string 0 . false false false false false false false false Specifies whether or not to include the drilled-down true. Specifies whether or not to contain the TOC in the exported PDF file. false true. Specifies the password for printing and editing the PDF file when encrypt=true. true. Specifies whether or not to set the mode as Standard Mode. false true. false true.css multi hyperlink pagenumber drilldown no_margin absolute PDF to_ver to_open to_local no_margin simulate standard content drilldown encrypt compress ratio compatibility Specifies whether or not to embed the cascading style sheet in the exported HTML files.Prevents users from printing the file 4 . false true.Allows high-resolution printing "" "" 0 . Specifies whether or not to remove the margin. true. true. Specifies the encryption compatibility. Specifies whether or not the mode is to be Simulated Printing Mode.0 and later doc_psw permi_pasw printing Specifies the password for opening the PDF file when encrypt=true. Specifies whether or not to remove the original margins. Specifies whether or not to contain hyperlinks in the HTML file. false true. false Any integer between 1 to 100 0 . Specifies the percentage with which to compress the images in the report. Specifies whether or not to save the result to version. false true. Specifies the PDF printing mode. false false false false false true false false false false false 20 1 Specifies whether or not to include the drilled-down true. false in the web browser. false true. Specifies whether or not to generate an HTML file for each page of the report result.Acrobat 3. Specifies whether or not to encrypt the report result.0 and later 1 . Specifies whether or not to save the result to a local file. false true. false file in the exported PDF file. false false false false false compress win_linebreak normal true. false true. false true.changes Defines which editing actions are allowed in the PDF file. Specifies whether or not to export and open the result file. false false false false false false true. Specifies whether or not to let visually impaired users read the document with window readers. false true. false false false false false true.Prevents users from making any changes to the file 1024 .Allows inserting. false true. and rotating pages 256 . Specifies whether or not to use Windows end-ofline characters. false true. Specifies whether or not to remove the margins in the PS file. 32 . false false true true. false true. Specifies whether or not to generate the report result to a standard text file.Aallows users to fill in form fields and add digital signatures and comments 40 .Allows users to do anything except extracting pages 2108 . Specifies whether or not to save the result to version. false false true true .Allows users to fill in form fields and adding digital signatures. Specifies whether or not to save the result to a local file. Specifies whether or not to replace a field value of a record with that of its previous record if the field value is null. Specifies whether or not to save the result to a local file. Specifies whether or not to apply a flow layout when exporting the report to RTF. false true. Specifies whether or not to export and open the result file. Specifies whether or not to export and open the result file. false true. Specifies whether or not to save the result to version. Specifies whether or not to remove the margins in the RTF file. Specifies whether or not to save the result to version. 0 . false true. false true. Specifies whether or not to compress the clearance between columns. Specifies whether or not to save the result to a local file.Allows all 0 enable_copy enable_access PostScript to_ver to_open to_local no_margin RTF to_version to_open to_local rtf_flow no_margin Text to_ver to_open to_local repeat Specifies whether or not to allow users to copy the file contents. true. false true. deleting. false true. false true. Specifies the page header text. false Any string Any string true. Specifies whether or not to save the result to a local file. "hyperlink=true". and omit those keys where you want to use the default value. Specifies whether or not to save the result to version. Specifies whether or not to contain all headers and footers in the report. false true.All Disabled 2 . false true. JReport will only accept the first true and treat the rest as false. that is. If you set all three to false. You can arrange the members in any order. Specifies whether or not to export the result in Excel 2000 format. Specifies the user-defined character height. false true.quote_mark head_foot delimiter width height Excel to_ver to_open to_local wrap Specifies whether or not to mark the fields in the exported file with quotation marks. you can define a variable html_options: var html_options = ["imagetype=1". to_open. For example. Specifies whether or not to only contain the database column information in the exported XML file. Specifies the user-defined character width. false 0 . false true. false Any single character An integer An integer true. Notes: q The three options to_ver. In the string array options. Specifies whether or not to save the result to version. Specifies the delimiter. Specifies whether or not to include the shapes in the exported file. false true. and the rest false. JReport will consider to_open as true. Specifies the name of an existing schema file with its full path with which to generate the XML file. false true."). Specifies whether or not to print gridlines when printing the exported Excel file. false true. Specifies whether or not to apply the advanced options. false true. false true false false false false true. only one of them should be true. false true.All Enabled false true false false false 0 new_layout shapes excel_2000 advanced header footer gridline XML to_ver to_open to_local only_data Specifies whether or not to use the new layout mode. Specifies the page footer text. true. false false false false false schema An existing schema file with its full path. If you set two or three of them to true. and to_local are mutually exclusive. true. Specifies the word-wrap setting. the members are separated by commas (".All Keep Existing 1 . "resolution=120". q . Specifies whether or not to export and open the result file. Specifies whether or not to save the result to a local file. Specifies whether or not to export and open the result file. q JReport also provides the function user_downloadReport(type. . options) whose usage is similar to user_oneStepExport. you can use user_oneStepExport(0. Then. "title=hello world"]. html_options) to obtain a URL for exporting the report result in HTML format."no_margin=false". which can be retrieved by obDHTMLUtil. Use the following two API functions to control the buttons: q public void customizeToolbar(String SessionId.show. int[] buttonId).whether or not to show the buttons defined with buttonID[].TOOLBAR_EXPORTTOHTML DHTMLConstant. int[] buttonId. String RptSetId.session ID.BTN_EXPORT_TO_RTF} The array elements available for one-step exporting are: r q q q DHTMLConstant. the buttons are invisible on the toolbar area.getRptSetId(request). For example: int[] mybuttonid ={DHTMLConstant. buttonId[] . before //<!-. such as "Standard". It is an integer array.Customizing buttons for one-step exporting Seven buttons are provided for one-step exporting. toolbarname .TOOLBAR_EXPORTTOPDF DHTMLConstant.TOOLBAR_EXPORTTOTEXT DHTMLConstant. TOOLBAR_EXPORTTOXLS. Export to PS. Add the code int[] temparray = {DHTMLConstant. 2. Export to Text. "Export".TOOLBAR_EXPORTTOHTML}. "Analysis".customizeToolbar(SessionID.TOOLBAR_EXPORTTOXLS DHTMLConstant.getSessionID(request).toolbar button ID. DHTMLConstant. RptSetId .toolbar name. RptSetId. then: 1. "View". By default. This parameter can be absent. Export to RTF. String toolbarname.Tool Bar --> . temparray. so you need define an integer array variant. if you want to add the Export to HTML button to the Export toolbar. Export to HTML. String toolbarname. dhtmlConfig. Export to Excel.jsp file in <install_root>\public_html\dhtmljsp. TMLConstant.TOOLBAR_EXPORTTOPS DHTMLConstant. and then the value is true.hide. true -. false -. and Export to XML. which can be retrieved by DHTMLUtil. You have to add them to the toolbar area by modifying the index.report ID. String RptSetId. Open the file index. q Explanation of these parameters: q SessionId .TOOLBAR_EXPORTTORTF DHTMLConstant. or user-defined ones.TOOLBAR_EXPORTTOPDF. boolean isVisible). true). They are Export to PDF.jsp. For example. public void customizeToolbar(String SessionId.TOOLBAR_EXPORTTOXML r r r r r r q isVisible . customizeToolbar(SessionID. before //<!-. and you will see a new button Export to HTML is displayed on the Export toolbar. temparray. RptSetId. adding Export to HTML and Export to PDF buttons to the Export toolbar: 1. Start JReport Server. TOOLBAR_EXPORTTOPDF}. Click the added button on the toolbar of the report page. Start JReport Server. the report will be exported to the corresponding format. 4. true). and you will see the buttons Export to HTML and Export to PDF are displayed on the Export toolbar.isFeatureEnabled(SessionID. RptSetId. 5. FEATURE_TOOLBAR)){ 3. Open the file index.if(dhtmlConfig. for example. DHTMLConstant. RptSetId.TOOLBAR_EXPORTTOHTML.Tool Bar --> if(dhtmlConfig. 2. . FEATURE_TOOLBAR)){ 3. DHTMLConstant. 4. using the default values of the format options. DHTMLConstant. dhtmlConfig. Run a report in the DHTML format.jsp. Run a report in the DHTML format. "Export". To add more than one button to the toolbar area.isFeatureEnabled(SessionID. Add the code int[] temparray = {DHTMLConstant. -2} to enableTypes. That is the global variable enableTypes in both customize_panel. EXCEL.2. Example Assume that there are two users.getUserName(request).equalsIgnoreCase("user2")) enableTypes=new int[]{4.5} will work.Controlling user access to different export formats JReport introduces an access control ability which can restrict different users to export report result to different formats. values will be ignored. XML formats can be in use. 9 and -2 will be ignored and {1. but if you do so. Or you can also use the integers which are not mentioned above. While user2 can export the report result as RTF and XML formats when logging on.jsp file: int[] enableTypes=null. if(UserName. and do not function. if you pass the array {1. To realize it. The value of enableTypes should be Integer. he can only export the report result as PDF and HTML formats. you can use the following codes in customize_panel. Value 0 1 2 3 4 5 6 You can specify a value or an array to enableTypes using the integers in the above table. so PDF.2.equalsIgnoreCase("user1")) enableTypes=new int[]{1.9. run a DHTML report.5.jsp or save_result. UserName=DHTMLUtil. When user1 logs on. if(UserName. the Int. String UserName=null. How to realize the access control ability You can restrict the report result formats for users by passing values to a variable. . and JReport gives you the following integers to represent the corresponding report result types: Report Result Format HTML PDF Excel Text RTF XML PostScript Int.jsp files in <install_root> \public_html\dhtmljsp folder.5}.jsp and save_result. user1 and user2. That is to say.0}. 5. and click OK. when you need to export the report result as XML. So. With this function. Open the customize_panel. String customMsgForXML ="This is "+browserName. click Menu > File > Export to display the Export dialog. Specify the value of customMsgForXML in the save_result. Run a report in JReport Viewer. A warning message shows as you have defined. the following is another way to create custom warning messages: 1. 3. Method 2 You can also export the report result via the Export panel instead of clicking Menu > File > Export. you can specify what you want to show as a warning message. Select XML from the Select Report Result Format drop-down list. 4. then click OK. 2.Customizing warning messages You can customize the warning messages when exporting the report result to XML through JReport Viewer. then click OK. 3.jsp to whatever you want. Run a report in JReport Viewer. 6. 2. modify other properties as required. and if necessary. 4. Specify the value of customMsgForXML in customize_panel. and if you want to show "This is IE Browser" while browser is IE. select XML from the Select Report Result Format drop-down list in the Export panel. Open the save_result. modify other properties as required.jsp file in the <install_root>\public_html\dhtmljsp folder with your favorite editor. By default. The value cannot be "" or null. Then a pop-up box will show you "This is IE . The custom warning messages are supported across web browsers. To customize the warning messages.jsp file in the <install_root>\public_html\dhtmljsp folder with your favorite editor. Set the class of panelDIV to visibleMargin to show the Export panel on web browser. and the Export panel together with the report shows. A warning message shows as you have defined. and if necessary.jsp file to visibleMargin as follows: <div id="<%=DHTMLConstant. using method2.DHTML_PREFIX%>panelDIV" class="visibleMargin"> And then customize CustomMsgForXML in the same jsp file as follows: String browserName=request.jsp. Select XML from the Select Report Result Format drop-down list. For example. 5. you need to customize the jsp files using either of the following two methods: Method 1 1.getHeader("User-Agent"). the panel is hidden. Access JReport Server via IE. run a report in JReport Viewer. you need to set panelDIV in customize_panel. .Browser". DHTML based reporting DHTML based reporting enables enterprise-wide information delivery. organizations can harness the power of the Internet. giving users across the enterprise the ability to access and generate reports from their own web browsers. With JReport Viewer. The DHTML based reporting function of JReport empowers you to perform the following operations: q Filtering report data Sorting report data Searching for text in a report q q . using filter controls. You can set a series of conditions and apply them to a DHTML server to filter the data buffer and reproduce the report result. There are these methods you can use to set the filter conditions: using the Filter dialog. or the Filter button on the Analysis toolbar to show the Filter dialog. and using labels. Click Menu > Report > Filter. . data is cached in a data buffer. Using the Filter dialog To set the filtering conditions using the Filter dialog: 1.Filtering report data In JReport Viewer. using the shortcut menu. and crosstabs. c. or select one or more values from the drop-down list. then define the expression as required. on its left. There are the basic and advanced modes of the dialog for you to define either simple or complex filter expressions. From the field drop-down list. From the operator drop-down list. Then. banded objects. charts. Define the filter as required. OR. Switch the dialog to the advanced mode. s To add a condition line of the AND relationship with the current line. Make sure the dialog is in the basic mode. then the selected conditions will be added in one group and work as one line of filter expression. From the operator drop-down list. r To define a filter using simple expressions: a. To adjust the priority of a condition line or a group. f. select the field on which the filter will be based. Type the values of how to filter the field in the value text box. The logic can be AND. d. click the Add Condition button and define the expression as required. . It is the equivalent of adding parenthesis in a logic expression. Using filter controls A filter control is a web control used to filter one or more data containers. select AND. set the operator with which to compose the filter expression. To delete a condition line or a group. select OR. For details. s Repeat this to add more filter expressions if required. then define the expression as required. which refer to tables. If you want to add another condition line. b. To add another condition line. or OR NOT. click r To define a filter using complex expressions: a. from the logic operator drop-down list. 3. select the field on which the filter will be based. e. 4. Type the values of how to filter the field in the value text box. c. select it and click Ungroup. To add a condition line of the OR relationship with the current line. set the operator with which to compose the filter expression. in a report using the same data source. select them and click the Group button. To take any condition or group in a group out. Select the component on which the filtering will be based from the Apply to drop-down list. select it and click the Up or Down button. select it and click the Delete button. or select one or more values from the drop-down list. From the field drop-down list. Conditions and groups together can be further grouped. e. To delete a condition line. To group some conditions.2. Click OK to make the filter take effect and return to the report. AND NOT. click the logic button until you get the required logic to specify the relationship between the two filter expressions. b. d. A filter control can do filtering based on one field. see Using filter control to filter report data. Repeat the above steps to add more filter expressions if necessary. then only the records with the field value equal to one of the last three field values will be displayed. see Setting filter options for a field in the JReport Designer User's Guide. you may notice that the corresponding filter expressions q q . 2. all the items (Remove Filter. For details. q Field values "Field values" is not the name for a command on the Filter submenu. Top N. you should set the field's Filter Options property when designing the report in JReport Designer. When using the shortcut menu for a field value or label to filter. Top N Shows the Top N dialog with which you can filter data to display records that meet the Top N condition. More This command is enabled if the Filter submenu cannot list all field values. To do this. Selecting any field value listed here will make the banded object or table only display records with the field value equal to the selected one. which contains All. Custom Filter. For filtering the data using shortcut menu or labels. This feature needs to be enabled at report design time. then right-click to show the shortcut menu. provided you have set its Bind Column property value to a field. and you can find that a button Filter list. Set the field by which you want to filter records as the value of the label's Bind Column property. the button will be affixed with a check mark. Notes: q You can also filter records by using the shortcut menu for a label in the same way as for a field value. 3. You can select one value in this dialog and apply the setting. and More) will be showed by default. in which the All item can help you remove the filters on the field. Top N. the field values. and you can still click it to show the Filter list. if you input 3 in the Top N dialog for a certain field. and then set its Filterable property to true. but represents some items which are the values of the field you have right-clicked. After applying a filter on the field decided by the Bind Column property. For example. q Using labels You can also use a label to control the filter condition in a banded object or table. 1. after which the banded object or table will only display records with the field value equal to that value. select a label in a banded object/table. Clicking this item will remove all filters on this field. then click the corresponding item to filter the records. is beside the label. q q Bottom N Shows the Bottom N dialog with which you can filter data to display records that meet the Bottom N condition. clicking it will show the Select Values dialog. You will see the Filter item which provides a submenu containing the following commands: q Remove Filter This command is enabled after you have applied filtering on the field to the banded object or table. In JReport Designer. Bottom N. Bottom N. For example. Save the report and publish it to JReport Server. If you want to disable some of the items.Using the shortcut menu You can also use filter-related commands on the shortcut menu to filter the data in a banded object or table. Click it to show the 4. When it is enabled. if you input 3 in the Bottom N dialog for a certain field. then only the records with the field value equal to one of the first three field values will be displayed. Run the report in JReport Viewer. point to any value of the field by which you want to filter data. and More (if there are too many distinct values for the field). see Customizing the field display names in the JReport Designer User's Guide. q JReport allows you to define the display names for fields to be shown in the Filter dialog. For detailed information.will appear in the Filter dialog if you open this dialog. . and the groups in a certain group level of the banded object or table if you have defined one or more group levels. Using the Sort dialog To set the sort conditions in the Sort dialog: 1. q You can achieve the above by using the Sort dialog. on the Analysis toolbar) to bring up the . or labels. The sorting scope is the group level. you should put the cube element into a banded object or table and make the data of the cube element inherit from the banded object or table.Sorting report data You can sort the records in a banded object or table. shortcut menu. Sorting groups at a group level: Changing the order of groups at the specified group level. If you want the data of other types of cube elements to be sorted. that is. The sorting scope is the whole banded object or table. Click Menu > Report > Sort (or the Sort button Sort dialog. or in each group if there exists one or more group levels. q Sorting records: Changing the order of records in the whole banded object or table. the groups will be sorted by value of the first record in each group on the related field. 1.2. and then right-click. Choose the command Sort > Ascend or Sort > Descend from the shortcut menu. select the field on which to sort the data. and no sort. Using the shortcut menu To sort data on a certain field using shortcut menu: 1. click Sort > No Sort. you may notice that the corresponding sort q q . and you can click beside the label to sort the data. the order of groups in the group level represented by the group field will be rearranged. 2. then set the sort order to Ascend or Descend. If what you right-click in Step 1 is a detail field value. Point to any value of a detail field or group field by which to sort the data in the banded object/ table. 5. If you select a banded object/table in Step 2. and then set the Sortable property of the label to true. If what you select in the Sort in Scope drop-down list is a group field. Using labels You can use a label to control the sorting order for a certain field. This feature needs to be enabled at report design time. then only one sort condition can be composed. and you can further click it to switch the sorting direction among ascend. 3. From the Sort in Scope drop-down list. To remove the sort condition on a field. 4. select a label in a banded object/table. select a banded object/table or a group field on which the sort condition will be based. if it is a group field value. You can also conduct sorting by using the shortcut menu for a label in the same way as for a field value. you can click to add a new row of sorting condition if required. Notes: q You cannot sort the data by a global type formula. the sorting will affect the order of detail records in the banded object or table. From the field drop-down list. This button will change after you have clicked it. provided you have set its Bind Column property. For sorting the data using shortcut menu or labels. In JReport Designer. click the Reset button. Run the report in JReport Viewer. 2. Click OK to accept the settings and to reload the result. Click or to move a row up or down so as to set the sorting priority. to delete the corresponding sorting condition if it is unwanted. To retrieve the opening status of this dialog. Set the field by which you want to sort records as the value of the label's Bind Column property. 4. Save the report and publish it to JReport Server. descend. 3. see Customizing the field display names in the JReport Designer User's Guide. JReport allows you to define display names for fields to be showed in the Sort dialog. q If you use the shortcut menu to sort the report data by a field and then sort by another field. You can right-click an object in a banded object and select the Reset item from the shortcut menu to reproduce the data of the banded object using the data cached in the data buffer. This will clear all sort and filter conditions except for those predefined in JReport Designer. q q q .expressions will appear in the Sort dialog if you open this dialog. Administrators can customize the buffer size for sorting of each report in the Configuration page of JReport Server so as to improve performance. the later sort condition will replace the former one. For detailed information. Select the field from the Select Field drop-down list. on the Standard To show this dialog. whether or not to . Set the range with which to search for the value from the Value Range drop-down list. whether or not to match whole word. Make sure the Search in Whole Report option in the Search dialog is NOT checked. 3.Searching for text in a report You can use the Search dialog to find text in the values of a certain field or in the whole report content. Select the field value you want to search for from the Value drop-down list. in which case. q Specify whether or not to match case. Note: If All is selected in the Value Range drop-down list. click the Search button toolbar. or right-click a field value or label (or object such as text box) and click Search on the shortcut menu. q To find text in the values of a particular field: 1. 4. JReport will search for all the values of the selected field. 2. click Menu > Edit > Search. when you submit the search. the only item in the Value dropdown list will be All and you cannot change the value. JReport allows you to define display names for fields to be shown in the Search dialog. q Click the Search button. In the Search dialog. q q q . Click the Search button. uncheck the option and submit the search again. or refresh the report. Set the other options such as the searching direction. 4. q Notes: q Finding text in the values of a particular field is not supported on crosstabs and charts. If you have not selected the Search in Whole Report option. check the Search in Whole Report checkbox. 3.highlight all the matching values and the searching direction. you will not be able to search special fields for strings. 2. to clear the highlighting in the search result. Type the string you want to search for in the Value box. see Customizing the field display names in the JReport Designer User's Guide. If you check Highlight All in the Search dialog. To find text in the report content: 1. For detailed information. drilling it. JReport Viewer facilitates data analysis. However. . These cubes contain the underlying data structure which makes data analysis possible.Analytic reporting JReport Viewer provides you with a convenient and powerful tool to analyze your business information. This view shields end users from having to understand database connectivity and SQL syntax while allowing IT professionals to maintain control of business data and to ensure its integrity. Through a user-friendly web GUI. drilled. For the former. and viewed in detail. if you want to do analytic actions in JReport Viewer. JReport Viewer will need to convert its fields to cube elements (for details. the data fields will be automatically converted to cube elements when the report is opened in JReport Viewer. JReport Viewer dynamically builds SQL statements to retrieve data and automatically generate multidimensional data cubes. report contents can be easily navigated. Using the Resource View panel. see Converting query-based components to report cube-based in the JReport Designer User's Guide). The following topics describe the analytic reporting features: q An introduction to business/report cubes Applying filters to business/report cubes Using cube elements Using dynamic resources Drilling through the report data Manipulating data components Adding conditional formats to fields Converting between components Navigating through the report data q q q q q q q q Note: A component created in JReport Designer is based on a dataset. while that created in JReport Viewer is based on a business/report cube. When conversion conditions are fulfilled. such as adding a cube element. JReport Viewer uses the Resource View panel to provide a business-oriented view of databases. or changing chart definition.allowing you to define your view of data to make it more useful. JReport Viewer enhances the utility of production reports by making them interactive . you will be prompted with the Convert Data Fields dialog to confirm the conversion. when you perform analytic actions in JReport Viewer. if the report tab level property Automatic Cube Initialization has been set to true when the report is designed in JReport Designer. By providing secure web access to business data and making the data interactive. converting the component type. It can be inserted as a column or row field in a crosstab. A measure object can be inserted wherever a summary can be inserted. measure objects. or as a group field or detail field in a banded object or a table. contains database connections and relationships between cube elements. it can be inserted into the group header or footer panel in a table or banded object. Categories are only for categorizing cube elements. see Business/Report Cubes in the JReport Designer User's Guide. and detail information objects). They characteristically return text or date values. while presenting end users with an intuitive view of the underlying data structures. The icon indicates that an object is a measure object. For instance. A dimension object can be inserted wherever a group field can be inserted into. q Category objects Category objects contain a collection of cube elements. q Detail Information objects indicates that an object is a Detail Information objects provide additional information. To make use of a business/report cube. or into a crosstab as an aggregate field. the icon indicates that an object is a category. In the Resource View panel. JReport Viewer will calculate the summary values based on the group level the measure object has been inserted into.An introduction to business/report cubes A business/report cube. The category is often used for indicating the name of the underlying DBMS table. A business/report cube may contain more than one category. the icon indicates that an object is a dimension object. and enables them to build reports and analyze data based on a set of cube elements they can understand. q q Measure objects Measure objects are numeric cube elements that are calculated dynamically at run time. For example. You can insert these cube elements or remove them to change the report result when you view reports in DHTML format. you need to first define it at report design time in JReport Designer. or displayed as category/series field in a chart. In the Resource View panel. A business/report cube may contain category objects and cube elements (dimension objects. It can be inserted wherever a DBField can be inserted. The business/report cube shields report end users from having to understand the physical structure of a data source. which is needed for creating multidimensional data cubes. The icon detail information object. A measure object can also be used as a detail field in a banded object or table although it will display the same aggregate value for every detail line. and they cannot be inserted into a report. It also enables IT professionals to maintain control of the business data and ensure its integrity. . Dimension objects Dimension objects are cube elements that will become the basis for analysis in a report. you can insert a detail information object into a table or banded object as a detail field. For additional information. 2. select the required business/report cube for the report. and user defined filters are created on business/report cubes while they are used in JReport Viewer. In a JReport Viewer window. or Chart from the Toolbox panel to the destination. Table or Chart and then click OK. Filters for business/report cubes are defined into two categories in JReport Viewer: predefined filters and user defined filters. you can choose to apply some filter to the specified business/ report cube to narrow down the data scope of the business/report cube. select User Defined from the Query Filter drop-down list. Click the Query Filter screen. then define the filter according to your requirements. and then click the mouse button. click Menu > File > New Page Report to display the New Page Report dialog. predefined filters are defined on business/report cubes in advance in JReport Designer. In the corresponding report wizard. so that your report will get data that meets the filter condition only. Filters can be applied to business/report cubes in JReport Viewer in the following ways: Applying a filter to a business/report cube while creating a report 1. The edited filter will then be saved as a user defined filter to the business/report cube. click the Edit button and then redefine the filter as required. 3. do either of the following: r Click Menu > Insert > Banded Object/Table/Crosstab/Chart. See Filtering report data for details about how to define a filter. and the fields you want to display in the report. If you want to further edit the filter.Applying filters to business/report cubes When creating reports in JReport Viewer. Table. point to the destination. In the corresponding report wizard. Applying a filter to a business/report cube while inserting a data component 1. All the predefined filters of the selected business/report cube are listed in the Query Filter dropdown list. There are the basic and advanced modes of the screen for you to define either simple or complex filter expressions. r 2. If you prefer to define a filter on your own. Specify the title of the report as required in the Report Title text box. and the fields you want to display in the component. select the layout as Banded. As the name suggests. . Choose the one you want to apply. 6. In the Choose Report Layout box. In a JReport Viewer window. 4. Crosstab. Crosstab. Click Finish in the report wizard and the specified filter will be applied to the business/report cube. select the required business/report cube for the component. Drag Banded Object. 5. In the Query Filter screen. In JReport Viewer. Business/report cube filters are defined on the component level in JReport Viewer. select the filter you want to apply to the business/report cube used by the component. 4. or define a filter according to your requirement. Select the component in a report which was created on a business/report cube by clicking anywhere in it. which means each time you create a component. you cannot edit the predefined filters that have been created on a business/report cube at the Designer side. If you do not have a Live license please contact your Jinfonet Software account manager to obtain a license. 2. specify the filter you want to apply to the business/report cube from the Query Filter drop-down list. Notes: q A JReport Live license for JReport Server is required in order to use this feature. 4. Click Finish to create the component and the specified filter will be applied to the business/report cube. Applying a filter to a business/report cube after a report is built 1. you can apply a filter to the business/report cube it applies to and it will not affect other components based on the same business/report cube. and then clicking the icon at the upper left corner of the component. or define a filter according to your requirement. You can just edit the condition based on a predefined filter and then the edited filter will be saved as a user defined filter. q q . Click OK to apply the filter to the business/report cube. From the Query Filter drop-down list. Click Menu > Report > Query Filter. or right-click the component and select Query Filter from the shortcut menu to display the Query Filter dialog.3. 3. Territory. Category. Total Cost is Sum on Cost. Quantity. Order Date. and Discount. CustomerCityStateZip. Product ID. provided that the data objects used by the component can be converted to corresponding cube elements (see the note in Analytic reporting for details). eleven detail information objects (Address 1. You can use the search bar at the top of the panel to search for any desired resource in a fast and convenient way. Region. Sales Month.Using cube elements After a report has been built and published to JReport Server. In JReport Viewer. click Menu > View > Resource View or the Resource View button on the View toolbar. and applies the ClassicBlue style. Tip: To display the Resource View panel. and Total Quantity is Sum on Quantity. Discount. The report cube contains thirteen dimension objects (City. Cost. table or crosstab) in the report. which shows the fields Product ID. Total calculates the value of the formula ("Unit Price" * Quantity . Sales Quarter. Customer Name. Total Sales defines an aggregate function Sum on the formula Total. Country. These examples are based on the WorldWideSalesRC report cube in Data Source 1 of the SampleReports catalog. Unit Price. Country. Customer Name. Total Quantity. Total. and Total Sales). you can open it in JReport Viewer and use the Resource View panel to analyze data of the report by dragging cube elements from the panel to the component (banded object. Quantity. The following examples show how to analyze reports using cube elements. State. and three measure objects (Total Cost. . Phone. Product Name. q Example 1: Analyzing a banded report Example 2: Analyzing a crosstab report Example 3: Analyzing a table report q q Example 1: Analyzing a banded report 1. and Product Type). and Unite Price). Sales Year."Unit Price" * Quantity * Discount/100). Product Name. Country. design a banded report titled Sales in China on WorldWideSalesRC. Click the Filter button on the Analysis toolbar.First. we will add the Total field to the banded object and group by the City field. Now the report shows as follows: Next. . Click the Resource View button shown in the panel. As the banded header panel holds no data. 2. we will apply a filter to the banded object to narrow down data scope. From the Resource View panel. on the View toolbar. drag the detail information object Total in the Orders Detail category to the detail panel of the banded object. 4. 3. we can hide it by right-clicking it and selecting Hide from the shortcut menu. 5. then resources of the report cube the banded object uses will be 6. define the filter as COUNTRY = 'China'. Right-click any of the Product Name values and select Sort > Ascend from the shortcut menu. We want to further sort the banded object by Product Name ascending. In the Filter dialog. . Drag the dimension object City in the Customers category to the banded page header panel. We can now analyze the data in various ways. if we want to see the sales by category instead of city. 9. drag the measure object Total Sales in the Orders Detail category to the group footer panel. For example. 8. when a blue line appears. release the mouse button.7. right-click on any of the City fields and select Drill To > Category from the shortcut menu. Finally. then we can see the same report with an entirely different view of the data. . Apply the ClassicBlue style to the crosstab. and we can see that the crosstab no longer contains the Product Type information. 2. and display the total sales of each product category in each region. Drag the dimension object Region in the Customers category from the Resource View panel to the crosstab until a blue line appears indicating the group level of the dimension.Example 2: Analyzing a crosstab report 1. Category (Ascend) as the row field. 3. on the View toolbar. then dragging it outside the report page. and Total Cost as the aggregate field. Click the Resource View button in the panel. Design a crosstab report on WorldWideSalesRC showing product sales information with Product Type (Ascend) as the column field. Remove Product Type from the crosstab by pointing to the header Product Type (Decaf or Regular). Click OK to confirm. we want to replace the product type information with region information. First. then resources of the report cube the crosstab uses will be shown 4. A message box will prompt you whether or not to remove the field. Click in the EMEA header and we will drill down to the next lower level based on the hierarchy defined in the report cube which in this case is Territory.5. . 6. Then we would like to see the territory information for the EMEA region. Now the total sales of each product category in each region is displayed. Drag the measure object Total Sales in the Orders Detail category to the aggregate area of the crosstab. we can insert a column (or row for horizontal table) at a specific position. Product Name. Add a filter COUNTRY = 'China' AND PRODUCT TYPE = 'Decaf' to the table (see Example 1 for details on filtering). 3. which shows the fields Product Type. Design a table report on WorldWideSalesRC. Quantity and Discount. JReport Viewer provides some analysis methods specific for tables. 2.Using the same way. refer to Automatic drilling. Example 3: Analyzing a table report For a table. Furthermore. then resources of the report cube the table uses will be shown in 4. then the city levels which have been defined in the hierarchy to get detailed sales information in each city. you can analyze its data in the same way as for a banded object. So next. The table displays as follows: For a table. Click the Resource View button the panel. For more details about drilling. Drag City in the Customers category from the Resource View panel to the boundary between the first column (Product Type) and the second column (Country) in the table until a blue line appears. 1. we will insert the dimension object City into the table. we can further drill down to the country. . and applies the ClassicBlue style. Country. on the View toolbar. Unit Price. Note: When you add a column to a table. . Drag the detail information object Total in the Orders Detail category to the header Product Name until the label Product Name is highlighted in a blue background. Click Yes in the message box to have the page size adjusted. Next. If you do not want to display the message in future. This can be done with a single drag-anddrop. 5. if the width of the table exceeds the defined page size. or uncheck Always Prompt Whether to Adjust Page Size Automatically in the Profile > Configure DHTML Profile > Properties > Default Properties tab. when the table width exceeds the defined page size. If you choose not to show the message box again. the total value for each record will be generated.The report result will be regenerated. check Don't prompt the message again in the message box. Also. or No to make the columns in the table compressed. Now. JReport will always adjust the page size automatically. we want to show the total information and remove the product name information. you will be prompted whether to allow JReport to adjust the page size automatically so as to place the column. As a table column can contain more than one field. the title for the added field will not be automatically created. At last. next.76 is the sum of all total values. Here 182. . Drag the label Total to the right of the Discount column. we will add the measure object Total Sales to the Total column. 6. release the mouse button. 7. The report result will be regenerated. when a blue line appears along the right boundary of the Discount column.298. Drag Total Sales from the Resource View panel to any value in the Total column. we want to change the order of the Total and Discount columns in the table. In this way. the records will be fetched based on the query which contains the report cube in JReport Designer. you should make sure that this ad hoc feature is enabled in the specified DHTML feature profile. To use the Resource View panel so as to add cube elements to the report.We can see that order of the columns changes. When you are using a report cube. If you do not have a Live license please contact your Jinfonet Software account manager to obtain a license. there is no predefined query and you will fetch records from the data source using dynamic SQL. while for a business cube. q q . Notes: q A JReport Live license for JReport Server is required in order to use this feature. This setting can only be made by administrators. Compose the formula by selecting the required fields.Using dynamic resources When you drag cube elements from the Resource View panel to analyze data of a report. expand the Dynamic Resources > Formulas node. 3. To learn the formula syntax. To create a dynamic formula: 1. . refer to Formula syntax in the JReport Designer User's Guide. you can create some dynamic resources and use them in the report to get the desired data. Functions and Operators boxes. refer to Built-in functions and Operators in the JReport Designer User's Guide. You can also write the formula by yourself in the editing box. Dynamic resources in JReport Viewer include formulas and measures. 2. In the Resource View panel. Creating and using dynamic formulas You should have some knowledge of the formula syntax before you can successfully compose a formula with no errors. functions and operators from the Fields. the dynamic resources will be saved along with the report as its resources. sometimes you may find that the cube elements that have been predefined in the business/report cube cannot meet your requirements. Enter a name for the formula in Formula Name text field. then click <Add Formula…> to display the Formula Editor window. Then when you save the report. For details about the functions and operators. in which case. click OK to create the measure object. In the Add Measure dialog. When done. However. In the Measure Name text field.".". "|". "\". Once a dynamic measure object has been created. 5. To create a dynamic measure object: 1. "\\". " ' ". "=". expand the Dynamic Resources > Measures node. specify the display name of the measure object and the aggregate function as required. if the formula has been used in the report or referenced by another formula. then select Create Measure from the shortcut menu. click OK. When done. "$". The Add Measure dialog is then displayed. ":". Currently. "[". you can then drag it from the Resource View panel to the desired position in the report as a detail information object for data analyzing. Notes: q A JReport Live license for JReport Server is required in order to use this feature. ". 3. "^". "+". "]". 2. Also. click the OK button to create the formula.". specify the aggregate function for the measure object. The formulas can also be used to control object properties if you are an advanced user and provided that the Use Dynamic Formula in Property is checked on the Report menu. Click the Check button to check whether or not the syntax of your formula is correct. "(". you can also create dynamic measure objects by mapping them to the available resources which include dimension objects. "/" q q . "`". Creating and using dynamic measure objects In JReport Viewer. "?". if you want to further edit an existing formula or remove any formula that is not required. From the Aggregate drop-down list. next to the Mapping Name text field to specify the mapping name of the field to which the measure object is 4. "#". right-click the formula and then click the corresponding command on the shortcut menu. right-click the formula in the Dynamic Resources > Formulas node. When done. "{". detail information objects in the current business/report cube and the dynamic formulas that have been created in the report. When formulas reference display names or mapping names. Click the chooser button mapped. ")". right-click the measure object and click Edit or Delete on the shortcut menu (a measure object that has been used in the report cannot be deleted). In the Resource View panel. 5. global variables and user defined formula (UDF) functions are not supported in dynamic formulas.4. and you can only save a dynamic formula with no errors into a report. If you do not have a Live license please contact your Jinfonet Software account manager to obtain a license. "-". To do this: 1. you can then drag it from the Resource View panel to the desired position in the report so as the get the desired data. ". Once a dynamic formula has been created. "<". "&". 2. 3. "%". "@". "!". And if you want to edit any dynamic measure object or delete it. In the Resource View panel. specify the display name of the measure. "}". ". ">". "*". it cannot be deleted. the names should not contain any of below characters if the names are not quoted by double-quotation marks "": "~". You can also create a dynamic measure object on a dynamic formula. then click <Add Measure…>. Examples: r Expression @Customer#. the display names of objects in a category in a business/report cube cannot be duplicated. you will be prompted with a message asking you to give a new name for the object in JReport Designer first. quote it as "Category. which means they are only available to the report tab for which they are created. will cause a syntax error.Measure" or "Category"."Measure". When you choose to create a dynamic formula/measure object on an object which was created in a previous version and it has the same display name as another object. r q q Now in JReport. If a field has the display name Category. But @"Customer#" is ok. .Measure. when adding it to a formula. Dynamic resources are report tab level resources. you can choose to show certain groups of records according to your requirements. They are: q Automatic drilling User defined drilling Going q q . This section presents three kinds of drilling in JReport Viewer. and switch among the groups to see the data you want. you can define some methods to view specific data. Moreover.Drilling through the report data In a DHTML report. The list of dimensions available for Drill To will appear on the submenu.Automatic drilling Automatic drilling enables you to switch from the current dimension to another dimension by using system-defined commands on the shortcut menu. and it is divided into four kinds: q Drill-to It enables you to obtain a different view of data by switching among dimensions. . q q q Drilling actions are performed on crosstabs. and Total Sales as the summary field. the new component can be analyzed in the same way as the original one. and choose Drill To from the shortcut menu. Drill-to 1. data fields of which can be converted to corresponding cube elements (see the note in Analytic reporting for details). Sales Year as the row field. and applied the default style to the crosstab. whose data are based on business/report cube or if on query. Right-click any value of Region. Drill-to-by-value It enables you to filter data based on a drill-to action so as to obtain a more detailed view of the data. APAC for example. Drill-down It enables you to drill data to lower dimensions according to predefined hierarchies. The crosstab shows as follows: We will now take the crosstab as an instance to illustrate the automatic drilling functions. After drilling. Drill-up It enables you to drill data to higher dimensions according to predefined hierarchies. Assume you have created a crosstab report on the report cube WorldWideSalesRC in Data Source 1 of the SampleReports catalog showing product sales information with Region as the column field. and grouped tables and banded objects. 2. Row field can also be drilled freely. This is because that. Drill-to-by-value 1. Click Product Type on the submenu. then in the regenerated result. we can see that Sales Year remains the dimension for rows and Product Type becomes the dimension for columns. 3. choose Drill To > Region from the shortcut menu. right-click any value of Product Type. To go back to the original report. the dimension of columns changes to Product Type by the Region value APAC. We can see that the result is different from that of drill-to. 3. for the drill-to-byvalue action. Go back to the original report in the above example. which lists the same items as those of Drill To. and point to Drill to By Value on the shortcut menu. That . Right-click the value APAC of the Region dimension. Click Product Type too and the result will be regenerated. 4.2. A submenu for the command is displayed. Repeat Steps 1 and 2 to drill the data to other dimensions. when a drill-to-by-value action is performed. 2. on the basis of the drill-to action. and thus the result of drill-to-by-value is generated. a filtering action where Region = APAC is further performed. To go back to the original report. and we can see that Territory is listed as the submenu item. The report cube WorldWideSalesRC contains a hierarchy Geography. Drill-down Drill-down actions are based on predefined business/report cube hierarchies. It displays the data about territories in the Asia Pacific region. then right-click any value of Product Type and click Drill To > Region from the shortcut menu. first delete the drill filter in the Drill Filter panel by clicking X next to the dimension name. which allows you to drill a dimension (corresponding to a high level) down to the one-level-lower dimension. on the shortcut menu. In addition.is. point to Drill Down. the Drill Filter panel will be displayed on the left of the JReport Viewer window. right-click the value APAC. Click Territory to see the result. which shows the dimension and the value the filter is based on. 1. Go back to the original report in the above example. . 4. 3. so JReport drills this region onelevel down to display territories in APAC. point to Drill Up. on the shortcut menu. 1. In this example. This is because. when you perform a drill-down action. The one-level-lower dimension for Territory defined in the hierarchy is Country. right-click any value of Country. and we can see that Territory is listed as the submenu item. we first click on the APAC region. Drill-up Drill-up actions allow you to drill a dimension (corresponding to a low level) up to the one-level-higher dimension. China for example. Based on the report result after drill-down. Now click Asia directly and JReport will also drill it down to Country. After these two drill-down actions. a filter will be created based on the value you click on. we can see two filters are added in the Drill Filter panel. you can remove the corresponding filter from the Drill Filter panel. Region = APAC and Territory = Asia. If you want all data in the one-level-lower dimension to be displayed when you drill down a dimension. and thus the filter Region = APAC is created. . Notes: q A JReport Live license for JReport Server is required in order to use this feature. For banded object and table. you can right-click its group header/footer to show the shortcut menu so as to use the automatic drilling functions. If you do not have a Live license please contact your Jinfonet Software account manager to obtain a license. Asia for example. JReport will drill it up to Region. point to Drill Up and click Region. Territory is now the dimension for columns. on the shortcut menu.2. The dimension is drilled one level up. q q q . Click Territory to see the result. JReport allows you to define display names for items to be shown on the drill-related menu items. see Customizing the field display names in the JReport Designer User's Guide. 3. Now right-click any value of Territory. automatic drilling doesn't take effect. The one-level-higher dimension for Territory defined in the hierarchy is Region. you can also right-click field values in the group header/ footer to achieve this. For dimension objects that not used as group fields in a banded object or table. For detailed information. 2.User defined drilling Besides automatic drilling. Publish the report to JReport Server. In this way. or right-click the object and then select Detail Report from the shortcut menu. an image. This is useful for viewing some information related to the current report. 2. a master report holds more comprehensive data. by setting up more and more pairs of master/detail reports. making the analysis of a report more diverse and useful. especially with viewing a report for comparison. JReport provides you with custom drilling functions including support for linking to another report and for linking to a detail report. Develop the page reports with master/detail relationship in JReport Designer. Linking to another report A link to another report can be bound to a field. Run the report in DHTML format with JReport Viewer. JReport reports can be joined together to compose a master/detail report group. Such an inter-report relationship network can be achieved by setting up "Anchor" and "Filter" conditions between two reports. Develop a page report in which a report tab contains an object which is linked to another report in JReport Designer. Click the trigger object in the master report. a label. A detail report can be the master report of another report. while detail reports hold related detail information. 4. Publish the reports to JReport Server. 4. your reports will be related to each other. 3. Normally. 5. instead of being isolated. Each report may have a particular emphasis on one or more aspects. The linked report will then be shown. 3. or right-click the object and then select Link Report from the shortcut menu. and a report chain is formed. To use master/detail reports in JReport Viewer: 1. you may want to set up certain relationships among your reports so that you can browse from one report to another through the relationship "channels" that you create. To use a link in JReport Viewer: 1. You can use one report to hold comprehensive report data. Run the report which contains the master report in DHTML format on JReport Server. In some circumstances. . or a shape map area in JReport Designer. Click the trigger object in the report. Linking to a detail report In most cases. and another to show detailed information on a specific topic. many reports can be joined together. you should specify the Target Frame option as Same Frame when you set up the master/detail relationship in JReport Designer. you should further make sure that the Pop Up New Window for Links option has not been checked in the Profile > Configure DHTML Profile > Properties > Default tab. will be displayed in the Go To drop-down list on the navigation bar after you have drilled to the link report or detail report if it is opened in the current window. To make the detail report show only the records related to a trigger field value in the master report. which tracks the linking (user defined drilling) actions. 6. If you select Server Setting. Otherwise. You may be prompted to provide encoding and DB security information before the report result is produced. Click OK if you want to run a detail report using the same encoding and DB security settings as that of the master report. A "link path". The detail report will show only the records in conformity to the anchor and filter conditions. Clicking an item in the list will switch to the corresponding report. the detail report will be opened in a new web browser window with no relationship to the master report. For detailed information. q q . see Linking reports in the JReport Designer User's Guide. such as assigning values to parameters of the link report or detail report automatically and passing style information to the link report. Notes: q In JReport Designer. you may find that the user defined drilling feature can provide more functions.5. printed. After a going action has been performed. will be displayed in the Go To drop-down list on the navigation bar. Go-down Go-down means to jump down one group level to show the records of a particular group. the data presented in the banded object will be re-loaded from the data buffer. with which you can easily return to the original report. showing only the records in the selected group.cls in the SampleReports folder of Public Reports. You can also switch among the groups to see the data you want. which divides into go-to. The following describes the use of the going actions based on Banded_Link. which contains a banded report. as indicated in the diagram. and the new report created by going can also be viewed. a "going path". Going actions do not apply to banded objects created in JReport Viewer.Going In a DHTML report. q q q Going actions are available only for banded objects that contain groups. which tracks the going action. go-up. and fields in which have not been converted to cube elements of a report cube. Run Banded_Link. In addition. and go-todetail. and exported to other format in the same way as the original report. q Go-to The go-to action allows you to switch the data presented in a banded object from any group to any other group. Go-to 1. you can select to show certain groups of records in a banded object according to your requirements. . Go-up Go-up means to jump up one group level to show the records of a particular group.cls. go-down. This action is called going. Go-to-detail Go-to-detail allows you to concentrate on the details of a group. right-click and select Go To > APAC > Vietnam from the shortcut menu. Then only the data about Vietnam is displayed.2. . Point to the region APAC. right-click and select Go Up > LATAM from the shortcut menu. at the same time. right-click and select Go Down > Singapore from the shortcut menu. Undo the go-up action in the above example. or from the Go To dropdown list on the navigation bar. Then data about Singapore is displayed. That is.3. at the same time. for example China. To return to the original status. Go-up For a go-up action. Point to any country. At Step 2. 2. in order to perform a go-to action. select Product Sales by Country. you can right-click any field value in the banded object or even the blank part of a group header/footer panel or detail panel. the go-up action allows you to focus your attention on the groups of a higher level than what you right-click. you need to right-click a group header/footer panel or any object in the panel.Country. in other words. you may find that items listed on the Go Up submenu are regions of the Region group level which is one level higher than the current group level . Then only the data about LATAM is displayed. Point to APAC. Go-down For a go-down action. Undo the go-up action in the above example. 1. you should make sure that this group level is lower than some other group levels. 2. 1. you need to right-click a group header/footer panel or any object in the panel. right-click any value and then click Go To > ROOT on the shortcut menu. . You may notice that the result is not dependent on what you right-clicked. you should make sure that this group level is higher than some other group levels. and only those lower-level groups which are related with the higher-level group value you right-click will be concerned. Undo the go-down action in the above example. you may find that items listed on the Go Down submenu are countries of the Region group level which is one level higher than the group level of Country. label. You can refer to Obtaining detailed information from a banded object in the JReport Designer User's Guide for more information. Point to LATAM. then a field. image or shape map in a group header/footer panel of the banded object can be used to obtain information of that group.At Step 2. and a chart in a banded object also has the similar function. The go-to-detail action should be predefined at report design time. the go-down action allows you to focus your attention on the groups of a lower level than what you right-click. 1. and only countries in the Asia Pacific (APAC) region are displayed. . That is. 2. Then only the data about this region is displayed. right-click and select Go to Detail from the shortcut menu. Go-to-detail If a banded object contains group information. To do this. in JReport Viewer as shown below. most of the manipulations require selecting the component first. it may be faster to limit the number of records to 1 page while you make the changes then change it back to All to view the final result. r r of the crosstab and select Rotate from the shortcut menu. Setting the number of records retrieved by data components You can set the number of records that can be retrieved by all data components in a report. To select a component. You can also directly input a positive integer here and press Enter to retrieve the corresponding records. which refer to crosstabs. However. and set the default expanding/collapsing state of groups in outer levels. Click the Rotate button Right-click the icon on the Analysis toolbar. To rotate a crosstab. Adjusting the width of crosstab fields according to the contents When the contents in the field of a crosstab need more space to completely display. tables. when the icon appears at its upper left corner. Rotating a crosstab Columns and rows in a crosstab can be exchanged. you can click Menu > Report > Max Records to show the Max Records dialog.Manipulating data components You can manipulate data components. you can simply drag a dimension object (row/column header) to the required destination till a blue line appears. To do this. banded objects and charts. you can adjust q . and then do one of the following: r q Click Menu > Report > Rotate Crosstab. Manipulating a crosstab q Changing the dimension index in a crosstab The dimension index in a crosstab can be modified. For details. If you do not have a Live license please contact your Jinfonet Software account manager to obtain a license. namely. You can also drag a column header to a row level and vice versa. If you are making a lot of changes to the report. you can specify whether or not to enable the crosstab to be expanded in JReport Viewer. q Expanding/Collapsing a crosstab For a crosstab. click the icon. if it has more than one row/column group level. first select it. click anywhere in the component. This operation is called rotating a crosstab. Note: When manipulating data components. and then achieve the same goal. Alternatively. select a value to your liking (All or first 50 to name a few) from the Max Records combo box on the Analysis toolbar. a JReport Live license for JReport Server is required in order to use the features involving report cube/business cube or changes of report template. see Expanding/Collapsing a crosstab in the JReport Designer User's Guide. This operation can be performed on crosstab's containing two or more dimensions. you can move a dimension to a higher or lower level. To do this. To do this. right-click the group header row and select Vertical to Detail from the shortcut menu. To do this. and select Horizontal to Detail from the shortcut menu. release the mouse button. To do this.the width of the field according to its contents. you can do the same actions on its row headers. Showing table columns of the You can specify which columns will be shown in a table. or group column. Hiding/Deleting table columns A table column (for a horizontal table. first select the field. To achieve it. Rotating a table You can rotate a table to switch its appearance between the horizontal and vertical layout modes by doing one of the following: r q q q q q Click Menu> Report > Rotate Table. r r of the table and select Rotate from the shortcut menu. you can adjust the width of the table column according to the contents. Changing group direction You can make the group headers that are placed horizontally in a table to be displayed vertically. summary column. drag a column header to the left or right boundary of another column header. In addition. r To insert a common column into a table: . drag a group field value to the required position until a blue line appears. q Inserting table columns You can insert a new column in a table and it could be a common column. Manipulating a table q Adjusting order of columns in a table The order of columns in a table can be easily adjusted. right-click the cell of the column in the table header. right-click the icon table. detail column. if the first column of a table is group column. With regard to a horizontal table. you can specify to place the group column horizontally in a table. the "column" corresponds to a field row) can be hidden or removed. To do this. check the names of the columns you want to show from the Show Column sub menu. The above description is for a vertical table. right-click the cell of the group column in the table header. select the cell of the column in the table header and right-click. The order of the group levels can also be adjusted. when a blue line appears along the column boundary. then select Auto Fit from the shortcut menu. and the column will be hidden or removed from the table. To do this. Adjusting the width of table columns according to contents When the contents in cells of a table column need more space to completely display. q Adjusting grouping order in a table A table may contain several group levels. To do this. and you will see the order change. then right-click on it and select Auto Fit from the shortcut menu. then on the shortcut menu. Click the Rotate button Right-click the icon on the Analysis toolbar. then select Hide Column or Remove Column from the shortcut menu. then click OK. Right-click any cell in the table header.1. r of the table. 2. and vice versa. or right-click the icon 2. select the dimension object you want to use for the new group column from the Resources box and click to add it as the group by field. if you use the table shortcut menu to insert the column. To convert a detail column into a group column: 1. r To convert a group column into a detail column. or as the last column in the table when there is no detail/summary column. Specify the positions of the group by fields: Group Above. r To insert a group column into a table: 1. In the Select Group Position dialog. Right-click any cell in the table header. select the cell of the group column in the table header. right-click and select Convert to Detail from the shortcut menu. Right-click any cell in the table header. then the conversion is done. right-click it and select Aggregate On . The next time when you open the Insert Group Column dialog to add more group columns. then select 2. In the corresponding insert column dialog. detail or summary column. 5. Repeat the above steps to add more groups if required. click Insert > Common Column. Click OK to save the changes. If it is a detail/summary column. You can choose to remove or edit them if required. 3. 3. 2. On the shortcut menu. Group Left Above. 4. Select the cell of the detail column in the table header. specify the position for the newly converted group by field. In the Insert Group Column dialog. r If it is a common column. all the added group by fields will be listed in the dialog. specify the resource you want to use for the new column. Click OK to insert the columns. the column will be inserted after the last detail/summary column. r q Aggregating on a detail column You can summarize the data in a detail column if required. To do this: 1. of the table. then select 1. or Group Left. or right-click the icon Insert > Group Column from the shortcut menu. right-click and select Convert to Group from the shortcut menu. Note: If you right-click any cell in the table header and use its shortcut menu to insert a common. however. Select the cell of the detail column you want to convert in the table header. r q Converting table columns You can convert a group column into a detail column. or right-click the icon Insert > Detail Column/Summary Column from the shortcut menu. the column will be inserted as the last column in the table. then specify the sorting direction of the group in the Sort column. the column will be inserted before the column in which the cell you click on is. To insert a detail or summary column into a table: of the table. Hiding/Showing DBFields and labels in a banded object The DBFields and their corresponding labels in a banded object can be hidden or shown.from the shortcut menu. In the Display tab. See the note in Analytic reporting for details. the Format Chart command will be available only when JReport Viewer can convert data fields used by the chart to corresponding cube elements. 3. data display. change the dimension and measure object used by the chart. it will be marked with a check mark. the item is with a check mark. or aggregate on its detail columns in JReport Viewer only when data fields used by the table can be converted to corresponding cube elements. and vise verse. convert columns in the table. For a field or label that is shown. When done. q q Manipulating a chart q Modifying the definition of a chart You can modify the definition of a chart. then on the shortcut menu. This operation is also applicable for hiding/showing a row in a table. To do this. Expanding/Collapsing a group panel in a banded object Group panels in a banded object can also be expanded or collapsed. specify the type for the chart. To do this: 1. the aggregation will be created for each group in every group level and the whole table at the same time. 2. Note: If a table is created in JReport Designer. you will find a dynamic measure object is created which is given a default name Function_DetailFieldName in the Dynamic Resource > Measures list in the Resources View panel and you can use it again in the current report if required. including the chart type. s If the table has groups. right-click the icon of the banded object. For a panel which is shown. and then select Format Chart from the shortcut menu to display the Chart Definition dialog. For details. specify a function from the Function drop-down list to summarize the field in the detail column. If the table has no groups. click OK. and style. Right-click the icon of the chart or any part of the chart other than the legend and label to show a shortcut menu. the aggregation will be created based on the whole table. you can add. click the fields and labels you want to show from the Show Field sub menu. To do this. s When you finish aggregating on a detail column. In the Aggregate On dialog. q In the Chart Type tab of the Chart Definition dialog. and vice versa. Note: In the event that the chart is built in JReport Designer. Manipulating a banded object q Hiding/Showing a panel in a banded object of the banded A panel in a banded object can be hidden or shown. see Managing the data of a banded object in the JReport Designer User's Guide. click the item which indicates the panel name from the Show sub menu. then on the shortcut menu. q . right-click the icon object. See the note in Analytic reporting for details. this style will be applied to the chart by default and the Style tab will be hidden from the dialog. right-click the legend/label and select Format Legend/ Format Label from the shortcut menu. For details about the properties. In the displayed format dialog. In addition. legend and label) in a chart can be formatted to suit your requirement. no matter whether the chart is originally created in JReport Designer or JReport Viewer. set the properties according to your requirement. If there is only one style available. and then select a r q Formatting chart elements The elements (platform. click the Chat Type button suitable subtype from the drop-down menu. select the required type from the Chart Type submenu. r To format the platform/paper of a chart. if you only want to change the chart type. For details about the settings. specify the settings as required. see Creating a chart report.q In the Style tab. you can achieve it by doing one of the following: r q Right-click the chart and on the shortcut menu. In the displayed format dialog. right-click the icon or any part of the chart except for the legend and label and select Format Platform/Format Paper from the shortcut menu. paper. modify the style for the chart as required. see Format Legend dialog and Format Label dialog. For details about how to modify the chart definition with the Chart Definition dialog. Select the chart. r . on the Analysis toolbar. To format the legend/label of a chart. which lists all the chart types and subtypes (the current one and the inapplicable subtypes are grayed out). Upon finishing. refer to Format Platform dialog and Format Paper dialog. click OK to apply the modifications. Click the button to open the Edit Conditions dialog to define the condition as required. Right-click the field and select Conditional Formatting from the shortcut menu to access the Conditional Formatting dialog. which refer to the DBField. To add conditional formats to a field. the defined format will be applied to the field values for highlighting. formula field. 1.Adding conditional formats to fields You can add some conditional formats to a field. then when the specified condition is fulfilled. parameter field. 2. and the special field Page Number or User Name. summary field. . for example. 3. click OK to save the condition. 4. the font face. font color. See Filtering report data for details about how to define a condition. font size. then click edit the condition expressions as required. Repeat the above steps to add more conditions and define the format for each condition as required.There are the basic and advanced modes of the dialog for you to define either simple or complex condition expressions. . To remove a condition and the corresponding format. 5. select the condition in the Condition box. . In the Edit Conditions dialog. To edit a condition. select the condition in the Condition box and click . The newly added condition will then be displayed and highlighted in the Condition box in the Conditional Formatting dialog. In the Format box. set the format which will be applied to values of the field when the specified condition is fulfilled. When done. etc. .To adjust the priority of a condition. select the condition in the Condition box and then click 6. Click OK to apply the conditional formats to the field. or . See also Conditional Formatting dialog and Edit Conditions dialog for details about options in the dialogs. 3. 2. click the icon to . In JReport Viewer. the chart converted from the crosstab will take on the style of the table or banded object. and the To Chart dialog will be displayed. Converting a chart into a crosstab To convert a chart into a crosstab: 1. If the crosstab is in a table or banded object. The chart can only be defined based on the cube elements listed. Converting a crosstab into a chart To convert a crosstab into a chart: 1. the Resources box lists all the cube elements used in the selected crosstab including dimension and measure objects. Note: A JReport Live license for JReport Server is required in order to use this feature. when there is only one style available. and so to the Show Values box respectively. specify a suitable type for the chart. when the icon select the crosstab. and measure objects from the Resources box to the Category box. Add a dimension object to the Series box. to enable the conversion. In the Chart Type tab. However. by default. you can convert a crosstab into a chart and vice versa. when the icon appears at its upper left corner. Click OK to confirm. set the style for the chart as required. then do any of following: r appears at its upper left corner. click the icon to Right-click the icon and select To Chart from the shortcut menu. In the Display tab. 5.Converting between components Converting between components enables you to view and analyze data from different aspects with different focuses. however. r Click Menu > Report > To Chart. 6. if a crosstab/chart is designed in JReport Designer. uncheck the Inherit Style option and choose the desired style in the Style box. you need to make sure that data objects used by the crosstab/chart can be converted to corresponding cube elements (see the note in Analytic reporting for details). If you want to apply another style to the chart. If you do not have a Live license please contact your Jinfonet Software account manager to obtain a license. In the Style tab. Click anywhere in the chart. Click anywhere in the crosstab. Click the OK button to finish the conversion. The Convert Data Fields dialog may appear for your confirmation on converting data fields of the crosstab to cube elements of a business/report cube. With a certain type specified. this style will be applied to the chart by default and the Style tab will be hidden from the dialog. 4. you can further define the chart as a combo chart by clicking <Add Combo Type> in the Chart Type Groups box. you can edit the display name of a group field or aggregate field. However. . uncheck the Inherit Style option and choose the desired style in the Style box. Click OK to finish the conversion. Note: Additional values are supported only in chart. r 2. select it and click . this style will be applied to the crosstab by default and the Style tab will be hidden from the dialog. Click Menu > Report > To Crosstab. In the Display Name column. then do any of following: r Right-click the icon or any part of the chart except for the legend and label. If you want to remove any group/aggregate field. when there is only one style available. apply a style to the crosstab as required. In the Style tab. or . by default. the additional values are not converted together with the chart. the crosstab converted from the chart will take on the style of the table or banded object. In the Display tab. If the chart is in a table or banded object. Click OK to confirm. If you want to apply another style to the crosstab. 3. Repeat these to add more aggregate fields. The Convert Data Fields dialog may appear for your confirmation on converting data fields of the chart to cube elements of a business/report cube. select a group/aggregate field and click 4. and the To Crosstab dialog will be displayed. select a dimension object in the Resources box and click to add it as a and click to add it as an group field to the Columns or Rows box. select a measure object aggregate field to the Aggregates box. and the Sort columns allow you to specify a sorting manner on a group field. If you convert a chart with additional values into crosstab. then click To Crosstab on the shortcut menu.select the chart. To adjust the order of group/aggregate fields. 5. TOC Anchor Besides the groups. TOC in JReport Designer Just like a report. expand the Report node. so that your input for that object can be displayed in the TOC Browser instead of the default value. The page that contains the component or the matching data will then be shown. The component names indicate components in the report tab. click Menu > View > TOC Browser. . Some objects. select a component or a node with the group value that you want to browse to. The group values show hierarchical groups. summaries. If the TOC Anchor property value is true. When you click such a node. there is an object named TOC. Most components in JReport Designer hold a property called TOC Anchor which holds a Boolean value. JReport Viewer will turn to the page that contains this component. Moreover. which means that by default they will appear in the TOC Browser. In the root node in the Report Inspector of JReport Designer. The root node represents the report tab that you are currently viewing. The table of contents on the TOC Browser is organized into a tree structure. a node for this object will then be added to the TOC tree. subreports. To show the TOC Browser.Navigating through the report data You can use the TOC Browser to navigate through a report. you can also add your own nodes to the TOC Browser. such as group panels. the format of the TOC is designed in JReport Designer. In the TOC Browser. you can type a string or even a formula as the Anchor Display Value property for a component holding a true TOC Anchor property. You can modify its properties to customize your TOC style. and cube elements hold a true value for the TOC Anchor property by default. the banded objects. You can create and set up your own styles in JReport Designer. or banded object in the report and select Apply Style from the shortcut menu to select the required style in the Apply Style dialog. . or select the required style from the style drop-down list on the toolbar. in which case. crosstab. In order to apply a style to a report.Applying a style A style can be applied to a report in order to change its appearance and characteristics. you will find that all these style related commands are hidden. charts. By default. After applying a style. click Menu > Report > Style and select the required one from the submenu. the style feature will be enabled and you can select a style to apply to the report. the style feature is enabled in JReport Viewer. When you publish your reports to JReport Server. However. if there is only one style available to the report. When you run a report. Reference: See also the chapter Styles in the JReport Designer User's Guide for more information about how to work with styles at report design time. You can also right-click a table. and tables in the report will take a uniform appearance. crosstabs. you can include these custom styles with the published reports. this style will be applied to the report by default. chart. . q q q q q q q There are some methods in the file API.. dhtml?sessionid=XXXXXXX&rptsetid=XXXXXXX&rptname=XXXXXXX& The path. The URL in DHTML is: http://localhost:8888/dhtml?sessionid=XXXXXXX&rptsetid=XXXXXXX&rptname=XXXXXXX&op=. search. localhost The host address.Working with reports via URL Besides working on interfaces.n Page number pn op=24&pn=2 function function function function op The page number begins with 1 and is less than total page number. q http The web service protocol. save and so on.js located in <intall_root>\public_html\javascript\dhtml. = URL separator. q Prototype Exit Prototype Navigate Page Operation code Example Note Prototype function user_downloadReport(type) function user_exit (popwin) op 24 1. can also be accomplished via URL. The order begins with 2. The result of each of these functions will be a URL. A file of HTML type cannot be downloaded. you should follow the specifications described in this section.. sort. ? URL separator. When using URLs to access JReport Viewer. 8888 The port. user_firstPage() user_lastPage() user_nextPage() user_prevPage() 25 One Step Filter Operation code .. & URL separator. most of the JReport Viewer operations such as filter. Parameter Key Description Download Report Operation code Export report type Example Note op ty op=51&ty=2 q Value 51 2/3/4/5/6/7 means PDF/PostScript/RTF/TEXT/EXCEL/XML respectively. These methods are the tools you can use to generate URLs. op The key of operation in DHTML. result path/name path/name . matchcase. comp component instance name op=25&col=CusID&operator=eq&value=1&logic=OR&col=CusName&operator=0&value=ZhangKe&logic=2&comp=convert_sectionObject The value is case-sensitive. colName. instanceName) op column value isContent 128 Mapping the name of a column in JReport.path jrs. function user_oneStepSort(columns. true/false component instance name function user_oneStepSearch(value.jsp jrs. isWholeWord) op=12&col=CusID&ord=true&col=CusName&ord=false&comp=convert_sectionObject The value is case-sensitive. means "equal to/greater than or equal to/greater than/less than/less than or equal to/unequal to" respectively. The version number can be none.try_vw path/name op col ord comp 12 Mapping the name of a column in JReport. as with the example.cls =&jrs. eq/gt/geq/lt/leq/neq. instanceName) Report name jrs. you can replace it with "%2f". values. the value to search for true/false One Step Search Whether or isMatchCase not to match case The search direction isUp true/false true/false Whether or isWholeWord true/false not to match whole word op=128&column=CusID&value=1&isContent=true&isMatchCase=false&isUp=false&isWholeWord=false Example Prototype One Step Sort Operation code The column name The column sort order Instance name of the column Example Note Prototype Open Report JSP page Action /dhtmljsp/dhtml. isUp. operators.The column name Operator of filter condition The column value Logic of filter condition Instance name of the column Example Note Prototype Operation code The column name The column value Whether or not to search content only col operator Mapping the name of a column in JReport.jsp jrs. q Open RSD File JSP page Result path Result name /dhtmljsp/dhtml.cat q The path delimiter is "/".jsp?jrs.report=%2fSampleReports%2fEmployeeInformation. isContent.catalog Result type Example Note jrs. value logic AND/OR/END.result_type int http://localhost:8888/dhtmljsp/dhtml.catalog=%2fSampleReports%2fSampleReports.try_vw&jrs. sorts. means "and/or/end" respectively. function user_oneStepfilter(columns.cmd jrs.report Catalog path jrs. If you encounter problems. logics.cmdjrs. ) function user_showHelp(helpId) function function function function function function function function function function function function function op op=84 function user_undo() op val op=50&val=250 50 0~400 user_showUserPanel() user_showTOC() user_showDHTMLView() user_showToolbox() user_showSortDialog() user_showFilterDialog() user_showNewRptDialog() user_showOpenRptDialog() user_showSaveAsDialog() user_showPageSetupDialog() user_showSaveResultDialog() user_showPageSetupDialog() user_showPrintDialog() 84 op op=34 function user_showSaveResultDialog() 34 op op=82 function user_saveRpt() 82 op op=76 function user_reset() 76 op op=83 function user_refresh() 83 op op=85 function user_redo() 85 Show Export to Dialog Show Panel or Dialog Undo Operation code Example Prototype Zoom Operation code Proportion Example Note val must be an integer between 0 and 400 .rst_version int http://localhost:8888/dhtmljsp/dhtml.open("xxx".jsp?sessionid=XXXXXXX&rptsetid=XXXXXXX&rptname=XXXXXXX&HELP_OP=XXX The URL gets the body of a window.resource_path=/USERFOLDERPATH/admin/test&jrs..rsd q The path delimiter is "/". The version number cannot be none. If you encounter problems. q Redo Operation code Example Prototype Refresh Operation code Example Prototype Reset Operation code Example Prototype Save Report Operation code Example Prototype Search Next Operation code Example Prototype Show Help Dialog ID Example Note Prototype Prototype HELP_OP 182 http://localhost:8888/dhtmljsp/help. you can replace it with "%2f". .Result version number Example Note jrs.jsp?jrs.file=1980996366. you should put it as xxx in window. Prototype function user_zoom(value) . and the number that the license allows is 20. On the JReport Administration page. click Profile on the system toolbar and then select Configure DHTML Profile from the drop-down menu. Limiting the number of simultaneously open reports Whether or not an open DHTML report interacts with the server. 4. Check the Maximum Number of Open Reports option and type the number to your requirement in the text box. Waiting Requests Queue . q . whichever is smaller will be used as the real maximum number of open reports allowed. opening many reports will decrease server performance. which can improve DHTML service performance. If the number of open reports exceeds the limit. if the value of the Maximum Number of Open Reports option is 10. Click the Properties > Advanced tab.This registers the requests that are waiting for being processed by the DHTML service. Click OK upon finishing. 10 will be used as the maximum number of DHTML reports that can be opened simultaneously. For example.This registers the requests that are currently being processed by the DHTML service. an error page will be displayed prompting you to close one before opening a new one. Note: The Maximum Number of Open Reports option works together with the maximum number of concurrent reports allowed by your product license. 10 non-DHTML reports may use the remaining licenses. Furthermore. The Action Task Manager improves DHTML service performance by preventing a large number of actions from being run simultaneously. Thus. you can modify a property file to control the Action Task Manager. 3. JReport allows the administrators to specify the maximum number of DHTML reports that can be open at the same time so as to prevent large numbers of DHTML reports from being open simultaneously and to improve the server performance.Tuning JReport Viewer performance JReport provides you with methods for adjusting DHTML performance. Of these two values. You can limit the number of DHTML reports open simultaneously by setting the DHTML preferences on the JReport Administration page. 2. As a result. The Action Task Manager coordinates DHTML actions through two fixed-size tables: q Concurrent Processing Table . Action Task Manager Some DHTML operations require a large amount of memory and CPU processing power. however. it holds many resources. To set the maximum number of DHTML reports that can be open at the same time: 1. properties file is located at <install_root>\bin. 3. The DHTML service will then automatically continue to process the requests in the Waiting Requests Queue. the DHTML service will refuse the request and return a warning message.Note: Only certain operations that consume considerable hardware resources need to be prevented from being run at the same time. If the queue is full. the Action Task Manager will take over the request. the restricted request will be assigned to the Waiting Requests Queue. After the request has been processed. it will be processed according to the following flow: 1. If it is. you can balance the server load by adjusting table sizes and specify which kind of requests are managed by the Action Task Manager. The DHTML service determines whether the requested operation is a restricted action. If the Concurrent Processing Table is full. it will be processed directly. Otherwise. dhtml. it will be de-registered from the Concurrent Processing table.properties provided in JReport Viewer.properties The dhtml. When a new DHTML request reaches the server. By using the property file dhtml. without being managed by the Action Task Manager. You can define which kind of requests need to be queued before being processed. 2. It allows you to control three major options for the Action Task Manager: q Specifying the size of the Concurrent Processing Table . pending=[integer] to set the maximum number of to-be-handled requests that the queue can contain.filter=true queue.max.actions. but be directly processed by the DHTML service without being queued.The action will be handled by the Action Task Manager. A request will either be handled by the DHTML service or be rejected when the maximum limit of the Concurrent Processing table has been reached.drill=true queue.actions. concurrent.actions.actions.actions>0.refresh=false queue.max.actions.init=false queue.actions.redo=true queue.actions.sort=true queue.actions. True . The value of this property can be equal to or larger than 0.undo=true queue.The action will not be handled by the Action Task Manager.max. False . The value of this property can be equal to or larger than 0.drillup=true queue. Use 0 (default) to disable the request queue feature.actions. q Specifying the size of the Waiting Requests Queue table Use queue.actions.actions. 0 means no requests will be stored in the queue.Use queue.concurrent=[integer] to set the maximum number of requests that can be processed simultaneously.search=true queue. q Specifying the actions that can be applied for the DHTML Request Queue feature These are listed below: queue. .finishNewReport=true # # # # # # # # # # Action: Action: Action: Action: Action: Action: Action: Action: Action: Action: DHTML report initialization Undo Redo Drilling Drilling up Refreshing Filtering Sorting Searching Finishing creating a new report These properties will only work when the queue feature has been enabled by setting queue.actions. If you do not have a Live license please contact your Jinfonet Software account manager to obtain a license. and higher versions. Using JReport Studio Wizard. it is easy to create complex reports with multiple components in a tabular style layout. web reports are created via the JReport Studio Wizard using a browser and are opened and edited via JReport Studio. JReport Studio Wizard and JReport Studio support Internet Explorer 8. The data sources that can be used to create web reports are business views that are resources built on top of queries. In JReport Server. q . JReport Designer supports creating. see Business Views in the JReport Designer User's Guide). Web reports also allow for company logo and titles to be placed on the top of the page for more formal presentation. In addition. Business views are created and managed in JReport Designer (for details. Google Chrome 5. This chapter covers the following topics to help you better interact with web reports q Why web reports and when to choose them Components supported in web reports JReport Studio window elements Creating web reports via wizard Editing web reports in JReport Studio Running web reports on server q q q q q Notes: q A JReport Live license for JReport Server is required in order to use web reports and all the related functions. see Web Reports in the JReport Designer User's Guide).5. Web reports are viewed using a new interactive viewer called JReport Studio.wls as the file suffix. JReport Studio still supports exporting the report to all supported output formats. JReport Studio provides a much nicer end user experience with many powerful features for interfacing with a report such as changing parameters without re-running the report. Firefox 3. opening. and editing of web reports (for details. Web reports are stored in the JReport Server resource system and follow the server resource and version management rules such as archive policy and permission setting. A web report template contains only one report and uses . JReport Designer also allows for web reports created on JReport Server to be downloaded to Designer and further edited.Web Reports JReport provides the web reporting solution for faster and simpler design and creation of reports using a web browser. Fast report rendering At runtime. Oriented toward presentation rather than analysis Unlike page reports. By using JReport Studio. privacy notices or any standard items and styles you want your users to start with. JReport Studio provides much higher performance when viewed from a browser compared to viewing a page report using JReport Viewer.cls). chart. JReport Designer cannot directly create the temple but can create the report and then using JReport Studio. However.0 interface. Also. q Fewer functions Web reports (. save the report as a template (. easier customization. The JReport Studio Wizard provides a tabular style layout in which you can place a table. but look forward to an excellent Web 2. many of the actions which require only a change in rendering the view are done locally on the client in the browser. Creation and edition in both JReport Server and Designer Web reports created using the JReport Studio Wizard can be downloaded from JReport Server and edited in JReport Designer and web reports can be created in JReport Designer and published to server just like . JReport Engine is structured so that as much of the processing as possible is completed on the client side allowing much higher salability for JReport Server allowing the server to handle more simultaneous users. crosstab. faster report execution. all of the user action requests must be sent to JReport Server which renders the new page on the server and updates the browser view.wls) support a subset of functions of JReport page reports (. and better presentation style using a newer Rich Internet Application (RIA) Web 2. web reports do not support slicing and dicing data since the data source for web reports has been designed with no hierarchical relationship between the data objects. Using JReport Viewer. Using JReport Studio. The basic and essential functions not only guarantee a good report presentation. Create web reports if you do not want to analyze report data such as drilling down and drilling up. Tabular style layout The creation of a page report using the Standard Report Wizard can only create one data component (table. Predefined report templates Web reports allow you to choose a starting template so you can predefine the template to include standard features such as company logo.Why web reports and when to choose them JReport Studio displays web reports (which are also called web layout reports) that are aimed at easier and faster report creation and design. JReport Designer can be used to create web reports which can be run in JReport Studio on the server and saved as a template to use in JReport Studio. Designer can view these reports but not modify them and publish them. Single report solution Only one report in a web report speeds up the report running process as compared to a multiplereport page report. but also make the report design experience easier for a new user of JReport.cls reports. page reports created using the Standard Report Wizard can only be edited in the server. crosstab or chart in each tabular cell so as to achieve a holistic layout with multiple components from the very beginning. Web reports also support agile development techniques such as continuous integration by allowing report templates to be updated by both JReport Studio and JReport Designer. q q q q q q . or banded object) using the wizard. company name.0 presentation. q Standard banded objects not supported Page reports support standard banded objects which are not supported by web reports. .wslt). and sorting them. . filter control. The runtime parameters help you dynamically control your report results such as filtering data. only these can be rendered and edited in JReport Studio: User Name. and navigation control. JReport provides a full set of components that allow you to present and control the report data and presentation in a wide variety of ways. There is one and only one tabular in a web report. A summary applies to a defined group of data. Special fields Special fields are defined by JReport and allow you to easily obtain system information and reportrelated data and add it to your report. All special fields are supported to insert into web reports in JReport Designer. the following four web controls are supported in web reports: parameter control. grouping them.Components supported in web reports Components are the objects that you can place in a report.jpg. It is typically a brief description used to identify a field or other value nearby. summaries. Currently. Formulas Formulas are calculated from DBFields.gif. or database fields. are fields directly from columns in the database or other data source such as XML or Java objects. and Windows Media objects. so they can present information which is not available directly from the database fields. average. and each contains several cells. DBFields DBFields. The following image types are suppported in web reports: . standard deviation or other transformation of a set of data values. Images An image is a digital representation of a picture. It is composed of rows and columns. other formulas.png. including placing fields. and Modified Time. Web reports support the following report components: q Labels A label is an object that contains a string. Parameters A parameter in JReport is a variable whose value is determined at runtime. With such a q q q q q q q q q q . However. Web controls Web controls are report components designed to be similar to the kinds of controls found on web pages. and . Summaries are required to provide the data values for charts as well as totals for table reports. due to the characteristics of JReport Studio. Summaries A summary is a special kind of formula. and parameters. Multimedia objects Multimedia objects include Flash. Tables A table gives you great control over how to present data. parameter form control. Real Media. sum. Modified Date. Tabular A tabular is a component designed to lay out other components. A summary generates a count. the components that can be bound with a data source are also referred to as data components. These components include tables. trends. Currently.structure a table is a good way to show any two-dimensional dataset. For how charts present data. For the elements that compose a chart. q Crosstabs A crosstab summarizes data and presents the summaries in a compact row and column format. see Chart elements in the JReport Designer User's Guide. these types of chart are supported in web reports: r q Clustered Bar 2-D Stacked Bar 2-D 100% Stacked Bar 2-D Clustered Bench 2-D Stacked Bench 2-D 100% Stacked Bench 2-D Line 2-D Stacked Line 2-D 100% Stacked Line 2-D Area 2-D Stacked Area 2-D 100% Stacked Area 2-D Clustered Pie Clustered Donut Gauge Dial 2-D Bullet 2-D r r r r r r r r r r r r r r r For details about each type. Charts A chart organizes and graphically presents data in a way that makes it easy for end users to see comparisons. see How data is represented in a chart in the JReport Designer User's Guide. crosstabs and charts. Tip: In JReport. . It represents the report data in a visually straightforward form. and patterns in data. see Chart types in the JReport Designer User's Guide. the editing mark will not be shown when a report object receives focus. If the option is unselected. Undoes the last operation. Saves the changes of the current web report. Configures the report page settings. Rotates a crosstab to exchange the axes on the crosstab in order to create a different view of the crosstab. Shows the hidden components you specify. Converts a crosstab into a chart. Defines properties of the report body. and report objects cannot be moved or resized. The Refresh operation fetches the data again. Closes the current web report and exits JReport Studio releasing all of the resources. Saves a copy of the web report or the report template in the current web report to server resources. Filters the report records according to the filter criteria you specify. crosstab or chart. Runs the report using previously provided parameters. Converts a chart into a crosstab. Applies a style to the selected components or the whole report. Exports the report result to disk or version in various formats. toolbar. Shows or hides editing marks (dashed outlines for objects and report body).JReport Studio window elements The main page of JReport Studio consists of the user information bar. Inserts a table into the report. Opens a report. left panels and report area. Prints the report result to a PDF/HTML file. menus. Deletes the selected object. Export Page Setup Print Exit Edit Undo Redo Delete Wizard Filter To Chart To Crosstab Rotate Crosstab Report Body Properties Unhide Components Style View Editing Marks Refresh Insert Table . Reverses the operation of Undo. The options for browsing or controlling a web report are as follows: Toolbar/Menu File Button Tool Name New Report Open Save Save As Description Creates a new web report based on an existing business view. Opens the report wizard for you to edit the selected table. Inserts a parameter control into the report. Deletes the selected object. Inserts a label into the report. Inserts a parameter form control into the report. Creates a new report based on an existing business view. Connects to JReport Home Page. Saves the changes of the current web report. Inserts a navigation control into the report. Specifies the font format of the selected text. Saves a copy of the web report or the report template in the current web report to server resources. Merge Split Help User's Guide JReport Home Page Technical Support About JReport Web Standard Toolbar New Report Open Save Save As Export Page Setup Print Refresh Undo Redo Filter Delete Rotate Crosstab . Accesses Jinfonet Technical Support. Filters the report records according to the filter criteria you specify. Merges the selected tabular cells into one. Available only when a label or field is selected. Opens a report. Shows product information about JReport Web. Configures the report page settings. The Refresh operation fetches the data again. Exports the report result to disk or version in various formats.Crosstab Chart Parameter Control Parameter Form Control Filter Control Navigation Control Label Image Multimedia Object Format Font Inserts a crosstab into the report. Prints the current report result to a PDF/HTML file. Reverses the operation of Undo. Opens the JReport Studio User's Guide. Inserts a chart into the report. Rotates a crosstab to exchange the axes on the crosstab in order to create a different view of the crosstab. Inserts a filter control into the report. Inserts a multimedia object into the report. Inserts an image into the report. Splits the selected tabular cell into the specified number of rows and columns. Undoes the last operation. Runs the report using previously provided parameters. Available only when a label or field is selected. Lists all available chart types for you to change the type of the chart. Lists all the parameters used by the current report. Available only when a label or field is selected. Context Toolbar for Crosstab Crosstab Wizard Rotate Crosstab Context Toolbar for Chart Chart Wizard Swap Chart Groups Chart Type Chart Options Panel Parameters Resources Components Filter Go to Filter . Specifies the criteria to filter the data field. or between the category and value axes if there is no field on the series axes. Splits the selected tabular cell into the specified number of rows and columns. After you perform the go-to-by-value action. You can also remove or change existing filters. Lists all the available resources.Swap Chart Groups Specifies whether to switch data between the category and series axes. Opens the Crosstab Wizard for you to edit the crosstab. center or right aligned. Creates a new summary directly based on the field bound with the table detail column. Hides or shows the detail columns you specify. Available only when a label or field is selected. Lists more options for you to specify the layout of the chart. the panel is displayed showing the filter created by the action. Makes the selected text left. Changes the background color of the selected text. Lists all the available components. Opens the Table Wizard for you to edit the table. Merges the selected tabular cells into one. Opens the Chart Wizard for you to edit the chart. Quick Format Toolbar Font Background Color Align Merge Split Context Toolbar for Table Table Wizard Show/Hide Detail Add/Remove Group Show/Hide Summary Specifies whether to show or hide the selected summary field. It is available when the current report uses parameters. Specifies whether to add or remove the selected field as a group. Specifies whether to switch data between the category and series axes. Specifies the font format of the selected text. Hide Aggregate On Hides the selected column. or between the category and value axes of a chart if there is no field on the series axes. Rotates a crosstab to exchange the axes on the crosstab in order to create a different view of the crosstab. Provides submenu items for sorting records on the selected field in ascending/descending order. Deletes the selected object. Adds some conditional formatting to the currently selected field. Edits the detail table to define the detail fields of the summary. Goes to any group with the current group value as a filter to show its record information. . Applies a style to the selected component. Sort Go to Detail Edit Detail Table Edit Link Conditional Formatting Go To Go to By Value Note: The shortcut menu contents vary with the objects you right-click. Goes to any group to show its record information. The above table only lists some typical shortcut menu items. Links the selected object to a report. Defines properties of the selected object. Provides submenu items for filtering the data in the selected component or remove existing filters. The following sections will guide you to use the shortcut menu for any object you may right-click. Goes to the detailed information of the selected summary. URL or E-mail. or remove the sort. Hides the selected object.Shortcut Menu Show Apply Style Delete Hide Properties Filter Shows the selected fields. In the Bind Data screen. then click New Report on the task bar of the Reports page. center or right of the cell. 2. In the Style screen. Repeat this to add component to the other cells. in the edit layout area. 6. 4. you can also create a new template according to your requirement. you can save report templates to include standard features such as a company logo. check the option Web Report and click OK. For details. You can also resize the tabular cells by dragging the cell border. you can directly create a new web report in a folder into which a catalog containing one or more business views have been published. Click Run to open the report in JReport Studio. 8. The JReport Studio Wizard is then displayed. choose a template for the report.Creating web reports via wizard On the JReport Console > Reports page. refer to the specific topic in Inserting components). Use to load your company logo. Click the Align drop-down list to set the component to the left. Then. You can set the font properties for company titles . Click the Page Setup link to set the page properties. company name. see Saving the report. select a tabular cell and select the component you want to display in the cell. A report template stores information in the page header and page footer as a starting point for a web report. 5. Template2 allows for more such as company name and title and report sub title. select the required layout with which you want to create the report. You can use the Back and Next buttons to switch between the components. To create a web report: 1. privacy notices or any standard items and styles you want your users to start with. Click Save to save the report to the server resource tree. you can split the selected cell horizontally or vertically by clicking the Horizontal Split or Vertical Split button. 3. Open the folder and select the catalog for the new web report from the Catalog drop-down list. 7. If you are an administrator with the privilege of publishing resources. In the Layout screen. Report templates Web reports allow you to choose a starting template. . define the specified components (for details about how to define a component. See also JReport Studio Wizard for details about options in the wizard. merge adjacent cells by selecting them and clicking Merge. In the Select Report Type dialog. If you are an and report titles using administrator with the privilege of publishing resources. Template1 allows for your company logo and report title to be added. In the Page screen. If required. apply a style to the report. To create a report template from the JReport Studio Wizard: The JReport Studio Wizard provides sample templates for you to define your own templates based on. edit the page header and page footer.Report templates can be saved using the JReport Studio Wizard or JReport Studio on the server. then rename or delete the template file (. and will be automatically loaded onto the Page screen of the JReport Studio Wizard for use. click the Save button. 1. Template2 allows for more such as company name and title and report sub title. click Save. For each template file.wsld). make use of Template1 and Template2 to customize your own report templates.png) which is used to display in the templates box of the Page screen of the JReport Studio Wizard. by customizing desired information in the page header and page footer of a web report. choose the file type of Web Report Template (*. You will need to rename or delete the image file when you rename or delete the template file. The saved report templates will be added into the templates directory on the server <install_root> \templates. and then save the report template using the Save As option (Menu > File > Save As or the Save As button Standard toolbar). If you want to further format the template. Template1 allows for your company logo and report title to be added. To save the report template from the JReport Studio Wizard.wsld. You can set the font properties for company titles and report titles using . by administrator with the privilege of publishing resources. . To create or edit a report template using JReport Desinger or JReport Studio: You can make use of JReport Desinger or JReport Studio on the server to create or edit your report template. When done. Then save the report template using JReport Studio on the server via the Save As option (Menu > File > Save As or the Save As button on the Standard toolbar). or select an existing template to overwrite it. In the Page screen of the JReport Studio Wizard. Use to load your company logo. there is an image file (. 2.wsld). on the To rename or remove a report template: Go to the templates directory on your server <install_root>\templates. 3. and specify a name for the template in the File Name text field. 4. In the Save As dialog. open a report in JReport Studio that was created with the template you want to change. as a representative of the template. by default it is in the view mode which provides only viewing-oriented functions. When a report is opened in JReport Studio. Pick a task from the following: q General operations in reports Inserting components Making simple modifications to components Manipulating data components Binding links to components Using dynamic resources Going through the report data Applying filters Using web controls Adding conditional formats to fields Applying parameters Sorting report data Applying CSS styles Saving the report Exporting/Printing the report result q q q q q q q q q q q q q q . If you want to edit the report.Editing web reports in JReport Studio JReport Studio is the web oriented page where you view and edit web reports. click the Edit Mode link on the toolbar to enter the edit mode. you can click Menu > Help > User's Guide to open the index page of JReport Studio User's Guide. To switch the status of the editing marks. Undoing/Redoing actions You can undo or redo some actions. Furthermore. Asking for help At any time. You can also use the Help menu to access Jinfonet Software website for more information. if a table or a crosstab contains more than one page. you can click the Help button in any dialog to show the help document about the dialog. just click Menu > File > Exit (or the button X on the far right of the toolbar). The editing marks are shown by default. q q q .General operations in reports You can perform the following general operations in JReport Studio: q Opening another web report Click Menu > File > Open (or the Open button on the Standard toolbar) to display the Select a Report dialog. crosstabs and charts. Do not use the close button on the browser window as that may not release the resources used by the report. To do this. Turning component pages In JReport Studio. and then click OK. You can use the navigation bar to view the desired pages: click a number or input a number in the text box. Showing/Hiding editing marks You can use editing marks (dashed outlines of objects) for purposes such as aligning. Select the web report you want to open from the default folder or from another folder. click Menu > Edit > Undo or Redo (or the Undo button or Redo button on the Standard toolbar). you can use the scroll bar to navigate their data if the tabular cell can not display all data of the component. q Exiting JReport Studio If you want to close the current web report and release the resources. click Menu > View > Editing Marks. moving and resizing. q q Navigating component data via scroll bar For tables. in which the web reports in the same folder as the current open report are listed. a navigation bar specific for the component will be available right below the component. or drag Table from the Components panel to the destination. 2. Click Menu > Insert > Table. The Insert Table dialog is displayed.Inserting components You can insert components into a web report via the Insert menu or via the Components panel on the left of the JReport Studio window. . Report Layout Area Component Chart Crosstab Table Group object Detail object Aggregation object Formula Label Image Multimedia object Web control Page Header/ Footer Y Y Y Y Y N Y Y Y Y Y Report Body Y Y Y Y Y Y Y Y Y Y Y Tabular Cell Y Y Y Y Y N Y Y Y Y Y Table Cell N N N Y Y Y Y Y N N N The following shows inserting a specific component in detail: Inserting a table 1. The following table lists the report areas that are valid targets for the various components. Locate the place in the report where you want to insert the table. If required. See also Insert Table dialog for details about the options in the dialog. 9. In the Group tab. In the Display tab. To adjust the order of the groups. or Summary Table. group in the Sort column. to set the font properties for the 4. Group Left Above. select the business view in the current catalog. and if required. Select the group to which the summary will be applied. click title. 5.3. add the group objects as the grouping criteria. Select the required table type: Group Above. on which the table will be built. Specify a title for the table in the Table Title text field. Specify the display name of any added field in the Label column if necessary. click the Filter button to add some filter conditions to the business view to narrow down data displayed in the table. Click OK to insert the table. Group Left. then specify the sorting manner of each or . add the required fields from the Resources box to be displayed in the table. 6. . From the Data Source drop-down list. then add an aggregation object as the summary field. To add summaries. select a group and click 8. go to the Summary tab. 7. edit the display name of the group object if required. From the Data Source drop-down list. Then. This will label the row/ column when the report is displayed. specify the sorting manner for the group field. 5. By default the Label column is blank and no label will be created for the row/ column. Click Menu > Insert > Crosstab. From the Resources box.Inserting a crosstab 1. on which the crosstab will be built. select a group object and click or to add it to the Columns or Rows box as a group field. or drag Crosstab from the Components panel to the destination. In the Sort column. 3. . to set the font properties 4. click for the title. Specify a title for the crosstab in the Crosstab Title text field. and if required. The Insert Crosstab dialog is displayed. select the business view in the current catalog. Locate the place in the report where you want to insert the crosstab. If required. 2. in the Label column. click the Filter button to add some filter conditions to the business view to narrow down data displayed in the crosstab. or drag Chart from the Components panel to the destination. If you want to remove any field. select a field and click 8. Repeat this to add more group/aggregate fields. . or . click title. The Insert Chart dialog is displayed. edit the display name of the aggregate field as required. and if required. See also Insert Crosstab dialog for details about the options in the dialog. Click Menu > Insert > Chart. 3. 2. to set the font properties for the . Specify a title for the chart in the Chart Title text field. Select an aggregation object or a detail object and click to add it to the Summaries box as an aggregate field. To adjust Inserting a chart 1.6. select it and click the order of the fields. In the Label column. If a detail object is added. Locate the place in the report where you want to insert the chart. Click OK to insert the crosstab. 7. specify the aggregate function for it in the Aggregation column. select a chart type and add an aggregation object value as the data of the type. above the 8. click the Filter button to add some filter conditions to the business view to narrow down data displayed in the chart. To delete a type. in the Resources box and add it to the Category or Series text field. From the Data Source drop-down list. edit the value as required. click above the Primary Axis box and an additional chart type will be added. Repeat this to add more chart types. or additional 6. Click beside the Show Values box. select it and click . Select the chart type in the Show Values box. In the Name text box. c. To create a single chart. If you want to define some sort order and Select N condition on the category or series field. In the Resources box. If required. expand the Additional Values node. In the Primary Axis or Secondary Axis box. then define the order and condition in the Category/Series Options dialog. b. select the business view in the current catalog. then click Additional Value dialog. In the Edit You can add more than one aggregation object or additional value to a chart type. the data of which 7. d. Click OK.4. The Edit Additional Value dialog appears. Check the Secondary Axis checkbox if you want to have the secondary axis (Y2) and define the chart types on the axis as required. and the defined constant/average value will be added to the chart type. or select a field based on which the average value will be calculated from the Based On drop-down list. Each added chart type shall have at least one aggregation object or additional value. . specify the display name for the constant/average value. click Category or Series text field. specify in which order values of the category/series field will be sorted. To add an additional value to a chart type: a. . Select a group object will be displayed on the corresponding axis. select the required chart type from the chart type drop-down list. 5. e. select the value in the Show Values box. on which the chart will be built. Input the constant value with numeric type in the Value text box. in the Primary Axis box. then select Constant Value/Average Value. You can replace the additional chart type by selecting the required one from the chart type drop-down list. In the Category/Series Order box of the Category/Series Options dialog. f. To modify a constant/average value. To define a sort order and Select N condition on the category/series field: a. To create a combo chart. and then input a number M in the text field to the right. so that the category/series values beyond the first or last N range will be merged into the group with the name as that character string. In the Category/Series Selection box.b. you can check Skip First. Inserting an image 1. If All is selected. If necessary. If you have selected Top N or Bottom N from the Select drop-down list. then click Menu > Insert > Label. you can check the Remaining Categories/Series In checkbox and then type a character string in the text field. If Based On is unchecked. f. if Top N or Bottom N is selected. the text field next to it will be enabled and you can specify an integer here. . if you check it. the order of the first or last N category/series values will be based on what you specify in the Category/Series Order box of the dialog. specify the Select condition to All. d. See also Insert Chart dialog for details about the options in the dialog. Locate the place in the report where you want to insert the image. locate the place in the report where you want to insert the label. 9. c. Check the Based On checkbox and specify values for the two drop-down lists that follow according to your requirement. Click OK to insert the chart. The label will then be inserted in the specified location. e. the order will be based on values of the summary field and the sort direction you specify in the drop-down lists next to Based On. Top N or Bottom N. or drag Label from the Components panel to the destination. Inserting a label To insert a label into a report. Click OK to accept the settings. which means that the first or last N category/series values will be shown in the chart. The skipped values will be merged into the Remaining Categories/Series group. then the first M category/series values will be skipped and the Select N condition will begin with M+1. all category/series values will be shown in the chart. r To use an image in the local file system. or drag Multimedia Object from the Components panel to the destination. then select the image in the My Images box. then click Browse to find the image. r r 4. 2. Inserting a multimedia object 1. or drag Image from the Components panel to the destination. select Web URL. To use an image in the image library of the JReport Studio. then input the image URL or paste the URL in the Image URL text field. Click OK to insert the image. select Library. Click Menu > Insert > Image. Click Menu > Insert > Multimedia Object.2. Locate the place in the report where you want to insert the multimedia object. 3. . select Local File. Specify the image you want to insert. The Insert Image dialog is displayed. The Insert Multimedia dialog is displayed. To use an image on a website. For details. 7. Choose from the three multimedia object types: Flash. 5. and navigation control. Inserting a web control You can insert the following web controls into a web report: parameter control. see Using web controls. . specify the full path of the multimedia object you want to insert or use the Browse button to find it if it is on your local disk. parameter form control.3. The Plug-in page text field provides a default URL from which to download the player to play the inserted multimedia object on a web page. See also Insert Multimedia dialog for details about the options in the dialog. 6. 4. Click OK to insert the multimedia object. Real Media file. In the File Name/URL text field. or Windows Media File. Or you can provide a URL for loading it from a website. specify the properties for the multimedia object as required. In the Properties box. filter control. For a tabular. Point to a handle. Then all the other rows of the same role will be resized too. click Menu > Edit > Unhide Components and then select the desired components to show from the drop-down list. click in the text and update the content. For a tabular. alignment. and background color of a label. To edit a table. drag the handle to resize the column. drag the right or lower boundary. when the mouse pointer turns to a double-headed arrow. If a group row is resized. crosstab. click on the component. or chart. border. drag the handle to resize the row height. when the icon appears at its upper left corner. all rows of the group will be resized. rightclick on the icon and then select Hide from the shortcut menu. you can drag the handle to resize the component. point to the boundary between two cells and the mouse pointer will become a doubleheaded arrow. To adjust the row height in a table. click anywhere in the component. all rows in the detail area will be resized. you can then drag the boundary to adjust the size of the related cells. To show the hidden components. . while the other groups' rows keep unchanged. use the corresponding report wizard. Editing a component q To edit a label. point to the lower boundary of a row. see Manipulating data components. For details. To resize the column or row in a crosstab. point to the right boundary of the column.Making simple modifications to components This section introduces the general actions that you can perform on the report components. Hiding/showing a component To hide a component. To edit an image or a multimedia. To adjust the width of a column in a table. click on the component. then you will see it is surrounded by a rectangle with resizing handles. you can edit it as follows: r q q q Merging tabular cells Adjacent cells in a tabular which form a rectangle can be merged into one cell. Another way to show the component after hiding is Undo. Resizing a component and its elements To resize a component. when the icon appears at its upper left corner. right-click on the icon and click Edit on the shortcut menu and then modify the settings in the displayed dialog. Then all the columns or rows of the same role will change too. when the mouse pointer becomes a double-headed arrow. if a detail row is resized. You can also use the Quick Formats toolbar to format the font. For example. when the mouse pointer becomes a double-headed arrow. Click OK in the message box so as to remove the component. click Menu > Edit > Report Body. specify the number of rows and columns and click OK. right-click the object and then select Properties from the shortcut menu. select them one by one while holding the Ctrl key. when the icon appears at its upper left corner. there must be one and only one tabular. Note: In a web report. a message will prompt. asking for your confirmation. q For detailed explanation about options in the properties dialogs. refer to the specific topics in JReport Studio dialogs. Then. then click Menu > Format > Merge or click r on the toolbar. Splitting a tabular cell To split a tabular cell. so you cannot either insert another tabular or delete the current tabular. Modifying component properties JReport Studio allows you to modify object properties with the corresponding properties dialog. . If you want to format the properties of the report. q To format the properties of any object in a report.To merge adjacent cells. then in the Split Cell dialog. right-click on the icon and select Delete from the shortcut menu. specify the settings as required. then in the Report Body Properties dialog. To delete a component. click on the component. In the corresponding properties dialog. select the cell and click Menu > Format > Split or click on the toolbar. and these cells will be merged into one cell. configure the properties as required. Deleting a component A component can be removed from the report if it is no longer required. In the Group tab. To do this. and style of the title. in JReport Studio as shown below. release the mouse button. 3. . Right-click the detail field and select Aggregate On from the shortcut menu. Or you can click the column header to select the column. most of the manipulations require selecting the component first. 5. If required. when a highlighted line appears along the column boundary. see Inserting a table. click anywhere in the component. Manipulating a table q Adjusting order of columns in a table The order of columns in a table can be easily adjusted. select the column by clicking on the column header.Manipulating data components You can manipulate data components. q Aggregating on a detail column You can summarize the data in a detail column. Note that. edit the title of the table. For details about how to define a table. In the Table Title text field. Select the table and do one of the following to display the Table Wizard: s q q Click Menu > Edit > Wizard. To do this. which refer to tables. In the Display tab. click the Filter button to apply some filter conditions to narrow down data displayed in the table. to customize the font. first select a column by clicking on the column header. you can adjust the width of the table column according to the contents. To select a component. then right-click the column and select Auto Fit from the shortcut menu. 4. add or change the fields displayed in the table. Changing the table definition 1. and charts. then on the Context toolbar. when the icon appears at its upper left corner. Upon finishing. click the Aggregate On button . click the icon. 6. Adjusting the width of table columns according to contents When the contents in cells of a table column need more space to completely display. 2. click OK to apply the modifications. Click the Table Wizard button Right-click the icon on the Context toolbar. s s of the table and select Table Wizard from the shortcut menu. To do this: 1. You can click size. modify the grouping criteria of the table. then drag it to the left or right boundary of another column. and you will see the order changes. crosstabs. right-click and select Delete from the shortcut menu. then click Yes in the message dialog. If the table has no groups. then on the Context toolbar. If there is no existing group in the table. click the Show/Hide Summary button select/unselect the summary field name to show/hide it. first select the table and then do either of the following: r On the Context toolbar. . the aggregation will be created for each group in every group level and for the whole table at the same time. the aggregation will be created based on the whole table. . Or you can use the Add/ Remove Group button on the Context toolbar of the table: unselect the group you want to remove from the drop-down list. From the drop-down list. From the list you can select the field you would like to add into the table as a group.2. q Adding/Removing groups in a table You can add more groups into a table or remove the groups that are not required from a table. r To add a group into a table: Select the table. r To remove a group from a table: Click the group column header to select the column. you will find a dynamic aggregation is created which is given a default name Function_DetailFieldName in the Dynamic Resource > Aggregations list in the Resources panel and you can use it again in the current report if required. When done. then on the shortcut menu. s When you finish aggregating on a detail column. q on the Context toolbar. click OK. the added group will be placed at the left-above position. If the table already contains groups. specify a function from the Function drop-down list to summarize the field in the detail column. q Showing/Hiding detail columns To show/hide a detail column. or right-clicking the column and selecting Hide from the Showing/Hiding summaries To show/hide a summary from a table. then on the Context toolbar. then click Yes in the message dialog to confirm the removal. r Right-click the icon of the table. click the Show/Hide Detail button column. In the Aggregate On dialog. From the drop-down list. the new group will be added as the highest level group and follow the same position pattern as the closest existing group. select/unselect the field name to show/hide its detail You can also hide a detail column by first clicking its column header to select it and then clicking the Hide button shortcut menu. select/unselect the summary field name from the Show/Hide Summary sub menu to show/hide it. Manipulating a crosstab . s If the table has groups. select the table. click the Add/Remove Group button and you will get a drop-down list of fields in the business view that can be used as group by fields. 3. s 2. you can adjust the width of the field according to its contents. s s of the crosstab and select Crosstab Wizard from the shortcut menu. see Inserting a crosstab. To rotate a crosstab. 3. aggregation objects 4. Click the OK button to finish the conversion. 3. To achieve it. and then do one of the following: r Click Menu > Edit > Rotate Crosstab. For details about how to define a crosstab. and so to the Series box. The chart can only be defined based on the view elements listed. .q Changing the crosstab definition 1. In the Crosstab Title text field. q Rotating a crosstab Columns and rows in a crosstab can be exchanged. to customize 2. edit the title of the crosstab. q Converting a crosstab into a chart 1. The Resources box lists all the view elements used in the selected crosstab including group and aggregation objects. to customize the font. You can click the font. Click the Crosstab Wizard button Right-click the icon on the Context toolbar. Click the Rotate Crosstab button Right-click the icon on the Context toolbar. You can click and style of the title. click the Filter button to apply some filter conditions to narrow down data displayed in the crosstab. 5. click OK to apply the modifications. Upon finishing. Right-click the icon of the crosstab and select To Chart from the shortcut menu. and style of the title. Change the fields and summaries used by the crosstab. q Adjusting the width of crosstab fields according to the contents When the contents in the field of a crosstab need more space to completely display. size. This operation is called rotating a crosstab. size. r r of the crosstab and select Rotate Crosstab from the shortcut menu. In the Title text field. first select it. If required. and to the Show Values box respectively. Select the chart and then do either of the following to display the To Chart dialog: s Click Menu > Edit > To Chart. right-click the field and select Auto Fit from the shortcut menu. 4. input a title for the chart. Add a group object from the Resources box to the Category box. Select the crosstab and then do one of the following to display the Crosstab Wizard: s Click Menu > Edit > Wizard. wall. 5. click OK to apply the modifications. then select Chart Wizard from the shortcut menu. To do this. first select the chart. edit the title of the chart. then on the shortcut menu. s s Right-click the icon of the chart or any part of the chart other than the legend and label. see Inserting a chart. refer to the specific format dialog in JReport Studio dialogs. 4. and style of the title. Converting a chart into a crosstab 1. click the Filter button to apply some filter conditions to narrow down data displayed in the chart. X and Y axes. Right-click the icon of the chart or any part of the chart except for the legend and label and click To Crosstab on the shortcut menu. For details about how to define a chart. If required. q Formatting chart elements You can format the chart platform. r Right-click the icon of the chart or any part of the chart other than the legend and label and select Swap Chart Groups from the shortcut menu. 3. In the Title text field. right-click the chart. Upon finishing. You can click size. Swapping chart groups You can switch data between the category and series axes. and gridlines using the corresponding format command on the shortcut menu of a chart. to customize the font. Sorting category/series labels You can sort the labels on the category or series axes of a chart in either descending or ascending alphabetical order. to customize the font. 2. To swap the chart groups. legend. or between the category and value axes of a chart if no field on the series axes. then do either of the following: r q q Click the Swap Chart Groups button on the Context toolbar. Select the chart and then do one of the following to display the Chart Wizard: s Click Menu > Edit > Wizard. Change the group and aggregation objects or the additional values used by the chart.Manipulating a chart q Changing the chart definition 1. select the required order from the Sort Category or Sort Series submenu. floor. paper. Select the chart and then do either of the following to display the To Crosstab dialog: s q Click Menu > Edit > To Crosstab. You can click . Click the Chart Wizard button on the Context toolbar. s 2. For details about the element properties. input a title for the crosstab. In the Chart Title text field. select it and click . In the Label column. click the Chart Options button . Note: Additional values are supported only in chart.size. and style of the title. To adjust the order of group/aggregate fields. it is better to also have the wall shown so as to make the background gridlines more intuitive. then on the Context toolbar. q Showing/Hiding X/Y gridlines Select the chart. left or right position in a chart. select the desired chart type and its subtype. 3. then on the Context toolbar. follow the steps above. . then select/unselect the desired gridlines to show/hide them. click the Chart Options button . . If you want to remove any group/aggregate field. select a group/aggregate field and click 4. To change the legend position. select Wall. q Changing chart type Select the chart. go to the Label submenu. select an aggregation object aggregate field to the Summaries box. select the chart. then on the Context toolbar. or . then on the Context toolbar. click the Chart Type button down menu. When gridlines are shown. From the drop- q Changing legend position in a chart Chart legend can be placed at the top. go to the Gridlines submenu. From the dropdown menu. If you convert a chart with additional values into crosstab. Select a group object in the Resources box and click or to add it as a group field to and click to add it as an the Columns or Rows box. go to the Legend submenu and select the desired position. then on the Gridlines submenu. From q Showing/Hiding labels on the X/Y axis Select the chart. To show the wall. click the Chart Options button the drop-down menu. the additional values are not converted together with the chart. Click OK to finish the conversion. . and the Sort column allows you to specify a sorting manner on a group field. you can edit the label of a group field or aggregate field. From the dropdown menu. Repeat these to add more aggregate fields. bottom. then select/unselect the desired labels to show/hide them. Link to URL Enter the URL in the Hyperlink box if you want to create a link to a web page. Right-click the component and select Edit Link on the shortcut menu. then specify whether to open the URL in a new window. 2. click OK to close this dialog. See also Edit Link dialog for additional information about options in the dialog. after which the trigger object in the primary report can be clicked in order to jump to the linked report to obtain information about the trigger object. when viewing the result. The Edit Link dialog appears. r Link to Report If you create a link to a report. you can view another report by clicking the component.Binding links to components You can bind links to labels. 3. select an object to be the trigger for loading the linked report. Specify the link type to which the component will be linked by selecting the desired type and then set the related options for the type. In the report. Link to E-mail Enter the E-mail address in the Hyperlink box. r r 3. formula fields. . To bind a link to a component: 1. In JReport Studio. 1. and multimedia objects. Link to Report is selected by default in the Edit Link dialog. Create a new web report which will be used as the primary report. parameter fields. DBFields. click Edit Link on the shortcut menu. it is very simple to set up the link relationship between two reports. Linking a report to another report A report can be linked to another report. 2. When done. Right-click the trigger object. images. You can assign fields of the primary report to the parameters. In the Target Component section. 6. to specify which components in the linked report will 7. Select a component in the Target Component box. a. 5.4. and then set link condition for it in the Conditions section. specify the link relationship for each target component. The Target Report Parameters section lists the parameters of the linked report. the field values of the primary report will be assigned to the parameters automatically. Then. click be interlinked with the primary report. when running the linked report from the link. In the Conditions section. . Click the Browse button to specify the target web report you want as the linked report. f. Note that the relationship among these link conditions is AND.b. 9. d. Click to add a condition row. "<>". For example. ">". g. Select an unchecked item and you will be directed to that target. Notes: q When linking reports. q . All fields in the linked report of the same value type as the selected main report field will be available. "<". Choose an operator from the drop-down list in the OP column. Then. you can specify more link conditions by specifying the main report field. That is. Select a field/formula from the drop-down list in the Main column. you will find that the linked report is displayed according to the specified link conditions. which means that JReport will fetch linked report data which meets all of the conditions. click on the toolbar. Specifies whether to have the linked report loaded in a new window. if you have linked report A to report B. c. or "IN". Click OK to apply the settings. The operator can be "=". Specify the field/formula of the linked report from the drop-down list in the Target column. the operator. you need to avoid link loops. The item checked on the drop-down list is the currently opened page. when you click the trigger object in the primary report. Click next to and you will get a drop-down list which lists the original report and the linked targets you have just visited within the link chain. Repeat the above steps to set link conditions for other target components. ">=". The condition specified in the Conditions section is used for setting up the searching criteria between the two linked reports. then you cannot link report B back to report A again. To go back to the original report. and the corresponding field in the linked report. the pages containing the data that meet the condition in the linked report will be displayed after you click the link. when the primary report is opened in HTML. e. "<=". PDF or Excel format. If necessary. 8. Dynamic resources that can be used in web reports include formulas and aggregations. you can create some dynamic resources and use them in the report to get the desired data. To create a dynamic formula: 1. To learn the formula syntax.Using dynamic resources When you add fields to a report. sometimes you may find that the view elements that have been predefined in the business view cannot meet your requirements. in which case. Creating and using dynamic formulas You should have some knowledge of the formula syntax before you can successfully compose a formula with no errors. . In the Resources box of the report wizard. then click <Add Formula…> to display the Formula Editor. expand the Dynamic Resource > Formulas node. refer to Formula syntax in the JReport Designer User's Guide. Then when you save the report. the dynamic resources will be saved along with the report as its resources. Compose the formula by selecting the required fields. 3. functions and operators from the Fields. Functions and Operators boxes.2. Enter a name for the formula in the Formula Name text field. You can also write the formula by yourself in the editing box. . If a field has the display name Category. when adding it to a formula. "+". "%". global variables are not supported in dynamic formulas. the names should not contain any of the following characters if the names are not quoted by double-quotation marks "": "~". refer to Built-in functions and Operators in the JReport Designer User's Guide. "&". "\". "*". ". you can then drag it from the Resources panel to the desired position in the report as a detail object. right-click the formula and then click the corresponding command on the shortcut menu. "`". "}". click the OK button to create the formula. "^". " ' ". "$". Currently. Notes: q You can only save a formula with no errors into a report.Aggregation. r Once a dynamic formula has been created. "<".". "\\". 4.". then click <Add Aggregation…>. Click the Check button to check whether or not the syntax of your formula is correct. detail objects in the current business view and the dynamic formulas that have been created in the report. ":". When done. ". "-". When formulas reference display names or mapping names. "{". if you want to further edit an existing dynamic formula or remove any formula that is not required. "[".For details about the functions and operators.". "!". "/" Examples: r q q Expression @Customer#. expand the Dynamic Resource > Aggregations node.Aggregation" or "Category". . But @"Customer#" is ok. "(". you can also create dynamic aggregations by mapping them to the available resources such as group objects. "#". In the Resources box of the report wizard. "?". "|". "@". "=". To create a dynamic aggregation: 1. You can then use the formula in the report. will cause a syntax error. 5. Also."Aggregation". ". ">". quote it as "Category. The Add Aggregation dialog is then displayed. ")". "]". Creating and using dynamic aggregations In JReport Studio. or use it when working with the report wizard. 3. You can then use the aggregation in the report Once a dynamic aggregation is created. . or use it when working with the report wizard. When done. specify the display name of the dynamic aggregation. And if you want to edit any dynamic aggregation or delete it. specify the aggregate function. Click the chooser button next to the Resource Name text field to specify the field on which the dynamic aggregation is based. From the Aggregate drop-down list. In the Aggregation Name text field. you can then drag it from the Resources panel to the desired position in the report to see the desired data. 4. click OK to create the dynamic aggregation. 5. right-click the aggregation and click Edit or Delete on the shortcut menu.2. Going through the report data In a web report. Decaf for example. and the new report created by going can also be viewed. After a going action has been performed. and applied the default style to the crosstab. q Automatic going actions are performed on tables and crosstabs. . Go-to 1. and exported to other format in the same way as the original report. The crosstab shows as follows: We will now take the crosstab as an instance to illustrate the automatic going functions. showing only the records in the selected group. Right-click any value of Product Type. This section presents two kinds of going in web reports. the data presented in the component will be re-loaded from the data buffer. They are: q Automatic going Going to detail q Automatic going Automatic going enables you to switch from the current group to another group by using systemdefined commands on the shortcut menu. Go-to-by-value It enables you to filter data based on a go-to action so as to obtain a more detailed view of the data. Assume you have created a crosstab report on the business view WorldWideSalesBV in Data Source 1 of the SampleReports catalog showing product sales information with Product Type (ascending) as the column field. Category (ascending) as the row field. printed. and choose Go To from the shortcut menu. and it is divided into two kinds: q Go-to It enables you to obtain a different view of data by switching among groups. and switch among the groups to see the data you want. The list of groups available for Go To will appear on the submenu. you can choose to show certain groups of records according to your requirements. and Total Sales as the summary field. Go back to the original report in the above example. right-click any value and then click Go To > Product Type on the shortcut menu. 3. A submenu for the command is displayed. Right-click the value Decaf of the Product Type group. To return to the original status. Go-to-by-value 1. 2.2. Click Region too and the result will be regenerated. then in the regenerated result. 3. and point to Go to By Value on the shortcut menu. Click Region on the submenu. we can see that Category remains the group for rows and Region becomes the group for columns. which lists the same items as those of Go To. . Note: If the table type is Group Above. To define the detail table for a summary and perform the go-to-detail action on it: 1. This is because that. you will get the table displaying the fields you defined and having applied the filter condition Country=France. and click Product Type on the submenu. To go back to the original report. the group of columns changes to Region by the Product Type value Decaf. which shows the group and the value the filter is based on. First define a table and make it contain the information you would like to view about the summary values. you have to right-click the group name in group column to perform automatic going. first delete the filter in the Go to Filter panel. For other table types. 4. then right-click any value of Region. 2.We can see that the result is different from that of go-to. on the basis of the go-to action. Going to detail Go-to-detail action is performed on the summary of the tables. choose Go To from the shortcut menu. for the go-to-byvalue action. In addition. you can right-click its group header to show the shortcut menu so as to use the automatic going function. add the fields you want to display in the detail table of the . Right-click any summary value and select Edit Detail Table from the shortcut menu. Suppose that the summary is total sales in different countries. when a go-to-by-value action is performed. the Go to Filter panel will be displayed on the left of the JReport Studio window. In the Edit Detail Table dialog. When you go to detail of the total sales in another country. and thus the result of go-to-by-value is generated. a filtering action where Product Type = Decaf is further performed. That is. the table will display the data of that country. Then when you perform go-to-detail action on the value of total sales in France. crosstabs and charts. summary. To go back to the original report. Right-click a summary value of which you would like to view the detailed information. 4. 5. 3. Click OK. The detail table for the summary value will then be displayed. click on the toolbar. which shows the fields you have defined. . then click Go to Detail on the shortcut menu. As the name suggests. Applying filters to business views When creating web reports. select the business view that you are going to add filters to from the Data Source drop-down list. crosstabs and charts of a web report so as to narrow down the data displayed in the web report.Applying filters You can apply filters to business views and data components such as tables. 1. The Query Filter dialog is displayed. and user defined filters are created on business views while they are used. . In the Bind Data screen of the JReport Studio Wizard or in the report wizard. and then click the Filter button on the right. filters for business views are defined into two categories: predefined filters and user defined filters. you can choose to apply some filter to the specified business view to narrow down the data scope of the data component using the business view. predefined filters are defined in advance when creating or editing the business views in JReport Designer. In JReport Studio. Filters can be applied to a business view in the report wizard. and then define the filter according to your requirements. The dialog has the basic and advanced modes for you to define a filter using either simple expressions or complex expressions. e. Type the values of how to filter the field in the value text box. click the Add Condition button and define the expression as required. If you prefer to define a filter on your own. or select one or more values from the drop-down list. e. If you want to add another condition line. From the field drop-down list. You can also edit a predefined filter if required and save it as a user defined filter to the business view. then define the expression as required. set the operator with which to compose the filter expression. select them and click the Group button. From the operator drop-down list. It is the equivalent of adding parenthesis in a logic expression. from the logic operator drop-down list. b. To take any condition or group in a group out. To group some conditions. d. Click the Add Condition button to add a condition line. . select the field on which the filter will be based. Make sure the dialog is in the basic mode. f. Repeat the above steps to add more filter expressions if necessary. To delete a condition line. or OR NOT. b. Select the field on which the filter will be based from the field drop-down list. r To define a filter using simple expressions: a. on its left. To add a condition line of the OR relationship with the current line. d. g. Conditions and groups together can be further grouped. set the operator with which to compose the filter expression. Type the values of how to filter the field in the value text box. select it and click Ungroup. The logic can be AND. From the operator drop-down list. To add another condition line. select AND. you can also choose to apply a predefined filter of the specified business view from the Query Filter drop-down list. click r To define a filter using complex expressions: a.2. c. c. OR. then the selected conditions will be added in one group and work as one line of filter expression. select OR. Then click the logic button until you get the required logic to specify the relationship between the two filter expressions. s Repeat this to add more filter expressions if required. then define the expression as required. Switch the dialog to the advanced mode. select User Defined from the drop-down list. When it is in the advanced mode. AND NOT. s To add a condition line of the AND relationship with the current line. or select one or more values from the drop-down list. The Filter dialog is . 3. you can only make the filter applied to a specific data component in the current web report. To delete a condition line or a group. Filtering report data There are the following ways you can take in order to filter components in a web report: using the Filter dialog. on the Standard toolbar. using the Filter panel. using the Filter web control. you can apply a filter to the business view the component uses and it will not affect other components based on the same business view. Note: Query filters take effect on the component level. select it and click the Delete button. Click Menu > Edit > Filter. which means each time you create a component. or the Filter button displayed. so that your report will get data that meets the filter condition only. or via shortcut menu. Using the Filter dialog When using the Filter dialog to filter report data. select it and click the Up or Down button. the specified filter will be applied to the business view. After you finish the report wizard.To adjust the priority of a condition line or a group. To filter report data using the Filter dialog: 1. You can click the Inspector button to view the detailed filter information.2. click OK to apply the filter. Using the Filter panel . Define the filter using either simple expressions or complex expressions. select the component in the web report to which you want to apply the filter. From the Apply to drop-down list. The Filter dialog provides an entry to all the filters used in the current web report except query filters. 4. When done. 3. The value selection applies a filter condition and the logic is as follows: q For one value selection: Selected_Field=Selected_Value For example. . The selected values applies a filter condition to all the data components in the current report that are using the same business view. (Country=USA or Country=China) and (Year=2008 or Year=2009) The following shows more about working with the Filter panel: q You can use the buttons on the bottom of the Filter panel to deal with the value selection in the panel. Add group and detail resources into the Filter panel by clicking + on the panel title bar. For example. Select the values you would like to filter the report data. regardless whether the data components contain the fields holding those values. Group and detail objects can be selected from the business views used by current report.The Filter panel on the left of JReport Studio is used to filter data components in the current report that are using the same business view. Country=USA q For multiple selection: (Selected_Field1=Selected_Value1 or Selected_Field1=Selected_Value2) and (Selected_Field2=Selected_Value3 or Selected_Field2=Selected_Value4). Each added group/ detail and its values are housed in a separate box. You can make use of the Ctrl or Shift key to do multiple selection.. 2.. To do this: 1. these options are available for managing the group/detail object. s s . and refreshes the report data accordingly. X Closes the quick search toolbar. s Highlight All Specifies whether to highlight all matched text. You can also use the button quick search toolbar. on the group/detail name title bar to launch the The following are details about the usage of the quick search toolbar: s Text field Type in the text you want to search for in the text field and the matched text will be highlighted among the group/detail values. r r q After right-clicking a group/detail name title bar. Clear Removes all the value selection histories and all the filter conditions based on the selections.r Back Goes back to the previous value selection status and refreshes the report data accordingly. Match Whole Word Specifies whether to search for text that matches a whole word as the typed text. Forward Goes forward to the next value selection status and refreshes the report data accordingly. Match Case Specifies whether to search for text that meets the case of the typed text. s s Lists the advanced options. r Search Displays the quick search toolbar right above the group/detail box which enables you to search values in the group/detail object. When there are filter controls. You can also use the button detail name title bar to achieve this. and when these controls' fields have cascading relationship. on the group/ r Clear All Cancels the selection of all values in all the group and detail objects. there is a filter control based on the field Country. r Clear Cancels the selection of a value in the group/detail object. the cascading relationship will be revealed when you select values in the controls. You select USA in the Country filter control. But the State values remain as before. Using the shortcut menu You can also use filter-related commands on the shortcut menu to filter the data in a table. Sort Sorts the values in the group/detail object in the ascending or descending order. Clicking this item will remove all filters . To do this. s Highlights the previous matched text. For details. You can also click X on the group/detail name title bar to remove it. a filter control on City. In both cases all the values are selectable. You will see the Filter item which provides a submenu containing the following commands: q Remove Filter This command is enabled after you have applied filtering on the field. still under the circumstance of using the same data source. that apply to the same data components. point to any value of the field by which you want to filter data. then right-click to show the shortcut menu. but State values will not participate. Using filter controls You can also use the Filter web control to filter one or more data components that use the same data source in a web report. since the selection of them will not affect the data components that the Country and City filter controls control. Country and City values will show cascading relationship. The first two share one table while the third shares nothing with the other two.s Highlights the next matched text. and the other cities are put in the lower area and grayed out. r r Note: The filters created via the Filter panel cannot be seen when web reports are opened in JReport Designer. For the case that the City filter control has no scrollbar: all the values remain their positions and the values not belonging to USA are grayed out. In this case. For example. the values in the City filter control will change as follows if the control has scrollbar: the cities belong to USA are displayed in the upper area of the filter control. including the special ones in the Filter panel. and another on State. see Using filter control to filter report data. A filter control can do filtering based on one field. Delete Removes the group/detail object from the Filter panel. Cascading relationship among filter controls The Filter panel can be regarded as a collection of special filter controls which apply to all data components using the same data source. While common filter controls can choose the data components they apply. then only the records with the field value equal to one of the last five field values will be displayed. if you select 5 from the Last N submenu for a certain field. if you select 5 from the First N submenu for a certain field.on this field. q First N Shows the First N item with which you can filter data to display records that meet the First N condition. You can select a number from the submenu or enter a positive integer into the text box on the submenu to specify the First N condition. For example. You can select a number from the submenu or enter a positive integer into the text box on the submenu to specify the Last N condition. You can select one value in this dialog. More This command is enabled if the Filter submenu cannot list all field values. q Field values "Field values" is not the name for a command on the Filter submenu. q Last N Shows the Last N item with which you can filter data to display records that meet the Last N condition. q . but represents some items which are the values of the field you have right-clicked. Selecting any field value listed here will make the table only display records with the field value equal to the selected one. then the table will only display records with the field value equal to the selected one. then only the records with the field value equal to one of the first five field values will be displayed. When it is enabled. For example. clicking it will show the Select Values dialog. Drag Parameter Control from the Components panel to the destination in the report. r The Insert Parameter Control dialog is displayed. parameter form control. To insert a parameter control and use it to specify a parameter to a report: 1. then point to the destination where you want to add the parameter control and click the mouse button. By specifying values to the parameter in a parameter control.Using web controls In JReport Studio. This section describes each of the web controls and how to use them. Do either of the following: r Click Menu > Insert > Parameter Control. you can pass the parameter values to JReport and run the report with the specified values. Using parameter control to specify a parameter to a report A parameter control is a web control that is bound with a parameter used by the current report. Parameter controls do not support inserting cascading parameters. use parameter form controls instead. filter control. these four types of web controls can be applied: parameter control. and navigation control. . If you want to do this. Using the calendar button Time. r r r Selecting or unselecting the checkbox to specify a Yes/No value. Once the value in the parameter control changes. Using the button to specify multiple values for the parameter in the Enter Values dialog. A parameter control will be added into the report. 3.2. There are the following ways to specify parameter values according to the appearance of the parameter control which varies with the type and properties of the selected parameter: r Typing in the parameter values if the text field is editable. the report will rerun with the new parameter . or DateTime type. r 4. to specify a value using the calendar if the parameter is of Date. Selecting a parameter value from a drop-down list. then click OK. Select the parameter you would like to add to the parameter control. select Current Report. Drag Parameter Form Control from the Components panel to the destination in the report.value. then point to the destination where you want to add the parameter form control and click the mouse button. r The Insert Parameter Form Control dialog is displayed. Do either of the following: r Click Menu > Insert > Parameter Form Control. Using parameter form control to run reports A parameter form control is a web control that is bound with the parameters used by the current report or other reports. Specify the target reports to run using the parameter form control. you can make the reports run with the specified parameter values. r To run the current report. the parameter control will become invalid. Note: If the specified parameter is no longer used in the report. then specify the parameters used to run the . 2. By specifying values to the parameters in a parameter form control. To insert a parameter form control and use it to run reports: 1. . Click OK in the dialog to save the changes. the change of values in the parameter form control will trigger report rerunning. the new values will be applied automatically. Drag Filter Control from the Components panel to the destination in the report. you cannot finish the dialog. Click the Submit button if present to run the current report or the specified reports. it is used to submit the parameter values you specified in the parameter form control. In the parameter form control. and crosstabs. specify values of the listed parameters. If Submit is included. Specify whether to include the Submit button in the parameter form control. All the parameters used by the selected reports are displayed in the Parameter Information box. It lists the selected parameters for the current report or lists all parameters used by the specified reports. the reports that you bind the parameter form control with will not be saved or published along with the report. 5. Using filter control to filter report data A filter control is used to filter one or more data components. If all the selected reports contain no parameters. If Submit is not included. 6. The parameter form control is now inserted in the report. To insert a filter control and use it to filter report data: 1. then point to the destination where you want to add the filter control and click the mouse button. r The Insert Filter Control dialog is displayed. If there is no Submit button. which refer to tables. Do either of the following: r Click Menu > Insert > Filter Control. 3. once you change the values of a parameter in the parameter form control. then select the reports you want to run. 4. in a report using the same data source. r To run other reports. Note: If you save or publish a report containing a parameter form control to another directory.report from the Select Parameters box. select Others. charts. you can also insert a navigation control for undoing/redoing the value selection in the filter controls. Specify the fields of the same type on which the filter control is based from the resource list in the Select Fields box. After inserting filter controls in the report. When done.2. 3. . see Using navigation control to undo/redo value selection in filter controls. Select the data components you want to apply the filter control to from the Apply To drop-down list. click OK. It lists all values of the specified fields. 4. You can select one or more values to apply. The filter control is inserted in the report. For details about the usage of navigation control. Match Case Specifies whether to search for text that meets the case of the typed text. on the title bar of the filter control to launch the The following are details about the usage of the quick search toolbar: r Text field Type in the text you want to search for in the text field and the matched text will be highlighted among the field values. s s r Highlights the next matched text. s Highlight All Specifies whether to highlight all matched text. . Match Whole Word Specifies whether to search for text that matches a whole word and ignore partial word matches. X Closes the quick search toolbar. You can also click outside of the quick search toolbar to achieve this. these options are available for managing the filter control.Managing a filter control After right-clicking at the upper left corner of a filter control. q Search Displays the quick search toolbar right above the filter control which enables you to search values in the filter control. You can also click the button quick search toolbar. r r Lists the advanced options. since the selection of them will not affect the data components that the Country and City filter controls control. a filter control on City. Clear q . but State values will not participate. For example. Country and City values will show cascading relationship. For the case that the City filter control has no scroll bar: all the values remain their positions and the values not belonging to USA are grayed out. and another on State. But the State values remain as before. q q q Cascading relationship between filter controls When there are filter controls that apply to the same data components. In this case. and when these controls' fields have cascading relationship. To insert a navigation control into a report. q A navigation control is a combination of three buttons: q Back Goes back to the previous value selection status and refreshes the report data accordingly. the values in the City filter control will change as follows if the control has scroll bar: the cities belong to USA are displayed in the upper area of the filter control. Clear q Cancels the selection of values in the filter control. The first two share one table while the third shares nothing with the other two. Hide Hides the filter control. In both cases all the values are selectable. You can also use the button cancel the selection. q on the title bar to Sort Sorts the values in the filter control in the ascending or descending order. there is a filter control based on the field Country. Delete Removes the filter control from the report and the filter you created with the filter control will be removed from the report too. This operation can be undone/redone. Using navigation control to undo/redo value selection in filter controls A navigation control can be considered as an accessorial control for filter controls and used to deal with the value selection operations in all the filter controls in the same report. You select USA in the Country filter control. Drag Navigation Control from the Components panel to the destination in the report. then point to the destination where you want to add the navigation control and click the mouse button. You can also use the X button on the title bar. do either of the following: q Click Menu > Insert > Navigation Control. the cascading relationship will be revealed when you select values in the controls. Properties Opens the Filter Control Properties dialog for editing the properties of the filter control.r Highlights the previous matched text. and the other cities are put in the lower area and grayed out. and refreshes the report data accordingly. .Removes all the value selection histories and all the filter conditions based on the selections. q Forward Goes forward to the next value selection status and refreshes the report data accordingly. 2. parameter field. and summary field. To add conditional formats to a field: 1.Adding conditional formats to fields You can add some conditional formats to a field in tables or crosstabs. the defined format will be applied to the field values for highlighting. formula field. Click the button to open the Edit Conditions dialog to define a condition using either simple expressions or complex expressions according to your requirements. The newly added condition will then be displayed and highlighted in the Condition box in the . then when the specified condition is fulfilled. 3. which refer to the DBField. Right-click the field and select Conditional Formatting from the shortcut menu to access the Conditional Formatting dialog. select the condition in the Condition box and click . etc. . or To adjust the priority of a condition. edit the expressions as required. 5. See also Conditional Formatting dialog and Edit Conditions dialog for details about options in the dialogs. the font face.Conditional Formatting dialog. select the condition in the Condition box and then click . Click OK to apply the conditional formats to the field. font size. In the Format box. set the format which will be applied to values of the field when the specified condition is fulfilled. font color. To edit a condition. In the Edit Conditions To remove a condition and the corresponding format. . for example. Repeat the above steps to add more conditions and define the format for each condition as required. 4. select the condition in the Condition box. 6. then click dialog. see Using parameter form control to run reports. you can pass the parameter values to JReport and run the report with the specified values. It lists all the parameters used by the current report. bind it with one or more parameters used by the report. You can specify values to the parameters in the Parameter panel and then click Apply to make the report run with the specified parameter values. After the report is opened in JReport Studio. By specifying values to the parameter in the parameter control. For details. . you can make the report run with the specified parameter values. you can change the parameter values using the following ways. Using parameter form controls You can insert a parameter form control. Using the Parameters panel The Parameters panel is available when the current web report uses parameters. a dialog is displayed for you to specify parameter values. Using parameter controls You can insert a parameter control and bind it with a parameter used by the current report. For details.Applying parameters When running a web report with parameters. make it run the current report. see Using parameter control to specify a parameter to a report. By specifying values to the parameters in the parameter form control. . Sorting groups at a group level: Changing the order of groups at the specified group level. q To sort data on a certain field using shortcut menu: 1. Choose the command Sort > Ascend or Sort > Descend from the shortcut menu. q Sorting records: Changing the order of records in the whole table. If what you right-click in Step 1 is a detail field value. and then right-click. crosstab or chart. crosstab or chart. 2. click Sort > No Sort from the shortcut menu. the sorting will affect the order of detail records in the table. if it is a group field value. crosstab or chart. the later sort condition will replace the former one. crosstab or chart.Sorting report data You can sort the records or groups at a certain group level in a table. To remove the sort condition on a field. Note: If you use the shortcut menu to sort the report data by a field and then sort by another field. or in each group if there are. that is. Point to any value of a detail field or group field by which to sort the data in a table. the groups will be sorted by value of the group field. the order of groups in the group level represented by the group field will be rearranged. all components in the report will take a uniform appearance. Applying a style to a report When a style is applied to the whole report. q Applying a style to multiple components You can apply a style to multiple selections of tables. or to the multiple selections of these components.Applying CSS styles CSS styles can be applied to web reports formatting their appearance and characteristics. or chart by selecting the component in JReport Studio and then doing one of the following: q Select a style from the Report Style list on the Edit menu. crosstabs. . q Applying a style to a component You can apply a style to a table. or chart. crosstab. Reference: See also the chapter Styles in the JReport Designer User's Guide for more information about CSS styles. You can apply a style in one of the following ways: q Specify a style in the Style page of JReport Studio Wizard. then select a style from the Report Style list on the Edit menu. and charts by selecting the components and then selecting a style from the Report Style list on the Edit menu. The last style always takes effect when more than one style is applied to the same object. crosstab. When you publish your catalogs to JReport Server. Right-click and then select a style from the Apply Style list on the shortcut menu. click the blank area outside of the report field. In JReport Studio. you can include these custom styles with the catalogs. Styles can be applied to a table. or to the whole report. You can create and set up your own CSS styles in JReport Designer or any other CSS editor. . In the Save in section. browse to the folder where you want to save the web report in the server resource tree. If the report is newly created and has not yet been saved. click Menu > File > Save (or the Save button Standard toolbar). the Save As dialog will be displayed. on the 1.Saving the report To save the changes you made to the current report. and then do as above. the saved report will run with the latest version of the catalog. The default file type is web report. 4. From the Catalog drop-down list. Set Catalog Copy to Target Folder If checked. Optionally. To save a copy of a report. s d. input comments in the Description box as a description for the report. Note: You will not be able to save the report to some locations if you do not have the required permissions. click Menu > File > Save As (or the Save As button show the Save As dialog.You can use the button to return to the parent folder. specify a status for the report. . If later the catalog is updated. the catalog will be copied to the directory where the report is saved and the saved report will run with the copied catalog. Specify the relationship between the saved report and the catalog used to run it: s Set Original Catalog as Linked Catalog into Saved Report If checked. From the Status drop-down list. and then click the Web Report Versions tab. Click Save to save the report. enter the name of the report or use the default name. a. 3. on the Standard toolbar) to To find a newly saved web report version. In the File Name box. b. Click the Advanced button to set the advanced settings for the report if required. the saved report will be linked with the catalog and will run with the catalog no matter whether the two are in the same directory. select the catalog for the report. You need to have Write access to the directory. c. browse to select the row that the web report is in on the JReport Console > Reports page. 2. click Tools > Version on the task bar. 1. Text. From the Select Report Result Format drop-down list. you may want to export it to other formats or have it printed. . Exporting the report result You can export the report result as a result version or as a local file in these formats: HTML. and PostScript. Click Menu > File > Export (or the Export button dialog. RTF. Excel. XML. select a format in which to export the result.Exporting/Printing the report result When you finish editing a web report. PDF. on the Standard toolbar) to display the Export 2. Click Menu > File > Print (or the Print button on the Standard toolbar) to display the Print dialog. Printing the report result You can print the report result to a PDF/HTML file. the page range and copies you want to print. . Click OK to confirm. you need to provide a name for the result file in the File Name field. r r 4. If selected. see Export dialog. otherwise it will prompt you to save the result file. For details about settings of each format. 5. In the Appearance tab. Save to File System: The web browser will prompt you to save the result file to a specified folder. In the General tab. Save to Version System: The result will be saved as a result version in JReport Server's versioning system. To print the result of a web report: 1. 2. 3. Specify the destination of the result: r View Report Result: The result will be directly opened in the web browser if the format is supported by a plug-in of the web browser. Expand More Options to set the options for the selected format.3. specify the printer properties. specify the appearance of the printed report as required. See also Print dialog for additional information about options in the dialog. . Click OK.4. The PDF/HTML result file will be opened in an associated program with which you can print the result to a printer. All the parameters are encapsulated as JSON (JavaScript Object Notation) objects. . it will help if you obtain some knowledge on JSON to understand the syntax more clearly. which are listed as follows: q Directly running A web report cannot run in DHTML or Applet format. but one more format is provided: Studio Result. // Optional: The report version. q q You can refer to the following topics for reference about running and scheduling a web report: q Running reports Scheduling reports q Opening web reports in JReport Studio via URL JReport provides parameters for developer users to run web reports via URL. // Optional: The catalog version. However. // The full path of the web report. Advanced running A web report cannot run in DHTML or Applet format. If the Default Format for Viewing Report property of a web report is set to DHTML or Applet. there are some differences. which is a static web report result marked as WST file. "ver":"-1". } q jrd_catalog={ "name":"xxx". -1 means the latest version. by choosing which you can run the web report in JReport Studio. // The full path of the catalog that the web report uses. The following lists the parameters for running web reports via a URL: q jrd_report={ "name":"xxx".Running web reports on server Just like page reports. When composing the URL. web reports can run using the following ways. -1 means the latest version. Therefore. however. one more format is provided when you run a web report in Advanced mode: Studio. "ver":"-1". the web report will run in JReport Studio by default. Scheduled running The results of a web report cannot be published to JReport Result or DHTML formats. you need to use URL encoding to avoid errors. // One or multiple data sources can be included at a time. // The encoding for running reports "resolution":"96" // The resolution for displaying reports } q jrd_datasources=[ // Optional. following locale naming specification "encoding":"UTF-8". // User name "country":"us". jdbc. "url":"xxx". For example. 4 .OracleDriver". // The locale representing the language part for running reports.} q jrd_param$={ "p1":"v1". // Indicates the data source type. "p2":["v1".driver. { // JDBC data source "ds":"Data Source 1".0. // p1 is parameter name. // The following types of external data sources are supported: 0 . "driver":"oracle. // JDBC URL. }.ResultSet object. "user":"xxx". // 2 .1:1521:ora8i".Connection object. { .JDBC data source."v3"] // For multiple values } q jrd_userinfo={ // Optional. // Data source name "uid":"xxx". and v1 is p1's value. For example. // DB user name "pwd":"xxx". "url":"jdbc:oracle: thin:@127.Java DataSource object.0."v2". following locale naming specification "language":"en". // The locale representing the region part for running reports. "driver":"xxx" // JDBC driver. 3 . // DB user password "type":"0". // java."type":"0". // Indicates the data source type. you need add the property "real":"true" for the path.sql. // // Then the key would be that "key":"Rst".jsp as follows: // // String key = "Rst". "key":"xxx" // Request attribute object name."ver":"1". // Data source name "type":"2/3/4". you can make use of jrs commands and jrs."key":"xxx"}] If you use absolute resource path."pwd":"xxx".result_type which is used to specify the type: . then the attribute // key is the one defined in the request.wls"."type":"2".setAttribute("Rst".cat"."ver":"-1"}&jrd_datasources=&jrd_catalog={"name":"/SampleReports/ SampleReports. // "ds":"Data Source 2". rst). It also applies to the other two types. write user.cat". For example.jsp?jrd_report={"name":"/SampleReports/ studioreport."ver":"-1"}&jrd_param$={"P_Coutry":"USA"}"xxx"}."real":"true"} Running web reports to other formats via URL To run a web report to other formats than to JReport Studio."driver":{"ds":"Data Source 2"."uid":"xxx". // rst = // get result set object from user own business logic // request."real":"true"}&jrd_catalog={"name":"C:\JReport\Server\jreports\SampleReports \SampleReports. jrd_report={"name":"C:\JReport\Server\jreports\SampleReports\studioreport.ResultSet rst = null."url":"xxx". // For example.[{" ds":"Data Source 1"."ver":"-1". // The above example is based on ResultSet object.// Java DataSource object/Connection object/ResultSet object. included in request or session } ] Here is an example of the complete URL without URL encoding to make it easier to read: http://localhost:8888/webreport/studio/entry/run.wls". // Users should define request or session attribute. catalog=%2fSampleReports%2fSampleReports.report=% 2fSampleReports%2fProducts. to run a web report to PDF: http://localhost:8888/jinfonet/runReport.cat&jrs.wls&jrs. result_type=2 .jrs.cmd=jrs.jsp?jrs.web_vw&jrs.result_type=1 (HTML) or 2(PDF) or 3(Text) or 4(Excel) or 5(PostScript) or 6(Rich Text) or 7(XML) For example. tables. If you do not have a JDashboard license please contact your Jinfonet Software account manager to obtain a license. see Library Components in the JReport Designer User's Guide). etc. . Within a dashboard. and Google maps. what data sources to use. and then published to the component library on JReport Server for use when creating or modifying dashboards. edit and browse dashboards from the JReport Console using JDashboard. what styles to set.JDashboard JDashboard is a new way of information delivery. without having to know how these objects were created. A dashboard can hold multiple library components so that when browsing the dashboard users are able to see multiple data aspects. library components are able to communicate with each other via the message mechanism. using a user portal user interface rather than a web report or page report. crosstabs. Library components are created using JReport Designer (for details. This chapter covers the following topics: q JDashboard basic concepts JDashboard window elements Creating dashboards Inserting components General operations in JDashboard Manipulating data components Filtering component data Saving dashboards Setting JDashboard home page q q q q q q q q Note: A JDashboard license is required in order to use JDashboard and all the related features. With pre-built library components. This allows actions such as common filters to be applied to all the components of a dashboard even when coming from different data sources. Since predefined containers are used for holding objects. it is easy to move objects around and resize them in dashboards. Library components are the basic members in dashboards for presenting data via intuitive components such as charts. users can freely choose the objects they want to display in the dashboard. Users can create. in this sense. The sending and receiving of messages between library components are defined in JReport Designer. The contents of library references in dashboards cannot be edited since they are referenced resources. q Message The information that one library component can send to another. you are not copying the component from the library. Local mapping table The local field mapping table in one dashboard that can be accessed and manipulated by authorized end users. and Google maps. special fields. Field mapping table Centralized alias table in JReport Server used for library components to interpret messages correctly. Dashboard A workspace window that can contain any number of library components. tables. and filter controls. There are two mapping tables: q Global mapping table The global field mapping table for all dashboards that can be accessed and manipulated by administrators. Component library A component library is used to manage library components on JReport Server. and then are published to the component library on JReport Server for use in dashboards. sliders. The library is a logical concept instead of a physical node. Library components are created and edited using JReport Designer. Library components that have been published to the library are available for use when creating or modifying dashboards. but instead referencing it from the library. They are able to present data via intuitive components such as charts. Objects from the Toolbox In addition to library components users can select objects from the Toolbox such as labels. the changes to the component in the library will be reflected in all of the dashboards referencing the component. crosstabs. q .JDashboard basic concepts The following shows the main JDashboard concepts: Library components Library components are used to build dashboards. images. q Components from library When inserting a library component from the component library into a dashboard. Menu and toolbars After JDashboard is opened in a web browser. The changes to the library component in the library will be reflected in all of the dashboards referencing the library component. version updated.JDashboard window elements JDashboard is opened in a web browser. Dashboard name tab Shows the names of opened dashboards. such as removal of library components. You can insert the same library component repeatedly to the same dashboard body. The grids are hidden by default. Library components inserted to dashboards are references of the library component in component library. Dashboard body lays out library component using grids. q q q . images. permission changed. only when users performing actions like dragging will they be shown. Rename a tab. Body can contain library components only. Dashboard view Dashboard view has header and body. Clicking x beside a dashboard name will close the dashboard. After typing a new name. Move a tab. the following will be available for editing dashboards: q One toolbar at the top One side bar on the left by default One menu hidden by default q q Toolbar The toolbar at the top contains dashboard name tabs. press Enter or click outside the input field to save the name. The following are operations on the tabs: q Click a tab to activate the corresponding dashboard. and special fields such as Print Date and User Name. Dashboard header can contain labels. and after users dropping objects the grids will become hidden again. Double-click a tab name to enter the editing mode. Drag a tab and drop it beside a different tab so as to change the tab order. and Special Field can be inserted in dashboard header. Dashboard Title. while Slider and Filter Control in dashboard body. The panel lists the objects that can be inserted in dashboards. Image. The panel contains the resources in the component library. These objects are editable in dashboards. You can select a library component in the panel and drag it into the dashboard body. By double-clicking a dashboard in the panel you can open it. The panel contains the resource view of dashboards with folders. Label. Side bar The side bar on the left contains these buttons: The Dashboard button is the entry to the Dashboards panel. The Component button is the entry to the Components panel.Adds a new dashboard in the current web browser. . The Toolbox button is the entry to the Toolbox panel. q q q q q The Dashboards and Components panels have a toolbar and the buttons on it are as follows: q The arrow button directs you to the parent folder. click the Toolbox button. Menu The menu options are available after you click New on the side bar.Refreshes the current dashboard. therefore the change to one panel's height. Displays the menu options. beside the arrow button provides a general view of all available folder resources in a tree structure. there will be a scrollbar appearing on the right. this will make the panel position fixed and unmovable but can be resized. After a panel is open. Components. The Dashboards. and position will be reflected in the other two panels. By selecting a folder you will open the folder in the panel. and Toolbox panels share one panel window. Drag the title bar to move the panel. Click the Pin icon on the title bar to make it vertically positioned. q The . Use it to scroll resources vertically. bottom border. . They also share the following common usages: q Drag the right border. to close the Toolbox panel. width. Double-click a folder to open it. For example. or bottom right corner to resize the panel... When the panel cannot hold all resources. you can close it by clicking its button. Open Opens another dashboard. Save As Saves the dashboard as another one. Component Title Bar Customizes the way of showing component title bar and the icons on it. Themes Applies a theme to the current dashboard. Set as Home Page Sets the current JDashboard page as home page after logging onto JReport Server using the dashboard port. . Exit Exits JDashboard. Save Saves the changes made to the current dashboard. Help Displays the JDashboard help documents.Creates a new dashboard. you can drag. hover the mouse cursor on the border right below the dashboard name tabs. and special fields like Print Date and User Name via the Toolbox panel. In the header you can insert labels. To make the header border shown. On the JReport Console > Reports page. To unfold the header. then a dotted line appears and the cursor changes into a double-arrow icon. 2. images. A blank dashboard will be created. Illustration 1: When the two-arrow icon appears. you need to unfold it before inserting any components into it. By default the dashboard header is folded. . Illustration 2: Drag the border to a lower position. press the Ctrl button on the keyboard. The area above the dotted line is the dashboard header. click New Report > Dashboard. and you will see the dotted line.Creating dashboards To create a dashboard: 1. Drag the dotted line downward to a lower location. . For details see Inserting components.3. In the body you can insert library components via the Components panel or insert sliders and filter controls via the Toolbox panel. Click the Component button on the left to display the Components panel. the changes to the component in the library will be reflected in all of the dashboards referencing the component. The contents of library references in dashboards cannot be edited since they are referenced resources. click the Toolbox button on the left to display the Toolbox panel. The area above the dotted line is the dashboard header. 2. and insert sliders and filter controls into dashboard body. in this sense. From the Toolbox panel you can insert labels. Inserting an image Images can be inserted in the dashboard header. Browse to find the library component you want to insert. From the panel drag Label to the destination in the dashboard header. To do this. Drag the dotted line downward to a lower location. 2. and two special fields User Name and Print Date into dashboard header. To do this. It can be inserted in the dashboard header. By default the dashboard header is folded. From the panel drag Dashboard Title to the destination in the dashboard header. From the panel drag Image to the destination in the dashboard header. 1. The Insert Image dialog . To unfold the header. Click the Toolbox button on the left to display the Toolbox panel. then drag it to the destination in the dashboard body. Inserting a dashboard title A dashboard title is a special label.Inserting components You can insert components into dashboards via two left panels. click the Toolbox button on the left to display the Toolbox panel. Inserting a label Labels can be inserted in the dashboard header. From the Components panel you can choose library components available in the component library and reference them into dashboard body. you are not copying the component from the library. The following shows inserting a specific component in detail: Inserting library component references When inserting a library component from component library into a dashboard. but instead referencing it from the library. hover the mouse cursor on the border right below the dashboard name tabs. images. then a dotted line appears and the cursor changes into a double-arrow icon. To reference a library component into the dashboard body: 1. you need unfold it before inserting any components into it. select Local File. They are used to filter component data. then input the image URL or paste the URL in the File URL text field. They are used to filter component data. 3. To use an image in the image library of JDashboard. Inserting a special field You can insert two types of special fields in the dashboard header: User Name and Print Date. then click Browse to find the image. Then in the Insert Special Field dialog. see Using sliders. then select the image in the My Pictures box. Specify the image you want to insert. To do on the left to display the Toolbox panel. For . click the Toolbox button Field to the destination in the dashboard header.is displayed. r To use an image in the local file system. choose User Name or Print Date and click OK to insert the specified one. Inserting a slider Sliders can be inserted in the dashboard body. For details. To use an image on a website. Inserting a filter control Filter controls can be inserted in the dashboard body. r r 4. Click OK to insert the image. select Library. select Web URL. From the panel drag Special this. details. see Using filter controls. . Select the dashboard you want to open from the default folder or from another folder. In the Open Dashboard dialog. you can click in any dialog to show the help document about the dialog. In the Themes dialog. q Closing a dashboard For the current dashboard. Do not use the close button on the browser window as that may not release the resources used by JDashboard. Exiting JDashboard on the side bar and then select If you want to exit JDashboard and release the resources. Click the dashboards in the same folder as the current open dashboard are listed. Operations on objects in the dashboard header q Editing an object . q Refreshing the current dashboard Click on the side bar to refresh the data of the current dashboard. q Applying a theme to the current dashboard on the side bar and then select Themes from the menu list. Operations on dashboards q Creating a new blank dashboard in the current web browser on the side bar and then select New Click + beside the right most dashboard name tab.General operations in JDashboard This section provides a general view of the operations you can perform in JDashboard. click Exit from the menu list. click X on its name tab to close it. q q Asking for help on the side bar and then select Help from the menu list to access the At any time. Furthermore. Then add components to customize the dashboard. Then browse to the target folder by double-clicking and doubleclick a dashboard to open it. or click from the menu list. and then click OK. select a Click theme from the left panel and then click OK. q Opening another dashboard in the current web browser on the side bar and then select Open from the menu list. hover the cursor on a name tab until X appears. then click X to close that dashboard. You can also open a dashboard using the Dashboards panel. Click the Dashboard button on the left to display the Dashboards panel. you can click JDashboard help documents. a blank dashboard will be created in the browser. For the other open dashboards. bottom border. Turning component pages If a table or a crosstab contains more than one page. By clicking Click the button again the object will be restored to the original size. or special fields. Click Next to go to the next page. bottom border. then drag to the desired position. then drag to the desired position. or the bottom right corner until the cursor becomes a two-arrow icon. hover the cursor on the image and then click that appears in the dotted rectangle. q q Operations on objects in the dashboard body q Moving an object Place the cursor on the component title bar until it becomes a four-arrow icon. Navigating component data via scroll bar For tables. hover the cursor on the object and then click that appears in the dotted rectangle. Maximizing an object r r r q on the component title bar and the object will take up the whole dashboard body. You can also maximize and then restore an object by double-clicking the component title bar. Resizing an object Place the cursor on the object until a dotted rectangle appears. q Modifying object properties You can modify the properties of labels. and the Edit Image dialog will be displayed for you to select another image. To edit an image. and a dialog will be displayed for you to modify the properties of the object.To edit the text of a label or the dashboard title. q Moving an object Place the cursor on the object until it becomes a four-arrow icon. crosstabs and charts. Click Prev to go to the previous page. Input a number in the text field. then drag to the desired position. the dashboard title. you can use the scroll bar to navigate their data if the container cannot display all data of the component. next move the cursor on the right border. double-click it to enter the edit mode. Use the Backspace or Delete button on the keyboard to delete unwanted text and then input the desired text. then drag to the desired position. You can use the navigation bar to view the desired pages: r q q q Click a number to go to that page. Resizing an object Place the cursor on the object's right border. q Customizing the way of showing the component title bar and options on it Click on the side bar and then select Component Title Bar from the menu list. In the . or the bottom right corner until the cursor becomes a two-arrow icon. To do this. Deleting an object Hover the cursor on the object and then click that appears in the dotted rectangle. a navigation bar specific for the component will be available right below the component. specify the way of showing the component title bar and the options on it. The Cancel button is used to close the configuration panel.Customize Component Title Bar dialog. Making use of the configuration panel Each library component can be equipped with a configuration panel. or to change properties of objects in its library component. To do this. click on the component title bar and then select About from the drop-down list. To view the information. Once a configuration panel has been defined for a library component. see Using the configuration panel in the JReport Designer User's Guide. You can click the OK button in the panel to close the panel. After specifying values in the panel. you can open it in JDashboard and then perform actions as defined. to filter or sort the data of its library component. click OK to apply the values in the library component. on the title bar of the library component. q Deleting an object Click on the component title bar and then select Delete from the drop-down list. e-mail address and description are provided. The configuration panel can be used to specify parameter values to its library component. click and then select Edit Setting to display the configuration panel. and then click OK. For how a configuration panel is configured. A panel will be displayed showing the information. q q Showing object information Information about an object such as its author. . and Google maps. because they are regarded as dashboard-level filters. Swapping chart groups You can switch data between the category and series axes. To remove the sort condition. To do this. Filtering a detail field You can use filter-related commands on the shortcut menu to filter the data in a table. q Manipulating a table q Sorting on a field To sort the values of a field. however filters created by sliders or filter controls are not under the control of the removing component level filter action. tables. select Ascend or Descend from the Sort submenu. use the Remove Filter option on the Filter submenu.Manipulating data components You can manipulate data components. The go-to action simply changes the group field. right-click on any value of the field by which you want to filter data. on the basis of go-to action. which is [Group Field] = [Focused Value]. right-click in the chart. Going up/down on Google map group markers q For the group level that is higher than some other group levels in a Google map component. select the required order from the Sort Category or Sort Series submenu. specify to show the first/last N values of the field or a specific value. To do this. then on the shortcut q . right-click on any value of the field. then on the shortcut menu. charts. or between the category and value axes of a chart if no field on the series axes. while the go-to-by-value action adds a filter condition. then from the Filter submenu. To do this. Applying a style to a data component Right-click in the component. select No Sort. In dashboards you can also use sliders and filter controls to do filtering. q q Manipulating a chart q Sorting category/series labels You can sort the labels on the category or series axes of a chart in either descending or ascending alphabetical order. Removing component level filters from a data component On the shortcut menu of data components. point to its group marker. Going to and going to by value on a group field You can use Go to or Go to by value command on the shortcut menu of a group field to change the group field to another field. right-click in the chart. point to its group marker. For the group level that is lower than some other group levels in a Google map component. in dashboards as shown below. then on the shortcut menu. which refer to crosstabs. there is an option Remove Filters which is used to remove filter conditions generated via the configuration panel and via message delivery from the data components. select a style from the Apply Style submenu. These two kinds of filters are referred to as component-level filters. right-click it and select Go Up from the shortcut menu to jump one group level up. To remove filter condition created this way. then on the shortcut menu. right-click it and select Go Down from the shortcut menu to jump one group level down. . q Changing chart type Right-click in the chart. then on the shortcut menu.menu. click Swap Chart Groups. select the desired chart type and its subtype. From the drop-down menu. locate the Chart Type. You can choose one or more values from anywhere in the list and there is no mean or median value calculation possible such as States and Countries. data source 1 uses "Country". quantity and currency variables where the slider represents the scale from lowest to highest value and the middle represents the median value. Think about what you need and choose the proper filtering tool. times. in this case. Bind a field to a slider or filter control. select the two components you want to filter. For example. insert a slider or a filter control according to your requirement into the dashboard body. Sliders allow you to pick one or more sequential values from a list and are used for interval variables such as dates. We . you need to select both "Country" and "P_Country"). you can filter component data using two types of web controls: sliders or filter controls. Filtering based on one field is a common usage. select both the country fields from the two data sources (different data sources may use different names for the country field. Region and Territory. you would like the two components to show the data of a specific country. then from the Apply To drop-down list. Field1=SelectedValue1 or Field2=SelectedValue1 or Field3=SelectedValue1. be sure the list of values in each field match so that when you select a value. The filter tool will be inserted in the dashboard body. select the common field under the nodes of all the data sources. for example. at runtime after you select values in the slider or filter control. Choose a common field all the data sources contain and then bind a slider or filter control with the common field in all the data sources. When you bind a slider or filter control with multiple different fields. in the insertion dialog. Filtering scenarios Both sliders and filter controls have the same filtering mechanism. for example. and then based on the field to filter the data of the components created from the same data source as the field. data source 2 uses "P_Country". When you bind a slider or filter control with multiple different fields which do not contain the same list of values such as Country. such as Country. it will match the appropriate country field in each component. and you can see it lists country names which come from the two data sources. In the filter tool select one or more countries. then in the insertion dialog. when Field1. Field2 and Field3 are used in different components you will see the records correctly in each component. when there are three fields but the list of values in each field do not match.Filtering component data When creating or editing dashboards. For example. the filter condition will use OR logic to apply the selected values to all the fields of the slider or filter control. In this case. P_Country and S_Country. Therefore. the result will have no matching records for two of the components and therefore become blank components. and you want to filter their data using one filter tool. Another special usage is to filter components using different data sources. Filter controls allow you to pick one or more random values from a list and are used with categorical or nominal variables. The logic is the values are OR that is Field1=SelectedValue1 or Field2=SelectedValue1 or Field3=SelectedValue1. that is. The precondition is that both components have the field you want to filter. In order to do this. then the two target components will be filtered and only display the data of these selected countries. there are two components containing data from different data sources. all the values of the selected fields will be available for the slider. Choose whether the slider is used to specify a range of values or just a single value. In the Title text field. which may be too . select the fields of the same data type to bind to the slider. To filter components created from the same data source. By default.recommend that you use three different filter tools in cases like this. From the panel drag Slider to the destination in the dashboard body. To filter components created from different data sources via one slider. find a common field these data sources contain. then select the field in each of the data sources. The Insert Slider dialog appears. From the resource list. select a field in the data source. 5. Click the Toolbox button on the left to display the Toolbox panel. 4. 3. 2. input a title for the slider. 6. Using sliders To insert a slider to the dashboard body: 1. Repeat the operation to add more values. you can also specify a special function. Click the Customize button to display the Customize Value dialog. click to add a value line. refer to Specifying special function for group by field in the JReport Designer User's Guide. . From the panel drag Filter Control to the destination in the dashboard body. click on the title bar of the slider and then select Edit Setting. To remove a value. 2. s To specify the value range. 8. 7. Select the components which you want to filter. s To specify values one by one. The customized values will be available on the slider for choosing. a. d. Later if you want to modify the slider. The Apply To drop-down list provides the components involving the selected fields. A slider bound with the specified fields will be inserted in the dashboard body. specify a value in the From and To text boxes respectively. For Date/Time/DateTime type fields. The Insert Filter Control dialog appears. Using filter controls To insert a filter control to the dashboard body: 1. The Edit Slider dialog will be displayed for you to bind different fields or customize the field values. For details about the special functions. Click the Toolbox button on the left to display the Toolbox panel.many for a slider. select its line and then click the button. Uncheck the Select All option. You can then customize the values. then in the line to type a value or select a value from the drop-down list. Click OK. b. To do this. However you can customize the values to show. Click OK to save the customized values. You can then specify values in the slider to filter the specified components. c. input a title for the filter control. 5. Click OK. select a field in the data source. 4. 6. To filter components created from the same data source. Filter control provides a quick search toolbar for easily locating the values you want. A filter control bound with the specified fields will be inserted in the dashboard body. The Apply To drop-down list provides the components involving the selected fields. From the resource list. Later if you want to modify the filter control. You can then specify values in the filter control to filter the specified components. To filter components created from different data sources via one slider. In the Title text field. click on the title bar of the filter control and then select Edit Setting. Select the components which you want to filter. The button cancel the selection of values in the filter control. Usage of the quick search toolbar on the on the field name bar is used to . select the fields of the same data type to bind to the filter control. then select the field in each of the data sources. Click field name bar to launch the quick search toolbar. The Edit Filter Control dialog will be displayed for you to bind different fields. find a common field these data sources contain.3. X Closes the quick search toolbar. r r q Highlights the previous matched text. Match Case Specifies whether to search for text that meets the case of the typed text. r Highlight All Specifies whether to highlight all matched text. q q Lists the advanced options. q Highlights the next matched text. .q Text field Type in the text you want to search for in the text field and the matched text will be highlighted among the field values. Match Whole Word Specifies whether to search for text that matches a whole word and ignore partial word matches. on the side bar and then select Save from the menu If the dashboard is newly created and has not yet been saved. click As dialog. browse to the folder where you want to save the dashboard in the server resource tree. on the side bar and then select Save As from the menu list to show the Save After saving your dashboard into the server resource tree. Click OK to save the dashboard. browse to select the row that the dashboard is in on the JReport Console > Reports page. To save a copy of a dashboard. and then do as above. You need to have Write access to the directory. 3. 2. you can browse to its directory on the JReport Console > Reports page and run it directly just like you run a report. the Dashboard Version panel will be displayed showing the versions. In the Save In section. Note: You will not be able to save the dashboard to some locations if you do not have the required permissions. click Tools > Version on the task bar. click list. To find a newly saved dashboard version. 1. You can use the button to return to the parent folder. the Save As dialog will be displayed. enter the name of the dashboard or use the default name. In the File Name box.Saving dashboards To save the changes you made to the current dashboard. . the saved JDashboard status will be loaded: q Log onto JReport Server using the dashboard port. q To set JDashboard home page: 1. uncheck Yes for the option Enable Setting Dashboard as Home Page. Click the option to set the current JDashboard status as the home page. open the desired dashboards. 2. 8887 is the default dashboard port. The Home tab is available after you have set JDashboard home page. click on the side bar and you will see Set as Home Page is enabled on the menu list. The URL is like this: http://localhost:8887. In the Profile > Customize Server Preferences > General tab on the JReport Administration or JReport Console page. In the same JDashboard window. Administrator can change it via the Dashboard Port option on the JReport Administration page > Configuration > Service panel. Click the Home tab on the system toolbar of the JReport Console page. set the option Enable Setting Dashboard as Home Page to Yes to enable setting JDashboard home page. you can set JDashboard home page at any time you want. . in the Profile > Customize Server Preferences > General tab on the JReport Administration or JReport Console page.Setting JDashboard home page You can save the JDashboard status such as which dashboards are open and which dashboard is active. The last time you do this before exiting JDashboard will take effect. In JDashboard. Then the next time when you access JDashboard via either of the following ways. To cancel setting JDashboard home page. Dashboards can have their status saved in JDashboard only when they have been saved. In order to deploy to an application server. This chapter covers the following: q Seamless integrated security solution Building a WAR/EAR file to include a self-contained JReport Server Deploying JReport Server to a Java application server Integrating remote JReport Server q q q Note: JReport Web and JReport Studio slather dynamic classes. and then use the application server deployment tools to deploy the WAR/EAR file. you first have to create a Web Application Archive (WAR) file or an Enterprise Application Archive (EAR) file to include a JReport Server. To solve the problem. you need to add -XX:MaxPermSize=256m to JVM or set the number to a bigger one according to your case. so you probably encounter "OutOfMemoryError: PermGen space" problem when working with them after integration. .Integrating with a Java Application Server JReport Server is implemented using Java Servlet technology and Java Server Pages (JSP). These servlets and JSP pages enable you to work with any Java EE compliant application server and administer JReport Server remotely through a web browser. you can see that the HTTP client can send a request directly to the application . the seamless integrated security solution becomes one of the key solutions of JReport Server. or it can re-direct the request to the JReport services provided by the JReport JSPs and Servlets. and the web application can either call the public Server API to the server instance directly to run a report and output a report result to file system. JReport JSPs/Servlets will first make sure the request is authenticated and authorized. they can all be categorized into the following two types according to the location of the JReport Server instance. After which. JReport Server instance is located in the same JVM as the web application In this scenario. JReport Server protects information via authentication and authorization processes. In the illustration above. Furthermore.Seamless integrated security solution As a reporting server. the client (HTTP client) most of time will send a request to the portal. the application includes JReport Server JAR files into the same JVM. In this way. it will call the internal API method against the JReport Server Instance in the same JVM to fulfill the requirement and return suitable information to the client via JSPs or internally generated output steam. There are all kinds of scenarios on using JReport solution. and it also includes JReport built-in servlets and JSPs which handle DHTML and other reporting services. for example the DHTML JSP and Servlet. scheduling reports. JReport allows a web application to embed this reporting solution in it seamlessly not only on UI but also with the Java EE technology. JSP or Servlet of the web application. for example. Description of the illustration In this scenario. However. the web application developer can set up the configuration to ensure that the customized authenticator and authorization instance is used instead. However. During the auth check process. If this Instance returns a user ID. including whether or not the user ID is valid. and then continue to check if the action is valid for the user by asking the AuthorizationProvider instance.JSP/Servlets or JReport JSPs/Servlets.server. Before a response is made by the JReport JSP and Servlet. Pay attention to the RED box: External Authorized instance. if the external authorized instance returns a user ID of the session. If this external authorized instance does not return a user ID. AuthorizationProvider. JReport Server instance is located in a different JVM from the web application . Normally.HttpExternalAuthorized to provide the authenticated user ID from the session.security.server. The AuthenticationProvider is used to authenticate the user ID.Authenticator and Authorizer instance. the builtin authenticator and authorization instance of JReport Server (Instance) is called to perform these checking actions. This Java class implements JReport jet.custom.security.AuthenticationProvider and jet. can be provided by implementing two other interfaces: jet. the auth check will qualify the session of the request. JReport will qualify the session of the request. If the user is valid.api. If the user ID is valid for JReport. JReport auth check will continue to send the user ID to the AuthenticatorProvider to check if it is valid or not.api. In general. JReport will pass it to its authenticator to check if it is valid. JReport will respond the request by asking for a login. server. The other RED box . if the application wants to control the process.api. and will not ask for a login again.http.custom. The AuthorizationProvider is used to check the privileges of the user against the action that the user requests. Two security check providers can be implemented to seamlessly integrate JReport security into the application. there is an authentication callback via the implemented interface of External Authorized. an Auth Check is performed to authenticate the session and then authorize the action. . Inside of the Web Application. the architecture is not changed.From the web application itself. the way that it uses the JReport solution is different since the JReport Server Instance is outside of the Web application server. the instance is RMI server being called by the web application server or JReport built-in JSP/Servlets for the RMI solution. However. jar contains the entire JReport runtime environment. go to web. jreports/ -. such as LogConfig. template/ -.jar and chart.properties. you do not have to specify the JReport Server installation root as the reporthome. If you are not familiar with JReport Server.jar.xml.xml which is located in <install_root>\bin. and JRWebDesign.This folder contains jar files needed by applets. It is used to dynamically detect and modify servlet path based on context path of self-contained WAR/EAR when deploying the WAR/EAR to a J2EE application server. it is better to use this way. The library contains all class packages required by the JReport Server runtime. jrenv. and the actual servlet path will be concatenating "context path" with "default servlet path" set in server. bin/ -. profiling/report/ -.properties. If you do not want this way. The following is the structure of the jrenv. set the parameter autoDetectServletPath to false in makewar.sh after you have installed a JReport Server. If the WAR/EAR has already been built. The bin/. With the self-contained solution. help/ -.This folder contains demo reports or pre-published reports.This folder contains demo database for demo reports.jar.jar workspace/ -.This folder contains the license file jslc. The method is no longer needed but is still available in this release in case you would like to take it. lib/. db/ -.dat and configuration files.This folder contains profiling report files. while the profiling/. q The self-contained JReport Server is based on a library. Create a WAR manually. lib/ -.properties and redirect. db/ and help/ folders are optional.This folder contains template files. This property is enabled by default.jar.jar package will be automatically put into the WAR/EAR.autoDetectServletPath.jar. you can disable the feature using either of the following ways: q Before making your WAR/EAR. set this parameter autoDetectServletPath to q . and template/ folders are necessary for the JReport runtime. When you create a JReport Server WAR/EAR file using the provided tool.This is the root folder. such as jrenv. and will be extracted to the specified reporthome when initializing JReport Server.jar package: jrenv. the jrenv.This folder contains help documents. jreports/.jar. JREngine. JRESServlets.bat/makewar. such as view12. and is the key to the selfcontained integration solution. Note: There is a parameter in self-contained WAR/EAR . In the library.Building a WAR/EAR file to include a self-contained JReport Server There are two ways of creating a WAR or EAR to include a self-contained JReport Server: q Create a WAR/EAR file using the provided tool makewar. The following are topics covered in the section: q Building a JReport Server WAR/EAR by tool Building a JReport Server WAR manually (deprecated) Four ways of integrating JReport Server q q .false. The WAR/EAR files can be deployed to any Java EE compliant application server without having to specify a JReport Server installation root as the reporthome.Building a JReport Server WAR/EAR by tool A tool based on the Apache Ant project is provided by JReport Server to build JReport Server WAR/EAR files which contain the full JReport Server runtime environment. q Creating a JReport Server WAR/EAR Specifying reporthome for JReport Server in a Java EE environment Specifying a data source for JReport Server in a Java EE environment q q . or you can customize the reporthome and data source for JReport Server before generating the WAR/EAR using the provided tool. You can use the default settings to generate a JReport Server WAR/EAR. such as web.rmiport=XXX] [-Djrs. The tool is makewar.host=XXX] [-Djrs.Specifies to build the JReport Server WAR for remote integration.sh.bat/makewar..bat/makewar. buildRemoteWar . such as the database connection information for the WAR/EAR file is stored in these files.sh [Target Name] [-Dpredeploy=ReportFolder] [-Dreporthome=XXX] [Djrs. the main targets in the makewar. Usage makewar.xml.>. You can modify the target names.sh The batch/script file used to build a JReport Server WAR/EAR according to the target specified in makewar. r r q r The temp directory used to save the temp files when building the WAR/EAR. makewar.xml This file can be used to specify the following: q Targets specified to build the WAR/EAR file.xml are as follows: r Making the server runtime environment Making the WAR file for normal or remote integration Making the EAR file Temp directories.Creating a JReport Server WAR/EAR JReport Server provides a tool for building a WAR or EAR file. They start with the tag <target name="xxx".. buildEar .Specifies to build the JReport Server EAR.Specifies to build the JReport Server WAR.auth_file=XXX] Options q Target Name The following targets can be performed: r buildWar .xml. By default. it is <install_root> \bin\distribute. it is <install_root>\bin\distribute\temp.rmi. and makewar. .remote. By default.xml in <install_root>\bin. makewar. r q The deployment descriptors. By default.remote. r r q -Dpredeploy=ReportFolder Allows you to deploy the reports and catalogs under ReportFolder to the WAR/EAR file. It is the default target. The directory which is used to store the generated WAR/EAR file. The configuration information.xml and application.bat/makewar. 1 -Djrs.0. -Djrs.auth_file Specifies the RMI auth file with the absolute file path when building a WAR for remote integration.war will be saved in the default directory <install_root>\bin \distribute.remote. buildEar. q q q Examples q Builds the JReport Server WAR file which is defined by makewar. If this argument is not set. or buildWar4WS.host Specifies the server's RMI host when building a WAR for remote integration. makewar. and saves the generated EAR file jreport.auth_file=C:\JReport\Server\bin\rmi.rmi.auth .bat q Builds the JReport Server WAR file.xml in the WAR/EAR. The generated WAR file is saved to the default directory <install_root>\bin\distribute.xml for remote integration. This argument takes effect only when the target name is buildWar.bat buildWar -Dpredeploy=c:\myReport q Builds the JReport Server WAR file as defined by makewar.xml (the default target).bat buildRemoteWar -Djrs.rmiport=1129 Djrs.rmi.remote.rmiport Specifies the server's RMI port when building a WAR for remote integration. -Djrs.home%/. makewar.0. makewar.q -Dreporthome Specifies the reporthome that will be set into web. and deploys the reports and catalogs in C:\myReport to the WAR file. This argument takes effect only when the target name is buildRemoteWar.bat buildWar -Dreporthome=C:\JReport q Builds the JReport Server EAR file.host=127. and saves the generated WAR file jreport.jreport/default. This argument takes effect only when the target name is buildRemoteWar.bat buildEar q Builds the JReport Server WAR file.ear to the default directory <install_root>\bin\distribute. reporthome will be decided when the WAR/EAR is loaded by the application server and the location will be %user.remote.war to the specified reporthome.remote. makewar. The generated WAR file jreport. makewar. -Djrs. This argument takes effect only when the target name is buildRemoteWar. The generated WAR file is saved to the default directory <install_root>\bin\distribute. The following introduces several methods of specifying reporthome or implementation of CustomizedServerEnv: . including the server properties.xml.api.xml/web. JReport Server enables you to customize the reporthome location before creating the JReport Server WAR/EAR using the provided tool.api. configuration files and resources. q Using ejb-jar. JReport Server will obtain not only reporthome but also server properties.api.jar that contains the entire JReport runtime environment will be extracted to the specified reporthome when initializing JReport Server. It contains two methods: q String getReportHome() Properties getServerProperties() q If you specify the implementation of this interface. for example: -Dreporthome=/home/jreport q Invoking the method jet. The package jrenv.server. CustomizedServerEnv interface: q By JVM -D parameter.server.server.server.initEnv(props).http.initEnv(Properties props).http. HttpUti. Set the JVM option -Dreporthome before starting the application server.http. Three ways of specifying reporthome There are three ways of specifying reporthome directly or the implementation of the jet. However.http. Note: Make sure that the reporthome for the integrated JReport Server is different from that of the standalone JReport Server.home>/.Specifying reporthome for JReport Server in a Java EE environment JReport Server requires a reporthome as its working space to hold the entire JReport runtime environment.setProperty("reporthome". For example: Properties props = new Properties().api.HttpUtil. Interface CustomizedServerEnv The jet. You can either specify reporthome directly or specify the implementation of the jet. You do not have to specify a reporthome for JReport Server since it will create a default reporthome location <user.jreport/default. "/home/test/JReport"). The reporthome can be any location on the disk where JReport Server has read and write privileges.CustomizedServerEnv interface can be used for specifying the JReport Server reporthome and for setting the server properties in a Java EE environment.CustomizedServerEnv interface. props. server.http.xml Using the default implementations of jet.http.xml or ejb-jar.CustomizedServerEnv q q q .q Using the default reporthome Specifying reporthome directly in web.server.api.api.CustomizedServerEnv Using a customized implementation of jet. If JReport Server is running as a Unix/Linux Daemon.home is a system property of the Java VM (-Duser. you can specify the JVM system property Duser. For example.home> is the system property user. For Windows: C:\Documents and Settings\username For Unix/Linux: /home/username Notes: q user.Using the default reporthome If you do not specify a reporthome.jreport/default.home in the script file that starts JReport Server.home retrieved from Java VM. So you can also specify different folders for this JVM option. The default working folder is <user.home=xxx). The JReport Server has the Read and Write privileges in this directory. where <user. the self-contained JReport Server will create a default working folder.home>.home>/. q q . If JReport Server is running on Windows as a service. Different OSs have different real paths for <user. the username is the user who installed the service or the specified logon user for the service. use the <context-param></context-param> tags to specify the reporthome in the target "web.String</env-entry-type> This is the recommended way to set reporthome since the <env-entry></env-entry> tags are also supported in ejb-jar. for example: <context-param> <param-name>reporthome</param-name> <param-value>/home/jreport</param-value> </context-param> Specifying the reporthome for EAR The same methods can be used to specify the reporthome of building the EAR file as of building the WAR file.norpthome".String</env-entry-type> <env-entry> .xml (for the EJB module).rpthome</env-entry-name> <env-entry-value>/home/jreport</env-entry-value> <env-entry-type>java.filter". Also.xml file (for the web module) or in ejb-jar. q In the makewar.xml.xml. In ejb-jar. you should ensure that you put the reporthome information either in the target "web.xml file. <env-entry> <env-entry-name>jreport.xml.xml or ejb-jar. xml. in the target "web. For example. For example: <env-entry-name>jreport. Specifying the reporthome for WAR You can use one of the two methods listed below to specify the reporthome for WAR: q In the makewar.xml file. However.rpthome</env-entry-name> <env-entry-value>/home/jreport</env-entry-value> <env-entry-type>java.xml (if you call the Server API in your EJB).norpthome" in the makewar.Specifying reporthome directly in web.xml.xml. you can specify the reporthome using the <context-param></context-param> tags. use the <env-entry></env-entry> tags to specify the reporthome in the target "web.lang.xml It is recommended that you use the <env-entry></env-entry> tags to specify the reporthome directly in the target "web. because you can wrap WAR and EJB in the EAR file.lang.xml.filter". and then uncommented the setting.norpthome" in the makewar. use the <env-entry></env-entry> tags to specify the reporthome.xml file or in ejb-jar. It enables finding the reporthome not only from <context-param></context-param> or <env-entry></env-entry> tags. xml or in ejb-jar. For example: jreport. since it can find the customized reporthome from the <context-param></ context-param> tags of the target "web.server.DefaultServerEnv and jet.jreportrc.rpthome.xml or ejbjar.MultipleInstanceServerEnv This implementation is extended from DefaultServerEnv.12345678=/home/user1/. this implementation has three main limitations.servlet.servenv</env-entry-name> <env-entry-value>jet.context. It is a string of HEX encoded hash value.12345678 .xml. once the file has been created.3.jreport/instance.server.String</env-entry-type> </env-entry> q The JReport Server must be initialized with JRServerContextListener from a Web module.xml" or the <env-entry></env-entry> tags of web.server. jet. such as extracting the WAR.context. you can edit it to change the reporthome for each instance.home>/.xml" in the makewar.DefaultServerEnv If you use this implementation. q The <user.servlet.MultipleInstanceServerEnv</env-entry-value> <env-entry-type>java. For detailed information.tempdir from ServletContext by invoking the getAttribute(String) method. The RC file can hold multiple records.4 SRV. Since in cases of deploying multiple JReport Server instances in one Java EE application server without touching the WAR. server. JReport Server has to use ServletContext to generate an ID for every instance. They are jet. You can only edit the file to change the reporthome after the JReport Server initialization. However. tempdir. and then uses this value to generate the instance ID. see Java Servlet Specification Version 2.rpthome.server.server.home>/. setting reporthome and rebuilding the WAR. jet.MultipleInstanceServerEnv.home>/. it cannot be pre-assigned. as follows: <env-entry> <env-entry-name>jreport. However.3/2.lang.http. Since the instance ID is generated based on a hash code retrieved from javax. and is therefore impossible for you to create the <user.xml" in the makewar.1 Temporary Working Directories. you will not need to specify it in the target "web. JReport Server retrieves javax.api. but also from an external file <user.Using the default implementations of jet.xml. They are: q This implementation must be clearly specified with the <env-entry></env-entry> tags in the target "web.7.jreportrc file must be created by JReport Server.xml.<instanceID>=the-instance-report-home The instanceID is created by JReport Server during its first initializing. jreportrc file.CustomizedServerEnv The self-contained JReport Server provides two implementations of CustomizedServerEnv. The record format should be as follows: jreport.xml or in ejb-jar. jar in workspace\bin (you can find the jrenv. Since different JReport instances cannot access the same JReport Server system database at the same time.server.String</env-entry-type> </env-entry> 2.MultipleInstanceServerEnv: Example: Specifying reporthomes when deploying multiple server instances JReport Server provides an internally implemented class of the jet. use the <env-entry></env-entry> tags to specify jet. MultipleInstanceServerEnv in the target "web. it will create a default reporthome in <user.home>/. and each JReport instance will read its reporthome from this file. In the file makewar.jreportrc in <user.server.xml.api. 3.server.12345abc=/home/user1/.server.lang.12345abc If JReport Server cannot get the reporthome from CustomizedServerEnv.servenv</env-entry-name> <env-entry-value>jet.rpthome.war) for each JReport Server WAR/EAR. and put it in jrenv.MultipleInstanceServerEnv which supports multiple JReport Server instances in one Java EE application server. For detailed information about modifying the dbconfig.xml. however. To do this. you will need to create a dbconfig. This file must be created by JReport Server.home>.jar file after extracting jreport. The following is an example of specifying reporthomes when deploying multiple server instances using jet.jreport/default.http. When the JReport Server WAR/EAR has been deployed. For example: <env-entry> <env-entry-name>jreport.server.xml file to store the connection information.xml". The reporthome of each instance can be assigned by the class automatically. . JReport will create a file . see Configuring the server database. follow the steps below: 1.jet. CustomizedServerEnv interface .jreport/instance.jreport. you can edit it in order to change the reporthome after it has been created.MultipleInstanceServerEnv</env-entry-value> <env-entry-type>java. your class name --> <env-entry-type>java.--> <env-entry> <env-entry-name>jreport. Here the customized implementation of CustomizedServerEnv is named my.properties file in the directory <install_root>\bin.xml in the makewar.server.servenv--> <env-entry-value>my.JReportServerEnv</env-entry-value> <!-.xml" in the makewar. JVM System properties.xml.must be jreport.servenv</env-entry-name> <!-.String</env-entry-type> </env-entry> Notes: q JReport Server will retrieve the reporthome and properties from your implemented class when the WAR/EAR file has been deployed. then use the <enventry></env-entry> tags to specify your implemented class in the target "web.xml file or in ejb-jar. xml file or in ejb-jar.lang. or self-defined ones.Using a customized implementation of jet.http. The properties returned from getServerProperties() can be the properties listed in server.JReport Server calls my.api.xml using the <env-entry></env-entry> tags.JReportServerEnv. q . The following is an example of specifying a customized implementation of CustomizedServerEnv in the target web.JReportServerEnv to obtain reporthome and server properties.CustomizedServerEnv You can implement the interface and add your class to the generated WAR/EAR file. <!-. .Specifying a data source for JReport Server in a Java EE environment See Configuring the server database when integrating with an application server for detailed information. server.JRServlet</servlet-class> </servlet> <servlet> <servlet-name>sendfile</servlet-name> <servlet-class>jet.SendFileServlet</servlet-class> </servlet> <servlet> <servlet-name>dhtml</servlet-name> <servlet-class>jet. while paths for Unix should use the Unix format. 3. Create a web. 2.dhtml.server.servlets. the paths for Windows should use the Windows format.servlets. /opt/JReport/Server. Create a new directory jreport in the JReport Server installation root: /opt/JReport/Server/jreport. C:\JReport \Server. If using this method.dhtml.sun.web. Inc.Building a JReport Server WAR manually (deprecated) This section introduces a method that has been used in earlier versions.servlets. you will have to specify the JReport Server installation root as the reporthome unless you make the WAR be a self-contained solution. However.web.//DTD Web Application 2. for example.JHelplet</servlet-class> </servlet> <servlet-mapping> <servlet-name>jrserver</servlet-name> <url-pattern>/jrserver/*</url-pattern> </servlet-mapping> <servlet-mapping> <servlet-name>sendfile</servlet-name> <url-pattern>/sendfile/*</url-pattern> .DHTMLlet</servlet-class> </servlet> <servlet> <servlet-name>help</servlet-name> <servlet-class>jet. for example. This section takes creating a WAR file on Unix for example.0" encoding="ISO-8859-1"?> <!DOCTYPE web-app PUBLIC "-//Sun Microsystems.3//EN" "http://java. Create a sub directory WEB-INF in jreport: /opt/JReport/Server/jreport/WEB-INF.JRServerContextListener</listener-class> </listener> <servlet> <servlet-name>jrserver</servlet-name> <servlet-class>jet.com/dtd/web-app_2_3.dtd"> <web-app> <listener> <listener-class>jet. The instruction is applicable to both Unix and Windows platforms. It is assumed that JReport Server has been installed to /opt/JReport/Server. Take the following steps to build a JReport Server WAR manually: 1.server.xml file in the WEB-INF directory as follows: <?xml version="1. jar in /opt/JReport/Server/lib.0. run the following command: jar -cvf languages.properties file: .jar. Create a directory lib in the jreport/WEB-INF directory: mkdir lib 5.htm file and the admin. To Excel.2.jar.jar.5. JREngine. and style folders from / opt/JReport/Server/public_html to the /opt/JReport/Server/jreport directory: cp -r /opt/JReport/Server/public_html/* /opt/JReport/Server/jreport Notes: r The jsp files within the admin folder are used by the JReport Administration pages. Copy all of the files in /opt/JReport/Server/lib/pages to the jreport/WEB-INF/lib/pages directory: cp /opt/JReport/Server/lib/pages/* lib/pages 7.jar. To FTP. tar. If you want to export reports to the following formats. for example. jai_codec. images.8. copy activation-1.jar. 8. Those within the dhtmljsp folder are used when viewing reports in the DHTML format.htm and these folders mentioned above to a sub folder in /opt/JReport/Server/ jreport. copy itext_1. skin.jar. to view reports in DHTML format. jinfonet.jar.4. Create a directory pages in the jreport/WEB-INF/lib directory: mkdir lib/pages 6.2. If you copy index.jar. log4j-1. copy commons-net-ftp-2.jar. Copy the following jar files from /opt/JReport/Server/lib to the jreport/WEB-INF/lib directory: commons-codec-1.jar.1. you need: s r Modify the server.0.4.jar. Create a jar file to include the resources folder which is located in /opt/JReport/Server and name it languages.jar. /opt/JReport/Server/jreport/sub.</servlet-mapping> <servlet-mapping> <servlet-name>dhtml</servlet-name> <url-pattern>/dhtml/*</url-pattern> </servlet-mapping> <servlet-mapping> <servlet-name>help</servlet-name> <url-pattern>/help/*</url-pattern> </servlet-mapping> </web-app> 4.jar resources Then put the languages.jar.jar. javascript. jai_core.jar.jar. sac. JRESServlets. languages. JRWebDesign. r r r 9. you should copy the corresponding jar to the jreport/WEB-INF/lib directory: r To e-mail or use the e-mail Notification function. xml-apis. copy poiHSSF_151.jar. For example. dhtmljsp. Copy the index. To PDF and DHTML.jar and mail-1. xercesImpl. jsp" frameborder="0"> 11.jsp" frameborder="0"> Then go to step 11. 10. Note that the path separator character is the Unix style "/" when referencing JSP.web.jsp in the dhtmljsp folder and make it adapt to the environment as follows: dhtmlConfig.bat/makewar.exe."http://localhost:8080/jreport/sub"). Use either way to create the jrenv.6.sh tool For example: run the command makewar jrenv. for example. To make the WAR be a self-contained solution To make the WAR include a self-contained JReport Server. jar and then put it in the jreport/WEB-INF/lib directory before creating the WAR. s In the step 10.jar: q By the makewar.setDHTMLContextPath(SessionID.0_17/bin/jar.setDHTMLJspUrl(SessionID. you need create jrenv. dhtmlConfig. /opt/jdk1. Using the following command to create a WAR file named jreport. q See also Building a WAR/EAR file to include a self-contained JReport Server for details about the structure of the jrenv.jar Creating manually Make sure all necessary contents are included and then use a proper tool to package them into a jar file.htm file and add the context path /jreport to the src tag. "/jreport/dhtml"). edit the index. dhtmlConfig. RptSetId. If it is not on your path you must call jar with the entire path.htm file like this: <FRAME name="ind" src="/jreport/sub/jinfonet/index.htm admin dhtmljsp images javascript jinfonet skin style WEB-INF Note: The jar utility is in the Java home bin directory. Edit the index.war: jar -cvf jreport. The result should be as follows: <FRAME name="ind" src="/jreport/jinfonet/index.setDHTMLServletUrl(SessionID."/jreport/sub/dhtmljsp/").skin.jar. . except for the above procedure.dir=/jreport/sub/skin s Uncomment the following lines in dhtml.war index. or create your WAR/EAR and embed a self-contained JReport Server inside it. The following are four ways of building a WAR/EAR file in order to include a self-contained JReport Server: q Integrating by building a JReport Server WAR Integrating by building a JReport Server EAR Integrating by building a user WAR and embedding a self-contained JReport Server Integrating by building a user EAR and embedding a self-contained JReport Server q q q .Four ways of integrating JReport Server You can either create a JReport Server WAR/EAR. you can build the WAR file using the tool makewar.servlets. To generate the WAR file. admin/ -.xml lib/ -.Integrating by building a JReport Server WAR The self-contained JReport Server can be deployed as a single WAR file.server.JRServlet</servlet-class> </servlet> <servlet> <servlet-name>sendfile</servlet-name> <servlet-class>jet.This folder contains all resources in the JReport Server library. here you can create a JReport Server WAR file named jreport.servlets. Inc. After specifying the reporthome and configuring the database information. The structure of the JReport Server WAR is as below: jreport.war.3//EN" "http://java.dtd"> <web-app> <listener> <listener-class>jet.bat/makewar. WEB-INF/web.xml file of the JReport Server WAR: <?xml version="1.xml The following is the default content in the web.sh buildWar Structure of the JReport Server WAR For example.This folder contains JSP files for the JReport Console page.web.sh in <install_root>\bin.dhtml.com/dtd/web-app_2_3.sun.war WEB-INF/ web.server.//DTD Web Application 2.server.servlets.0" encoding="ISO-8859-1"?> <!DOCTYPE web-app PUBLIC "-//Sun Microsystems.bat/makewar. jinfonet/ -.DHTMLlet</servlet-class> .This folder contains JSP files for the JReport Administration page. execute the command with the buildWar parameter.JRServerContextListener</listener-class> </listener> <servlet> <servlet-name>jrserver</servlet-name> <servlet-class>jet. dhtmljsp/ --This folder contains JSP files for viewing DHTML reports.SendFileServlet</servlet-class> </servlet> <servlet> <servlet-name>dhtml</servlet-name> <servlet-class>jet. For example: makewar. </servlet> <servlet> <servlet-name>help</servlet-name> <servlet-class>jet.web.dhtml.JHelplet</servlet-class> </servlet> <servlet-mapping> <servlet-name>jrserver</servlet-name> <url-pattern>/jrserver/*</url-pattern> </servlet-mapping> <servlet-mapping> <servlet-name>sendfile</servlet-name> <url-pattern>/sendfile/*</url-pattern> </servlet-mapping> <servlet-mapping> <servlet-name>dhtml</servlet-name> <url-pattern>/dhtml/*</url-pattern> </servlet-mapping> <servlet-mapping> <servlet-name>help</servlet-name> <url-pattern>/help/*</url-pattern> </servlet-mapping> </web-app> . xml file before deploying the EAR: <?xml version="1.xml jreport-lib/ -.war</web-uri> <context-root>jreport</context-root> </web> </module> </application> .Integrating by building a JReport Server EAR The self-contained JReport Server can be deployed as a single EAR file.bat/ makewar. To generate the EAR file. for example: makewar.3//EN" "http://java.sh buildEar Structure of the JReport Server EAR For example.xml Following the Java EE standard. you should configure the META-INF/application. jreport.//DTD J2EE Application 1.MF WEB-INF/web.dtd"> <application> <display-name>Self-contained JReport Server</display-name> <module id="JReportWebModule"> <web> <web-uri>jreport.sun. execute the command with the buildEar parameter. The structure of the JReport Server EAR is as below: jreport. here you can create a JReport Server EAR file named jreport.ear.bat/makewar.war META-INF/MANIFEST.sh in <install_root>\bin.This folder contains all resources in the JReport Server library. you can build the EAR file using the tool makewar.0" encoding="UTF-8"?> <!DOCTYPE application PUBLIC "-//Sun Microsystems.com/dtd/application_1_3. Inc. After specifying the reporthome and configuring the database information.ear META-INF/application.xml admin/ jinfonet/ dhtmljsp/ META-INF/application. See the section Integrating by building a JReport Server WAR for details. Class-Path is a list of all packages in the JReport Server library.jar jreport-lib/JREngine. WEB-INF/web..MF file: Class-Path: jreport-lib/jrenv. Each package name should start with the prefix jreport-lib/. and you should use a blank space to separate package names.xml of the JReport Server EAR are the same as the contents in web.MF of Web module Since the JReport Server library is included in jreport-lib of the EAR layer.xml of the JReport Server WAR. . The contents below should be included in the MANIFEST.jar jreport-lib/JRESServlets.xml of Web module The contents in the web.MF file. you must specify Class-Path in the META-INF/MANIFEST.META-INF/MANIFEST.. jar . you must do the following configurations: q Add the following entry into web...war.. Structure of the user WAR For example.. jreport. here you can create a WAR named MyApp.xml lib/ -./. and then embed a self-contained JReport Server inside it. . classes/ -.Integrating by building a user WAR and embedding a self-contained JReport Server You can embed a self-contained JReport Server into your WAR./asset/images/ jreport/ admin/ dhtmljsp/ jinfonet/ . The structure of your WAR may be as follows: MyApp.xml: <context-param> <param-name>autoDetectServletPath</param-name> <param-value>false</param-value> . and this time the structure of your WAR may be as follows: MyApp./asset/images/ jsp/ If you put the JReport WAR related JSPs to a sub folder.This folder contains all resources in the JReport Server library and your other jar files./.war WEB-INF/ web.xml lib/ -.. for example. To run JReport reports..war WEB-INF/ web.This folder contains your servlet classes.This folder contains your servlet classes. classes/ -. .This folder contains all resources in the JReport Server library and your other jar files. server.JRServerContextListener</listener-class> </listener> .xml as follows: <listener> <listener-class>jet.</context-param> WEB-INF/web.servlets.xml in the user WAR You should add listener into the web. .ear META-INF/application.sun. In the EAR.xml file before deploying your EAR: <?xml version="1.jar</ejb> </module> </application> META-INF/MANIFEST. here you can create an EAR named MyApp. The structure of your EAR may be as follows: MyEAR. you must specify Class-Path in the META-INF/MANIFEST. Inc.ear and then embed a self-contained JReport Server inside it.xml jreport-lib/ -. Class-Path is a list of all packages in the JReport Server library. you should configure the META-INF/application. there is an EJB module used for initializing JReport Server. Structure of the user EAR For example. jar .//DTD J2EE Application 1.dtd"> <application> <display-name>EJB with Embedded JReport Server</display-name> <module id="MyEJBModule"> <ejb>MyEjb.xml Following the Java EE standard. Each package name should start with . MF file: Class-Path: jreport-lib/jrenv.jar jreport-lib/JRESServlets.This folder contains all resources in the JReport Server library MyEjb.MF ejb-jar.xml com/ META-INF/application.3//EN" "http://java. The contents below should be included in the MANIFEST.com/dtd/application_1_3.jar META-INF/ MANIFEST..MF of EJB module Since the JReport Server library is included in the jreport-lib folder of the EAR layer.jar jreport-lib/JREngine.Integrating by building a user EAR and embedding a self-contained JReport Server You can embed a self-contained JReport Server into your EAR in order to use JReport Server from EJB.MF file.0" encoding="UTF-8"?> <!DOCTYPE application PUBLIC "-//Sun Microsystems. 0//EN" "http://java.JRptServerBean</ejb-class> <session-type>Stateless</session-type> <!-.Specify JReport reporthome directly <env-entry> <env-entry-name>jreport.JReport callback my CustomizedServerEnv --> <env-entry> <env-entry-name>jreport.String</env-entry-type> </env-entry> --> <!-.xml.lang. but instead want to use JReport's default settings.dtd"> <ejb-jar id="ejb-jar_ID"> <display-name>MyEJB</display-name> <enterprise-beans> <session id="JReportEJB"> <ejb-name>JRptServer</ejb-name> <home>demo. META-INF/ejb-jar. if you want to control the reporthome of the JReport Server. and you should use a blank space to separate package names.//DTD Enterprise JavaBeans 2. or specify a JNDI data source for JReport Server to use. However.xml If you do not want to set the reporthome for the embedded self-contained JReport Server. Here is an example: <?xml version="1.com/dtd/ejb-jar_2_0. there is no requirement for configuring the ejb-jar.0" encoding="UTF-8"?> <!DOCTYPE ejb-jar PUBLIC "-//Sun Microsystems. Inc.JRptServerHome</home> <remote>demo.String</env-entry-type> </env-entry> <transaction-type>Bean</transaction-type> </session> </enterprise-beans> </ejb-jar> .sun.JRptServer</remote> <ejb-class>demo.rpthome</env-entry-name> <env-entry-value>/home/jreport</env-entry-value> <env-entry-type>java.xml file using the <env-entry></enventry> tags.JReportServerEnv</env-entry-value> <env-entry-type>java.servenv</env-entry-name> <env-entry-value>demo. you should first configure the ejb-jar.the prefix jreport-lib/.lang. skin. The following examples are based on the Unix platform with one exception of Sun Application Server on Windows: q Deploying to IBM WebSphere 7 Deploying to WebLogic 11g Release 1 (10.3. Before going on to the next sections.Deploying JReport Server to a Java application server After you have created a WAR/EAR file that includes a self-contained JReport Server. /opt/JReport/Server.properties in the \WEB-INF directory and then adding the following two properties and providing the correct paths (the context root is excluded): web.1 Deploying to GlassFish V3 q q q q q q Note: It is supported if you change the location of the two folders. while paths for Unix and z/Linux should use the Unix and z/Linux format. you can deploy the WAR/EAR to an application server following the deploying instructions of the application server. z/Linux and Windows platforms. The instructions are applicable to Unix. for example.3.1 Deploying to OC4J 10g R3 (10. the paths for Windows should use the Windows format. This section provides examples of deploying JReport Server to several leading Java EE application servers. for example. What is need is creating a file jrserver. skin and dhtmljsp. you should already have reviewed Building a WAR/EAR file to include a self-contained JReport Server. which are in the \public_html directory in the application server side.2) Deploying to Tomcat 6 Deploying to JBoss 5.0. However.0) Deploying to Sun Java™ System Application Server Platform Edition 9.1.5.dhtml_jsp_path .dir web. C:\JReport\Server. Click Save. Select jreport. The default server name is server1. Use the shell script /opt/IBM/WebSphere7/AppServer/bin/startServer. 13. Start IBM WebSphere. 11.war file. wait until the process is completed. In the Context Root field. The installing process may take several minutes. 6. 8. type a context path such as /jreport/.war and then click Start to start JReport Server. 2.e. C:\JReport\Server instead of /opt/JReport/Server. 7. 9. Keep clicking Next until you see the requirement for specifying context root. Click Install. 10. To create the WAR file. the format of the paths for Windows would use the Windows format. and 9060 is the port number. q To deploy JReport Server to IBM WebSphere: 1. where the hostname is host name or IP address. expand the Applications node. After successfully log in.Deploying to IBM WebSphere 7 The example directory paths listed below are based on Solaris or Linux (referred to as Unix). then click Next.jsp Troubleshooting . The instructions are applicable to both Unix and Windows installations. Click Browse to select the jreport. 5. The JReport Server WAR file jreport.jsp http://<hostname>:9080/jreport/jinfonet/index. Click Finish on the Summary page. 12. The login requires user name and password. 3. select Application Types and then Websphere enterprise applications. Copy Derby jars in /opt/JReport/Server/derby to the /opt/IBM/WebSphere7/AppServer/lib directory. i. sh <servername> to start the server. Access the WebSphere Administrative Console by using the URL: http://hostname:9060/ibm/ console.war is located in the /opt/JReport/Server/bin/distribute directory. It is assumed that: q WebSphere 7 is installed in the /opt/IBM/WebSphere7/AppServer directory. and then click Next. however. Access JReport Server using the following URL: http://<hostname>:9080/jreport/jrserver http://<hostname>:9080/jreport/admin/index. 4. refer to the instructions in Building a WAR/EAR file to include a selfcontained JReport Server. com. Go to Application servers > server1 > Process Definition > Java Virtual Machine to access this field. 2. The most useful one is in /opt/ IBM/WebSphere7/AppServer/profiles/AppSrv01/logs/server1/SystemErr. Restart the application server. send the log files of JReport Server to support@jinfonet. The WebSphere log files may also help to identify the problem.com the log files in reporthome/logs. Type -Dlogall=true in the Generic JVM arguments field.log. . The following procedure illustrates how to generate the log files: 1. After reproducing the problem. send support@jinfonet. and try to reproduce the problem.If you run into problems when using JReport Server in IBM WebSphere. Deploying to WebLogic 11g Release 1 (10. and then click Next. Restart the application server. click Install. click Browse to select the jreport. 2. If you have not already created a WebLogic Domain for JReport Server you must create one before starting the integration. 6.war is located in the /opt/JReport/Server/bin/distribute directory. 5. 8. Access the WebLogic Administrative Console by using URL http://hostname:7001/console/. This is referred to as BEA_HOME in the WebLogic documentation. where the hostname is host name or IP address.2) is installed in the /opt/bea directory. After reproducing the problem. i. It is /opt/bea/user_projects/ . To create the WAR file refer to the instructions in Building a WAR/EAR file to include a selfcontained JReport Server. 2. 9. The following procedure illustrates how to generate the log files: 1. 4.3. 7.com the log files in reporthome/logs.2) The example directory paths listed below are based on Solaris or Linux (referred to as Unix). however. and then try to reproduce the problem. and then click Finish. In the Deployment Archive section.3.e. Start WebLogic by running startWeblogic. Start JReport Server and then access it using the following URL: http://localhost:7001/jreport/ Troubleshooting If you run into problems when using JReport Server in BEA WebLogic. click the upload your file(s) link.war file in C:\JReport \Server\bin\distribute. Add -Dlogall=true on the same line as -Dreporthome in the startWebLogic.sh shell script. The JReport Server WAR file jreport. C:\JReport\Server instead of /opt/JReport/Server.com. click Deployments node. It is assumed that: q WebLogic 11g Release 1 (10. After your successful login. Keep clicking Next until the Finish button is enabled. the format of the paths for Windows would use the Windows format. send the log files of JReport Server to
[email protected] in /opt/bea/user_projects/domains/domain_name/ bin. In the Install Application Assistant panel. The instructions are applicable to both Unix and Windows installations. The WebLogic log file may also help to identify the problem. in the Domain Structure panel on the left. 3. send support@jinfonet. q To deploy JReport Server to BEA WebLogic: 1. In the Summary of Deployments panel. and 7001 is the port number. domains/domain_name/logs. . 4. Ensure that Tomcat is shut down. send the log files of JReport Server to support@jinfonet. Save the output to a file. The JReport Server WAR file jreport.sh. Modify the catalina.com.jsp http://localhost:8080/jreport/jinfonet/index. 4.jsp Troubleshooting If you run into problems when using JReport Server in Tomcat.Deploying to Tomcat 6 The example directory paths listed below are based on Solaris or Linux (referred to as Unix).jsp?cmd=info.jboss.sh file in /opt/apache-tomcat-6/bin.sh script. To create the WAR file refer to the instructions in Building a WAR/EAR file to include a selfcontained JReport Server. q To deploy JReport Server to Tomcat 6: 1. To get the information about the JReport Server environment. add -Dlogall=true after the reporthome definition: "$JAVA" $JAVA_OPTS \-classpath "$JBOSS_CLASSPATH" -Dreporthome=/opt/JReport/Server\-Dlogall=true\ org. After editing catalina. C:\JReport\Server instead of /opt/JReport/Server. Access JReport Server using the following URLs: http://localhost:8080/jreport/jrserver http://localhost:8080/jreport/admin/index. start Tomcat. 5. Copy the Web Application Archive jreport. send support@jinfonet. 3. 2.war is located in the /opt/JReport/Server/bin/distribute directory.com the log files in reporthome/logs. 3. however. the format of the paths for Windows would use the Windows format. It is assumed that: q Tomcat 6 is installed in the /opt/apache-tomcat-6 directory.sh. After reproducing the problem. . you can access http:// localhost:8080/jreport/admin/info. Start Tomcat by running the startup.e. The instructions are applicable to both Unix and Windows installations.war to /opt/apache-tomcat-6/webapps. The following procedure illustrates how to generate the log files: 1. i. In the file catalina.Main "$@" 2. out. . The most useful one is /opt/apachetomcat-6/logs/catalina.The Tomcat log files may also help to identify the problem. com the log files in reporthome/logs.jar from jreport.war since they conflict with JBoss.sh.com. however.war to /opt/jboss/server/default/deploy.Main "$@" 2. 3. 4. 5. The instructions are applicable to both Unix and Windows installations. C:\JReport\Server instead of /opt/JReport/Server. Access JReport Server using the following URLs: http://localhost:8080/jreport/jrserver http://localhost:8080/jreport/admin/index. the format of the paths for Windows would use the Windows format.Deploying to JBoss 5. In the file run.sh -S.war\WEB-INF\lib. Remove the two files xercesImpl.1 The example directory paths listed below are based on Solaris or Linux (referred to as Unix).jsp Troubleshooting If you run into problems when using JReport Server in JBoss. The JReport Server WAR file jreport.0.jboss. It is assumed that: q JBoss 5. 3. Ensure that JBoss is shut down by running the script /opt/jboss/bin/shutdown. q To deploy JReport Server to JBoss 5. 2. add -Dlogall=true after the reporthome definition: "$JAVA" $JAVA_OPTS \ -classpath "$JBOSS_CLASSPATH" -Dreporthome=/opt/JReport/Server \ -Dlogall=true \ org.0.e. i. After editing run. start JBoss using the modified file.0. send the log files of JReport Server to support@jinfonet. The most useful one is /opt/jboss/ . send
[email protected] is located in the /opt/JReport/Server/bin/distribute directory.jsp http://localhost:8080/jreport/jinfonet/index.1 is installed in the /opt/jboss directory. The JBoss log files may also help to identify the problem. To create the WAR file refer to the instructions in Building a WAR/EAR file to include a selfcontained JReport Server.sh in /opt/jboss/bin. Copy jreport. Start JBoss by running the run. They are located in jreport.sh script.1: 1. After reproducing the problem. Modify the file run. The following procedure illustrates how to generate the log files: 1.jar and xml-apis.sh. log.server/default/log/server. . send support@jinfonet. and type a context path such as /jreport in the Context Root field. Then click Next.war file in /opt/JReport/ Server/bin/distribute.1. To deploy JReport Server to OC4J 10g R3 (10.com. Type JRServer in the Application Name field.war is located in the /opt/JReport/Server/bin/ distribute directory.3. Click Deploy to deploy the WAR. click Deploy. On the Applications tab. 3. Then click Next. 2. click Browse to select the jreport. Access JReport Server using the following URLs: http://localhost:port/jreport/jrserver http://localhost:port/jreport/admin/index. Start OC4J.0) It is assumed that the JReport Server WAR file jreport.5. 6. The following procedure illustrates how to generate the log files: 1. and then try to reproduce the problem. 3. 4.com the log files in reporthome/logs. 2.5. After reproducing the problem. In the Archive Location section. 5. .jsp http://localhost:port/jreport/jinfonet/index.1. Type -Dlogall=true in oc4j located in /oc4jhome/bin. To create the WAR file refer to the instructions in Building a WAR/EAR file to include a self-contained JReport Server. send the log files of JReport Server to
[email protected] Troubleshooting If you run into problems when using JReport Server in the Oracle oc4j Application Server. Restart OC4J.0): 1.3.Deploying to OC4J 10g R3 (10. q To deploy JReport Server to Sun Java™ System Application Server Platform Edition 9. .war is located in the C:\JReport\Server\bin \distribute directory. The instructions are applicable to both Unix and Windows installations. In the left console tree. 3. /opt/JReport/Server instead of C:\JReport\Server. and then click JVM Options. expand the Applications node. In the Web Applications page. Start the Sun Application Server by selecting Start > Programs > Sun Microsystems > Application Server PE > Start Default Server. and then type -Dlogall=true. 8. e. 4. and then launch the Admin Console. 2. It is assumed that: q Sun Java™ System Application Server Platform Edition 9. Upgrade Sun Application Server's Derby jars by using the lib folder in C:\JReport\Server\derby to replace the lib folder in C:\Sun\AppServer\javadb\lib.1 is installed in the C:\Sun\AppServer directory. however. Launch the Admin Console by selecting Start > Programs > Sun Microsystems > Application Server PE > Admin Console. then click Web Applications. The following procedure illustrates how to generate the log files: 1.jsp http://<hostname>:8080/jreport/admin/index. 2. 4.war.Deploying to Sun Java™ System Application Server Platform Edition 9. Click Browse to select the WAR file jreport. Use the default settings and click OK.1 The example directory paths listed below are based on Windows.com. To create the WAR file refer to the instructions in Building a WAR/EAR file to include a self-contained JReport Server. 3. Start the Sun Application Server. In the console tree. click Add JVM Option. 6. the format of the paths for Unix would use the Unix format. send the log files of JReport Server to support@jinfonet. Access JReport Server using the following URLs: http://<hostname>:8080/jreport/jrserver http://<hostname>:8080/jreport/jinfonet/index. It is assumed that the JReport Server WAR file jreport. You will find a new application jreport is listed. Then click Next. Go to the JVM Settings tab. 5. click Application Server. i. click Deploy.jsp Troubleshooting If you run into some problems when using the Sun Application Server.1: 1. In the JVM Option field. 7. send
[email protected] the log files in reporthome/logs. 7. Restart Sun Application Server and try to reproduce the problem.5. Click Save to save your changes. . 6. After reproducing the problem. and then click JVM Options. 8. click Add JVM Option.awt. Start the GlassFish in the default domain1 and then launch the Admin Console. click Configuration. Click jreport and then on the displayed page click Save. In the console tree.headless=true. the format of the paths for Windows would use the Windows format. 3. 3. Go to the JVM Settings tab. Click Deploy on the displayed page. and then click JVM Options. 4. and then type -Dlogall=true. click Configuration.Deploying to GlassFish V3 The example directory paths listed below are based on Solaris or Linux (referred to as Unix). The following procedure illustrates how to generate the log files: 1. Click Save to save your changes. 5. Click Choose File to select the WAR file jreport. C:\JReport\Server instead of /opt/JReport/Server.jsp http://<hostname>:8080/jreport/jinfonet/index. Start the GlassFish in the default domain1 and then launch the Admin Console. send the log files of JReport Server to support@jinfonet. 9. click Add JVM Option. 6. and then type -Djava. You need not add this JVM option if you are using Windows. Leave Application Name and Context Root as jreport and jreport. Restart GlassFish and try to reproduce the problem.war is located in the /opt/JReport/Server/bin/ distribute directory. Expand the Deployment node on the left and you will see a new node named jreport. To create the WAR file refer to the instructions in Building a WAR/EAR file to include a self-contained JReport Server. 4. Then click OK. The instructions are applicable to both Unix and Windows installations. i.war. and then start the application jreport. Go to the JVM Settings tab. In the JVM Options section. Access JReport Server using the following URLs: http://<hostname>:8080/jreport http://<hostname>:8080/jreport/admin/index. Click the Deployment node on the left. .e. 7. In the console tree. In the JVM Options section. Click Save to save your changes. 5.jsp Troubleshooting If you run into some problems when using the GlassFish V3. however.com. Restart GlassFish. It is assumed that the JReport Server WAR file jreport. To deploy JReport Server to GlassFish V3: 1. 2. 2. It is /opt/glassfish/domains/domain1/ logs/server. After reproducing the problem.com the log files in reporthome/logs.6. . send
[email protected]. The GlassFish log file may also help to identify the problem. and then call the RMI API to publish them.dhtml_jsp_path q See the following cases: q Integrating remote JReport Server with IBM WebSphere 7 by a WAR file Integrating remote JReport Server with WebLogic 11g Release 1 (10. However.Integrating remote JReport Server Normally. skin and dhtmljsp. the two tabs Monitor and Data are hidden on JReport Administration page since they are not supported. JReport servlets are only integrated with other applications on the same machine.2) by a WAR file q Related Topics: q Overall Remote Server APIs & unified JSPs . Notes: q In a remote integration environment. which is running on a different machine. Copy the report or catalog files to the computer where JReport Server (not the remote server) is located. If you want to publish reports or catalogs to JReport Server. You can change the location of the two folders. use one of the following ways: r Access the JReport Server (not the remote server) Administration page with 8889 as the default port to perform publish work. you can now implement JReport Remote Server API in your JSPs. In a remote integration environment.dir web. and integrate the JSPs with the application server to call JReport Server. Publish the report or catalog files from JReport Designer to the JReport Server. r r q q In a remote integration environment. in the \public_html directory in the application server side.skin. What is required is to create a file jrserver. the options for publishing resources are hidden since they are not supported by JReport JSPs.3.properties in the \WEB-INF directory and then add the following two properties and provide the correct paths (the context root is excluded): web. running reports to the Applet format is not supported. Configuring JReport Server 1.xml are located in C: \JReport\Server\bin. Run the following commands in DOS window and the generated WAR file remote.enable=true server.rmiserver.xml for remote integration.) Deploying the WAR file 1. In computer A.bat and makewar.war will be saved to the directory C:\JReport\Server\bin\distribute.remote.auth_file=C:\JReport\Server\bin\rmi.enable=true (This is required only when you have included the admin JSP pages from C:\JReport\Server\bin\public_html\admin and are going to use the administration service.bat buildRemoteWar -Djrs.1 -Djrs. makewar. 2. JReport Server is installed in C:\JReport\Server in computer B. Make sure JReport Server has been started once in order that the server.0.0.rmiport=1129 Djrs.properties file in C:\JReport\Server\bin as follows: server. Generate a WAR file. start IBM WebSphere. Copy the rmi. In computer B.Integrating remote JReport Server with IBM WebSphere 7 by a WAR file Here is an example illustrating the case of using JSPs based on Remote Server APIs to integrate with IBM WebSphere 7. Below show the details for each step: Generating the WAR file 1.host=127.1. The computer IP is 127. 2. . q Take the following steps to integrate remote JReport Server with IBM WebSphere: 1.rmi. Both makewar. It is assumed that: q WebSphere 7 is installed in C:\WebSphere in computer A.0.rmiadminservice. 3.auth file from C:\JReport\Server\bin in computer B to C:\JReport\Server\bin in computer A.bat to build the JReport Server WAR file as defined by makewar. Configure JReport Server.properties file is generated.0. Change server.auth 2. Deploy the WAR file.remote. use the tool makewar. expand the Applications node. After successfully log in. .war and then click Start. 7. Click Finish on the Summary page.jsp Here the hostname is computer A's host name or IP address. where the hostname is computer A's host name or IP address. Click Browse to select the remote. 9.war file. Access JReport Server using the following URL: http://hostname:9446/remote/jinfonet/default. 4. Keep clicking Next until you see the requirement for specifying context root. and 9046 is the port number. 11. 5. and then click Next. 8. Select remote. select Application Types and then Websphere enterprise applications. wait until the process is completed. 6. In the Context Root field. then click Next. Click Save. The installing process may take several minutes. 3. 10. Click Install. type a context path such as /remote/. access the WebSphere Administrative Console by using the URL: https:// hostname:9046/ibm/console. In computer B.2. Copy the rmi.auth 2.rmi.remote.0.0.1 -Djrs. 3. Below show the details of each step: Generating a WAR file 1.rmiserver. Configuring JReport Server 1. Make sure JReport Server has been started once in order that the server.3.properties file in C:\JReport\Server\bin as follows: server.host=127.enable=true server.0.2) by a WAR file Here is an example illustrating the case of using JSPs based on Remote Server APIs to integrate with WebLogic 11g Release 1 (10.properties file is generated.0. It is assumed that: q WebLogic is installed in C:\bea in computer A.rmiport=1129 Djrs.bat buildRemoteWar -Djrs. In computer B.3. Change server. makewar. q Take the following steps to integrate remote JReport Server with WebLogic: 1.xml for remote integration. JReport Server is installed in C:\JReport\Server in computer B. Both makewar. Run the following commands in DOS window and the generated WAR file remote.auth_file=C:\JReport\Server\bin\rmi.enable=true (This is required only when you have included the admin JSP pages from C:\JReport\Server\bin\public_html\admin and are going to use the administration service.bat to build the JReport Server WAR file as defined by makewar.) Deploying the WAR file . 2. Generate a WAR file. The computer IP is 127.rmiadminservice. Deploy the WAR file.auth file from C:\JReport\Server\bin in computer B to C:\JReport\Server\bin in computer A.xml are located in C: \JReport\Server\bin.1. Configure JReport Server.Integrating remote JReport Server with WebLogic 11g Release 1 (10. 2.remote.bat and makewar.war will be saved to the directory C:\JReport\Server\bin\distribute.2). use the tool makewar. click Deployments node. In the Install Application Assistant panel. click Browse to select the remote. 9. 3. and then click Next. In computer A. In computer B. 4. in the Domain Structure panel on the left. start WebLogic by running startWeblogic. where the hostname is computer A's host name or IP address. 5. 2.war file in C:\JReport \Server\bin\distribute. In the Summary of Deployments panel. and 7001 is the port number. 6. After your successful login. Keep clicking Next until the Finish button is enabled. 7. and then click Finish.sh in C:\bea\user_projects\domains \domain_name\bin. If you have not already created a WebLogic Domain for JReport Server you must create one before starting the integration. 8. click the upload your file(s) link. access the WebLogic Administrative Console by using URL http://hostname:7001/ console/. Then go to computer A and access JReport Server using the following URL: http://localhost:7001/remote/ . click Install. In the Deployment Archive section.1. Start JReport Server in computer B. and how to manage it. You can add a new server to the existing cluster or shut down a server from the cluster any time. what features it owns. security. how to set it up. The following topics are covered: q Cluster overview JReport Server cluster main features Setting up and starting a JReport Server cluster Managing JReport Server clusters Dispatching RMI Server Pages requests in multiple server environment q q q q Note: A JReport Server cluster license is required in order to use this feature.Clustering A JReport Server cluster is a distributed cluster in which a group of servers work together to provide cluster-wide shared resources. schedules and version services. In a JReport Server cluster. all clustered servers play exactly the same role. This chapter shows you the infrastructure of the JReport Server cluster. . If you do not have a cluster license please contact your Jinfonet Software account manager to obtain a license. The following list shows all the tasks each clustered server in the server cluster can complete. Business tasks Run Reports Clustered Server Y Submit Scheduled Tasks Y LoadBalancing Y Failover Y Administrative tasks LoadBalancing Administration Y Security Administration Y Resource Administration Y Related topics: q JReport Server cluster . You can set each clustered server in a JReport Server cluster by configuring its properties.Cluster overview There are many nodes (clustered servers) that play the same role in a JReport Server cluster. The following is a diagram of the JReport Server cluster infrastructure: Every clustered server in this distributed cluster has the same responsibility. then the node who gets the trigger becomes the active scheduler. q q Load balancing As for scheduled tasks in a cluster environment. Edit resource nodes and sub resource nodes. Depending on the number of scheduled reports you have. Administering security and resources In a distributed cluster. The Cluster Scheduler Lease option allows you to limit the number of servers competing for each scheduled report by setting a Cluster Scheduler Lease Active Count. Automatically re-balances the network load when one server is added or removed. groups. When the time of a scheduled task arrives. When dispatching tasks. After logging onto the cluster from a clustered server as an administrator. As long as the count is less than the total number of nodes in the cluster. you may find that setting the Lease Active Count to 1 or 2 will provide more overall throughput on the system so the other nodes never have to be concerned about scheduled tasks. in a JReport Server cluster all nodes of the cluster compete to become the active scheduler when the time of a scheduled task arrives. remove and edit users. Some of these features are also available through the API. Add reachable virtual resource nodes. . With these features in mind. certain security administrative tasks can be performed: q Create. Customize the default page appearance for users. Here are the benefits of deploying load balancing in a JReport Server cluster. protections and ACLs. you will be better able to understand JReport Server clusters and easily use them.JReport Server cluster main features This section describes the main features of the JReport Server cluster. the server which has the active scheduler will select a server according to load balancing algorithm and allocate the task to it. Every clustered server has a scheduler. q Automatically allocates tasks to suitable servers according to their current load and performance. Makes sure that all of the servers in the cluster are fully utilized. If the scheduled task has been bound with a trigger. realms. The active scheduler for the task will then determine the server that will be asked to run the scheduled report based on load balancing. and among the schedulers those with a lease are active schedulers. only the nodes holding a lease will compete to become the scheduler for the report that is ready to run. q q Cluster Scheduler Lease By default. JReport Server provides a load balancing mechanism which enables the server to work more effectively. active schedulers compete and the winner gets to trigger the schedule. you can accomplish all administrative tasks from any single node. Road Robin (loadbalance. Configurable algorithms for load balancing clustered servers are: q Min-load (loadbalance. every 30 seconds all the other nodes will check to see if one of the lease semaphores is available to take. it will be given higher priority. If the local server is one of the qualified servers. i. This is the default setting. Failover . q Load detection There is a JReport Server residing in each node of a JReport Server cluster.type=1) The server that has the active scheduler will select each server in sequence one by one until each has been allocated a report to run then will repeat the cycle. The number of semaphores is set by the Cluster Scheduler Lease Active Count. every member server in the cluster has been enabled to send the number of concurrently running reports on it to the other cluster nodes. Cluster Schedule Lease Check Interval will set the amount of time between when other non-lease nodes will check to see if a lease is available to pick up. it will be given higher priority. by default the algorithm will work the same as Round Robin. See Configuring performance weight for how to set performance weight and how this algorithm works.There are two additional parameters that can be set: q Cluster Scheduler Lease Valid Time will set the amount of time that the lease holder will continue to compete for scheduled tasks to run.e.type=2) The server that has the active scheduler will select the server that has the least weighted current reports. Number of currently running reports Weighted current reports= Performance Weight q q Performance weight is a positive floating point number that you set to each server in a cluster on any clustered server. The default value is 30 seconds. The default value is 300 seconds. Weighted Min-load (loadbalance. Built-in load balancing algorithms JReport Server Cluster supports several algorithms for load balancing clustered servers. The main factor that affects load balancing is the number of concurrent reports that are running on every JReport Server.type=3) The server that holds the active scheduler will select the server randomly. the higher chance it may get selected by the server that holds the active scheduler during load balancing. Use Admin Console > Cluster > Weight panel and measure the performance of a typical report on each node of the cluster. q Random (loadbalance.type=0) The server that has the active scheduler will select the server which has the least number of currently running reports. If the local server is one of the qualified servers. The higher performance weight you set to a clustered server. If you do not set performance weight. In order to avoid heavy load. it will be written to temporary storage for redirection to the requester. it will check the shared table for the list of incomplete tasks and will then reassign all incomplete tasks to other active servers using the load balancer. JReport cluster will send a notification e-mail to a specified address. CRD result files On each clustered server. Failure after that will not be recovered. They might be stored on any node in the cluster. some temporary files will be generated. If the copy number is 0. when a member server crashes or is disconnected with the cluster. Load balancing will proceed on the remaining active servers. Notifying of server down If you have enabled the notifying of server down feature. Then if you need to access the files from another node. then it means every node of the cluster will get a copy. JReport cluster will copy them to the node from where it is stored. If a member server is down. Member server failure Effect on load balancing When JReport cluster detects a failed member server. JReport cluster will remove it from the active clustered server list. Effect on completed tasks JReport supports only report level recovery but not session level recovery.You can check the status of the clustered servers on JReport Server Monitor and notice the failure of any member server. As a result. Effect on incomplete tasks When JReport cluster detects a failed clustered server. Distributed storage In pure distributed cluster the resource files are no longer stored in a central place. it will remove the member server from the active server list and will not schedule reporting tasks to that server any more. History Directory When publishing reports to the versioning system from any server in a JReport Server cluster. q q q . Once a report task is completed. You can set how many copies would be made in the cluster. All temporary files are saved in the temp directory. you can access your required files from anywhere in the cluster. the realm related files are saved in the realm directory. Realm Directory On each clustered server. the CRD result files are stored in the cached CRD result folder. Here are the resources that can be stored on any single node of the cluster: q Temp Directory When viewing reports from any server in a JReport Server cluster. all the result files are saved in the history directory. it is assumed that you already have a general idea about the infrastructure of JReport Server clusters and know the functions of the clustered servers. see Cluster overview and JReport Server cluster. If this isn't the case.Setting up and starting a JReport Server cluster This section introduces the steps for setting up a JReport Server cluster and starting it. Here. Following are steps and examples for how to set up and start a JReport Server cluster: q Preparation Setting up and configuring a JReport Server cluster Starting a JReport Server cluster Example 1: Setting up a simple JReport Server cluster Example 2: Setting up a JReport Server cluster for a production environment q q q q . Only by testing in your environment will you be able to find the number of nodes to give you the highest performance. Too few and resources will be under utilized and too many will cause thrashing and lower throughput.Preparation To set up a JReport Server cluster. Another option to consider is using your own DBMS for the server database. you must determine the following factors: q What is a JReport cluster? JReport cluster is based on JGroups and is a distributed cluster. If the copy number is 0. Often with multi-cpu and multi-core systems you will get better overall throughput having several nodes on a single server. the system will copy every resource file to every node. If the node goes down though then the resource is unreachable. You can set how many copies will be made in the cluster and if you need to access the files from another node. By default each installed node creates it's own database in <install_root>/derby. However. The tradeoff is overall system performance versus individual user performance when a user requests a report result. You can add a new server to the existing cluster or shut down a server from the cluster any time. As a result. Based on your expected load and protection from system failures you can create 2 or more nodes for your cluster. . All clustered servers in JReport cluster play the same role. For an example. review the sample configuration Case 1. slowing overall throughput considerably. q How many servers will be included in the cluster? The maximum number of servers is unlimited as long as you install JReport Server with the license key for cluster. refer to Configure the server database. then it means every node of the cluster will get a copy. If you already have a reliable DBMS which is already being backed up and provides the reliability you need such as MySQL or Oracle we recommend you change the system DBMS to use your own managed DBMS rather than maintain a separate one for JReport. For information on how to configure JReport to use a different system DBMS. If you set Number of Copies to 0. all nodes must use the same database. you can access your required files from anywhere in the cluster. In order to use a JReport cluster. setting Number of Copies to 1 will keep a single copy just on the node where it was created which provides maximum system throughput but when a user requests a resource which is not on his node he then needs to wait for it to be copied before he can view it. groups and roles and a lot of other information. A setting of 2 is the default which allows for failover if a node goes down but just does a single copy. q Whether to use the default Derby DBMS or use your own DBMS? JReport includes the Apache Derby DBMS for the server data such as resources and users. q Whether to use the distributed storage feature in the cluster? In a distributed cluster the files may be stored on any node in the cluster. JReport cluster will copy them to this node from the node it is stored on. Select one of the nodes to manage the Derby DBMS and ensure that all the other nodes point to this same instance. 5. first you need to make the time difference between the target computers that will join the cluster as small as possible (the time difference between the target computers should be within one minute). From the Load Balancer Type drop-down list. This is the easiest way for you to set up a cluster. 7. If you want to allow 2 simultaneous failures. 2. valid time and check interval for the cluster scheduler lease. use the cluster enabled license key. 4. 6. You can either make the server join an existing cluster or specify a new cluster name to build another cluster. Specifies your User ID. choose Custom Installation for Standalone Server. This allows any one node to go down and the system will still be able to find all resources. 10. 9. and make sure all servers in the cluster will be set up on the same architecture and operating system. specify a cluster name in the Cluster Name text field. all clustered servers in the cluster will compete for a chance to trigger scheduled tasks which could lower overall system throughput. Run the JReport Server installation file to install JReport Server with the Installation Wizard. input the e-mail addresses of the people to whom you want to send a notification e-mail. The default value is 2 which means make one copy plus the original. In the Service tab of the Configuration panel. When choosing the installation type. check the Network Address At option and type in the IP address of the server. Then specify the installation directory for JReport Server. set the number of copies to 3. Read main features for additional information. In the License Key text field.Setting up and configuring a JReport Server cluster Before setting up a JReport Server cluster. then in the E-mail Address text field. If you are using shared disk resources for any of these directories you should set the value to 1. Cluster Storage Realm Number of Copies and Cluster Storage CRD Result Number of Copies. then set the active count. Check the Cluster Scheduler Lease option to enable lease for the cluster. To create a JReport Server cluster during installation: 1. 3. select the algorithm for load balancing clustered servers. Specify values for Cluster Storage History Number of Copies. Creating a JReport Server cluster during installation It is recommended that you create a JReport Server cluster during the installation of servers. Uncheck the Disable Cluster option. A JReport Server cluster can be set up either during the JReport Server installation or after the servers have been installed using the appropriate license key for cluster. Check Notify via E-mail When a Server Is Down if you need to notify somebody via e-mail when a server in the cluster is down. 8. In the Cluster tab. If you don't enable the lease option. . Specify the value for Cluster Memory Storage Number of Copies to set how many memory copies will be shared in the cluster 11. To enable lease for the cluster. jdbc:derby:// localhost:1527/realmtable.12. Restart the server you have enabled with cluster.create=true. 11. and click Cluster > Configuration on the system toolbar. 7. Go to the JReport Administration > Data page. Realm. and Temporary Directories if necessary. Go on with the installation steps to complete the installation. see Configuring the server database. For details. 14. select the algorithm for load balancing clustered servers. Resource. check the Cluster Scheduler Lease option and set the active count. Cluster Storage Realm Number of . Type the IP address or host name of the server in the Server's RMI Host text field. In the Data Source tab. This requires that you replace localhost with the IP address of the first cluster node that you installed: jdbc:derby://localhost:1527/systemtables. you need to make the system database and realm database in the URL text field point to the same DBMS as the previous server. Check the Enable Cluster option. valid time and check interval of the cluster scheduler lease respectively. In the Cluster Name text field. and type the port number in the Server's RMI Port text field.create=true. 2. History. 8. If they are not specified. specify a name for the cluster.properties and dbconfig.member. 9. 13. 4. Since JReport Cluster uses only one server DBMS. configure the databases to make sure they point to the database that the server will use. go to the Cluster > Configuration panel. you can configure the clustered servers either by using the JReport Administration page or the server. 5.defaultRealm. then log onto the JReport Administration page. go to server. 3. Start up the server that hasn't been enabled for cluster. 16. Install another server you want to join the cluster and repeat the above steps to configure its cluster settings. default directories will be used. A cluster member ID will be generated automatically for the server. 6. Specify values for Cluster Storage History Number of Copies. From the Load Balancer Type drop-down list. configure the System DB and Realm DB to make sure they point to the database that the server will use.properties file located in <install_root>\bin and set the property cluster. Using the JReport Administration page 1. id. You can either make the server join an existing cluster or specify a new cluster name to build another cluster. Log onto the JReport Administration page. Click Save to enable the cluster. 15. Set the Properties. But if you need to modify it.xml files. 10. Creating a JReport Server cluster after installation After the servers have been installed using the appropriate license key for cluster. dir= Specifies the directories of the realm files. If they are not specified. 15. resource. 14. type the RMI port number of the clustered server. input the e-mail addresses of the people to whom you want to send a notification e-mail.rmi. then in the E-mail Address text field. In the server.Copies. Using the server. set the property cluster. 13.hist. r r .properties file: r resource. Specify the paths of the directories on the physical disk.properties file of each clustered server.name in any server's server.member.dir= Specifies the directories for storing temporary files.properties and dbconfig. The value of this property should be an integer no less than 1.xml files To set up a JReport Server cluster using the server. In the Server's RMI Port text field.properties file to specify the cluster name.realm.share. you need to modify the server. history directory.temp.id=(integer) Specifies the member ID of the local server.share. See also Cluster dialog for details about the cluster configuration options. and Temporary Directories if necessary. r r 4. Cluster Storage CRD Result Number of Copies and Cluster Memory Storage Number of Copies. Add the following properties to the server. it will take jreport-cluster as the default name. In the server. server. 12. resource root. server.dir= Specifies the directories for storing all versions of report results in the cluster. modify the properties file as follows: r cluster. 17. The process uses the following procedures: 1.rmi. If not specified.xml files. and temporary files directory.host=localhost IP address Specifies the RMI IP address or host name of the local server.port=1129 Specifies the RMI port number of the local server. Realm.properties and dbconfig. 16.share. The directories on each clustered server should point to a different physical disk. In the Server's RMI Host text field. Shut down the server. Check Notify via E-mail When a Server Is Down if you need to notify somebody via e-mail when a server in the cluster is down. default directories will be used. realm directory.properties file located in <install_root>\bin of each server. such as properties directory. 3. Start up another server you want to join the cluster and repeat the above steps to configure its cluster settings. Set the Properties. History. Resource. Modify cluster.enabled=true. type the RMI IP address or host name of the clustered server. 2.properties file on each JReport Server. resource. scheduler.root= Specifies the directories of the JReport demo reports.xml in <install_root> \properties.realm.usage. server. cluster.copy_number. you need to make sure that the settings of HTTP Port.node_number.share.notify_server_down_address.r resource. server. see Configuring the server database. you can no longer use HSQLDB as the server's system database.custom_class.config.dir. cluster.config.expired.crd_result.expire.storage. resource.host. cluster. server. For details.check_interval. and Server's RMI Port on each cluster node be different from those on any other nodes. cluster.xml in each server's <install_root>\bin. you need to configure the fax settings for each clustered server respectively. realm.lease.security.version. resource. server.temp.lease.properties file in <install_root>\bin.enabled.usage.active. server. and make sure that the system database and realm database all server nodes use point to the same DBMS. However.copy_number.share_memory. enable_notify_server_down.root.name.dir. resource.properties file in the system database. temp. server. If you set up a JReport cluster on one computer. resource. max_count.never. log.lease. scheduler. because distributed storage uses the member ID to recognize on which node the physical files are stored. server. active_count. install the new JReport Server to the same directory with a new license key. server.properties. cluster.lease. loadbalance.filename. Properties such as cluster.from. port. loadbalance.crd. All properties in the clusterWeight.rmi.update. properties that are now saved in the database should be configured for all the server nodes in the cluster. server.disk.rmi. r r r q No sub folders should be created under the realm directory because it may create a realm when server is started. If the content of the resource root directory jreports is removed.max.interval that created in the server. server. log. overriding the existing program files.autocache. resource. cluster.autocache.share.scheduler. server. All properties in the LDAP configuration XML file LDAPProperties. cluster.autocache.valid_time. All properties in the mailconfig.autocache. cluster. Modify dbconfig.enable. cluster.history. cluster.dir.completed. Notes: q In JReport cluster.share.enabled.storage.properties. r 5. time.realm.config. copy_number.memory.hist.type. In order to fax report results successfully in a cluster. Administration Port.share.update.id. the Public Reports folder in the q q q .scheduler.share. cluster.properties file: cluster. These properties are: r q q q The following properties listed before in the server. To use the old result files in <reporthome>\history. and log.dir= Specifies the directories of the properties files.dir.member.storage. resource.properties file and their corresponding UI options on the JReport Administration page need to be configured respectively for each cluster node. It is strongly recommended that you do not change the auto generated cluster member ID in a JReport cluster. resource tree will be empty. . If you are using the default Derby DBMS. q . you need to add -Djgroups. be sure to start Derby first by running startNetworkServer. Notes: q If you are using multiple IP address on a clustered server.bat/ sh in the <install_root>/derby/bin directory on the server containing the server DBMS. If you have two JReport clusters with the same cluster name in a network segment. although the two clusters are pointing to different databases. only the one started earlier can work successfully. bind_addr=IP address at which JReport cluster can work properly to its JRServer.bat file located in <install_root>\bin to make sure the server can be started successfully.Starting a JReport Server cluster To start a JReport Server cluster. start the servers you have configured for the cluster one by one. 6. q q q Take the following steps to set up the cluster: 1. History Directory and Temporary Files Directory. then set the active count. In the Configuration panel. Check the Notify via E-mail When a Server Is Down option. Assume that JReport Server Monitor has been installed on your computer. Change the Cluster Storage History.Example 1: Setting up a simple JReport Server cluster This example demonstrates how to configure a simple JReport Server cluster by modifying the configuration options on the JReport Administration page on each JReport Server. Example description: q Set up a simple JReport Server cluster using the JReport Administration page. Realm Directory. We will just use one resource directory. 13. specify a cluster name and check the Enable Cluster option. Resource Root. Install the two JReport Servers respectively to C:\JReport\Server1 and C:\JReport\Server2 using the cluster enabled license key. leave the Load Balancer Type as Round Robin. Keep the default value 2 for Cluster Memory Storage Number of Copies. Launch the JReport Server installed to C:\JReport\Server2. Go to the Cluster > Configuration panel. Realm and CRD Result Number of Copies to 1. then click Save to enable the cluster. . 5. 3. 11. Check the Cluster Scheduler Lease option to enable lease for the cluster. then set Port and Administration Port respectively to 8886 and 8887 to make them different from those of Server1. valid time and check interval for the cluster scheduler lease. input the e-mail addresses of the people to whom you want to send a notification e-mail. The cluster consists of two copies of JReport Server on one computer. and in the E-mail Address text field. Log onto the JReport Administration page of Server2. click Configuration > Service on the system toolbar. Keep the default values for Properties Directory. Restart the JReport Server installed to C:\JReport\Server2. The cluster uses shared directories for resources so no resource copies are required. 8. You may use any port numbers which are available on your system. thus 2 memory copies will be shared in the cluster. The cluster uses one server DBMS. 10. 7. Click Cluster > Configuration on the system toolbar. 4. 12. 9. Log onto the JReport Administration page of Server2 using the administration port 8887 set in Step 3 (http://localhost:8887). 2. Start JReport Server Monitor and check the cluster on the JReport Monitor page. Use the same cluster name as Server2. click Save to accept all settings and shut down Server1. 19. In the Scheduled tab. 20. and then submit another scheduled task. log onto the JReport Administration page (http://localhost:8889). you will see the newly scheduled task. then shut down the server. If there are two or more JReport Servers started on one machine. Go to the Cluster > Configuration panel. It doesn't matter which one you started first. then click Save to enable the cluster. 21. Restart the JReport Server installed to C:\JReport\Server1. 27. and then log onto the JReport Administration page. 22. 23. the RMI port number of each clustered server must be changed to a unique one. Access the JReport Console page of the first server using port 8888 as an administrator. 25. 16. Notes: q Publishing to disk is not supported when you schedule to run a report in JReport cluster. 28. It will be recreated when you restart Server2 with a unique number. You can only view scheduled tasks that you have submitted. Copy rmi. Click Save to accept all the changes. thus making Server1 join the existing cluster. Start the server Derby DBMS service by double-clicking the startNetworkServer. Check the Enable Cluster option. In this example. Edit C:\JReport\Server2\bin\dbconfig. Restart Server1 and Server2. 24. Access the JReport Console page of the second server using port 8886 as Tom.properties in C:\JReport\Server2\bin and remove cluster. and then submit a scheduled task. From the JReport Console page of the clustered servers. and type the port number in the Server's RMI Port text field.auth in C:\JReport\Server1\bin to C:\JReport\Server2\bin.14. Log onto the JReport Administration page of the second server and create a new user Tom in the Security > User panel. then click Cluster > Configuration on the system toolbar. The default port number is 1129. since the other server will use the default port number 1129. We only want Server1 to start the server DBMS since we will always use the Server1 database. Edit server. in order to avoid port conflicts. you can only view completed tasks that you have submitted. Remember to keep Server's RMI Port to its default value 1129. 17. the port number is changed to 1130. Type the IP address or host name of Server2 in the Server's RMI Host text field. Upon finish.xml and remove the lines with auto-start-derbyservice. Launch the JReport Server installed to C:\JReport\Server1. 15.id.member. configure Server's RMI Host and Server's RMI Port. q q .bat file in C: \JReport\Server1\derby\bin. This allows RMI to be authorized between the two systems. 18. The port is the RMI port of the clustered server. 26. . then after you shut down one server. all the scheduled tasks running on this server will be run on other servers.q If there are more than two clustered servers in the cluster. 0. then set the active count. Resource Root. 9. Keep the default values for Properties Directory. Log onto the JReport Administration page and click Cluster > Configuration on the system toolbar. Click Save to accept all the changes. Make the time difference between the target computers be within one minute. all nodes in the cluster must use the same database. 4. 2. This means that each resource will be copied to 2 of the 3 servers so there will be no single point of failure for the resources. This ensures that all servers in the . valid time and check interval for the cluster scheduler lease respectively. 13. then click Save to enable the cluster. There will be three computers in the cluster. Take the following steps to set up the cluster: 1. thus 2 memory copies will be shared in the cluster. Type the port number in the Server's RMI Port text field as 1129.1. 10.168. 12. Launch the JReport Server installed to /home/JReport/Server1 on node1. Install JReport Server on each of the three nodes in directories /home/JReport/Server1.1). and go to the JReport Administration page > Cluster > Configuration panel. Realm Directory. all three nodes will use the database Server1 uses. in the Configuration tab.Example 2: Setting up a JReport Server cluster for a production environment This example demonstrates how to set up a JReport Server cluster on Unix/Linux by configuring the cluster UI on each JReport Server. Check the Notify via E-mail When a Server Is Down option. 11. 5. realm and CRD result number of copies to 2. 8. Restart the JReport Server on node1. In the Configuration panel.0. and go to the Realm DB panel to copy the URL using the same way. 3. In the Server's RMI Host text field.0. Leave the Load Balancer Type as Round Robin. History Directory and Temporary Files Directory.168.2) and node3 (IP address: 192. and in the E-mail Address text field. In order to use a JReport Server cluster. 7. specify a cluster name and check the Enable Cluster option.0. Keep the default value 2 for Cluster Memory Storage Number of Copies. Go to the Data > System DB panel of Server1.168. 6. The defaults of 2 active schedules with a time of 300 seconds and check interval of 30 seconds are a good starting point.3). They are node1 (IP address: 192. node2 (IP address: 192. Keep the cluster storage history.168. 14. copy the URL in the URL text field to a temporary file. and install JReport Server Monitor on one of the nodes. Check the Cluster Scheduler Lease option to enable scheduler leases for the cluster. /home/ JReport/Server2 and /home/JReport/Server3 respectively using the appropriate license key for the cluster. input the e-mail addresses of the people to whom you want to send a notification e-mail. type the IP address or host name of Server1 as 192. In this case. All JReport Servers in the cluster use Apache Derby as the server system database. auth in /home/JReport/Server1/bin to /home/JReport/ Server3/bin. Log onto the JReport Administration page and click Cluster > Configuration on the system toolbar. 30. Click Save to accept all the changes. Launch the server on node1. Launch the JReport Server installed to /home/JReport/Server2 on node2. Type the port number in the Server's RMI Port text field as 1129. type the IP address or host name of Server2 as 192.cluster share a single DBMS instance. Check the Enable Cluster option. then shut down the server. In the Server's RMI Host text field.3. 26.2. Start the server Derby DBMS service by running the startNetworkServer. 17. 16. 27. 23. 31. Similarly. then click Save to enable the cluster. copy rmi.sh file in /home/JReport/ Server1/derby/bin. 18. 29.168. Restart the JReport Server on node3. make the system database and realm database in the URL text field the same as those of node1. type the IP address or host name of Server3 as 192. Go to the JReport Administration page > Data > System DB/ Realm DB. make the system database and realm database in the URL text field the same as those of node1. . Type the port number in the Server's RMI Port text field as 1129. Shut down the server. Start JReport Server Monitor and go to the JReport Monitor page to track the cluster. Go to the JReport Administration page > Data > System DB/ Realm DB. 25. 28. you will see the following information: JReport Server is ready for service. 24. In the Configuration panel. In the Command Prompt window. use the same cluster name as Server1. 19. Just like what we did with node2. In the Server's RMI Host text field. Just as we did with node2. then shut down the server. 21. This allows RMI to be authorized between node1 and node2. thus making Server2 join the existing cluster. Click Save to accept all the changes.0.168. Copy rmi. launch the server on node2 and node3.0.auth in /home/JReport/Server1/bin to /home/JReport/Server2/bin. Go to the Cluster > Configuration panel. Go to the Cluster > Configuration panel. 20. 15. 32. 22. Restart the JReport Server on node2. enable cluster and make node3 join the existing cluster too. Launch the JReport Server installed to /home/JReport/Server3 on node3. Evaluate the performance weight of the clustered servers. you can: q Enable and set up a cluster. JReport Server cluster administration is described in the following topics: q Configuring performance weight Balancing the server load Monitoring clustered servers q q . you can also administer the servers in a cluster. In this section. Configure the clustered servers.Managing JReport Server clusters The JReport Server Cluster page allows you to enable a cluster and configure and evaluate the performance weight of the servers in the cluster. On this page. Set the shared parameters of the clustered servers. q q q On the JReport Administration page. type=2) algorithm for load balancing. The higher performance weight you set to a clustered server. Start a clustered server in the cluster. To configure performance weight: 1. on its JReport Administration page.5 2 1.when there are no free servers: Active Servers Is local server Maximum concurrent reports Number of currently running reports Performance weight Calculation Weighted current reports 2.25 ServerA ServerB TRUE 10 10 4 FALSE 10 10 5 ServerC FALSE 10 10 8 Comments . Specify a weight value for each clustered server manually. specify a catalog and a report that will be used for the testing in the Catalog and Report text fields and then click the Test button. 3. click Cluster > Weight to show the Weight panel. Performance weight is a positive float number.when there are free servers: Active Servers Is local server Maximum concurrent reports Number of currently running reports Performance weight Calculation Weighted current reports Is free Candidate servers Candidate servers Selected server 0. 4.5 FALSE Current < MaxConcurrent.6 TRUE YES YES 0.6 TRUE YES YES YES 0. If you want to test each clustered server's performance weight value at current time. 2. the higher chance it may get selected by the server that has the active scheduler during load balancing. Click OK to save the weight values. you will have to configure a performance weight for each clustered server in the cluster.Configuring performance weight If you have chosen the Weighted Min-load (loadbalance. The following are two examples for how Least Weighted Current Reports algorithm works: Example 1 . or MaxConcurrent is unlimited Select from free servers Select servers which have the least Weighted current reports Local server has higher priority ServerA ServerB TRUE 8 6 10 FALSE Unlimited 6 10 ServerC FALSE 5 5 10 Comments Example 2 . or MaxConcurrent is unlimited Selects from all servers when all servers are full Select servers which have the least Weighted current reports Select ServerC .Is free Candidate servers Candidate servers Selected server FALSE YES FALSE YES FALSE YES YES YES Current < MaxConcurrent. Customized load balancing algorithm based on API You can write your own load balancing algorithm based on the API included in JReport Server.bat in the ADDCLASSPATH variable. Compile DemoLoadBalancer. To do this.Balancing the server load In a cluster environment.custom_class=DemoLoadBalancer to the server's startup file JRServer. root=%REPORTHOME%" . Submit some tasks for running. Note that if you create a load balancing algorithm with the API. 2. Load balancing process 1. you need to add JRESServlets.custom_class=DemoLoadBalancer "-Dinstall. 5.class to the class path of setenv. the customized loadbalancer DemoLoadBalancer will then be applied. Tip: You can also directly specify a server in a cluster to perform a scheduled task instead of using load balancing.exe" -Dloadbalance. When the time of a scheduled task arrives. For example: "%JAVAHOME%\bin\java. You will now find that these tasks are allocated to the clustered servers based on the DemoLoadBalancer code. .jar DemoLoadBalancer. You can find it in <install_root>\help\server\en\samples. The server that has the active scheduler selects a server in the cluster according to the load balancing algorithm specified which can either be a built-in one or a customized one. active schedulers compete and the winner gets to trigger the schedule..jar to the class path): javac -classpath <install_root>\lib\JRESServlets. Add DemoLoadBalancer. and then sends the task to the selected server. 4.java. Take the following steps: 1. 3. Add the parameter -Dloadbalance.bat which locates in <install_root>\bin.java to generate the class file as follows (when compiling DemoLoadBalancer. and then use the Specify a preferred server to run the task option in the General tab of the Schedule dialog to specify a server manually. it will take effect in place of other built-in load balance algorithms you have set. Launch JRServer.bat. Assuming that you have several clustered servers. JReport Server provides a load balancing mechanism which enables the server to work more effectively. A demo DemoLoadBalancer.. first make sure that the Identify Server Preference option is enabled in the Profile dialog (Profile > Customize Server Preferences > Advanced > Identify Server Preference).java 2.java has been provided to illustrate how to customize load balancing using APIs. and setLoadBalanceType(3) means respectively the algorithm Least Current Reports (Min-load). setting the API method as setLoadBalanceType (0).Reference: For more details. if all servers are full. For example. Notes: q You can choose the load balancing type by setting the API method setLoadBalanceType() at jet. For the load balancing algorithms: the server that holds the active scheduler selects from the servers with the number of concurrently running reports less than maximum number first. setLoadBalanceType(2).api.server.LoadBalancer interface in JReport Server Javadoc located in <install_root>\help\server\en\api\jet\server\api\cluster. setLoadBalanceType(1).ClusterAdminService. However. Least Weighted Current Reports (Weighted Min-load) and Random will be chosen.admin. q . it will select from all of them.cluster. Round Robin. server. see the jet.api. 3. the following steps must be taken: 1.properties. 6. Copy rmi. Launch MonitorServer. or by clicking the Monitor link on the JReport Administration page.auth from <server_install_root>\bin of the clustered server whose IP address and port information you modified in the last step to <monitor_install_root>\bin.port in server. Related topics: q Monitoring JReport Server . JReport Server Monitor should be used together with JReport Server. Note: The Monitor link will not be displayed on the JReport Administration page when the web. Modify the server.enable property in the server. or remove rmi. Start JReport Server.Monitoring clustered servers JReport Server Monitor is a standalone web-based application used for monitoring the overall performance of JReport Server. q q q Before you can use JReport Server Monitor to monitor servers in a cluster. JReport Server Monitor contains the following main features: q Inspects the status of JReport Server. Download and install JReport Server Monitor. Shows server performance statistics in Graph/Text mode.monitor. Creates profiling reports: performance reports and statistics reports. auth from <server_install_root>\bin of this clustered server. link. Maintains JReport Server. 4. Access JReport Server Monitor using http://monitorhost:monitorport (default 8848). 5.bat in <monitor_install_root>\bin to start JReport Server Monitor. You can specify the monitor port by setting monitor.properties file in <monitor_install_root>\bin to configure the IP address and port information of one clustered server. 2.htmladaptor.properties file in <server_install_root>\bin is set to false.jmx. 1 192.168. 192. which includes JReport clustered and non-clustered server environment.2 Refer to Setting up and configuring a JReport Server cluster for the specific steps of setting up JReport Server in a cluster.Dispatching RMI Server Pages requests in multiple server environment You can dispatch RMI Server Pages requests in multiple server environment. In the following sections. Configure a clustered JReport Server. The generated WAR file is saved to the default directory <install_root>\bin\distribute.168. In general. Set up the server cluster.xml for remote integration. The dispatcher has the Fail Over function. Sample solution: dispatch RMI Server Pages requests in clustered server environment This sample solution is to visit Server Pages JSPs remotely from WebSphere 7 to JReport Clustered Server.0.0. we will explain clearly the exact operations you are expected to make in each of the main steps. 3. 2. . See the below diagram for the structure: You should be able to set up a similar service with any Java EE server by following the same procedure based on your preferred application server documentation. Setting up the server cluster In this example we will set up two into the cluster using the Round-Robin algorithm. This demo dispatcher dispatches requests from different sessions to different JReport Servers according to Round-Robin algorithm. No request will be dispatched to the unavailable server until the server is checked to be available again. Build a JReport Server WAR file as defined by makewar. Generating a WAR file containing Server Pages RMI JSP and dispatcher for WebSphere 1. Generate a WAR file containing Server Pages RMI JSP and dispatcher for WebSphere. 4. the solution can be categorized into the following major steps: 1. Deploy the WAR file to WebSphere. which will periodically check whether there is any unavailable server in the cluster. auth_file=C: \JReport\Server\bin\rmi. Click Next.remote.war file. .configFile and jrs.makewar. click Save. 4.dispatcher. Type RMI_Server Pages in the Application name field. This step is to configure the dispatcher and cluster server.auth 2. Expand Servers.1 -Djrs.jar and <server_install_root>\lib\servlet. 3. 10. Deploying the WAR file to WebSphere 1. You can open Administrative Console by using the Start Menu.java stored in <server_install_root>\help\server\en\samples with <server_install_root>\lib\JRESServlets. 5. Click Finish in the Summary page. go through Server Types > WebSphere application Servers > server1 > Process definition (in the Server Infrastructure table > Java and Process Management) > Java Virtual Machine > Custom Properties (in the Additional Properties table). 9.bat buildRemoteWar -Djrs. Start IBM WebSphere 7.rmiport=1129 -Djrs. Click Browse to select your . Click the New button to add properties for our demo dispatcher com. wait until the process is completed. and then click Install New Application.remote. Compile the dispatcher DemoRemoteDispatcher. In the Context root field. In the WAR file. click Save directly to the master configuration. Go to WebSphere Admin Control to add some properties for this dispatcher.jinfonet.168. After successfully logging in.jar. Then in the Save directly to the master configuration dialog. 8. After the installation process is completed. Open Administrative Console.remote. The class file DemoRemoteDispatcher.host=192. or by using the URL: http:// hostname:9060/ibm/console.rmi. DO NOT check the Precompile JavaServer Pages files option. 6. Do not make any changes in the next two pages. type a context path such as /servlet/ ("/servlet" is also ok). drag the class files generated in step 2 to the classes\demodispatch folder. Click Next.class and some other class files will be generated.dispatcher. where hostname is host name or IP address.0. The installing process may take several minutes. 3. and 9060 is the port number. and then click Next. 7. Do not check any option in this page. expand the Applications node. assuming that this folder has already been created in the WAR file. 2. rmiadminservice. to_version_pdf=true&jrs. Change server.cls&jrs.enable=true server.properties file like below: rmiserver=192.report=/cheping/CustomerAnalysis.jsp?jrs.1:1129 rmiserver=192.catalog=/SampleReports/ SampleReports.properties file is generated. Click the Save link in the Messages table and click Save button to save the changes.168. 12. and then restart WebSphere 7. 11. If you have set up JReport Server in a cluster.2:1130 .enable=true Then you can start JReport Server and access your Server Pages with a URL such as: http://hostname:9080/remote/jinfonet/submitSchedPage.Note that the dispatcher DemoRemoteDispatcher. 2.schedule..jrtasks. you can append their host and port information to the above text file.launch_type=0&jrs.properties file in <server_install_root>\bin as follows: server.0. auth_pwd=admin . Configuring the JReport Server cluster 1.task_class=jet.server.java will read the clustered server information in the hostport. Make sure JReport Server has been started once in order that the server.to_version=true&jrs.auth_uid=admin&jrs.168.PublishRptTask&jrs.cat&jrs.0.submit_schedule&jrs.cmd=jrs..rmiserver. there are two types of security mechanisms. q Report security system Server security system q . This chapter discusses these two mechanisms respectively. One is to deal with report security.JReport Security System In JReport Server. and the other is to manage user permissions on JReport Server. an end user will only see what he or she is allowed to see.Report security system This section demonstrates the control of access to reports and to different subsets of data by means of defining report security. After applying report security. The following topics explain the report security at each level in detail: q Cached report bursting Record-level security and column-level security q . report security can be classified into three groups: cached report bursting. In general. record level and column level. This section focuses on how to view and schedule a report that has cached report bursting with JReport Server. Groups. and Roles. q Scheduled DHTML and HTML reports will create a report result with the report data for all possible users. The feature enables different users to view different data groups according to their access privileges. report bursting does not support DHTML and it makes a separate physical report result for each user and the administrator needs to manually restrict access to the results. JReport Server will use the security identifier of the user to restrict access to the data in the report to the specific groups the security identifier is allowed to view. however. The end result is the same as the bursting report in that the user sees only his data. In this way. the advantage to the administrator is there is only one version result to manage. groups. q For detailed descriptions about setting up cached report bursting in reports. q Viewing a report with cached report bursting Scheduling a report with cached report bursting Example: e-mailing billing reports q q . however. On-Demand and schedule non-DHTML and non HTML reports build a separate data result for each request containing only the data the security identifier allows. By defining which groups of data are available to which users. Cached report bursting operates 2 different ways depending on the output format selected and if the report is ran on-demand or scheduled. group and role of the user and merges the groups of data in the report the user is authorized to see and displays it to the user. it is similar to a report using Record-level Security. see Setting up a cached report bursting policy for a report in the JReport Designer User's Guide. the setup mechanism is different. JReport supports cached report bursting which creates a security mechanism for controlling access to the report. Grant. It also applies to nested groups. report results are created for each user. Cached report bursting is implemented with these security properties on the group panel: Cascade.Cached report bursting Security in a report is a kind of privileged control. When a user views the report result using cached report bursting. When a user accesses the report result. role and group. This allows the report to run with a single query to the DBMS to create the report for all users in one pass. or roles. It is similar to report bursting. JReport checks the user. PDF. You can also advanced run reports with cached report bursting in different formats. including DHTML. Note: When designing the report in JReport Designer. 1. the significance of this function is only apparent after reports have been published to JReport Server and users access it using their JReport User ID (security identifier). PS. TEXT. To view a report with cached report bursting in JReport Server. 4. Browse to the report that you are going to view. Access the JReport Console page via a web browser with the user ID admin. the corresponding groups will be displayed according to the security identifier.Viewing a report with cached report bursting Since the control of report access is not possible without a user ID. you will then only be able to view the BC group. HTML. When a client views a report with cached report bursting in JReport Server. the report must first be published to the server from JReport Designer. the specified group will only display its group header and footer. 2. the security for a report that is grouped by the Customer_Region field has been set as follows: q The user ID admin has the privilege to view the CA and MN groups of the report. q Then. Excel. The user ID jennifer has the privilege to view the BC group of the report. . For example. and you will then be able to view the CA and MN groups of the report. If you log onto JReport Server with the user ID jennifer. 3. if the Cascade property is set to be false. XML and Rich Text Format (this feature does not support the RST and Applet formats). Click the report name. if in JReport Designer. Assuming that the catalog and the report have been published to JReport Server. 3.properties in <install_root>\bin: q When server. the scheduled result only contains the data that the user who did the scheduling is allowed to see.cachedreportbursting=true which is the default. Type the subject and select the result format.2 versions of JReport. Then when end users view the result. with the contents in accord with their access right to the report. and then send the report result to admin and jennifer. Scheduling to HTML/DHTML to version When you schedule a task to publish a report with cached report bursting to the HTML and/or DHTML formats to the versioning system. This is primarily for compatibility with pre-8. q When server. make sure you have input the e-mail addresses of the users when . JReport Server supports a multiple mail feature which enables sending the data results directly to each user who is authorized to view the report. 2. there is a slight difference. select the report tab with cached report bursting. However. summaries and other similar data will be recalculated based on the privileged data. 4. They can perform interactive actions on the scheduled DHTML result as on other DHTML results.Scheduling a report with cached report bursting You can schedule a report with cached report bursting as a normal report. Note: Before publishing to e-mail. The following procedure shows how to schedule a task on a report with cached report bursting to be published to e-mail. Note: If the report is cached report bursting and RLS/CLS mixed. there are some differences between the formats in which the report is to be published.cachedreportbursting=false. In the General tab. 5. Browse to the row that the report is in. Scheduling to e-mail When you schedule a report with cached report bursting to publish it to e-mail. the scheduled result depends on the mode which is controlled by the property server.enable. then click Finish. put the mouse pointer over the report row and click the Schedule button on the floating toolbar. and two users admin and jennifer both have the permission to view the report. JReport Server will get the e-mail addresses from the user accounts.enable. 1.enable. In the Publish tab. they will see only the data they are privileged to see according to the cached report bursting setting in the report. Access the JReport Console page with user ID admin or jennifer. and the formulas. the scheduled result includes full data. then when other users other than the user who did the scheduling view the scheduled HTML or DHTML result. switch to the To E-mail sub tab and then check This report has Cached Report Bursting. E-mail the report to each specified user. a blank page is displayed.cachedreportbursting in server. You can then type in the e-mail address of the user. Access the JReport Administration page. Scheduling to other formats When scheduling a report with cached report bursting to other formats. and then click it. the scheduled result only contains the report data that the user who does the schedule is allowed to see.configuring JReport Server. . click Security on the system toolbar. choose the user name that you want to edit in the User ID column. 2. To do this: 1. In the User panel. and then select User from the drop-down menu. 2. the mails will not be sent successfully. UserMailList. JReport Server allows you to send a scheduled report result to the e-mail addresses accordingly. and then grant a formula FPageLevel to it. since a user ID that is appropriate for the report doesn't always exist in JReport Server. Each of them may refer to a particular report. JReport provides two interfaces for you to retrieve user and e-mail information from a customized source: q jet. design a report and set cached report bursting for it. as illustrated below. The getInstance() method should be implemented in this interface to get an instance of jet.UserMailListFactory interface. each recipient will only be able to view certain parts of the report data. The following is a simple example: 1. In JReport Designer.UserMailListFactory interface. jet.UserMailListFactory Used to get the UserMailList instance implemented by the user. Therefore. implement the two interfaces to import the e-mail lists saved in the Customers table. based on the cached report bursting settings of the report and the user information stored in JReport Server (e. in this example. implement the jet.Customer Name.server. Then in the server side.server. The content of the formula FPageLevel is as below: @"Customer Name".api.api.Example: E-mailing billing reports Sometimes. Specifically.UserMailList Used to get e-mail information from a customized source.server. group the report data by Customer Name. using e-mail information of server users is not reliable. However.server.server. Take the following implementation as a reference.g. This means that only the records of the specified group will be shown at runtime when you enter with different IDs -. sending pertinent report data to corresponding mail recipients is required.api. e-mail address information). The best way to resolve this is to use an external e-mail information source by implementing the UserMailList and UserMailListFactory API that JReport provides. 3. so that later in the server side. there is a Customers table with customer names and their e-mail addresses. you can get one implementation of the UserMailList. Then apply cached report bursting for this report.api. You can design a report using this table and others.api. q You can implement multiple classes of interface UserMailList. In cases like this. see JReport Server API Documentation. where the implementing class . In this case. you can schedule the report and send pertinent data to different recipients saved in this Customers table. Here. For more information on these two interfaces. By using the getInstance() method in the jet. String clsName = "UserMailList_" + rpt + "_Impl".getProperty(APIConst. } catch (IllegalAccessException e1) { e1.util.server. .newInstance(). import java.printStackTrace().odbc.lastIndexOf("/") + 1). such as "UserMailList_InvoiceReport_cls_Impl". Then implement the jet.util.replace(' '.printStackTrace().forName(clsName).newInstance()). which gets the user and e-mail information from the customized data source. } private void loadData () { try{ String jdbcDriver = "sun. import jet. '_').replace('.api. } rpt = rpt.server.api. import jet.*. } } 4.api.*. private String curRealmName = "defaultRealm".printStackTrace(). return null.server.jdbc.sql. which contains Customer Name and Customer E-mail columns.printStackTrace(). } catch (ClassNotFoundException e1) { e1. import jet. import java. try { UserMailList mailList = (UserMailList)Class. } catch (RptServerException e) { e.forName(jdbcDriver).JdbcOdbcDriver".UserMailList interface. return mailList.getTaskProperties().*. public UserMailList_InvoiceReport_cls_Impl() { loadData(). } catch (InstantiationException e1) { e1.*.'.name of the UserMailList interface is formatted as "UserMailList_" + report + "_Impl". The following implementation gets the e-mail list from the Customers table. public class DemoUserMailListFactoryImpl implements UserMailListFactory { public UserMailList getInstance(ServerInfo serverInfo) { if (serverInfo == null) { return null.TAG_REPORT). DriverManager.registerDriver((Driver)Class.*.substring(rpt. '_'). } return null.cs. rpt = rpt. try { rpt = serverInfo. public class UserMailList_InvoiceReport_cls_Impl implements UserMailList { public static Hashtable userEmails = new Hashtable(). rpt = rpt. } String rpt = null. Register the above classes to JReport Server before the server is started.elements().Enumeration getRoleMailAddresses (String realmName.addElement(userEmails. }else{ return null.Connection conn = DriverManager.next()){ userName = rs. }else{ return null.put(userName. } } public java. String userEmail = null.Enumeration getAllMailAddresses(String realmName){ if (realmName. String groupName) { if (realmName. userEmail = rs. }else{ return null. ResultSet rs = stmt. while(rs. return groupEmails. } } public java.containsKey(groupName)) { Vector groupEmails = new Vector(). String userName) { if (realmName.lang.equals(curRealmName) && userEmails.executeQuery("select * from Customers"). roleEmails. Statement stmt = conn.get(roleName)). String userName = null.addElement(userEmails.equals(curRealmName) && userEmails. if (userEmail != null) { userEmails. } } public java. groupEmails.equals(curRealmName) && userEmails.createStatement(). } } public java. }else{ return null.util.getString("Customer Name"). } } }catch(Exception e){ e.equals(curRealmName)) { return userEmails.util.printStackTrace(). .util.String getMailAddress(String realmName.getConnection("jdbc:odbc:jinfonet4").Enumeration getGroupMailAddresses (String realmName.elements() . return roleEmails.getString("Customer Email"). String roleName) { if (realmName. } } } 5. userEmail).containsKey(roleName)) { Vector roleEmails = new Vector().get(groupName)).get(userName).elements() .containsKey(userName)) { return (String)userEmails. Provide the necessary information and then submit the schedule.jinfonet. Add the path of the implementation classes to the class path of the command line/batch file. 7.jinfonet. . Add the parameter -Dcom. Schedule the report. the parameter should be -Dcom. E-mail the report to each specified user. b. mailListFactory=DemoUserMailListFactoryImpl. where UserMailListFactoryImplName indicates the implementation of the jet. 6. check the option This report has Cached Report Bursting.api. Start JReport Server and then publish the report and catalog.UserMailListFactory interface. In this case.server.mailListFactory=UserMailListFactoryImplName to the command line/batch file that starts JReport Server.a. The report will be processed and sent to the corresponding recipients with pertinent report data. publish to e-mail. No matter to whom you need to provide information. based on the security information file. However. This enables you to provide different users with accordingly different. q Connection-scope security You can build connection-scope security policies: where each security policy refers to a data source connection in the catalog. you will find that the security settings are applied to the report. a plant manager or thousands of customers. you can use the security information file to set the security policies for a report. Note: The report designer defined users and roles may not be recognized by JReport Server. but appropriate contents. Then. Both RLS and CLS can be connection-scope security. JReport Designer have two types of the security policies. Report-scope security Additionally. That is. record-level security can be of report scope. That is. without having to repeatedly build security information for each report. q Record-level security can be applied simultaneously to both connection and report scopes. synchronize the security information with JReport Server using the Merge option. create these users and roles respectively in JReport Server. different users will only see the data they are supposed to see. If your security policies contain such users/roles.Record-level security and column-level security The record-level security (RLS) and column-level security (CLS) of JReport Designer allow you to control user access to different subsets of data and ensure that people only see what they are supposed to see: record-level security allows you to define which records are to be revealed to any given user. it will override a connection-scope security policy applied to the report. See also Record-level and column-level security in the JReport Designer User's Guide for details about how to set up record-level/column-level security policies and apply them to reports in JReport Designer. and then in JReport Designer. one is a security policy based on a data source connection (connection-scope security policy). . you can simply apply an existing security policy to the report. you can then publish it to JReport Server as normal. report-scope security policies have a higher priority than connection-scope security policies. when you log onto the server as different users. if a report-scope security policy has already been applied to a report. JReport Designer allows you to control access to information according to your requirements. while column-level security allows you to define which report column is revealed to any given user. That is. Report-scope security policy doesn't support column-level security. and the other is a security policy based on a single report (report-scope security policy). Running reports with record-level/column-level security After setting up the security policy for a report in JReport Designer. If you want to implement the same security policy in a group of reports. JReport Server also provides two sets of implementations for you to directly adopt. a cache system is added between the security service and the Security API. groups and roles. The following is a diagram of the JReport Server security system structure: Go through the following topics for details about the server security system: q Built-in security system Role based security Security cache system Customized implementation of the Security API Single sign-on q q q q . One is an implementation based on a database that makes the built-in security system. One is the default applied security of setting permissions for users. the performance of the server security system may be lowered. In order to promote performance. with which you can customize your own implementation. As a result. and users and groups are mapped to roles. groups.Server security system JReport Server supports two types of security mechanism. The other is role based security in which permissions are defined on roles only. The JReport Server security system is implemented based on a whole set of Security APIs. The other is an LDAP implementation to be used when JReport Server can directly access an LDAP server. roles and ACLs for the security system. Accessing data by direct API implementation may result in many time-consuming IO operations. The cache system is used to store security objects including users. q Using an LDAP server's security system . The below diagram illustrates the built-in security structure in JReport Server: And the below diagram illustrates the inherited relationship among User. At runtime. Group and Role. JReport Server offers these security features: q Realm Realm is an abstract security concept. There can be more than one realm on the server and each realm is independent from others. which can contain any characters other than forward slash (/) and backward slash (\). q User To use JReport Server. which hosts the resources and authentication entities on JReport Server. which consists of a unique user name and .Built-in security system JReport Server provides a built-in security system for you to set up and maintain security on it and protect resources from inappropriate access by users. group accounts and role accounts. only one realm can be active and only the users and resources in the active realm are accessible. The authentication entities consist of user accounts. A realm is identified by a unique name. The resources and authentication entities that reside in different realms are different. you must have a user account. while the Message Table Manipulation privilege enables dashboard end users to map fields from different data sources in a dashboard. changing the properties (not including permission settings) of the objects in the resource tree or version table. Roles. Allows or denies viewing object properties. and archive versions. Allows or denies submitting resources to schedules (report type resources only). and thus groups or roles can inherit the permissions of other roles. JReport Server comes with two built-in role accounts. JReport Server comes with two built-in user accounts. The built-in role accounts cannot be deleted. and archive versions. JReport Server verifies your identity when you type in your user name and password. groups or roles. JReport Server prevents you from accessing the web services that it provides. Permissions in JReport Server include: Permission Visible Read Write Description Allows or denies viewing object names in the resource tree or version table. Allows or denies updating report status. Role Users must have certain user rights and permissions in order to perform tasks on resources. Allows or denies deleting objects in the resource tree or version table. and Update Status. in order to ensure that only valid users have access. versions. Write. and then logs you on. and archive versions. resources. groups or roles that have obtained the Grant permission are also endowed with the other seven permissions .password. The Admin user account can neither be deleted nor disabled. Read. Users. A role can also be assigned to other groups or roles. resources. and. Permission Permissions. administrators and everyone. and can grant these seven permissions except the Grant permission itself. help you to efficiently assign the appropriate user rights and permissions to users. associated with resources and folders. admin and guest. Execute. If your user account has been disabled or deleted. Advanced Properties. folder content. users that have the privilege of Advanced Properties are allowed to view advanced information of version properties such as catalog connections and report related resources. if it is a folder. such as folders. the status of reports in the folder. Alias q . which represent an aggregate of permissions. Schedule. such as folders. JReport Server offers these types of privileges for users: Publish. Users that are granted the Publish privilege will be able to publish resources to JReport Server. and therefore inherit the resource and folder permissions from the group. which represents an organization of user accounts. The built-in user accounts cannot be deleted. The administrator role account can neither be deleted nor disabled. q Group The principle group. is available for managing users. Users or groups can be added into a group as its child members. such as folders. Assigning roles to users gives the users all of the user rights and permissions of the roles to perform their jobs with. It can be used to manage different access permissions unrelated with nodes. q q Delete Execute Schedule Grant Update Status q Privilege Privilege is a mode for managing permissions.Visible. Delete. Allows or denies publishing folders and resources. are the rules that are granted to users to control their access to the resources and folders. Allows or denies running resources in normal and Advanced mode (report type resources only). and modifying version table settings. and Message Table Manipulation. Allows or denies granting permissions to other users. and if it is a folder. resources. JReport Server organizes file and directories into a Resource Tree. Related topics: q Managing security . so that she can only see the market resource node and thus can directly walk into the report file she is interested in. For example. you may set an alias resource tree (based on the resource tree) for Tanya. Aliases are used to provide different "views" of a tree for different users to enter the Resource Tree. an alias is a combination of users and resource nodes. To manage JReport Server's built-in security. you must be a member of the administrator role in order to access the JReport Administration page. In summary. Role only based security is similar to Java EE security where the developer assigns roles and during deployment users and groups can be mapped to the roles so if you are already using Java EE security. In this case.ui. . To switch to the role based security system. groups and roles is applied. q In the server.set_permissions. the following three properties will not take effect since they control UI display of setting user/group/role permissions: server. this would be the best method. and users and groups are mapped to roles.role server. since it is used to control UI display and is of no use in the role based security environment.Role based security In addition to the security system based on users.properties file. in both the JReport Administration page (port 8889 by default) and Console page (port 8888 by default).set_permissions. If the option is checked. the option is unchecked and the security mechanism of setting permissions for users. set server.group server.ui.user If the role based security system is used. groups and roles. the Permission Setting UI Displays option will be hidden automatically. when you set permissions of a resource node.authorization to true. JReport Server also supports a role based security system in which permissions are defined on roles only.ui. By default. you can use either of the following two methods: q Check the Role Based Authorization option on the JReport Administration page > Configuration > Advanced panel. there are only roles displayed.rolebased.set_permissions. groups and ACLs. so as to synchronize security data between the cache system and the external security system. roles. The cache system caches not only security objects for the built-in security system.Security cache system The security cache system temporarily stores security objects such as users. The following focuses on the configuration and synchronization of the security cache system: q Configuration of the security cache system Synchronization of the security cache system q . If the security service needs security information. it will fetch it from the security data. When the security information is modified in the security system. the Security API is invoked directly in order to modify the security data. it will request it from the Security API. but also those implemented by the Security API from the external security system. It is recommended that you invoke it when you access the external security system. it can fetch it from the cache for better performance. When JReport Server requires information from the security system. and is in charge of storing and checking principal permissions. through which the cache is noted to update the cached information. Note: There is a special interface SecurityListener in the cache system. ACL. and then cache it in the cache system. However. It caches security information in the security data. is the core object of the security authorization system. if the security data cannot find the information. short for Access Control List. r r r 3.protection.protection.role. Should be an integer value. Its value indicates the maximum number of user objects that the security cache can store. Configuring using the API method .size This should be an integer value.size=1000. Should be an integer value.size=100.cache. the cache can then store 100 group objects.security. There are three ways in which you can customize the security cache system as explained below: Configuring by editing the server. click Configuration on the system toolbar.cache.security.security.security. The default value is 50. If server.security. Role Cache Size The maximum number of role objects that the security cache can store.user.properties file Edit the following four properties: q server. four options are provided for specifying the cache size: r User Cache Size The maximum number of user objects that the security cache can store.group. When done.cache.user. click Save to apply the settings.security. The default value is 100. and then select Cache from the drop-down menu. Log onto the JReport Administration page. the cache can then store at most 1000 user objects. q q q Configuring from the JReport Administration page You must be a member of the administrator role in order to access the JReport Administration page. The default value is 50. groups and ACL objects that can be cached.cache.security.size This should be an integer value. server. In the Cache panel. Its value indicates the maximum number of role objects that the security cache can store. roles. Its value indicates the maximum number of ACL objects that the security cache can store.size This should be an integer value.cache. switch to the Security Cache tab. the cache can then store 100 role objects. q If server.size=100. q q q For instance. If server. Should be an integer value.Configuration of the security cache system The security cache system enables you to define the maximum number of users. Group Cache Size The maximum number of group objects that the security cache can store. 1.cache.role. If server.cache.size=100.cache. Protection Cache Size The maximum number of ACL objects that the security cache can store. server.group. the cache can then store 100 ACL objects.security. server. 2.size This should be an integer value. Its value indicates the maximum number of group objects that the security cache can store. Should be an integer value. The default value is 1000. ConfigurationAdvanced: /** * Set the security user cache's size * Setting the size of the cache to zero or negative means closing the security user cache.api. * @param size */ public void setSecurityUserCacheSize(int size). /** * Get the size of the security role cache * @return the size of the security role cache */ public int getSecurityRoleCacheSize().server. /** * Get the size of the security user cache * @return the size of the security user cache */ public int getSecurityUserCacheSize(). /** * Set the size of the security group cache * Setting the size of the cache to zero or negative means closing the security group cache * @param size */ public void setSecurityGroupCacheSize(int size).cfg.admin. . /** * Set the size of the security role cache * Setting the size of the cache to zero or negative means closing the security role cache * @param size */ public void setSecurityRoleCacheSize(int size). /** * Get the size of the security protection cache * @return the size of the security protection cache */ public int getSecurityProectionCacheSize(). /** * Set the size of the security protection cache * Setting the size of the cache to zero or negative means closing the security protection cache * @param size< */ public void setSecurityProtectionCacheSize(int size). /** * Get the size of the security group cache * @return the size of the security group cache */ public int getSecurityGroupCacheSize().Invoke the following methods in the API class jet. The following is a diagram of the synchronization system mechanism: There are two ways to invoke the synchronization system.Synchronization of the security cache system A synchronization system has been provided for synchronizing JReport Server's security system with your external security systems. . and the second is to modify the external security system (blue line). it will then fetch the security information from the API and update the cached information. The first is to modify the security information on our Server web UI (red line). When the security cache system receives a security information modification event. The file is customizedAPI. if you do not want to provide a complete security system to your JReport Server. The following interfaces are required to be implemented: q AuthenticationProvider AuthorizationProvider q Example 2 Requirements: You want to customize authentication and users. you provide full functions to the JReport Server security system. The following interfaces are required to be implemented: q AuthenticationProvider UserProvider q Example 3 Requirements: For CLS/RLS scenario. The following interfaces are required to be implemented: q AuthenticationProvider UserProvider RoleProvider RoleUserRelationProvider q q q Implementing the Security API using an .xml file You can specify a customized implementation of the Security API in a . This section discusses the basic rules and implementation of the Security API. you can achieve this by implementing the interfaces that meet your requirements. By implementing all interfaces. The JReport Server loads classes according to this file. Here are some examples: Example 1 Requirements: You only want to customize authentication and authorization. However.Customized implementation of the Security API JReport Server provides a set of Security APIs which you can implement in order to build your preferred security system.xml in <install_root>\bin. you must provide user/role information. but only to use part of the functions available. while the JReport Server maintains other functions of the security system. Partial Implementation of the Security API The Security API can meet various requirements for seamlessly integrating the JReport security system into an existing external security system.xml file.xml file as below: . Specify the content in the . customer.user.customer.role.relation.group. the JReport Server will apply built-in implementations of these Providers.security.AuthorizationProviderImpl</authorization-provider> <user> <provider>com.<?xml version="1.custom.security.security.security.UserPermissionProviderImpl</permission-provider> <privilege-provider>com.GroupPrivilegeProviderImpl</privilege-provider> </group> <role> <provider>com.customer.user.security. RoleProvider.security.customer.RoleGroupRelationProviderImpl</role-group> <role-user>com.customer.role. and RoleUserRelationProvider.relation.UserProviderImpl</provider> <permission-provider>com.customer. including: AuthorizationProvider. GroupUserRelationProvider.customer.customer. the prerequisite for applying a customized UserPermissionProvider is that a customized UserProvider has been applied. . in order to build an integrated security system.security.group. If you have applied a PermissionProvider or PrivilegeProvider.security. the JReport Server will automatically provide implementation of some missed but required interfaces.RoleProviderImpl</provider> <permission-provider>com. RoleGroupRelationProvider.customer.customer.group. see the jet.RolePrivilegeProviderImpl</privilege-provider> </role> <relation> <role-group>com. For example.GroupProviderImpl</provider> <permission-provider>com.relation. Below are the rules: r If customized implementations of Providers have not been applied.security. GroupProvider. Interface RelationProvider depends on both the corresponding principal interfaces.security.api. For example.AuthenticationProviderImpl</authentication-provider> <authorization-provider>com.server. the prerequisite for applying a customized GroupUserRelationProvider is that a customized UserProvider and GroupProvider have been applied. but not applied an AuthorizationProvider.GroupPermissionProviderImpl</permission-provider> <privilege-provider>com. the JReport Server will apply the built-in implementation of the AuthorizationProvider.RolePermissionProviderImpl</permission-provider> <privilege-provider>com.customer.security. It is first loaded when JReport Server loads a customized Security API.security.security package in JReport Server Javadoc in <install_root>\help\server\en\api.customer. UserProvider.customer. for example.customer. q q If you partly implement the Security API.RoleUserRelationProviderImpl</role-user> <group-user>com.security.security.0" encoding="UTF-8"?> <jreport-customized-api> <security> <authentication-provider>com. UserPermissionProvider or UserPrivilegeProvider.UserPrivilegeProviderImpl</privilege-provider> </user> <group> <provider>com. r q If you have applied an AuthorizationProvider.GroupUserRelationProviderImpl</group-user> </relation> </security> </jreport-customized-api> Rules for applying customized Security API The following are rules for applying customized Security API: q AuthenticationProvider is a core interface and must be implemented. There are dependency relationships among some interfaces: Interfaces PermissionProvider and PrivilegeProvider depend on the corresponding principal interface provider. the JReport Server will not apply the built-in implementation of the PermissionProvider or PrivilegeProvider.role.user. Notes: q For details about the Security APIs. but not applied a PermissionProvider or PrivilegeProvider. java. JReport Server provides the ability to use customized user authentication scheme by the implementation of the two interfaces jet. two new methods addSecurityListener() and isEnableEdit() are added into the API jet.server.AuthenticationProvider interface.AuthenticationProvider and jet.server.api.txt for reference. you need implement the new methods in the API.server.server.AuthenticationProvider. Demo2Realm. AuthorizationProvider.custom.java Demo for implementation of the jet.security. and have applied customized implementation of AuthenticationProvider in V7. security. userman.custom.java Demo for implementation of the jet.security.UserAuthenticator is also supported and you can refer to the following demos for reference.security.java and demo2data.AuthorizationProvider interface. which are located in <install_root>\help\server\en\samples: r q If you want to use JReport Server as a servlet in your system. See Demo2UserAuthenticator. java. DemoAuthorizationProvider. you need load your data in the structural method.java. If you have upgraded your JReport Server from V7 to a higher version. the way of implementing the deprecated Security API interface jet. If you want to use your user data.api.custom.api.security. Demo2User.server.q Demo references available in <install_root>\help\server\en\samples: r DemoAuthenticationProvider.custom. see Demo1UserAuthenticator.custom. r q In V8. In addition.server. r .api.api. By this interface.api.http.Single sign-on When JReport Server is integrated into your system. It has the following methods: q getExternalAuthorizedUser Gets and returns the externally authorized user ID. the report server will send the HTTP unauthorized response (HTTP 401) to the client. The server does not call this method if a user logs out. q q Interface HttpExternalAuthorized The interface jet. it will implement a security check. the report server gets the user ID that is authorized by an external authenticator. askInvalidate Asks whether to invalidate an externally authorized user session (i. This method allows you to send your response to the client to handle an unauthenticated request. Interface ExternalAuthorized The interface jet.api. notifyLogout Notifies an external authorized user session logout. you will have to pass through authentication twice. q Implementation For implementation in an integration environment.ExternalAuthorized maintains externally authorized user sessions.server.e.jet. The user ID should be a valid user ID of the report server. Returns null if the authorized user info cannot be obtained from the HttpServletRequest object.http. JReport Server provides Single Sign-On APIs for you to pass login information from your external security system to the JReport Server security system in order to avoid a second login requirement by JReport Server after you have logged into your external system.api.HttpExternalAuthorized. To deal with this problem.HttpExternalAuthorized extends jet. Null will be returned if the authorized user info cannot be obtained from the userInfo object. If your system also checks security. Otherwise the report server does nothing. You can either disable the JReport Server security check or customize security for JReport Server by implementing the interface . The report server calls this method before the session is invalidated.ExternalAuthorized. It has the following methods: q getExternalAuthorizedUser Gets the externally authorized user ID. If this method returns true.server. the session has expired). server. The user ID should be a valid user ID of the report server. The report server calls this method after user logout.server. handleUnAuthenticatedRequest Handles unauthenticated requests. The report server calls this method before sending the HTTP unauthorized response (HTTP 401) to the client.api. the following steps are required: . 3. 4.jsp Demo to work together with customNoAuth.jsp Demo to set implementation of HttpExternalAuthorized into the report server. customParamAuth.HttpExternalAuthorizedImpl Demos The following demo programs are provided to illustrate the implementation of the HttpExternalAuthorized interface. customSessionAuth.jsp.jar. These demos are available in <install_root>\help\server\en \samples.mycorp.java Demo to set implementation of HttpExternalAuthorized into the report server.jsp to view a report. External authorized user name is submitted by http session in this demo. External authorized user name is submitted by parameter in this demo. Define the system property jrs. r r r . 2. For example. No external authorized user name is submitted in this demo. which can be found in WEBINF\lib directory. assuming that the implementation of this interface is com. customViewReport.1. q CustomHttpExternalAuthorized.httpExternalAuthorized=com.mycorp.class: -Djrs.httpExternalAuthorized with your implementation by -D parameter. CustomServlet. Create a folder classes in the WEB-INF folder and then add the authentication classes in the classes folder.jsp.jsp Demo to set implementation of HttpExternalAuthorized into the report server. Compiling requires the library JRESServlets.jsp and customSessionAuth.zip The following demos are contained in the zip: r q q customNoAuth. customViewReport.java Demo for implementation of HttpExternalAuthorized. Write your HttpExternalAuthorized implementation.jsp Demo to set implementation of HttpExternalAuthorized into the report server. HttpExternalAuthorizedImpl. Compile Java classes. customParamAuth. q Pick a topic from the following to get more: q Examples of LDAP server configuration SSL support in LDAP system Limitations of LDAP support q q . you should first enable JReport Server to adapt to a directory server by configuring the settings in the Server tab (accessed by selecting Configuration > LDAP on the JReport Administration page). The second is non-importing mode. The first is importing mode. Notes: q Make sure that the Directory Manager DN is a user with prior LDAP Server permission. Make sure that the users and groups you want to query and import into JReport Server belong to the organization you typed into the Distinguished Name field. making sure that the Enable LDAP Support option has been checked. Below is a diagram which illustrates these two working modes: JReport Server can access an LDAP server using the LDAP implementation of the Security API (blue line). With this mode. JReport Server can access an LDAP server and obtain LDAP security information directly without having to import it. In this mode. To use an LDAP server's security system. you will have to import the security information from an LDAP server. if you want to use the LDAP feature. and who can retrieve other LDAP users. and import security information from an LDAP server into the built-in security system (red line).Using an LDAP server's security system The server security system can run two modes in which you can use an LDAP server's security system. q Using LDAP server security information by importing Using LDAP server security information via the LDAP implementation of the Security API q . They are as follows: q Example 1: Configuration for adapting to a Novell Directory Server Example 2: Configuration for adapting to a Microsoft Site Server Example 3: Configuration for adapting to an iPlanet Directory Server Example 4: Configuration for adapting to the Active Directory Advanced Server Example 5: Configuration for adapting to a Lotus Domino Server on NT Example 6: Configuration for adapting to an OpenLDAP Directory Server q q q q q . New servers are frequently being added. contact your JReport Sales Representative. The following sections provide examples of settings which enable JReport Server to adapt to these directory servers.Examples of LDAP server configuration Six directory servers are currently supported. These are: q Novell Directory Server Microsoft Site Server iPlanet Directory Server Active Directory Advanced Server Lotus Domino Server OpenLDAP Directory Server q q q q q If you need access to a different directory server. 0. The settings of the Novell Directory Server will then be loaded. Check the Enable LDAP Support checkbox. and get the query result of groups specified in the option Filter by clicking the Query Group button. and then click Load Settings. .1) LDAP Server Port: 389 Root Entry: o=the name of the root (for example: o=myorg) Directory Manager DN: cn=user name of the directory manager.0. you should follow the steps below to configure your Server tab on the JReport Administration page > Configuration > LDAP panel: 1. You can test the connection settings by clicking the Test Connection button. and input the following information: r LDAP URL: ldap://IP address or host name of your Novell Directory Server (for example: ldap://127.Example 1: Configuration for adapting to a Novell Directory Server If you want to get all users and groups from the orgunit organizational unit.o=context (for example: cn=admin. 2. Click Save to save all settings. 4. get the query result of the users specified in the option Filter by clicking the Query User button. Select Novell Directory Server from the Select LDAP Server drop-down list.o=context) Password: the password of the Directory Manager (for example: 1234) Encryption Type: None Import LDAP Groups to: Group User Schema s r r r r r r r Distinguished Name:ou=the name of the organization unit where you want to perform a search for users (for example: ou=orgunit) Filter: (&(cn=the filter criteria that you want to set )(objectclass=person)) (for example: (& (cn=*)(objectclass=person))) s r Group Schema s Distinguished Name: ou=the name of the organization unit that you want to perform a search for groups (for example: ou=orgunit) Filter: (&(cn=the filter criteria that you want to set )(objectclass=groupofuniquenames)) (for example: (&(cn=*)(objectclass=groupofuniquenames)) ) Admin Group: The name of the group you want to add to the Admin group (for example: develop) s s 3. Make sure that the Enable LDAP Support checkbox is selected. and then click Load Settings.ou=members. 4. The settings of the Microsoft Site Server will be loaded. 2. get the query result of users specified in the option Filter by clicking the Query User button.0. Select Microsoft Site Server from the Select LDAP Server drop-down list. and get the query result of groups specified in the option Filter by clicking the Query Group button. You can test connection settings by clicking the Test Connection button. and input the following information: r LDAP URL: ldap://IP address or host name of your Microsoft site Server (for example: ldap://127.1) LDAP Server Port: 1003 Root Entry: o=test Directory Manager DN: cn=administrator. . You can get all users from the members organizational unit and all groups from the groups organizational unit.0.o=test Password: test Encryption Type: None Import LDAP Groups to: Group r r r r r r 3.Example 2: Configuration for adapting to a Microsoft Site Server Follow the steps below to configure your Server tab on the JReport Administration page > Configuration > LDAP panel. 1. Click Save to save all settings in this tab. You can get all users in the people organizational unit and all groups in the groups organizational unit.dc=jinfonet. and get the query result of groups specified in the option Filter by clicking the Group Query button. The settings of iPlanet Directory Server will then be loaded. . Make sure that the Enable LDAP Support checkbox is selected. and then click Load Settings. 4.Example 3: Configuration for adapting to an iPlanet Directory Server Follow the steps below to configure your Server tab on the JReport Administration page > Configuration > LDAP panel. Select iPlanet Directory Server from the Select LDAP Server drop-down list. 1. 2. You can test the connection settings by clicking the Test Connection button. and input the following information: r LDAP URL: ldap://IP address of your iPlanet Directory Server LDAP Server Port: 389 Root Entry: dc=mailbj.dc=com Directory Manager DN: cn=directory manager Password: jinfonet Encryption Type: None Import LDAP Groups to: Group r r r r r r 3. get the query result of users specified in the option Filter by clicking the Query User button. Click Save to save all the settings in this tab. and get the query result of groups specified in the option Filter by clicking the Group Query button. You can test the connection settings by clicking the Test Connection button.CN=Users. Make sure that the Enable LDAP Support checkbox is selected. The settings are then cleared and you can input your information. and then click Load Settings. and input the following information: r LDAP URL: ldap://IP address of your Windows 2000 Advanced Server LDAP Server Port: 389 Root Entry: DC=testad.DC=testad.Example 4: Configuration for adapting to the Active Directory Advanced Server Follow the steps below to configure your Server tab on the JReport Administration page > Configuration > LDAP panel.DC=local Password: 1234 Encryption Type: None Import LDAP Groups to: Group User Schema s r r r r r r r User Attribute Name: cn User Common Name: userPrincipalName User Password: userPassword Distinguished Name: ou=myorg Filter: (&(cn=*)(objectclass=person)) s s s s r Group Schema s Group Common Name: cn Group Member Type: member Distinguished Name: ou=myorg Filter: (&(cn=*)(objectclass=group)) s s s 3. 4. Click Save to save all settings in this tab. 1. You can get all users and groups from the myorg organizational unit.DC=local Directory Manager DN: CN=administrator. 2. . get the query result of users specified in the option Filter by clicking the Query User button. Select Win2000 Active Directory from the Select LDAP Server drop-down list. get the query result of users specified in the option Filter by clicking the button Query User. and input the following information: r LDAP URL: ldap://IP address of your Lotus Domino Server LDAP Server Port: 389 Root Entry: Directory Manager DN: cn=admin. 2. and get the query result of groups specified in the option Filter by clicking the Query Group button. and then click Load Settings. 1. Click Save to save all settings in this tab. you can get all users and groups from the developer organization unit. You can test the connection settings by clicking the Test Connection button. The settings are then cleared and you can input your information.Example 5: Configuration for adapting to a Lotus Domino Server on NT By following the steps below to configure your Server tab on the JReport Administration page > Configuration > LDAP panel. 4. Select Lotus Domino on NT from the Select LDAP Server drop-down list.o=jtotal Password: 123456 Encryption Type: None Import LDAP Groups to: Group User Schema s r r r r r r r User Attribute Name: uid User Common Name: cn User Password: userPassword Distinguished Name: ou=developer. . o=jtotal Filter: (&(cn=*)(objectclass=person)) s s s s r Group Schema s Group Common Name: cn Group Member Type: member Distinguished Name: Filter: (&(cn=*)(objectclass=groupofnames)) s s s 3. Make sure that the Enable LDAP Support checkbox is selected. dc=ldaptest Directory Manager DN: cn=Manager. Select OpenLDAP Directory Server from the Select LDAP Server drop-down list.Example 6: Configuration for adapting to an OpenLDAP Directory Server By following the steps below to configure your Server tab on the JReport Administration page > Configuration > LDAP panel. You can test the connection settings by clicking the Test Connection button. 1. The settings are then cleared and you can input your information. and get the query result of groups specified in the option Filter by clicking the Query Group button.0.dc=ldaptest Password: 123456789 Encryption Type: None Import LDAP Groups to: Group User Schema s r r r r r r r User Attribute Name: uid User Common Name: cn User Password: userPassword Distinguished Name: ou=members Filter: (&(uid=*)(objectclass=person)) s s s r Group Schema s Group Common Name: cn Group Member Type: uniqueMember Distinguished Name: ou=groups Filter: (&(cn=*)(objectclass=groupofuniquenames)) Admin Group: s s s s 3.1) LDAP Server Port: 389 Root Entry: dc=openldap.0. Make sure that the Enable LDAP Support checkbox is selected. get the query result of users specified in the option Filter by clicking the Query User button.dc=openldap. 4. Click Save to save all settings in this tab. you can get all users and groups from the developer organization unit. . and then click Load Settings. 2. and input the following information: r LDAP URL: ldap://IP address of your OpenLDAP Directory Server (for example: ldap://127. Detailed steps can be found in the JSSE Reference Guide.keystore.keystore. This is a characteristic of the SSL protocol. and use the password test. your program will hang. To use JSSE on a platform earlier than Java 2 SDK. first install JSSE. Since the connection time varies with the user's network environment. the main thread will only need to wait until the socket timeout time has been reached and can continue to run. You can also use -D parameters to specify another file and password.4. For instance. it is better to set it in LDAPProperties.SSL support in LDAP system JReport Server's LDAP system supports SSL when connecting to an LDAP server for obtaining security information.the socket timeout time (This time can be set by users).keystore" "-Djavax.xml: modify the element env-socketTime's value before the server is started. . if the child thread hangs due to using the wrong port type. Method to avoid the wrong connection port type problem Use a main thread to create a child thread for connecting to the LDAP server.ssl. it will notify the main thread. If the child thread creates an LDAP connection successfully. A Parameter setting in the method There is an important parameter in this method: the socket timeout time. However. If the TrustManager does not accept them. the certificates will be checked by JSSE's default TrustManager: X509TrustManager. About SSL certificate store in JReport Server Since JNDI uses the default SSL provider.net.trustStore= C:\certs\certs. JReport Server will store the SSL certificates into another key store file.com/products/ jsse for information. The wrong connection port type problem in SSL protocol If you use an SSL socket to connect to a server on a port that is not using SSL.security file with the provider or by adding the provider programmatically. The main thread can wait on the child thread for a period of time-. As for earlier versions of the Java platform. This file is placed in <install_root>\properties \LDAPKeyStore. Its default value is 10.4. if you want to add the certificates into: C:\certs \certs. and the program will continue to run. You can modify this value according to your network environment. Here JAVA_HOME refers to the directory where the Java Runtime (JRE) software has been installed. Solving the wrong connection port type problem JReport implements a method in the security system to solve the wrong connection port type problem. JSSE is available as part of Java 2 SDK.trustStorePassword=test" Note: The LDAP service provider uses JSSE for its SSL support.net.sun. you should add the following parameters to JReport Server's startup file: "-Djavax. or if you use a plain socket to connect to a server's SSL socket. v1. and then configure a JSSE provider either by updating the JAVA_HOME/lib/security/java. which means that the socket timeout time is 10 seconds. v1. you can turn to http://java. The password to access the file is jinfonet.ssl. . when the session exceeds the time limit. After that. the retained password will be lost. the retained password will be lost. there are some limitations: q If the Load Settings button is clicked. sessions are used to remember passwords and the status of the remember password checkbox.Limitations of LDAP support In the LDAP page. q . Due to this. the user must log onto JReport Server again. If the session expires due to idling. and the session has expired. when logging back onto JReport Server again. where you can predefine a role map for the imported LDAP users. In addition. you can use LDAP users and groups in JReport Server by importing them. and the latter determines whether LDAP users can be imported automatically. you can synchronize the security information from your local server with that of the LDAP server. users will automatically be imported into JReport Server when they log in for the first time. =Unchecked Enable AutoImport of Users from LDAP Server Enable LDAP Support Can be used Local User YES YES YES YES Imported LDAP User YES YES NO NO NoneImported LDAP User YES NO NO NO . To do this. in order to have the most current security information. if you have checked Enable Auto-Import of Users from LDAP Server. JReport Server enables you to import users/groups from directory servers. However. To import LDAP security server information. on the JReport Administration page. click Configuration > LDAP > Import. as shown in the following table: =Checked. on the JReport Administration page. The former determines whether an imported LDAP user can be used in JReport Server. With LDAP support. The Enable LDAP Support and Enable Auto-Import of Users from LDAP Server options in the Configuration > LDAP > Server tab work together. click Configuration > LDAP > Synchronize. In the Import tab.Using LDAP server security information by importing LDAP (Lightweight Directory Access Protocol) is a lightweight client-server protocol for accessing directory services. To use the LDAP security providers. Troubleshooting LDAP configuration If you encountered any problems during LDAP configuration. The user can be granted the role by a role map. The following are rules for checking whether or not a user is an admin user: q Whether or not the user is a member of the LDAP admin group. */ public void setEnableNoneImportedLDAPSupport (boolean isEnableNoneImportedLDAPSupport). Note: In order to use LDAP providers. refer to the following for help. otherwise returns false. JReport Server security system will then use the LDAP providers. q A user that meets one of these two rules is regarded as an admin user. If the value is true. The LDAP admin group is a configuration option in the LDAP configuration XML file. on the JReport Administration page. There are three approaches to achieve this: q Configuring on the JReport Administration page You must be a member of the administrators role in order to access the JReport Administration page. To achieve this. Whether or not the user is a member of the administrators role. you will need to turn on the LDAP security providers. click Configuration > LDAP > Server. then check Enable Direct Authentication to LDAP Server. LDAP configuration failure resulting in re-login failure as an admin user . and is thus allowed to access the JReport Administration page. /** * Specifies whether or not the Server security system uses none imported LDAP support. * @return Returns true if using none imported LDAP support. q Configuring by API method Invoke the following two methods in the interface ConfigurationLDAPServer: /** * Specifies whether or not the Server security system uses the LDAP providers. The default value of this property is false. q Editing the LDAP XML configuration file Specify the following property in the LDAP XML configuration file: <env-enableNoneImportedLDAPSupport>true</env-enableNoneImportedLDAPSupport>.Using LDAP server security information via the LDAP implementation of the Security API JReport Server can access an LDAP server directly using the LDAP Security API implementation. otherwise set it to false. a valid admin user is required to manage the JReport Server. */ public boolean isEnableNoneImportedLDAPSupport(). * @param isEnableNoneImportedLDAPSupport Set this parameter to true if the Server security system uses none imported LDAP support. If this happens. If the admin group specified does not hold a user. prompt warning information is also provided in order to cope with incorrect LDAP configuration. Warning messages in the advent of incorrect LDAP configuration Apart from the notes offered on the JReport Administration page > Configuration > LDAP panel. If the admin group specified does not exist in the LDAP server.An admin user may fail to carry out LDAP configuration properly. The server system will prompt warning messages in the following cases: q If you do not fill in the Admin Group field or specify an admin group. q q . and thus then cannot log onto the JReport Administration page to manage the server.xml in <install_root> \properties as below to turn off the Enable Direct Authentication to LDAP Server option: <env-enableNoneImportedLDAPSupport>false</env-enableNoneImportedLDAPSupport> 2. Restart JReport Server and log in as a built-in security admin user to correct the LDAP configuration. Modify the property in the LDAP configuration XML file LDAPProperties. you should follow the below steps: 1. you will need to configure your server. For these types of settings. Before or while running the server. Some server UI options and properties in the configuration files are mapped and both function the same way. This chapter focuses on the following topics: q Configuration files Performing administrative configuration work on UI Configuring the server database Configuring another connection as a substitute for the catalog connection Configuring connection pool Configuring logs Changing the server context path q q q q q q . The configuration work can be performed in two ways: via the JReport Server UI or via configuration files. Appendix 4: Mapping list of server UI options and properties details which server UI option are mapped to which properties in the configuration files. However. you may find that JReport's default port number conflicts with an existing one in your computer. or that you need to generate log files for analyzing a problem. In these cases.Configuring Once JReport Server has been installed and you have prepared the reporting environment. you can configure it according to your systems. you can then start it. you can take either way to do the configuration. server RMI port.xml <install_root>\bin\dbconfig. properties <install_root>\bin\jdbcdrivers. properties <install_root>\bin \JdbcDriversConfig.properties <install_root>\bin\datasource.properties Apply old version Security API (UserAuthenticator) <install_root>\bin \ConnectionPoolConfig.xml file Action Task Manager > dhtml. properties <install_root>\bin\mailconfig. xml file Configuring the server database in the dbconfig.xml JReport Administration/ Console page JReport Administration page > Configuration > LDAP > Server Appendix 1: Properties server. and server backup priority.properties <install_root>\bin\faxconfig. server IP address.properties <install_root>\bin\LogConfig.properties <install_root>\properties \LDAPProperties.xml Engine connection pool configuration Connection mapping configuration Server DB configuration <install_root>\bin\dhtml. including server name. properties Configuring logs Configuration for sending emails Record relevant information about the clustered servers.properties file - Related topics: q Appendix 4: Mapping list of server UI options and properties . properties <install_root>\bin\server. properties <install_root>\bin\classes.list Configuration for the Action Task Manager Configuration for sending fax Configure the JDBC drivers that can be auto loaded JDBC capability description Configuration for log JReport Administration page > Configuration > Log JReport Administration page > Configuration > Export > E-mail - Configuring JdbcDriversConfig.Configuration files The following table lists the files provided for configuration purpose and the corresponding server UIs they are mapped to if applicable: File Description Mapped Server UI JReport Administration page > Data > System DB/Realm DB/Profiling DB > Configuration JReport Administration page > Configuration > Export > Fax Related Document Configuring a connection pool Configuring the datasource. Comprehensive configuration Configuration for LDAP support - - <install_root>\bin\server. Data . Profile . Cached Data .Where you configure and manage a JReport Server cluster.Where you create and manage report data caches.Where you manage user accounts and permissions.Where you create and manage triggers. q q q q q q . Security . these tabs are entry to different-purposed configuration panels: q Configuration .Where you manage the server data. first log onto the JReport Administration page. To perform administrative configuration work as an administrator. The JReport Administration page is available to administrators only.Performing administrative configuration work on UI JReport Server UI can be accessed remotely from a client machine through a web browser such as Internet Explorer.A comprehensive place for server configuration containing further-divided categories. On the JReport Administration page.Where you define some initial settings for users' profiles. Cluster . Triggers . xml file is automatically created in the directory <install_root>\bin. etc. JReport Server provides multiple database support. there will be the exception of encoding not supported. such as server. You can configure your database by using the dbconfig.properties q q q q Notes: q If you are using MySQL. depending on your environment. The profiling database holds server runtime related information. you may want to configure the realm and profiling databases separately. nodes.Configuring the server database There are three databases in JReport Server: system. q Related topics: q Managing server data . versions. realm. The database configuration information is stored in this configuration file. Also. If your server database uses DB2 and the charset is DBK. and the completed table. For best performance. you can specify a table space in the database configuration for JReport Server to create tables in it. The realm database is necessary in order to run JReport Server. The system database holds resources of the global server scope. allowing you to configure your own database to store the server data. and profiling. make sure it is of version 5 or above. q Configuring the server database in a standalone environment Configuring the server database when integrating with an application server Creating tables in a specified table space Schema support Configuring JdbcDriversConfig. When you install JReport Server.properties. the security system.xml file. a dbconfig. global NLS. This section presents the ways of configuring a server database for JReport Server in two different environments. The realm database holds information of folders. user and password individually. click Test.</password> </database> ..bat file. In order to make it shown. you will have to provide the driver class path information unless it has already been added to the class path of setenv. Provide the user ID and password. This method of configuration can be modified through the JReport Administration page. or Profiling DB from the drop-down menu according to your requirement.profiling.xml file In dbconfig. The following presents the two ways of configuring the server database in a standalone environment: Configuring on the JReport Administration page 1. Note: The Profiling DB option is not shown by default on the drop-down menu. click Update and then restart the server to finalize the function.</user> <password>.xml. Realm DB. One is to specify the URL. The valid format of the URL should be provided by the DBDriver vendor.sh on Unix) file during installation or by editing the setenv. you should set the server. 2. you can also configure the server database in this file. Log onto the JReport Administration page. driver. For all other databases. Select a realm if it is the Realm DB or Profiling DB panel... 5..xml file in the directory <install_root>\bin. select a DBDriver from the Driver drop-down list and provide the driver class path information in the Driver Class Location field.. Type a valid URL that can be used to establish a connection to the database. Configuring in the dbconfig.enable property to true in the server. since the server database configuration information is stored in the dbconfig. To test the connection. you can configure the server database using one of two methods.. you can configure the database for it remotely on the JReport Administration page.bat (setenv.</url> <driver>. click Data on the system toolbar and then select System DB. Also. 4. For example: <database name="systemtables/realmtables/profile"> <url>.</driver> <user>. In the Configuration tab. you do not need to specify the Driver Class Location. HSQLDB and Derby databases. To update the database configuration and to apply the settings. properties file in the <install_root>\bin directory. 3. Note: For the Access.. 6..Configuring the server database in a standalone environment When JReport Server is running in a standalone environment. OracleDriver </driver> </database> </workspace> </dbconfig> q The following example is for a DataDirect driver.jdbc.driver.xml file. D:\DBDriver\connectjdbc\lib\sqlserver.jar"> oracle.SQLServerDriver </driver> <dbtype>Microsoft SQLServer</dbtype> </database> . The other is to use the <datasource> tag.xml file as follows: <?xml version="1.jdbc.jar"> com.Note: The <user> and <password> information is encrypted.ddtek. Modify the dbconfig.0" encoding="UTF-8"?> <dbconfig> <workspace name="defaultRealm"> <database name="realmtables"> <user>test</user> <url> jdbc:datadirect:sqlserver://dbhost:1433.jar. The <user> and <password> tags will be replaced by the <encrypt-sign> tag after JReport Server's startup as follows: <encrypt-sign>enDkq7srM9cHhoUwzYXJ3NvcDIYk</encrypt-sign> If you want to change user or password. For example: <database name="systemtables/realmtables/profile"> <datasource> jdbc://user:password@jdbc:odbc:jreport-realmtables#driver=sun.jdbc. D:\DBDriver\connectjdbc\lib\util.JdbcOdbcDriver </datasource> </database> Here are two examples for your reference: q The following example is for Oracle.0" encoding="UTF-8"?> <dbconfig> <workspace name="defaultRealm"> <database name="realmtables"> <user>test</user> <url> jdbc:oracle:thin:@dbhost:1521:ora9i </url> <password>1234</password> <driver classpath="D:\DBDriver\Oracle\oracle9i\ojdbc14.jar.sqlserver.xml file as follows: <?xml version="1.odbc. Modify the dbconfig. delete the <encrypt-sign> tag and add the <user> and <password> tags in the dbconfig.DatabaseName=realmdb </url> <password>1234</password> <driver classpath="D:\DBDriver\connectjdbc\lib\base. However.xml file. you will need another user. . JReport Server automatically creates database tables the first time it is started. JReport Server will fail to complete the operation. to create a set of empty tables in the user's schema using the provided SQL files. In this case. These SQL files can be found in <install_root>\script_files.</workspace> </dbconfig> Note: Usually. if the user ID defined in this file does not have the permission to create tables in the database. The database information that JReport Server uses is defined in the dbconfig. such as the database administrator (who holds the relevant permissions). odbc. By default it will load from the dbconfig.ear file that JReport Server creates does not specify any Java EE information. with the Java EE Data Source Support feature.xml.xml (EAR mode) > web.xml. ejb-jar. Do not use reporthome. @ or # in the JNDI name or Resource name. Here.xml respectively: Specifying data source in web. xml file using the <env-entry></env-entry> or <context-param></context-param> tags. and dbconfig.realmtables.jdbc. the use of the <env-entry></env-entry> tags is the recommended way since the tags are also .xml in <install_root>\bin. the dsInfo name is jreport. <dbname> is JReport Server's inner database name. You can create a database connection according to this configuration file.xml (WAR mode) > dbconfig. The JDBC configuration information is stored in the file dbconfig.xml (for the WAR mode) When integrating the JReport Server in a WAR package. It is a key-value pair. Also. JReport Server's dsInfo can be configured to the WEB-INF/web. The name and value for dsInfo are defined as below: q The name should be: jreport. However. JdbcOdbcDriver r jndi://[<jdbc-user:jdbc-passoword>@]datasource_name[#<attribute-name=attributevalue>. There is a limitation in WebSphere.DataSource by JNDI APIs. JBoss works fine for either one.xml. such as VM properties. There are three protocols supported by JReport Server: r q file:///absolute_path_of_config_file For example: file:///JReport/Server/bin/dbconfig. or profile.Configuring the server database when integrating with an application server JReport Server supports connecting an RDBMS to access its system data via JDBC.xml and <install_root>\bin\dbconfig.xml file.datasource. Notes: q The jreport.xml r jdbc://[<jdbc-user:jdbc-password>@]<jdbc-url>[#<attribute-name=attribute-value>. For example.<dbname>.sql. xml with JNDI name but not RESOURCE name. q q The following shows specifying the dsInfo in web. in a Java EE environment.xml. web. JReport Server can get the predefined javax. you can specify the dsInfo in the WEB-INF/web.xml. The sequence to load the information is: VM system environment > ejb-jar. The value should be in the form of a URL.] For example: jndi://jdbc/jreport-realmtables The dsInfo can be specified in several places or levels. where.] For example: jdbc://user:password@jdbc:odbc:jreport-realmtables#driver=sun. It must be systemtables. realmtables.datasource. ejb-jar. the term dsInfo is used to indicate where JReport Server can obtain the JDBC connection information. . <env-entry> <env-entry-name>jreport.datasource. xml in /META-INF or web.realmtables</param-name> <param-value>jndi://datasource_name_which_is_predefined</param-value> </context-param> ..realmtables</env-entry-name> <env-entry-value>jndi://resource-name</env-entry-value> <env-entry-type>java. see section Specifying data source in web.xml file.String</env-entry-type> </env-entry> </web-app> The following is an example of specifying the dsInfo in WEB-INF/web.xml using the <env-entry></enventry> tags: <web-app> . For information about specifying a data source in the web.xml or web.. . The following is an example of specifying the dsInfo in WEB-INF/web.xml file..xml (for the EAR mode) When the JReport Server is used with APIs by EJBs.xml using the <context-param></ context-param> tags: <web-app> <context-param> <param-name>jreport.server.. Here is an example: <web-app> <listener> <listener-class> jet.xml (if you call the Server API in your EJB).supported in ejb-jar. </web-app> You can specify the dsInfo in the META-INF/ejb-jar.servlets. Note: If the dsInfo is stored in a Web module..xml in /WEB-INF.JRServerContextListener </listnener-class> </listener> .xml file using the <env-entry></env-entry> tags. </web-app> Specifying data source in ejb-jar. you can specify the dsInfo either in the file ejb-jar.xml (for the WAR mode).lang. you should add the JReport Server context listener to the WEB-INF/web.datasource. For details about configuring the JDBC data source. The following is an example of specifying the JNDI data source: <?xml version="1.xml file... </ejb-jar> Specifying data source in dbconfig.0" encoding="UTF-8"?> <dbconfig> <workspace name="defaultRealm"> <database name="realmtables"> <datasource>jndi://datasource-name</datasource> </database> </workspace> </dbconfig> . </enterprise-beans> .datasource.. <env-entry> <env-entry-name>jreport.xml By default.datasource.META-INF/ejb-jar... here is an EJB named firstEJB which creates the JReport Server instance.xml as follows: <ejb-jar> <enterprise-beans> <session> <ejb-name>firstEJB</ejb-name> .String</env-entry-type> </env-entry> </session> .lang.xml. You can specify either a JDBC or JNDI data source using the <datasource></ datasource> tags in the dbconfig.For example. see Configuring the server database in a standalone environment.realmtables=file:///${rpthome}/bin/ dbconfig.realmtables</env-entry-name> <env-entry-value>jndi://resource_name</env-entry-value> <env-entry-type>java. JReport Server assumes that jreport.. You can add the <env-entry></env-entry> tags to the EJB's configuration file . This key-value pair is then passed to JReport Server through the JDBC configuration. JdbcOdbcDriver. Tablespace can be configured either in the dbconfig. <database name="realmtables"> <driver classpath=". In dbconfig.xml Add the <tablespace></tablespace> tags in the dbconfig. A key-value pair tablespace is provided to specify a table space into which JReport Server will create database tables.] For example: jdbc://user:password@jdbc:odbc:jreport-realmtables#driver=sun.jdbc.xml file by using the <tablespace></tablespace> tags...xml file as follows: . JReport Server retrieves the table space information from the JDBC (data source) configuration.] For example: jndi://jdbc/jreport-realmtables#tablespace=myTablespace . q jdbc://[<jdbc-user>:<jdbc-password>@]<jdbc-url>[#<attribute-name=attribute-value>.. you can add the attribute tablespace=table_space_name in the JNDI or JDBC statement.. such as DB2 and Oracle. and then creates tables in the specified table space.tablespace=myTablespace q jndi://[<jdbc-user>:<jdbc-password>@]<datasource-name>[#<attri-name=attri-value>.. or in dsInfo by adding the attribute tablespace=table_space_name.odbc.Creating tables in a specified table space JReport Server supports creating tables in a user-specified table space in a database that supports table spaces.. In dsInfo Since the dsInfo supports JNDI and JDBC protocols.">jdbc_driver_name</driver> <url>jdbc_url</url> <user>jdbc_user</user> <password>jdbc_password</password> <tablespace>table_space_name</tablespace> </database> . ">jdbc_driver_name</driver> <url>jdbc_url</url> <user>jdbc_user</user> <password>jdbc_password</password> <schema>schema_name</schema> </database> . or in dsInfo by adding the attribute schema=schema_name.. not when it is running in standalone mode. In dsInfo Since the dsInfo supports JNDI and JDBC protocols. DB2. Note: For Sybase. <database name="realmtables"> <driver classpath=".xml file using the <schema></ schema> tags. The JNDI approach is only available when deploying JReport Server into a Java Application Server.odbc.schema=db2admin q jndi://[<jdbc-user>:<jdbc-password>@]<datasource-name>[#<attri-name=attri-value>. for example. In dbconfig. You can specify schema information either in the dbconfig...] For example: jndi://jdbc/jreport-realmtables#schema=db2admin .. you can add the attribute schema=schema_name in the JNDI or JDBC statement. the schema name must use capital letters.jdbc. ABCDE.xml Add the <schema></schema> tags in the dbconfig. JdbcOdbcDriver. and Sybase. Those DBMSs include Oracle.xml file as follows: .Schema support JReport Server supports DBMS schemas in order to work well with DBMSs that are currently supported by JReport Server and that support schemas. SQL Server.. q jdbc://[<jdbc-user>:<jdbc-password>@]<jdbc-url>[#<attribute-name=attribute-value>.] For example: jdbc://user:password@jdbc:odbc:jreport-realmtables#driver=sun.. on JReport side or on the database side.setFetchSize(). It can also avoid Java heap out of memory errors when doing large queries.getDriverVersion() to obtain the value. For details about usage of these two properties. It is an Integer value that should be larger than 0 and less than or equal to getMaxRows().Configuring JdbcDriversConfig. getMetaData(). Limiting the size of the fetch data buffer If you are using a database which supports the JDBC method Statement. _[Name] It is a user-defined name used to mark a group of driver settings different from the other groups.getMetaData(). You can use connection. It is a string value. The default value is different according to the driver in use.com Version_D1 = 3.2. you can also specify where the properties.8-stable ( $Date: 2003/05/19 00:57:19 $. properties file for you to do this. You can refer to your own database driver specification. $Revision: 1.properties This document describes how to configure the file JdbcDriversConfig. The following is an example of setting the setFetchSize property in the JdbcDriversConfig.27. JReport provides a property setFetchSize in the JdbcDriversConfig.18 $ ) setFetchSize_D1 = 5000 DriverName_[Name] Database driver name that should be used to establish a connection. setFetchSize_[Name] The number of rows retrieved in each buffer from the database.properties file and detailed description of each property: DriverName_D1 = MySQL-AB JDBC Driver Vendor_D1 = MySql.properties file. Vendor_[Name] The vendor of current JDBC driver. Specifying where to implement the maximum query run time and number of records In the JdbcDriversConfig. see Limiting the query run time and number of records in the Queries . Maximum Rows and Maximum Duration will be implemented.0. Version_[Name] The version of current JDBC driver. you can request the database retrieve a specified number of rows in each read instead of all rows which minimizes memory usage which can improve performance.properties in the <install_root> \bin directory for better performance. You can use connection.getDriverName() to obtain the value. SupportMaxRowPushDown_[Name] Specifies where the property Maximum Rows will be implemented. the query used by the report will also be cancelled in the database. You can use connection. for example. it is set to true. on JReport side or on the database side. the property will take effect on JReport side.chapter of the JReport Designer User's Guide. 3. 2. on JReport side or on the database side.properties if it is not listed there.properties there is a line: #supportCancelQueryStatement_D5=true Remove the sign # and use your driver number instead of D5 to activate the feature. when you choose to cancel a running task. or when you choose to stop a report running in background mode. By default.getDriverVersion() to obtain the value.0 supportMaxRowPushDown_D2 = true supportMaxDurPushDown_D2 = true DriverName_[Name] Database driver name that should be used to establish a connection. By default. The following is an example of setting the two properties: DriverName_D2 = Oracle JDBC driver Vendor_D2 = Oracle Version_D2 = 9. then the next time. SupportMaxDurPushDown_[Name] Specifies where the property Maximum Duration will be implemented. the property will take effect on JReport side. configure the file JdbcDriversConfig.3. Add the JDBC driver you use into JdbcDriversConfig. it is set to true. In the file JdbcDriversConfig. provided that the DBMS supports . when you click the Cancel button on the report processing page of JReport Viewer. Canceling running query If your JDBC driver support the Cancel Running Query feature and you want JReport to cancel the running query used by a report in the database when you cancel the running task of the report. If it is set to false.0. Version_[Name] The version of current JDBC driver.getMetaData(). properties as follows: 1. _[Name] It is a user-defined name used to mark a group of driver settings different from the other groups. Vendor_[Name] The vendor of current JDBC driver. Restart your JReport Server. which means the property will take effect on the database side. It is a string value. which means the property will take effect on the database side. You can use connection.2. getMetaData().getDriverName() to obtain the value. If it is set to false. properties file. q q . you need start the server to load the changes. If there are more than one group with the same group marking name. the last group will be adopted.this action. the whole group will be disabled. If the sign # is seen before "DriverName" of a group. or if setFetchSize is given a negative value. Notes: q After you modified the JdbcDriversConfig. xml Integrating JReport Server with your Java application server Example 1: Using JNDI data source connections of WebLogic Server Example 2: Using JNDI data source connections of JBoss server q q q q q . after a report has been created.xml file The connection priority Reloading connection information from datasource.Configuring another connection as a substitute for the catalog connection Normally. This section focuses on the following: q Configuring the datasource. you can change to another runtime JDBC or JNDI data source to run reports. it is fixed to a specific catalog connection. With the Java EE Data Source Support feature. This allows you to control the catalog data source connections in JReport Server to connect dynamically to your production data sources. Change this file according to the data source you want to use.0" encoding="UTF-8"?> <datasource-mapping> <datasource> <catalog-connection-name>Connection1</catalog-connection-name> <connection-type>JNDI</connection-type> <jndi-datasource>Sample</jndi-datasource> </datasource> <datasource> <catalog-connection-name>Connection2</catalog-connection-name> <connection-type>JDBC</connection-type> <driver>sun.odbc.jdbc. The datasource. jndi-datasource If you are using a JNDI data source. a configuration file.xml file is located in the <install_root>\bin directory. depending on the data source your application uses. which can be either JNDI or JDBC. URL. connection-type Specifies the connection type. user and password. The <user> and <password> tags will be replaced by the <encrypt-sign> tag after JReport Server's startup as follows: <encrypt-sign>enDkq7srM9cHhoUwzYXJ3NvcDIYk</encrypt-sign> If you want to change user or password. delete the <encrypt-sign> tag and add the <user> and <password> tags in the datasource. Two types of connections are supported by JReport Server. A unique connection name in a catalog is suggested.JdbcOdbcDriver</driver> <url>jdbc:odbc:jinfonet</url> <user>Username</user> <password>Password</password> </datasource> </datasource-mapping> Note: The <user> and <password> information is encrypted. Note that this is the connection name that you can see in JReport Catalog Browser. Element descriptions q catalog-connection-name Specifies the name of the catalog connection that you want to substitute. They are JNDI data source connection and JDBC connection.xml file In order to enable you to conveniently set different connections in JReport Server. datasource. is provided with which you can define the connection to use at runtime by setting up connection mapping information such as the JDBC driver.xml file.xml. The content of the datasource.xml file is as follows: <?xml version="1. or JNDI data source name.Configuring the datasource. specify the JNDI data source name you defined in your Java q q . Each pair will map one of the connections in your catalog. You can define mapping connections for multiple connections for more than one catalog.xml file. Specially. q driver & url If you are using a JDBC data source. You can choose whether to provide database user and password information for the JNDI connection. using the <user> and <password> tags. the settings defined in your application server will be used. it will be used to set up the connection regardless of the settings defined in your application server. Notes: q There can be multiple <datasource></datasource> tags. for WebLogic users. you should provide user name and password for WebLogic console instead of the database. If the user and password information is provided in this file. Otherwise. q .application server which you want to use as the substitute connection. The catalog connection name should be unique in the datasource. specify the JDBC Driver and URL in these two attributes. otherwise the latter <datasource> information will overwrite the previous ones. the priority of these three is as follows: Server API > datasource.The connection priority If you are using a catalog connection. you have set new connection information via the Server API/URL ((jrs. datasource. jrs. and at the same time.xml.xml > catalog connection This means that if the approach with higher priority fails to get the connection.db_user. db_pswd). the one with the next lower priority will be used. jrs.jdbc_url. jrs. .jdbc_driver. go to Configuration > Connection panel.Reloading connection information from datasource. and then click the Reload button. Log onto the JReport Administration page.admin.reloadFile().xml file. This file can be reloaded using the following ways: q Call jet.server. Restart JReport Server.api. you need to reload it in JReport Server.xml After you have made changes to the datasource.ConnectionInfoProviderService. q q . you can integrate JReport Server with your application server. Before you deploy the WAR file to a web server. make sure that the datasource.xml file. .jar/workspace/bin directory. add <include name="datasource.Integrating JReport Server with your Java application server After updating the datasource. Before making the JReport Server WAR file.xml in the <install_root>\bin directory. usually you need to specify the -Dreporthome parameter in the application server so that the application server can locate and load the resources it needs. If you are integrating JReport Server to an application using a non-JReport WAR file. you do not need to do anything special for this file. make sure that the datasource.xml file is included in the WAR file.xml" /> into the <zipfileset dir="${installroot}/bin" prefix="workspace/bin"> section.war/WEB-INF/lib/jrenv.xml already exists in the bin directory.xml file is included in the jreport. Since the datasource. in makewar. If you are using a WAR file. In the Configuration tab. 5. Select the correct connection from the Pool Name drop-down list. Build the JReport Server WAR file using the makewar utility in the <install_root>\bin directory.xml in the <install_root>\bin directory and add: <datasource-mapping> <datasource> <catalog-connection-name>ConnectionName</catalog-connection-name> <connection-type>JNDI</connection-type> <jndi-datasource>MyJNDISample</jndi-datasource> <user>youruserid</user> <password>yourpassword</password> </datasource> </datasource-mapping> 4. create a data source using the JNDI name MyJNDISample. 3. 6. 2. Start WebLogic server. navigate to <YourProjectName> > Services > JDBC > Connection Pools. . take the following steps: 1. make sure that the connection you are going to use is there and correctly set up.Example 1: Using JNDI data source connections of WebLogic Server Using WebLogic as an example. Browse to <YourProjectName> > Services > JDBC > Data Sources. Deploy JReport Server to WebLogic. Open datasource. In the Configuration tab. Run the report that uses this connection. Create a db2-ds. take the following steps: 1. Copy the DB2 driver to D:\jboss-4. Build the JReport Server WAR file using the makewar.1.Example 2: Using JNDI data source connections of JBoss server Using JBoss as an example. and add the following content: <?xml version="1.1\server\default\lib.xml in <install_root>\bin.xml file in D:\jboss-4.0. DB2 is used. Deploy JReport Server to JBoss. Run the report that uses this connection.ibm.0.DB2Driver</driver-class> <user-name>db2admin</user-name> <password>db2admin</password> <min-pool-size>0</min-pool-size> <metadata> <type-mapping>DB2</type-mapping> </metadata> </local-tx-datasource> </datasources> 3.1\server\default\deploy. 6.net.bat utility in the <install_root>\bin directory.db2. Modify datasource. in this Example.0" encoding="UTF-8"?> <datasources> <local-tx-datasource> <jndi-name>DB2DataSource</jndi-name> <connection-url>jdbc:db2://dbs-b/sample</connection-url> <driver-class>COM. Make sure that the following are included: <datasource-mapping> <datasource> <catalog-connection-name>ConnectionName</catalog-connection-name> <connection-type>JNDI</connection-type> <jndi-datasource>java:/DB2DataSource</jndi-datasource> </datasource> </datasource-mapping> 4.jdbc. . 5. 2.0. and JBoss is installed to D:\jboss-4. the connection will be closed right after it starts idling.properties file and detailed description of each property in the file: # jdbcpool configure information URL1=jdbc:odbc:Jinfonet Expire_URL1=0 IdleExpire_URL1=1 MaxCount_URL1=0 MaxShare_URL1=0 Attempt_URL1=1 Interval_URL1=0 URL JDBC URL that can establish a connection to your database. MaxCount_URL The maximum number of connections based on the URL. you can configure a connection pool using the ConnectionPoolConfig. To improve performance. Cached connections are kept in the connection pool and can be used and re-used as required. The value for this property by default is "1". The following is an example of the ConnectionPoolConfig. Expire_URL You can define how long in seconds it takes for an active connection to expire. a new connection will be created to connect to the database.Configuring connection pool If you have used SQL or other similar tools to connect to a database and act on data. If you want to improve the performance of JReport Server. JReport Server supports caching a connection. IdleExpire_URL You can define how long a free connection can be idle before it is closed. Generally speaking. Once the number of the connections reaches the maximum. A program can spend several seconds every time it needs to establish a connection. you probably know that getting the connection and logging in is the part that takes the most time. the fewer the connections. which means that the active connection will not expire. which means that one request in one connection . MaxShare_URL The maximum number of requests in one connection that can be executed simultaneously. The value for this property by default is "0". If the value is set to "0". the better the performance of JReport Server. If the value is "0". it means that there will be no limit on the number of the connections.properties file in the directory <install_root>\bin. a new connection will be blocked until a free connection becomes available. leading to a considerable saving of time. which means that the connection will be released after 1 second. The value for this property by default is "50". so that it can be used each time the same user accesses the same table. Therefore. The value for this property by default is "1". The connection will not be released until the defined time has reached its limit. Once the number of the requests reaches the maximum. JReport Server is freed from having to create the connection to the database. Once the number of the connections reaches the maximum. which means that the engine will only try once to create a new connection. The smaller the number of requests. you should make a balance between these two properties to achieve the best performance of JReport Server. Attempt_URL This property has a close relation to the property MaxCount_URL*. which means that the engine will start the next attempt immediately. getConnectionPool. Notes: q You are forced to give a value to the property URL in order to establish a connection to the database. Since the property MaxShare_URL* and MaxCount_URL* are incompatible. To make the maximum use of the available connections in the pool. the better the performance of JReport Server. You can gain access to it using the URL http://localhost:8889/admin/getConnectionPool. It is now deprecated in the current version. a new connection will be blocked until a free connection becomes available. The default value for this property is "0". For the other six properties which configure the URL. Interval_URL The interval the engine will wait for between attempts to create a new connection if a previous try has failed. If the value is set to "0". it is not necessary to set their property values (the default values will be used). The default value for this property is "1".jsp.can be executed simultaneously. it means that there will be no limit to the maximum number of requests sharing one connection and that all the requests in one connection can be executed simultaneously. The unit of the property value is milliseconds. q . the property Attempt_URL* allows you to set how many times the engine will try to establish a new connection.jsp is still available for customers who have updated JReport Server from earlier versions. getConnectionPool.jsp is used for viewing connection information and for deleting unused connection information. properties file.2.8.8 to 1. Trace type is divided into four levels. For example. In comparison with earlier versions. These levels are OFF. They are: q Using the JReport Administration page > Configuration > Log panel. It is easy to configure and manage. The following are the significant benefits of the JReport logging system: q It is compatible with your application which is based on log4j. error type is . such as tracing a program workflow. OUTLINE. INFO. logging runtime information and associated elements. Error is used for logging something unexpected or irregular. The logging system is used for obtaining meaningful and helpful JReport logging information in a convenient way. JReport also supports versions of log4j version 1. from the least to the most. when a URL is unreachable. q q Configuring logs Log configuration tasks can be achieved in three ways.Configuring logs JReport provides a robust. and TRIVIAL. Similarly. Sets all loggers' trace level to INFO and error level to WARN. Using the LogConfig. q q Note: Any settings made using the command options will override the trace and error type level settings in the LogConfig. a file does not exist. or a table cannot be found in a data source. Using command options. and is ordered according to the amount of information logged. Outputs JReport Engine messages to the file as specified and uses the -vDebug level. flexible and configurable logging system. It supports setting the trace and error type level separately. Logging information using the trace and error type The JReport logging system enables you to trace both normal and abnormal situations by using the trace and error type. the command options used for log configuration have undergone a considerable change.2. The following are descriptions of these options: Options -vDebug -vError -logall -log[:file Name] Description Enables JReport Engine to output messages to a file and sets engine log file's trace level to INFO and error level to WARN.properties file located in <install_root>\bin directory. Trace is used for logging something expected or regular. It can be configured to output the logging information of different modules separately or to output them all together. which is based on log4j version 1. Enables JReport Engine to output messages to a file and sets engine log file's trace level to OFF and error level to ERROR.3alpha7. 4. %L and %M. For information about the ConversionPattern property. Configuration settings . %F. If you want to customize the location of the Engine log file. take the following steps: 1. you can set trace level to TRIVIAL and error level to WARN.EngineRollingFile.properties file. 2. Modify the parameter log4j. If you want the most amount of information to be logged. By default. The levels of trace and error affect the amount of logging output. 3. The settings for error level will have a negligible affect on performance but a high level for trace may affect performance. and is ordered according to the amount of information logged. The higher the level. Customizing log file location You can customize where to output logs in your local disk instead of using the default directory <install_root>\logs. For example. different log categories are output to different rolling files. which is located in the <install_root>\bin directory.properties file located in the <install_root>\bin directory. Open the LogConfig. Set its value to an absolute path with a log file name. from the least to the most.log in the <install_root>\logs directory.effect on performance The following are configuration properties which have an effect on server performance: q If the showTitle property is set to true in the LogConfig.properties file. the Engine log is output to Engine. the effect on performance is negligible. These levels are OFF. For detailed information about the eight levels.File. and WARN. Restart JReport Server.log (on Windows) or /logs/Engine. for example: C:\logs\Engine. the log file size will increase. The use of the following conversion characters in ConversionPattern property results in the slow generation of caller class or location information: %C. see Log panel.log (on Linux/ Unix). Their use should be avoided unless execution speed is not an issue. FATAL. However. Setting these to the highest level could affect system performance as well as disk usage. see comments in the LogConfig. you can set trace level to OFF and error level to ERROR.also divided into four levels.appender. q q . If you want the least amount of information to be logged.properties file. ERROR. Save the LogConfig. the more the output. properties in <install>\bin directory by adding "/jrp": jsp_path=/jrp/jinfonet/ 4. Copy all contents in <install_root>\public_html to <install_root>\public_html\jrp.jsp http://<hostname>:8888/dhtmljsp/. Changing standalone server context path JReport has the following URL configuration for accessing JReport Server console and running JReport reports in a standalone environment: http://<hostname>:8888/jrserver http://<hostname>:8888/jinfonet/index..jreport_servlet_path=/jrp/jrserver web.design_servlet_path=/jrp/webreporting web.skin. You may want to change the server context path as follows: http://<hostname>:8888/jrp/jrserver http://<hostname>:8888/jrp/jinfonet/index. 2. Modify the value of jsp_path in redirect..help_servlet_path=/jrp/help web. This section introduces how to do this in a standalone or an integrated environment.dhtml_servlet_entry_path=/jrp/jrdhtml web.properties in <install>\bin directory by adding "/jrp": .dir=/jrp/skin 3..jsp http://<hostname>:8888/jrp/dhtmljsp/. Modify mapping..dhtml_jsp_path=/jrp/dhtmljsp web.properties in <install>\bin directory by adding "/ jrp": web.dhtml_servlet_path=/jrp/dhtml web. To do this: 1. Modify the following property values in server.Changing the server context path In some circumstances you may want to change the server context path for accessing JReport Server console and running JReport reports. Move index.jsp http://<hostname>:port/jreport/dhtmljsp/.jsp=jspservlet 5.jsp http://<hostname>:port/jreport/myjsp/dhtmljsp/. You may want to change the server context path as follows: http://<hostname>:port/jreport/myjsp/jinfonet/index..catalog=%2fSampleReports% 2fSampleReports.cls Changing integrated server context path Supposing that all server resources are deployed to the context root folder jreport\ after deploying JReport Server to an application server. You can use the following URLs for accessing JReport Server service console and running JReport reports in the integrated environment: http://<hostname>:port/jreport/jinfonet/index..cat &jrs.jsp?jrs. To do this: 1.jsp Run a report in the DHTML format by the URL: http://localhost:8888/jrp/dhtmljsp/dhtml. Start the server and access the server by the URLs: http://localhost:8888/jrp/jrserver http://localhost:8888/jrp/jinfonet/index..htm and the following folders from jreport\ to jreport\myjsp\: admin dhtmljsp images javascript jinfonet skin style 2.properties in the \WEB-INF directory.. Create a file jrserver.# # # # # # Map servlets to paths Properties beginning with a . are extension properties.report=%2fSampleReports%2fEmployeeInformation. all other properties are path properties Format: path or extension = servlet name /jrp/jrserver=jrserver /servlet/sendfile=sendfile /jrp/dhtml=dhtml /jrp/jrdhtml=jrdhtml /jrp/help=help . add the skin and dhtmljsp properties and provide the correct paths (the context root is excluded): . dir=/myjsp/skin web.catalog=% 2fSampleReports%2fSampleReports.skin.jsp?jrs. Access the server by the URL: http://<hostname>:port/jreport/myjsp/jinfonet/index.cls .dhtml_jsp_path=/myjsp/dhtmljsp 3.report=%2fSampleReports%2fEmployeeInformation.jsp Run a report in the DHTML format by the URL: http://<hostname>:port/jreport/myjsp/dhtmljsp/dhtml.web.cat &jrs. After going through these topics. library components. security. you will be able to manage your JReport Server more effectively. versions. . They are management of resources. server data and cached report data. q Managing resources Managing versions Managing security Managing tasks Managing server data Managing cached report data q q q q q Note: A JReport Live license for JReport Server is required in order to use web reports and all the related functions. and all the related features. and a JDashboard license is required in order to use dashboards.Managing The administration task in JReport Server consists of six major parts. tasks. If you would like a license please contact your Jinfonet Software account manager to obtain a license. This chapter discusses these task types in detail. properties file. show_catalog property to true in the server.option. getting resources from a real path.Managing resources Resources on JReport Server are organized into a tree structure called the Resource Tree. you can also manage the versions and secure your resources. You can perform basic resource tasks. such as publishing. such as changing resource and folder properties. Only the resources that are organized in the resource tree can be accessed and queried by a client. In order to perform operations on catalogs published from outside of JReport Server on the JReport Console page. Detailed information is available in sections Managing versions and Managing security. deleting. This section includes the following topics: q Publishing resources Converting reports of earlier versions into current version Updating a catalog's cube/business view permission Getting and using resources from a real path Customizing TTF font location for resources Working with custom fields Changing resource and folder properties Linking resources and catalogs Deleting resources q q q q q q q q . you need to enable them to be displayed first by setting the web. and more advanced tasks. Moreover.page. Note: Catalogs are by default not displayed in the server resource tree on the JReport Console page. library components. browse to the folder where you want to publish the resources. or catalogs from JReport Designer to JReport Server. on the JReport Administration page. select Dashboard > Component Library on the system toolbar. and folders. then on the task bar of the Reports page. Do either of the following to access the Publish to Local Server dialog: r For administrators. library components. you first need to have your resources published and organized. catalogs. then click Publish to Local Server. then click the To Local Server link. click Reports on the system toolbar and select Reports from the dropdown menu. s To publish reports. browse to the folder where you want to publish the resources. Publishing resources from JReport Designer You can directly publish your reports. The resources are reports. and folders. Only administrators can publish library components. . catalogs. on the JReport Console > Reports page. library components. They are reports.Publishing resources Before you can perform any tasks on JReport Server. browse to the folder in which to publish the resources. That is because the publish time takes the server time instead of the client time. s r For end users. The Publish to Local Server dialog is then displayed. There are three ways of publishing resources: q Publishing resources from JReport Designer Publishing resources from a local computer Publishing resources from a remote computer q q Note: After resources have been delivered to JReport Server. To publish resources from a local computer: 1. For detailed information. In the Component Library panel. To publish library components. you may find that the publish time shown on the server UI is different from the client time. on the JReport Administration page. In the Reports panel. click Publish > To Local Server. see the topic Publishing resources remotely in the JReport Designer User's Guide. Publishing resources from a local computer You can publish these types of resources from a local computer. This name is required and is used as the display name of the resource node in the server resource tree. 4. r If the Page Report or Web Report resource type is selected: 1. and then type a path in the Resource Real Path box. specify a name for the report. specify the report you want to publish with its full path. 8. Click the Browse button to specify a font directory for the report. 6. 3. Specify properties for the to-be-published resources as required.2. select the status of the report. 3. Make sure that the resources exist in the resource real path. . Specify values of the custom fields for the report if there are custom fields. r If the Component resource type is selected. Type a brief description to describe the library component in the Resource Description field. 5. specify a name for the library component. In the From File text field. 4. 7. 2. This name is required and is used as the display name of the resource node in the server resource tree. 2. Click the Browse button to specify a style directory for the report. From the Status drop-down list. In the Resource Node Name field. specify the catalog you want to publish with its full path. In the From File text field. 3. To enable getting resources from a real path. Type a brief description to describe the report in the Resource Description field. In the Resource Node Name field. Click the Browse button to specify a geographic information directory for the report. 1. Select a type from the Resource Type drop-down list. check the Enable Resources from Real Paths option. click the Advanced Publish button. To apply an archive policy to the resources that you are publishing. Click the Browse button to specify a geographic information directory for the resources. Click the Browse button to specify a font directory for the library component. 6. In the Resource Node Name field. Note that a folder by itself does not have versions. . In the Resource Node Name field. Click the Browse button to specify a style directory for the resources. 5. 2. All resources contained within the specified folder will then be displayed. This name is required and is used as the display name of the resource node in the server resource tree. specify a name for the folder. If the resources you specify to publish contain reports created in earlier versions. 7. To enable getting resources from a real path. 2. Click the Browse button next to the From Folder text field to specify the folder where the resources you want to publish are saved. 8. Check the resources you want to publish and specify the properties for each resource as required. 4. r If the Folder resource type is selected: 1. Read. Delete. Permissions that can be specified to a user or role include: Visible. To enable getting resources from a real path. Schedule. This name is required and is used as the display name of the resource node in the server resource tree. Specify values of the custom fields for the catalog if there are custom fields. Type a brief description to describe the catalog in the Resource Description field. click the Advanced Publish button. If the resources are to be published to the Public Reports folder. check the Enable Resources from Real Paths option. 4. 3. Click OK to start publishing the resources. then specify the archive policy as required: Archive as New Version or Replace Old Version. Click the Browse button to specify a font directory for the resources. If you want to use Advanced Publish. 4. 3. 3. Grant. Click the Browse button to specify a style directory for the resources. Click the Browse button to specify a geographic information directory for the resources. r If the Folder with Contents resource type is selected: 1. In the Resource Node Name field. Check the resources you want to publish and specify the properties for each resource as required. Click the Browse button to specify a font directory for the resources. the archive policy specified for a folder applies to the folder contents. Write. check the Apply Archive Policy option. Click the Browse button to specify a geographic information directory for the library component. r If the Catalogs. 9. If you want to use Advanced Publish. Specify values of the custom fields for the folder if there are custom fields. specify a name for the folder. Click the Browse button next to the From Folder text field to specify the folder where the resources you want to publish are saved. Specify values of the custom fields for the folder if there are custom fields. 4. 7. and Update Status. 2. 3. specify a name for the catalog. 8. and then type a path in the Resource Real Path box.5. 5. check Automatically Convert Old Report Schemas. All resources contained within the specified folder will then be displayed. and then type a path in the Resource Real Path box. In the From File text field. Type a brief description to describe the folder in the Resource Description field. Click the Browse button to specify a style directory for the library component. 4. click the Set Permissions link to specify user permissions to them according to your requirement. check the Enable Resources from Real Paths option. r If the Catalog resource type is selected: 1. 6. This name is required and is used as the display name of the resource node in the server resource tree. specify the catalog you want to publish with its full path. 2. the reports will then be automatically converted into current version JReport reports when publishing finishes. Type a brief description to describe the folder in the Resource Description field. Specify the maximum number of versions to keep in the library component by inputting a number in the text box. 5. Execute. 7. 6. Reports and Folders in Folder or Catalogs and Reports in Folder resource type is selected: 1. To publish resources from a remote computer: 1. r If you want to publish the resources directly to the current open folder. on the JReport Administration page. select Dashboard > Component Library on the system toolbar. In the Resource Node Name box. the option is displayed only when they have the privilege of publishing resources and have logged onto JReport Server from a local browser. The Publish to Remote Server dialog is then displayed. If you want to create a new folder in the current open folder to locate the resources. Click the Browse button to specify the zipped file which contains the resources you want to publish. library components. Only administrators can publish library components. r . Publishing resources from a remote computer You can publish these types of resources from a remote machine to the server. s r For end users. In the Component Library panel. For end users. Do either of the following to access the Publish to Remote Server dialog: r For administrators. To publish library components. then click the To Remote Server link. browse to the folder in which to publish the resources. on the JReport Administration page. Before publishing remote resources. b. In the Reports panel. Make sure the Publish files and folders in the zipped file to /XXX checkbox is not selected. click Reports on the system toolbar and select Reports from the dropdown menu. catalogs. browse to the folder where you want to publish the resources. then click Publish to Remote Server. The name will then be used as the display name of the resource node in the server resource tree. check the Publish files and folders in the zipped file to /XXX checkbox. Specify where the resources will be published. They are reports. specify the name for the folder. you must create a zip file or tar file containing the resources to publish. browse to the folder where you want to publish the resources. a. then on the task bar of the Reports page. 3. 2. click Publish > To Remote Server.Note: The Publish to Local Server option is always available to administrators on the JReport Console page. s To publish reports. and folders. on the JReport Console > Reports page. Delete. r To generate a jar file containing no path information. Schedule.jar. You can use jar.6. 8. and Update Status.* for this parameter. and containing no path information. 7. such as Winzip and gzip. 4. The jar file will be generated to c:\temp.c. Write. Note that specifying a path for this parameter will cause the generated jar file to contain the same path information.exe that the JSDK provides to build a compressed jar file directly. To enable getting resources from a real path. Click OK to start publishing the resources. Type a brief description to describe the folder in the Resource Description box. Use the command as follows: %JAVAHOME%\bin\jar. check the Apply Archive Policy option. Read. Grant.exe -cvfM %DEST_JAR_FILE% %SOURCE_RESOURCES% Parameter %JAVAHOME% %DEST_JAR_FILE% %SOURCE_RESOURCES% Description The Java SDK install root. Permissions that can be specified to a user or role include: Visible. then specify the archive policy as required: Archive as New Version or Replace Old Version.jar. check Automatically Convert Old Report Schemas.jar file will be generated to the path you specify here. C:\myReports>C:\jdk1. r q You can compress the resources manually using a third-party tool. f. the process is similar to that for a local publish. and then type a path in the Resource Real Path box. The destination file path and file name. If the resources are to be published to the Public Reports folder. Specify values of the custom fields for the folder if there are custom fields. as aa. There are two approaches to building a compressed file. e. . Korean. the files will be extracted to a folder called myReports. library components. Check the resources you want to publish and specify the properties for each resource as required. click the Advanced Publish button. Note: When publishing resources from a remote computer.0_17\bin\jar -cvfM c:\temp\aa. The resource type of Remote Publish can ONLY be a compressed file. For example. add the corresponding font files into the compressed file as well. All resources contained within the zip file will then be displayed. To apply an archive policy to the resources. when you extract a jar file compressed using myReports\*. If the to be published resources are library components. there are differences: q Local Publish publishes resources from the machine where the server runs. The source file path and file name. If you want to use Advanced Publish. If the resources you specify to publish contain reports created in earlier versions. switch to the source folder. so do not specify a path for this parameter. using the file name you provide. The . and catalog files in advance. and then carry out the compression. You should compress the reports. or Japanese names. and if special fonts are used in the reports or library components. 6. while a Remote Publish publishes resources from a client machine using a web browser to the machine where the server runs. JReport Server is not able to import a compressed file which contains the path information. the reports will then be automatically converted into current version JReport reports when publishing finishes. compressing all the files in c:\myReports. 5. Always use this method if the folder you are compressing contains reports or library components with Chinese. Execute. specify the maximum number of versions to keep in the library component by inputting a number in the text box. For example. click the Set Permissions link to specify user permissions to them according to your requirement. d. However. check the Enable Resources from Real Paths option. Specify the folders which contain the reports you want to convert. To convert reports earlier than V8 into current version: 1. Converting via the Administration UI The converting UI is available to administrators only.bat/rptconv. Converting using tool You can also use rptconv. 2. The converted reports are stored in the same directory. When done. JReport Server allows administrators to permanently convert reports earlier than V8 in the server resource tree to adapt to the current version. click OK to start converting. This may result in decreased performance. r Replace the Old Repors Replaces the old reports with the converted reports. Specify how to save the converted reports. . Save as New Report Versions Saves the converted reports as new report versions in the resource tree. To avoid this. r 4. click Reports on the system toolbar. On the JReport Administration page. the JReport Engine has to first convert the earlier version report into a current version report before running the report. 3. then select Converting from the drop-down menu. during each server runtime lifecycle when you run such a report for the first time.Converting reports of earlier versions into current version If your JReport Server contains reports earlier than V8.sh located in the <install_root>\bin directory to convert a report and a type of reports or all reports earlier than V8 in a directory. It is used to convert all reports earlier than V8 in the My Reports folder or Public Reports folder. for example.Updating a catalog's cube/business view permission When a catalog is published to JReport Server. Then the server will invoke the method of the cube/business view authorize manager to reload all the permission settings. c. then click the Cube Security button column. and then select the updated authorization file using the Browse button. The authorization file is loaded by the cube/business view authorize manager of its catalog during runtime. if the catalog file is called test. In the Cube Security dialog. in the Control b. upload it to JReport Server from the JReport Administration page if you are an administrator: a.cat. business cube and/or business view permission settings by uploading the updated authorization file from JReport Designer without re-publishing the catalog. when you save the catalog. Browse to the row the catalog is in. . or business view permissions in the catalog using JReport Designer. the authorization file is called test. The catalog and authorization files have the same file name but different suffixes. After you have updated the authorization file in JReport Designer.auth. you can only update the authorization file to update the permission settings either using JReport Designer or by hand. Click OK to apply the settings. the permission settings are also saved and they are saved in an authorization file in the same folder as the catalog file. you can update the catalog's report cube. first select a catalog version. To do this: 1. and the permission settings will take effect right after reloading. The updated authorization file will be uploaded to JReport Server and replace the old file. business cube. In this case. 2. If the catalog is not modified. 3. First you should have set report cube. q q q . In the server. Notes: q You cannot publish resources from real path. Now end users can perform operations on the real path resources. when accessing a resource node which is linked with a real path. check Enable Resources from Real Paths. The difference between real path resources and published resources lies in the way of managing them. save the changes and then restart the server. the folder ABC. To use real path resources. After using the real path resources. Real path resources are managed in both the server and the operating system. You cannot delete the real path resources directly from the server UI. specify a real path for the demo virtual folder as C:\JReport\Server\reportbak. then click OK to save the changes. 4. For details. see Clearing unused nodes from the system database. You cannot use a real path resource as an archive location. has a sub folder DEF. the local resources in the real path are loaded to the node and displayed together with other server resources (including the published resources) in the node. report2. and report3. whose real path is C:\FolderABC. under certain special conditions some invalid nodes will be generated in the server databases. administrators can perform the corresponding option on the JReport Administration page to clear unused nodes from the internal JReport Server database. advanced running. The following example uses the resources in the folder /SampleReports obtained from the real path: 1. On the JReport Administration page. 5.Getting and using resources from a real path Not only can you use the published resources described in section Publishing resources. You can then add or remove resources into or from JReport Server by adding or removing them into or from the real path. The relationships of folder real paths do not need to be consistent with that of the resource tree folders. You will then see the three sub folders: report1. setting properties. and scheduling. On starting JReport Server. In the Windows directory C:\JReport\Server\reportbak. For example. create three sub directories report1. including their reports and catalogs. In order to delete the invalid nodes. 3. if you do not want to publish resources to the server by using the publish feature. That is. and then copy some reports and catalogs into them. and report3 within it. 2. in the resource tree. but also those resources obtained from a real path. click Configuration on the system toolbar. you should specify a real path for a virtual folder. then select Advanced from the drop-down menu. The real path of DEF need not necessarily be a folder in C:\FolderABC. click the virtual folder /SampleReports. Published resources are managed in JReport Server totally. Also. check the Enable Resources from Real Paths option. report2. you can set a real path instead. including viewing versions. and report based operations such as running. It can be any folder. Open the Properties dialog of the folder /SampleReports. In the Advanced panel. they are independent of each other. but can only achieve it by removing the resources from the local disk. you can create an install. q Setting during installation 1. When installing JReport Server using the Installation Wizard. Check the Enable Resources from Real Paths option.publicReportsRealPath=D:\JReport .server. The Configuration screen is then available for you to configure the server properties. it retrieves the file contents. Specify the content in the file as follows: server. select Advanced from the left panel. q Setting after installation If you want to set a default real path for the Public Reports folder after installation. and then type in a path in the Public Reports Real Path text field or specify a path using the Browse button. select the installation type Custom Installation for Standalone Server. an install. When the server starts. In the screen. There are two ways to achieve this goal: setting the real path during or after installation. and then sets the real path for the Public Reports folder. Note that the file is deleted after the server has loaded the file contents.properties file in the <install_root>\bin directory manually. 2. 4.properties file will be created in the <install_root>\bin directory.Setting a default real path for the Public Reports folder before the server starts JReport Server enables setting a default real path for the Public Reports folder without having to log onto the server.server. 3. Upon completion of the installation. font.path Use the API HttpUtil. These are in an order from higher to lower priority: q Use the -D parameter to set the system properties key jreport.path in the server. q q Notes: q The value specified by -D is not stored into the server.path Add a property server. q .Customizing TTF font location for resources The default font path in JReport Server is <install_root>\font.font.initEnv() to set the properties key server.server.properties file and set a full path to it.font. You can set the font path to a different location by using the following three ways. The value specified using API is stored into the server.properties file.properties file. In the displayed dialog. modify the name and description for the custom field. Click OK to accept the changes. Deleting custom fields Administrators can delete the custom fields that are not required at any time. etc. click New Custom Field on the task bar. 2. You can select multiple custom fields. Editing custom fields To edit a custom field: 1. either locally/remotely or from JReport Designer. provide a name and description for the custom field. In the Custom Field panel. then select Custom Field from the drop-down menu. 2. Click Edit > Delete on the task bar. Click OK in the warning message to confirm the deletion. In the Custom Field panel. Setting value to custom fields When you publish resources to JReport Server. To do this: 1. the same as Type. 5. if . then click Edit > Properties on the task bar. In the New Custom Field dialog. select the row where the custom field is. click Configuration on the system toolbar. To enable the custom field. Description. and change its status if required. select the row where the custom field is in.Working with custom fields Custom fields are user defined fields which can be used as resource properties. 2. Click OK to create the custom field. In the Custom Field panel. On the JReport Administration page. 3. it will be available in the resource information table on both the JReport Administration > Reports panel and the JReport Console > Reports page. Last Modified. Creating and enabling custom fields To create a custom field: 1. End users can define its value by setting properties. 4. After a custom field is created and enabled by administrators. 3. check the Enabled option. 3. Hiding custom fields By default. 3. Also. the custom field values can be defined by setting resource properties. 2. Click Profile on the system toolbar of the JReport Administration page. In the General tab. For end users: End users can hide a custom field on the JReport Console page > Profile > Customize Server Preferences > General tab as shown in the above method. and besides have a second choice: 1. they will be displayed in the publishing dialog and you can specify the value of the custom fields for each resource according to your requirements. unselect the checkbox in front of the corresponding custom field. If you want to hide a custom field from being shown in this table. . all the enabled custom fields will be displayed in the resource information table on both the JReport Administration > Reports panel and the JReport Console > Reports page. in the Columns Shown in Reports List section. follow the steps below: For administrators: 1. then click OK. click Tools > Preferences on the task bar. On the JReport Console > Reports page.there are custom fields enabled. unselect the checkbox in front of the corresponding custom field. then select Customize Server Preferences from the drop-down menu. Click OK to accept the setting. 2. In the General tab of the Preferences dialog. To change the properties of a library component resource or folder as an administrator: On the JReport Administration page. browse to the row that the object in and do either of the following: r Select the row and click Tools > Properties on the task bar of the Reports page. associated with resources and folders. are the rules granted to users which control the operations they can perform on resources and folders. In the Reports panel. change the q For end users. on the JReport Console > Reports page. browse to the row that the object is in and click the Properties button settings as required. in the Control column. in the Properties dialog. change the See also the following documents for details about the property settings: q Catalog Properties dialog Folder Properties dialog Result Properties dialog Report Properties dialog Dashboard Properties dialog Library Component Properties dialog q q q q q Assigning permissions Permissions. in the Control column. Put the mouse pointer over the row and click the Properties button on the floating toolbar. any new resources and sub folders created in that folder will inherit the same permissions. you can enable their user permissions and set their permissions separately. In the Component Library panel. right-click in the row and select Properties from the shortcut menu. To set. Resources and folders will inherit permissions from their parent folder if their user permissions are not enabled. view. After you have set permissions for a parent folder. or remove resource/folder permissions: . click Dashboard on the system toolbar and select Component Library from the drop-down menu. Select the row. browse to the row that the object is in and click the Properties button settings as required. If you do not want them to inherit these permissions. change. change the settings as required. click Reports on the system toolbar and select Reports from the drop-down menu.Changing resource and folder properties To change the properties of a report resource. on the JReport Administration page. In the Properties dialog. dashboard or folder: q For administrators. In the Properties dialog. r r Then. and then check or uncheck each permission as required. only apply to the report type resource. you must have both the Visible and Read permissions. r To set up or change permissions for a role. For example. you may require more than one permission. Only members in the administrator role can assign the Grant permission to other users or groups or roles. Some special permissions. Allowing anyone of these will also allow the Read permission. group. in the Permissions tab of the Properties dialog. such as Execute and Schedule. r q r To set up or change permissions for a role. uncheck the Enable Setting Permissions option.q For administrators. groups and roles. to view the properties of a report. For end users. user or group. and their contents. click the Add button to add it and then assign the permissions accordingly. Some permissions depend on other permissions in order to work. r Notes: q Security permissions do not apply to the built-in version folders. in the Properties dialog. To complete a task. select the user. first check Enable Setting Permissions. the My Reports folder. select the corresponding radio button below the Available box. click the Set Permissions link. To remove resource/folder permissions for all users. To remove resource/folder permissions for all users. and Schedule. User Permissions. or Group Permissions table. q q q q q . group or role is not listed in the corresponding table. or role in the Role Permissions. Execute. Users that are given the Grant permission can grant permissions to other users in the same group. add the role/user/group to the Selected box and then assign the permissions accordingly. then select the role/user/group in the Selected box and check or uncheck the required permissions. check Enable Setting Permissions. such as Write. groups and roles. If the user. If the role/user/group is not listed in the Selected box. then in the Set Permissions dialog. user or group. uncheck the Enable Setting Permissions option. folder level. and resource level as follows: q To set linked catalog at server level (this can only be done by administrators): 1. However. you can change it by the provided option Select Another Catalog. then specify the linked catalog as required. In the Advanced panel. 2. the default selected catalog is the linked catalog if there is one. you can use the parent-level linked catalog as the linked catalog of the folder/resource.If checked. q To set linked catalog at folder/resource level. r Use Specified . then click the Select Another Catalog link to specify the catalog which will be used as the linked catalog at server level. As for Advanced Run and Schedule. q q When directly running a resource. however. The benefits of a linked catalog compared to a copied catalog are: q There is no need to also copy the wanted catalog to the destination directory when saving the resource to a different location. you can specify a linked catalog which can be any catalog in the server resource tree to the folder/resource. Click Save to save the change. For the My Reports and Public Reports folders. check Enable Linked Catalog. Go to the JReport Administration page. the resource will run within the selected catalog in the same folder).If a linked catalog has been specified on the parent level of the folder/resource. for the other folders or resources. the linked catalog has higher priority than the catalog specified in the same folder as the resource (without linked catalog. When the resource and its linked catalog are not in the same directory. Setting linked catalog Linked catalog can be set at server level. 4. the task will still use the previous catalog until the task information is updated. the parent level is the server level. go to the Properties dialog of the folder/resource. the parent level is the parent folder.Linking resources and catalogs A resource such as a report or a library component can be linked with a catalog in JReport. r Notes: q If a schedule task has been submitted and then the linked catalog in use is modified. Use Inherited . When the linked catalog is updated. you can also save the original catalog as a linked catalog q . Restart JReport Server to make the settings take effect. check Enable Linked Catalog. When running a report in JReport Viewer. the copied catalog cannot be updated if its original catalog is updated since they are two independent versions. the resource using the catalog can run with the updated version. click Configuration on the system toolbar and select Advanced from the drop-down menu. the resource can still run with the catalog. 3. .when saving the DHTML report. on the JReport Administration page. then do either of the following: r Select the row. r Notes: q The Public Reports folder and My Reports folder cannot be deleted. browse to the row that the resource or folder is in.Deleting resources To delete a resource or folder: q For administrators. browse to the row that the resource or folder is in. q For end users. Deleting a resource or folder removes the resource or folder from disk. q . then click the Delete button in the Control column. right-click in the row and select Delete from the shortcut menu. Any relevant versions belonging to the resource will also be deleted. Put the mouse pointer over the row and click the Delete button on the floating toolbar. on the JReport Console > Reports page. The deleted resources and folders cannot be retrieved. You can control whether or not to use multiple versions for a specific resource.Managing versions Your resources might change over time. and catalogs. The archive policy can be applied to a single resource individually. are controlled by versions. JReport Server uses a versioning system to create and manage resources that have changed in content and properties owing to updates made to them. In addition. dashboards. A great proportion of resource management tasks are carried out by managing resource versions. JReport Server uses an archive policy to control the resource versions. you can define the maximum number of versions that can be listed in the version table. or to many resources in a folder as a whole. This section shows how to manage resource versions as follows: q Creating versions Browsing versions Applying an archive policy Deleting versions Advanced version topics q q q q . All the resources in the server resource tree: reports. report results. Also. library components. Then. q When advanced running a report. select Built-in Version Folder. a report result version will be generated to the location specified. s 2. library component. show_catalog property to true in the server. To generate report result version in a standalone resource node in the resource tree. s To generate the report result version in the built-in folder. to create a new version for a report. In order to perform operations on catalogs published from outside of JReport Server on the JReport Console page. For how to publish. If you are publishing resources using JReport Server. s . To generate report result version in a standalone resource node in the resource tree. q When scheduling a report to publish it to the versioning system. and each saving action will create a version in the dashboard. s To generate the report result version in the built-in folder. or catalog versions The method for creating a new version to a report. Note: Catalogs are by default not displayed in the server resource tree on the JReport Console page. select The My Reports folder or The Public Reports folder. library component. see Publishing resources. Specify where to save the result version by setting the Archive Location option. in the Publish > To Version tab of the Schedule dialog: 1.properties file. and then make the old and the new share one common resource node. when the report finishes running.page. you have to publish them respectively from outside of JReport Server. library component.Creating versions Generally. and then provide the path and resource name information in the corresponding box. Versions of a dashboard are generated by saving the dashboard. or catalog. select Built-in Version Folder.option. or catalog is by publishing a resource of the same type with exactly the same name to the same location on JReport Server. and then provide the path and resource name information in the corresponding box. Apply an archive policy to the version as required and submit the task. Creating report. Specify where to save the result version by setting the Archive Location option. you need to enable them to be displayed first by setting the web. report result versions are created when an end user runs a report using Advanced Run or Schedule Run However. Creating report result versions A report result version can only be created by advanced running the report or by scheduling the report to publish it to the versioning system on the JReport Console page. in the Archive tab of the Advanced Run dialog: 1. you need to apply an archive policy so as to make the published resources saved into the existing resources as a new version. select The My Reports folder or The Public Reports folder. you should make sure to provide the path and name of the existing resource for The Public Reports folder or The My Reports folder option. for example. creating a new version for a resource node. Then. When generating report result versions in an existing standalone resource node in the resource tree. Notes: q The resource path and name refers to the resource path and name in the resource tree. a report result version will be generated to the location specified. For The Public Reports folder option. the first slash mark (/) refers to the Public Reports folder in the resource tree. and the folder name (foldername) refers to an existing folder in the resource tree. and then save the changes. For The My Reports folder option. when the schedule task is finished. Apply an archive policy to the version as required and submit the task. you may want to update or modify it. Creating dashboard versions After a dashboard is saved into the server resource tree. and the folder name (foldername) refers to an existing folder in the resource tree. /foldername/filename. which will add a new version in the dashboard. the first slash mark (/) refers to the My Reports folder in the resource tree. For instance.2. q q q . version number. then do either of the following: r Select the resource row and click Tools > Version on the task bar of the Reports page. called the version table. q Report Versions Table Column Version Date NLS Editor Version Number Description The date and time of when the version was generated. browse to the resource. The serial ID that identifies a version in the version table. You can click the links to view the output files. r To view versions of a library component resource. browse to the resource. on the r r The versions that a resource hosts are organized in the version table. The serial ID that identifies a version in the version table. select Dashboard > Component Library on the system toolbar. q Report Result Versions Table Column Result Version Date Description The output file formats. right-click in the row and select Version from the shortcut menu. browse to the resource. q For end users. then click the Version button in the Control column. In the Component Library panel. The date and time of when the version was generated. Version table Relevant information about the versions that a resource hosts. In the Reports panel. is collected and represented in a table. on the JReport Console > Reports page. Administrators can edit NLS for a specified report version by clicking the corresponding link. .Browsing versions To view the version information of a resource: q For administrators. The version table is composed of the following columns: q Catalog Versions Table Column Version Date Version Number Description The date and time of when the version was generated. click Reports on the system toolbar and select Reports from the drop-down menu. r To view versions of a report resource or a dashboard. on the JReport Administration page. Select the resource row. on the JReport Administration page. Put the mouse pointer over the resource row and click the Version command button floating toolbar. then click the Version button in the Control column. such as the version date. then click OK to save the settings. To have them displayed. You can click the underlined file name to view the parameters. Dashboard Versions Table Column Version Date Version Number Description The date and time of when the version was generated. The serial ID that identifies a version in the version table. Tip: Some columns in the tables are not shown by default. You can perform operations such as sorting/viewing properties. . The ID of the user who created the version. The serial ID that identifies a version in the version table. Administrators can edit NLS for a specific library component version by clicking the corresponding link. locate the table. click Preferences on the task bar if available. and output files/parameters in the version table. q Library Component Versions Table Column Version Date NLS Editor Version Number Description The date and time of when the version was generated. check the corresponding items in the Preferences dialog. The serial ID that identifies a version in the version table.Parameter File Creator Version Number q The parameter file name. then click OK. Note: If you leave the Apply Archive Policy option unchecked. In the dialog. overriding its inherited archive policy. Access the Properties dialog for the resource. the resource will inherit the archive policy from its parent object. 2. The archive policy can be applied to a single resource individually or to many resources in a folder as a whole. The archive policy includes settings for controlling the use of multiple versions for a specified resource. By default the number of versions is unlimited. q If there is no archive policy specified for a resource. It can also be applied when you run (Advanced Mode) or schedule a report. If afterwards you then specify an archive policy for the resource. refer to the table below: If you want to Apply archive policy to a folder Then do 1. Apply archive policy to a resource 1. Applying an archive policy to resources in the resource tree To apply an archive policy to a resource in the resource tree. set the Apply Archive Policy option as required. In the Properties dialog. Note: This does not include resources that already have individually applied archive policies. Available only for resources in the resource tree. Access the Properties dialog for the folder (for how to access the dialog. the resource will inherit the archive policy from its parent object. then click OK. Result The archive policy will be applied to all of the folder content. and the maximum version amount that will be listed in the version table: q Archive as New Version Specifies whether to use multiple versions for the specified resource. the folder it resides in. for example. set the Apply Archive Policy option as required. Maximum Number of Versions Specifies the maximum number of versions that will be listed in the version table of the resource. The archive policy is applied to the resource. see Changing resource and folder properties). 2. . the new policy will override the one inherited from the parent object.Applying an archive policy JReport Server uses an archive policy to control resource versions. In the Publish tab. browse to the resource you want to run. On the JReport Console > Reports page. In the Report Result Versions tab. check the Auto Archive Properties option. making sure that Archive Location is set to the resource tree folder. 2. 2. for example.Apply archive policy when running a task in Advanced mode 1. example. To apply an archive policy to the built-in version table. 4. making sure that its parent object. Finish the other relevant information. Put the mouse pointer over the resource row and click the Advanced Run button The archive policy will be applied to a result type resource. refer to the table below: If you want to Apply archive policy to a built-in version table Apply archive policy when running a task in Advanced mode Then do 1. 2. Apply Archive Policy option unchecked. The versions in the built-in version folder are controlled by its own archive policy. check the Maximum Number of Versions option. Access the version table for the resource (report type) (for how to access the table. the 3. Finish the other relevant information. Note: If you leave the Apply Archive Policy option unchecked. Set the Apply Archive Policy option as required. 5. Set the Apply Archive Policy option as required. check the Auto Archive Properties resource will use its old option. 1. then check the Publish to Versioning System option. Apply archive policy when scheduling a task 3. the resource will use its old archive policy or inherit the archive policy from its parent object. 5. Finish the other relevant information. 3. click the To Version sub tab. In the Archive tab. making sure that Archive Location is set to the Built-in Version Folder. On the JReport Console > Reports page. see Browsing versions). then click Finish. the folder it resides in. Put the mouse pointer over the resource row and click the Schedule button on the floating toolbar. specify the versions to be saved as required. browse to the resource you want to schedule. then click Finish. . then click OK. 4. 2. browse to the resource you want to run. 1. In the Archive tab. On the JReport Console > Reports page. Put the mouse pointer over the resource row and click the Advanced Run button on the floating toolbar. 5. for Archive Location is set to the resource tree folder. The archive policy is applied to a result type resource. Note: If you leave the on the floating toolbar. archive policy or inherit the archive policy from 4. Applying an archive policy to the built-in version table The above table applies to the resource in the resource tree only. the folder it resides in. and then click Finish. Set the Apply Archive Policy option as required. making sure that Archive Location is set to Built-in Version Folder. browse to the resource you want to schedule.Apply archive policy when scheduling a task 1. Finish the other relevant information. 4. 3. In the Publish tab. click the To Version sub tab. 2. Put the mouse pointer over the resource row and click the Schedule button on the floating toolbar. . On the JReport Console > Reports page. then click Finish. then check the Publish to Versioning System option. Set the Apply Archive Policy option as required. 5. When removing the versions using the user interface. if you specify "Result Expires in 30 days". . first open the version table of the resource (for how to access the table.Deleting versions After creating versions. Put the mouse pointer over the version row and click the Delete button . the archive versions stored on disk are also physically deleted. periodically you may want to delete some expired or unused versions. You can choose to remove these versions manually or configure JReport Server to delete them automatically. you can specify a certain period of time to keep the version. When creating a resource version. it will be automatically removed 30 days after its creation. It is only applicable to report result versions. you can specify the maximum number that will be saved. then: q For administrators. Deleting automatically There are two approaches to automatically deleting versions: q Apply Archive Policy The Apply Archive Policy controls the number of versions that will be recorded in the version table of a resource. in the version table. For example. when the sixth version is created. Deleting manually To delete some versions of a resource manually. in the version table. The version will automatically be removed from the version list after the number of days or the specified date. For end users. the first version will automatically be removed. When creating a report result version. find the version you want to remove. view the version information again. check the checkbox ahead of the versions that you want to remove and then click the Delete link. If the number of versions exceeds the specified number. q Result Auto-delete Result Auto-delete controls the duration of versions. r r After receiving "The version has been deleted" message. Select the version row. right-click in the row and click Delete on the shortcut menu. For example. You will find that the version you selected has now been removed from the version table. if you specify Maximum Number of Versions as 5. the oldest version will automatically be removed from the version list. see Browsing versions). then: r q Select the version row and click Edit > Delete on the task bar. It will give you an understanding of version structure in depth.Advanced version topics The following sections cover advanced version topics for administrators and developers. q Version resource structure in the server database Storage of versions on disk Topics for developers q q . since JReport Server provides multiple database support. update or insert data into the database.Derby. ij provides several non-SQL commands for ease in accessing a variety of JDBC features for testing.ij ij version 10. the security system. Example 2: Finding catalog version information from the database Execute the command SELECT * FROM CATALOGVERSION_2. . you can configure your own database to store server data.bat in <server_install_root>\derby\bin. Example 1: Finding result version information from the database Execute the command SELECT * FROM RESULTVERSION_2 WHERE CREATOR='admin'. Note: Don't delete.5 ij> connect 'jdbc:derby://localhost:1527/defaultRealm'. use Apache toolkit ij. and server runtime performance are all stored in the default database Derby. ij is a Java application that you start from a command window such as an MS-DOS Command Window or the Unix shell. it may result in JReport Server crashing if invalid data is found.tools. ij is Derby's interactive JDBC scripting tool. It is a simple utility for running scripts or interactive queries against a Derby database. For more information about Derby and ij. to fetch all catalog versions.Version resource structure in the server database Information about versions. ij allows the execution of Derby SQL statements interactively or via scripts. Otherwise.* files: 1. nodes. To open the defaultRealm. the completed table. please visit Apache website http://db.apache. Connect to database. 4. For production systems it is recommended to use the same DBMS as your database application so the server data will be backed up with the rest of the application. 2.org/ derby/. Also. folders. To connect to a Derby database. ij automatically loads the appropriate driver based on the syntax of the URL. To open the Derby database. ij> 3. It is recommended that all modifications to the database be done from JReport Server instead of in the ij. to retrieve result versions which were created by the user 'admin'. After connected to the database successfully. Start ij.apache. you need to perform a valid database connection URL. The following example shows how to connect defaultRealm by using the Connect command and the client driver: D:>java org. Note: All statements must be terminated with a semicolon. This section discusses how view resources were stored in the server database .derby. When all the 100 folders have been filled up with subfolders.Storage of versions on disk A working directory <reporthome>\history has been defined for use by the system database. After the above procedures have been performed. JReport Server will then create another 100 folders. When the amount of subfolders in folder 1 reaches the maximum subfolder amount.share. folder 5.dir=D:\ServerData.hist. 3. These subfolders however cannot hold any further subfolders.properties file is generated in the <install_root>\bin folder. 4. and will continue to store the history information in these folders. You can then set the folder that your server data is to be stored in. named 101 to 200.properties file for you to configure the server. another 100 folders will be created. Restart JReport Server. When the second 100 folders are full.share. and each of these folders can contain a further 3000 subfolders. The following describes the process of changing the storage folder: 1. First. the DBMS stores only pointers to the actual files. . in the resource. JReport Server uses this folder to store all of the parameter information and version files. profiling and history sub folders from the <install_root> folder. The demo resources in the <reporthome>\jreports directory will now be stored in the specified ServerData folder. Rather than store all the actual resources in the DBMS.dir property as resource. JReport Server creates 100 folders in its history folder (<reporthome>\history). By default. it starts to put files in folder 2.hist. such as archive versions and parameter files in folder 1. After installing and starting JReport Server. folder 3 will be used. and so on. the server. 2. then folder 4.hist. starting from folder 101.share. JReport Server puts the history information. and so on. When folder 2 is filled up. Changing the storage folder JReport Server provides a server. all parameter information and version files created will be stored in the specified ServerData folder. you can set the folder for the resource. Delete the properties.dir property in this file. until all 100 folders have been filled up. If you want to specify a folder other than <reporthome>\history to store the version files. TAG_ENABLE_ARCHIVE_POLICY Values true /false true /false APIConst. Whether or not to autoarchive the viewed result. .TAG_AUTO_ARCHIVE 1 2 The Public Reports folder is used as the result archiving location. Applying an archive policy You may find that whenever you create catalog/report template versions. / rtp100. an archive policy is applied. which means to output the file to / USERFOLDERPATH/ <userid>/rtp100. Parameters Values Description APIConst. The archive policy is a series of settings for controlling whether or not to use multiple versions for a specific resource.Topics for developers Other than implementation from the JReport Server UI. explore report resources. TAG_ARCHIVE_LOCATION 0 Description Whether or not to apply a new archive policy. The My Reports folder is used as the result archiving location. TAG_ARCHIVE_MY_DESTINATION Sub folder name in the My Reports folder for this user. how to run a report. APICONST. The JReport Server API and RMI API is a set of Java programming interfaces that run reports. JSPs and Java applications with report server features. Built-in version folder is used as the result archiving location. and for controlling whether or not to auto-delete versions after a certain period of time. or report result versions. and provide access control for report servers. Archive policy parameters Parameters APIConst. advanced users are also allowed to manage versions using the JReport Server API and RMI API. You can find documentation that describes the usage of the JReport Server API in the section JReport Server APIs and Remote APIs. Program examples to show how to publish a report to the versioning system. For example. It is mainly used for writing servlets. and how to publish a catalog/report can be found in the <install_root>\help\server\en\samples folder. for specifying the maximum version amount and archive location. which includes the parameters used for running tasks. Whether or not to auto delete this version. Scheduling report results to the versioning system You can use the Java class HttpRptServer with the following methods to schedule report results to the versioning system: runTask(). TAG_TO_VERSION Values true /false Description Whether or not to schedule to the versioning system. There is a Hashtable argument for these two methods. Here are some parameters that you will need when specifying your Hashtable for scheduling to version: Parameters APICONST. APIConst. Whether or not to archive the next version as a new version. TAG_REPLACE_OLD_VERSION true /false true /false Whether or not to replace the previous version.TAG_EXPIRE_MONTH APIConst. / ActimizeTest/rtp100 APIConst. Version expires after a number of days.TAG_EXPIRE_METHOD 0 1 Version expires after a certain date. TAG_ARCHIVE_NEW_VERSION APICONST.DAY_EXPIRE Number The number of days until a version expires. TAG_NEED_MAXVERSION 0 or N APICONST. APIConst. For example. TAG_TO_VERSION_EXCEL true /false Whether or not to schedule to an Excel version. APICONST. TAG_ARCHIVE_PUBLIC_DESTINATION Sub folder name in the Public Reports folder for all the users.APICONST. APIConst. The number of versions to keep for this resource result. Parameters Values Description .TAG_EXPIRE_DATE Number Number Number The year of expiration. and submitScheduledTask(). The month of expiration.TAG_NEED_EXPIRE true /false APIConst.TAG_EXPIRE_YEAR APIConst. The date of expiration. Whether or not to schedule to a PostScript version. String rptName. String catName) Result version getResultDocVersions(String userID. TAG_TO_VERSION_PDF APICONST. TAG_TO_VERSION_TXT APICONST. TAG_TO_VERSION_XML Obtaining version information You will be able to fetch version records with the following function calls: 1. String rptName) Report Result version getResultVersion(String userID. TAG_TO_VERSION_RTF APICONST. TAG_TO_VERSION_HTML true /false true /false true /false true /false true /false true /false true /false true /false Whether or not to schedule to an HTML version. Then use the following methods to obtain a version: r Report version getReportVersions(String userID. TAG_TO_VERSION_RST APICONST. int versionNumber) Catalog version getCatalogVersions(String userID. Whether or not to schedule to an rst version. APICONST. Get the resource manager from the HttpRptServer: public ResourceManager getResourceManager() 2. Whether or not to schedule to an rtf version. TAG_TO_VERSION_RSD APICONST. and not for filtering the submitter. . Whether or not to schedule to a PDF version. TAG_TO_VERSION_PS APICONST. Whether or not to schedule to a DHTML result version. String resultDocName) Dashboard version getReportVersions(String userID.APICONST. Whether or not to schedule to a TEXT version. Whether or not to schedule to an XML version. String dashboardName) Library component version getLCVersions(String userID. String lcName) r r r r r Note: userID is only used for checking privilege in this method. users.Managing security JReport Server provides a security system which allows you to set up and maintain security on the server and protect your resources from inappropriate access by users. This section focuses on accomplishing security management in JReport Server by means of setting up roles. You can find other information related to server security in the sections Security and Server security system. and assigning certain permissions. This section covers the following topics: q Managing realms Managing user accounts Managing groups Managing roles Managing privileges Managing aliases q q q q q . Remember to activate the correct realm before allowing clients to visit. When a new realm is created. Restart JReport Server so that the changes can take effect. Basic Authentication uses the base64 encryption method as defined by RFC 1945. click Configuration on the system toolbar. 3. click Security on the system toolbar and go to the Realm panel. groups and roles in an inactive realm Users. groups. Digest Authentication provides much higher security and is usually used with SSL in a highly secure environment. 3. Digest Authentication uses the MD5 encryption method as defined by RFC 2069. where you can manage the realms as required. The following topics detail how to manage a realm: Creating a new realm 1. groups and roles in . click OK. To activate a realm: 1. 2. and roles. Activating a realm The realm must be activated before its content. Basic Authentication is lower security but is usually what is used on intranets. and then click Service from the drop-down menu. and the default resource tree. In the New Realm dialog. type a name for the realm. and select an authentication mode as the scheme. and it can then be accessed by the client users. However. users. such as resources. it is assigned with built-in users.Managing realms To manage realms. Managing the users. and the realm will then be added to the realm list table. When done. 2. groups. 4. Select the realm you want to activate from the Active Realm drop-down list. There can be only one active realm at any time. Click Save to apply the settings. Click the Create a New Realm link. users. groups and roles are only available when the realm they belong to is active. On the JReport Administration page. on the JReport Administration page. you must be a member of the administrator role in order to access the JReport Administration page. Then. Group. Information about users. Group or Role to manage the selected realm. and Role panels. An active realm is marked as Active Realm. If the realm is both active and selected. A selected realm is marked as Selected Realm. All realms in JReport Server are listed in the realm list table. Click Security and then User. The State column shows the status of the realms. . 2. Click the Select link in the Control column of the realm list table to select the realm you want to manage. To manage users. groups and roles in the selected realm is listed in the User. groups and roles in an inactive realm: 1.an inactive realm can still be managed by users in the administrator role. you can delete it by clicking the corresponding Delete link in the Control column of the realm list table. Deleting a realm If you find a realm is no longer required. it is marked as Active Realm. The following topics describe how to manage a user account. When done. In the role table. 2. In the Security > User panel. Click Security > User to return to the user list.Managing user accounts To manage user accounts. 3. In the displayed page. Adding roles to a user A user can be assigned more than one role. Click OK. then click the Add button. select the realm in which the user is. select the realm in which the user is. In the Edit User dialog. click the name of the user. click Security on the system toolbar and go to the User panel. Creating a new user account 1. Then. click the Add Roles link. In the Security > User panel. 4. 5. In the Security > User panel. 3. A user that holds multiple roles has all the privileges that these roles have. where you can manage the user accounts as required. and the user will then be added to the user account table. 4. click OK to accept the changes. edit the user information as required. In the Security > Realm panel. 3. click the role(s) link of the user. In the Security > Realm panel. 2. . 2. check the roles that you want to add to the user. click the Create a New User link. select a realm to which you want to add the user. To add roles to a user: 1. provide the information for the user as required. on the JReport Administration page. In the New User dialog. In the Security > Realm panel. you must be a member of the administrator role in order to access the JReport Administration page. Modifying a user account 1. 4. In the Security > Realm panel. select the realm in which the user is. In the roles/groups table of the user. 2. click the group(s) link of the user. Removing roles/groups from a user If you want to remove certain roles a user holds. In the Security > User panel. In the Security > User panel. 4. Click Security > User to return to the user list. In the Security > Realm panel. 3. 3. When done. click OK to accept the changes. the user will no longer have the privileges the role or group has. follow the steps below: 1. and the resulting information will be written into the log files. 2. In the Auditing dialog. In the Security > User panel. In the Security > Realm panel. then click the Add button. 4. In the Change Password dialog. 4.Adding a user to groups A user can be assigned to more than one group. Once a role or group is removed from a user. specify the events which you want to have audited for this user. 5. When done. 4. In the Preferences dialog. 3. click OK to accept the changes. click the Preferences link of the user. 3. then click the Remove button. 5. specifies the server preferences and DHTML preferences for the user accordingly. Specify the new password for the user and confirm it by entering it a second time. To audit a user: 1. specify the password of the current logged in user. check the groups that you want to add the user to. Setting user preferences 1. click OK to accept the changes. In the group table. Auditing a specific user You can have the server to audit a user. 2. Deleting a user account . A user that belongs to multiple groups has all the privileges that these groups have. click the Auditing link of the user. To add a user to some groups: 1. click the role(s)/group(s) link of the user. click the Add Groups link. In the displayed page. or some groups a user belongs to from a user. click the Change Password link of the user. 2. Changing the password of a user 1. In the Security > User panel. select the realm in which the user is. select the realm in which the user is. check the roles/groups you want to remove. select the realm in which the user is. In the Security > Realm panel. 2. In the Security > Realm panel. 3. When done. In the Security > User panel. select the realm in which the user is. However. the built-in user accounts. or that belong to any group. such as admin and guest. you can delete it by clicking the corresponding Delete link in the Control column of the user account table. and users that hold roles other than the everyone role.If you find a user account is no longer required. . cannot be deleted. A user cannot delete himself from the user list either. In the Security > Group panel. browse to the specific group. Modifying a group 1. edit the group information as required. 5. select the realm in which the group is. such as adding a new member. In the Security > Realm panel. click the name of the group. click OK to accept the changes. or removing a member from the group. and the new group will then be added into the group list table. select a realm to which you want to add the group. on the JReport Administration page. Edit the members of the group as follows: r To remove a member from the group. 2. 2. 3. Then. click Security on the system toolbar and go to the Group panel. In the Security > Group panel. Creating a new group 1. In the Security > Group panel.Managing groups To manage groups. you must be a member of the administrator role in order to access the JReport Administration page. 2. Click Security > Group to return to the group list table. Editing members of a group You can edit members of a group. click the Add Members link. check the new member. click OK. and then click the member(s) link. In the Edit Group dialog. The following topics explain how to manage a group. When done. In the Security > Realm panel. r Notes: . In the New Group dialog. 3. 4. 4. where you can manage the groups as required. check the member and then click the Remove button. In the Security > Realm panel. click the Create a New Group link. When done. To add a member to the group. specify the settings for the new group. and then click the Add button. 3. To edit the members in a group: 1. select the realm in which the group is. cannot be deleted. having child members or parent members. However. you can delete it by clicking the corresponding Delete link in the Control column of the group list table. q Deleting a group If you find a group is no longer required.q A group can have more than one child member and parent member. . groups that are not empty. A parent member cannot be added to the current group as its child member. 4. To edit the members in a role: 1. Then. 2. click Security on the system toolbar and go to the Role panel. 4. 2. In the Security > Role panel. click the Add Members link. select the realm in which the role is. In the Security > Realm panel. click OK to accept the changes. When done. Editing members of a role You can edit the members of a role. 2. specify the settings for the role. you must be a member of the administrator role in order to access the JReport Administration page. edit the role information as required. such as adding a new user or role. and then click the member(s) link. In the New Role dialog. select the realm in which the role is. r Notes: q A role can have more than one child group. In the Edit Role dialog. In the Security > Realm panel. check the new member. click the Create a New Role link. In the Security > Role panel. child role and parent role. 3. The following topics describe how to manage a role. To add a member to the role. on the JReport Administration page. Modifying a role 1. 3. and then click the Add button. check the member and then click the Remove button. or removing a member from the role. select a realm to which you want to create the role.Managing roles To manage roles. 3. Click OK. browse to the specific role. Creating a new role 1. Edit the members of the role as follows: r To remove a member from the role. click the name of the role. In the Security > Realm panel. and the new role will then be added to the role list table. In the Security > Role panel. where you can manage the roles as required. . the built-in roles. Some members cannot be removed from the role they belong to. q Deleting a role If you find a role is no longer required. However.q A parent role cannot be added to the current role as its child. A user cannot remove himself from the administrators role. and roles that are not empty. you can delete it by clicking the corresponding Delete link in the Control column of the role list table. . such as admin in the administrator role and guest in the everyone role. cannot be deleted. such as administrators and everyone. click the Add button. 2. On the JReport Administration page. 1. 3. and Message Table Manipulation. and roles: Publish. Then click Save to apply the changes. You can then grant and remove role/group/user privileges in the panel. while the Message Table Manipulation privilege enables dashboard end users to map fields from different data sources in a dashboard. To assign privileges to a role/group/user. 4. 2. In the Privilege panel. For roles/groups/users that have had neither of the privileges 1. To manage privileges. Select the realm in which the role/group/user is. Users that are granted the Publish privilege will be able to publish resources to JReport Server.Managing privileges JReport Server offers these types of privileges for users. Then. 5. users that have the privilege of Advanced Properties are allowed to view advanced information of version properties such as catalog connections and report related resources. Check the checkbox below the type of privilege you want to grant. Granting role/group/user privileges in the Privilege panel q For roles/groups/users that already have privileges Roles/groups/users that already have privileges are listed in the Role Privileges/Group Privileges/User Privileges table. The Privilege dialog will then appear. Click the OK button to apply the changes. groups. you must be a member of the administrator role in order to access the JReport Administration page. click Security on the system toolbar and select Realm from the drop-down menu. To assign privileges to them. Then click Security on the system toolbar and select Privilege from the drop-down menu. select the Role Privileges/Group Privileges/User Privileges tab accordingly. Advanced Properties. you just need to check the checkbox below the type of privilege you want to grant. Choose the specific role/group/user from the list by selecting the checkbox before its name. The role/group/user that has been granted new privileges will be added into q . click the underlined role/group/user name. By doing this.the Role Privileges/Group Privileges/User Privileges table. 2. Removing privileges from a role/group/user in the Privilege panel To remove privileges from a role/group/user. To remove all privileges from a role/group/user. uncheck the checkbox below the privilege. In the Security > Role/Group/User panel. . 4. and then click the Remove button. the role/group/user will be deleted from the Role Privileges/Group Privileges/User Privileges table. q Granting and removing role/group/user privileges in the Role/Group/User panel 1. and then click Save to apply the changes. In the Edit Role/Edit Group/Edit User dialog. check or uncheck the target privileges. first select the role/group/user. In the Security > Realm panel. 3. Click the OK button to apply the changes. select the realm in which the role/group/user is. you can choose either of the following two methods: q To remove a privilege from a role/group/user. which enables her to only see the Sales resource node. in order to manage aliases. and then click the Next button to open the Set Alias dialog. 3. group. 6. . you can set an alias resource tree (based on the resource tree) for Mary in Sales. and allow different users to have different views. Aliases are used to provide certain "views" of the tree. Click Security on the system toolbar and select Realm from the drop-down menu. Select the realm in which the role. 5. 4. Click Security on the system toolbar and select Alias from the drop-down menu. group. you must be a member of the administrator role in order to access the JReport Administration page. Select a role/group/user. Set an alias resource tree for a role/group/user. 2. or user 1. click the corresponding set alias link. Setting an alias resource tree for a role. An alias is a combination of users and the resource node.Managing aliases JReport Server organizes its files and directories into a Resource Tree. or user is. For example. However. allowing her direct access to the report files she is interested in. Log onto the JReport Administration page. Select the node in which you want to create a new alias node. f. replace the default name newAlias with a name for the alias. Check/uncheck the Hide This Alias option. In the Alias Name field. c. 11. In the alias list of the Security > Alias panel. If you do not want the alias node to be shown in the alias resource tree. 10. group. Click the Browse button to search for the destination resource from the Server resource tree that is to be associated with the alias node. Use the following steps to create further alias nodes: a. Click the OK button to complete the creation of the new alias node. After you have finished with the alias resource tree. In the Security > Realm panel. e. If you do not want the alias node to be shown in the alias resource tree. . Click the OK button to complete the creation of the new alias node. In the Alias Name field. select the realm in which the role. group. replace the default name with a name. creating a new alias node. The Set Alias dialog will then be displayed for you to edit the alias resource tree of the role/group/user. b. r To create a new alias node: a. check Hide This Alias. In the alias list of the Security > Alias panel. or user is. click the Close button to exit the dialog. select the underlined name of the role/group/user you want to view. c. Editing the alias resource tree of a role. Click the Browse button to specify a destination resource from the server resource tree that is to be associated with the new alias node. d. replace the default name newAlias with a name for the alias. 2. group. b. Select the alias node in which you want to create a new alias node. You will now see that the just set role/group/user is listed in the corresponding alias list in the Alias panel. The Set Alias dialog will then be opened for you to view the alias resource tree information of the role/group/user. Select the alias node in the alias resource tree. 12. group. d. Click the Browse button to specify a destination resource from the server resource tree that is to be associated with the new alias node. or user 1. In the Security > Realm panel. Click New. 2. or user 1. r To hide/unhide an alias node: a. check the Hide This Alias option. 3. 8. or removing an existing alias node. or user is. Click New to create. 3.7. Click the New button to create a new alias node in the root node. 9. You can edit by hiding/unhiding an alias node. select the underlined name of the role/group/user you want to edit. and then click OK. Viewing the alias resource tree of a role. b. In the Alias Name field. select the realm in which the role. b. the alias resource tree root for each user refers to the resource tree root.e. q q . Click Remove to remove the alias node. r To remove an existing alias node: a. Click OK to create the alias node. When an alias tree is activated for a user. Notes: q An alias tree is based on the resource nodes (not virtual resource nodes) of the resource tree. By default. all resource access is then controlled by the alias resource tree. Select the alias node from the alias resource tree. You can view the status of these report-running tasks. JReport Server allows you to quickly view a report result (Run). This section describes the following: q Accessing the task information tables Managing tasks in the task tables Task-level timeout for advanced run and schedule tasks q q . These are the fundamental modes that JReport Server uses to perform its report-running tasks. such as publishing a folder. and schedule a report to run unattended at a specific time or periodically (Schedule).Managing tasks Usually. and the tasks that have already been performed. the tasks that are currently being performed. the tasks that the JReport Server manages are those associated with report-running issues. such as scheduled tasks that are waiting to be performed by JReport Server. a task is a set of operations you perform on JReport Server to achieve a goal. and viewing resource properties. However. the report-running tasks. view a report result using selected options and parameters (Advanced Run). deleting a resource. To access a specific table. such as Versioning System. whether the task is enabled. The following shows the columns that are displayed in each table in detail. such as task ID. The next scheduled time for when this task is to be performed. The report path. and the status of the task.Accessing the task information tables JReport Server collects task information and manages it in a set of tables. or Background Run mode. time when the task was started. running format. result files. such as task ID. Tip: Some columns in the tables are not shown by default. The internal ID for this task. then click the corresponding tab. the task has not been run before. such as task ID. The value true means that the last running was performed successfully and false means the task failed. Advanced Run or Background Run mode r r q r Background Tasks table Shows the status information of the tasks submitted using the Run. To have them displayed. time elapsed since the task was performed. time when the task was started/completed. and error messages. If the column is empty. Completed table Shows the status information of tasks that have already been performed. The names of the report tabs in the report that are included in this task. on the JReport Console page. The last scheduled time this task was performed. File System. Catalog . check the corresponding items in the Preferences dialog. Can be Enabled or Disabled. q Tasks that are scheduled r Scheduled table Shows the status information of scheduled tasks that are waiting to be performed. click Tools > Preferences on the task bar of the My Tasks page. time when the task was completed. whether or not the task was successfully performed. The type of task. Shows whether or not the last running of this task was successfully performed. The catalog path and name that the report belongs to. name and its status. and engine status. Tasks that are performed in the Run. such as report tab names. then click OK to save the settings. E-mail. or Printer. click My Tasks on the system toolbar. Shows whether this task is enabled. which is a unique time stamp. Scheduled table The Scheduled table consists of the following columns: Column Schedule Name Task ID Report Report Tabs Next Run Time Last Run Time Task Type Is Enabled Is Successful Description The name of the schedule task. switch to the table. Running table Shows the status information of tasks that are currently being performed. report path and name. previous running time. Advanced Run. catalog path and name. and next running time. grouping. such as Versioning System. File System. Error Message Result Files . The parameter file name. The type of the task. then in the Preferences dialog. Engine Status The current status of the JReport engine. The report path and name. The internal ID for this task (a unique time stamp). such as record fetching. The list of parameter values according to the size specified. The way in which this task is executed. You can click the underlined file name to view the parameter values. click Preferences on the task bar. or Printer. The report path and name. Running table The Running table consists of the following columns: Column Schedule Name Task ID Report Report Tabs Start Time Task Type Catalog Launch Type Requester Parameter File Parameters Description The name of the scheduled task. The report result file names and links to the report result files. The time when this task was completed. Completed table The Completed table consists of the following columns: Column Schedule Name Task ID Is Successful Report Report Tabs Completed Time Task Type Catalog Launch Type Requester Parameter File Parameters Description The name of the scheduled task. such as Repeatedly. E-mail. E-mail. then in the Preferences dialog. The user who submitted this task. The internal ID for this task (a unique time stamp). such as Repeatedly or One Time. Shows whether this task was successfully performed. Engine Status The status of JReport Engine when the task was completed. grouping. The names of the report tabs in the report that are included in this task. You can click the underlined file name to view the parameter values. The catalog path and name that the report belongs to. here you can see the status of the engine at the time of the error. or Instant. or Instant. The names of the report tabs in the report that are included in this task. File System. set a value for the Parameter Display Size option as required. The way in which this task is executed. The user who submitted this task. The parameter file name. memory paging. click Preferences on the task bar. The error message for when the task failed to complete the task. The time when this task was started. and engine initializing. such as record fetching. The list of parameter values according to the size specified. The type of task. The value true means that the task was performed successfully and false that the task failed. set a value for the Parameter Display Size option as required. One Time. such as Versioning System. such as Repeatedly. The user who submitted this task. One Time. To specify the size. When a task fails to perform. or Printer.Launch Type Requester The way in which this task is executed. memory paging. To specify the size. and engine initializing. The catalog path and name that the report belongs to. The version number of the report. The version number of the catalog that the report belongs to. The path and name of the catalog that the report belongs to. The time when this task was completed. The path and name of the report that the report tabs belong to. The result in the format in which the report ran. The time when this task was started. . Shows whether the task is cancelled or not. The parameters of the report.Background Tasks table The Background Tasks table consists of the following columns: Column Report Tabs Result Report Start Time Finish Time Status Catalog Elapse Time Catalog Version Number Report Version Number Parameters Cancelled Description The names of the report tabs in the report that are included in this task. The time elapsed since the start of this task. The status of the task. Managing tasks in the task tables You can manage tasks in the task tables according to your requirements. Select the row the task is in. Select the row the task is in. For example. Performing common tasks Some task management operations are common to the task tables. right-click in the row and select Copy from the shortcut menu. q q . Put the mouse pointer over the row the task is in and click the Delete button on the floating toolbar. specify how to create the task: by selecting a report or by importing a script file. then in the New Schedule dialog. q Select the row the task is in and click Edit > Delete on the task bar of the My Tasks page. If you want to Select a task Select multiple tasks Remove a task Then do Click in the row that the task is in. Put the mouse pointer over the row the task is in and click the Run button on the floating toolbar. q q Managing tasks in the Scheduled table If you want to Create a new scheduled task Then do Click New Schedule on the task bar of the My Tasks page. Put the mouse pointer over the row the task is in and click the Copy button on the floating toolbar. or stop a running task from running. q q Duplicate a task q Select the row the task is in and click Edit > Copy on the task bar of the My Tasks page. q Run a task at once Select the row the task is in and click Run on the task bar of the My Tasks page. right-click in the row and select Run from the shortcut menu. right-click in the row and select Delete from the shortcut menu. you can run a scheduled task at once. Select the row the task is in. Select the rows that the tasks are in while holding the Ctrl button. q Managing tasks in the Running table If you want to Stop a task from running Then do q Select the row the task is in and click Stop on the task bar of the My Tasks page.Enable a task q Select the row the task is in and click Edit > Enable on the task bar of the My Tasks page. Select the row the task is in. so some results may have been sent to some recipients. See Importing and exporting scheduled tasks for details. Notes: q You can perform the Run action on a disabled scheduled task. right-click in the row and select Stop from the shortcut menu. When copying a disabled scheduled task or exporting it to script. right-click in the row and select Enable from the shortcut menu. the disabled state will not be included since it is not a property of the task. Put the mouse pointer over the row that the task is in and click the Enable button on the floating toolbar. q q Note: When you stop a bursting task from running. Export a scheduled task to a script on disk Import a scheduled task from a script saved on disk See Importing and exporting scheduled tasks for details. View parameter information Refer to the Parameters column of the Running table. Managing tasks in the Completed table If you want to Then do . q q The disabled task will not be performed until you enable it again. q q Disable a task q Select the row the task is in and click Edit > Disable on the task bar of the My Tasks page. Put the mouse pointer over the row the task is in and click the Disable button on the floating toolbar. Select the row the task is in. Put the mouse pointer over the row the task is in and click the Stop button on the floating toolbar. right-click in the row and select Disable from the shortcut menu. Select the row the task is in. some sub tasks in the bursting task may have already been finished. Select the row the task is in and click Edit > Details on the task bar of the My Tasks page. right-click in the row and select Details from the shortcut menu. Select the row the task is in. Put the mouse pointer over the row the task is in and click the Stop button on the floating toolbar. Select the row the task is in. q q Restart a stopped task q Select the row the task is in and click Edit > Restart on the task bar of the My Tasks page. q q q View parameter information Refer to the Parameters column of the Completed table. right-click in the row and select Stop from the shortcut menu. Put the mouse pointer over the row the task is in and click the Details button on the floating toolbar.View detailed task running information q Click the schedule name of the task. right-click in the row and select Restart from the shortcut menu. q q View parameter information Refer to the Parameters column of the Background Tasks table. Managing tasks in the Background Tasks table If you want to Stop a task submitted using Background Run mode from running Then do q Select the row the task is in and click Edit > Stop on the task bar of the My Tasks page. Select the row the task is in. . Put the mouse pointer over the row the task is in and click the Restart button on the floating toolbar. click Configuration on the system toolbar. r If you have specified to have server cancel the task when the task duration is up. Since task duration check frequency affects server performance. check Cancel the task after the specified time. 4. Select the task row.duration. select Advanced. On the JReport Administration page.en able property to true. Put the mouse pointer over the task row and click the Delete button on the floating toolbar. r 2. In the Duration tab. With the mechanism.Task-level timeout for advanced run and schedule tasks A task-level timeout mechanism is introduced in order to avoid the never-finished running tasks consuming server resources and thus decreasing the server performance.che ck_cycle property in the server. Click Finish to submit the task. To do this: 1. it is recommended that you set the value according to your system environment. Then. and ask JReport Server to cancel the task or to notify you or someone else of the task status via e-mail if the task has not yet finished running when the task duration is up. shown with a sign of cancellation. c. you can choose to cancel the task manually. d. Use the Duration tab in the Advanced Run and Schedule dialogs to specify task duration. 3. If you want JReport Server to cancel the task when the task duration is up but the task is not finished yet. Set task duration check frequency. a. however a record for the task will be still remained in the Background Tasks table of the My Tasks page. JReport Server checks task duration every 30 seconds. s r Select the task row and click Edit > Delete on the task bar of the My Tasks page. the task will be cancelled automatically. If you want to notify someone of the task status if the task has not yet finished running when the task duration is up. To do this.duration. if you haven't checked the option Cancel the task after the specified time. when the specified task duration is up but the task has not finished running. Note that the value must be an integer greater than 0. and then check the Enable Task Duration option.properties file. the task will be switched to run in background mode when the task duration is up. Restart JReport Server if you have modified the Advanced panel. By default. specify the time limit for when the task can run before notifying of the timeout or canceling the task.properties file or by the Status Refresh Interval option in the Configuration > Advanced panel on the JReport Administration page. In the Timeout text box. b. you can specify a time duration for a task. check Notify by e-mail after the specified time and specify the mail address in the Mail To text box. r In the server. Do either of the following to enable the task-level timeout mechanism. in the Background Tasks table. The period value can be reset either by the task. right-click in the row and select Delete from the shortcut menu. in which case. s s . set the task. q For an Advanced Run task. It is recommended that the task duration is set to about five times of the required time for finishing running the task. Select the task row. if you haven't checked the option Cancel the task after the specified time. q . with the Is Successful status shown as No. s s Notes: q JReport Server may not cancel a task right after the specified task duration is up due to check frequency. if you want to cancel the task manually. Put the mouse pointer over the task row and click the Stop button on the floating toolbar. Then.q For a Schedule task. in the Running table. In the Duration tab. the task will still be listed in the Running table of the My Tasks page when the task duration is up. right-click in the task row and select Stop from the shortcut menu. the task will be cancelled automatically. and a task completed record will be added in the Completed table of the My Tasks page. r If you have specified to have server cancel the task when the task duration is up. s r Select the task row and click Stop on the task bar of the My Tasks page. properties. global NLS. etc. versions.Managing server data During its running process. realm. such as server. nodes. The server database includes system. JReport Server keeps track of server information and stores it to its own database for the purpose of running various managing and monitoring tasks. and profiling. The profiling database holds server runtime related information. JReport provides completed SQL files to create tables for all databases supported. and collecting server running statistics. the security system. monitoring the task running status. The realm database holds information of folders. such as managing the resources on the server. The system database holds resources of the global server scope. They reside in <install_root>\script_files. This section covers the following topics: q Initializing the database system as a non-admin database user Checking server data integrity Backing up/restoring server data Archiving and restoring server data Viewing the summary information of archive files Clearing unused nodes from the realm database q q q q q . and the completed table. You can refer to Configuring the server database for details about how to configure the databases. txt .Deletes old version tables for Derby database. the database initialization has to be divided into three phases: 1.Creates new tables for Informix database. and are stored in <install_root> \script_files\create_new_tables: q db2_c.Creates new tables for Microsoft SQL Server database.txt .Creates new tables for Derby database. 3. Microsoft SQL Server.txt . sybase_c.Creates new tables for Sybase database. and Informix.txt . In this phase. q q .txt . you will be able to see a record of it in the debug file.Deletes old version tables for HSQLDB database. and are stored in <install_root> \script_files\delete_old_tables: q db2_do.txt .Creates new tables for Oracle database. sqlserver_c.Creates new tables for HSQLDB database.Creates new tables for DB2 database. mysql_c. q q q q q q q Script files used for deleting the old version' tables The following files are used to delete the old version' tables.Initializing the database system as a non-admin database user The database initialization system allows you to use a non-admin database user for JReport Server. oracle_c.Deletes old version tables for DB2 database. 2.txt . Oracle.txt . Sybase. hsqldb_c. However. IBM DB2. hsqldb_do. HSQLDB.Creates new tables for MySQL database.txt .txt . The non-admin database user starts JReport Server. derby_do. If the server has updated the old version's table data. MySQL.txt . The database administrator creates new database tables using script files. There are three types of script files: Script files used for creating new database tables The following files are used to create new database tables. The database administrator deletes the old version' tables in the database using script files. The script files are stored in <install_root>\script_files. Script files JReport Server supports these different databases: Apache Derby. informix_c. derby_c. the old version's database tables will be updated if they exist. txt . oracle_dc.txt .txt . oracle_do. sybase_do.Deletes current version tables for Microsoft SQL Server database.Deletes old version tables for MySQL database.txt .txt .Deletes old version tables for Sybase database.Deletes current version tables for HSQLDB database. mysql_dc. sqlserver_do.txt .Deletes current version tables for Oracle database.Deletes current version tables for DB2 database.txt . sybase_dc. q q q q q q q . informix_dc. hsqldb_dc.Deletes old version tables for Informix database. and are stored in <install_root> \script_files\delete_current_tables: q db2_dc.Deletes current version tables for Derby database.Deletes current version tables for Informix database.txt . q q q q Script files used for deleting the current version' tables The following files are used to delete the current version' tables. mysql_do.Deletes old version tables for Oracle database.txt .q informix_do. sqlserver_dc. derby_dc.txt .txt .Deletes old version tables for Microsoft SQL Server database.txt .txt .Deletes current version tables for MySQL database.Deletes current version tables for Sybase database. Note: The integrity check checks only the realm database. The integrity check mainly examines two aspects of the realm database: q Integrality and consistency among tables . server data may not be saved correctly or completely in the databases. using parameter -cleanup.. C:\JReport\Server\bin>JRServer -cleanup q Open the batch file used to start JReport Server. Integrality and consistency between realm database and the external files .checking to see whether the records in the tables match the related external files. JReport Server allows you to check the integrity of server data. The same process also applies to files..realmtables=true to the line that starts JReport Server: "%JAVAHOME%\bin\java.checking records among the tables to see whether they are complete and consistent. it will be removed from the realm database since it is unused. .root= <install_root>" .Checking server data integrity In abnormal circumstances. To check server data integrity.realmtables=true "-Dinstall. q If any inconsistent or incomplete server data is found.exe" -Dcheck. do one of the following: q Launch JReport Server on the command line. add -Dcheck. Select a realm if it is the Realm DB or Profiling DB panel. switch to the <install_root>\bin folder.sh on Unix/Linux) and -Bsystemtables/-Brealmtables/Bprofiling or -B0realmtables parameter. It has two parameters: q -Bsystemtables/-Brealmtables/-Bprofiling: Backup the data with the server data in a JReport cluster. type the file path and name in the Backup System DB/Realm DB/Profiling DB field (or use the Browse button to specify the file path).bat/DBMaintian.sh in <install_root> \bin. All server data is compressed to a single Zip file.Backing up/restoring server data Backing up server data The server data backup process inspects all of the tables in the database. On the JReport Administration page. You can only restore server data using the DBMaintain tool with the -Rsystemtables/-Rrealmtables/-Rprofiling or -R0realmtables parameter. report version table. click Data on the system toolbar and then select System DB/ Realm DB/Profiling DB from the drop-down menu. the data also includes relational real files from the history directory. q To export the server data from the command line on Windows or on Unix/Linux: 1. such as the catalog version table. For example: C:\JReport\Server\bin>DBMaintain -Brealmtables:C:\TEMP\cmd_b_realmtables. It is DBMaintain. Click the Backup tab. collecting and then exporting all table data to a ZipEntry. .dat Restoring server data The server data restore process picks up all table data from the backup file and inserts it into the corresponding table in the database.dat Bprofiling:C:\TEMP\cmd_b_profiling. In a DOS window. Note that the file extension should be included. and report result version table. Exporting the server data through the server user interface 1. 2. and all table data and every relational real file is stored as a ZipEntry in this single file. You have two alternatives for exporting the server data: through the server user interface or through command line. Exporting the server data through the command line on Windows or on Unix/Linux A tool is provided to backup the server data. 3. Use the DBMaintain command (DBMaintain. -B0realmtables: Only backup the data in the database. For certain tables. and then click Backup. 2. dat Rprofiling:C:\TEMP\cmd_b_profiling. Also. and then restore the data on each cluster node. To make it shown. switch to the <install_root>\bin folder.enable property to true in the server. for example: C:\JReport\Server\bin>DBMaintain -Rrealmtables:C:\TEMP\cmd_b_realmtables. error may occur if the backup zip file is too large. the system DB and realm DB should better be backed up together. When running DBMaintain.bat/DBMaintian. to avoid redundant data backup. first make sure all the cluster nodes are shut down. you will then not be able to restore it on a Unix system. When backing up server data in cluster environment. You can try the -B0realmtables and -R0realmtables options to backup and restore data separately. For example.dat Backup/restoration limitations The backup/restore feature does not support cross-platform operation.profiling. you need to manually back up the external files on every cluster node after backing up the system DB and realm DB on any of the cluster nodes.properties file in the <install_root>\bin directory.To import server data using the command line: 1. q q q . 2. you need to set the server. In the DOS window.sh. When restoring server data in cluster environment. Use the DBMaintain command and -Rsystemtables/-Rrealmtables/-Rprofiling or -R0realmtables parameter. which is caused by JVM limitation. it is recommended that you back up the data on every cluster node to make sure no files get lost on any node after they are restored. The backup and restore operations must be done on the same operating system. if you backup the server data to a zip file on a Windows platform. Since the external data cannot be backed up once just on one single cluster node. Notes: q On the JReport Administration page. the Profiling DB option is not shown by default on the Data dropdown menu. enable property to true in the server. 3. Note: The Profiling DB option is not shown by default on the drop-down menu. To make it shown. Click Archive. To restore the archived server data: 1. JReport Server allows you to archive data to a single backup file. 4. Specify a date in the Move to Archive Data Before field. Restoring the archived server data You can restore server data that has been archived from a backup file. and then type or use the Browse button to specify the file path and name. set the server.profiling. You can then retrieve the data from the backup file at a later date. 4. click Data on the system toolbar and then select Realm DB/ Profiling DB from the drop-down menu. . Switch to the Archive tab. 3. Type or use the Browse button to provide the archive file name and location in the Restore from archive field.properties file in the <install_root>\bin directory. leave this field blank. If you don't want to backup the archived server data. On the JReport Administration page. You can only restore it using the server user interface. Server data prior to the date specified will be archived and saved to the backup file using the name specified. Archiving server data Along with the running of the server. Switch to the Archive tab. Select a realm from the Select Realm drop-down list. click Data on the system toolbar and then select Realm DB/ Profiling DB from the drop-down menu. Select a realm from the Select Realm drop-down list. 2. and then click Restore. The server data will then be removed from the database. To archive the server data: 1. On the JReport Administration page. 2. the sizes of the result version table (DB: realm) and TaskContext table (DB: profiling) grow larger. 5.Archiving and restoring server data You can archive and restore server data in the realm and profiling databases. Viewing the summary information of archive files After archiving or backing up files. 2. Database and Scope. set the server. . 4. and then click Summary.profiling. Type. Note: The Profiling DB option is not shown by default on the drop-down menu. you can view the results. Date.enable property to true in the server. To make it shown. The summary information includes Archive. On the JReport Administration page. Version. Type or use the Browse button to specify an archive file name and location in the Archive field.properties file in the <install_root>\bin directory. Realm. 3. Select a realm from the Select Realm drop-down list. To view the summary information of a specified file: 1. Switch to the Summary tab. click Data on the system toolbar and then select Realm DB/ Profiling DB from the drop-down menu. catalogs. Publish a resource to replace an existing real path resource. and reports. On the JReport Administration page. Otherwise. 5. How unused nodes are generated When resources. After running a report and saving the result to the versioning system or scheduling reports which are saved in the versioning system. you can check the corresponding checkbox to select the invalid nodes that you want to delete. have been published using a real path in order to allow dynamic updating there is a possibility to produce invalid nodes. 4. . either of the following conditions will generate invalid nodes: q Cancel or change the real path setting. Check the checkbox on the header of the first column to specify whether you want to select all or unselect all. Click the Check button. All invalid resource nodes will then be listed. The generated unused nodes can be cleared through the JReport Administration page. such as folders. 2. q How to clear invalid nodes To clear unused nodes: 1. click Data on the system toolbar and then select Realm DB from the drop-down menu. Click Delete button to delete all selected nodes.Clearing unused nodes from the realm database Making operations on real path resources may generate unused nodes from the realmdatabase. 3. Click the Realm DB Check tab. Many users can run reports from data created from a single query thus not having the reporting users impacting production DBMS users. data is fetched from the data source and cached to be another auto CRD. see Automatic Cache section in the Cache Configuration dialog. and parameters whose type is Bind with Single Column or Bind with Cascading Columns. Auto CRDs are disabled for generation by default. user defined data sources. thus the data will not change minute by minute based on current DBMS updates. stored procedures. You can enable them and configure the maximum hard disk space for auto CRDs and how long an auto CRD is stored. Use of auto CRD When there are auto CRDs generated in a query. which means that once the server closes or restarts.Managing cached report data Cached report data (CRD) is a cached subset of data fetched from the database according to certain conditions and is used for retrieving data for reports instead of the database. q Reports can be run from a specific point in time such as a month end report or quarter end report without going back to the DBMS to get the original data. q q q Cached report data can be created for query resources such as queries. hierarchical data sources. imported SQLs. Auto CRDs will only be available within one server running life cycle. the report running request based on the query will first search for the auto CRD that contains all the data required by the report. Users running a report will all see the same view of the data. if it finds one. This provides several benefits. data will be fetched from the data source. Auto CRD When running a report. . There are two types of cached report data in JReport Server: auto CRD and scheduled CRD. How many auto CRDs can be held in a query within one server running session is decided by the maximum hard disk space configured in the Cache Configuration dialog. the located CRD will retrieve data to the report. see the specific topics below. For details. Caching report data can be scheduled for any time frame to simulate real time on-demand reporting for many users while not slowing down the production DBMS. the report is created based on a report cube and the report cube is built from a query). if there is no scheduled CRD created for the query that the report is using directly or indirectly (for example. For details about each type. and at the same time the fetched data is cached and becomes an auto CRD. they will be removed and a new cycle of auto CRD generation will begin. but if JReport cannot find one. click Cached Data on the system toolbar and then select Cached Report Data from the drop-down menu. 6. its scheduled CRD can only represent the data of one parameter scenario. specify to notify someone via e-mail when the task is finished and whether it is successful or unsuccessful. In the Select Folder dialog. 10. the default values will be applied. more than one query resource can be selected at a time and a CRD can be created for each query and all of the scheduled CRDs will be applied the same creation and updating policy. select the query resources you want to create data caches for from the resource tree. In the Cached Report Data panel. specify the time for when the task is to be performed in the Time sub tab. On the JReport Administration page. Click beside the Select Queries box. click New Cache on the task bar. 12. Then click OK. only the latest are kept in the query. 2. administrators are able to define when a scheduled CRD for a query will be created and how it will be updated according to time. you can create more query resources or simply make some copies of the catalog and then create a CRD for each query. In the General tab. For detailed information. In the Conditions tab. A query resource can have zero or one scheduled CRD. browse to the folder containing the required catalog and click OK. When a query resource contains parameters. Scheduling a CRD task Administrators can schedule to have a data cache created for a query resource and updated at a specific time or periodically. When scheduling a CRD task. click next to the Select a Folder text field. In this way you can have more parameter scenarios. In the Select Queries dialog. Click OK in the New Cache dialog for selecting queries and you are then redirected to the New Cache dialog for scheduling. In the New Cache dialog for selecting queries. From the Select a Catalog drop-down list. 13. specify the time duration for the task. The query resource names will be used as the new CRD names. 7. Via JReport scheduling mechanism. and ask JReport Server to cancel the task or to notify you or someone else of the task status via e-mail if the task has not yet finished running when the task duration is up. and select or create a trigger to bind with the task in the Trigger sub tab. 1. Scheduled CRDs have no version. see Task-level timeout for . 4. In the Duration tab.Scheduled CRD Scheduled CRDs can be created and managed by server administrators. 5. In the Notification tab. select the required catalog in the specified folder. The setting in the Conditions tab decides when the CRDs will be created and when they will be updated. 8. Specify the other settings in the tab if needed. If no values are provided. you can specify values to the parameters of the query resources listed in the Select Query drop-down list. once they are updated. therefore if you want more than one CRD for the query resource. 3. 11. 9. If parameters or schedule policy is changed. and JReport Server will then perform the task at the requested times. See also New Cache dialog for scheduling for details about options in the dialog. the reports running later will get data from the updated CRD. which consists of the following columns: Column Name Path Catalog Name Data Source Data Type Last Modified Description The name of the scheduled CRD.advanced run and schedule tasks. Updating CRD is updating itself at a scheduled point. Use of scheduled CRDs A scheduled CRD has four statuses. a parameter may depend on another parameter. To do this. all reports using the CRD will still get the old data. select the row where the CRD you want to edit is located. the query parameters will be disabled for specifying or changing. 14. All reports based on the same query will fetch data from the CRD. but still not ready. In JReport. q Not ready CRD is not initiated yet. Whether reports running based on the same query as the CRD can fetch data from the CRD is determined by the CRD's status. Ready CRD is prepared and ready to use. The last time when the scheduled CRD was modified. before that. The reports will try to get data from the data source directly. In addition. or right-click in the row and select Properties from the shortcut menu. if the latter is frozen. . The data source that the scheduled CRD belongs to. Once the update is finished. All reports based on the same query will use the ready CRD before the update happens. the former will be frozen too. The path of the scheduled CRD in the server resource tree. Click Finish. Editing scheduled CRDs The generated scheduled CRDs are displayed in the Cached Report Data table. Since a scheduled CRD freezes parameters in the query. The type of the query resource that the scheduled CRD is based on. The reports will wait for the CRD to be ready and then fetch data from the ready CRD. Initiating CRD is preparing its data for the first time. if a report uses a scheduled CRD and its query contains parameters. you can remove it. they will only take effect after next CRD updating. The catalog that the scheduled CRD belongs to. all reports based on the same query as the CRD will automatically use the CRD for retrieving data. q q q After a scheduled CRD is created. only parameters used in the report are prompted for specifying values. if you find any of the scheduled CRD is no longer required. You can further edit the scheduling information of the CRDs if required. then click Edit > Properties on the task bar. To do this. The data source that the scheduled CRD belongs to. The parameters of the query. The value true means that the last running was performed successfully and false means the task failed. The path of the scheduled CRD in the server resource tree. The next scheduled time this task is to be performed. Shows whether or not the last running of this task was successfully performed. click Cached Data on the system toolbar and then select Running from the drop-down menu): Column Name Path Catalog Name Data Source Data Type Start Time Parameters Description The name of the scheduled CRD. The parameters of the query. CRD tasks that are currently being performed are listed in the Running table. To do this. click Cached Data on the system toolbar and then select Scheduled from the drop-down menu): Column Name Path Catalog Name Data Source Data Type Last Modified Next Run Time Last Run Time Is Successful Description The name of the scheduled CRD. The path of the scheduled CRD in the server resource tree. click Cached Data on the system toolbar and then select Completed from the drop-down menu). The latest time when the task was modified. select the row where the record is located and then click Delete. The last scheduled time this task was performed. The type of the query resource that the scheduled CRD is based on. which consists of the following columns (to access the table. or rightclick in the row and select Delete from the shortcut menu. The type of the query resource that the scheduled CRD is based on. The time when this task was completed. The catalog that the scheduled CRD belongs to. The value true means that the task was performed successfully and false that the task failed. The data source that the scheduled CRD belongs to. Viewing and managing scheduled CRD tasks CRD tasks that are waiting to be performed are listed in the Scheduled table. CRD tasks that have already been performed are listed in the Completed table. The type of the query resource that the scheduled CRD is based on. If the column is empty. then clicking Edit > Delete on the task bar. The data source that the scheduled CRD belongs to. which consists of the following columns (to access the table. . The catalog that the scheduled CRD belongs to. You can remove the record of a completed CRD task from the table if required. The time when this task was started. The path of the scheduled CRD in the server resource tree. the task has not been run before. or right-click in the row and select Delete from the shortcut menu. Column Name Path Catalog Name Data Source Data Type Is Successful Completed Time Parameters Description The name of the scheduled CRD. which consists of the following columns (to access the table. Shows whether this task was successfully performed.select the row where the CRD is. The catalog that the scheduled CRD belongs to. Scheduled CRD synchronization with catalog republish After a catalog is republished. however. When it is the next schedule time. the scheduled CRD based on the old query will behave as follows: r q Before the next schedule time. the CRD will be disabled for retrieving data to reports. s s CRD memory usage configuration Administrators can configure the maximum CRD memory in the Cache Configuration dialog. The data before the crash will be maintained. Scheduled CRD tasks share the total number of users defined in the license and share task priority with report tasks. q Recovering of scheduled CRDs Scheduled CRDs will be recovered after the server crashes and then restarts. If old parameters are deleted from the new query. the CRD will continue with the update. . The value should be at least 4 MB and not more than 80% of the JVM current maximum heap size. and then click OK to apply the settings. the parameter values previously specified in the CRD will be removed. The number of MBs must be configured in whole numbers. All CRDs share the same cache area.Notes: q Some columns are not shown by default. which is applicable for both types of CRDs. If parameters are changed and the previously specified values do not match the type. Any size CRD can be accessed with even the smallest cache size. The cache is used to improve performance when multiple users are running reports using the same CRD. error messages will be given in the server error log and the CRD is disabled for service. data is fetched from the new query to generate an updated scheduled CRD: s r If new parameters are added in the new query. after server restarts. check the corresponding items in the Preferences dialog. the larger the cache size the faster performance will be when multiple users run reports using the cache but a large cache size may lower performance for users who do not use the CRD. If a CRD is updating when the crash happens. the existing CRDs will be automatically applicable to the new catalog. If a query resource is modified. focus on the required table. To have them displayed. default values will be used until an administrator specifies values to them. how the existing scheduled CRDs based on the old query resources in the catalog will be updated depends on the following conditions: q If no query resource is modified. click Preferences above the table. reports. This chapter is split into two topics: q NLS at application level NLS at report level q Related topics: q Appendix 6: Language and Region name list for National Language Support . with which you can run JReport Server.National Language Support JReport products implement a National Language Support (NLS) feature. or dashboards in different language environments. JReport Viewer. JDashboard. JReport Studio. and JDashboard: q common. when creating a WAR/EAR file to include a JReport Server. Each language package contains all the UI text and messages available in JReport Server. JReport accepts user-customized language packages and can recognize and load them if they are correctly specified. and JDashboard. follow the steps below: 1. and JDashboard in the specific language. When a language package is applied. JReport Viewer.jar which packs all language resources in the <server_install_root>\resources directory will be generated and included for the multiple language support. Browse to the <server_install_root>\resources\server\languages directory. you can select the one you are familiar with for your own convenience as the JReport Server environment language. a folder "resources" is added in the installation root directory for holding language packages. if you are a German you may be glad to apply the German language package. Manually adding a language package Currently JReport provides only the English language packages: en and en-us. However. . For example. the languages. q q The structure of a language package which is stored in the <server_install_root>\resources\server \languages directory follows: \LanguageName \properties common. dhtml.properties This property file stores some common UI text all over JReport Server in the specific language. JReport Studio.properties This property file stores UI text and messages referred by JReport Viewer. server.properties server. JReport Studio. Create a folder named fr. there are three property files which together contain all UI text and messages in JReport Server. and specifies the UI text in a specific language. the UI will be displayed in the language specified in the language package.properties dhtml. In each language package. JReport Studio.NLS at application level In JReport Server.jar makes sure the server UI text is displayed correctly after deploying the WAR/EAR to other application servers. The languages.properties To add a language package. including JReport Viewer. 2. The folder name should keep to the naming criterion. though it may be a big task.properties This property file stores UI text and messages referred by JReport Server in the specific language. Moreover. When there are more than one language packages. chemie. Where there are two variants.ics. The language argument is a valid ISO Language Code.properties >newdhtml. mac for Macintosh.properties.properties.0_17\bin>native2ascii -encoding utf-8 server. Restart JReport Server. and put the more important one first. properties.properties. it takes effect in the whole JReport Server. Modify the three property files: common. You can find a full list of these codes at a number of sites.properties. You can find a full list of these codes at a number of sites. properties C:\jdk1. Specifying the application language Once the application language is set. Save these property files with UTF-8 encoding.properties to server. 4.6. use win for Windows. you may want to modify them more at a later time. 5. 6. These codes are the lower-case two-letter codes as defined by ISO-639. and newserver.fu-berlin.0_17\bin>native2ascii -encoding utf-8 dhtml.properties in the \fr folder.html. 9. These codes are the lower-case two-letter codes as defined by ISO-3166.uci. separate them with an underscore. Naming criterion for language package folders * FolderName(language) * FolderName(language-country) * FolderName(language-country-variant) The folder name should be lower-case codes. 8. There are two ways of setting the application language: . Rename the original property files.0_17\bin>native2ascii -encoding utf-8 common.de/diverse/doc/ISO_3166.exe in the <jdk_install_root>\bin directory by running the following line in the Command Console: C:\jdk1.edu/pub/ietf/http/related/iso639.txt. properties C:\jdk1. and posix for POSIX. including JReport Viewer and JReport Studio. newdhtml. and server.6. Translate all the text and messages after "=" in these files to French. The variant argument is a vendor or browser-specific code.properties >newserver. dhtml.properties to common. Convert the contents in the three property files into Unicode using native2ascii.6. Change the names of the generated property files back to the same names as the original property files: newcommon. properties Note: When you convert your property files to the same directory as the original ones you need give them new names instead of replacing the original in order to avoid problems.properties to dhtml. for example: http:// www. For example. The country argument is a valid ISO Country Code. for example: http:// www.3. Copy the properties folder in the existing <server_install_root>\resources\server\languages \en directory to the \fr folder.properties >newcommon. 7. then click Customize Server Preferences on the task bar of the Profile page. result_type=8&jrs.1:8888/jinfonet/index. however. The format of the URL is as follows: http://IP_Address:port/context/pagename?parameter=value&jrs. The following are two examples: r URL for accessing the JReport Console page: http://127.catalog=/SampleReports/SampleReports. on the JReport Console page. click Profile on the system toolbar.1:8888/dhtmljsp/dhtml.cmd=jrs. select Customize Server Preferences from the drop-down menu. . select the Advanced tab and set an application language for themselves.0. Specifying by URL parameter r q End users can control the application language by the parameter jrs.cls&jrs.q Specifying by UI option There is an option Specify Default Language for you to switch the application language.language=zh-cn r URL for opening a report in the DHTML format in JReport Viewer UI: http://127. To specify the application language: r For administrators.path=/SampleReports/EmployeeInformation.language=zh-cn Note: The specified application language by URL parameter has higher priority than that specified by UI option.cls&jrs.language=Language_Name The value of jrs.0. it takes effect only in the current user session.language should be the same as the language package folder name in the <server_install_root>\resources\server\languages directory and be lower-case letters.cat_version=1&jrs. on the JReport Administration page. The available language list depends on the language packages in <server_install_root>\resources\server \languages.try_vw&jrs.0. cat&jrs.report=/ SampleReports/EmployeeInformation. For end users.jsp?jrs. click Profile on the system toolbar.language when accessing the JReport Console page or JReport Viewer UI via URLs.0.jsp?jrs. then click the Advanced tab and set the default application language for all users. and what's more. you can create global NLS resources that can be shared by all reports to reduce the translation cost. with which you can edit NLS for any report the same as the report designer does in JReport Designer. different clients can select different languages for the rendering of the report. see National Language Support in the JReport Designer User's Guide). JReport provides you with the NLS Editor on JReport Server.NLS at report level If the NLS feature is enabled for a report when it is designed in JReport Designer. when the report is run in the client/server scenario. Also. The following topics show how to use the NLS feature in JReport Server: q Creating global NLS for reports Editing local NLS for reports Running NLS reports Localizing page navigation links in HTML report outputs q q q . it will also be available after the report has been published to JReport Server (for detailed information about how to use the NLS feature in JReport Designer. Then. With global NLS. 4. Refer to Appendix 5: Language and region name list for National Language Support for language and region A2 codes. r If Languages Supported by JReport is checked in the dialog.Creating global NLS for reports The global NLS is similar to the local NLS feature. r 5. Then. you can share the NLS information between all reports and reduce your translation cost. Click Reports on the system toolbar and select Global NLS from the drop-down menu. select the file and then click Open. Click the Add button above the Language box. Start JReport Server and log onto the JReport Administration page. while global NLS is the NLS resource that can be used for all reports in any catalog in both JReport Server and JReport Designer. NLS resource files should follow the naming rule: NLS_[language]_[region A2]_[User Defined].properties. r Languages Supported by JReport Adds languages from the languages that JReport supports. To create global NLS on JReport Server: 1. the Add Language dialog will be displayed. NLS Resource File Adds languages from an external NLS resource file which has been defined with some language information. Select the required languages and click OK to add them. Specify where to add the required languages. Note that this feature is provided to administrators only. r . Local NLS is the NLS resource used for a particular report. The Select Language Source dialog is then displayed. 2. Click OK in the Select Language Source dialog. the File Upload dialog will be displayed. If NLS Resource File is checked in the dialog. 3. Browse to the local folder where the NLS resource file is located. then in the Font Size column. Click add more rows and specify the key and translation according to your requirements. 6. click OK to accept the settings. specify the key in the Key column. click the Add button face and font size of the key. When done. 9. click the Add button to add a new row of display. in the Font Face column. See also the Global NLS dialog for detailed explanation about options in the dialog. In the Display tab. . then give the corresponding target language text in the Translation column. to add a new row of font.The specified languages are now displayed in the Language box in the Global NLS dialog. 10. choose from the drop-down lists the font 8. Select the type of the display from the Type drop-down to list. In the Font tab. 7. Repeat the above steps to define global NLS for the other languages as required. Select a language from the Language box to edit global NLS for it. choose from the drop-down list the font face for the target language. choose from the drop-down list the font size for the target language or check to use relative font size. In the Key column. Click to add more rows and specify the font information according to your requirements. Note that this feature is provided to administrators only. The NLS Editor 4.Editing local NLS for reports JReport allows you to edit NLS for each report on the Administration page of JReport Server as the report designer would with the NLS Editor in JReport Designer. in the Control column. Select the row that the report is in. 3. you can translate a report into different languages from the original one. Start JReport Server and log onto the JReport Administration page. browse to the report you want to edit. 2. Specify a report and catalog version as required. then click the NLS Editor button dialog appears. In the resource tree. With the NLS Editor. To edit NLS for a report on JReport Server: 1. . on the JReport Administration page. provide the corresponding format in the Format column for the target language. 11. then click OK to confirm and go back to the NLS Editor dialog. 6. Click the Add button above the Language box. q . click Add to Global NLS to add the font information you specify for the report to the global NLS library of the target language. 12. Select a target language from the box to edit NLS for it. you can add -Djreport. click . This changes the encoding to Unicode which supports all languages. enter all the corresponding target language text in the Translate column. access the version table of the report.encoding=UTF-8 to the batch file that starts the server and then restart it. In the Add Language dialog. 7. Click OK to accept the settings. In the Display tab. When you switch among different languages by choosing languages from the Language box. If required. 9. click Add to Global NLS to add the display information you specify for the report to the global NLS library of the target language. See also the NLS Editor dialog for detailed explanation about options in the dialog. To resolve this problem. click .5. If required. add the fonts you want to customize and click OK. where all the fonts used in objects of the report are listed. The selected languages are now listed in Language box of the NLS Editor dialog. If you have defined global NLS for the target language. where all the formats used in objects of the report are listed. give the font face and font size you want for the target language in the Font Face and Font Size columns. where all the display text in the report are listed. Click the Font tab. 10. Switch to the Format tab. 8. click . Select another language and edit NLS for it as shown above. add the display text you want to translate and click OK. Then. then in the Add Display dialog. Then.url. select the languages in which you want the report to display. you can also click Fetch from Global NLS to fetch the corresponding font information. add the formats you want to customize and click OK. then in the Add Font dialog. you can also click Fetch from Global NLS to fetch the corresponding display information. you may find that the text in the Translate column become unreadable. To do this. Then. If you have defined global NLS for the target language. then in the Add Format dialog. then click the NLS Editor link for the report version. Notes: q You can also edit NLS for a specific report version. 3. then click its Properties button column. you can then run the report in the specified languages. On the JReport Console > Reports page. follow the steps below: 1. To enable NLS for a report: 1. Click Profile on the system toolbar. Running NLS reports in Advanced mode To run a NLS report in a specified language in Advanced mode. Click Reports on the system toolbar to switch to the Reports page. Browse to the report you want to preview and click its name. 2. browse to the report you want to run. check Specify Default Language and choose the language from the Language drop-down list. then click OK to confirm. check the National Language Support option. before doing this. 5. Finish the other related options and click Finish to run the report. click Reports on the system toolbar and select Reports from the drop-down menu. In the Properties dialog. Select the Advanced tab. Click OK to save the changes. The report result will then be displayed in the language you have specified. On the JReport Administration page. 2. put the mouse pointer over the report row and click the Advanced Run button on the floating toolbar. follow the steps below: 1. Previewing NLS reports To preview a NLS report in a specified language. browse to the report. or have an NLS report published to the server from JReport Designer. you need to first make sure that the NLS feature is already enabled for the report by the administrator.Running NLS reports When you have NLS edited for a report on the JReport Administration page. then select the corresponding encoding from the Encoding drop-down list. select the Enable NLS checkbox. 4. choose the language from the Using Language drop-down list. However. 3. 2. In the Reports panel. In the Format tab. in the Control 3. Scheduling NLS reports . The report result will then be run in the selected language. then click Customize Server Preferences on the task bar of the Profile page. On JReport Console page. . select the corresponding encoding from the Encoding drop-down list. select the Enable NLS checkbox. 2. On the JReport Console > Reports page. In the General tab. 3. Finish the other related options and click Finish to perform the task. then choose the language from the Using Language drop-down list. The report result will then be run in the selected language. browse to the report you want to run. follow the steps below: 1. put the mouse pointer over the report row and click the Schedule button on the floating toolbar.To schedule a NLS report. 6. To do this: 1. 5. 3. 2. Next. Translate the text after = to the language specified by the folder name.properties file in the properties directory. Create the sub directories in <server_install_root>\resources as follows: <server_install_root> \resources\report\languages\[language-locale]\properties. Open the property file and copy the following contents to it: # The following is the report properties file format that can localize the link names in HTML. 3. 7. 4. according to your requirements. see Appendix 6: Language and region name list for National Language Support. Note: You can just add the <jdk_install_root>\bin directory to your PATH instead of copying the file. a property file must be created first for the desired language. you just need to translate "of" to the desired language. The localizing process is divided into three steps: 1. of @TotalPageNumber. The following explain the steps in detail: Creating the property file To localize the page navigation link names in HTML report outputs. Save the property file with UTF-8 encoding. Enable the language for the report. For example. such as First. Copy the property file to the <jdk_install_root>\bin directory. and @TotalPageNumber by the report total page number.exe in <jdk_install_root>\bin by running the following command: C:\jdk1.properties Note: When you convert your property file to the same directory as the original one. In the HTML outputs. or run it in Advanced mode in HTML format.Localizing page navigation links in HTML report outputs When you schedule to publish a report to HTML format. of @TotalPageNumber.". you need to give it a new name instead of replacing the original in order to avoid problems.0_17\bin>native2ascii -encoding utf-8 report. and Last. Previous. Create a report. . 4000101=First 4000102=Prev 4000103=Next 4000104=Last 4000105=Back 4000106=Refresh 4000107=@CurrentPageNumber. Apply the localized link names to HTML report outputs. For detailed information about the abbreviation for each language and locale. @CurrentPageNumber will be replaced by the current page number.properties > newreport.6. you can localize the names of page navigation links in the HTML report outputs. Create a property file for the desired language. C:\JReport\Server\resources \report\languages\zh-cn\properties. Note: For the line "4000107=@CurrentPageNumber. 2. Convert the contents in the property file into Unicode using native2ascii. properties in <server_install_root>\resources\report\languages\[language-locale] \properties and copy newreport. Click the button and click OK. then in the Add Language dialog. Enabling the language for the report When the property file is ready. Applying the localized link names to HTML report outputs To apply the localized link names to HTML outputs of the specified report. check the National Language Support option. Put the mouse pointer over the report row and click the Advanced Run button the floating toolbar. Specify the other settings and finish the task. then rename the property file back to report. choose the specified language in the Control column. In the Format/General tab of the Advanced Run/Schedule dialog. 6. then click OK to confirm. 5. 7. In the NLS Editor dialog. the next step is to enable the language defined in the file for the required report. . you can see that the page navigation links are displayed in the language you defined for the property file. Click OK in the NLS Editor dialog to confirm the settings. follow the steps below: 1.properties in <jdk_install_root>\bin to it. Start JReport Server and log onto the JReport Administration page. Log onto the JReport Console page and browse to the report. Then in the generated HTML outputs. 4. Browse to the row that the report is in. 1. In the Properties dialog.properties. specify a report and catalog version as required. 2. Delete report. above the Language box. Browse to the row that the report is in again and click the Properties button in the Control column. or Schedule button on 3. then click the NLS Editor button 3. check Enable NLS and select the specified language from the Using Language drop-down list. 4. Now the language will have been enabled for the report.8. 2. See Configuring the server database on the JReport Administration page. In this case. Limiting the number of actively running reports can avoid momentary system overload.sh/bat) and set the maximum heap (Use -Xmx) to the maximum that you want the heap to q q q q q q q q q .max. Set task-level timeout for advanced run and scheduled tasks. When using an application server. templates and images are used frequently but may harm performance when many different catalogs.properties in the <install_root> \bin directory can smooth out performance and provide higher overall throughput. Convert reports from earlier versions into current version. but you are able to carry out performance tuning to make JReport Server efficient. Cache catalogs. On 32-bit systems the maximum size is 2GB. This is effective when the same catalogs. templates and images are used and the requested resource is not in the cache. max. Again this needs some testing on your system to determine the best overall throughput. For best performance and reliability you should change the JReport Server DBMS from Derby (the internal Java DBMS) to your standard production DBMS or other DBMS you are familiar with. the hardware and software environment that it runs in.properties. In production servers trace level should be OFF and error level should be ERROR unless you are searching for specific issues such as monitoring the SQL statements sent to the DBMS. Preloads catalogs and reports by configuring the Configuration > Performance panel on the JReport Administration page. You may or may not have any influence in this regard. Setting the property performance. This will ensure that users do not run extremely long jobs accidentally. and JReport web images by configuring the Configuration > Cache panel on the JReport Administration page.Tuning Performance Many variables affect the performance of JReport Server. See Configuring connection pool. Derby is included for out of the box ease of use but is not recommended for production use. Modify the JVM heap size. For example. This will improve the performance the first time the report or catalog is used. reports. on 64-bit systems the maximum size is extremely large.reports=10 but may provide better overall throughput since it is has finer granularity to control CPU utilization. You can assume a report consumes around 5 threads on average so setting the number of active threads to 50 is similar to setting performance. Set a starting heap size just under your normal average usage (Use -Xms in JRServer. and fast.reports by limiting the total number of active threads for JReport. The following lists the factors that help with the server performance: q Use Connection Pooling either by using JNDI and the connection pool of the application server or JReport connection pooling using ConnectionPoolConfig.max. Set log trace level and error level to record less information. The best number depends entirely on your environment so needs to be configured after testing which setting provides the highest throughput in your environment.reports to a limited number in server. however. The heap usage can be monitored by tools such as the JDK jconsole application. reliable. it slows performance checking the cache and wastes memory. you can achieve a similar result to performance. Word Wrap requires that we preformat the data in memory to determine its size then wrap the field as necessary then continue to format it.cls and .properties in the <install_root>\bin directory to turn on using priorities so on demand reports will be higher than scheduled reports. Set engine. However. True Type Fonts (TTF) provide better throughput by reducing font substitution and scaling time. calculate complete report totals and create the TOC. using too much memory for Java heap can impact performance of other applications. Use binary versions of . Setting this larger than needed wastes resources.policy=1. you can dynamically adjust priorities so reports increase their priority the longer they wait in the queue. Select the two options View Incomplete Pages and Format Page on Demand on the JReport Administration/Console page > Profile > Configure DHTML Profile > Properties > Advanced tab for faster viewing of the first page of large reports in DHTML format.cat. not the xml versions when you publish reports to JReport Server. Depending on your environment and JDK. 2 or 3 in server. By using the different policies. especially objects like labels. This needs to be tested in your environment to determine which setting provides the highest throughput.max. Set the maximum number of user handlers to the optimal size by setting the httpserver.exe_gc=false as the default in the server.properties. If fields never are large enough to wrap.properties file.grow. q q q q q q q q q . Minimize the usage of Word Wrap to columns which really require it.single_thread=true or false in server. handlers property in the server. the user has to manually select the last page of the report. JReport can use additional heap to improve performance of queries and sorting and reducing the number of garbage collections (GC) which use CPU time. This saves processing time and I/O time when converting the files to Java classes. by setting the Engine Priority property to a higher or lower priority on the JReport Administration page > Configuration > Advanced panel. Configure dhtml. The disadvantage is that to see the actual number of pages. This is the number of threads which are waiting to handle user requests. it is a lot of overhead. A third high priority queue can also be enabled for on demand reports which need to run immediately. This allows the JDK to schedule garbage collections as needed rather than at specific times. Changing all the fonts to use TTF fonts improves the quality of the output as well as the performance when a mixture of operating system is used such as report design on Windows and production on Unix. Be sure performance. Adjust the engine's utilization of the CPU in accordance with your own requirements. setting it too small will mean that some users will not be able to access reporting until someone else exits. however. some systems run faster with a single threaded engine than with a multi-threaded engine.properties file. q Set queue.properties to queue DHTML actions to ensure JReport Viewer features do not take too many system resources and impact other functions. You can also use JReport Server Monitor to maintain JReport Server. 2. JReport Server Monitor is able to generate and display the performance chart of JReport Server according to its statistics. stopping waiting/running tasks. logging out a valid user session and so on.bat in <monitor_install_root>\bin. To access JReport Server Monitor: 1. you can inspect server performance in a certain period of time. allows you to inspect the status of JReport Server. By creating profiling reports using JReport Server Monitor. the status of on-line users and so on. including the status of the servers in the cluster. Thus you can view the performance of JReport Server in the form of Line Chart Graph and Text. The following topics detail how to use the Server Monitor: q Monitoring the server status Monitoring the server performance q . the status of different reports. which is a standalone web-based application used to monitor the overall performance of JReport Server. Launch MonitorServer. such as shutting down servers.Monitoring JReport Server Monitor. Click Monitor on the system toolbar of the JReport Administration page. JReport Server Monitor is not able to monitor the information of a report that is running in DHTML format. finished reports. for example.Monitoring the server status JReport Server Monitor allows you to inspect the status of JReport Server. and failed reports. The following topics explain what JReport Server Monitor can do: q Showing the status of servers in a cluster Monitoring the status of reports Monitoring the status of online users Monitoring the status of the database connection pool q q q . you can even view the status of these reports. waiting reports. running reports. You can also list the reports by drilling down into the servers. Tracking further down. However. You can list the servers and their status from a cluster. The server has been started and is ready for service. q . port. The Status table of the servers includes: Column Heading Cluster Member ID Host Port Status Description The ID of the server as a cluster member. Can be either Active or Inactive. including the cluster member ID.Showing the status of servers in a cluster By accessing the home page of JReport Server Monitor. q Active . The host IP address of the server. you can see the status of each server in a cluster. The status of the server. host IP. and its status. Inactive .The server is inactive and cannot be available for service. The RMI port number of the server. and failed reports. Exiting Engine . There are five types of report status: all reports. The time when the task was submitted. The total number of report runs since it is first published to JReport Server. waiting reports. Loading Report . The status of the submitted report.The task is currently in the loading report stage. The ID of the user who submitted the report.The task is currently in the exiting engine stage. running reports. The port number of the host on which the task is performed.The task is currently in the initializing engine stage. finished reports. Status of all reports The status table of all reports includes: Column Heading Report User ID Submit Time Pages Number of Runs Status Description The full path name of the report. you can see the status of the reports. and then click Reports. The ID of the user who submitted the report. For running reports. The internal ID for this report. Status of the running reports The status table of the running reports includes: Column Heading Action Task ID Report User ID Task Status Description Stops the report from running and makes it a failed report. Status of the waiting reports . Exporting . q q q q Task Type Start Time Elapsed Time Submit Time Run Host Run Port Catalog The task type. You can select to view the status of different reports from the drop-down list.The task is currently being processed. The time when the task was last submitted.The task is currently in the exporting stage. The catalog that the report belongs to. The time when the task was started. The name of the host on which the task is performed. The full path name of the report. The elapsed time since the task was started.Monitoring the status of reports Expand any server node in the left panel of the JReport Server Monitor home page. Initializing Engine . can be one of the following: q Running . The total number of pages the last submitted report has. The path of the result files. The total page number of the report. The full path name of the report. The full path name of the report. For waiting reports. The catalog that the report belongs to. The time when the report was completed. The time when the task was submitted. . can be one of the following: q Submitted . Completed. The time when the task was submitted.The task is currently in the unlaunch queue waiting to be processed. Status of the failed reports The status table of the failed reports includes: Column Heading Task ID Report User ID Description The internal ID for this report.The task has been submitted successfully. and has accomplished all the requirements. The time when the report was started. The catalog that the report belongs to. q q Task Type Submit Time Catalog The task type. The ID of the user who submitted the report.The status table of the waiting reports includes: Column Heading Action Task ID Report User ID Task Status Description Stops the report from running and makes it a failed report. The full path name of the report. The ID of the user who submitted the report. The ID of the user who submitted the report. Task Queue . The reason why the task failed. The name of the host on which the task is performed. The task has been processed successfully. Can be an exception or a meaningful description. The internal ID for this report. Status of the finished reports The status table of the finished reports includes: Column Heading Task ID Report User ID Task Status Description The internal ID for this report. Can be Schedule or On-demand. The port number of the host on which the task is performed.The task is currently in the task thread queue waiting to be processed. Task Type Run Host Run Port Catalog Result Files Report Pages Reason Submit Time Start Run Time Completed Time The task type. Unlaunch . Can be an exception or a meaningful description. The path of the result files. The catalog that the report belongs to. Task Type Run Host Run Port Catalog Result Files Report Pages Reason Failed Info Submit Time Start Run Time Completed Time The task type. The total page number of the report.Task Status Failed. . The task has encountered errors. The time when the task was submitted. The reason why the task fails. The port number of the host on which the task is performed. The time when the report was completed. The time when the report was started. and has failed to accomplish all the requirements. The information about the report's failure. The name of the host on which the task is performed. You can also select and remove specific users. The status table of the online users includes: Column Heading Session ID User ID Create Time Last Access Time HTTP Session ID Authentication Description The internal ID of the user session. expand any server node in the left panel of the JReport Server Monitor home page. The session ID in the HTTP service. The time when the user last accessed the server. The time when the user session was created. The authentication type.Monitoring the status of online users To see the status of the online users. . and then click Users. The ID of the user logged onto the server. It can be Internal or External. 0 (default) or a positive integer. The unit is millisecond (ms). It shows the time elapsed since the last user has taken this connection. If the user sets this value to a nonpositive integer. and then click Databases.properties file in <server_install_root>\bin and the last three properties will be shown according to the real time status. The unit is second. 5 6 7 Maximal Connection Count Maximal Share Count Attempt 8 Interval(ms) 0 (default) or a positive integer. If the value is zero then the connection will never expire. It specifies the connections that are based on a URL which will be caught in the pool. This property defines the interval time. expand any server node in the left panel of the JReport Server Monitor home page. 9 Last User 0 (default) or a positive Connecting Time(s) integer. The unit is second. the default value is 1. Shows the time elapsed since the connection started to idle. the default value (1) will be used. Shows the time during which a connection can be alive. the connection pool will close it. Its value must be larger than or equals to 1. 0 (default) or a positive integer. 10 11 Note: The properties numbered 2 to 8 can be set in the ConnectionPoolConfig. The status table of the connection pool includes: # 1 2 3 Column Heading User URL Expiring Time(s) Value String A URL connecting to a database. 1 (default) or expiring time. Shows whether to re-create a connection when the connection pool has failed to create one and the number of attempts for creating the connection. which limits the number of connections under a single URL Shows the number of users who can share a connection simultaneously. it will stay open until the idle expiry time has been reached. If property ‘Attempt' is larger than 1. You can also select and remove specific connections. A positive integer. Description The user who is currently using the connection. If a connection has expired. Current Idle Time (s) Current Share Count 0 (default) or a positive integer. 0 (default) or a positive integer. Shows the number of users who are currently sharing this connection. The unit is second. The unit is second. 4 Idle Expiring Time (s) Shows the time during which a connection is kept after it starts idling. . 0 (default) or expiring time. If a connection is not used. then before the connection pool retries to create a connection it will wait for an interval time. Shows the pool size.Monitoring the status of the database connection pool To see the status of the database connection pool. Monitoring the server performance You can monitor the server performance in two ways. In server. "d:\\monitor").1".1129. click to select any server node.1129. The average waiting time of each report. Make your application environment consistent with the JMX specification. and then click on the toolbar. To monitor the performance of JReport Server on JReport Server Monitor: 1. ProfileNotifyListener notifyListener = new ProfileNotifyListener(). The number of the finished reports. The average number of reports that a user submits. profilingCounter. set the properties server. null. server. 2.properties. MBeanServer server = MBeanServerFactory. parameter homepath is the path of the rmi.null). // Create an RMI connector and start it JMXServiceURL url = new JMXServiceURL("service:jmx:rmi:///jndi/rmi://localhost:9999/server").0. The number of database connections. "d:\\monitor"). ProfilingCounter profilingCounter = new ProfilingCounter(ft). In the left panel of the JReport Server Monitor home page. The number of pages of the finished reports.0.registerMBean(profilingCounter. JMXConnectorServer cs = JMXConnectorServerFactory. String homepath). cs.0.rmiserver. 3. 2.createMBeanServer().addNotificationListener(notifyListener. Run your code. 4. profilingName).enable and server. .enable to true. The number of the currently running reports.1". the parameters serverHost and serverRMIPort are used to get server's ProfilingService remote object. and the other is by using an external method: JMX MBean API or web service API. null. The performance chart will then be displayed. int serverRMIPort.auth file which is used for RMI authority checking public ProfilingFactory(String serverHost.0. and then click Add.profiling. The number of valid user sessions. In code part ProfilingFactory ft = new ProfilingFactory("127. Monitoring the server performance using JMX MBean API or web service API To monitor server performance via JMX MBean API: 1. server). Select a task type from the drop-down list. 3.start(). click to select the counters you want to add. Here is an example: ObjectName profilingName = new ObjectName("jinfonet:name=profileCounter"). one is using JReport Server Monitor. Monitoring the server performance on JReport Server Monitor JReport Server Monitor can show performance counters in graph (Line chart and Bar chart) and text mode. Click the Performance tab. ProfilingFactory ft = new ProfilingFactory("127.newJMXConnectorServer(url. The available counters for different tasks are: Task Type Report Task Performance Counter Waiting Report Number Running Report Number Finished Report Number Finished Report Pages Report Average Processing Time Report Average Waiting Time User Session Database Connection Valid User Session Number User Average Submit Rpt Num Database Connection Number Description The number of the currently waiting reports. The average processing time of each report. getInstance(o). 3. When you run your code. "true"). JReportServerProfilingWs o = (JReportServerProfilingWs)factory.printStackTrace().profiling. null.newInstance(). XFireProxyFactory factory = new XFireProxyFactory(xfire). client. The average waiting time of each task.war to your application server such as Tomcat or WebSphere. client.rmiserver.getXFire(). Class className = jet.server.create(serviceModel. The total number of the exported report pages. set the properties server. Build jreport.create(className.properties. "true"). The average running time of each task on engine.JReportServerProfilingWs. In server. //Setup properties Client client = Client.checkLogin("admin". } //call check login then call getCounter and getCounterType o. Check the monitoring result. null). The maximum running time of all tasks on engine. 4.class.service. The tasks that have been run successfully. String serviceURL = "http://localhost:8080/jreport/services/ProfilingService". you can call the two methods getCounter() and getCounterType() to get the information you want. "admin"). The number of the reports running per minute. The average number of concurrent engines for each task. Deploy jreport. }catch(Exception e) { e.4. System. The maximum waiting time of the tasks. String serviceName = "ProfilingService". //try call getCounter first before check login try{ System. Service serviceModel = new ObjectServiceFactory(). Run your code. Here is an example: XFire xfire = XFireFactory. serviceURL).war with the makewar buildWar4WS command by using the makewar. The maximum number of report pages for all tasks.enable to true.CHUNKING_ENABLED. The tasks that have been run on-demand. The average number of report pages for each task. 2.setProperty("mtom-enabled". The maximum running time of the tasks.profiling.setProperty(HttpTransport. Check the monitoring result. To monitor server performance via web service API: 1. Exported Pages per Minute ExportPagesPerMinute SuccessfulTasks OnDemandTasks TaskAveragePages TaskMaximumPages TaskAverageRunTime TaskMaximumRunTime TaskAverageWaitTime TaskMaxWaitTime TaskAverageEngineTime TimeTaskMaximumEngine AverageConcurrentEngines .bat utility in the <install_root> \bin directory. The available counters used in JMX MBean API and web service API are: Performance Counter Total Completed Tasks Number of Reports per Minute Total Number of Pages Exported Successful Tasks On-demand Tasks Average Number of Pages Maximum Number of Pages Average Running Time per Task Maximum Running Time Average Waiting Time per Task Maximum Waiting Time Average Engine Time per Task Maximum Engine Time Average Concurrent Engines Counter Name TotalCompletedTasks NumberofReportsPerMinute TotalNumberofPageExported Counter Type int float long float int int float long float float float float float float float Description The tasks that are totally completed.ws. 5. The average running time of each task.getCounter("totalcompletedtasks")).getCounter("totalcompletedtasks")).enable and server. The number of exported report pages per minute. serviceName. Below is a figure of built-in data type hierarchy that you could refer for the return value: . In JMX MBean API and web service API.Maximum Concurrent MaximumConcurrent long The maximum number of concurrent engines for all tasks. the data type of the profiling counters has to be Decimal. If you only want to convert table/crosstab components into HTML data table in the HTML format report result. and table/crosstab components are output as HTML data table. Enable Section 508 compliant output when exporting the report to HTML format. In the accessible version.w3. The above two options are available on all HTML export option UIs in JReport Designer. In the HTML export option UI. The accessible version of JReport Server JReport Server enables the disabled users to visit the accessible version with simplified functionality to read reports by reader agent or other assistive tools. When a report element is selected. the Use Accessible Version option controls switching between normal version and accessible version of JReport Server UI when logging onto port 8888.01 http://www. Making HTML format report results accessible When designing a report in JReport Designer. you can add the accessibility related HTML attributes to the report elements in order to make the HTML format result more readable and accessible. JReport Server provides an option .section508. the corresponding accessibility attributes are available in the Report Inspector. Activating the accessible version The administrator can activate the accessible version for all users or for an individual user: q To enable for all users: .gov. Those attributes are provided in the Accessibility category of the Report Inspector. Predefine necessary accessibility attributes when designing the report in JReport Designer. By default this option is unselected and end users are directed to the JReport Console page in normal version. check the option Use HTML Data Table. 2. reports are displayed in HTML format with accessibility attributes. check the option Section 508 Compliant Output. That is to say.gov and www. The implementation standard is based on HTML specification 4.org/TR/WCAG10-HTMLTECHS/ and information on Section 508 Standards: www.access-board. The default port for accessible version is 8888 which is also the default port for JReport Console page in normal version.Accessibility JReport supports accessibility attributes and a built-in accessible JReport Server console.Use Accessible Version. To add accessibility to a report in the HTML format result: 1. JReport Server and JReport Viewer. for setting the accessible version of JReport Server as the default portal UI for an end user after the user logs in. Click Security on the system toolbar and then select User from the drop-down menu. 2. However. Up to Higher Level Directory Goes to the parent level folder. Check the Use Accessible Version option. then click OK to save the change. Locate the wanted user ID. it is not recommended for the disabled to leave the accessible version unless having others' help. Up to Top Level Directory Goes to the default portal page. 2. Check the Use Accessible Version option. the user will be directed to the accessible version when he/she logs in next time. Once you leave the accessible version. 4. there is no way to return unless you re-log in. 3. Click Customize Server Preferences on the task bar of the Profile page. 3. q To enable for an individual user: 1. In the Preference dialog. 3. Log onto the JReport Console page and click Profile on the system toolbar. 5. Select the Advanced tab. And a non-administrator user can also enable the accessible version by self on the JReport Console page in the following way: 1. Leave Accessible Version Redirects to the normal version of JReport Console page with full functionalities. then click OK to save the change. 2. 4. With the help of reader agent the user can navigate through the server resource to view the target report. then click the Preference link for the user.1. go to the Customize Server Preferences > Advanced tab. Select User Directory You can choose to open either the My Reports folder or the Public Reports folder. then click OK to apply the change. Main options in the accessible version UI Directory Path Displays the current directory where you have come to follow the server resource tree. then select the Advanced tab. Log onto the JReport Administration page. Log onto the JReport Administration page. Catalog . Check the Use Accessible Version option. After a user has been enabled the access to Accessible Version. Click Profile on the system toolbar and then select Customize Server Preferences from the drop-down menu. Lists the catalogs used in the current directory. You can click the hyperlinks in the Name column to open them. . Report List Lists the folders and report and report tabs contained in the current directory. The Portlet Report property of the report tab is set to true in JReport Designer. q q The following topics are introduced about JReport Portlet: q Preparing the webservice for JReport Portlet Deploying JReport Portlet to portal servers Adding JReport Portlet to the portal server Working with reports in JReport Portlet q q q . It is deployed and run in a portal server container on the Java EE application server. By default. and run reports in the JReport Portlet window on the portal page. to which JReport Server is deployed. this property is false. There is only one dataset in the report. where necessary and easy-to-use ad hoc functions are available for you to manipulate and customize reports. a report that can run in a JReport Portlet should meet the following requirements: q The report is the only report tab in the page report. You can insert JReport Portlet objects into your portal page. JReport Portlet provides DHTML report displays in the JReport Portlet window. However.JReport Portlet JReport Portlet is a portlet implementation based on JSR-168 Portlet Specification. this is because the JReport demo portlet reports are based on MySQL database. which are available in PortletReports.zip in <server_install_root>\help\server\en\samples.zip which is available in <server_install_root>\help\server\en\samples. the reports you want to run in JReport Portlet should also be published to the JReport Webservice Server. Start the application server in which JReport Server is deployed. To publish the demo reports to the JReport Webservice Server: 1. Assume that: q You have downloaded the JReport demo portlet reports. This name is required and is used as the display name of the resource in the server resource tree.x-bin. Upon finishing. Specify a name in the Resource Node Name box. 2. then click Publish > To Local Server on the task bar. However. Click OK to publish the resources. q Note: If you want to use the demo reports JReport provides in JReport Portlet. 7. 6. 8. Click the Browse button next to Style Directory. 3. In the Publish to Local Server page. the JReport Server WAR file jreport. and then browse to select C:\PortalDemo\font.Preparing the web service for JReport Portlet Before you can deploy JReport Portlet to any portal server. 5. After the portlet reports are published to the My Reports/Public Reports folder in the JReport Webservice Server. in advance.jar into \WEB-INF\lib. You can refer to Deploying JReport Server to a Java application server for details about the deploying procedure. your JReport Server should have been deployed to an application server.war used in the deployment should be packaged using the following command in this case (here it is assumed JReport Server is installed to C:\JReport\Server): C:\JReport\Server\bin\makewar buildWar4WS Also. they will also be automatically loaded to the My Portlet Reports/Public Portlet . war to the web server. you will find a new folder of the specified resource node name is added in the My Reports/Public Reports folder with the portlet reports. you need to add mysql-connector-java-5. Click the Browse button next to Font Directory. Open a web browser and set the URL to http://<hostname>:<webserver_port>/jreport to access the JReport Webservice Server. The font and style files the demo portlet reports use have also been downloaded to C:\PortalDemo \font and C:\PortalDemo\style. and then browse to select C:\PortalDemo\style. Open the My Reports/Public Reports folder. 4. before deploying jreport. to C:\PortalDemo. You can get the database driver from PR_Resources.zip which locates in <server_install_root>\help\server\en\samples. click the Browse button next to the From Folder field to select the folder C:\PortalDemo where the portlet reports are saved. so that they can be loaded to the corresponding folder in JReport Portlet automatically. These files can be found in PR_Resources. . Reference: You can refer to Publishing resources for more detailed instruction about the publishing steps.Reports folder in JReport Portlet. Deploying to WebSphere Portal Assume that the WebSphere Portal Server has been installed in C:\websphere. 5. 6. Click Launch to open the main menu. C:\JReport\Server\bin\makewar buildPortletWar When this is done.war in C:\JReport\Server\bin\distribute. click the install button. before you can deploy JReport Portlet to any portal server.6. to deploy JReport Portlet to the portal server: 1. Deploying to JBoss Portal Assume that you have downloaded JBoss Portal 2.Deploying JReport Portlet to portal servers Assume JReport Server is installed to C:\JReport\Server.war in C:\JReport\Server\bin\distribute to C:\jboss\server\default\deploy. to deploy JReport Portlet to the portal server: 1.5. Start JBoss Portal Server to finish deploying. JBoss 2. to deploy JReport Portlet to the portal server. Then you need to edit web. Set the value of jreport.5. click Login and the WebSphere Portal home page is displayed. you need to package the JReport Portlet WAR file by running the following command. Click Browse to find jrportlet. Enter wpadmin for the User ID and admin for the Password. 4. open a web browser and set the URL to http://hostname:10038/ wps/myportal to access the WebSphere Portal. and above.6. Liferay 4.SP1.3. The web portal servers supported are WebSphere 6. q The following introduces how to deploy JReport Portlet to some specific portal servers. On the Manage Web Modules page.1. then click Administration > Web Modules on the menu. Click Finish to deploy JReport Portlet to the portal server. 2. you can find the file jrportlet. Copy jrportlet. you can use one of the following two methods: .5-SP1 into C:\jboss. 3.0.xml in \WEB-INF as follows: q Modify the host and port of of the webservice server according to your environment.0. 2. Deploying to Liferay Assume that you have installed Liferay in C:\liferay.war in C:\JReport\Server\bin\distribute. Start WebSphere Portal Server.authorized according to the portal server you install. Start Liferay to finish deploying.war in the same directory to C:\Documents and Settings\user name\liferay \deploy. 3. 2. Click Install to finish. Copy jrportlet. Click the Upload File tab. Start Liferay. Follow the above steps to deploy jrportlet. and the plugin Installer dialog appears.war to Liferay directly instead of to the web server as explained in Preparing the webservice for JReport Portlet. then open a web browser and set the URL to http://localhost:8080/user/ joebloggs to access the Liferay home page. Click Browse to find jreport. .war in C:\JReport\Server\bin\distribute to C:\liferay\webapps. 6. 2. q Method2: 1.war in C:\JReport\Server\bin\distribute.q Method 1: 1. 3. 5. Note: Because the Liferay Portal Server is integrated with Tomcat. you can deploy jreport. 4.war. Copy jreport. Click Plugins. 3. 5. open a web browser and set the URL to http://localhost:8080/ portal. 4. Enter JReport in the Search field. Specify the title of the page as JReport in the Title text field. and then click the Create instance link in the JReport . click Launch to open the main menu. Click Login in the upper right corner of the JBoss Portal page.Adding JReport Portlet to the portal server When JReport Portlet is successfully deployed to the portal server. open a web browser and set the URL to http://hostname:10038/ wps/myportal. Start JBoss Portal Server. 6. JBoss Portal and Liferay specifically. follow these steps: 1. Start WebSphere Portal Server. The Manage Pages page is then displayed. On the main menu. Adding to WebSphere Portal To add JReport Portlet to WebSphere Portal. then click OK to add the page. Click Launch again to open the main menu. Click at the upper right corner of the page to open the portlet palette. then click Login. On the WebSphere Portal home page. Click the Content Root link in the My pages table. 4. 9. 7. Adding to JBoss Portal To add JReport Portlet to JBoss Portal. In the JBoss Login Portal dialog. This section explains adding JReport Portlet to WebSphere Portal. enter admin for Username and admin for Password. . 3. 5. Drag the portlet to the JReport page. the next step is to add it to the portal server. click Admin at the upper right corner. then click JReport on the menu to access the JReport page. so that you can work on the reports you have published to the JReport Webservice Server. On the JBoss Portal home page. 2. Click the Portlet Definitions sub tab. click Administration > Manage Pages. then click search result list. which are also available in JReport Portlet. and then click the New Page button to access the Page Properties page. follow these steps: 1. 2. JReport Portlet View is then displayed in the 8. then click the Admin tab. open a web browser and set the URL to http://localhost:8080 to access the Liferay home page. enter test@liferay. 6. then click Sign In. Click Dashboard > Configure dashboard at the upper right corner of the JBoss Portal page. Start Liferay. enter JReport in the Create an instance named text field. In the JReport Portlet View instance creation dialog. In the Portlet Instances sub tab. 6. 3. 5. Enter JReport in the Window Name text field. . Now you can see the JReport tab is added on the JBoss Portal page. then expand the Welcome Joe Bloggs list and click Add Content on the list. Click the JReport tab. click on JReport and then click the Add button to add one JReport Portlet View window. Click Dashboard at the upper right corner to return to the JBoss Portal home page. click Add Page. then click Save to create the page. In the Add Content dialog.Portlet View row. enter JReport in the Add Instance Display Names text field. enter JReport in the page name text field. On the Liferay home page. select English in the Locale drop-down list and click Add Name. 2.com for Login and test as the password. 4. You can add several windows according to your requirements by clicking the Add button. Point to Welcome at the upper right corner of the home page. 12. 7. 8. Adding to Liferay To add JReport Portlet to Liferay. follow these steps: 1. Close the Add Content dialog. 10. click Add button in the Page Layout panel. then click Save. 9. then the JReport page will be added to the Portlet Instance associated to this window box. In the Create a New Page dialog. specify JReport in the Page name text field. then click SIGN IN. In the Sign in with a regular account box. Now JReport Portlet is ready on Liferay. A tab named JReport is then added. 7. and then click the Create instance button. 11. If the report has parameters. click the Rename Report button . Running reports To run a report in JReport Portlet: 1. Note that.Working with reports in JReport Portlet When reports are published to JReport Portlet. drilling. you can just double-click the report row to rename it. you can also rename the reports. In the Select Report window. only the reports that are published to the My Reports folder on the JReport Webservice Server are listed. to make them available in the list. q To rename a report. Enter the parameter values as required and then click Submit. filtering. Open JReport Portlet on the portal server. In the Select Report window. Click OK. etc to the reports according to your requirements just as you do on JReport Server. you will be asked to specify the parameter values. So if your reports are published to the Public Reports folder. then give a new name for the report in the Rename Report dialog as required. 2. . click Customize Report List button in the Select Report window. select the report you want to run from the report list. select the report from the report list. or remove any report that is not required according to your requirements. you can then run them and perform actions like sorting. then add the reports from the Public Portlet Reports box to the My Portlet Reports box. 3. in the report list. Or. Besides the above operations. the following toolbar commands are available in the window for you to work with: Open Opens another report in the window. you can change its chart type by selecting another type from the drop-down list. ear\wps. click the Preferences button toolbar commands that you want to display in the JReport Portlet window for the report. Change <portal-skin:portletTitle> <portal-fmt:problem bundle="nls. In order to use a dynamic portlet title on WebSphere. and link to another report or a detail report. then specify the window title and the this. Export PDF Exports the report result to PDF format. you can click the page number and the arrow buttons to navigate through the report pages. so as to make the analysis of a report more diverse and useful.problem"/> . Sort Sorts the report data in ascending or descending order on the fields you select.jsp: 1. In the report display window. go to the details of a group in a report. then click the Remove Report button .q To remove a report. Working with reports When a report finishes running and is displayed in the JReport Portlet window. To do . you need to modify <WebSphere Portal Profile>\installedApps\<Node>\wps. Page navigation If a report contains several pages. <Select a chart type> For a chart report.Interactive Reports. Note: WebSphere portal server does not support dynamic portlet title by default. For details about the operations. Filter Filters the report data according to the filter criteria you specify. Rerun Reruns the report to refresh the report data. Tip: The JReport Portlet window for each report can be customized according to your requirements. you can also drill the data in a crosstab into other dimensions. select the report you from the report list.war\skins\html\IBM\control. refer to the specific topics in JReport Viewer . Export Excel Exports the report result to Excel format. } </script> For more. if (titleElement != null) { if (dynamicTitle != "" && dynamicTitle != "null") titleElement.portal.ibm.<portal-skin:portletID/>"> <portal-skin:portletTitle> <portal-fmt:problem bundle="nls.portlet.problem"/> </portal-skin:portletTitle> </span> 2.ibm.</portal-skin:portletTitle> to <span id="title.innerHTML = dynamicTitle. .Constants.com/developerworks/websphere/library/techarticles/0612_rick/0612_rick. Add the following code at the end of control.jsp: <script type="text/javascript"> var dynamicTitle = "<%=request. see http://www.<portal-skin:portletID/>").getElementById("title. html. DYNAMIC_TITLE)%>". var titleElement = document.getAttribute(com. Working with APIs APIs provide extensibility by enabling you to leverage JReport components and services. This chapter introduces how to install and utilize two types of significant APIs: q JReport Server API DHTML API q . see JReport Server Javadoc located in <install_root>\help\server\en\api. thus integrating JReport with their existing platform infrastructure. For details about the usage of APIs available in JReport Server. and build them into other applications. and provide access control for report servers. The following topics are covered in this chapter: q Installing the Server API Creating and getting instances of the ReportEngine Creating and getting instances of RptServer or HttpRptServer Invoking the Server API Overall Remote Server API & unified JSP Secure RMI objects and universal RMI object management Loading user data source classes at runtime Applying a user defined CSS to the HTML result file Specifying paths for the result files when using On-Demand API Setting dynamic parameter values when running/scheduling report via API Setting values of multi-value parameters via API API demos RMI demos Additional references q q q q q q q q q q q q q . explore report resources. It is mainly used for writing servlets.JReport Server API JReport Server API is a set of Java programming interfaces that run reports. JSPs and Java applications with report server features. 0. <install_root> \derby\lib\derby. Append the following jar files to your classpath that compile and run applications which call the Server API: <install_root>\lib\JRESServlets. JReport Server API is also installed at the same time.jar.jar.jar.2.jar.4.jar log4j-1.jar. q q q q q .2.jar.2. To DHTML: JRWebDesign. <install_root>\derby\lib\derbytools.1. Note: If you want to export reports to the following formats. you will have the following files: q In <install_root>\lib: r JRESServlets.jar. <install_root>\lib\log4j-1.jar.jar.jar r r r The Server API classes are stored in the archive file JRESServlets.jar.Installing the Server API When you install JReport Server. <install_root>\derby\lib\derbyclient.jar.jar sac.jar JREngine. <install_root>\lib \servlet. <install_root>\lib\sac.jar.jar commons-codec-1. <install_root>\derby\lib \derbynet. To XML: xml-apis.jar hsqldb.jar.jar. you should add the corresponding class package or jar with a valid path to the class path: q To e-mail or use the E-mail Notification function: activation-1. To PDF & DHTML: itext_1.2.jar and mail-1.4. After installation. <install_root>\lib\hsqldb.8.0. <install_root>\lib\JREngine. To FTP: commons-net-ftp-2.jar In <install_root>\derby\lib: r r r r r r q r derby.jar derbynet. <install_root>\lib\commons-codec-1. You need to set the classpath environment variable.ja.jar and xercesImpl.jar derbyclient.jar servlet. To Excel: poiHSSF_151.jar.jar derbytools.5.jar.8.jar. . ReportEngineFactory. you can use the method getInstance() or getInstance(boolean setDebugLevel) in the jet.server. . For example. Reference: See JReport Server Javadoc in <install_root>\help\server\en\api for usage of the ReportEngine methods.api.engine. bean = ReportEngineFactory.Creating and getting instances of ReportEngine To get an instance of the ReportEngine. or. bean = ReportEngineFactory.getInstance().getInstance(true). http.The default value is Basic. //The default value is <reporthome>\history.api.HttpRptServer httpRptServer = HttpUtil.temp: The path of temp directory. //This information is used for JRServlet to determine whether it needs //to convert that path. Method 1 Use the method jet.isMyServer: Indicates if the HTTP server is JReport standalone server.getProperties(). //also can get the instance of HttpRptServer by using HttpUtil. They are: //jrs.) creates and initializes the HttpRptServer object.. //The property reporthome must be set.initEnv(props) jet.dir.history: The directory where all the versions //of report results will be maintained. For example: c:\JReport\Server. //The path is relative to <install_root>.api. //Properties props = System. your web server //is not supposed to decode the path. and in most circumstances. The method jet.server.server. //The default value is <reporthome>\temp. //auth_scheme: It specifies the scheme of authentication.dir.server. it will use the existing HttpRptServer instance.HttpUtil. //vDebug: Enables JReport Engine to output messages to a file and sets engine //log file's trace level to INFO and error level to WARN. If the HttpRptServer has already been started. //The default value is "false". you should get the server instance instead of creating a new one. //get an initialized instance of HttpRptServer HttpUtil.HttpUtil. //temp_dir or jrs.getHttpRptServer(). //default_doc: The home page of JReport Server //It is an HTML file. //prepare report server initial properties.getHttpRptServer() // after called HttpUtil. //vError: Enables JReport Engine to output messages to a file and sets engine //log file's trace level to OFF and error level to ERROR.html. Use this method to avoid creating more than one HttpRptServer instance..server. for example. If it is not set or the file set to it cannot be loaded.http.initEnv(Properties props). docs/index. If you don't specify this property. //isConvertedServletPath: This property specifies whether your web server //decodes the path if it contains special characters. //Its value must be Basic or Digest. //demo cast HttpRptServer to RptServer jet.http.api. .initEnv(props).RptServer rptServer = httpRptServer. //the default home page of JReport Server will be used. Note that only one server can exist in the system.initEnv(.Creating and getting instances of RptServer or HttpRptServer You can use the following three methods to get the instances of RptServer or HttpRptServer. //Other properties are optional.api. //history_dir or jrs. http. //initialize the HttpRptServer. //The path is relative to <intall_root>.html.The default value is Basic. //The default value is <reporthome>\history.HttpRptServer //httpRptServer = new jet.. //This information is used for JRServlet to determine whether //it needs to convert that path. //vDebug: Enables JReport Engine to output messages to a file and sets engine //log file's trace level to INFO and error level to WARN.Method 2 Call the method HttpUtil.isMyServer: Indicates if the HTTP server is JReport standalone server.http..checkLogin(HttpServletRequest req.checkLogin(.JRHttpRptServer().init(System.server. //isConvertedServletPath: This property specifies whether your web server //decodes the path if it contains special characters.. // check login at first if (HttpUtil. The method jet.. //auth_scheme: It specifies the scheme of authentication. your web server is not supposed to decode the path.checkLogin(.getProperties()).http. //For example: c:\JReport\Server. HttpServletResponse res).api.server. If you don't specify //this property. response)) {// get the instance of HttpRptServer jet. //The default value is "false". // do something } Method 3 Directly create an instance of HttpRptServer.).. httpRptServer. Demo 1: //create an instance of HttpRptServer jet.) if necessary. //temp_dir or jrs.getHttpRptServer().api.HttpUtil. //Other properties are optional. //The default value is <reporthome>\temp. //Its value must be Basic or Digest. //default_doc: The home page of JReport Server.server.temp: The path of temp directory. httpRptServer. //at least the property reporthome should be set. //the default home page of JReport Server will be used. The properties are: //jrs.. . docs/index.http.dir.jrserver. //The property reporthome must be set.server.api.checkLogin(request. for example. So you can get the HttpRptServer after calling HttpUtil. //vError: Enables JReport Engine to output messages to a file and sets engine //log file's trace level to OFF and error level to ERROR.start(). //history_dir or jrs.dir.initEnv(.) implicitly calls HttpUtil. It is an HTML file.history: The directory where all the versions //of report results will be maintained.HttpRptServer httpRptServer = HttpUtil. //If it is not set or the file set to it cannot be loaded. getProperties()). // initialize the RptServer.server.start(). // at least the property reporthome should be set.Demo 2: //create an instance of RptServer jet.server. . rptServer.RptServer rptServer = new jet.JRRptServer().api. rptServer.jrserver.init(System. } if( !HttpUtil.getHttpRptServer().HTML.cat".*" %> <%@ page import="jet. response) ) return.*" %> <% try{ if( !HttpUtil. String user = HttpUtil. while SendFileServlet sends the requested file to the client end.jsp calls WebViewServlet to run reports. our JSP example rsthtml. Here is a simple JSP example: <%@ page import="java.Invoking the Server API JReport Server API can be invoked either by JSP or Servlet.util.cls". java.api.getUser(request).util.jsp calls SendFileServlet to send files such as jar file and report results. WebViewServlet and SendFileServlet are built-in servlets.server. This section presents to you the two methods in detail. String cat = "/SampleReports/SampleReports.*" %> <%@ page import="jet. int rstType = APIConst. }catch(TooManyTimesException e){ %> Too many times to try to login! <% return. } try{ HttpRptServer httpRptServer = HttpUtil.jet.api. . String rptName = "CustomerAnalysis.*.io.http.checkPermission(request) ){ %> Access denied! <% return.cs.*.server. and getRptDescPage. Properties ht = new Properties().checkLogin(request. }catch(TooManyUsersException e){ %> Too many users! <% return. For Example. Invoking using JSP There are example JSPs which use the Server API in <intall_root>\public_html\jinfonet. WebViewServlet responds to the run-report requests. This rstURL will redirect to the SendFileServlet. String.viewrpt.// set result type ht.printStackTrace().out. // the rst is name of the first HTML result page String rst = httpRptServer. /viewrpt=viewrpt should be added into mapping.registerOwner(user. ht).setStatus(HttpServletResponse.runReport(user. rstURL). the mapping.TAG_RESULT_TYPE. you will find the illustrative test program ViewHtmlPipelineServlet. } }catch(RptServerException e){ // output error e. rptName.getServerName() + ":" + request.valueOf(rstType)). if (rst == null) { // warning error } else { // register the owner of the result.printStackTrace(). cat. }catch(Throwable t){ // output error t.java in <install_root>\help\server\en\samples.SC_MOVED_TEMPORARILY). Here is how ViewHtmlPipelineServlet. httpRptServer.setHeader("Location".getServerPort() + "/servlet/sendfile/result/" + HttpUtil. response.properties file and servlet.getName())).println("============================ht="+ht).getTempResultOwnerManager().getName()). And servlet.java works. } %> Invoking using Servlet After you have installed JReport Server. // redirect to the rstURL response.setHeader("Content-Location". First. properties file in <install_root>\bin should be modified before it can be run. // The "/sendfile/" is the path of built-in servlet of SendFileServlet // of JReport Server. // The SendFileServlet will send the HTML result page to the client. HttpUtil.getTempResultKey(new File(rst). // make the URL to view the first HTML result page.properties.encodeEsc(new File(rst). response. rstURL). String rstURL = request. System.getScheme() + "://" + request.code=ViewHtmlPipelineServlet should be added into the servlet.put(APIConst.properties file as below: . initArgs=\ temp_dir=temp.server. .Designlet servlet.servlets.jspservlet. you should register as the owner of the temporary results by invoking the method jet.web.server. or else an Access denied error warns.jspservlet.web.jrdhtml.dhtml.sendfile.dhtml.dhtml. TempResultOwnerManager.code=jet.code=jet.viewrpt.# jrserver servlet servlet.code=jet.initArgs=keepgenerated=false.registerOwner(String owner.servlets.webview.web.JspServlet servlet.jrserver. scratchdir=C:\JReport\Server\scratchdir Note: If you want to access the temporary result files generated by running reports with the Server API.\ default_doc=docs\\index.webreporting.\ history_dir=history.JHelplet servlet.\ debug=on servlet.code=jet.WebViewServlet servlet.code=jet.code=org.apache.DHTMLRunReportlet servlet.JRServlet servlet.web.jrserver.SendFileServlet servlet.jasper. reloading=true.server.api.DHTMLlet servlet. development=false.design.help.code=ViewHtmlPipelineServlet servlet.servlet.server.code=jet.code=jet.servlets.dhtml.html. String tempResult) and then you can view the temporary result files via URL or by clicking the link on the Background Tasks page. host.0. without having to install JReport Server on the client machine.auth--> <context-param> <param-name>jrs. and to administer JReport Server. Set the following parameters as the JVM environment variables in the client side: r Djrs. -Djrs. For example.properties file located in <install_ root> \bin. JReport Server remote host and port information is passed to the client application.rmi.rmi package in the JReport Server Javadoc located in <install_root>\help\server\en\api.rmiserver. 2.fixed_port property in the server.host=<HOST_NAME/IP_address> Djrs. so that you can conveniently use the Remote Server API to accomplish your tasks.auth_file) is optional. to view the report result directly from the client side.rmiserver.JRServerContextListener</listener-class> </listener> r .The third param(jrs. By using JSPs in your web applications.properties file.1</param-value> </context-param> <context-param> <param-name>jrs.rmiport</param-name> <param-value>1129</param-value> </context-param> <!-. you must make sure that: 1.auth_file=<authFileName> (optional) r r You have two alternatives for setting these parameters: r You can add -Djrs.remote. For example: C:\JReport\Server\bin\rmi.auth_file</param-name> <param-value>C:\JReport\Server\bin\rmi.remote. the Remote Server API enables you to perform report running tasks remotely.remote.remote.xml file: <context-param> <param-name>jrs. you can also add the following to the web.auth</param-value> </context-param> <listener> <listener-class>jet. "authFileName" includes the auth file's realpath and auth file name.host</param-name> <param-value>127.rmi.0.auth_file (optional) to the batch file that is used to start your application. You can find the Remote Server API in the jet. you need to specify a fixed port in order to pass through the firewall and obtain the remote objects from the client side by setting the server. When JReport Server resides behind a firewall. you can invoke JReport Server interface remotely.Overall Remote Server API & unified JSP JReport Server allows you to run our JSPs on other machines.enable property to true in the server.server.rmiport and -Djrs.api.server.remote. Before using the Remote Server API.servlets. The RMI service is opened in JReport Server side.rmi.rmiport=<HOST_PORT> Djrs. If you are in an integration environment. Set the server.rmi.remote. properties file located in <install_ root>\bin in the JReport Server side: q server.rmiserver. connection pool management.jar. you need to set the following properties in the server. Before a JReport Server can be performed the remote administration operation on.. 3. Then. which can be found in <install_root>\lib directory. q q Using single sign-on in RMI client For implementation in a standalone server.class. If it is in an integration environment. By default this property is set to false and the JReport Server does not support remote administration.server. For example. follow the steps below: 1.httpExternalAuthorized=com. security administration. resource alias management. so that your application of RMI can access them. resource administration.mycorp. For details.admin package available in the JReport Server Javadoc which is located in <install_root>\help\server\en\api. Compiling requires the library JRESServlets. and catalog information management... connection information provider service. assuming that the implementation of this interface is com.mycorp. Modify the class path used by your RMI client to include your external authentication classes. see Server security .Single sign-on. Compile Java classes. configuration.api.httpExternalAuthorized with your implementation. 2.rmi. The administration of a JReport Server includes cluster administration.HttpExternalAuthorizedImpl . 4.enable=true Used to open the RMI service. Write your HttpExternalAuthorized implementation.Administering JReport Server remotely JReport Server can be administered from a remote client by Remote Admin Service API. . You can find the Remote Admin Service API in the jet. Modify the start file of your RMI client to define the system property jrs.rmiserver.enable=true Used to open the administration service in the RMI server.fixed_port=<AnOpenedPort> Required when JReport Server runs behind a firewall. server. use the command line to start the RMI client: java -Djrs. restart the RMI client. server. you can add the authentication classes in a folder named classes in the WEB-INF folder. HttpExternalAuthorizedImpl.rmiadminservice. If you want to add a new JReport Server that has a different authentication file to the server cluster. you can specify a string by specifying the content of the authentication file. you can pass the authentication check: java -cp .rmi. Also. Also. As long as the authentication strings that the local and remote server both hold are the same. a request must be sent to the remote object management to get that special remote object. In the universal remote object management system. the remote object management system will use an authentication file. JReport Server Monitor will then fetch it from <monitor_install_root>\bin and build an authInfo object.... Alternatively.auth_file or Djrs.rmi. For example.rmi. To avoid security risks and the mess of using the RMI registry (all the remote objects bound with the RMI registry directly can cause the remote objects to be unmanageable). java -cp .auth) is generated by JReport Server automatically during the server installation process.rmi. Remote API. This file can then be used in JReport Server Monitor. The information first found will be used for the authentication check in the remote object management system. The authentication file The authentication process requires a remote authentication file that contains the authentication information to accomplish the security check. Note: In JReport Server and JReport Server Monitor.auth_string=my_auth_info mainClass. when getting a remote object to perform certain operations. which resides in the <server_install_root>\bin directory.Secure RMI objects and universal RMI object management RMI is frequently used in JReport Server.rmi. The remote authentication file (<install_root>\bin \rmi. JReport Server/JReport Server Monitor looks up these three locations in turn (-Djrs. event system. -Djrs. make sure that the authentication files on all clustered servers are the same. universal remote object management has been introduced into JReport Server. -Djrs.auth_string in the startup file.auth_file => <monitor_install_root> \bin) when checking authentication information. and then copy the authentication file from a clustered server in the JReport Server cluster to <server_install_root>\bin. java -cp . you can also use -Djrs.auth_file=% authFileName% mainClass. either on a server (local or remote) or in a 3rd-party application (via Remote API). such as for clustering..rmi. You can protect your authentication file by moving it to a safe place after installation.auth_string => -Djrs.. Using the authentication file The authentication file is commonly used in the following circumstances: q In JReport Server. For example..auth_string=my_auth_info mainClass. and monitoring system.rmi. you should first backup the authentication file of that server. you can specify the authentication string yourself arbitrarily. In JReport Server Cluster. authentication is required before any request for a remote object can be processed. -Djrs. Copy the authentication file generated by the JReport Server installation process to the directory <monitor_install_root>\bin. q q q . you must specify the authentication file when launching an application that contains the Remote API invocations. If the Remote API is used. auth_file or -Djrs.Ways to generate authentication information The authentication information can be of any bytes.rmi.auth) generated when installing the server. You can compose any string into the auth file using any text editor. You can compose any string as the value of the system property -Djrs. The following are the methods for specifying authentication information: q You can get the authentication file (rmi.auth to specify authentication information. as long as the authInfo objects match between the local and the remote server.bat file stored in <server_install_root>\bin to generate the authentication file.rmi. q q q . You can use the RMIAuthFileCreator. api. r Using the option -Dserver.api.dir=YOUR_FOLDER r Using the property entry server.util. for standalone JReport Server.getProperties().server. static void jet. "c:\\JReport\\Server\ \dynamic"). for example: System.dynamic.api.class.ServerEnv.dir in the server/application startup file It will be loaded to system properties. q Usage Follow the steps below: 1.class.class.dir". UDO or UDF to your production environment. HttpUtil.initEnv(System. Here is an example: -Dserver.engine. user defined objects (UDO). When you publish the reports using UDS.initEnv(java.getDynamicClassDir() Retrieves the path of the dynamic classes of the report server.class.http. or in your embedded application server calling the Server API.dir=YOUR_FOLDER.ReportEngineFactory. JReport requires the UDS. you can control loading the classes at runtime without shutting down your application. and user defined formulas (UDF). Specify a folder location on the machine where JReport Server runs to hold all the UDS/UDO/UDF jar files.dynamic. When JReport Server initializes. That is.class. .server. You need to shut down your application and wrap the new UDS.loadClasses(String path) Loads the dynamic classes from the location specified by the path parameter.Loading user data source classes at runtime JReport allows you to create your reports using user data source (UDS).dir to set the location.dynamic.getProperties()).dynamic.dynamic. This might be difficult for you. Here is an example: server.Properties props) Use the key server.server. Methods There are two important methods in the Server API that you need to call to dynamically load your UDS classes: q String jet.class. UDO or UDF jars to be in the classpath or part of the EAR bundle. UDO or UDF classes into the WAR or EAR or put them in the classpath of the application server. so that you can specify to load the classes from that folder.properties file located in <install_root>\bin The default value of this property is <install_root>\dynamicclasses.put("server.dir in the server.dynamic.HttpUtil. you can specify the location in one of the following ways: r Using the Server API static void jet. The feature Loading User Classes at Runtime can solve this issue. q . r q When you call the API for loading the classes.println("Dynamic path"+httpRptServer. ReportEngineFactory.loadClasses(httpRptServer.getServerEnv(). However. then you should follow the below rules: r q q The jar with the main class implementing JRUserDataSource class of the dynamic UDS must be in the dynamic class folder. JReport Server will try loading dynamic classes in the above way. JReport Server will not kill the running catalogs and reports but run them using the old UDS classes.getServerEnv(). the classes (in the *.zip packages in the specified folder including resource files (recommended *.ServerEnv. api. or EAR/EAR in embedded integration environment). it will try loading them in the traditional way (using the class path in the JReport Server startup file. and the third has the lowest. and the older ones will be neglected.jar files. The latest modified file will be loaded first. r q r You should bundle the resource files into a jar no matter whether it is in the same class jar file or not.jar or *.jar or *. If failed. Specify to load classes at runtime by calling the method static void jet.lang. If there are duplicated classes (having the same package and class name) in different *. ClassNotFoundException will be thrown.getServerEnv(). Check the dynamic UDS/UDO/UDF folder any time by calling the method static String jet. 2. Usage of the method: HttpUtil.loadClasses(java. Notes (technical issues): q Only *.engine. which excludes the sub directories and unpackaged classes. For example: ReportEngineFactory.jar or *.server.zip packages and also want to take advantage of dynamic loader. The classes in the *. it cannot work in reverse. the default loading sequence is in time order. among the above three approaches.zip ) in the dynamic class folder can get the recourse files both in the dynamic class folder and under the JVM class path. the first has the highest priority.jar) will be loaded.Note: In general. If your UDS classes also go to load the recourse files. You can even copy your UDS/UDO/UDF jar files to the above folders programmatically. and freeze new reports until the loading action has finished. 3.jar or *.getDynamicClassDir()).api. Once it fails to find the classes.String path).getDynamicClassDir ()). In addition.getDynamicClassDir().getHttpRptServer(). The parameter path is the dynamic class folder. You can get the path's value in your own properties file.out.getDynamicClassDir() Example: System. the classes under the JVM class path cannot get the resource files in the dynamic class folder. If you split one dynamic UDS classes into different *.server.zip packages in the dynamic class folder can call or refer the classes under the JVM's class path. q For the UDO classes. only the creator class and render class can be loaded. . In JReport Designer.jsp in the file ApplyUserCSS. Publish the report to JReport Server (for details. 3.Applying a user defined CSS to HTML result file When exporting a report to HTML format. To apply user defined CSS to HTML result file: 1.css file to the HTML result file. The value of the property should be the selector in your .css file. and in Report Inspector. Select the object which you want to apply in your own CSS. 2.zip which is stored in <install_root>\help\server\en\samples for your reference. Export the report to HTML format using JReport Server. When exporting a report to HTML format with Server API. 4.css file will be generated automatically by JReport to control the appearance and layout of the result file. specify a value for the CSS property External CSS Class Selector. Edit your JSP file that invokes the interface used to export the report to HTML format. specify the CSS selector in your own CSS for report objects. a . JReport provides a demo JSP file ApplyUserCSS. . JReport enables you to apply your own . see Publishing resources). tempResult.TAG_HTML_DIR.put(APIConst.put(APIConst.out.put(APIConst.put(APIConst. props). //props.put(APIConst.println("========to pdf=" + props). String.exportResult("admin".TAG_RESULT_LOCATION.TAG_RESULT_LOCATION_TYPE. String tempResult = server. System. catalog.TAG_RESULT_LOCATION. //Set result file location.valueOf(APIConst. System. //and the value of TAG_LOCATION_TO_SERVER_DISK_REAL_PATH is 1. String.TAG_HTML_DIR_TYPE. The value of TAG_LOCATION_TO_SERVER_RESOURCE_PATH is 0. See the following demo code: Demo code of running the report to the PDF format directly //Set report properties Properties props = new Properties().TAG_RESULT_LOCATION_TYPE. "/SampleReports"). Demo code of exporting the RST file to HTML format //Set task properties Properties props = new Properties(). props).put(APIConst. TAG_LOCATION_TO_SERVER_DISK_REAL_PATH)). tempResult = rptServer. . String. props.println("========tempResult="+tempResult). //Export to HTML props. ExportedFileList fileList = server.out.put(APIConst.TAG_RESULT_TYPE. //props. props. props. props).TAG_RESULT_LOCATION_TYPE. "/SampleReports"). rptName. String.println("\n========exportResult="+props).TAG_HTML.getHTMLFilenameList()="+fileList.out. System.out. "0"). props.runReport(user.pdf format.out.PDF)). "Crosstab"). //The default value of TAG_RESULT_LOCATION_TYPE is 1. "C:\\"). "/SampleReports").TAG_RESULT_LOCATION. props.TAG_LOCATION_TO_SERVER_RESOURCE_PATH)). props.valueOf(APIConst.println("\n========fileList.runReport("admin". props. //Set result type as .put(APIConst. props. TAG_LOCATION_TO_SERVER_RESOURCE_PATH)). catalog. you can specify the path for the report result files.put(APIConst.put(APIConst.valueOf(APIConst.valueOf(APIConst. //Set result file location.TAG_RESULT_TYPE.put(APIConst.valueOf(APIConst. String. System.getHTMLFilenameList()). rptName.Specifying paths for the result files when using On-Demand API When you run a report in the Advanced mode using the on-demand report execution API.RST)).println("========to pdf=" + props). System. you can specify dynamic parameter values by implementing the ParameterGenerator interface.java in <install_root>\help\server\en\samples for an example of implementing the ParameterGenerator interface.TAG_PARAM_PREFIX + "PToday". replace the way of setting static parameter values and instead set dynamic values of the required parameters in the report.TAG_PARAM_PREFIX + "PToday". Add the class path into the class path of your implementation of running or scheduling the report such as DemoParameterRunReport.put(APIConst. Take the parameter PToday for example: First disable or delete the line: props. See JReport Server Javadoc in <install_root>\help\server\en\api for detailed usage of the API. See the API demo DemoParameterGenerator. and then add a line as follows: props. In DemoParameterRunReport.put(APIConst. 3. 2.TAG_PARAM_GEN_PREFIX + "MyParameterGeneratorImpl". APIConst. . "2007-5-21"). To set dynamic parameter values to a report: 1.Setting dynamic parameter values when running/scheduling report via API When running or scheduling a report with parameters via API. Create a class MyParameterGeneratorImpl to implement the ParameterGenerator interface. see APIDemoRunReport.TAG_PARAM_PREFIX + "Customers_Country". . "Canada"}.java in <install_root>\help\server\en \samples.put(APIConst.Setting values of multi-value parameters via API To run a report with multi-value parameters via API. take the following example to set values to a multi-value parameter Customers_Country: String a[] = {"USA". props. For the API code of running a report. a). or folders to the server.java An example of using remote report server.java q q q q q q q q q q q q q . and then saving them to local disk. CustomServlet.java An example of exporting a report to some formats. All these programs are available in <install_root>\help\server\en\samples.java An example of publishing catalogs. For details. and set the where portion. see Single sign-on.java An example of scheduling a customized task.java An example of publishing a scheduled task. and you can run the demo using the URL http://localhost:8888/demo/main. APIDemoRunReport. a folder named demo is added.API demos Here is a list of some demo programs included within JReport Server.zip An example of applying user defined CSS to the HTML report result. For details. APIDemoSendEMail. For details. which is used to control users' accessibility to certain files in server machine when they access the server via http. After extracting the zip to a folder where JSP can be run. CustomHttpExternalAuthorized.java An example of using the ReportEngine to run a report.HttpExternalAuthorized.api. see Scheduling a customized task using User Task. CustomizedSendFileAuthorizor. APIDemoRunAndExportReport. see Applying a user defined CSS to HTML result file.jsp. ApplyUserCSS.server. APIDemoRemoteFileService.zip An example of using JSP to build URL to run a report in DHTML format. APIDemoDynamicExportTask. APIDemoReportEngine. export/print a report. report s. q 1stepdl_demo.java An example of running a report.java Demonstrates implementation of SendFileAuthorizor.java Demo for implementation of the jet. for example. APIDemoDeployRpt.http. APIDemoRunReportWithTimeout. APIDemoPublishRpt. <install_root>\public_html.java An example of publishing a report to e-mail.java An example of running reports with timeout. java Demo for implementation of the jet. then fire the trigger to run the schedule.java Referenced by Demo2UserAuthenticator. DemoParameterGenerator. For details. ExampleCodeForTags. Demo2User.java Demo to implement the jet.api.Demo to set implementation of jet. For details.server. see Single sign-on.api.html The sample code for different tags. see Appendix 8: DHTML tag library.custom.server. For details about tags.HttpExternalAuthorized into the report server. For details.java This demo creates a trigger.txt Referenced by Demo2UserAuthenticator. DemoAuthorizationProvider.java Referenced by Demo2UserAuthenticator.UserAuthenticator for using your user data. see Dispatching RMI Server Pages requests in multiple server environment. MultipleReports.server.jsp.server. see Balancing the server load.custom. DemoTrigger. demo2data. For details.java. see Setting dynamic parameter values when running/ scheduling report via API.java An example of dispatching request to remote clustered server according to Round-Robin algorithm. see Customized implementation of the Security API. For details.userman.api.cluster.http.zip A page enabling you to export the report result to various formats (except for applet). getRptDescPage2.http.UserAuthenticator for using JReport Server as a servlet in your system.zip q q q q q q q q q q q q q q .server. DemoLoadBalancer.java Demo to implement the jet. submit a schedule bound with the trigger.java.java.userman. For details.java Demo to implement the jet.AuthorizationProvider interface. see Customized implementation of the Security API. Demo2UserAuthenticator. Demo1UserAuthenticator.jsp.HttpExternalAuthorized into the report server and view a report.api. DemoRemoteDispatcher. For details. see the Notes section in Customized implementation of the Security API.java An example of implementing the jet.java Demo for implementation of the jet. see Single sign-on. For details.security. DemoAuthenticationProvider.zip Demos to set implementation of jet.LoadBalancer for randomly selecting a clustered server. For details.server.ParameterGenerator for setting dynamic parameter values.api.server. Demo2Realm.AuthenticationProvider interface.security.schedule. see the Notes section in Customized implementation of the Security API.custom.server.api. q customViewReport. see Opening multiple reports in one session. see Adding TaskListener. ViewHtmlPipelineServlet.java This is a servlet demo of viewing report as HTML pipeline format. see Using JSPs to print reports. q printDemo.Demo JSPs for opening multiple reports in one session.zip Called by the getRptDescPage2.jsp to run a report. you can put them in the directory <intall_root>\public_html\jinfonet.jsp. See details.zip These JSP files show how to print reports by using ViewerApplet. For details. TestTaskListener. For details.jsp. To run JSP pages. TestMutiUserDesign. For details.jsp. see Invoking using Servlet.java Demo for how to create reports by multi-user via MultiuserDesigner.java This sample demonstrates exporting report result to physical disk path when publishing a scheduled task. q q q q q . PublishToRealDiskPath.java An example to demonstrate how to implement users' own scripts before and after task running and how to get the information about a task. runReport2. and then access them from a web browser using the URL http://host:8888/jinfonet/XXX. q q Before running these demos.rmi. <install_root>\commons-codec-1. RemoteAPIDemoRunReportWithTimeout.jar. disk.jar. You need to set the classpath environment variables. <install_root>\lib\log4j-1.jar . 2. <install_root>\lib\servlet.8. <install_root>\lib\sac. <install_root>\lib\JREngine. Modify the server. They are available in <install_root>\help \server\en\samples. This demo runs a report and marks it as a large report by setting the timeout value. You can submit a schedule to export a report to version. RemoteAPIDemoRunAndExportReport.2. and then returns the large report information. remember to do the following: 1. q RemoteAPIDemoPublishRpt.RMI demos Here are some demo RMI programs that JReport provides.properties file in the <install_root>\bin directory to set the property server.jar.java A demo about publishing reports.java A demo about running reports and exporting report results to other formats. Append the following jar files to the classpath that compile and run applications which call the Server API: <install_root>\lib\JRESServlets.jar.java A demo about the Large Report Manager. Add -Djrs. rmiserver.enable to true.jar. or email. 3.2.auth_file="%authFileName%" to the command line that starts the required program. cs. It allows concurrent users to create or modify multiple reports at a time.api.http package and jet. JReport Server Designer API is a program interface for creating new reports or modifying existing reports.server. JReport Server contains a full JReport Server Designer API package. jet. See JReport Server Designer API in <install_root>\help\designer\api.api package. q q .util package in <install_root>\help\server\en\api. Accessing JReport Server.server.Additional references q See JReport Server Javadoc jet. It is located in <intall_root>\public_html\dhtmljsp.dhtml package in JReport Server Javadoc that is located in <install_root>\help\server\en\api. see the jet.web. so that you can conveniently use the JReport Viewer features (completely or partially) in your product. This section talks about the following three topics: q Installing the DHTML API Getting started with the DHTML API Advanced DHTML API application q q . You can refer to the built-in JSP dhtml. For DHTML API specifications.DHTML API The DHTML API is a set of Java programming interfaces which allow you to customize the DHTML feature of JReport Server.jsp that comes with JReport Server as a demo. jar log4j-1.jar derbynet.jar derbytools.Installing the DHTML API When you install JReport Server.jar.2. <install_root>\derby\lib \derbynet.jar.jar. you have the following files: q In <install_root>\lib: r JRESServlets.jar hsqldb.jar r r r JReport Server API classes are stored in the archive file JRESServlets. <install_root>\lib \servlet. <install_root>\derby\lib\derbyclient. You will need to set the classpath environment variable.jar derbyclient.2. <install_root>\lib\log4j-1. .jar.jar.jar.jar.2.jar servlet. <install_root>\derby\lib\derbytools. <install_root>\lib\commons-codec-1.jar. also include: <install_root>\lib\JRWebDesign. <install_root>\lib\sac. After installation. <install_root>\lib\JREngine. <install_root> \derby\lib\derby. JReport Server API including the DHTML API is also installed at the same time. Append the following jar files to your classpath that compile and run applications which call the Server API: For Server: <install_root>\lib\JRESServlets.8. For DHTML.jar.jar commons-codec-1.jar.jar sac.8.jar.2.jar JREngine.jar.jar. <install_root>\lib\hsqldb.jar In <install_root>\derby\lib: r r r r r r q r derby. } DHTMLClientService service = server.REMOTE_DISPATCHER) == null) { server = HttpUtil. q For local use Both of the following methods can be used to get an instance of the DHTML API locally. r Method 1: DHTMLClientService service = DHTMLServiceFactory.getProperty(APIConst. jet.* must be included here. if (System.getDispatchedServer(request).getInstance().dhtml. The results of these two methods are exactly the same.getInstance(). if (System. .getDispatchedServer(request). r Method 2: HttpRptServer server.web. HttpRptServer server.getDHTMLClientService(request).getDHTMLClientService().getProperty(APIConst. q For RMI use This method can be used to get an instance of DHTML API from a remote server (RMI).getHttpRptServer().getDHTMLClientService().Getting started with the DHTML API How to get an instance of DHTML API Note that before you can use the following methods to get a DHTML API instance. } else { server = RemoteDispatcherFactory. } else { server = RemoteDispatcherFactory. For instance. firstly you need to import some relevant packages. } DHTMLClientService service = (DHTMLClientService)server.REMOTE_DISPATCHER) == null) { server = HttpUtil.getHttpRptServer(). buttonId The buttonId constant for the toolbar. r r r r q Method: jet.TOOLBAR_SEARCH. DHTMLConfig config = service. String toolbarname. DHTMLWriter writer = service.DHTMLConfig. rptSetId The report ID of the current user or current request. q Method: jet.TOOLBAR_EXPORTTOXLS. java. With the DHTML API. DHTMLConstant.web. rptSetId The report ID of the current user or current request. DHTMLConstant. "Analysis".DHTMLConfig. DHTMLConstant.lang. Parameters: r sessionId The session ID of the current user or current request. int[] buttonId. DHTMLConstant. //The instance "service" is supposed to be derived //from the above method 1 or 2.TOOLBAR_UNDO.dhtml. java. The buttonId argument is an integer bitmask that can be DHTMLConstant. you can easily embed the DHTML page or components into your own JSP.setUsedToolbar (java. DHTMLDataInfo dataInfo = service.web.lang. java. String rptName.lang.lang.dhtml. you can further obtain other instances from DHTMLClientService. boolean isVisible) This method is used to specify the buttons displayed on the DHTML toolbar. isVisible If it is true. Parameters: r sessionId The session ID of the current user or current request. or a bitwise union of them (for example. TOOLBAR_EXPORTTOHTML. DHTMLConstant. DHTMLConstant.. and then //use the following method to get the other instances. boolean isShow) This method is used to set the toolbar's default status: shown or hidden. "View".lang.Advanced DHTML API application Besides fundamental functions that DHTML API provides.lang.getDHTMLWriter(sessionId. Here jet.getDHTMLConfig().getDHTMLDataInfo().TOOLBAR_EXPORTTOXML. rptSetId) How to use the other instances Customizing DHTML toolbar using the DHTML API DHTML API provides you with the API interface. DHTMLConstant. java.TOOLBAR_EXPORTTOPS etc.TOOLBAR_REDO). r .TOOLBAR_UNDO | DHTMLConstant. java.dhtml. DHTMLConstant. the buttons are visible.TOOLBAR_PREVIOUS_SEARCH.lang.web.TOOLBAR_NEXT_SEARCH. TOOLBAR_EXPORTTOTEXT.String toolbarName.String rptSetId.DHTMLConfig is used to customize your own DHTML toolbar. such as "Standard". How to get the other instances //Get a DHTML API instance using the method 1 or //2 provided in the preceding section. and user-defined ones.String rptSetId.TOOLBAR_REDO.String sessionId. DHTMLConstant.TOOLBAR_EXPORTTORTF.TOOLBAR_EXPORTTOPDF. toolbarname Name of the toolbar. DHTMLConstant.customizeToolbar (java.String sessionId. DHTMLConstant. DHTMLConstant. TOOLBAR_SEARCH}. dhtmlConfig. you must add the following code to run_report.getRptSetId(request).DHTMLConstant. isShow If it is true. see the Javadoc located in <install_root>\help\server\en\api.getDHTMLClientService(request).setUsedToolbar(SessionID.customizeToolbar(SessionID.getSessionID(request). "View". "View".getDHTMLConfig(). int[] bId = new int[]{DHTMLConstant. . String SessionID = DHTMLUtil. And this code must be after the RunReport() method.jsp in <intall_root>\public_html \dhtmljsp. r r To customize the DHTML toolbar.TOOLBAR_EXPORTTOPDF.DHTMLConstant. null. toolbarname Name of the toolbar. the toolbar is visible. "Analysis". String RptSetId = DHTMLUtil.TOOLBAR_EXPORTTOXML. RptSetId. RptSetId. bId. and user-defined ones. such as "Standard". true).r rptName The report name of the current user or current request. "View". dhtmlConfig. Reference: For more information on this topic. DHTMLConfig dhtmlConfig = service. DHTMLClientService service = DHTMLServiceFactory. true). the following types of dialogs are covered: q JReport Server dialogs JReport Viewer dialogs JReport Studio dialogs JDashboard dialogs q q q . you will find JReport Server much easier and more convenient to use.Dialog Reference This chapter covers the dialogs that you will come across when using JReport Server. In this chapter. By referencing this chapter. providing descriptions and explanations of the options available. which are listed in alphabetic order: q Add Language dialog Add to Global NLS dialog Advanced Run dialog Auditing dialog Cache Configuration dialog Catalog Properties dialog Cluster dialog Configuration dialog Customize Waiting Page dialog Dashboard dialog Dashboard Properties dialog Data dialog DHTML Profile dialog Edit Expression dialog Encrypt dialog Enter Values dialog Expression dialog Folder Properties dialog Global NLS dialog Library Component Properties dialog New Cache dialog for scheduling New Cache dialog for selecting queries q q q q q q q q q q q q q q q q q q q q q . while the JReport Administration page dialogs are only accessible to users who have been assigned the administrator's role.JReport Server dialogs There are two classes of dialog in JReport Server. They are distinguished by the types of users who can gain access to them. The JReport Console page dialogs are available to general users. The following are dialogs of the JReport Server. q New Custom Field dialog New Group dialog New Realm dialog New Role dialog New Schedule dialog New User dialog NLS Editor dialog Profile dialog Publish to Local Server dialog Publish to Remote Server dialog Report Properties dialog Result Properties dialog Schedule dialog Security dialog Select Another Catalog dialog Select Folder dialog Select Language Source dialog Select Queries dialog Select Report Type dialog Set Alias dialog Set Permissions dialog Sign dialog Specify Catalog dialog Triggers dialog q q q q q q q q q q q q q q q q q q q q q q q . Select the required languages from the box. or click OK in the Select Language Source dialog with Languages Supported by JReport selected. Available Languages Lists all the languages that are available for you to choose. in which reports can be run. Cancel Cancels the action and exits the dialog. OK Adds the selected languages and closes the dialog. It helps you to add one or more languages.Add Language dialog This dialog is displayed when you click the Add button in the NLS Editor dialog. Help Displays this help document. . Cancel Cancels the action and exits the dialog.Add to Global NLS dialog This dialog is displayed when you click the Add to Global NLS button in the NLS Editor dialog to add the selected display or font items to the target language's global NLS resource library. When display items are to be added. OK Adds the selected items to the target language's global NLS resource library and exits the dialog. Language Displays the target language into which the display text will be translated. Checkbox Specifies the items you want to add to the target language's global NLS resource library. options in the dialog are as follows. Check the checkbox on the column header to select all the items. It varies according to the type of the selected items. but some of the selected items already exist there. Help Displays this help document. . . Column This type is only for DHTML. Check the checkbox ahead of the display item if you want to add it. There are two circumstances: q If the translation is Null for any display text. It is the type of display text of columns. TOC Type of display text on the TOC tree. the existing global NLS translation for this display text will be replaced by the new one. If any display text already exists in the target language's global NLS resource library. q Label Type of display text of label and some web controls. Translate Specifies to which the display text will be translated in the target language. when you choose to add this display item. options in the dialog are as follows. and you have provided a new translation for the text in the Translate column. q q q Key Lists keys to indicate the objects in the original language. Prompt Type of display text of parameter prompt value.Type Lists types of display text for different objects. it means the display text doesn't exist in the target language's global NLS resource library yet. q When font items are to be added. Global NLS Translation Displays to which the display text is translated in the target language's global NLS resource library. Font Size Specifies the font size for the key in the target language. Font Face Specifies the font face for the key in the target language. when you choose to add this font item. Global NLS Translation Displays the font properties for the keys in the target language's global NLS resource library. There are two circumstances: q If the translation is Null for any font item. the existing global NLS translation for this font will be replaced by the new one. Key Lists keys to indicate the fonts in the original language. Check the checkbox ahead of the item if you want to add it. q . Checkbox Specifies the items you want to add to the target language's global NLS resource library. it means the font item doesn't exist in the target language's global NLS resource library yet. Check the checkbox on the column header to select all the items. and you have specified a new face and size for it in the Font Face and Font Size columns. If any font already exists in the target language's global NLS resource library.Language Displays the target language to which the font properties will be applied. then do either of the following: q Select the row the report is in. q General tab Format tab Archive tab Duration tab q q q Back Goes back to the left tab. Put the mouse pointer over the report row and click the Advanced Run button toolbar. browse to the report you want to run in Advanced mode. Help Displays this help document.Advanced Run dialog To access the Advanced Run dialog. then on the task bar of the Reports page. on the floating q q There are four tabs in this dialog. . click Run > Advanced Run. which are listed below. right-click in the row and select Advanced Run from the shortcut menu. Finish Applies the settings. You can set the settings to your requirements in each tab. Select the report row. Cancel Closes the dialog and discards any changes. on the JReport Console > Reports page. Next Goes to the right tab. .General tab This tab allows you to specify the general information about a report. which is available when the parameter's Allow Multiple Values property is set to true in JReport Designer. When it is checked. When the number of the saved parameter value lists reaches the maximum number. Parameters Specifies values of the parameters applied in the report.Enter Parameters Specifies the parameter values if any to run the report. a drop-down list that contains the lists of previously saved parameter values will be displayed for you to choose one to apply. When it is clicked. input the value manually or select the required one from the drop-down list. The Use Saved Values option is available when Enable Saving Parameter Values is checked in the Profile > Customize Server Preferences > Advanced tab. if you want to save another parameter list. You may specify parameter values in these ways: q In the parameter value combo box. By default it is 3. Bursting reports are not listed in the table. click the calendar button calendar. DateTime. or Time type. check the checkbox ahead of the button then click the button to specify a dynamic date or time parameter value with expression in the Expression dialog. Report Information . If you are running a page report. Save Values This link is available when Use Saved Values is checked. The parameter value lists saved for the report are limited. the currently displayed parameter values set for the specified report will be saved as a whole marked as a list for reuse next time. If the parameter is of DateTime type. q Check the Use Saved Values checkbox and select a previously saved parameter value list to apply to the report. The maximum number is controlled by the option Maximum Number of Auto Complete Parameters List in the Profile > Customize Server Preferences > Advanced tab. and you need to provide a name for the list in the prompted dialog as required. Click the button . If no parameter is used. to specify multiple values in the Enter Values dialog. "No Parameter Needed" will be displayed here. The button next to the drop-down list is used to delete a saved list from the list library. to set a DateTime value with and q q q If the parameter is of Date. it will overwrite the oldest list. Select Report Tab Specifies the page report tab which you want to run. you need to select a specific report tab to run. This property is available to administrators. By default this property is ignored unless server.policy not equal to 0.Specifies other report information. Catalog Version Specifies the catalog version. Priority Specifies a priority level to the report running task. Catalog Lists the catalog information.properties is modified to set queue. Report Lists the report information. The priority levels are from 1 to 10 in ascending order of lowest priority to highest priority. . Report Version Specifies the report version. Select Another Catalog Specifies another catalog for the report in the Select Another Catalog dialog. Format tab This tab allows you to specify the format in which you would like to generate the report and set its corresponding settings. It can be one of the following: q Web Report . Select Format Specifies the format in which the report result will be. Select Format section Specifies the format of the report result. If there is no NLS resource defined for the report. the DB user and password defined in the catalog will be used. the Before Converting and After Converting options will be activated. Connect to [Data Source Name] Specifies the DB user and password with which you want to connect to the data source the report uses. the Using Language drop-down list will be displayed for you to choose a language. specify another DB user and password instead of the one defined in the catalog. Use the DB User If checked. Enable Style Group When this option is disabled as default. When this option is enabled. use the style group property of the page report tab or web report for this format that is predefined in JReport Designer to run the page report tab or web report. q Use the DB user and password defined in catalog If checked. Web Report . Notes: q The Enable NLS option is available only when the National Language Support option is checked in the Properties dialog of the report on the JReport Administration page. If checked. Enable NLS Specifies whether to enable NLS for the report. If checked. q Encoding Specifies the encoding for the report. you can only run the report using the default language. q Add TaskListener to be Invoked Specifies whether to enable the user to call the Java application before/after viewing.q DHTML HTML PDF Excel Text RTF XML PostScript Applet q q q q q q q q Advanced section Specifies some advanced format settings. Select the encoding from the drop-down lists as required. you are allowed to select a style group from the Style Group drop-down list to run the page report tab or web report in the format. Enabled only when the format is not specified to DHTML. Enable Converting Encoding Specifies whether to enable the conversion of encoding. html. reports containing data objects. sales_2.css file will be generated individually. 72 DPI on Unix or 96 on Windows. Section 508 Compliant Output If checked. Resolution Specifies the resolution of the result to zoom in/out. DHTML This format allows you to export your report to a DHTML result that can be viewed in a JReport DHTML window. 72 DPI on Unix or 96 on Windows. q No Hyperlink If checked. the accessibility attributes defined for the report elements via the Report Inspector will be exported to the HTML format report result which is Section 508 compliant. JReport will create three files called sales_1. which is the resolution of your monitor. JReport designates a serial number for each HTML page.html. and sales_3. Profile Specifies the DHTML profile to be applied to run the report. The default value is obtained from the operation system. there will be no hyperlinks for navigating previous and next pages on the navigation bar of the exported HTML file. Single File Generates the report result to a single HTML file. multi-level nested master and subreports. Background Mode Timeout Specifies the time after when the report will run in background mode. You can set higher/ lower value to zoom in/out. for example. if you named a 3-page report as "sales". otherwise. The default value is obtained from the operation system. the . Resolution Specifies the resolution of the DHTML result to zoom in/out. For example. No Page Number If checked. which contains a set of JReport Viewer settings. such as self-contained (CLX) reports. See Accessibility for more information. in DPI. Some reports cannot be published to version in a DHTML result format. Multiple Files Generates the report result to multiple HTML files. there will be no page number information showing the current page number and total page number on the navigation bar of the exported HTML file. The Drilldown feature enables you to inspect certain items for further detailed data.Runs a web report in JReport Studio. You can set higher/lower value to zoom in/out. it will be automatically be switched to run in background mode. q Drilldown Generates the report result into an HTML file with the Drilldown feature enabled. and reports developed from a dynamic query or hierarchical data source (HDS). When a DHTML report runs and the results have not yet been generated after the specified time. for example. which is the resolution of your monitor. in DPI. the Use HTML Data Table and Relative Font Size options will be . When Section 508 Compliant Output is checked. HTML No Margin Removes the margins you originally set while designing the report.html. q Embedded CSS Specifies to embed the cascading style sheet (CSS) in the exported HTML files. 72 DPI on Unix or 96 on Windows. Image Chart If selected. Use Chart q Applet Chart Uses a Java applet to display the charts in an HTML format result file. the PNG format will be applied. JPG images support 16 million colors and are best suited for photographs and complex graphics. which is supported on the Web. PNG supports indexed-color images of up to 256 colors and shows a more interchangeable. If the image colors are less than 256 colors. The font size can be adjusted according to the font size settings in the web browser. Relative Font Size Generates the report result using a relative font size.checked and disabled. Generate charts and barcodes using images (recommended) . in DPI. Use HTML Data Table Specifies whether the table and crosstab components will be output as table objects in the HTML format result. GIF If selected. r r r Resolution Specifies the resolution of the HTML result to zoom in/out. the image format will be detected to JPG or GIF by the JReport system automatically. which is a lossless compression technique and supports only 256 colors. PDF No Margin Removes the margins you originally set while designing the report. such as line drawings. legally unencumbered. accessible attributes. which means that the font size is fixed. JPG (JPEG) If selected. the JPG (JPEG) format will be applied. which is the resolution of your monitor. otherwise. JPG is a lossy compression technique that is designed to compress color and grayscale continuous-tone images. well-compressed (effectively 100 percent lossless compression). the GIF format will be applied. The output will be Section 508 compliant including HTML data table. charts will be displayed as images. well-specified standard for lossless bitmapped image file. for example. The default value is obtained from the operation system. flexible and robust function than GIF. You can specify the image type from the drop-down list. Compress Image Compresses the images in the report by the percentage you specify in the box. GIF is better than JPG for images with only a few distinct colors. Text Overflow Specifies whether the text overflow is visible or hidden. Web Browser Specifies the web browser for which the HTML result adapts. PNG If selected. black and white images and small text that is only a few pixels high. The options are: r q auto select If selected. and cannot be adjusted according to the font size settings in the web browser. You can set higher/ lower value to zoom in/out. which provides a portable. it is JPG. and relative font feature. Absolute Font Size Generates the report result using an absolute font size. GIF will be applied. All Enabled Enables the Word Wrap property for all objects. Excel Word Wrap q All Keep Existing Keeps all the settings of each object's Word Wrap property originally specified in the report. there will be no more options. If checked. Print Gridlines q q q . That is. TOC Generates the report result to PDF format with a Table of Contents. and box. only the report data will be exported without format. If checked. That is. the Word Wrap property is made true for all objects. Drilldown Generates the report result to a PDF file with the Drilldown feature enabled. More/Less Options Shows/Hides the additional settings for exporting the report to Excel. Sign Specifies whether to add the digital sign to the PDF file. All Disabled Disables the Word Wrap property for all objects.When you run a report in PDF format. However. oval. Print Page Footer Specifies the page footer text for the printed file. When Excel 2000 is selected. the Word Wrap property is made false for all objects. The Drilldown feature enables you to inspect certain items for further detailed data. q q Preserve Report Formatting Specifies to adopt the original layout of the report when exporting. and the Columned property of the report tab is set to true in JReport Designer. click the Settings button to configure the encrypt settings in the Encrypt dialog. Excel 2000 If checked. such as line. q Include Shapes in Export Specifies whether to include the drawing objects in the exported Excel file. Print Page Header Specifies the page header text for the printed file. Not supported for web report. Generate charts and barcodes using vector graphics The result of using Generate charts and barcodes using vector graphics is the same as with using Generate charts and barcodes using images (recommended). JReport will take the result of the whole report as a dataset to transform the report by sequence and to generate the report result in PDF format. Normal Formatting If checked. click the Settings button to configure the sign settings in the Sign dialog. JReport will take the result of the whole report as a graphic to transform the report by the method of simulated printer and generate the report result in PDF format. the exported Excel file will be in columned format. when you run a report in PDF format using Generate charts and barcodes using vector graphics. Encrypt Specifies whether to encrypt the PDF file. the greater the value. the specified value of the two densities will be applied. there will be no clearance between the columns. That is. q Use Quote Mark Specifies to use quote marks in the text file. If the values of Vertical Density and Horizontal Density are both greater than 0 and the value of Horizontal Density is less than 11. When setting the value of Horizontal/Vertical Density. Otherwise. By default the density will be specified by JReport. Notes: q By exporting using user defined densities. the fields in the report may overlap each other. value of the previous cell in the same column will be used. the value you set will not be applied. CSV Format Exports to CSV format text file. that is to say. the value that you specify for the Horizontal Density will be applied and the value of Vertical Density will be specified by JReport. they will be specified by JReport. if the densities are not set appropriately. Repeat Last Column Value If Null If checked. The resulting density is a direct ratio of the value you specify. the Text file will only contain data in Detail panel. so you are not recommended to use this way to export the report result to Text. the value that you specify for the Vertical Density will be applied and the value of Horizontal Density will be specified by JReport.Specifies whether to include gridlines when printing the exported Excel file. the Text file will contain all headers and footers in the report. You can type your own delimiter in the Delimiter box. these densities will be specified by JReport. Otherwise. If the value of Vertical Density is less than 0 and the value of Horizontal Density is greater than 0. Windows End-of-line (CR-LF) . Vertical Density Specifies the value for each unit of the vertical density between columns. using a delimiter you specify to separate the fields. Page Header/ Footer and Group Header/Footer. the smaller the height between columns. Text Delimited Format Generates the report result to a standard text file. The resulting density is a direct ratio of the value you specify. That is. when a cell in the exported CSV text has no value. including Report Header/Footer. otherwise. Customize Delimited Fields in the exported text file will be separated by a user defined delimiter. If the values of Vertical Density and Horizontal Density are both less than 1. Header and Footer If checked. By default the density will be specified by JReport. the smaller the width between columns. q q q q Horizontal Density Specifies the value for each unit of the horizontal density between columns. Tab Delimited Specifies to use a Tab delimiter to separate the fields. If the value of Vertical Density is greater than 0 and the value of Horizontal Density is less than 0. you need to pay attention to the following: r q The value of Horizontal/Vertical Density must be greater than the character's width/height of the smallest field in the report (smallest field is the field with the smallest font size). the greater the value. r r r r Compress Specifies whether to generate the report result to Text format in a compressed size. If you specify an existing XML schema file. The exported XML schema file will only contain the structure information of the report. If checked. only the Unix End-of-line character <lf> will be used. Applet Pop-up Window Specifies to show an Applet window when viewing a report.2 for Windows Directs applets to run using Sun's Java Runtime Environment (JRE). By default when exporting a report via Applet on Internet Explorer. Otherwise.pdf in case you may not find the result. a new XML schema file will be generated to the directory where the exported XML file is to be exported. If you do not have read or write permission to the default location or the location you specified. such as D:\folder\filename. including all the property values of each report object. PostScript No Margin Removes the margins you originally set while designing the report. and the exported XML schema file will contain all the detailed information from the report. XML Only Data q If checked. Zip Result Specifies to compress the result and its size would be smaller.3 for Windows Directs applets to run using Sun's Java Runtime Environment (JRE). Unix End-of-line (LF) Specifies to use Unix End-of-line characters to indicate the start of a new line. the exported XML file will only contain the database column information. If unchecked. and when on Firefox. you will get an access . RTF Best Editing Specifies whether to apply flow layout when exporting the report to RTF. the exported XML file. the exported result will be located on the Desktop. it will be in its installation root.Specifies to use Windows end-of-line characters to indicate the start of a new line. Java Plug-In 1. Notes: q You'd better specify a file destination when exporting a report via Applet. No Margin Removes the margins you originally set while designing the report. q Schema File Name Specifies the directory and the name of an existing XML schema (.xsd) file. If checked. Java Plug-In 1. the exported XML file will also contain elements controlled by formulas. two characters <cr> and <lf> will be used at the end of the line. the generated XML file that is to be exported will be based on it. The new XML schema file and the exported XML file will have the same name but with different extensions. add the required permission in jdk\jre\lib\security\java. "read". "read.io.io.denied error.PropertyPermission "user.policy that the applet uses: permission java.write".write".dir".write".io. permission java.FilePermission "Open". . "read. q When advanced running a report to Applet on Firefox.FilePermission "${user.FilePermission Open read) To resolve this. add the required permission in java.io.util.FilePermission "D:${/}temp${/}*". To handle this.AccessControlException: access denied (java.policy that the applet uses: For the default location "Desktop": permission java. you may get the access to the Open dialog denied error as follows: java. For user defined location: permission java. after you select File > Open Result File on the Report Viewer.security. "read.home}${/}Desktop${/}*". Auto Archive Properties Specifies to archive the result version automatically after the report has finished running. Apply Archive Policy Applies an archive policy to the report result version. Archive Location Specifies the location in which to archive the report result version.Archive tab Options below are available only when the view format is NOT set as DHTML or Studio in the Format tab. The Maximum Number of Versions option specifies the maximum version amount that will be listed in the version table. By . q Archive as New Version Specifies whether to use multiple versions for the specified resource. My Reports Folder Specifies to save the report result version to the My Reports folder. q Built-in Version Folder Specifies to save the report result version to the built-in version folder. Public Reports Folder Specifies to save the report result version to the Public Reports folder. Available only for the resources in the resource tree. q q Input archive destination and result name Specifies the name and location with which to archive the result. q Result Expires in N Days Specifies a period after which the report result version will be automatically deleted. Result Expires After Specifies a certain day on which the report result version will be automatically deleted. . JReport Server will keep the result forever. q Replace Old Version Specifies to replace the old version when a new version is generated. Click the link to set user permissions to the specified report in the Set Permissions dialog. q Set Permissions Available only when the Archive Location is specified to be Public Reports Folder.default the version amount is unlimited. Result Auto-delete Specifies the deleted date of the report result version. You should make sure to set the result version as deleted automatically within one hundred years. If the time you specified exceeds one hundred years. enable property to true in the server.properties file or by checking the Enable Task Duration option on the JReport Administration page > Configuration > Advanced panel. you can specify a time duration for a task. In this tab. The following are the available options: Timeout Specifies the time duration for the task.duration. q Mail To Specifies the e-mail address of the recipient.Duration tab This tab is available only when you have enabled the task-level timeout mechanism either by setting the task. . Notify by e-mail after the specified time Sends an e-mail about the task information when the specified time is up. and ask JReport Server to cancel the task or to notify you or someone else of the task status via e-mail if the task has not yet finished running when the task duration is up. Cancel the task after the specified time Cancels the running task when the specified time is up. Auditing the Accessed Events Specifies to audit accessed events and record them in the log file in <install_root>\logs. Failure q .Auditing dialog This dialog is displayed when you click the Auditing link of a user in the User panel of the Security dialog on the JReport Administration page. Disable Auditing on All Events Specifies whether to audit on all events. q Success Specifies to audit and record the accessed events when they have been successfully performed. Specifies to audit and record the accessed events when they fail. q OK Audits and records the events with the information you have specified. Failure Specifies to audit and record management events when they fail. Cancel Cancels operations and closes the dialog. . Auditing the Management Events Specifies to audit the management events and record them in the log file in <install_root>\logs. q Success Specifies to audit and record management events when they have been successfully performed. Cache Configuration dialog This dialog is displayed after you click Cached Data on the system toolbar of the JReport Administration page. Custom Specifies the period an auto CRD exists. Help Displays this help document. r OK Applies the changes and closes the dialog. Automatic Cache Specifies whether to enable auto CRD. It allows you to configure memory usage for cached report data (CRD) and configure auto cached report data. select Cached Report Data from the drop-down menu. All CRDs being used to run reports will share the same memory space. Expires Specifies how long an automatic cached sharable data result is kept. and then click the Cache Configuration link. q Maximum Memory Usage Specifies the maximum memory usage when running a report using the CRD.bat). . The minimum value is 4 MB and can be increased up to 80% of the total Java maximum heap size (-Xmx value in JRServer. Cancel Does not retain any changes and closes the dialog. When it is selected. r q Never The auto CRD will not expire. the following options are available: q Maximum Disk Usage Specifies the maximum hard disk space for auto CRD. The value should be between 4 MB and 1024*1024 MB. Memory Usage Configuration Configures the memory usage. Catalog Properties dialog You can set the properties of a specified catalog in its Properties dialog according to your requirements. Resource Path Shows the resource path. The Properties dialog is divided into the following two tabs: q General Permission q Reset Discards your modifications and restores the dialog to its default status. Help Displays this help document. . Resource Node Name Specifies the name for the catalog. OK Retains the settings and submits the task to the server. Cancel Cancels any settings and closes the dialog. General tab Specifies the general properties of the catalog. Resource Description Specifies the description of the catalog. Apply Archive Policy Applies an archive policy to the catalog versions. r Maximum Number of Versions Specifies the maximum number of versions that will be listed in the version table. Permission tab Specifies permissions of roles/users/groups to the catalog. Enable Setting Permissions Enables the setting of permissions. Available only for versions in the resource tree. q Archive as New Version Specifies whether to use multiple versions for the catalog. A custom field can be regarded as a resource property and is available when it is enabled. q Replace Old Version Specifies to replace the old version when a new version is generated. .Resource Type Shows the type of the resource. This tab is available when the catalog is in the Public Reports folder. [Custom Field Name] Specifies value of the custom field for the catalog. By default the number of versions is unlimited (0). Users.Visible. Schedule Specifies whether to give the selected role/user/group the Schedule permission. q q Adds the selected roles. q Role If checked. Delete. q Visible Specifies whether to give the selected role/user/group the Visible permission. Read Specifies whether to give the selected role/user/group the Read permission. Write. groups or roles that have obtained the Grant permission are also endowed with the other seven permissions . Write Specifies whether to give the selected role/user/group the Write permission. all roles will be displayed in the Available box for you to assign permissions. Execute.Available Lists the roles/users/groups to which you can assign permissions. Removes the selected roles. and Update Status. Delete Specifies whether to give the selected role/user/group the Delete permission. users or groups to the Selected box. all users will be displayed in the Available box for you to assign permissions. Selected Displays the roles. Execute Specifies whether to give the selected role/user/group the Execute permission. Read. users and groups to which the permissions will be assigned. Group If checked. Grant Specifies whether to give the selected role/user/group the Grant permission. Schedule. users or groups from the Selected box. and can grant these seven permissions except the Grant permission itself. q q q q q q . User If checked. all groups will be displayed in the Available box for you to assign permissions. . There are two panels in this dialog: q Configuration panel Weight panel q Configuration panel Use this panel to configure the servers in a cluster. It is available only when your JReport Server license permits the cluster feature. It helps you to configure the settings for a cluster.Cluster dialog This dialog is displayed when you click Cluster on the system toolbar of the JReport Administration page. Cluster Name Specifies a name for the cluster. see JReport Server cluster main features. Lease is a semaphore that enables a scheduler to be an active scheduler. Cluster Storage Realm Number of Copies Specifies how many copies will be made in the cluster when a new file or folder is added to the realm folder. If this option is left unchecked. The property value should be an integer and the default value is 2. and then transfers it to another scheduler in the cluster. . The property value should be an integer and the default value is 2. When cluster is enabled. Road Robin. q Cluster Scheduler Lease Active Count Specifies the active lease number in the cluster. Load Balancer Type Specifies the built-in load balancing algorithm. For details about how these algorithms work. q q Cluster Storage History Number of Copies Specifies how many copies will be made in the cluster when a new file or folder is added to the history folder. Weighted Min-load. Configurable algorithms for load balancing clustered servers are: Min-load. If a scheduler is enabled with lease. and Random. The property value should be an integer in seconds and the default value is 30. Cluster Scheduler Lease Check Interval Specifies the time interval the cluster will use to check the number of active leases. you must specify a unique cluster name for all servers that will join the cluster to build the cluster. it becomes an active scheduler and will compete to trigger the schedule. Cluster Scheduler Lease Valid Time Specifies the period of time that the clustered server can hold a lease before releasing it. Cluster Scheduler Lease Specifies whether to enable lease for a scheduler in the cluster. you get to know how many active schedulers there are to compete to trigger the schedule. Each active scheduler can hold a lease for a period of time (which depends on the value you set in the Cluster Scheduler Lease Valid Time text field). every scheduler in the cluster becomes an active scheduler. The property value should be an integer and the default value is 2. The property value should be an integer in seconds and the default value is 300. By setting the active lease number. Notify via E-mail When a Server Is Down Specifies whether to notify somebody via e-mail when a server in the cluster is down. The property value should be an integer and the default value is 2. Server's RMI Host Specifies the RMI IP address or host name of the clustered server. Realm Directory Specifies the realm directory for storing system data. Each clustered server should use an individual temp folder to store its temporary files generated during its working process. The property value should be a positive integer and the default value is 2. temporary result files (generated by background run) will be written to the temp directory.Cluster Storage CRD Result Number of Copies Specifies how many copies will be made in the cluster when a new file or folder is added to the cached report data (CRD) result folder. sharing memory in all cluster nodes would increase the network load exceedingly which may lead to poor server performance and scalability. q E-mail Address Specifies the e-mail addresses of the people to whom you want to send a notification e-mail when a server in the cluster is down. Properties Directory Specifies the properties directory for storing system data. Temporary Files Directory Specifies the directory for storing temporary result files. Along with the running of JReport Server. The realm directory of each clustered server should better point to a different physical location. Resource Root Specifies the report root directory for storing system data. The resource root of each clustered server should better point to a different physical location. If there are quite a few clustered servers in a JReport cluster. The properties directory of each clustered server should better point to a different physical location. Save Applies any changes to the server. Cluster Memory Storage Number of Copies Specifies how many memory copies will be shared in the cluster. Server's RMI Port Specifies the RMI port number of the clustered server. . History Directory Specifies the directory for storing report/catalog/result files. Enable Cluster Enables cluster on the server. The history directory of each clustered server should better point to a different physical location. The higher performance weight you set to a clustered server. Clustered Server Name Displays the name of the clustered server.Weight panel Use this tab to configure the performance weight on the clustered server. See Configuring performance weight for how to set performance weight and how this algorithm works. Performance weight is a positive float number. Test . the higher chance it may get selected by the server which has the active scheduler during load balancing. Catalog Specifies the catalog that will be used for performance weight testing.type=2) algorithm for load balancing. Report Specifies the report that will be used for performance weight testing. you will have to configure a performance weight for each clustered server. Performance Weight If you have chosen the Weighted Min-load (loadbalance. Related topics: q Setting up and starting a JReport Server cluster Managing JReport Server clusters q . Cancel Cancels the settings.Calculates each clustered server's performance weight value at current time. OK Applies the settings. Help Displays this help document. Configuration dialog After you click Configuration on the system toolbar of the JReport Administration page. q Service panel Log panel Cache panel Performance panel Advanced panel LDAP panel Export panel Connection panel Upload panel Custom Field panel q q q q q q q q q . the entries to the following panels are available on the drop-down menu. The panels help you to configure JReport Server to suit your own requirements. Service panel This panel allows you to configure the service settings of JReport Server. . A connection handler is set free after the server sends a response to a client request. it will be refused. when the eleventh and twelfth requests come. Dashboard Port Specifies the port for accessing JDashboard page. the request will either be handled after a connection handler has been set free. or be refused when timeout occurs. numbers less than 1024 are usually reserved by system. it cannot be blocked forever. The port can be an integer between 1 and 65535. a request from the client-side will be blocked. However. When you start JReport Server.RcServlet) listens.The following are the options available in the Service panel: Port Specifies a port as the TCP port on which JReport Server listens. It should be larger than the maximum number of handlers. the administrator can specify the port for client users to configure and administer the server remotely. A request will be blocked if there are no free connection handlers in the server.servlets. The maximum number of connections depends on the number of requests that can be handled. Maximum Number of Handlers Specifies the maximum number of connection handlers. you will need to specify a port as the TCP port on which the server listens. A connection is set up between the server-side and a client-side when a request from the client-side reaches the server. Maximum Number of Connections Specifies the maximum number of HTTP connections between the server-side and client-side. and so numbers larger than 1024 are preferred. This port is where the servlet for remote administration (jet. you can use HTTPS schema to visit JReport Server UI in the standalone mode. Administration Port Specifies the port used for remote administration. When there is a limit on the maximum number of connection handlers. if there are no free connection handlers available. When the thirteenth request comes. then the request will be refused back to the client. and the maximum number of connections is 12. The maximum number of requests that can be handled depends on the maximum number of handlers. If JReport Server is running as a standalone web server. For example. Connection Timeout in _ Milliseconds Specifies the maximum time in milliseconds for a request from a client-side to be blocked before being refused by the server. JReport Server uses 8888 as the default port.server. Enable Secure Socket Layer Connection If enabled. and if there are still no free connection handlers after the time specified here (in milliseconds). In which case. The default administration port is 8889. . if the maximum number of handlers is 10. they will be blocked until a handler has been set free. However. q q q q q q q Servlet Properties File Name Displays the full path of the property file of the servlet jet. Assuming that JReport Server has been installed to C:\JReport\Server. Realm names cannot contain the "/" or "\" character. and you can specify them by inputting the host names or IP addresses. if you want to specify more than one address to be active.servlet. For IBM JVMs you should use IbmX509. This defaults to the Sun implementation (SunX509). input * into this field. q All Network Addresses If checked. but only one is active at runtime. The valid values are JKS and PKCS12. Dashboard Secure Port The port used for visiting JDashboard page via HTTPS schema. JReport Server listens on all network addresses. It should be different from the Port for HTTP schema. Keystore Type The type of keystore to be instantiated.1' automatically. the servlet property file is C:\JReport \Server\bin\servlet. JReport Server opens the listening port at host name 'localhost' or at IP address '127. which means that all the hosts of the machine are active. q Notes: q The machine that JReport Server runs on can be multi-homed (for example. JReport Server listens on the specified hosts. Only the users and resources in the active realm are accessible. When Network Address At is checked. A user is a kind of entity that is contained in a realm. if there is more than one IP address. Active Realm Specifies the realm that will take effect when the server starts up. Provide Service On Specifies whether JReport Server listens on all network addresses or just some. Keystore Password The password used to protect the integrity of the keystore. if you want to specify all the host addresses to be active. A realm is the context of JReport Server where the entities reside. It should be different from the Dashboard Port for HTTP schema. Keystore Protocol The encryption/decryption protocol to be used on the socket. Different users in one realm must have different names. Network Address At If checked. you should separate them using a q . Keystore File Path The location of your trusted keystore file. It should be different from the Administration Port for HTTP schema.q Secure Port The port used for visiting JReport Console page via HTTPS schema. Keystore Algorithm The X509 algorithm to use. and the client-end can connect with any of the hosts of this server.server. There can be multiple realms in the server. two interface cards have been installed on the machine). The valid values are SSL and TLS.0. Secure Administration Port The port used for visiting JReport Administration page via HTTPS schema.JRServlet.0.properties. Save Applies changes to JReport Server.177. Active Host Address Lists the current active host' address.blank. "leo 204.110". . for example.148. You can configure settings for each log category. and debug trivial messages. track down the workflow of a business process. .Log panel Logs can help you find out the reasons of problems. all the other options in the panel are used to define the log type. Options for configuring JReport Server logs have been provided in this panel. After you select a log type. For example. such as tracing program workflow. OUTLINE The OUTLINE level specifies an outline of program workflow. multiple threads. and dump global variables. Trace Level Used for logging something expectable or regular. and when the Engine is stopped. Access Uses the "Access" log if you want to log which users accessed which services. Error Uses the "Error" log if you want to log errors in any of the categories. including a single thread. and success in exporting to the specified result format. including Ad Hoc and analysis features supported by JReport Viewer. q q q q q q q q Descriptions Specifies the brief description of the specified log type. Manage Uses the "Manage" log if you want to log the events related to modifying settings in the Administration Console or server. Performance Uses the "Performance" log if you want to analyze the performance of report result or export operations.The options in the Log panel are listed as follows: Log Type Specifies the log category. You can set the trace level of the specified log type to one of the following: q OFF Specifies not to use the trace level. DHTML Uses the "DHTML" log if you want to log the events related to end users modifying and saving DHTML format reports. INFO The INFO level specifies informational messages that highlight the application progress at a coarse-grained q q . such as its start time and stop time. when the Engine is initiated. when the task is run. It can be specified as one of the following: q Engine Uses the "Engine" log if you want to log the events related to running reports. the time for when to begin to fetch data. Dump Uses the "Dump" log if you want to log events related to at what time what action is started or ended during the process of running tasks. such as report running service and task scheduling service. logging runtime information and associated elements. that is creating report results or exporting reports.properties. when the task is submitted. such as the exact SQL statements used to query the database. Event Uses the "Event" log if you want to log the events related to the lifecycle of the server instance. Debug Uses the "Debug" log if you want to log the events most likely needed for debugging purposes. Reports are run by the Engine component of JReport Server. Such as the report structure dump. or the result set dump. or having found invalid query or formula with grammar error when loading a catalog. q TRIVIAL The TRIVIAL Level specifies fine-grained informational events most useful in tracing an application. the output will be the result based on the trace level and error level that filter the threshold level. failing to parse a parameter. and then comes out the final log output. the threshold level for each goal appender defines the basic log level which will be further filtered by JReport trace level and error level. q q q Additivity Determines the inheritance of the appenders defined by the Logger's ancestors. If threshold=ALL. WARN The WARN level specifies potentially harmful situations. a URL is unreachable. the trace level and error level will be ignored. and important local variables. If you have set log destination. the following options are available: r Threshold Defines the appender's level (Log4j named as threshold). They group log information into two categories and add more levels to classify log information.log. if threshold=OFF. and failing to create db buffer. formula value used when running reports. or a table cannot be found in a data source. failing to find a catalog file. such as failing to load a report. and the log information output is none. such as failing to find the resource. and SQL statement. For example. the output is determined by the trace level and error level. a file is not there. Error Level Used for logging something unexpected or irregular. parameter. If threshold=one of the other levels. and exceptions that result in feature uncompleted. failing to read the valid key. For example. File Name Specifies the name of the log file to which the File Appender will output the log contents. Logs of the specified category are written into a file. for example. q File Outputs log contents to the file appender that requires a layout. Append r r r r . You can set the error level of the specified log type to one of the following: q OFF Specifies not to use the error level. connection information. When File is checked. The suffix of the log file name is . Trace level and error level are JReport specific log levels developed based on Log4J.level. Layout Type Specifies the layout type used to format the log contents. Log Destination Specifies where the log contents will be outputted to. ERROR The ERROR level specifies error events that may allow the application to continue running. such as query. Pattern Conversion Sets the conversion pattern for the Pattern Layout. FATAL The FATAL level specifies severe error events that will presumably lead the application to abort. When Daily Rolling File is checked. File Name Specifies the name of the log file to which the appender will output the log contents. Layout Type Specifies the layout type used to format the log contents. Pattern Conversion Sets the conversion pattern for the Pattern Layout.log. the following options are available: r Threshold Defines the appender's level. Pattern Conversion Sets the conversion pattern for the Pattern Layout. r r r r r r q Socket Outputs log contents to a remote log server. When Rolling File is checked. Append Specifies whether or not to retain the old contents of the specified file. The suffix of the log file name is .Specifies whether or not to retain the old contents of the specified file. r r r r r r r q Daily Rolling File Outputs log contents to the daily rolling file appender that requires a layout. File Name Specifies the name of the log file to which the appender will output the log contents. When Socket is . Buffered IO Specifies to create a buffer for the log IO. the following options are available: r Threshold Defines the appender's level. Maximum Backup Index Decides the maximum number of the latest rolling files that will be retained by the log system. Layout Type Describes the layout type used to format the log contents. Maximum File Size Decides the maximum file size of the rolling file appender. Buffered IO Specifies to create a buffer for the log IO. The suffix of the log file name is . The socket appender needs not a layout. Append Specifies whether or not to retain the old contents of the specified file. r Buffered IO Specifies to create a buffer for the log IO. Date Pattern Specifies the data pattern used to generate the daily rolling file.log. q Rolling File Outputs log contents to the rolling file appender that requires a layout. The log system will create a new rolling file when the file size exceeds the maximum file size. Layout Type Specifies the layout type used to format the log contents. Remote Host Specifies the host name where the Socket Server is located. the following option is available: r Threshold Defines the appender's level. LF5 has a swing-based UI to view all of the logging messages at run time and enables you to search and filter logging messages. Pattern Conversion Sets the conversion pattern for the Pattern Layout. When Syslog is checked. the following options are available: r Threshold Defines the appender's level. This appender requires a layout. When NTLog is checked. . r r r q Syslog Outputs log contents to a remote syslog daemon. Source Specifies the source name used and displayed by the NTEvent Viewer. Applies only to Unix and Linux servers. Applies only to Windows servers. the following options are available: r Threshold Defines the appender's level.checked. r r r r q NTLog Outputs log contents to the NT event log system. Layout Type Specifies the layout type used to format the log contents. r r r r r q LF5 Outputs log contents to a swing based logging console. When LF5 is checked. Syslog Host Specifies the host name where the Syslog server is located. Facility Specifies the facility name that is used by the Syslog. Pattern Conversion Sets the conversion pattern for the Pattern Layout. Port Specifies the port number on which the Socket Server listens. Facility Printing Specifies whether or not to print the facility information. Location Information Specifies whether or not to output the log location information to the socket stream. Delay Specifies the timeout interval value for when a client attempts to create a socket connection. the following options are available: r Threshold Defines the appender's level. This appender requires a layout. This appender needs not a layout. System.properties file located in <install_root>\bin directory.q Telnet Outputs log contents to a read-only socket. When Telnet is checked.err If selected. the log contents will be outputted to the standard error stream of the console. the log contents will be outputted to the standard output stream of the console. the following options are available: r Threshold Defines the appender's level. the following options are available: r Threshold Defines the appender's level. especially when monitoring a servlet. s r r r System.out If selected. Layout Type Specifies the layout type that is used to format the log contents. and this is handy for remote monitoring. For more information about the Pattern Conversion option. Pattern Conversion Sets the conversion pattern for the Pattern Layout. You use telnet to connect to the socket and receive log data. Layout Type Specifies the layout type used to format the log contents. This appender requires a layout. r r r q Console Outputs log contents to the standard stream of Jave console. When Console is checked. s Save Applies all changes to JReport Server. Notes: q The Pattern Conversion option is available only when the Pattern is chosen as the Layout Type. Port Specifies the port number on which Telnet listens. see comments in the LogConfig. Target Specifies the standard IO target of the Console. q . Pattern Conversion Sets the conversion pattern for the Pattern Layout. Note that when you run a report to DHTML format. the report and the catalog will not be cached. It contains three tabs: q Report Cache Security Cache Image Cache q q Save Applies the changes to JReport Server. The following options are available in this tab. JReport Server enables you to cache reports and catalogs into memory so that they do not have to be loaded from disk when they are required.Cache panel This panel allows you to configure the cache settings of JReport Server. . Report Cache To improve performance. Here is an example. When you adjust the number. The format is as follows: <report file path>-V<version number>(<applied style name>). q Maximum Number of Catalogs to Be Cached Specifies the maximum number of catalogs that can be cached by the server in its memory. The format is as follows:<catalog file path>V<version number>. the real paths of them are listed. q Maximum Number of Reports to Be Cached Specifies the maximum number of reports that can be cached in the memory by the server. If the heap is used up. If you are using the Add button to add a catalog. Cached Catalogs Lists the currently cached catalogs. an OutOfMemoryException will be thrown. the root path stand for the Public Reports folder is /. You can refer to the documents of the Java VM for more information. Remove Deletes the selected cached catalog. report version number. The larger the heap space. you should adjust the heap accordingly. The root path stand for the My Reports folder is /USERFOLDERPATH/admin/. r Cache Loaded Reports Specifies whether to keep the reports in memory or to remove them from memory after they have been generated. If you are using the Add button to add a report. However. the listed catalog item includes information such as catalog file path in the server resource tree and catalog version number. For the catalogs that are automatically cached by the server after the reports in them are run. The root path stand for the My Reports folder is /USERFOLDERPATH/admin/. the catalog used to generate it is removed from memory. after a report has been generated. the accuracy depends on your OS and VM: Cache Size 10 reports 30 reports Heap Size Required 16M 25M The default cache size is 10 reports and the default maximum heap space is 512MB. the better the performance provided enough physical memory is available. q Cached Reports Lists currently cached reports. if you specify this option. Usually. No more reports can be cached if this amount has been reached. the catalog will be cached instead of being removed. When there is no style applied. For the reports that are automatically cached by the server after they are run. -ms/-Xms specifies the initial heap and -mx/-Xmx specifies the maximum heap. -ms10m -mx512m means that the initial heap is 10MB and the maximum heap is 512MB. the listed report item includes information such as report file path in the server resource tree. Each cached report will use some heap memory. and applied style name. For example. the root path stand for the Public Reports folder is /. the real paths of them are . the applied style name is None. r q Add Adds a new catalog to the list of catalogs to be cached.Cache Loaded Catalogs Specifies whether to keep a catalog in memory or to remove it from memory after a report has been generated. No more catalogs can be cached if this amount has been reached. If checked.000 records). Remove Deletes the selected cached reports. Custom Size Specifies to customize the buffer size used in the RAM for each report when sorting on DHTML reports. r Report Buffer Size for Sort Action q System Managed Size Specifies whether to automatically control the buffer size used in the RAM for each report when sorting on DHTML reports by system. User Cache Size Specifies the maximum number of user objects in the security cache. because if the amount of data for sorting is large (such as 5. Any value smaller than 4 MB will be ignored and use 4 MB instead.000. Protection Cache Size Specifies the maximum number of ACL objects in the security cache. but the buffer size that you configure is small. The default value is 16 MB. Role Cache Size Specifies the maximum number of role objects in the security cache. q Note: Any change to the buffer size will take effect immediately. all data for sorting will be stored in the RAM automatically. Security Cache The following options are available in this tab. Image Cache . Group Cache Size Specifies the maximum number of group objects in the security cache. and the minimum size required by JReport is 4 MB. it will require a lot of IO and produce poor performance. r Add Adds new reports to the list to be cached.listed. Locked Displays the lock status of the image file. all the images that are used in reports will be cached. The default value is 10 MB. s r r r r r Look In Specifies the root of the catalog. specify the maximum size for caching images as required. q All used images If checked. r q q Name Displays the name of the image. Size Displays the size of the image file. Show Details If checked.The following options are available in this tab. that is to say. My Reports or Public Reports. Cache Images Specifies whether or not to enable image cache. the detailed status of the current image cache will be shown. Path Displays the path of the cached image. Maximum Image Cache Size If checked. Add Adds an image to the image cache. you can see all the cached images. Select Directory s . Catalog Displays the catalog file in which the image file is. Specifies the directory of the catalog. s s r Lock If you select one image and lock it. the image will be always kept in cache until you remove it manually or restart JReport Server. Unlock The unlocked image will not be always be kept in cache. Remove Removes the selected image from the image cache. Image Size Displays the size of the selected image file. Image File Specifies the image file. s Catalog Specifies the catalog from the drop-down list. Remove All Removes all the images from the image cache. r r r . q Add Adds a catalog to be preloaded. The options in this panel are as follows: Catalogs to Be Preloaded Displays the catalogs that will be loaded when JReport Server is started. Preloading some useful Java classes will improve performance. Otherwise. Preload Catalog Referred Classes Specifies to preload the Java classes that are used by a catalog when JReport Server is started. Remove Removes a catalog from the preloading list. it will take some time for JReport Server to load any required Java classes when generating reports. q q q Preload Report Referred Classes Specifies to preload the Java classes that are used by a report when JReport Server is started. Preload Engine Referred Classes q .Performance panel This panel allows you to tune the performance of JReport Server. Specifies to preload the Java classes used by the JReport Engine when generating reports when JReport Server is started. Remove Removes a report from the preloading list. Note: Compressing swap files will increase CPU pressure because it uses compress algorithm to shrink data. enabling this option will bring extra performance impact. q q Improve I/O Performance q Compress Swap Files Specifies whether or not to compress the temporary data generated during runtime before it is swapped to disk. so if your system already has high CPU usage. and such impact may overcome the performance gain that comes from reducing I/O time. Save Applies the changes to JReport Server. . By compressing the swap files. q Add Adds a report to be preloaded. Reports to Be Preloaded Displays the reports that will be loaded when JReport Server is started. the I/O efforts in certain circumstance may remarkably reduced so that the overall performance can be improved. depending on different circumstance. Preload Fonts Specifies to preload fonts when JReport Server is started. Enable "Publish to Versioning System" for Background Tasks View Specifies whether to generate the hyperlink Publish to Versioning System in the view page when you run a report on the JReport Console page. The options available in this panel are as follows: No Security Check Specifies whether the server responds to all the requests without security checking. Click this hyperlink to save the report result as a version.Advanced panel This panel allows you to configure the advanced settings of JReport Server. Keep Connection Alive . Permission Setting UI Displays Controls whether to display user. All catalogs in the server resource tree are listed for your selection. If this option is checked.algorithm. By default. then the My Reports and the Public Reports folders can inherit the linked catalog from the server level once their Enable Linked Catalog property is enabled. role or group's permission. This option is disabled in cluster environment. Enable Multiple Users to Login Using the Same User Name Specifies whether multiple sessions created by one user can exist simultaneously. If you need to get resources from real paths. the connection will be disconnected once the HTTP request has been responded to. Permission Algorithm Specifies an algorithm for calculating a user. the Duration tab will be available in the Advanced Run and Schedule dialogs. If you uncheck this option. When connections are established to the JReport Server at runtime. Enable Task Duration Specifies whether to enable setting a time duration for a task and asking JReport Server to cancel the task or to notify you or someone else of the task status via e-mail if the task has not yet finished running when the task duration is up. see server. Enable Linked Catalog Enables to predefine a linked catalog at server level for the My Reports and Public Reports folders to inherit. permission. Enable Resources from Real Paths Specifies whether to enable getting resources from real paths. make sure that this option is checked. In the role based security. and users and groups are mapped to roles. By default. That is. If this option is unchecked. For information about the permission accumulation algorithm and the user permission replacement algorithm. By default. only the newly created session will be active. If you have set a linked catalog here. User Session Timeout Specifies the time limit for a user to gain access to JReport Server.Specifies whether to keep the connection alive. If the option is unchecked. . the My Reports and the Public Reports folders cannot inherit linked catalog. Prompt Message When JReport Viewer (DHTML) Action Queue is Full If checked. groups and roles. q Select Another Catalog Specifies another catalog. a message will be prompted asking you either to place the action in the waiting queue or to cancel it when an action cannot be performed in JReport Viewer immediately due to the action queue being fully occupied. If this option is checked. this option is not checked. Role Based Authorization Specifies whether to activate the role based security in replace of the default applied security of setting permissions for users. you can choose either to keep the connections alive or to close them. Internet Explorer will not hold the open connection. and all the other former sessions created by the same user will be terminated by the server automatically. permissions are defined on roles only. this option is checked and one user can log onto JReport Server repeatedly without having to terminate former sessions until the session number reaches the number permitted by the license. role or group permissions in the permission setting UI for the server resource tree node and version properties. this option is checked. Show Extensions for Known File Types Specifies whether to show the file name extensions of catalog and report files. a message will be prompted asking you either to place the task in the waiting queue or to cancel it when a task cannot be run in JReport Server immediately due to the task queue being fully occupied. and the scheduling to version and advanced run dialogs. the option Permission Setting UI Displays will be hidden since it applies to the default applied security. Prompt Message When Server Task Queue is Full If checked. or simply showing that no more action can be held at the moment when the waiting queue is full. High Priority. It can be one of the following: Lowest Priority. On the condition that multiple tasks are running on your machine. JReport Engine will share a comparatively small part of the CPU usage when it is running. For example. JReport Engine will occupy more CPU usage. Of course. Whereas. the faster the performance. This choice provides you with greater flexibility in adjusting the engine's utilization of the CPU according to your requirement. and Highest Priority. it will be put into the Background Tasks page and the server will go on running the report there. if you choose Low Priority. select the report by clicking in the row and then delete it from the Background Tasks tab.properties file. if several users attempt to gain access to JReport Server at the same time and among them. Normal Priority. The default session timeout is 3 hours. you can decide your engine's priority in CPU usage by choosing one of them. If you want to stop running the report. Time Limit before Moving to Background Specifies the maximum time for running a report.duration. JReport Server checks task duration every 30 seconds. The option is available when the option Enable Task Duration in this panel is checked. Engine Priority Specifies the priority of the engine in CPU usage when multiple tasks are running on your machine. Temporary Files Life Specifies the length of the period to keep the temp files for after they have been generated. By default it is 24 hours. . This value can also be reset by the task. Temp files are deleted 24 hours after they have been generated. the server will then log it out after timeout. if you choose High Priority. Low Priority. By default. the higher the priority. a user is unable to send requests to JReport Server for a period of time. Note that the value must be an integer greater than 0.Generally speaking. If a report is so large that JReport Server cannot run it within the time specified here. Save Applies the changes to JReport Server.check_cycle property in the server. Status Refresh Interval Specifies task duration check frequency. It contains four tabs: q Server Import Synchronize Role Map q q q Server This tab allows you to configure LDAP server settings.LDAP panel LDAP (Lightweight Directory Access Protocol) is a lightweight client-server protocol for accessing directory servers. This panel allows you to configure the JReport Server LDAP settings. the JReport Server enables you to import users/groups from directory servers. . With LDAP support. Microsoft Site Server. Enable Direct Authentication to LDAP Server Specifies whether or not to enable LDAP support without importing LDAP security information. Load Settings Loads the settings of the specific server. OpenLDAP Directory Server. Directory Manager DN Specifies the entry path of the Directory Manager who has the priority to manage users on the Directory Server. the JReport Server security system can run two modes in which you can use an LDAP server's security system. referral. Enable Auto-Import of Users from LDAP Server Specifies to enable JReport Server to import LDAP users automatically. This option controls the LDAP feature's work mode. the server security system will import security information from the LDAP server when an LDAP user logs into JReport Server for the first time. This is done by using extensions and controls. and deployment. Currently. JReport Server will only use LDAP Version3 protocol to connect to LDAP server. Supported servers are: Novell Directory Server. Password . LDAP Server Port Specifies the port of the LDAP server. Note that currently when you select Version3. Win2000 Active Directory. With this mode. Enable LDAP Version2/Version3 Specifies whether or not to enable JReport Server to retrieve users from the Directory Server and which LDAP Version to adopt. LDAP Version3 protocol has extensible authentication which uses Simple Authentication and Security Layer ( SASL) mechanisms so as to support pluggable authentication. From this root. and Lotus Domino on NT. iPlanet Directory Server. Root Entry Specifies the root of the Directory Server. The first is importing mode. JReport Server can directly access an LDAP server and obtain LDAP security information without having to import it. you will have to import the security information from an LDAP server. if you want to use the LDAP feature. It also allows new features to be added to the protocol without also requiring changes to the protocol. The second is non-importing mode.Select LDAP Server Specifies the Directory Server. In this mode. JReport Server searches for objects in Directory Server. If activated. The LDAP Version3 extends LDAP Version2 in the areas of internationalization. LDAP URL Specifies the URL of the LDAP server. authentication. Query User Views properties of users in the organization unit. and SSL refers to connecting to the LDAP server by SSL. q q q q q Save Saves all changes.Specifies the Directory Manager's password. User Password Specifies the user's password. q Group Common Name Specifies a common name for the group. q User Attribute Name Specifies the user's attribute name. User Schema Specifies the settings of user schema. Distinguished Name Specifies the name of the organization unit inside the LDAP server where you want to perform a search for users. q q q q q Group Schema Specifies the group schema settings. Import This tab allows you to import users/groups from directory servers. Import LDAP Groups to Specifies whether the LDAP groups will be imported into the JReport security system as local roles or as local groups. Remember Password Specifies to remember the Directory Manager's password. There are two types available. Test Connection Tests whether the connection to the specified server is successful or not. None means using a plain port to connect to the LDAP server. . There are several Examples of LDAP server configuration for your reference. Group Member Type Specifies the member type of the group. Filter Specifies the filter criteria with which to search for groups. Filter Specifies the filter criteria with which to search for users. User Common Name Specifies the user's common name. Distinguished Name Specifies the name of the organization unit inside the LDAP server where you want to perform a search for groups. Encryption Type Specifies the encryption type. Query Group Views properties of groups in the organization unit. Admin Group JReport Server will add the group specified here as a member to the Admin group. LDAP users overwrite local users Specifies that users of the LDAP server will overwrite those of the local server. all LDAP users will then be imported. all LDAP groups will be imported. and local users of the same names as the LDAP users will be overwritten. any LDAP group that has the same name as a group in the local server will be merged into the local group. and any users that have the same names as JReport Server users will be overwritten. Import Users Imports LDAP users. q q Import Groups Imports LDAP groups. If Local overwrite LDAP server users is selected. all LDAP groups will be imported. and LDAP users of the same names as the local users will be overwritten. If LDAP Server overwrite Local users is selected. and any JReport Server users that have the same names as the LDAP users will be overwritten. Local users overwrite LDAP users Specifies that users of the local server will overwrite those of the LDAP server. If Local overwrite LDAP server users is selected. Back Returns to the default Import tab. Import All Imports all groups from the LDAP server to JReport Server. q q . List Users Lists the LDAP users with the same names as the users from JReport Server. q Import Imports the selected groups from the LDAP server to JReport Server. any LDAP group that has the same name as a group in the local server will be merged into the local group. Back Returns to the default Import tab. Import All Imports all users from the LDAP server to JReport Server. If LDAP Server overwrite Local users is selected. List Groups Lists the LDAP groups with the same names as the groups from JReport Server. q Import Imports the selected users from the LDAP server to JReport Server. all LDAP users will be imported. If you have imported users/groups from the LDAP server to JReport Server once and you want to import them again.Notes: q There is an admin group named Administrators on the LDAP Server. q Enable . In the case of a non-admin group on the LDAP Server having the same name as a non-admin group on JReport Server. you should first check Local overwrite LDAP server users and then import the users/groups. Synchronization Information Lists information about the synchronization task when the synchronization process is complete. note that for security reasons. if necessary. all users from the non-admin group on the LDAP Server will be merged into the nonadmin group of JReport Server. Synchronize Now Synchronizes local security information. this process does not automatically import the newly-added users or groups from the LDAP server. The synchronization process first compares the security information on both the local server and the LDAP server. q q Import All Imports all LDAP users and LDAP groups. if you perform an Import operation. all groups will then be imported except for the Administrators group. it updates the information on the local server so that both sides are consistent. in order to prevent the information of the users/groups on JReport Server from being overwritten by the newly imported users/groups. However. Synchronize This tab enables you to synchronize security information from your local server with that of the LDAP server so that you have the most current security information. If you perform an Import operation. LDAP Synchronization Schedule Settings Sets the schedule settings to your requirement. Then. When an LDAP user account is automatically imported (the Enable Auto-Import of Users from LDAP Server option in the Server tab has been checked). Corresponding Role Name Specifies the corresponding role to which you want to assign the matching users. it will automatically be added to a specific role (specified by the Corresponding Role Name).Enables the LDAP synchronization schedule task. q q Role Map This tab allows you to pre-define a role map for the imported LDAP users. A role map consists of two parts: Search Filter String and Corresponding Role Name. q q q . Edit Edits the synchronization schedule task. When an imported LDAP user account matches the filter condition (specified by the Search Filter String). q Search Filter String Specifies the search filter criteria. q Disable Disables the LDAP synchronization schedule task. Detail Lists information about the last run synchronization task. You can create more than one role map. Create New Role Map Creates a new role map. Save Creates a role map and exits the dialog. JReport Server can automatically assign it to specific roles according to the pre-defined role map. Test Tests the contents of the filter. The results of the test do not affect the creation of the new role map. Test Tests the contents of the filter. .q Cancel Cancels the settings. Delete Deletes the specified role map. Edit Edits the specified font map. E-mail Address Specifies the address of the e-mail sender.Export panel This panel allows you to configure the default settings for exporting report results in JReport Server. It is divided into three tabs: q E-mail tab Fax tab Layout Precision tab q q Save Saves changes made in this panel. SMTP Server Port Specifies the port where the e-mail server runs. You must specify an address and make sure that the format of the specified address is valid. E-mail tab Configures the default settings for exporting report results to e-mail. Default E-mail Format . The changes will be applied the next time JReport Server starts. Server Requires Authentication This option must be checked if an SMTP Server requires authentication. The options available in this tab are as follows: SMTP Server Specifies the numeric or named host of the machine where the e-mail server is located. Attachment in PostScript Format Sends the report result via e-mail to the specified address with a PostScript file as attachment. Attachment in JReport Result Format Sends the report result via e-mail to the specified address with a JReport result file as attachment. q q . and therefore the result is one PDF file as attachment no matter the Split PDF feature is enabled or not. q q q q q q q q q Compress Attachment as Java Archive Specifies whether or not to compress the mail attachment as Java Archive.Specifies how a published report is sent out by e-mail. If the maximum file size is set to 1. Attachment in XML Format Sends the report result via e-mail to the specified address with an XML file as attachment. then how to split the PDF file depends on the following two aspects: q The separated pages by the before-split PDF file The maximum file size specified for an after-split PDF file q Here the before-split PDF file refers to the big PDF file to be split and an after-split PDF refers to one of the smaller PDF files generated after splitting the big PDF file. the maximum file size helps to decide by which page to split: the page that the maximum size comes to is not included with the previous pages in an after-split file. Attachment in RTF Format Sends the report result via e-mail to the specified address with a RTF file as attachment. Attachment in PDF Format Sends the report result via e-mail to the specified address with a PDF file as attachment. E-mail Result in Plain Text E-mail Format Sends the report result via e-mail to the specified address in plain text format. For example. If you check to use the Split PDF function. When a PDF file is to be split by file size. Attachment in HTML Format Sends the report result via e-mail to the specified address with an HTML file as attachment. The Split PDF function takes effect only when the selected option value is greater than 0. images and so on. The format can be any of the following: q E-mail Result in HTML E-mail Format Sends the report result via e-mail to the specified address in HTML format.5M. Maximum Split PDF File Size (KB) Specifies in KB the largest size each PDF file could have after splitting. Maximum Split PDF File Page Specifies how many pages each PDF file could have at most after splitting. Attachment in Excel Format Sends the report result via e-mail to the specified address with an Excel file as attachment. The report result will be shown in HTML format in the mail body. Notes: q When the before-split PDF file contains only one page. there is a 2M PDF file with 1M per page. The report result will be shown in plain text format in the mail body with no other information such as color. the TOC and Sign options are disabled when scheduling a report result to email in PDF file attachment. we will get two PDF files with each 1M and one page as the split result. the splitting will be carried out based on the pages the file separates but not physically on the maximum file size specified for an after-split PDF file. Attachment in Text Format Sends the report result via e-mail to the specified address with a Text file as attachment. but instead is the beginning page of the following after-split file. the split function will not take effect for the only one page cannot be further split either by file size or by file page. If you choose to split a PDF file by file size. However. you will need to configure your running environment first. Xon/Xoff Flow control of the software.jar javax.0. you should make sure that your modem can support it.0. so if you select Class 2 or Class 2.jar Location <server_install_root>\lib javax. Specifying flow control can help the compressing data function of the modem work better.jinfonet. zip for Win32. <Java_install_root>\jre\bin dll q For Solaris: File Name comm. You can specify to export the report results either via a fax machine or a fax server. The flow control options are as follows: r q q RtsCts Flow control of the hardware (recommended). None No flow control specified. Modem Class Specifies the class of the modem. Flow Control Command r r q . Options are: Class 1.comm.comm. and place the following files in the specified locations: q For Windows: File Name comm.so Location <server_install_root>/lib <Java_install_root>/jre/lib LD_LIBRARY_PATH The following are options available when Fax Machine is checked: q Dialing Specifies the dialing mode for the fax modem. Fax Machine JReport supports exporting report results to fax. <Java_install_root>\jre\lib properties Win32Com. Flow Control Specifies the flow control mode between DTE (Data Terminal Equipment) and DCE (Data Circuit-terminating Equipment).jinfonet.Fax tab Configures the default settings for exporting report results to fax.properties libSolarisSerialParallel. If you want to use this feature.com/download/third_party_tool/ JavaCommAPIV2_Solaris.com/download/third_party_tool/JavaCommAPIV2_Win32. Options are: Pulse or Tone.zip for Solaris and http://www. Most modems only support Class 1. All are fax protocols. Download Java Communications API (Version 2. Class 2 or Class 2.0) from the website http://www. Layout Precision tab Configures the precision level for different formats with which the report result will be exported. Timeout Specifies the maximum amount of time that the fax should wait for a response from the destination before timing out. q q q q q q q Retries Specifies the number of times the modem retries faxing the report result.bat in the ADDCLASSPATH variable.0.9. Password Specifies the password for the class communicating with fax server. and then add them to the class path of setenv. Initialization String Initializes the modem. gnu-hylafax-util-0. the report result cannot be faxed.2.jar.2. you can specify the maximum number of times the modem re-tries faxing the report result. gnu-inet-ftp-0.2. however. q q q Fax Server If you choose to export the report results via a fax server. you can leave this field empty and then enter the command as part of the initial string. Login ID Specifies the username for the class communicating with fax server. Note: By default. The string should be obtained from your modem manual. q Server IP Specifies the IP address or domain name of the fax server. It is a limitation of Hylafax Server. Special Parameters Specifies some parameters for the fax server. If not contained in the drop-down list.net/projects/gnu-hylafax/. you need to download the gnu-hylafax packages according to your requirements from http://sourceforge. The port should be obtained from your modem manual. and gnu-hylafax-0. Retries When the line is busy. q Port Specifies the port number. . configure the following settings according to your requirements: q Fax Gateway Connector Specifies the name of the class implemented by users.Specifies the flow control command according to the modem being used. The settings of high/low precision take effect only in the report tabs whose Precision Sensitive property is set to true in the Report Inspector of JReport Designer.jar.9. Time Out Specifies the maximum amount of time that the fax should wait for a response from the destination before timing out. Here. Server Port Specifies the port number of the fax server. Fax Sender Specifies the user's name that shows in the fax server manager.jar.0. Note: For Hylafax Server the value should not be larger than 59 seconds. The command should be obtained from your modem manual. for example. if you want to export your report results via Hylafax Server.0. the fax server JReport uses is based on Hylafax Server.9. . r High If checked. q System Default Settings Pre-defines the default precision for each format.Customize for each format In order for the pre-defined default precision for a format to take effect. the report result will be exported to the specified format with low precision. For formats that are not checked. Low If checked. r Optimize for speed over visual effect If checked. the report result will be exported to the specified format with high precision. the report results will be exported with precision level decided by JReport. Note: The RSD format controls only the DHTML Format in the Schedule dialog. JReport will decide their precision. you need also check the checkbox before the format. xml file in the <install_root>\bin directory.Connection panel This panel is used for retrieving the modified catalog connection information from the datasource.xml file. . The option available in this panel is as follows: Reload Reloads catalog connection information from the datasource. Upload panel This is used for specifying the allowed image size and types for the images which are uploaded from the local file system when end users insert images into reports in JReport Viewer. The changes will be applied the next time JReport Server starts. The options available in this panel are as follows: Image Type Sets the allowed image types. . Save Saves changes made in this panel. If the value is blank. it means that the image size is unlimited. Image Size Sets the allowed image size. q Custom Field table Displays the custom field information. Edit This option is enabled after you select one or more custom fields in the Custom Field table below. q q . q Custom Field Name Displays the name of the custom fields. It contains two operations: q Edit Displays a dialog to edit the information of the selected custom field. Enabled Shows whether the custom fields are enabled or not.Custom Field panel This panel is used for defining and managing user defined fields which can be used as resource properties. Delete Deletes the selected custom fields. The options available in this panel are as follows: New Custom Field Opens the New Custom Field dialog for creating a custom field. Description Displays the description of the custom fields. and PNG. Specify a JSP as Waiting Page . q Enable Customize Loading Status Image Allows to upload a local image to Server as the loading status image appearing in waiting pages. These types of images are supported: GIF. Alignment to Specifies the relative position of the image as compared to tip text in waiting pages. r Loading Status Image File Uploads an image from the local disk. It helps you to customize the waiting screen according to your requirements. JPG. BMP. Customize Format Allows to customize loading status image and tip text font.Customize Waiting Page dialog This dialog is displayed when you click the Customize button in the Profile > Customize Server Preferences > Advanced tab on the JReport Administration page. Server-side File Name This name will be used as the name of the image file after it is uploaded to server. Default Format Applies the default format provided by JReport. r r q Tip Text Font Specifies font face and size and style of tip text in the waiting pages. processing</font></td> </tr> <tr> <td><img src="..Allows customized JSP files to implement the waiting pages. OK Applies the changes and closes the dialog.gif" /></td> </tr> </table> </td> </tr> </table> </div> q File Name This name will be used as the name of the JSP file after it is uploaded to server.. . Cancel Does not retain any changes and closes the dialog. Note that the required JSP file is not exactly a complete JSP but a segment.font-family:Verdana./images/loadingdefault. Help Displays this help document.">waiting.. q JSP File Uploads a JSP from the local disk. Its body can contain only one root <div></div> tags and the non-body section can contain only tags that are allowed in the <body></ body> tags. The following is a sample: <div> <table border="0" cellspacing="0" cellpadding="0" align="center"> <tr> <td valign="middle" align="center"> <table cellpadding="5" cellspacing="0" border="0"> <tr> <td><font style="font-size:12px.. Thumbnails Shows resource thumbnails with information such as names. q q Properties Manages the properties of the current resource. and last modification time. the entry to the following panel is available on the drop-down menu.Dashboard dialog After you click Dashboard on the system toolbar of the JReport Administration page. types. Details Shows resource information in a table such as names. Component Library panel The panel is used for managing component library and the library components in it. The root node is COMPONENT_LIB\. descriptions. The panel helps you to manage library components in the component library. There are three modes: q Icons Shows resource icons with names. controlling options. descriptions. Publish to Local Server Publishes library components to JReport Server locally. View Mode Specifies the mode in which to view resources. and controlling options. . The options available in this panel are as follows: Path Shows the current resource path. last modification time. Publish to Remote Server Publishes library components to JReport Server remotely. Publish to Remote Server Publishes library components to the folder remotely. NLS Editor Manages resource NLS. Publish to Local Server Publishes library components to the folder locally. Resource box Lists the resources in the specified view mode. Controlling options The following are options that can be performed on the resources: q Version Manages resource versions. Cube Security Updates the catalog's report cube. business cube and/or business view permission settings by uploading the updated authorization file from JReport Designer without re-publishing the catalog. Available for catalogs. q q q q q q . Properties Manages resource properties. Delete Deletes the current resource. OK Retains the settings and submits the task to server. . The Properties dialog is divided into the following two tabs: q General Permission q Reset Discards your modifications and restores the dialog to its default status. Resource Path Shows the resource path. Cancel Cancels any settings and closes the dialog. Resource Node Name Specifies the name for the dashboard. Help Displays this help document. Resource Type Shows the type of the resource. General tab Specifies the general properties of the dashboard.Dashboard Properties dialog You can set the properties of a dashboard in its Properties dialog according to your requirements. By default the version amount is unlimited. Available only for versions in the resource tree. This option is available when the Properties dialog is opened from the JReport Administration page. Permission tab Specifies permissions of roles/users/groups to the dashboard. r Maximum Number of Versions Specifies the maximum version amount that will be listed in the version table. Apply Archive Policy Applies an archive policy to the dashboard versions. Available Lists the roles/users/groups to which you can assign permissions.Resource Description Specifies the description for the dashboard. q Archive as New Version Specifies whether to use multiple versions for the dashboard. Enable Setting Permissions Enables the setting of permissions. q Replace Old Version Specifies to replace the old version when a new version is generated. . This tab is available when the dashboard is in the Public Reports folder. National Language Support Specifies whether to enable the NLS feature for the dashboard. Read Specifies whether to give the selected role/user/group the Read permission. Delete. Write. q q Adds the selected roles. all roles will be displayed in the Available box for you to assign permissions. Group If checked. groups or roles that have obtained the Grant permission are also endowed with the other seven permissions . Schedule. Removes the selected roles. all groups will be displayed in the Available box for you to assign permissions. Write Specifies whether to give the selected role/user/group the Write permission. Users. users or groups from the Selected box. Execute. Delete Specifies whether to give the selected role/user/group the Delete permission. and can grant these seven permissions except the Grant permission itself. Read. q q q q q .Visible. Grant Specifies whether to give the selected role/user/group the Grant permission. users and groups to which the permissions will be assigned. all users will be displayed in the Available box for you to assign permissions. users or groups to the Selected box. and Update Status. User If checked.q Role If checked. Execute Specifies whether to give the selected role/user/group the Execute permission. q Visible Specifies whether to give the selected role/user/group the Visible permission. Selected Displays the roles. properties. viewing backup and archive files' summary information. Note: The Profiling DB option is not shown by default on the drop-down menu. In order to make it shown. such as server. Realm DB panel It allows you to manage server data. global NLS.enable property to true in the server. q q . you should set the server. Profiling DB panel It allows you to manage server data. and viewing backup and archive files' summary information. and clearing invalid resource nodes.properties file in the <install_root>\bin directory. The realm database holds information of folders. and the completed table. backing up server data. the security system. such as configuring your profiling database.profiling. The panels help you to configure your databases. the entries to the following panels are available on the drop-down menu.Data dialog After you click Data on the system toolbar of the JReport Administration page. backing up server data. q System DB panel It allows you to configure your system database and backup server data. The system database holds resources of the global server scope. versions. such as configuring your realm database. schedule. archiving/restoring server data. etc. archiving/restoring server data. nodes. System DB panel This panel is displayed when you click Data on the system toolbar of the JReport Administration page and then select System DB from the drop-down menu. It allows you to configure your system database and backup server data. . The following are tabs contained in the panel: q Configuration tab Backup tab q Configuration tab This tab allows you to configure your system database to store server data. Driver Class Location Specifies the path of the JDBC driver. Test Tests whether the JDBC configuration works. Click the Browse button to specify the location for the driver class. User Specifies the JDBC user name for connecting to the database. Backup tab This tab allows you to back up your system database for archiving. . refer to the handbook of the specific driver. Password Specifies the user password. URL Specifies a valid URL that can be used to establish a connection to your database. Driver Specifies the name of the JDBC driver. Update Updates the JDBC configuration and saves it to disk. Cancel Cancels the settings. which means that JReport Server will load the driver from the VM's class path. For the valid format of the URL. It can be null. Backup Begins the backup process. Click the Browse button to specify a file path to store the backup archive. Related topics: q Managing server data .Backup System DB Backups JReport Server's system database to an archive. viewing backup and archive files' summary information. It allows you to manage server data. archiving/restoring server data. such as configuring your realm database. The following are tabs contained in the panel: q Configuration tab Backup tab Archive tab Summary tab Realm DB Check tab q q q q Select Realm Before you can manage the realm database. you need to first select a realm from the drop-down list. .Realm DB panel The panel is displayed when you click Data on the system toolbar of the JReport Administration page and then select Realm DB from the drop-down menu. backing up server data. and clearing invalid resource nodes. Configuration tab This tab allows you to configure your realm database to store server data. URL Specifies a valid URL that can be used to establish a connection to your database. Test Tests whether the JDBC configuration works. Password Specifies the user password. For the valid format of the URL. which means that JReport Server will load the driver from the VM's class path. Driver Specifies the name of the JDBC driver. refer to the handbook of the specific driver. It can be null. User Specifies the JDBC user name for connecting to the database. .Driver Class Location Specifies the path of the JDBC driver. Click the Browse button to specify the location for the driver class. Cancel Cancels the settings. . the external data bound with the database will also be archived. Backup Begins the backup process. Backup Realm DB Backups JReport Server's realm database to an archive. only the database will be archived. Archive tab This tab allows you to archive the result version data in an archive file. Otherwise. With External Data If it is checked.Update Updates the JDBC configuration and saves it to disk. Backup tab This tab allows you to back up your system's database for archiving. Click the Browse button to specify a file path to store the backup archive. q Restore from Archive . The range is defined using date. Move to Archive Data Before Specifies the range of data that you want to archive. Records Count Displays the number of sets of result version data in the database. you then have the option to restore it.Archive Result Version Data q Data Scope Displays the result version data range. for example. you can archive data before a certain date. Click the Browse button to specify the file path for storing the archived data. Archive Begins the archiving process. q q q Restore Result Version Data After data has been saved to an archive file. Specifies the archive file that contains the archived result version data. q Restore Begins the restoring process. Realm DB Check tab This tab allows you to clear invalid resource nodes from JReport Server. Summary tab This tab allows you to view the archive files' summary information. Archive Specifies the name of the archive from which you want to retrieve summary information. Click the Browse button to specify the archive. Summary Begins the summary process and returns summary information about the specified archive. . Click the Browse button to specify the archive file. Related topics: q Managing server data . Invalid nodes should be cleared from JReport Server. Invalid Dynamic Nodes Displays all invalid resource nodes in the database.Check Checks whether there are any resource nodes that have lost external data. the resource nodes will become invalid. If any corresponding files (the resource's external data) have been manually deleted. Cancel Cancels the operation. Delete Deletes the specified invalid resource nodes. Configuration tab This tab allows you to configure your profiling database to store server data. It allows you to manage server data. you need to first select a realm from the drop-down list. . such as configuring your profiling database. archiving/restoring server data. and viewing backup and archive files' summary information. backing up server data. The following are tabs contained in the panel: q Configuration tab Backup tab Archive tab Summary tab q q q Select Realm Before you can manage the profile database.Profiling DB panel This panel is displayed when you click Data on the system toolbar of the JReport Administration page and then select Profiling DB from the drop-down menu. It can be null. User Specifies the JDBC user name for connecting to the database. Test Tests whether the JDBC configuration works. Update .Driver Class Location Specifies the path of the JDBC driver. URL Specifies a valid URL that can be used to establish a connection to your database. For the valid format of the URL. Click the Browse button to specify the location for the driver class. which means that JReport Server will load the driver from the VM's class path. Password Specifies the user password. refer to the handbook of the specific driver. Driver Specifies the name of the JDBC driver. Backup Begins the backup process.Updates the JDBC configuration and saves it to disk. Backup Profiling DB Backups JReport Server's profiling database to an archive. Archive tab This tab allows you to archive the result version data in an archive file. Backup tab This tab allows you to back up your system's database for archiving. . Cancel Cancels the settings. Click the Browse button to specify a file path to store the backup archive. Click the Browse button to specify the file path for storing the archived data. . you then have the option to restore it.Archive Profiling Data q Data Scope Displays the result version data range. Archive Begins the archiving process. Records Count Displays the number of sets of result version data in the database. for example. q q q Restore Profiling Data After data has been saved to an archive file. Move to Archive Data Before Specifies the range of data that you want to archive. you can archive data before a certain date. The range is defined using date. Click the Browse button to specify the archive. Click the Browse button to specify the archive file. Archive Specifies the name of the archive from which you want to retrieve summary information.q Restore from Archive Specifies the archive file that contains the archived result version data. q Summary tab This tab allows you to view the archive files' summary information. Restore Begins the restoring process. Summary Begins the summary process and returns summary information about the specified archive. Related topics: q Managing server data . DHTML Profile dialog This dialog is displayed when you click the New Profile link in the Profile > Configure DHTML Profile > Features tab on the JReport Administration page. Basic tab In this tab. you can turn on/off the required basic DHTML features for the profile. Description Specifies information about the new profile. DHTML Profile Name Specifies the name for the new profile. q Save Specifies to enable the Save feature which allows you to save the report result as a version. It helps you to create profiles for applying in running reports in DHTML. . which allows you to sort records in the data buffer by certain fields. which allows you to select to show certain groups of records in a banded object. Style Specifies to enable the Style feature. which allows you to set page properties. which allows you to zoom in on your report. Navigation Specifies to enable the Navigation feature. Sort Specifies to enable the Sort feature. which allows you to open/hide some report tabs in a report. Go to Specifies to enable the Go to feature. Reset Specifies to enable the Reset feature. which allows you to apply a filter a the business/report cube by certain component. . Refresh Specifies to enable the Refresh feature. you can turn on/off the required advanced DHTML features for the profile. Help Specifies to enable the Help feature. which allows you to search for the required data in a report. q Query Filter Specifies to enable the Query Filter feature. which allows you to print the report data. Printable Version Specifies to enable the Print feature. which allows you to access the index page of JReport Viewer help documents with the Help button. which allows you to reload the report data. Open Specifies to enable the Open Report Tab feature. Filter Specifies to enable the Filter feature. q q q q q q q q q q q q q q q q q Advanced tab In this tab. which allows you to export your report result for exchange purposes. which allows you to set the maximum number of records retrieved by all components in the report. Max Records Specifies to enable the Max Records feature.q Save as Specifies to enable the Save As feature which allows you to save the current report as another file. which allows you to change the skin of the DHTML window. which allows you to filter report data according to your filter conditions. Zoom Specifies to enable the Zoom feature. which allows you to undo/redo previous operations. Undo/Redo Specifies to enable the Undo/Redo feature. which allows you to use styles in your report. Export Specifies to enable the Export feature. which allows you to navigate through the report pages. Page Setup Specifies to enable the Page Setup feature. Change Skin Specifies to enable the Change Skin feature. which allows you to reset your DHTML window and load page defaults. Search Specifies to enable the Search feature. which allows you to merge several cells in a tabular. Toolbox Specifies to enable the Toolbox feature. Merge Specifies to enable the Merge feature. Insert/Remove Specifies to enable the Insert/Remove feature. you can change the order of group levels in a table/crosstab. which allows you to insert/remove objects in a report. which allows you to change the position of an object. which allows you to rotate the selected crosstab. Grid Specifies to enable the Grid feature. If the feature is disabled. With this feature enabled. Move Specifies to enable the Move feature.q To Chart Specifies to enable the To Chart feature. for example. q User Information Bar Specifies to enable the User Information Bar feature. the editing mark will not be shown when a report object receives focus. To Crosstab Specifies to enable the To Crosstab feature. which allows you to resize an object. Split Specifies to enable the Split feature. catalog. Rotate Specifies to enable the Rotate feature. which allows you to turn a crosstab to a chart. and so on. which allows you to show or hide the dashed borders of some components and the report body. which allows you to change the structure of a table. which allows you to split a cell in a tabular. which helps you in laying out objects in a report. which allows you to change the type of a chart. which allows you to use the Toolbox to insert a component into your report. and report objects cannot be moved or resized. Editing Marks Specifies whether or not to enable the Editing Marks feature. Resize Specifies to enable the Resize feature. you can show or hide the required DHTML window elements for the profile. q q q q q q q q q q q q q q q Function Visibility tab In this tab. which allows you to insert a cube element into your report. Resource View Specifies to enable the Resource View feature. which allows you to select to show certain groups of records in a crosstab. which allows you create a new report using a DHTML window with existing queries. you may view information about the user. Drill Specifies to enable the Drill feature. change the order of columns in a table. and report by clicking the User Information button in JReport Viewer. Chart Type Specifies to enable the Chart Type feature. . New Specifies to enable the New Report feature. Pivot Specifies to enable the Pivot feature. which allows you to turn a chart to a crosstab. and crosstab. Drill Specifies to show the Drill command on the right-click menu. Go to Specifies to show the Go to command on the right-click menu. Toolbar Specifies to enable the Toolbar feature.q Page Report Bar Specifies to enable the Page Report Bar feature. you can further specify the commands on the right-click menu. Rotate Specifies to show the Rotate command on the right-click menu. Table of Contents Specifies to enable the Table of Contents feature. which allows you to change the type a chart. Chart Type Specifies to show the Chart Type command on the right-click menu. This feature allows you to specify whether to show the page report bar. Right-click Menu Specifies to enable the Right-click Menu feature. which allows you to convert a crosstab to r r r r r r r r r r r . Reset Specifies to show the Reset command on the right-click menu. which allows you to sort records in the data buffer by certain fields. which allows you to select to show certain groups of records in a banded object. which allows you to show/hide the selected object. which allows you to rotate the selected crosstab. which allows you to select to show certain groups of records in a crosstab. which allows you to reload the report data. which allows you to reset your DHTML window and load page defaults. If this feature is enabled. which allows you to search for the required information in a report. Refresh Specifies to show the Refresh command on the right-click menu. Search Specifies to show the Search command on the right-click menu. r q q q q Display Name Specifies to show the object display name on the right-click menu. which allows you to access DHTML features by providing you with menu commands. To Chart Specifies to show the To Chart command on the right-click menu. Menu Specifies to enable the Menu feature. which allows you to navigate around in the report using the TOC Browser. which allows you to filter report data according to your filter conditions. Show/Hide Specifies to show the Show/Hide command on the right-click menu. Filter Specifies to show the Filter command on the right-click menu. Sort Specifies to show the Sort command on the right-click menu. which allows you to open the detail report. which allows you to convert a chart to a crosstab. which allows you to configure the properties of the selected object. Delete Specifies to show the Delete command on the right-click menu. r r r r r r r Select All Has all options in the tabs checked. Detail Report Specifies to show the Detail Report command on the right-click menu. Cancel Cancels creating the profile and leaves the dialog. Query Filter Specifies to show the Query Filter command on the right-click menu. .a chart. Link Report Specifies to show the Link Report command on the right-click menu. Select None Has all options in the tabs unchecked. OK Finishes creating the profile and leaves the dialog. Properties Specifies to show the Properties command on the right-click menu. r To Crosstab Specifies to show the To Crosstab command on the right-click menu. Expand Data Specifies to show the Expand Data command on the right-click menu. which allows you delete the selected object from a report. Help Displays this help document. which allows you to apply a filter to the business/report cube used by the selected component. which allows you to apply a style to the selected component. Style Specifies to show the Apply Style command on the right-click menu. which allows you to open the linked report. which allows you to expand data of a crosstab or group. . The current expression is displayed at the top of the dialog. Edit it directly in the text field.Edit Expression dialog The dialog is displayed when you click the button in the Expression dialog. It provides some builtin functions of the Date/Time type for you to edit a template expression to create your own expression. Cancel Does not retain any changes and closes the dialog. For details about the functions. see Date/Time in the Formula Reference chapter of the JReport Designer User's Guide. OK Saves the expression and closes the dialog. Help Displays this help document. you can insert a function into the expression by double-clicking it from the built-in function list below. If required. . Encrypt dialog This dialog is displayed when you click the Setting button next to the Encrypt option while configuring settings for advanced running/publishing a report in PDF format. while the other option Acrobat 5.0 and later uses a high encryption level (128-bit RC4). Encryption Level Shows the level of the encryption compatibility that you specified in the Compatibility drop-down list. The option Acrobat 3. The following are details about the options in the dialog: Compatibility Specifies the encryption type from the two types that are provided here in order to encrypt a PDF document.0 and later uses a low encryption level (40-bit RC4). Require a password to open the document . . The password you specify here cannot be the same as the one that you use to open the document. Enable text access for screen reader devices for the visually impaired Allows visually impaired users to read the PDF document with window readers. q Permissions Password Specifies the password to prevent others from printing and editing.0 or later Acrobat version. q q q Enable copying of text. OK Saves the settings and exits the dialog. images and other content Allows others to select and copy the contents of the PDF document. Confirm Password Confirms the password you have specified in the Document Open Password text box. This option is available only if the Compatibility option is set to Acrobat 5. q Document Open Password Specifies the password to prevent others from opening the document without authorization. Printing Allowed Specifies the printing quality for the PDF document. Help Displays this help document.Specifies the Document Open Password to prevent others from opening the document without authorization. q Use a password to restrict printing and editing of the document and its security settings Specifies the Permission Password to prevent others from printing and editing the document. Confirm Password Confirms the password you have specified in the Permissions Password text box. Changes Allowed Specifies the editing actions that are permitted in the PDF document. Cancel Cancels the settings and closes the dialog. Adds all the selected values from the Available Values box to the Selected Values box. Removes the selected values from the Selected Values box. It helps you Available Values Lists all predefined parameter values for selection. values of the Display Column are listed here. but the Display Column is different from the Bind Column. Adds the selected values from the Available Values box to the Selected Values box. while specifying parameter values. .Enter Values dialog The dialog is displayed when you click the button to specify multiple values for a parameter. Selected Values Lists the values selected. The selected values are case sensitive. When the parameter is bound with a column. All If selected. CUSTOMERID>0 and CUSTOMERS.CUSTOMERNAME FROM CUSTOMERS where CUSTOMERS. it means that the parameter value result is all the values in the DBMS. 2 and 3 as the parameter values.2.CUSTOMERID.Removes all the selected values from the Selected Values box. when the parameter query is: SELECT CUSTOMERS.3)) Run the same report again and this time check the All checkbox in the Enter Values dialog. which are all the available values. This is translated in SQL to remove the parameter which may select more values than listed in the available values list. Enter a value manually in the text box and then click the button next to add the value to the Selected Values box.CUSTOMERID IN ( 1. Enter Values This option is available when the parameter's Allow Type-in of Value property is set to true in JReport Designer. Help Displays this help document. the field will show the string "All" which represents all the values in the DBMS.CUSTOMERID<4 When you click SQL is: to add 1.CUSTOMERS. . Note: When a multi-value parameter is inserted as a field into a report and All is selected as the value. When the parameter is bound with a column. the query is then: ( 1 = 1) In this case. Cancel Does not retain any changes and closes the dialog. make sure the value you enter is that of the bind column. OK Applies the selected values to the parameter and closes the dialog. you will get more customers even though available values are only 1 – 3. the (CUSTOMERS. This option is available when the parameter's Enable the "All" Option property is set to true in JReport Designer. but the display column is different from the bind column. For example. It helps you to specify a dynamic date or time parameter value with expression.Expression dialog The dialog is displayed when you click the button while specifying parameter values of Date. DateTime. Result Displays the value result based on the specified expression. which provides some built-in functions of the Date/Time type for you to edit a template expression. or Time format. You can edit it directly in the text box to create your own expression. or gives error information if the expression is not correct. . q Opens the Edit Expression dialog. Expression Displays the expression. Template Specifies the expression template on which to edit your expression. . Help Displays this help document. Cancel Does not retain any changes and closes the dialog. Note: The expression function does not support binding-column parameters or multi-value parameters.OK Sets the expression as the parameter value. Help Displays this help document.Folder Properties dialog You can set the properties of a selected folder in its Properties dialog according to your requirements. . Cancel Cancels any settings and closes the dialog. OK Retains the settings and submits the task to server. The Properties dialog is divided into the following two tabs: q General Permission q Reset Discards your modifications and restores the dialog to its default status. General tab Specifies the general properties of the folder. Last Modified Shows the last time the folder was modified. Resource Real Path Specifies the real path of the folder. the reports and sub folders resided in the folder cannot inherit linked catalog. Resource Type Shows the type of the resource. Once checked. Note that if the parent level does not enable linked catalog. Enable Resources from Real Paths Specifies whether or not to enable getting resources from the folder real path. A custom field can be regarded as a resource property and is available when it is enabled. r Maximum Number of Versions Specifies the maximum version amount that will be listed in the version table. This option is disabled in cluster environment. you are not allowed to check this option. q Archive as New Version Specifies to use multiple versions for the resources. q Replace Old Version Specifies to replace the old version when a new version is generated. then the reports and sub folders resided in the folder can inherit the linked catalog from the folder once their Enable Linked Catalog property is enabled. Permission tab Specifies permissions of roles/users/groups to the folder. q Use Inherited Links the folder with the linked catalog inherited from its parent folder or from the server level if the folder is My Reports or Public Reports. Enable Linked Catalog Enables to link the folder with a catalog. Resource Node Name Specifies the name for the folder. Resource Description Specifies description of the folder. r Select Another Catalog Specifies another catalog in the Select Another Catalog dialog. By default the version amount is unlimited. q Use Specified Links the folder with a catalog in the server resource tree. Note: This option can only be checked when the Enable Resources from Real Paths option in the Configuration > Advanced panel on the JReport Administration page has also been checked. This tab is available when the folder is in the Public Reports folder. Apply Archive Policy Applies an archive policy to resource versions in the folder. .Resource Path Shows the resource path. If this option is unchecked. it is required that you specify a real path in the Resource Real Path field. Available only for versions in the resource tree. If you have specified a linked catalog for the folder. [Custom Field Name] Specifies value of the custom field for the folder. This option is disabled in cluster environment. This option is available when the Properties dialog is accessed from the JReport Administration page. users and groups to which the permissions will be assigned. Write Specifies whether to give the selected role/user/group the Write permission. Selected Displays the roles. q q .Enable Setting Permissions Enables the setting of permissions. users or groups to the Selected box. q Role If checked. Read Specifies whether to give the selected role/user/group the Read permission. Removes the selected roles. User If checked. Available Lists the roles/users/groups to which you can assign permissions. all roles will be displayed in the Available box for you to assign permissions. all groups will be displayed in the Available box for you to assign permissions. Group If checked. q q Adds the selected roles. q Visible Specifies whether to give the selected role/user/group the Visible permission. users or groups from the Selected box. all users will be displayed in the Available box for you to assign permissions. and can grant these seven permissions except the Grant permission itself. Execute. Read. Write. Execute Specifies whether to give the selected role/user/group the Execute permission. Schedule. Users. Grant Specifies whether to give the selected role/user/group the Grant permission. groups or roles that have obtained the Grant permission are also endowed with the other seven permissions .Visible. Update Status Specifies whether to give the selected role/user/group the Update Status permission. Schedule Specifies whether to give the selected role/user/group the Schedule permission. Delete. and Update Status.q Delete Specifies whether to give the selected role/user/group the Delete permission. q q q q . It helps you to create global NLS resources which can be used globally for all reports in both JReport Server and JReport Designer. Language Specifies the languages into which the display text will be translated. q Displays the current page number. You can also input a page number in the page box and press Enter on the keyboard to go to that page. Removes the selected language from the Language box. The results will be paged and listed in the table below. Display tab Specifies the translation version of the display text in the target language. Opens the Select Language Source dialog to choose where to add a language. .Global NLS dialog This dialog is displayed when you click Reports > Global NLS on the JReport Administration page. q Search Searches for the Key and Translation items that match the search condition in the Search text box. Here you are not allowed to search wildcards. q Specifies to add a new row of font for the target language. q q Specifies to add a new row of display for the target language. Choose from the drop-down lists the font face and font size for the key. TOC Type of display text on the TOC tree. r q q q Use Relative Font Size Specifies to use a relative font size. q Specifies to remove the selected rows of display for the target language. r q q Label Type of display text of label and some web controls. Check the checkbox on the column header to select all the items. Column This type is only for DHTML. Key Specifies keys to indicate the fonts in the original language. Check the checkbox on the column header to select all the items. Prompt Type of display text of parameter prompt value. q Goes to the next page. q Checkbox Specifies to select the font item. r r r q Key Lists keys to indicate the objects in the original language. Font Face Specifies the font face for the key in the target language. Type Specifies the type of display text for different objects. q Goes to the last page. q .q Goes to the first page. Checkbox Specifies to select the display item. Font tab Specifies font properties for the target language. It is the type of display text of columns. q Specifies how many lines will be displayed in each page. q Goes to the previous page. Font Size Specifies the font size for the key in the target language. Translate Specifies to which the display text will be translated in the target language. which means the font size can be adjusted according to the font size settings in the web browser. Help Displays this help document.Specifies to remove the selected rows of font for the target language. OK Applies the settings and closes the dialog. . Cancel Cancels the settings and exits the dialog. Resource Path Shows the resource path. . Resource Node Name Specifies the name for the library component.Library Component Properties dialog You can set the properties of a library component in its Properties dialog according to your requirements. Resource Description Specifies description of the library component. r Select Another Catalog Specifies another catalog in the Select Another Catalog dialog. q Use Inherited Links the library component with the linked catalog inherited from its parent folder or from the server level if the folder is My Reports or Public Reports. If you have linked a library component with a catalog. Maximum Number of Versions Specifies the maximum version amount that will be listed in the version table. Reset Discards your modifications and restores the dialog to its default status. Cancel Cancels any settings and closes the dialog. Set Permissions Opens the Set Permissions dialog for you to specify which users can perform what operations on the library component. Enable Linked Catalog Enables to link the library component with a catalog in a folder within the component library.Resource Type Shows the type of the resource. OK Closes this dialog and applies the properties to the library component. By default the version amount is unlimited. Note that if the parent level does not enable linked catalog. then even if the library component and the catalog are not in the same directory. it also can be run with the catalog. you are not allowed to check this option. . National Language Support Specifies whether to enable the NLS feature for the library component. q Use Specified Links the library component with a catalog in the component library. .New Cache dialog for scheduling The dialog is displayed when you click the OK button in the New Cache dialog for selecting queries. Next Goes to the next tab. you first need to configure the settings in this tab. It helps you to define the updating policy of the data caches created based on the selected queries. Set the settings in each tab according to your requirements. Finish Applies the settings. Cancel Cancels any settings and returns to the New Cache dialog for selecting queries. General tab Before you can schedule a CRD task. Help Displays this help document. q General tab Conditions tab Notification tab Duration tab q q q Back Goes back to the previous tab. This dialog contains the tabs listed below. If the query resource does not have parameters. which is available when the parameter's Allow Multiple Values property is set to true in JReport Designer. q . Click the button . Select a query resource from the drop-down list and then specify the parameter values for it in the Enter Parameters section below if required.Enter Parameters section Specifies the parameter values for the listed query resources. "No Parameter Needed" will be displayed here. You may specify parameter values in the following ways: q In the parameter value combo boxes input the values manually or select them from the drop-down lists. Specify multiple values in the Enter Values dialog. Enter Parameters Specifies values of the parameters applied in the selected query resource. Select Query Lists all the query resources you selected in the New Cache dialog for selecting queries. q Add TaskListener to be Invoked Enables you to call the Java application before/after viewing or when scheduling the task. Connect to [Data Source Name] Specifies the DB user and password with which you want to connect to the data source. The latest version is used by default. By default this property is ignored unless server. Name Displays the name of the selected query resource. The priority levels are from 1 to 10 in ascending order of lowest priority to highest priority. This property is available to administrators. the default values will be applied. specify another DB user and password instead of the one defined in the catalog. check the checkbox ahead of the button and then click the button to specify a dynamic date or time parameter value using an expression in the Expression dialog. the DB user and password defined in the catalog will be used. Cached Report Data Info section Specifies the data cache information. to set a DateTime value using the q If the parameter is of Date. q Use the DB user and password defined in catalog If checked. Catalog Displays the catalog information. Recreate All Results q q .properties is modified to set queue.q If the parameter is of DateTime type. DateTime. Data Source Displays the data source name. Enable Auto Recover Task Specifies to enable the task to be auto recovered. Advanced section Configures some advanced settings. If no parameter values are specified. q Maximum Retry Times Specifies the maximum number of times in which to retry running the task in order to recover it.policy not equal to 0. Priority Specifies a priority level to the scheduling task. Retry Interval Specifies the interval between retries. Type Displays the type of the query resource. It is also used as the name of the new data cache. click the calendar button calendar. Use the DB User If checked. or Time type. It contains the following two sub tabs: q Time tab Trigger tab q Time tab The Time tab allows you to set settings for specifying the time for when a task is to be performed. .Specifies whether to recreate all or just the failed results. Time Zone Specifies the time zone. Conditions tab The Conditions tab allows you to specify the conditions for the task. Monday.. or on the first Sunday. Time Specifies the time for when the task will be run. s s . You can specify the date by clicking the calendar button .Time Type Specifies the time type of the task. and on Sunday. r Duration s Run after Specifies the start date and time of the period during which the task is to be performed on a repeated basis. r Date Specifies the date for when the task will be run. second day. etc. two days. etc. s Never The new task never expires. s r Date Specifies the date for when a task is to be performed. Monthly Performs the task every one month. If the option is checked. Weekly Performs the task every one week. etc. etc. At Specifies a specific time on a selected day when the task expires. two weeks. Monday. etc. two months. r Do not start schedule until the report is requested This option is used to freeze the way of automatically performing the schedule and change it to the schedule being fired upon certain condition. or every weekday (from Monday to Friday). r Expires Specifies when the task expires. the schedule will be fired only upon the first report running request based on the query after each scheduled time. r r q Run this task periodically Specifies the time for when the task is to be performed on a repeated basis.. on the first day. the schedule will be performed automatically according to the time condition... Tuesday. After Specifies a time period after that the task expires. s Daily Performs the task every one day. Run missed task upon Server restart Specifies to run missed tasks when you restart the server. Run until Specifies the end date and time of the period during which the task is to be performed on a repeated basis. q Run this task immediately Performs the task as soon as you submit it. etc. s s q Run this task at Specifies the time for when the task is to be performed once. If the option is not checked. s s r Expires Specifies the expiration time for how long to keep the scheduled data caches.r Time Specifies the exact time for when a task is to be performed on a selected day. Conflict Check Checks if the name has been used for another trigger. At Specifies a specific time when the data caches will expire. etc. q Trigger Name Specifies the name of the trigger. q . Minutely Performs the task every one minute. After Specifies a period of time after which the data caches will expire. Create New Creates a new trigger.. two hours. etc. Hourly Performs the task every one hour. at a certain minute on a selected day. Select a trigger to bind Specifies the trigger from the drop-down list for the task. s Never The data caches will not expire. Trigger tab The Trigger tab allows you to set settings for specifying a trigger for the task. s At Specifies a specific time for when to perform a task on a selected day. two minutes. s s r Run missed task upon server restart Specifies to run missed tasks when you restart the server. the task will be regarded as expired and will be deleted. . you must check the checkbox Run missed task upon Server restart. Trigger and Time Condition Performs the task when both time condition and trigger condition are ready.q Description Specifies the description of the trigger (if required). Time Condition or Trigger Performs the task when either the time condition or the trigger condition is ready. Notes: r q No matter which condition is ready. otherwise the task will be regarded as expired and will be deleted when the time condition is ready before the trigger condition. q Trigger Only Performs the task only when the trigger fires. the task can only be performed when its counterpart is ready. q q Logic with time condition Specifies the logic between time condition and trigger condition. q Notification tab The Notification tab allows you to notify someone by e-mail when a task has finished running. Cancel Cancels the trigger creating process. If you specify the task to be performed at a specific time. OK Creates the trigger with the specified information. regardless of whether it was successful or unsuccessful. The trigger condition must be ready before the time condition. r q Time Condition after Trigger Performs a task when both the time condition and the trigger condition are ready. If the time condition is ready before the trigger condition. When task is successful Specifies to send an e-mail when the task is successful. you can specify a time duration for a task. Duration tab This tab is available only when you have enabled the task-level timeout mechanism either by setting the task. Cc Specifies the address you want to copy to. and ask JReport Server to cancel the task or to notify you or someone else of the task status via e-mail if the task has not yet finished running when the task . When task fails Specifies to send an e-mail when the task is unsuccessful.properties file or by checking the Enable Task Duration option in the Configuration > Advanced panel on the JReport Administration page. In this tab. Subject Specifies the subject of the e-mail. Bcc Specifies the address you want to secretly copy to. duration.enable property to true in the server. Comments Specifies the contents of the mail or comments to the contents. To Specifies the address you want to send the e-mail to. The following are the available options: Timeout Specifies the time duration for the task. Cancel the task after the specified time Cancels the task when the specified time is up. Notify by e-mail after the specified time Sends an e-mail about the task information when the specified time is up. q Mail To Specifies the e-mail address of the recipient.duration is up. . Select Queries Lists the selected queries. It helps you to select queries which you will create data caches for.New Cache dialog for selecting queries The dialog is displayed when you click the New Cache link in the Cached Data > Cached Report Data panel on the JReport Administration page. You can click the button to open the Select Folder dialog for selecting the folder. OK Redirects to the New Cache dialog for scheduling. Select a Folder Specifies the folder in the server resource tree that contains the required catalog. q Opens the Select Queries dialog to select the queries that you are going to create data caches for. Select a Catalog Specifies the catalog in the folder. q Removes the selected queries. Cancel . Help Displays this help document.Does not retain any changes and closes the dialog. . OK Creates the custom field and exits the dialog. Help Displays this help document. It is used to create user defined fields which can be used as resource properties. Field Description Specifies a description for the custom field. . Cancel Cancels operations and closes the dialog. Enabled Specifies whether to enable the custom field. Custom Field Name Specifies the name for the custom field.New Custom Field dialog This dialog is displayed when you click the New Custom Field link in the Configuration > Custom Field panel on the JReport Administration page. The enabled custom fields are available for showing in the resource properties. full stop and blank space. The group name can contain comma. Parent Group Name Specifies the parent group for the new group. .New Group dialog This dialog is displayed when you click the Create a New Group link in the Security > Group panel on the JReport Administration page. Group Name Specifies the name for the new group. Cancel Cancels operations and closes the dialog. Privileges Specifies whether the new group has the following privileges: q Publish The privilege of publishing resources to JReport Server. Advanced Properties The privilege of viewing advanced version properties information.Description Specifies the description for the new group. . q q OK Creates a group with the information you have specified. such as catalog connections and report related resources. Message Table Manipulation The privilege of mapping fields from different data sources in a dashboard. Scheme Specifies the scheme of the new realm. It can be one of the following: .New Realm dialog This dialog is displayed when you click the Create a New Realm link in the Security > Realm panel on the JReport Administration page. Realm Name Specifies the name of the new realm. q Basic Authentication Specifies to use the Base64 method (re-conversion is easy). . Cancel Cancels all operations and closes the dialog. q OK Creates a realm with the information you have specified. Digest Authentication Specifies to use the MD5 digest method (re-conversion is impossible). The role name can contain comma. Parent Role Name Specifies the parent role for the new role. .New Role dialog This dialog is displayed when you click the Create a New Role link in the Security > Role panel on the JReport Administration page. Role Name Specifies the name for the new role. full stop and blank space. . such as catalog connections and report related resources. Privileges Specifies whether the new role has the following privileges: q Publish The privilege of publishing resources to JReport Server.Description Specifies the description for the new role. Cancel Cancels operations and closes the dialog. Message Table Manipulation The privilege of mapping fields from different data sources in a dashboard. q q OK Creates a role with the information you have specified. Advanced Properties The privilege of viewing advanced version properties information. q Report in Displays the folder path. q Select Script File . Select a Catalog Specifies the catalog file in which the report is. q q q Import Script to Create Schedule Specifies to create the schedule task on an imported script file.New Schedule dialog This dialog is displayed when you click New Schedule on the task bar of the My Tasks page on the JReport Console page. Select Report to Create Schedule Specifies to create the schedule task on an existing report. It helps you to create a new schedule task. Select a Report Specifies the report on which the schedule task will be created. Select a Folder Specifies the folder in which the report is. Click the Browse button to select the script file. the Schedule dialog will be displayed.Specifies the script file on which the schedule task will be created. OK Creates the schedule task. Help Displays this help document. . q If you specify to create the schedule task on an existing report. when you click OK. If the schedule task is created on a script file. q Cancel Cancels the operations. the Edit Script dialog will be displayed for you to further edit the task information imported from the script file. Specify the settings according to your requirement to finish the task. when you click OK. full stop and blank space.New User dialog This dialog is displayed when you click the Create a New User link in the Security > User panel on the JReport Administration page. The user name can contain comma. . Full Name Specifies the full name for the new user. User Name Specifies the name for the new user. the user account will be disabled for the time being. Advanced Properties The privilege of viewing advanced version properties information. q Password Length Specifies the length of the password. E-mail Specifies the e-mail address of the new user. such as catalog connections and report related resources. The number you specify here should be between 0 and 20. q Permit Blank Specifies that the password can be blank. q Privileges Specifies whether the newly created user has the following privileges: q Publish The privilege of publishing resources to JReport Server. Account Disabled If this is checked. Expires in N days Specifies a period of time during which the password is valid. Password Specifies the password of the new user.Description Specifies the description for the new user. . Message Table Manipulation The privilege of mapping fields from different data sources in a dashboard. Password Life Specifies the validity period of the password. Confirm Password Confirms the password by typing it in again. q Never Expires The password will not expire. q q OK Creates the user with the information you have specified. Cancel Cancels operations and closes the dialog. Minimum Length Specifies the minimum number of characters that can be used in the password. . NLS Editor dialog This dialog is displayed when you click the NLS Editor button in the Control column of a report on the JReport Administration page. Report Displays the name of the report. Edit Subreport's NLS Specifies to edit each subreport's NLS. . It helps you to edit NLS for the specified report. The method of editing NLS for a subreport is just the same as that for a primary report. Removes the selected language from the Language box. q Key . Language Lists the languages into which the display text in the report will be translated. r r r q Key Lists keys to indicate the objects in the original language. another dialog will appear showing all the subreports of the current report. q Removes the selected rows of display for the target language. If you cannot find the language you need. It is the type of display text of columns. Catalog Displays the catalog that the report uses. Format tab Specifies the format for all fields in the report. r Label Type of display text of label and some web controls. TOC Type of display text on the TOC tree. Display Tab Specifies the translation version of every display text in the report. Opens the Add Language dialog to add languages for editing here. Select Another Catalog Specifies another catalog for the report in the Select Another Catalog dialog. just click the Edit NLS link for it in the dialog. Prompt Type of display text of parameter prompt value. q q Adds available display text in the object of the report for the target language. q Type Lists types of display text for different objects. Column This type is only for DHTML. To edit a subreport's NLS. Catalog Version Specifies the catalog version. click above the box to add it.When you click this button. Report Version Specifies the report version to apply the NLS settings. Translate Specifies to which the display text will be translated in the target language. Add to Global NLS Specifies to add the selected display/font items to the target language's global NLS resource library. q q q Adds available fonts in the object of the report for the target language. Fetch from Global NLS Fetches the translation/properties for the selected display/font items from the target language's global NLS resource library if there are any. q Removes the selected rows of font for the target language. Cancel Cancels the settings and exits the dialog. q Removes the selected rows of format for the target language. q Format Specifies the format for every field in the report in the target language. q Adds available formats in the object of the report for the target language. OK Applies the settings and closes the dialog. the Add to Global NLS dialog will pop up for you to either replace the existing global NLS translation with a new one or keep the original corresponding global NLS. q Key Lists font face and font size of all fields in the report in the original language. Font tab Specifies font properties for every field in the report. .Displays formats of all fields in the report in the original language. If some of the items already exist in the global NLS resource library of the target language. Help Displays this help document. Font Face Specifies font face for every field in the report in the target language. Font Size Specifies font size for every field in the report in the target language. OK Submits any changes to JReport Server to allow the customizing of your web pages. the profile settings made on the Administration page will not be able to apply to the Console page whose profile settings have already been saved by clicking the OK button in the Profile dialog. To access this dialog. the admin should ask the corresponding end user to make changes on the Console page directly. Restore Defaults Uses the default settings. Cancel Cancels the settings.Profile dialog The Profile dialog is available on both the JReport Administration and Console pages. Help Displays this help document. while the settings specified on the JReport Administration page will be applied to all users. click Profile on the system toolbar. However. The difference lies in that any settings you specify in the Profile dialog of the JReport Console page will only be applied to the current user. Available only when the Profile dialog is accessed on the JReport Console page. The dialog contains three subjects: q Change Password Customize Server Preferences Configure DHTML Profile q q Reset Resets the settings without refreshing the web pages. . if the admin would like the Console page to adopt the same change as the Administration page. In this case. It is available only when the Profile dialog is accessed on the JReport Console page. Logged In User's Password Specifies the password of the currently logged in user. Confirm New Password Confirms the new password by typing in it again.Change Password This panel allows you to change the password used for logging onto JReport Server. . New Password Specifies the new password. User ID Displays the ID of the current user. Display the Last Logout Time Specifies whether to display the last logout time of a user on the top banner of JReport Server. Keep Completed Tasks for . It contains the following tabs: q General Export Formats Advanced q q General Lists the general options for customizing the JReport Server web pages. If checked. Display the Last Login Time Specifies whether to display the last login time of a user on the top banner of JReport Server.Customize Server Preferences This panel allows you to customize your JReport Server web pages. If the property Default Format for Viewing Report of a report tab or a web report has been set to a specific format when the report is designed in JReport Designer. Pop-up DHTML Window Specifies whether to show a DHTML window when you view a report in DHTML format.properties file in <install_root>\bin after JReport Server shuts down. Default Format for Viewing Report Specifies the default format for viewing reports. Only Display CSS Styles in Style List Specifies whether to display only the CSS styles in the style list.properties file in <install_root>\bin after JReport Server shuts down. the value in Designer has higher priority than the one here. the login time will be recorded in the login. the logout time will be recorded in the logout. If checked. dashboard users will be able to use the menu option Set as Home Page in JDashboard to set the JDashboard status as the home page. This format is available to administrators only. the following option is available: r Zip Result Specifies whether to compress the result and make its size smaller. VBScript format Folder selector is a dialog generated by VBScript. Running. Completed. This option is available on the Internet Explorer browser and applied to local publishment only. Background Tasks. Report Versions. Parameter Display Size Specifies the display length in characters of the parameters that are to be applied to both the completed and active schedules. Catalog Versions. If the value is set to 0. Export Formats Customizes the export formats. Folder Selector Type Specifies the type of the tool used for selecting folder paths from the file system. Enable Setting Dashboard as Home Page Specifies whether to enable dashboard users to set the JDashboard status as home page. Once this option is checked. Then after logging JReport Server using the dashboard port or clicking the Home tab on the system toolbar of the JReprot Console page. . JSP format Folder selector is an HTML page generated by JSP. q q Skin Format Specifies the skin format applied to JReport Server and JReport Viewer UI. Classical and Windows XP. q JReport Result Exports a report to a result file. There are three types of folder selectors: q JavaScript format Folder selector is a dialog generated by JavaScript. and Result Versions. the server will keep the completed tasks until you delete them from the Completed page. Scheduled. You can choose from Standard. the JDashboard will be displayed with the saved status. If yes. Columns Shown in _ List Specifies which columns will be displayed as default in the following list when you log onto JReport Server: Reports. Report Result Versions.Specifies for how many days JReport Server will keep the completed tasks in the Completed list. With the help of reader agent end users can navigate through the server resource to view the target report. . This option is available only when the Profile dialog is accessed on the JReport Administration page. In the accessible version. and table/crosstab components are output as HTML data table. Specify Default Time Zone Specifies the default time zone for JReport Server. See Accessibility for more information. Identify Server Preference Specifies whether a task can be performed on a manually specified clustered server when scheduling a report. All UI text and messages will be displayed in the specified language.q DHTML HTML PDF Excel Text RTF XML PostScript Applet q q q q q q q q Advanced Lists the advance options for customizing the JReport Server web pages. q Reset All Users' Preference Checking this option will reset all users' default language to the one specified here. Click the Customize button to customize waiting pages in the Customize Waiting Page dialog. This option is available only in cluster environment. Use Accessible Version Sets the accessible version of JReport Server as the default portal instead of JReport Console page. All date on the server UI will then be displayed according to the specified time zone. Enable Waiting Page Specifies whether to show the waiting pages. Specify Default Language Specifies an environment language for JReport Server. reports are displayed in the HTML format with accessibility attributes. the oldest lists that exceed the number will be removed.Enable Saving Parameter Values Enables saving parameter values for reuse next time when specifying parameter values in order to run reports. This option is used to control the maximum number of the saved parameter value lists for the report. By default the maximum number is 3. you can save the specified parameter values for the report as a list. Maximum Number of Auto Complete Parameters List When specifying parameter values in order to run or schedule to run a report. If you change the number to a smaller number. . Last Modified Displays the time when the profiles were last modified. Available to administrators only. If you want to customize them. Delete Deletes the selected profile. . If disabled.Configure DHTML Profile This panel allows you to customize DHTML features according to your requirement. click the relevant window buttons or menu commands in JReport Viewer. q Name Displays the names of the profiles. Profile list Lists the DHTML profiles that have been created. Default Profile Specifies the profile which will be used as the default profile to run reports in DHTML. Check the element names to show/hide them. New Profile Opens the DHTML Profile dialog to create profiles for applying in running reports in DHTML. Then end users can further customize the JReport Viewer settings for the profiles on the JReport Console page and then select one of the profiles to apply in running reports in DHTML. the specified window element will not be shown by default. q q Properties The properties are classified in two categories: default properties and advanced properties. Default properties Specifies to show or hide certain DHTML window elements. End users can only select a profile and view its settings. Description Displays the descriptions of the profiles. It contains two tabs: q Features Properties q Features Administrators can define more than one DHTML profile on the JReport Administration page. Some properties are not available when the Profile dialog is accessed on the JReport Console page. log onto the JReport Administration page. Available to administrators only. To show it. The next time the report is opened. Save Sort Criteria Specifies to check the Save Sort Criteria option by default when saving a report to a report version or as a new report. it will be the previous version which was last saved explicitly or the original published version. and report objects cannot be moved or resized. which can be a link report. when this option is unchecked. catalog. and report. This bar is on the top of the JReport Viewer window which shows information about the user. By default. Toolbar Specifies to show a default toolbar. Resource View Specifies to show the Resource View panel. By default. Pop Up Save Criteria Dialog Specifies whether to pop up the Save Report Template dialog when you exit a report which has been changed since it was first opened in JReport Viewer. the path for tracing the master/detail report q q q q q q q q q q q . a detail report. this option is unchecked. if you have specified Server Setting as the target frame of the links. then when the user closes the report the dialog will not be displayed and the changes will be discarded. Editing Marks Specifies whether to show editing marks (dashed outlines for objects and report body). Right-click Menu Specifies to show a shortcut menu when you click the right mouse button. a URL. A second way to skip the pop up Save Report Template dialog is to create a profile which does not have the Save option checked and assign the profile to the user or to the report. the editing mark will not be shown when a report object receives focus. A change includes any action taken such as sort. this option is checked so the dialog will always pop up. Pop Up New Window for Links Specifies whether to display a new web browser window for the link target. When defining such links in JReport Designer. Toolbox Specifies to show the Toolbox panel. filter and drill as well as actual changes to the template such as adding or removing objects. Switch Reports with Tab Specifies to switch among report tabs in a report using tabs. or the detailed information created from the go-to-detail function. Save Filter Criteria Specifies to check the Save Filter Criteria option by default when saving a report to a report version or as a new report. you can use the Go To drop-down list on the toolbar to switch among the report tabs. If the option is unselected. a chart hyperlink. If you uncheck this option. which means that when a report contains several report tabs. In addition. the dialog will not pop up when changes have been made and all changes will be discarded.q User Information Bar Specifies to show the User Information bar. this option will decide where the corresponding link targets will be displayed. Table of Contents Specifies to show the TOC Browser by default. If this option is not checked. r Align Summaries Vertically . r Show Grids Specifies to show grids in JReport Viewer report area. the groups will be indented according to the width of the group by fields. Grid Color Specifies color of the grids. Tool Tips on Toolbars Specifies to show the tooltips for toolbar commands. r r r q Grid Specifies the grid properties. when you create groups in a report in the report wizard. Always Prompt Query Filter Specifies to prompt the Query Filter dialog when inserting the first field from the Resource View panel into a blank component. in JReport Viewer. Report Style Group Specifies the default selected style for the four types of components when creating them via the report wizard in JReport Viewer: table. The default value is 0. You can also input a value between 0 and 4 to customize the indent. r Report Layout Specifies the default report layout when creating a new report in JReport Viewer. Always Prompt to Convert Data Fields Specifies to prompt the Convert Data Fields dialog when performing data analytic actions on reports. Zoom Specifies the zoom ratio at which DHTML pages will be displayed. r q q q q q q q q q Remove Filter Specifies to show the Remove Filter item on the Filter submenu. More Specifies to show the More item on the Filter submenu. chart. which are created in JReport Designer. Browser Page Title Specifies the title for the DHTML window (displayed on the DHTML window title bar). the indent of the groups is 0 inch. By default.07 inches. This section is available only when a JReport Live license for JReport Server is obtained. the master report will be closed after the detail report is opened. However.navigation as well as the drilling and going actions will also be reflected in the Go To drop-down list. when inserting them into a table or banded object which can bind style. Max Records Specifies the maximum number of records that will be retrieved by components in the report. If checked. All CSS styles in the <install_root>\style directory are available in the drop-down list. Mouse Wheel Turn to Page Specifies whether to allow using the mouse wheel to scroll up/down reports. Filter Menu Specifies which items will be shown on the Filter submenu. Grid Size Specifies size of the grids. the default style type will be Inherit Style instead of the value specified by this option. If unchecked. Always Prompt Whether to Adjust Page Size Automatically Specifies whether to prompt with a message box when JReport is going to adjust the page size if the width of a table exceeds the defined page size. Snap to Grids Specifies to snap an object to grids when you move it by dragging and dropping in JReport Viewer report area. r r r q New Ad Hoc Report Specifies properties for creating reports in JReport Viewer. and banded object. end users can go back to the master report by clicking the master report name link. q Show Master Report Specifies whether to show the master report in the same window when opening a detail report by default. r r Customize Group Indent Specifies to customize the indent of groups created via the report wizard. crosstab. Top N Specifies to show the Top N item on the Filter submenu. The default value is #808080. Bottom N Specifies to show the Bottom N item on the Filter submenu. Click on the property names to switch them on/off. Further options are available for advanced users. The displayed pages are complete. such as the options on the Export and Other tab. so as to make the server session never time out when any JReport Viewer window is open. If the server has not received a request for a period of time from one DHTML report tab. Editing group and report properties (can be accessed by using the Group and Report command on the shortcut menu). with mixed value. The contents of the displayed pages may be incomplete for lack of data integrity and will then be refreshed when their data is ready. such as editing group and report properties from the shortcut menu. If unselected. fetch all data before formatting report pages. format all report pages. Modifying the properties of images. If a Boolean type property in a report is set to be controlled by a formula. The total number of pages will not be known and will show as a + sign. q Advanced User Specifies to enable DHTML advanced features. There are in all four rendering modes controlled by the combination of the two options: View Incomplete Pages and Format Page on Demand. some features are only available for advanced users. format the required pages. and parameters (can be accessed by using the Properties command on the shortcut menu). it will be displayed as a checkbox. s r Format Page on Demand s If selected. which are created via the report wizard and have the same summary function. which automatically refreshes the DHTML window at certain intervals.Specifies whether to make summaries aligned vertically. special fields. Show Group by Name Specifies whether to show the groups by name in the TOC panel. Report Rendering Mode Specifies a way of running and laying out a report as the DHTML format. In JReport Viewer. q . The auto refresh time interval equals user session time out minus 16 seconds. including the following: r Advanced users can use a formula to control the value of a property. Advanced Properties Specifies to show or hide some advanced DHTML properties. This shows the total number of pages but will take longer to show the first page. fetch data for the required page and then format the page. r r r q Auto Refresh Specifies whether to enable the Auto Refresh feature. Report Tab Timeout Each open DHTML report tab is cached in the buffer. The first page will be displayed more quickly. If unselected. s q Lock Screen Timeout Specifies the idle time before the DHTML window is locked. This means that this option is currently controlled by a formula. r q q View Incomplete Pages s If selected. it will release its memory automatically. Select Catalog Linked Model If checked. the DHTML report will automatically be switched to run in background mode. Maximum Number of Open Reports Specifies the maximum number of DHTML reports that can be opened at the same time. q Page Report Timeout Each open DHTML report is cached in the buffer. Background Mode Timeout Specifies the time allowed for a DHTML report to run in foreground mode. ad hoc end users can decide the relationship between the saved report and the catalog used to run it when saving a report to a different directory in JReport Viewer: either link the saved report with the catalog.jsp. the report task in the table will be deleted.it will then release its memory automatically. After the Background Mode Timeout has expired. If the server has not received a request for a period of time from one DHTML report. The default value for this option is 10800 seconds. You can view the DHTML report result by clicking the report name in the Background Tasks table of the My Tasks page on the JReport Console page. The default value for this option is 10800 seconds. The two items As Linked Catalog and As Catalog Copy just predefine which corresponding option will be automatically checked in the Save As dialog of JReport Viewer. or copy the catalog to the target directory where the report is saved. and after the result is opened in a browser. see Limiting the number of simultaneously open reports. q . which is the JReport logo and displays when you open a DHTML report. Check DHTML Resource Path Checks the existence of static resources defined in the file ResourcePath. q q q q Show Splash Screen Specifies whether or not to show the splash screen. For details. . This name is required and is used as the display name of the resource in the server resource tree. If not specified. Resource Description Specifies the description of the resource (if necessary). From Folder/From File Specifies where to get the resources. Click the Browse button to specify the location. This option is available for report type only. Status Specifies the status of the report. Resource Type Specifies the type of the resources. Publish Local Resource to Shows where the resources will be published to.Publish to Local Server dialog The Publish to Local Server dialog guides you through the process of publishing resources to JReport Server locally. Resource Node Name Specifies the name of the resource. the status will be Active by default. Available only for the resources in the resource tree. Click the link to set user permissions to the resources in the Set Permissions dialog. Advanced Publish Specifies to publish resources in an advanced way. Note that only the font used by the specified resource can be published. r Maximum Number of Versions Specifies the maximum version amount that will be listed in the version table. q q Resource Real Path Specifies the real path of the folder. [Custom Field Name] Specifies value of the custom field for the resource. Description Specifies the description of the resource (if necessary). q Archive as New Version Specifies whether to use multiple versions for the selected resource. Click the Browse button to specify the directory. Note: This option can only be checked when the Enable Resources from Real Paths option in the Configuration > Advanced panel on the JReport Administration page has also been checked. Click the Browse button to specify the directory. Font Directory Specifies the font directory of the resource. advanced run or scheduled on JReport Server. By default the version amount is unlimited. q q q .q Active The report can be run. Once checked. q Checkbox Specifies the resources you want to publish. q Replace Old Version Specifies to replace the old version when the new version is generated. A custom field can be regarded as a resource property and is available when it is enabled. Apply Archive Policy Applies an archive policy to the resource result version. Resource Name Specifies the name of the resource. Set Permissions Available only when the resources are to be published to the Public Reports folder. it is required that you specify a real path in the Resource Real Path field. This option is available for folder type only but is disabled in cluster environment. This name is required and is used as the display name of the resource node in the server resource tree. Click the Browse button to specify the directory. This option is available for folder type only but is disabled in cluster environment. Automatically Convert Old Report Schema Specifies whether or not JReport Server converts JReport reports of earlier versions into current version JReport reports when publishing the earlier version reports. Incomplete The report is not completely designed and cannot be run. File Name Displays the file name of the resource. advanced run or scheduled JReport Server. Geographic Information Directory Specifies the geographic information of the resources with reports or library components contained that have geographic information. advanced run and scheduled on JReport Server. Enable Resources from Real Paths Specifies whether or not to enable getting resources from the folder real path. Style Directory Specifies the style directory of the resource. Inactive The report cannot be run. Help Displays this help document. Cancel Cancels the operations.q [Custom Field Name] Specifies value of the custom field for the resource. . which include the archive policy of the resource. Advanced Specifies the advanced properties for the resource. and the user permissions on the resource if the resource is to be published to the Public Reports folder. q OK Retains the settings and submits the task to server. the following options are available. Publish files and folders in the zipped file to /XXX Specifies whether to publish files and folders in the zipped file to /XXX directly. Resource Real Path Specifies the real path of the folder. Once checked. Publish Remote Resource to Shows where the resource will be published. it is required that you q q q . This option is disabled in cluster environment.Publish to Remote Server dialog The Publish to Remote Server dialog guides you through publishing resources to JReport Server remotely. q Resource Node Name Specifies the name of the resource node. From Zipped File Specifies where to get the resource. Click the Browse button to specify the location. Enable Resources from Real Paths Specifies whether or not to enable getting resources from the folder real path. This name is required and is used as the display name of the resource node in the server resource tree. Resource Description Specifies the description of the folder (if necessary). which specify properties of the new folder you want to create in /XXX to locate the resources in the zip file. When this option is not checked. q Replace Old Version Specifies to replace the old version when a new version is generated. which include the archive policy of the resource. This option is disabled in cluster environment. This name is required and is used as the display name of the resource node in the server resource tree. Set Permissions Available only when the resources are to be published to the Public Reports folder. Cancel Cancels operations. Resource Name Specifies the name of the resource. r Maximum Number of Versions Specifies the maximum version amount that will be listed in the version table. File Name Displays the file name of the resource. Apply Archive Policy Applies an archive policy to the resource result version. q Checkbox Specifies which resources in the zip file you want to publish. By default the version amount is unlimited. q [Custom Field Name] Specifies value of the custom field for the folder. Description Specifies the description of the resource (if necessary). [Custom Field Name] Specifies value of the custom field for the resource. and the user permissions on the resource if the resource is to be published to the Public Reports folder. Click the link to set user permissions to the resources in the Set Permissions dialog. Available only for the resources in the resource tree. Note: This option can only be checked when the Enable Resources from Real Paths option in the Configuration > Advanced panel on the JReport Administration page has also been checked. A custom field can be regarded as a resource property and is available when it is enabled. Help Displays this help document. q q q q q OK Retains the settings and submits the task to server. q Archive as New Version Specifies whether to use multiple versions for the selected resource. Advanced Specifies the advanced properties for the resource. . Automatically Convert Old Report Schema Specifies whether or not JReport Server converts JReport reports of earlier versions into current version JReport reports when publishing the earlier version reports. Advanced Publish Specifies to publish resources in an advanced way.specify a real path in the Resource Real Path field. Resource Path . Help Displays this help document. The Properties dialog is divided into the following two tabs: q General Permission q Reset Discards your modifications and restores the dialog to its default status. Cancel Cancels any settings and closes the dialog. General tab Specifies the general properties of the report. OK Retains the settings and submits the task to server.Report Properties dialog You can set the properties of a specified report in its Properties dialog according to your requirements. q Use Specified Links the report with a catalog in the server resource tree. you can change the catalog to apply another one using the Select Another Catalog option in the General tab of the corresponding dialog. Inactive The report cannot be run. Resource Type Shows the type of the resource. q q National Language Support Specifies whether to enable the NLS feature for the report. advanced run or scheduled. the linked catalog is applied instead of the catalog that is resided in the parent folder and originally used to run the report. q Use Inherited Links the report with the linked catalog inherited from its parent folder. Apply Archive Policy Applies an archive policy to the report versions. advanced run and scheduled. . This option is available when the Properties dialog is opened from the JReport Administration page. Note that if the parent folder does not enable linked catalog. Resource Description Specifies the description for the report. Enable Linked Catalog Enables to link the report with a catalog. [Custom Field Name] Specifies value of the custom field for the report. you are not allowed to check this option. the status will be Active by default. A custom field can be regarded as a resource property and is available when it is enabled. r Maximum Number of Versions Specifies the maximum version amount that will be listed in the version table. By default the version amount is unlimited. Resource Node Name Specifies the name for the report. Status Specifies the status of the report. Incomplete The report is not completely designed and cannot be run. This option is available when the Properties dialog is opened from the JReport Administration page. Available only for versions in the resource tree. For Advanced Run and Schedule. When you background run. advanced run or scheduled. If not specified. q Archive as New Version Specifies whether to use multiple versions for the report. q Replace Old Version Specifies to replace the old version when a new version is generated. then even if the report and the catalog are not in the same directory. it also can be run with the catalog. If you have linked a report with a catalog.Shows the resource path. advanced run or schedule the report. q Active The report can be run. r Select Another Catalog Specifies another catalog in the Select Another Catalog dialog. Choose Profile Specifies the DHTML profile to be applied to run the report which contains a set of JReport Viewer settings. all groups will be displayed in the Available box for you to assign permissions. Read Specifies whether to give the selected role/user/group the Read permission.Permission tab Specifies permissions of roles/users/groups to the report. users or groups to the Selected box. all users will be displayed in the Available box for you to assign permissions. Group If checked. Available Lists the roles/users/groups to which you can assign permissions. This tab is available when the report is in the Public Reports folder. Enable Setting Permissions Enables the setting of permissions. User If checked. q Visible Specifies whether to give the selected role/user/group the Visible permission. Selected Displays the roles. Removes the selected roles. q q Adds the selected roles. users or groups from the Selected box. users and groups to which the permissions will be assigned. q . q Role If checked. all roles will be displayed in the Available box for you to assign permissions. Execute Specifies whether to give the selected role/user/group the Execute permission. groups or roles that have obtained the Grant permission are also endowed with the other seven permissions . Update Status Specifies whether to give the selected role/user/group the Update Status permission. Grant Specifies whether to give the selected role/user/group the Grant permission. Delete Specifies whether to give the selected role/user/group the Delete permission. and Update Status. q q q q q . Execute.Visible. Schedule. and can grant these seven permissions except the Grant permission itself. Read. Schedule Specifies whether to give the selected role/user/group the Schedule permission. Users. Delete.q Write Specifies whether to give the selected role/user/group the Write permission. Write. General tab Specifies the general properties of the result.Result Properties dialog You can set the properties of a specified result in its Properties dialog according to your requirements. Cancel Cancels any settings and closes the dialog. OK Retains the settings and submits the task to server. Resource Path Shows the resource path. The Properties dialog is divided into the following two tabs: q General Permission q Reset Discards your modifications and restores the dialog to its default status. Help Displays this help document. Resource Node Name Specifies the name for the result. . By default the number of versions is unlimited (0). [Custom Field Name] Specifies value of the custom field for the result. q Replace Old Version Specifies to replace the old version when a new version is generated. This tab is available when the result is in the Public Reports folder. . r Maximum Number of Versions Specifies the maximum number of versions that will be listed in the version table. q Archive as New Version Specifies whether to use multiple versions for the result. A custom field can be regarded as a resource property and is available when it is enabled. Permission tab Specifies permissions of roles/users/groups to the result. Enable Setting Permissions Enables the setting of permissions. Available only for versions in the resource tree. Apply Archive Policy Applies an archive policy to the result versions.Resource Type Shows the type of the resource. Resource Description Specifies the description of the result. users or groups from the Selected box. Schedule. groups or roles that have obtained the Grant permission are also endowed with the other seven permissions . all users will be displayed in the Available box for you to assign permissions. all groups will be displayed in the Available box for you to assign permissions.Visible. and can grant these seven permissions except the Grant permission itself. q Visible Specifies whether to give the selected role/user/group the Visible permission. q q Adds the selected roles. Delete Specifies whether to give the selected role/user/group the Delete permission. users and groups to which the permissions will be assigned. Removes the selected roles. q Role If checked. Write. Selected Displays the roles. and Update Status. Grant Specifies whether to give the selected role/user/group the Grant permission. Read. Group If checked. Read Specifies whether to give the selected role/user/group the Read permission. Write Specifies whether to give the selected role/user/group the Write permission. Users. users or groups to the Selected box. q q q q . Delete. Execute. all roles will be displayed in the Available box for you to assign permissions.Available Lists the roles/users/groups to which you can assign permissions. User If checked. right-click in the row and select Schedule from the shortcut menu. Select the report row. q General tab Publish tab Conditions tab Notification tab Duration tab q q q q Back Goes back to the left tab. Put the mouse pointer over the report row and click the Schedule button on the floating toolbar. browse to the report you want to schedule. q q This dialog contains five tabs as listed below. on the JReport Console > Reports page. then on the task bar of the Reports page. Next Goes to the right tab. click Run > Schedule. To access the Schedule dialog. then do either of the following: q Select the row the report is in. Related topics: q Scheduling reports with dialog . Finish Applies the settings. Cancel Closes the dialog and discards any changes. Set the settings in each tab according to your requirements.Schedule dialog JReport Server allows you to schedule a report to run at a specific time and publish the report result to different formats. Help Displays this help document. General tab Before you can schedule a task. you first need to configure the settings in this tab. . the bursting definition will be removed from the report and the result will be generated based on whole data without data splitting. This property is available to administrators. Priority Specifies a priority level to the report running task. you need to select specific report tabs to run. If no parameter is used. Parameters Specifies values of the parameters applied in the report. If the parameter is of DateTime type. Check the Use Saved Values checkbox and select a previously saved parameter value list to apply to the report. Select Bursting Reports This option is available when there are bursting reports in the current report. You can select multiple schemas to apply to the report. DateTime. Bursting Configuration q Select Schema Specifies the schema you want to apply to the selected bursting report. Click the button . which is available when the parameter's Allow Multiple Values property is set to true in JReport Designer.Schedule Name Specifies the name for the currently scheduled task. Select Report Tabs Specifies the page report tabs you schedule to run. If you are running a page report. The Use Saved Values option is available when Enable Saving Parameter Values is checked in the Profile > Customize q . q q q If the parameter is of Date. By default this property is ignored unless server. Enter Parameters Specifies the parameter values if any to run the report. Non-bursting Result If checked. you should at least either complete Bursting Configuration for the report or select Non-bursting result in order to submit the task. The priority levels are from 1 to 10 in ascending order of lowest priority to highest priority. "No Parameter Needed" will be displayed here.policy not equal to 0. click the calendar button to set a DateTime value with calendar. or Time type. check the checkbox ahead of the button and then click the button to specify a dynamic date or time parameter value with expression in the Expression dialog.properties is modified to set queue. Select the bursting report you schedule to run. You may specify parameter values in the following ways: q In the parameter value combo boxes input the values manually or select them from the drop-down lists. to specify multiple values in the Enter Values dialog. You can select only one bursting report at a time. Once you choose to schedule to run a bursting report. Catalog Version Specifies the catalog version when you schedule a task. By default it is 3. Advanced section Configures some advanced settings. When it is checked. you are allowed to select a style group from the Style Group drop-down list to apply it to all the selected report tabs or web report for all export formats. When the number of the saved parameter value lists reaches the maximum number. Enable Style Group When this option is disabled as default. The button delete a saved list from the list library. use the style group properties of the selected report tabs or web report for corresponding export formats that are predefined in JReport Designer to do the schedule. Report Lists information about the report. The parameter value lists saved for the selected report tabs are limited. The default version is always the latest version. From the Before Converting and After Converting drop-down lists. The maximum number is controlled by the option Maximum Number of Auto Complete Parameters List in the Profile > Customize Server Preferences > Advanced tab. and you need to provide a name for the list in the prompted dialog as required. if you want to save another parameter list. The next time only when these very report tabs are selected. . the Using Language drop-down list will be displayed for you to choose a language. When this option is enabled. select encodings as required. Select Another Catalog Specifies another catalog for the report in the Select Another Catalog dialog. If checked. These predefined style group properties take effect when publishing to version/disk/e-mail/FTP. Report Version Specifies the report version when you schedule a task. the currently displayed parameter values set for the specified report will be saved as a whole marked as a list for reuse next time. If multiple report tabs are selected in this schedule task. it will overwrite the oldest list. Catalog Lists the catalog information. Save Values This link is available when Use Saved Values is checked. Enable NLS Specifies whether to enable NLS for the report. the parameter values specified for all of the report tabs are saved as a list. The default version is always the latest version. Enable Converting Encoding Specifies to enable the conversion of encoding. next to the drop-down list is used to Report Information Specifies the report information. Notes: q The Enable NLS option is available only when the National Language Support option is checked in the Properties dialog of the report on the JReport Administration page.Server Preferences > Advanced tab. This setting will cancel all the style group properties of the selected report tabs or web report for all export formats that are predefined in JReport Designer and replace them all with the value specified here. can the list be available for apply after you select the Use Saved Values checkbox. a drop-down list that contains the lists of previously saved parameter values will be displayed for you to choose one to apply. When it is clicked. Encoding Specifies the encoding of the report from the drop-down list. This option is available only when there are more than one active server in a cluster and when the Identify Server Preference option in the Profile > Customize Server Preferences > Advanced tab is selected. q q . Retry Interval Specifies the interval between retries. the DB user and password defined in the catalog will be used. Enable Auto Recover Task Specifies to enable the task to be auto recovered. q Use the DB user and password defined in catalog If checked. Use the DB User If checked. specify another DB user and password instead of the one defined in the catalog. you can only run the report using the default language. q Add TaskListener to be Invoked Enables you to call the Java application before/after viewing or when scheduling the report. Specify a preferred server to run the task Enables you to directly specify a server in a cluster to perform the schedule task instead of using load balancing. Connect to [Data Source Name] Specifies the DB user and password with which you want to connect to the data source the report uses. q Maximum Retry Times Specifies the maximum number of times in which to retry running the task in order to recover it.q If there is no NLS resource defined for the report. Recreate All Results Specifies whether to recreate all or just the failed results when you published the task to multiple formats. you can choose from the following six sub tasks: q To Version Publishes the report result to the versioning system. To FTP Publishes the report result to an FTP site. To Printer Publishes the report result to a printer. q q q q . For details about the change.Publish tab The Publish tab allows you to specify the type of the task. By default. the Publish tab will change according to the bursting setting made in the General tab of the Schedule dialog. q q q q q Note: If you are scheduling a bursting report. Default task is used to publish the reports. There are two main tasks to publish your reports: Default Task and User Task. The properties will be listed in the User Task Properties area. To Fax Publishes the report result to fax. you can implement a customized task with schedule properties. when specifying your task type. To use the User Task. To Disk Publishes the report result to the file system. Display Name Specifies the display name for the user task. Default Task If you select Default Task to publish your reports with. see Scheduling a task containing a bursting report. To E-mail Publishes the report result to e-mail. q User Task Class Name Specifies the class name for the user task. Import User Task Properties from file Imports a user task from a properties file. User Task Properties Specifies user task properties to define tasks. User Task If you select User Task to publish your reports. click the User Task link in the Default Task page. Upload Properties Uploads the properties to JReport Server. . it uses more CPU resources. You can publish the result to the following formats: q JReport Result Publishes the report to a JReport result file. Publish to Versioning System Specifies to publish the report result to the versioning system. .To Version This tab is for you to specify settings for publishing report results to the versioning system. r Zip Result Specifies to compress the result to reduce the disk size and I/O. however. XML Publishes the report result to the versioning system in XML format. it uses more CPU resources. Precision Level Specifies the precision level with which to publish the web report result. multi-level nested master and subreports. You cannot refresh a report viewed from an RSD file to refetch data from the database. Precision Level Specifies the precision level with which to publish the report result. r Zip Result Specifies to compress the result. RTF Publishes the report result to the versioning system in RTF format. The security information of an RSD file is the user of the generator that creates it. XML. however. Excel Publishes the report result to the versioning system in Excel format.rsd. When opening a report RSD. report template. The compressed file's suffix will still be . you cannot go back to the actions which the RSD generator took before generating the RSD file but can take actions based on the current RSD resources. r Zip Result Specifies to compress the result to reduce the disk size and I/O. Based on the RSD file. they will get the same result based on the same security configuration. however. data. NLS. reports containing data objects. you can rebuild a DHTML report to analyze data and to export to other formats. When different users open the same RSD. My Reports Folder Specifies to save the report result version to the My Reports folder. it will only load data from the RSD file. such as self-contained (CLX) reports. such as catalog. WST files can be exported to HTML. Note that changing the default value may cause abnormalities in report layout. RTF. Note that changing the default value may cause abnormalities in report layout. q q q q q q Archive Location Specifies the location for the saved report result version. q Built-in Version Folder Specifies to save the report result version to the built-in version folder. Some reports cannot be published to version in the DHTML Result format. parameters and security. and Postscript formats. Text.r Precision Level Specifies the precision level with which to publish the report result. Excel. and reports developed from a dynamic query or hierarchical data source (HDS). it's size will be smaller which reduces IO and disk usage. An RSD file is a standalone working file so all the useful information is added into it. r q Studio Result Publishes the web report to a static web report result file (WST file). Text Publishes the report result to the versioning system in Text format. q . Note that changing the default value may cause abnormalities in report layout. it uses more CPU resources. r q HTML Publishes the report result to the versioning system in HTML format. When the system rebuilds a report according to the RSD file. q DHTML Publishes the report to a DHTML result file (RSD file) that can be viewed in a JReport Viewer window. PostScript Publishes the report result to the versioning system in PostScript format. PDF Publishes the report result to the versioning system in PDF format. PDF. An RSD file is a middle result for DHTML that can preserve data and the working status of the DHTML report and can be shared with others. Click the link to set user permissions to the specified report tabs or web report in the Set Permissions dialog. JReport Server will keep the report result forever. Available only for resources in the resource tree. q Result Expires in N Days Specifies a period after which the report result will be automatically deleted. By default number of versions is unlimited. Set the result to be automatically deleted within one hundred years. the new version will replace the oldest version in the resource tree. If the time you specify exceeds one hundred years. Apply Archive Policy Applies an archive policy to the report result version. The Maximum Number of Versions option specifies the maximum version number that will be listed in the version table. q Set Permissions Available only when the Archive Location is specified to be Public Reports Folder.q Public Reports Folder Specifies to save the report result version to the Public Reports folder. . q Result Auto-delete Specifies the deleted date of the result. q Archive as New Version Specifies whether to use multiple versions for the specified resource. Replace Old Version Specifies to replace the old version when a new version is generated. Result Expires After Specifies a certain day on which the report result will be automatically deleted. When the number of versions is reached. rst q JReport Result Publishes the report to a JReport result file (RST file). you can decide whether to publish the results to the server resource tree or to the server disk path. Publish to Disk Specifies to publish the report result to the file system.To Disk This tab is for you to specify settings for publishing report results to the file system. PDF q q q q .rst Example for server disk path: C:\temp\report1. Studio Result Publishes the web report to a static web report result file (WST file). DHTML Publishes the report to a DHTML result file (RSD file) that can be viewed in a JReport Viewer window. HTML Publishes the report result to the file system in HTML format. For each format. Then you need to type in the blank location field root of the resource tree or disk path as shown in the examples below: Example for server resource tree: /SampleReports/report1. You can publish the report result to the following formats. PostScript Publishes the report result to the file system in PostScript format.rsd should be opened with JReport Viewer (DHTML) and those with the extension of . q . q Excel Publishes the report result to the file system in Excel format. you need only provide one file path because all selected report tabs will be output into one file. Text Publishes the report result to the file system in Text format. For other formats.Publishes the report result to the file system in PDF format. XML Publishes the report result to the file system in XML format. rst should be opened by JReport Server Viewer or Applet. you need specify a file path for each selected report tab. q q q q Notes: q For the JReport Result and DHTML formats. The files with the extension of . RTF Publishes the report result to the file system in RTF format. .To E-mail This tab is for you to specify settings for publishing the report results to e-mail. Cc Specifies the address you want to copy to. Bcc Specifies the address you want to secretly copy to. E-mail Address Specifies the e-mail address of the account. SMTP Logon Information Specifies the SMTP logon information. q From Specifies your e-mail address. Subject Specifies the subject of the e-mail. r q q q q q q q Account Name Specifies the account name. r r q E-mail Result in HTML E-mail Format Sends the report result via e-mail to the specified address in HTML format. images and so on. q . Password Specifies the password of the account. New Creates a new e-mail. q To Specifies the address you want to send the e-mail to. The report result will be shown in HTML format in the mail body. E-mail Result in Plain Text E-mail Format Sends the report result via e-mail to the specified address in plain text format.Mail To Lists the e-mail addresses you have sent mail to. Comments Specifies the contents of the e-mail or comments to the contents. Encoding Specifies the encoding of the e-mail. Note: This option can be enabled only when the option Server Requires Authentication is checked in the Export > E-mail tab of the Configuration dialog on the JReport Administration page. The report result will be shown in plain text format in the mail body with no other information such as color. Note: If you do not specify the address. the e-mail address in the Export > E-mail tab of the Configuration dialog on the JReport Administration page will be used as the default address. Compress Attachment as Java Archive Specifies whether to compress the mail attachment as Java Archive. the TOC and Sign options are disabled here. If you choose to send the mail in E-mail Result in HTML E-mail Format. OK q q q q q . Note: If the Split PDF options is specified in the Configuration > Export > E-mail tab on the JReport Administration page.See details about settings of this format. r File Name Specifies the name for the attachment file. r q Attachment in JReport Result Format Sends the report result via e-mail to the specified address with a JReport result file as attachment. Zip Result Specifies to compress the result and its size would be smaller. Attachment in XML Format Sends the report result via e-mail to the specified address with an XML file as attachment. Notes: r The two formats. Precision Level Specifies the precision level with which to publish the report result. r r q Attachment in Studio Result Format Sends the web report result via e-mail to the specified address with a WST file as attachment. Attachment in RTF Format Sends the report result via e-mail to the specified address with a RTF file as attachment. Precision Level Specifies the precision level with which to publish the web report result. the comments that you input for the mail will be overwritten by the report result. r r q Attachment in HTML Format Sends the report result via e-mail to the specified address with an HTML file as attachment. Attachment in PostScript Format Sends the report result via e-mail to the specified address with a PostScript file as attachment. E-mail Result in HTML E-mail Format and E-mail Result in Plain Text Format. Note that changing the default value may cause abnormalities in report layout. Attachment in PDF Format Sends the report result via e-mail to the specified address with a PDF file as attachment. cannot be support concurrently. Note that changing the default value may cause abnormalities in report layout. q q Attachment in Excel Format Sends the report result via e-mail to the specified address with an Excel file as attachment. Attachment in Text Format Sends the report result via e-mail to the specified address with a Text file as attachment. Zip Result Specifies to compress the result and its size would be smaller. r File Name Specifies the name for the attachment file. . q Cancel Cancels operations. Delete Deletes the specified e-mail in the Mail To list. Edit Edits the specified e-mail in the Mail To list.Retains the settings and adds the e-mail address into the Mail To list. Select Print Method Specifies the printing method to print the report result. the following options will be available. Copies .To Printer This tab is for you to specify settings for publishing report results to a printer. Print Range Specifies the pages to be printed. You can type it in the box or select it from the drop-down list. Publish to Printer Specifies to publish the report result to a printer. Paper Size Specifies the paper size. Printer Specifies the name with the path of the printer. When JDK1.4 is selected in the Select Print Method drop-down list. User Name Specifies the name of the user. . 3. q Priority Specifies the print priority for this task. q q Sheet collate Specifies the printing order for printing multiple-page reports. If no path is provided in the file name. q q q Color Appearance Specifies to print the reports in Monochrome or in Color. Duplex Imposes each consecutive pair of print-stream pages upon the front and back sides of consecutive media sheets. This kind of files can only be opened and printed by serial port printer on Windows via DOS command. q One Side Imposes each consecutive print-stream page upon the same side of consecutive media sheets. 1. such that the orientation of each pair of print-stream pages on the medium is correct for the reader as if for binding on the short edge. It can be Draft. Normal. The number of copies will be applied to all specified pages. q File Name Specifies the name of the file to which you print. when you print two copies of a three-page report.Specifies the number of copies you want to print. 2. Reverse Portrait Prints your reports in a Reverse Portrait orientation. Job Name Specifies the name of the print task. the page order is 1. such that the orientation of each pair of print-stream pages on the medium is correct for the reader as if for binding on the long edge. q Collated If selected. Print Sides Specifies the print sides for the printed reports. Job Attributes Specifies the properties of the print task. Print to File Prints the document to a file instead of a printer. Portrait Prints your reports in a Standard letter orientation. Print Quality Specifies the print quality. 3. or High. Tumble Imposes each consecutive pair of print-stream pages upon front and back sides of consecutive media sheets. 2. Reverse Landscape Prints your reports in a Reverse Landscape orientation. q q Orientation Specifies the orientation for the printed reports. q Landscape Prints your reports in a Landscape orientation. the file will be saved to the working directory of the server. when you print two copies of a three-page report.q Uncollated If selected. Margins Specifies the paper margins for the printed reports (MM or Inch). Media Tray First select a printer. 1. Note: JReport Server cannot obtain information on which options are supported and which are not from your printer and reflect it on this tab. and then from the drop-down list. 3. 3. You should configure the setting according to your printer carefully. 2. 2. specify the media tray. the page order is 1. . you must have your modem configured. Note that before you can fax the report result. You can specify the date by clicking the calendar button . Include Cover Sheet Specifies to send a cover sheet with the fax. Date Specifies the date on which the fax is to be sent. Company Specifies the sender's company. Quality Specifies the quality of the fax: Best. Normal. otherwise a warning message will be displayed. .To Fax This tab is for you to specify settings for publishing report results to fax. and Fast. From Specifies the name of the sender. Publish to Fax Specifies to publish the report result to fax. The following items are displayed on the fax cover sheet. To Specifies the name of the recipient. Phone Number Specifies the phone number of the sender. Please Comment Specifies that the recipient is required to comment on the content of the fax. . For Review Specifies that the recipient only needs to view the fax. Re Specifies the subject of the fax. Please Reply Indicates that a reply is required for the fax.Fax Number Specifies the fax number of the recipient. Comments Specifies the comments of the fax. Urgent Specifies whether the fax is urgent or not. FTP To Lists the FTP sites you send report results to. Host Address The domain name or IP address of the FTP site. It is optional. q . It cannot be null. New Creates a new FTP site.To FTP This tab is for you to specify settings for sending report results to an FTP site. q FTP Site Name A user-defined name of the FTP site. You should specify a fullyqualified class name that is package name plus class name. using the Secure Shell (SSH) protocol.DemoJakartaFTPHandler. For each format. Folder Location The location where to put the report result files on the FTP server. and by default 21 is used for Standard FTP and Explicit FTPS. s r Studio Result Sends the web report result in a WST file to the specified FTP site. s Zip Result Specifies to compress the result and its size would be smaller. r JReport Result Sends the report result in a JReport result file to the specified FTP site. FTP with TLS/SSL (Explicit) Explicit connection type of FTP security with TLS/SSL. test. Note that changing the default value may cause abnormalities in report layout. and 990 for Implicit FTPS. 22 SCP and SFTP. FTP with TLS/SSL (Implicit) Implicit connection type of TP security with TLS/SSL. r q q q q q q FTP (Standard File Transfer Protocol) Files are transferred in a non-secure (plain text) style. you need to specify a name for the result file. "anonymous" will be used as the user name by default. Precision Level Specifies the precision level with which to publish the web report result. for example. If this type is selected. Account The account of the FTP user if there exists. Handler Class A customized FTP-client handler class can be used instead of the one provided in JReport. SCP (Secure Copy) This is a means of securely transferring computer files between a local and a remote host or between two remote hosts. If not specified. the root path "/" of the FTP server will be used by default. It is optional. Precision Level Specifies the precision level with which to publish the report result. Protocol Type Specifies the protocol type used for publising the report results to FTP. s r HTML Sends the report result in an HTML file to the specified FTP site. you will not be able to create folder to the FTP server. If not specified. Ask your server administrator about availability. r r r r q Formats Specifies in which formats to send the report result file to the FTP site. Password The password is valid to the authentication of the FTP server that enables the user name to access the FTP site. You can specify one or more formats. s Zip Result Specifies to compress the result and its size would be smaller.q Port The port of the FTP server. SFTP using SSH2 (Secure Shell) SFTP (Secure FTP) is a component of Secure Shell and is supported by most Unix servers running SSH2. PDF r . User Name The user name is valid to the authentication of the FTP server that can access the FTP site. Note that changing the default value may cause abnormalities in report layout. Text Sends the report result in a Text file to the specified FTP site. RTF Sends the report result in a RTF file to the specified FTP site. q q Edit Edits the specified FTP site in the FTP To list. PostScript Sends the report result in a PostScript file to the specified FTP site. r Excel Sends the report result in an Excel file to the specified FTP site. OK Retains the settings and adds the FTP site into the FTP To list.Sends the report result in a PDF file to the specified FTP site. XML Sends the report result in an XML file to the specified FTP site. r r r r q Check Connection Checks whether to be able to connect to the specified FTP location with the specified user account. . Cancel Cancels the creation of the new FTP site. Delete Deletes the specified FTP site from the FTP To list. q Run this task immediately . It contains the following two sub tabs: q Time tab Trigger tab q Time tab The Time tab allows you to set settings for specifying the time for when a task is to be performed. Time Zone Specifies the time zone. Time Type Specifies the time type of the task.Conditions tab The Conditions tab allows you to specify the conditions for the publishing tasks. two months. or on the first Sunday.. two days. etc. of the specified month. etc. r r q Run this task periodically Specifies the time for when the task is to be performed on a repeated basis. Tuesday. etc. q Run this task at Specifies the time for when the task is to be performed on a repeated basis. . r Duration s Run after Specifies the start date and time of the period during which the task is to be performed on a repeated basis. You can specify the date by clicking the calendar button . Hourly Performs the task every one hour.. Monthly Performs the task every one month. Time Specifies the time for when the task will be run. Minutely Performs the task every one minute. etc. or every weekday (from Monday to Friday). and on Sunday. two minutes. on the first day.. s At Specifies a specific time for when to perform a task on a selected day. s r Date s Daily Performs the task every one day.Performs the task as soon as you submit it. Weekly Performs the task every one week. Trigger tab The Trigger tab allows you to set settings for specifying a trigger for the publishing task.. s s r Time Specifies the exact time for when a task is to be performed on a selected day. r Date Specifies the date for when the task will be run. at a certain minute on a selected day. Monday. second day. Run missed task upon server restart Specifies to run missed tasks when you restart the server.. s s r Run missed task upon server restart Specifies to run missed tasks when you restart the server. Monday. Run until Specifies the end date and time of the period during which the task is to be performed on a repeated basis. etc. two weeks. etc. etc. two hours.. etc. the task can only be performed when its counterpart is ready. q Trigger Name Specifies the name of the trigger. Create New Creates a new trigger. . q q q q Logic with time condition Specifies the logic between time condition and trigger condition. Cancel Cancels the trigger creating process. Notes: r q No matter which condition is ready. OK Creates the trigger with the specified information.Select a trigger to bind Specifies the trigger from the drop-down list for the task. Description Specifies the description of the trigger (if required). q Trigger Only Performs the task only when the trigger fires. Trigger and Time Condition Performs the task when both time condition and trigger condition are ready. Conflict Check Checks if the name has been used for another trigger. the task will be regarded as expired and will be deleted. The trigger condition must be ready before the time condition.r If you specify the task to be performed at a specific time. q . Time Condition or Trigger Performs the task when either the time condition or the trigger condition is ready. If the time condition is ready before the trigger condition. q Time Condition after Trigger Performs a task when both the time condition and the trigger condition are ready. you must check the checkbox Run missed task upon Server restart. otherwise the task will be regarded as expired and will be deleted when the time condition is ready before the trigger condition. Bcc Specifies the address you want to secretly copy to. When task is successful Specifies to send an e-mail when the task is successful. Comments Specifies the contents of the mail or comments to the contents. . regardless of whether it was successful or unsuccessful.Notification tab The Notification tab allows you to notify someone by e-mail when a task has finished running. When task fails Specifies to send an e-mail when the task is unsuccessful. Cc Specifies the address you want to copy to. To Specifies the address you want to send the e-mail to. Subject Specifies the subject of the e-mail. . and ask JReport Server to cancel the task or to notify you or someone else of the task status via e-mail if the task has not yet finished running when the task duration is up. The following are the available options: Timeout Specifies the time duration for the task. duration. you can specify a time duration for a task. In this tab. q Mail To Specifies the e-mail address of the recipient.properties file or by checking the Enable Task Duration option in the Configuration > Advanced panel on the JReport Administration page. Notify by e-mail after the specified time Sends an e-mail about the task information when the specified time is up.enable property to true in the server. . Cancel the task after the specified time Cancels the running task when the specified time is up.Duration tab This tab is available only when you have enabled the task-level timeout mechanism either by setting the task. Create a New Realm Creates a realm in the New Realm dialog. Name Displays the names of the existing realms. . the entries to the following panels are available on the drop-down menu. State Displays the states of the existing realms: Active Realm or Selected Realm. q Select Sets the specified realm to be the current editing realm. q User panel This panel allows you to manage users in JReport Server. Use each panel to set the settings according to your requirements.Security dialog When you click Security on the system toolbar of the JReport Administration page. Active Realm means that the realm is the current active realm. q Realm panel User panel Group panel Role panel Privilege panel Alias panel q q q q q Realm panel This panel allows you to manage realms in JReport Server. Control Controls the realms. and Selected Realm means the realm is the current editing realm in the Security dialog. Delete Deletes the specified realm. Edit Roles Edits the roles of the specified user.Create a New User Opens the New User dialog to create a user. User ID Lists the users' IDs. Control Controls the users. Click the underlined role(s) to edit the roles. q Name Lists the name of the roles that the user holds. Click the underlined group(s) to edit the groups. Add Roles Lists the roles that can be assigned to the user. Edit Groups Edits the groups of the specific user. Remove Removes the user from the specified groups. Add Groups Lists the groups that the user can be added to. q Auditing . Full Name Displays the user's full names. r q q q Add Adds the specified roles to the user. q Name Lists the name of the groups that the user belongs to. Remove Removes the specified roles from the role list. Full name is a property of a user. Built-in Specifies whether the role is a built-in role. r q q Add Adds the user to the specified groups. Authentication Specifies users' authentication type: Local or LDAP. You can view and edit user properties by clicking the underlined user IDs. Preferences Opens the Preferences dialog to set preferences for the specific user. q Change Password Opens the Change Password dialog to change the password of the specific user. Role panel This panel allows you to manage roles in JReport Server. Authentication Specifies the group members' authentication type: Local or LDAP. The built-in user accounts admin and guest cannot be deleted. Groups that have child members or parent members cannot be deleted. Remove Removes the specified members from the group. . Delete Deletes the specified user. q Name Lists the name of the members that the group holds. Add Members Shows the members that can be added to the group. You can view and edit group properties by clicking the underlined group name. Type Specifies the type of the members that the group holds. Create a New Group Creates a group in the New Group dialog. q q q q Control Controls the groups. q q Group panel This panel allows you to manage groups in JReport Server. For details about the preference settings.Opens the Auditing dialog to audit the specified user. q Delete Deletes the specified group. Click the underlined member(s) to edit the members. Members Edits members of the specified group. Name Lists the group names. refer to Profile dialog. Members Edits members of the specified role. q Delete Deletes the specified role. Type Specifies the type of the role's members. cannot be deleted. Authentication Specifies the role's members' authentication type: Local or LDAP. administrators and everyone. Click the underlined member(s) to edit the members. . Built-in roles.Create a New Role Creates a role in the New Role dialog. Privilege panel This panel allows you to grant roles. You can view and edit role properties by clicking the underlined role name. Remove Removes the specified members from the role. groups and users privileges in JReport Server. Add Members Shows the members that can be added to the role. and roles that are not empty. q Name Lists the names of the role's members. Name Lists the role names. q q q q Control Controls the roles. You can directly select the checkboxes to grant privileges to a group. You can directly select the checkboxes to grant privileges to a user. Add Assigns privileges to roles/groups/users. or uncheck the boxes to remove privileges from a group. After you have clicked the button. q q Role Privileges Lists the roles that have been assigned one or more privileges. User Privileges Lists the users that have been assigned one or more privileges. Group Privileges q .The privileges include the following: q Publish The privilege of publishing resources to JReport Server. the following options are available: q Role Privileges First select a role and then click the checkboxes to assign privileges to it. Advanced Properties The privilege of viewing advanced information of version properties such as catalog connections and report related resources. Message Table Manipulation The privilege of mapping fields from different data sources in a dashboard. or uncheck the boxes to remove privileges from a role. and adds these roles/groups/users into the Role Privileges/Group Privileges/User Privileges table. Group Privileges Lists the groups that have been assigned one or more privileges. or uncheck the boxes to remove privileges from a user. You can directly select the checkboxes to grant privileges to a role. By default. q Alias panel This panel allows you to set an alias resource tree based on the server resource tree for roles. the following options will be available: q Role Name/Group Name/User Name Lists the roles. and users for which you can set an alias resource tree. they must at the same time have both the permission to write and publish. After clicking the link. and then adds these roles/groups/users to the alias list. q q Remove Removes the selected roles/groups/users from the Role Privileges/Group Privileges/User Privileges table. only the "administrators" role and "admin" users have the Publish. q . and also removes the privileges assigned to them at the same time. OK Saves the changes. groups. q User Privileges First select a user and then click the checkboxes to assign privileges to it. Notes: q If users are to conduct publishment. group or user. Description Specifies information about a role. Set Role/Group/User Alias Sets an alias resource tree for roles/groups/users. Cancel Cancels the changes. Save Submits the changes that are to be applied.First select a group and then click the checkboxes to assign privileges to it. Advanced Properties and Message Table Manipulation privileges. groups. or users. Description Specifies information about a role.q Next Goes to the next step and opens the Set Alias dialog. group or user that has been assigned an alias. q Name Lists the name of roles. Related topics: q Managing security . Cancel Cancels any operations performed and exits the page. groups. and users that have been set an alias resource tree. Select a Catalog Specifies the catalog from the drop-down list. Catalogs in Specifies the root of the catalog.Select Another Catalog dialog The Select Another Catalog dialog helps you to specify another catalog for the current report or folder. . My Reports or Public Reports. Select a Folder Specifies the directory of the catalog. OK Applies the settings and closes the dialog. Cancel Cancels the settings and closes the dialog Help Displays this help document. Help . OK Selects the folder and closes the dialog.Select Folder dialog The dialog is displayed when you click the button next to the Select a Folder text field in the New Cache dialog for selecting queries. Cancel Cancels the selection of a folder and closes the dialog. Navigate to the required folder to select it. It helps you to select a folder in the server resource tree that contains the required catalog. Resource tree box The box lists the folder resources in the server resource tree. Displays this help document. . you can browse to the local folder where the NLS resource file is located. OK Goes to the next action. Refer to Appendix 5: Language and region name list for National Language Support for language and region A2 codes. NLS resource files should follow the naming rule: NLS_[language]_[region A2]_[User Defined]. NLS Resource File Specifies to add a new language from an NLS resource file in your local folder. . After choosing the option and clicking OK. It helps you to choose where to add a new language. Cancel Cancels the action and exits the dialog. properties.Select Language Source dialog This dialog is displayed when you click the button above the Language box in the Global NLS dialog. you will be shown the Add Language dialog. Help Displays this help document. Languages Supported by JReport Specifies to add a new language from the Available Languages box. After choosing the option and clicking OK. and parameters whose type is Bind with Single Column or Bind with Cascading Columns (for which type only a parameter with the cascading parameter group name is listed). it will not be listed here. imported SQLs. It allows you to specify the queries that you are going to create data caches for. stored procedures. You can select multiple resources at a time. The query resources include queries.Select Queries dialog This dialog is displayed when you click the button beside the Select Queries box in the New Cache dialog for selecting queries. If a query resource has been used by an existing data cache. hierarchical data sources. Cancel . user defined data sources. Resource tree box The box lists the data source resources that can be used as queries. OK Selects the query resources and closes the dialog. Cancels the selection of resources and closes the dialog. . Help Displays this help document. Web Report Specifies to create a web report based on a business view.Select Report Type dialog This dialog appears when you click New Report > Report on the task bar of the Reports page. It helps you to choose a type for the report. . Page Report Specifies to create a page report based on a business/report cube. If Page Report is selected. the New Page Report dialog will be displayed for you to create a page report. . OK q If Web Report is selected.q Available Business View Data Sources Displays all the available business views in the current catalog. q Available Report Cube Data Sources Displays all the available business/report cubes in the current catalog. q Cancel Does not retain any changes and closes the dialog. when you click OK. Help Displays this help document. the JReport Studio Wizard will be displayed for you to create a web report. when you click OK. Set Alias dialog This dialog is displayed when you click the Set Alias link in the Security > Alias panel on the JReport Administration page. Remove Deletes the selected alias node permanently. check a role/group/user in the displayed dialog and then click the Next button. The root node cannot be deleted. A node functions as a folder. New Creates a new alias node in the current node. Alias Tree Displays the alias resource tree. . When an alias tree is activated for a user. When you click the New button to create a new alias node in the current node. or user for whom the alias resource tree is set. You will need to specify a resource from the server resource tree with which to associate the new alias node by using the Browse button. the alias resource tree root for each user refers to the resource tree root. this field is left blank. By default.Path Displays the path of the current node in the alias resource tree. group. q q . the default name for the new alias node is newAlias. Browse Specifies a destination resource in the server resource tree that is to be associated with the current alias node. You can change the resource using the Browse button. Real Resource Name Displays the resource in the server resource tree that is associated with the current alias node. Alias Name Displays the name of the current node. the current alias node and its sub aliases will be invisible to the role. You can edit the alias name. Hide This Alias If this option is selected. Notes: q An alias tree is based on the resource nodes (not virtual resource nodes) of the resource tree. Back Returns to the previous page if no alias has been set. OK Applies the settings. all resource access is then controlled by the alias resource tree. When you click the New button to create a new alias node in the current node. Close Exits this dialog. users. users or groups from the Selected box. Removes the selected roles. users and groups to which the permissions will be assigned.Set Permissions dialog This dialog helps you to assign permissions to roles. Enable Setting Permissions Enables the setting of permissions. groups on specific resource or folder. Available Lists the roles/users/groups to which you can assign permissions. q Visible . q Role If checked. all groups will be displayed in the Available box for you to assign permissions. Selected Displays the roles. q q Adds the selected roles. all users will be displayed in the Available box for you to assign permissions. User If checked. users or groups to the Selected box. all roles will be displayed in the Available box for you to assign permissions. Group If checked. and can grant these seven permissions except the Grant permission itself. Grant Specifies whether to give the selected role/user/group the Grant permission. and Update Status. q q q q q q OK Accepts the settings and closes the dialog. Write. . Schedule.Visible. Help Displays this help document. Execute Specifies whether to give the selected role/user/group the Execute permission. Delete Specifies whether to give the selected role/user/group the Delete permission. Read. Delete. Execute. Schedule Specifies whether to give the selected role/user/group the Schedule permission. Update Status Specifies whether to give the selected role/user/group the Update Status permission. q Read Specifies whether to give the selected role/user/group the Read permission. Cancel Cancel the settings. Write Specifies whether to give the selected role/user/group the Write permission. groups or roles that have obtained the Grant permission are also endowed with the other seven permissions . Users.Specifies whether to give the selected role/user/group the Visible permission. Confirm Password . Method Specifies the signing digital signature method from the three methods provided by Adobe Acrobat software. Digital ID File Specifies whether to use a digital ID file from a specified directory. User Password Specifies the password for this digital ID file.Sign dialog This dialog is displayed when you click the Setting button next to the Sign option while configuring settings for advanced running/publishing a report in PDF format. Location Edits your location accordingly. Or Other Reason Edits the reason for signing the document. . Reason for Signing Document Specifies the reason for signing the document. Help Displays this help document. Your Contact Information Edits your contact information accordingly. Cancel Cancels the settings and closes the dialog.Confirms the password. OK Saves the settings and exits the dialog. Select a Catalog Specifies the catalog you want to use to create the report. Cancel Cancels the settings and exits the dialog. OK Applies the settings and opens the Select Report Type dialog.Specify Catalog dialog This dialog is displayed when you click Create Report on the JReport Server launch pad. My Reports or Public Reports. It helps you to specify the catalog which will be used to create the report. Help Displays this help document. . Select a Folder Specifies the folder in the selected resource directory that contains catalogs you can use to create the report. Catalogs in Specifies the resource directory in which the catalogs are located. . so each trigger must have a unique name. New Trigger Creates a new trigger. Description Specifies the description for the new trigger. q q q q Delete Deletes the selected triggers. Disable . Triggers are managed by name in JReport Server. Cancel Cancels the operation. OK Creates the trigger. You cannot create two triggers with the same name. When a trigger is enabled. Enable Enables the selected triggers.Triggers dialog This dialog is displayed when you click Triggers on the system toolbar of the JReport Administration page. Conflict Check Checks whether the name conflicts with any existing triggers before creating the new trigger. q Trigger Name Specifies the unique name for the new trigger. the Fire operation is also enabled. Name Displays names of the triggers. Check the checkbox on the column header to select all the triggers. q q q q q . Referenced Shows the times the triggers are referenced. q Checkbox Specifies whether or not to select the triggers. Last Fired Shows the time when the triggers were lasted fired. Is Enabled Shows whether the triggers are enabled or not. Trigger box Displays the trigger information. Description Displays description of the triggers.Disables the selected triggers. Fire Activates tasks that are bound with the selected triggers. q Add Measure dialog Aggregate On dialog Apply Style dialog Banded Object Properties dialog Banded Panel Properties dialog Banded Wizard Bottom N dialog Button Properties dialog Chart Definition dialog Chart Wizard Conditional Formatting dialog Convert Data Fields dialog Crosstab Properties dialog Crosstab Wizard Customized Page dialog Data Field Properties dialog Edit Additional Value dialog Edit Conditions dialog Edit Measure dialog Encoding dialog Enter Values dialog Export dialog Filter Control Properties dialog Filter dialog q q q q q q q q q q q q q q q q q q q q q q q .JReport Viewer dialogs While using JReport Viewer. you will go through the following dialogs. This section introduces each of these dialogs in alphabetical order. You can go into the links for details. q Format Label dialog Format Legend dialog Format Paper dialog Format Platform dialog Formula Editor dialog Group Properties dialog Image Properties dialog Insert Detail Column dialog Insert Filter Control dialog Insert Group Column dialog Insert Image dialog Insert Parameter Control dialog Insert Parameter Form Control dialog Insert Summary Column dialog Label Properties dialog Max Records dialog Multivalue Container Properties dialog Navigation Control Properties dialog New Page Report dialog New Report Tab dialog New Toolbar Name dialog Open Report Tabs dialog Options dialog Order/Select N dialog Page Properties dialog Parameter Control Properties dialog Parameter Field Properties dialog Parameter Form Control Properties dialog PDF Encrypt Option dialog q q q q q q q q q q q q q q q q q q q q q q q q q q q q . q PDF Sign Option dialog Printable Version dialog Query Filter dialog Rename Report Tab dialog Report Body Properties dialog Report Parameters dialog Report Properties dialog Save As dialog Save Report Template dialog Search dialog Select Color dialog Select Field dialog Select Group Position dialog Select Resource dialog Select Values dialog Sort dialog Special Field Properties dialog Split dialog Table Cell Properties dialog Table Properties dialog Table Row Properties dialog Table Wizard Tabular Cell Properties dialog Tabular Properties dialog Text Box Properties dialog Top N dialog To Chart dialog To Crosstab dialog Turn to Page dialog q q q q q q q q q q q q q q q q q q q q q q q q q q q q . click Profile on the system toolbar and select Configure DHTML Profile from the drop-down menu. An advanced user can modify some properties that a common user cannot. Click OK to accept the change. and can use formulas to control properties. To become an advanced user: 1.q Zoom dialog Note: The properties dialogs may be different for an advanced user and for a common user. Log onto the JReport Administration page. 3. . The section about JReport Viewer dialogs is based on advanced user. 2. Select the Properties > Advanced tab and check the Advanced User option. Mapping Name Specifies the mapping name of the field to which the measure object is mapped. Click field in the Select Resource dialog. q Count This function computes the number of values referred to by the argument. Measure Name Specifies the display name of the measure object. The function will be applied according to the group where the measure is placed or the entire report if placed in the report header or footer. q q . Average The function is used to get the average value of the values referred to by the argument. Sum This function computes the sum of all the values referred to by the argument.Add Measure dialog This dialog helps you to create a dynamic measure object in a report. to select the This option and the button are disabled when you specify to create a measure object on a dynamic formula. Aggregate Specifies the aggregate function of the measure object. Variance This function computes the variance of all the values referred to by the argument. Minimum This function returns the lowest value referred to by the argument. PopulationStdDev This function computes the population standard deviation of the values referred to by the argument. StdDev This function computes the standard deviation of the values referred to by the argument.q Maximum This function returns the highest value referred to by the argument. DistinctCount This function computes the number of distinct values referred to by the argument. q q q q q OK Creates the measure object and closes the dialog. Cancel Cancels the operation and closes the dialog. . Help Displays this help document. Help Displays this help document. Cancel Does not retain any changes and closes the dialog. Aggregate On Displays the field bound with the detail column. and also the one on which you want to create aggregate function.Aggregate On dialog The dialog helps you to create aggregate function based on a selected table detail column. . OK Creates the aggregate function and closes the dialog. Function Specifies the function to summarize the field in the detail column. Style Lists the styles applicable to the component. q Custom There is no style information in this style and it is only used to handle reports created with previous versions which did not bind any style or the bound style cannot be found in the style list.Apply Style dialog This dialog helps you to set a style to the selected data component. Preview . Help Displays this help document. or chart is contained in a banded object (for a chart. in a table also). . The option is available only when the banded object. Inherit Style Specifies to take the style of the parent component.Displays a diagram illustrating the effect of the selected style on the component. OK Accepts all changes and closes the dialog. Cancel Does not retain any changes and closes the dialog. crosstab. table. Cancel Cancels the settings and closes this dialog.Banded Object Properties dialog This dialog helps you to edit the properties of a banded object. It contains the following tabs: q General tab Border tab Others tab q q OK Applies the settings and closes this dialog. General tab This tab shows some general information of the banded object. . Help Displays this help document. . Position Displays the position mode of the banded object.Name Specifies the display name of the banded object. or a text box. Relative: The banded object will be positioned according to its default location and the X and Y property values. If the banded object is directly contained in the report body. its position mode can be modified. Static: The banded object will be positioned at the default location in its container. q Absolute: The banded object's position will be decided by its X and Y property values. If selected. a tabular cell. q q X Specifies the X coordinate of the banded object. the X. which will be shown on the shortcut menu of the banded object. Y and other position-related properties will be hidden or disabled. or input a color string in the format #RRGGBB. . Width Specifies the width of the banded object. input Transparent in the text box. click the color indicator to access the Select Color dialog and then specify a new color. Height Specifies the height of the banded object.Y Specifies the Y coordinate of the banded object. If you want to make the background transparent. To change the color. Border tab This tab shows information about borders of the banded object. Background Specifies the background color of the banded object. Right Line Specifies the style of the right border line. Bottom Line Specifies the style of the bottom border line. Width Specifies the border width.Color Specifies the border color. . Top Line Specifies the style of the top border line. Left Line Specifies the style of the left border line. the banded object will be exported when you save the report result as a TXT file with . TOC Anchor Specifies whether or not to add the node that represents the banded object to the TOC tree that is displayed in the TOC Browser.Others tab You can use this tab to view and configure some miscellaneous settings. Export to CSV If true (checked). Export to XLS If true (checked). the banded object will be exported when you save the report result as an XLS file (make sure to check Excel 2000 in the Export dialog). the banded object will not be displayed. Suppress When No Records If true (checked) and no records are returned by the report. Delimited Format selected. . It contains the following tabs: q General tab Border tab Others tab q q OK Applies the settings and closes this dialog. . General tab This tab shows some general information of the banded panel. Help Displays this help document.Banded Panel Properties dialog This dialog helps you to edit the properties of a banded panel. Cancel Cancels the settings and closes this dialog. Border tab . To change the color. Background Specifies the background color of the panel. If you want to make the background transparent. Height Specifies the height of the panel. input Transparent in the text box.Name Specifies the display name of the panel. click the color indicator to access the Select Color dialog and then specify a new color. Width Specifies the width of the panel. or input a color string in the format #RRGGBB. which will be shown on the shortcut menu of the panel. Top Line Specifies the style of the top border line. Color Specifies the border color. Right Line .This tab shows information about borders of the banded panel. Width Specifies the border width. Bottom Line Specifies the style of the bottom border line. Left Line Specifies the style of the left border line. Others tab You can use this tab to view and configure some miscellaneous settings.Specifies the style of the right border line. the panel will cross into the next page if the property is set to true (checked). Cross Page When the current page cannot hold the whole panel. Bottom Line Specifies whether or not to show the bottom line of the panel. or else the whole panel will be displayed in the next page. Export to XLS . the panel will not be displayed. Suppress When No Records If true (checked) and no records are returned by the report. If true (checked). Export to CSV If true (checked). the panel will be exported when you save the report result as an XLS file (make sure to check Excel 2000 in the Export dialog). the panel will be exported when you save the report result as a TXT file with Delimited Format selected. . Banded Wizard This wizard guides you through the process of creating a banded object. Finish Creates a report containing the banded object and closes the wizard. Cancel Closes the wizard without creating a report. It contains the following screens: q Data screen Display screen Group screen Summary screen Query Filter screen Style screen q q q q q Back Returns to the previous screen. Data screen Specifies the business/report cube to use to create the banded object. . Help Displays this help document. Next Goes to the next screen. This screen is hidden when there is only one cube in the current catalog. . Display screen Specifies the fields to be displayed in the banded object.Available Data Resources Lists all the available business/report cubes in the current catalog. with which you can create the banded object. Resources Displays all the cube elements in the selected business/report cube. Display Fields . Adds the selected cube element to be displayed in the banded object. Removes the selected cube element. Group screen Specifies the fields to group the data. Display Name Specifies the display names of the added cube elements.Lists the cube elements you have selected to display in the banded object. . Moves the selected cube element one step down. Moves the selected cube element one step up. Descend.Resources Displays all the available dimension objects you can use to group the data in the banded object. Summary screen Specifies the fields on which to create aggregation functions. Adds the selected dimension object as a group field. Removes the selected dimension object. Sort Specifies the sort order for each group: Ascend. Moves the selected group one step up. . or No Sort. Group By Lists all the dimension objects that have been added as the group fields. Moves the selected group one step down. Resources Displays all the available measure objects object. . Removes the selected measure object. you can use to create aggregation functions in the banded Adds the selected measure object as a summary field. Display Name Specifies the display names of the measure objects. Moves the selected measure object one step up. . Moves the selected measure object one step down.Summarized Fields Lists the groups that have been created in the banded object and the measure objects you have added to summarize data in each group. Query Filter screen Specifies the filter which you want to apply to the selected business/report cube. This screen is hidden when there is only one style available to be applied to the banded object. If you prefer to define a filter on your own. .In this screen. and then define it according to your requirements. You can choose one of them to apply. For details about options in the screen. select User Defined from the drop-down list. Style screen Specifies the style of the banded object. all the predefined filters of the business/report cube are listed in the Query Filter drop-down list. refer to Query Filter dialog. Style Lists all the available styles for you to select from. The option is available only when you specify to insert the banded object into another banded object. Preview Shows a preview of the selected style. Inherit Style Specifies to take the style of the parent component. . Value Enter a positive integer N here so that records with the field value equal to one of the bottom N field values will be displayed. . Help Displays this help document. Cancel Closes the dialog and discards any changes. OK Applies the settings and closes the dialog.Bottom N dialog This dialog helps you to filter data to display records that meet the Bottom N condition. q Button When Button is selected as the button type. Image Button The button is displayed as an image. . Button Type q Button The button is displayed as a normal button.Button Properties dialog This dialog helps you to modify the properties of a button in a navigation control. the following options are available. or input a color string in the format #RRGGBB. Height Specifies the height of the button. Position q q . q Color Specifies the border color. Left Line Specifies the style of the left border line. If you want to make the background transparent. Bottom Line Specifies the style of the bottom border line.Button Label Specifies the properties of the button label. Font Specifies the font face of the text. Font Style Specifies the font style of the text. q Text Specifies the text of the label. q q q q q Button Body Specifies the properties of the button body. Top Line Specifies the style of the top border line. q q q q q Border Specifies the properties of the button border. q Width Specifies the width of the button. To change the color. Font Size Specifies the font size of the text. q Background Specifies the background color of the button body. Right Line Specifies the style of the right border line. Font Color Specifies the font color of the text. input Transparent in the text box. click the color indicator to access the Select Color dialog and then specify a new color. Thickness Specifies the border width. Align Specifies the alignment way of the label in the button. Image Button When Button Image is selected as the button type. its position mode can be modified. If selected. the following options are available. a tabular cell. q Preview Displays a preview of the button according to the button properties. Y and other position-related properties will be hidden or disabled. or a text box. r Absolute: The button's position will be decided by its X and Y property values. the X. If the button is directly contained in the report body.Displays the position mode of the button. Static: The button will be positioned at the default location in its container. r r q X Specifies the X coordinate of the button. Y Specifies the Y coordinate of the button. . Relative: The button will be positioned according to its default location and the X and Y property values. proxyHost=XXX -Dhttp. which locates in <install_root>\bin. q Library Specifies to use an existing image. JPG. r Image URL Specifies the URL of the image file. r My Images The My Images folder is a virtual location where JReport Server stores the images that have once been inserted into reports. Select the one you want to use. Help Displays this help document. These types of images are supported: GIF.bat. The types and size of the images that can be used are defined by the administrator in the Upload panel. Cancel Cancels the changes and closes this dialog. .proxyPort=XX to the server's startup file JRServer. q Local File Specifies to use an image from the local file system. to successfully access the image via URL.Image From Specifies the source of the image file. You can click the Browse button to locate the image file. Note: If your JReport Server is in an intranet. r File Name Specifies the path and name of the image file. and PNG. Preview Displays a preview of the selected image. you need to add the parameters -Dhttp. q Web URL Specifies to use an image via URL. JReport will record the latest 10 entered URLs in the drop-down list. r OK Applies the button properties and closes this dialog. Cancel Cancels the settings and closes the dialog. It contains the following tabs: q Chart Type tab Display tab Style tab q q OK Applies the settings and closes the dialog.Chart Definition dialog The dialog helps you to modify the definition of a chart. . Help Displays this help document. Chart Type tab This tab allows you to set the type of the chart. Chart Type Lists all the chart types. Chart Type Groups Lists the subtypes defined for the chart. . Subtype Shows subtypes of the selected chart type in thumbnail form. Display tab This tab allows you to set the fields that will be displayed in the chart. .Removes the selected subtype. Available only when an additional value is selected in the Show Values box. Removes the selected cube element. Category Lists the dimension object Series Lists the dimension object Show Values Lists the measure objects chart. that will be displayed on the series axis of the chart. Order/Select N Opens the Order/Select N dialog to define the sort order and Select N condition in the chart. Adds the selected cube element to the chart. Style tab This tab allows you to select a style for the chart. . q that will be displayed on the category axis of the chart. and additional values that will be displayed on the value axis of the Opens the Edit Additional Value dialog to edit an additional value.Resources Displays all the dimension objects and measure objects used in the chart. It is hidden when there is only one style available. Preview .Style Lists the available styles. q Custom There is no style information in this style and it is only used to support reports built with previous versions which did not bind any style or the bound style cannot be found in the style list. Displays a diagram illustrating the effect of the selected style on the chart. . It contains the following screens: q Data screen Type screen Display screen Query Filter screen Style screen q q q q Back Returns to the previous screen. Next Goes to the next screen. This screen is hidden when there is only one cube in the current catalog. Finish Creates a report containing the chart and closes the wizard. Help Displays this help document.Chart Wizard This wizard guides you through the process of creating a chart. Cancel Closes the wizard without creating a report. . Data screen Specifies the business/report cube to use to create the chart. Type screen Specifies the type of the chart.Available Data Resources Lists all the available business/report cubes in the current catalog. . with which you can create the chart. Subtype Shows subtypes of the selected chart type in thumbnail form. Removes the selected subtype. Chart Type Groups Lists the subtypes defined for the chart. .Chart Type Lists all the chart types. Category Lists the dimension object that will be displayed on the category axis of the chart. Resources Displays the cube elements in the selected business/report cube.Display screen Specifies the fields to be displayed in the chart. . . Removes the selected cube element. and additional values that will be displayed on the value axis of the chart. Available only when an additional value is selected in the Show Values box. Order/Select N Opens the Order/Select N dialog to define the sort order and Select N condition in the chart.Series Lists the dimension object Show Values Lists the measure objects q that will be displayed on the series axis of the chart. Query Filter screen Specifies the filter which you want to apply to the selected business/report cube. Opens the Edit Additional Value dialog to edit an additional value. Adds the selected dimension or measure object to be displayed in the chart. For details about options in the screen. Style screen Specifies the style of the chart. This screen is hidden when there is only one style available to be applied to the chart. If you prefer to define a filter on your own. refer to Query Filter dialog. select User Defined from the drop-down list.In this screen. and then define it according to your requirements. You can choose one of them to apply. . all the predefined filters of the business/report cube are listed in the Query Filter drop-down list. Style Lists all the available styles for you to select from. . Preview Shows a preview of the selected style. Inherit Style Specifies to take the style of the parent component. The option is available only when you specify to insert the chart into a banded object or table. . q Adds a new condition in the Edit Conditions dialog. Condition Displays all the conditions you have already added.Conditional Formatting dialog This dialog helps you to add some conditional formats to values of the selected field. r Moves a condition down for a lower priority. Size Specifies the font size for the field values. Italic Specifies whether or not to make the field values italic. Background Color Specifies the background color for the field values. Bold Specifies whether or not to bold the field values. Foreground Color Specifies the foreground color for the field values. q q q q q q q q OK Applies the settings and exits the dialog. Border Specifies the border line style for the field values. Format Specifies the format which will be applied to the field values when the specified condition is fulfilled. Priority Specifies the priority of each condition. Help Displays this help document. Underline Specifies whether or not to underline the field values. Cancel Cancels the settings and closes the dialog. Sample Text Displays a preview sample of your settings. r q Moves a condition up for a higher priority.q Edits the selected condition. . q Font Specifies the font type for the field values. q Removes the selected condition. . if you want to do analytic actions in JReport Viewer. such as adding a cube element. JReport Viewer will convert its fields to cube elements of a business/report cube. drilling it. Do not display this message again Check this option if you do not want this dialog to be displayed in future. . or changing chart definition. while that created in JReport Viewer is based on a business/report cube. To display the dialog again. the Convert Data Fields dialog will appear for your confirmation of the conversion. For the former. Help Displays this help document. converting the component type. In those cases. and then check Always Prompt to Convert Data Fields. OK Confirms the conversion.Convert Data Fields dialog A component created in JReport Designer is based on a dataset. on the JReport Console/Administration page. click Profile > Configure DHTML Profile > Properties > Default. Cancel Does not convert the fields to cube elements. Help Displays this help document. General tab This tab shows some general information of the crosstab.Crosstab Properties dialog This dialog helps you to edit the properties of a crosstab. It contains the following tabs: q General tab Border tab Crosstab tab Others tab q q q OK Applies the settings and closes this dialog. . Cancel Cancels the settings and closes this dialog. input Transparent in the text box. Position Displays the position mode of the crosstab.Name Specifies the display name of the crosstab. Y Specifies the Y coordinate of the crosstab. If selected. or a text box. If the crosstab is directly contained in the report body. Background Specifies the background color of the crosstab. Width Specifies the width of the crosstab. q Absolute: The crosstab's position will be decided by its X and Y property values. Y and other positionrelated properties will be hidden or disabled. q q X Specifies the X coordinate of the crosstab. To change the color. a tabular cell. Static: The crosstab will be positioned at the default location in its container. click the color indicator to access the Select Color dialog and then specify a new color. Relative: The crosstab will be positioned according to its default location and the X and Y property values. which will be shown on the shortcut menu of the crosstab. the X. If you want to make the background transparent. Height Specifies the height of the crosstab. its position mode can be modified. Border tab This tab shows information about borders of the crosstab. . or input a color string in the format #RRGGBB. Color Specifies the color of the borders. Crosstab tab This tab shows the layout-related information of the crosstab. . Has Border Specifies whether or not to show the borders. Row Total on Top Specifies whether or not to display the Total rows for each column on the top of the crosstab. Column Total on Left Specifies whether or not to display the Total columns for each row in the first column in the crosstab. Boundary Value Specifies the number of aggregate fields in one row/column. Repeat Row Header Specifies whether or not to repeat column headings on every page.Horizontal Gap Specifies the space between the content and left/right edge of a crosstab cell. check this checkbox. To keep the column header together with the data in the next page. Vertical Gap Specifies the space between the content and top/bottom edge of a crosstab cell. Avoid Orphan Header Sometimes the column header happens to be at the bottom of a page. . Block Gap Specifies the spacing between each part of the crosstab if the crosstab will be split into more than one part. Expand Data Specifies whether or not to enable JReport Viewer users to expand or collapse dimensions in the crosstab. Current Row Block Index Specifies the row index of data block.Suppress Row Header Specifies whether or not to suppress the row headers. Outside Aggregate Title Specifies whether or not to place the titles of aggregate fields outside. Repeat Aggregate Specifies whether or not to repeat the crosstab for different aggregate fields. Current Column Block Index Specifies the column index of data block. Suppress Column Header Specifies whether or not to suppress the column headers. Items per Row Block . Table Style Specifies whether or not to add headers to the Total rows and columns. Others tab You can use this tab to view and configure some miscellaneous settings. Export to XLS If true (checked). TOC Anchor Specifies whether or not to add the node that represents the crosstab to the TOC tree that is displayed in the TOC Browser. the crosstab will not be displayed. Items per Column Block Specifies how many data blocks in the column direction should be split. the crosstab will be exported when you save the report result as an XLS file (make sure to check Excel 2000 in the Export dialog). Suppress When No Records If true (checked) and no records are returned by the report. the crosstab will be exported when you save the report result as a TXT file with Delimited Format selected. Export to CSV If true (checked). .Specifies how many data blocks in the row direction should be split. It contains the following screens: q Data screen Display screen Query Filter screen Style screen q q q Back Returns to the previous tab. Next Goes to the next tab. This screen is hidden when there is only one cube in the current catalog. Finish Creates a report containing the crosstab and closes the wizard. Data screen Specifies the business/report cube to use to create the crosstab.Crosstab Wizard This wizard guides you through the process of creating a crosstab report. Help Displays this help document. . Cancel Closes the wizard without creating a report. . Display screen Specifies the fields to be displayed in the crosstab. with which you can create the crosstab.Available Data Resources Lists all the available business/report cubes in the current catalog. . Adds the selected dimension object to be displayed on the rows of the crosstab.Resources Displays the cube elements in the selected business/report cube. Adds the selected dimension object to be displayed on the columns of the crosstab. Moves the selected cube element one level down. You can double-click the cells to edit them if required. By default these are blank and no labels will be created for the measure objects to name the summaries. Removes the selected cube element.Adds the selected measure object Columns/Rows q to be the aggregate field of the crosstab. By default these are blank and no labels will be created for the dimension objects to name the columns/rows. Query Filter screen Specifies the filter which you want to apply to the selected business/report cube. You can double-click the cells to edit them if required. q Moves the selected cube element one level up. Field Lists the dimension objects that will be displayed on the columns/rows of the crosstab. Display Name Specifies the display names of the dimension objects. q q Summaries q Field Lists the measure objects that will be the aggregate fields of the crosstab. . Sort Specifies the sort order of the dimension objects. Display Name Specifies the display names of the measure objects. For details about options in the screen. If you prefer to define a filter on your own. and then define it according to your requirements. This screen is hidden when there is only one style available to be applied to the crosstab. You can choose one of them to apply. refer to Query Filter dialog. Style screen Specifies the style of the crosstab. all the predefined filters of the business/report cube are listed in the Query Filter drop-down list. . select User Defined from the drop-down list.In this screen. Inherit Style Specifies to take the style of the parent component. .Style Lists all the available styles for you to select from. Preview Shows a preview of the selected style. The option is available only when you specify to insert the crosstab into a banded object. Also. Help Displays this help document. you can customize the JSP page of this dialog to make it display what you need by using the DHTML API. OK Applies the changes and closes the dialog.Customized Page dialog This dialog is displayed when the web action user_popCustomizedPage() bound with a web control is triggered. You can change the parameter values to re-run the report according to your requirement. Cancel Cancels the changes and exits the dialog. It by default shows all the parameters the current report and its subreport use. . General tab This tab shows some general information of the data field. It contains the following tabs: q General tab Font tab Border tab Others tab Display tab q q q q OK Applies the settings and closes this dialog. Cancel Cancels the settings and closes this dialog. . Help Displays this help document.Data Field Properties dialog This dialog helps you to edit the properties of a DBField. Y . If the data field is directly contained in the report body. q q Format Specifies the data format of the data field. If selected. X Specifies the X coordinate of the data field.Name Specifies the display name of the data field. Y and other position-related properties will be hidden or disabled. q Absolute: The data field's position will be decided by its X and Y property values. Position Displays the position mode of the data field. the X. Static: The data field will be positioned at the default location in its container. or a text box. Relative: The data field will be positioned according to its default location and the X and Y property values. its position mode can be modified. a tabular cell. To change the color. Font tab This tab shows the font-related information of the data field. Height Specifies the height of the data field. click the color indicator to access the Select Color dialog. click the color indicator to baccess the Select Color dialog and then specify a new color. Width Specifies the width of the data field. or input a color string in the format #RRGGBB. Top Padding Specifies the space between the text of the field and its top border. or input a color string in the format #RRGGBB. Left Padding Specifies the space between the text of the field and its left border. Right Padding Specifies the space between the text of the field and its right border. To change the color. input Transparent in the text box. If you want to make the background transparent. Background Specifies the background color of the data field. and then specify a new color. Foreground Specifies the foreground color of the data field. .Specifies the Y coordinate of the data field. Bottom Padding Specifies the space between the text of the field and its bottom border. Vertical Alignment Specifies the vertical alignment mode of the text in the data field. . Horizontal Alignment Specifies the horizontal alignment mode of the text in the data field. Bold Specifies whether to make the text bold or not. Strikethrough Specifies whether or not to attach a strikeout line to the text. Size Specifies the font size of the text. Underline Specifies whether the text will be underlined or not.Font Specifies the font face of the text. JReport will parse HTML tag elements in the field value while the report is to be saved as an HTML file.Italic Specifies whether to make the text italic or not. Word Wrap Specifies whether or not to wrap the text to the data field width. Color . if any. will not be parsed). Ignore HTML Tag If this option is unchecked. or the field value will appear in the HTML file the same as that in JReport Viewer (HTML tag elements in the field value. Border tab This tab shows information about borders of the data field. Autofit Specifies whether or not to automatically adjust the width of the data field. Shadow Color Specifies the color of the border shadow. Others tab You can use this tab to view and configure some miscellaneous settings. . Bottom Line Specifies the style of the bottom border line. Left Line Specifies the style of the left border line.Specifies the border color. Width Specifies the border width. Right Line Specifies the style of the right border line. Top Line Specifies the style of the top border line. Shadow Specifies whether the borders will have a shadow effect or not. Suppress When No Records If true (checked) and no records are returned by the report. Export to XLS If true (checked). It is a representation of the standard HTML attribute scope. Scope Available only for data field in table or crosstab. Export to CSV If true (checked). the data field will be exported when you save the report result as an XLS file (make sure to check Excel 2000 in the Export dialog). This attribute specifies the set of data cells for which the current header cell provides header information. . the data field will not be displayed. the data field will be exported when you save the report result as a TXT file with Delimited Format selected. the data field will not be displayed. Suppress If Null If true (checked) and the field value is null.TOC Anchor Specifies whether or not to add the node that represents the data field to the TOC tree that is displayed in the TOC Browser. Display tab You can use this tab to modify the display type of the data field as one of the following: Text. Reset. Submit.The scope attribute will not be generated when exporting to HTML. Checkbox. and Hidden. Barcode Specifies to display the data field as barcode. None . you can't change its display type. and then set the corresponding options. What you need to do is select the display type from the Display Type drop-down list. Image. Barcode. Column . Button. q q Logic Column Specifies whether to show the data field in the next visible table cell in the same row when the column which holds the field is hidden. Text Field. . Radio Button. For a field displayed as rank.The current cell provides header information for the rest of the row that contains it. there is no option available.The current cell provides header information for the rest of the column that contains it. Text Area. Image Button. Note: For the display types Text.q Row . Use Default Message Specifies whether or not to use the Message value as the barcode value when you view the report result. narrow width. Display HR Specifies whether or not to display the barcode numbers together with the barcode. . Message Specifies the default value of the barcode.Symbology Specifies the barcode type. Image Specifies to display the data field as image. Supplement Specifies the supplement of the barcode. Height Specifies the height of the barcode bars. height. Quiet Zone Specifies the space around the barcode. Enable Checking Digits Specifies whether or not to include check digits in the barcode. and ratio. Scale Mode Specifie the unit for the values of the quiet zone. supplement. Narrow Width Specifies the barcode bar width. Ratio Specifies the width ratio of the thick bar to the thin bar. Orientation Specifies the rotation angle in degrees. Scaling Mode Specifies the scaling mode of the image. This option is enabled when Original Size is unchecked (false). The mode can be: q Actual Size: The image will be shown in its actual size. Fit Image: The image will be scaled largest under the limitation of Max Ratio to wholly show in the field. Fit Width: The image will be scaled largest under the limitation of Max Ratio to fit the width of the field. Fit Height: The image will be scaled largest under the limitation of Max Ratio to fit the height of the field. Customize: The image size will be equal to the field size. q q q q Rotation Rotates the image at a specified angle in degrees. The following is the meaning of different values: q 0 - No rotation. Positive value - Rotate the image clockwise. Negative value - Rotate the image anticlockwise. q q Note: When you rotate an image, the rectangle that holds the image maintains its original size, which may result in that the image exceeds the field border and therefore the parts that extend outside of the border will be cut off. Name Specifies the name of the image. Alternate Text If the image cannot be displayed, this attribute value will be used as the alternate text. Max Ratio Specifies the maximum scaling ratio of the image. Width Specifies the width of the image, applying if Scaling Mode is set to Customize. This option is enabled when Original Size is unchecked (false). Height Specifies the height of the image, applying if Scaling Mode is set to Customize. This option is enabled when Original Size is unchecked (false). Original Size Specifies whether or not to show the image in its original size. Text Field Specifies to display the data field as text field. Type Specifies whether to render the field as a normal text field or to a password box. Name Specifies the name of the text field. Title Specifies the title of the text field. Character Width Specifies the width of the characters in the text field. Max Length Specifies the maximum number of the characters that can be input into the text field. Read Only Specifies whether or not to make the text field read-only. Disabled Specifies whether or not to make the text field disabled. Note: When a data field is displayed as text field, the value you have specified for the field's font property Vertical Alignment will no longer take effect. This is because the property is not supported in HTML standards. Text Area Specifies to display the data field as text area. Name Specifies the name of the text area. Title Specifies the title of the text area. Wrap Specifies whether or not to wrap text to the width of the text area. Note: When a data field is displayed as text area, the value you have specified for the field's font property Vertical Alignment will no longer take effect. This is because the property is not supported in HTML standards. Read Only Specifies whether or not to make the text area read-only. Disabled Specifies whether or not to make the text area disabled. Checkbox Specifies to display the data field as checkbox. Name Specifies the name of the checkbox. Title Specifies the title of the checkbox. Disabled Specifies whether or not to make the checkbox disabled. Initially Checked Specifies whether or not to check the checkbox by default. Radio Button Specifies to display the data field as radio button. Name Specifies the name of the radio button. Title Specifies the title of the radio button. Disabled Specifies whether or not to make the radio button disabled. Initially Checked Specifies whether or not to select the radio button by default. Image Button Specifies to display the data field as image button. Scaling Mode Specifies the scaling mode of the image. This option is enabled when Original Size is unchecked (false). The mode can be: q Actual Size: The image will be shown in its actual size. Fit Image: The image will be scaled largest under the limitation of Max Ratio to wholly show in the field. Fit Width: The image will be scaled largest under the limitation of Max Ratio to fit the width of the field. Fit Height: The image will be scaled largest under the limitation of Max Ratio to fit the height of the field. Customize: The image size will be equal to the field size. q q q q Name Specifies the name of the image button. Alternate text If the image cannot be displayed, this attribute value will be used as the alternate text. Title Specifies the title of the image button. Max Ratio Specifies the scaling ratio of the image button. Width Specifies the width of the image button, applying if Scaling Mode is set to Customize. This option is enabled when Original Size is unchecked (false). Height Specifies the height of the image button, applying if Scaling Mode is set to Customize. This option is enabled when Original Size is unchecked (false). Original Size Specifies whether or not to show the image button in its original size. Disabled Specifies whether or not to make the image button disabled. Button Specifies to display the data field as button. Name Specifies the name of the button. Title Specifies the title of the button. Value Specifies the value of the button. From Database Specifies to get the value of the button from database. Disabled Specifies whether or not to make the button disabled. Note: When a data field is displayed as button, the value you have specified for the field's font property Vertical Alignment will no longer take effect. This is because the property is not supported in HTML standards. Submit Specifies to display the data field as submit button. Name Specifies the name of the submit button. Title Specifies the title of the submit button. Value Specifies the value of the submit button. From Database Specifies to get the value of the submit button from database. Disabled Specifies whether or not to make the submit button disabled. Reset Specifies to display the data field as reset button. Name Specifies the name of the reset button. Title Specifies the title of the reset button. Value Specifies the value of the reset button. From Database Specifies to get the value of the reset button from database. Disabled Specifies whether or not to make the reset button disabled. Hidden Specifies to render the data field as hidden field. Name Specifies the name of the hidden field. Value Specifies the name of the hidden field. Edit Additional Value dialog This dialog helps you to edit an additional value. It varies according to value types. If it is a constant value, options in the dialog are as follows. Name Specifies the display name of the constant value, which will be shown under the subtype in the Show Values box. Value Specifies a float number for the constant value. OK Applies the settings and closes the dialog. Cancel Closes the dialog and discards any changes. Help Displays this help document. If it is an average value, options in the dialog are as follows. Name Specifies the display name of the average value, which will be shown under the subtype in the Show Values box. Based On Specifies the measure object based on which the average value will be calculated. OK Applies the settings and closes the dialog. Cancel Closes the dialog and discards any changes. Help Displays this help document. Edit Conditions dialog This dialog helps you to edit a condition for the selected field for adding conditional format. It contains the following two modes: q Basic Advanced q Advanced/Basic Switches the dialog to the advanced/basic mode. OK Applies the settings and exits the dialog. Cancel Cancels the settings and closes the dialog. Help Displays this help document. Basic mode The basic mode provides function for creating simple filter conditions which are connected by the AND and OR operators. Deletes the current condition line. Field Specifies the field to be filtered. Operator Specifies the operator to compose the filter expression. q = Equal to > Greater than q q >= Greater than or equal to < Less than <= Less than or equal to != Not equal to [not] in Causes an enumerated list of values to appear in the WHERE clause predicate, used for evaluating for a true condition. [not] like Like string pattern matching operator is used to compare the first expression string value to the pattern string (the second expression). If you want to use wildcard character in the pattern string, only "_" and "%" are supported. [not] between Allows the system to evaluate whether or not data values are located between a range of values indicated in the predicate. is [not] null It is used in WHERE clause predicates to match null values occurring in a specified data field. q q q q q q q Value Specifies the value of how to filter the field. You can either enter the value manually in the text box or select a value from the drop-down list. When you type in the value manually, if multiple values are required, they should be separated with ",", and if "," or "\" is contained in the values, write it as "\," or "\\". Logic Lists the logic operator. q AND Logic operator AND which is applied to this and the next line. OR Logic operator OR which is applied to this and the next line. q Advanced mode The advanced mode enables the building of more complex filter conditions via the grouping of conditions. Add Condition Adds a new condition line. Delete Deletes the selected condition line. Group Makes the selected conditions in one group. Conditions can also be added to an existing group by selecting the conditions and the group while holding the Ctrl button, and then clicking the Group button. Ungroup Makes the selected condition ungrouped. Up Moves the selected condition or group up to a higher level. Down Moves the selected condition or group down to a lower level. Logic Specifies the logic operator. q AND Logic operator AND which is applied to this and the next line. OR Logic operator OR which is applied to this and the next line AND NOT Logic operator AND NOT which is applied to this and the next line. OR NOT Logic operator OR NOT which is applied to this and the next line. q q q Field Specifies the field to be filtered. Operator Specifies the operator to compose the filter expression. Value Specifies the value of how to filter the field. You can either enter the value manually in the text box or select a value from the drop-down list. When you type in the value manually, if multiple values are required, they should be separated with ",", and if "," or "\" is contained in the values, write it as "\," or "\\". Condition Expression Displays the SQL statement of the filter condition. Edit Measure dialog This dialog helps you to edit an existing measure object. Measure Name Specifies the display name of the measure object. Mapping Name Specifies the mapping name of the field to which the measure object is mapped. Click field in the Select Resource dialog. to select the This option and the button are disabled when you specify to create a measure object on a dynamic formula. Aggregate Specifies the aggregate function of the measure object. The function will be applied according to the group where the measure is placed or the entire report if placed in the report header or footer. q Count This function computes the number of values referred to by the argument. Sum This function computes the sum of all the values referred to by the argument. Average The function is used to get the average value of the values referred to by the argument. q q q Maximum This function returns the highest value referred to by the argument. Minimum This function returns the lowest value referred to by the argument. DistinctCount This function computes the number of distinct values referred to by the argument. PopulationVariance This function computes the population variance of the values referred to by the argument. StdDev This function computes the standard deviation of the values referred to by the argument. Variance This function computes the variance of all the values referred to by the argument. q q q q q OK Applies the changes to the measure object and closes the dialog. Cancel Cancels the operation and closes the dialog. Help Displays this help document. Encoding dialog When a report designer links a trigger field of a master report to a detail report in JReport Designer, if he or she hasn't checked the option Use the same encoding and DB settings for the detail report as that of the mater report, then when the report is published to JReport Server and run in JReport Viewer, when you click the trigger field, this dialog will be displayed for you to specify the encoding for the detail report. Page Report Displays the path and name of the current page report. Catalog Displays the path and name of the current catalog. Enable Converting Encoding Specifies to enable the conversion of encoding. From the Before Converting and After Converting dropdown lists, select the encoding as required. Encoding Specifies the encoding for the detail report. Connect to [Data Source Name] Specifies the DB user and password with which you want to connect to the data source used by the detail report. q Use the DB user and password defined in catalog If checked, the DB user and password defined in the catalog will be used. Use the DB User If checked, specify another DB user and password instead of the one defined in the catalog. q OK Closes this dialog and applies the settings to run the detail report. Cancel Closes this dialog and runs the detail report without regard to the settings. Help Displays this help document. Enter Values dialog The dialog helps you to specify multiple values for a parameter. Available Values Lists all predefined parameter values for selection. When the parameter is bound with a column, but the Display Column is different from the Bind Column, values of the Display Column are listed here. Selected Values Lists the values selected. The selected values are case sensitive. Adds the selected values from the Available Values box to the Selected Values box. Removes the selected values from the Selected Values box. Adds all the selected values from the Available Values box to the Selected Values box. Removes all the selected values from the Selected Values box. Enter Values This option is available when the parameter's Allow Type-in of Value property is set to true in JReport Designer. Enter a value manually in the text box and then click the button next to add the value to the Selected Values box. When the parameter is bound with a column, but the display column is different from the bind column, make sure the value you enter is that of the bind column. All If selected, it means that the parameter value result is all the values in the DBMS. This option is available when the parameter's Enable the "All" Option property is set to true in JReport Designer. This is translated in SQL to remove the parameter which may select more values than listed in the available values list. For example, when the parameter query is: SELECT CUSTOMERS.CUSTOMERID,CUSTOMERS.CUSTOMERNAME FROM CUSTOMERS where CUSTOMERS. CUSTOMERID>0 and CUSTOMERS.CUSTOMERID<4 When you click SQL is: to add 1, 2 and 3 as the parameter values, which are all the available values, the (CUSTOMERS.CUSTOMERID IN ( 1,2,3)) Run the same report again and this time check the All checkbox in the Enter Values dialog, the query is then: ( 1 = 1) In this case, you will get more customers even though available values are only 1 – 3. Note: When a multi-value parameter is inserted as a field into a report and All is selected as the value, the field will show the string "All" which represents all the values in the DBMS. OK Applies the selected values to the parameter and closes the dialog. Cancel Does not retain any changes and closes the dialog. Help Displays this help document. Export dialog This dialog helps you to set settings for exporting the report result to different formats. Select Report Result Format Specifies the format to which the report result will be exported. View Report Result If selected, the result will be directly opened in the web browser if the format is supported by a plug-in of the web browser; otherwise you will be prompted to save the result file. Save to File System If selected, the web browser will prompt you to save the result file to a specified folder. Save to Version System If selected, the report result will be saved as a result version in JReport Server's versioning system. File Name Specifies the name of the result file. More/Less Options Shows/Hides the additional settings for exporting the report to the specified format. q Style Group Specifies the style group that will be applied to the exported result. When the No Style item in the Style Group drop-down list is selected, the style group property predefined for specific export format in JReport Designer will be applied to export the report result to that format. Properties Specifies the properties for the selected format: r q PDF HTML Excel Text RTF XML PostScript DHTML Result s r r r r r r r Zip Result Specifies to compress the result and its size would be smaller. OK Exports the report with the settings you specified. Cancel Cancels the operation and closes this dialog. Help Displays this help document. Filter Control Properties dialog This dialog helps you to edit the properties of a filter control. It contains the following tabs: q General tab Font tab Border tab Title tab q q q OK Applies the settings and closes this dialog. Cancel Cancels the settings and closes this dialog. Help Displays this help document. General tab This tab shows some general information of the filter control. Name Specifies the name of the filter control. Position Displays the position mode of the filter control. If the filter control is directly contained in the report body, a tabular cell, or a text box, its position mode can be modified. q Absolute: The filter control's position will be decided by its X and Y property values. Static: The filter control will be positioned at the default location in its container. If selected, the X, Y and other position-related properties will be hidden or disabled. Relative: The filter control will be positioned according to its default location and the X and Y property values. q q Format Specifies the field value format in the filter control. Filter On Displays the fields that the filter control is based on. You can click the button dialog to select other fields. X to open the Select Field Specifies the X coordinate of the filter control. Y Specifies the Y coordinate of the filter control. Width Specifies the width of the filter control. Height Specifies the height of the filter control. Background Specifies the background color of the filter control. To change the color, click the color indicator to access the Select Color dialog and then specify a new color, or input a color string in the format #RRGGBB. If you want to make the background transparent, input Transparent in the text box. Foreground Specifies the foreground color of the filter control. To change the color, click the color indicator to access the Select Color dialog and then specify a new color, or input a color string in the format #RRGGBB. Show Title Specifies whether to show the title of the filter control. Font tab This tab shows the font-related information of the text in the filter control. Font Specifies the font face of the text. Size Specifies the font size of the text. Bold Specifies whether to make the text bold or not. Underline Specifies whether the text will be underlined or not. Italic Specifies whether to make the text italic or not. Border tab This tab shows information about borders of the filter control. Top Line Specifies the style of the top border line. . Left Line Specifies the style of the left border line. Bottom Line Specifies the style of the bottom border line. Width Specifies the border width. Right Line Specifies the style of the right border line.Color Specifies the border color. Text Specifies the text of the title. the Text box above is disabled for inputting.Title tab This tab shows information about the title of the filter control. Foreground Specifies the foreground color of the title. . To change the color. q Auto Map Field Name Specifies whether to use the field name as the title. It is available when the Show Title option is selected in the General tab of the same dialog. or input a color string in the format #RRGGBB. input Transparent in the text box. Background Specifies the background color of the title. If you want to make the background transparent. If selected. click the color indicator to access the Select Color dialog and then specify a new color. Horizontal Alignment Specifies the horizontal alignment mode of the text. or input a color string in the format #RRGGBB. click the color indicator to access the Select Color dialog and then specify a new color. . Size Specifies the font size of the text. Font Specifies the font face of the text. Bold Specifies whether to make the text bold or not.To change the color. Italic Specifies whether to make the text italic or not. Underline Specifies whether the text will be underlined or not. Basic mode The basic mode provides function for creating simple filter conditions which are connected by the AND and OR operators. Apply Accepts the changes in the current tab.Filter dialog This dialog helps you to set criteria for filtering records in a report. OK Accepts the changes. . and regenerates the result using the filter settings. It has the following two modes: q Basic Advanced q Advanced/Basic Switches the dialog to the advanced/basic mode. Reset Restores this dialog to its opening status. Cancel Cancels the operation and closes this dialog. Help Displays this help document. and regenerates the result using the filter settings with this dialog closed. Deletes the current condition line. Field Specifies the field to be filtered. Operator Specifies the operator to compose the filter expression. .Apply to Specifies the object to which the filter will be applied. used for evaluating for a true condition." or "\\"." or "\" is contained in the values. they should be separated with ". write it as "\. [not] between Allows the system to evaluate whether or not data values are located between a range of values indicated in the predicate. OR Logic operator OR which is applied to this and the next line. q AND Logic operator AND which is applied to this and the next line. q q q q q q q q q Value Specifies the value of how to filter the field. only "_" and "%" are supported.". if multiple values are required. You can either enter the value manually in the text box or select a value from the drop-down list. is [not] null It is used in WHERE clause predicates to match null values occurring in a specified data field. Logic Lists the logic operator. If you want to use wildcard character in the pattern string. When you type in the value manually. and if ". .q = Equal to > Greater than >= Greater than or equal to < Less than <= Less than or equal to != Not equal to [not] in Causes an enumerated list of values to appear in the WHERE clause predicate. q Advanced mode The advanced mode enables the building of more complex filter conditions via the grouping of conditions. [not] like Like string pattern matching operator is used to compare the first expression string value to the pattern string (the second expression). Add Condition Adds a new condition line. . and then clicking the Group button. Conditions can also be added to an existing group by selecting the conditions and the group while holding the Ctrl button. Delete Deletes the selected condition line.Apply to Specifies the object to which the filter will be applied. Group Makes the selected conditions in one group. if multiple values are required. q AND Logic operator AND which is applied to this and the next line. Logic Specifies the logic operator. Operator Specifies the operator to compose the filter expression. You can either enter the value manually in the text box or select a value from the drop-down list. Value Specifies the value of how to filter the field. Down Moves the selected condition or group down to a lower level. and if ". write it as "\." or "\\". Up Moves the selected condition or group up to a higher level.Ungroup Makes the selected condition ungrouped."." or "\" is contained in the values. OR Logic operator OR which is applied to this and the next line AND NOT Logic operator AND NOT which is applied to this and the next line. they should be separated with ". . When you type in the value manually. Condition Expression Displays the SQL statement of the filter condition. q q q Field Specifies the field to be filtered. OR NOT Logic operator OR NOT which is applied to this and the next line. . It contains the following tabs: q General tab Border tab Font tab q q OK Applies the settings and closes this dialog.Format Label dialog This dialog helps you to format labels in a chart. Cancel Cancels the settings and closes this dialog. Help Displays this help document. General tab This tab shows some general information of the label. and then specify a new color. If you want to make the background transparent. Text Specifies the label text. Transparency Specifies the transparency of the label background. Alignment Specifies the alignment mode of the chart label. click the color indicator to access the Select Color dialog. .Name Specifies the display name of the label. X Specifies the X coordinate of the label. Width Specifies the width of the label. Height Specifies the height of the label. Border tab This tab shows information about borders of the label. Fill Type Specifies the type for filling the label. Color Indicates the background color of the label. which will be shown on the shortcut menu of the label. or input a color string in the format #RRGGBB. input Transparent in the text box. Y Specifies the Y coordinate of the label. To change the color. Thickness Specifies the thickness of the label borders. . Border Type Specifies the border type. Font tab This tab shows the font-related information of the label.Line Style Specifies the style of the label borders. Transparency Specifies the transparency of the label borders. Color Specifies the color of the label borders. Color Specifies the color of the label text. Font Effect Specifies the font effect of the label text. Transparency Specifies the transparency of the label text. Fill Type Specifies the fill type of the label text. . Font Style Specifies the font style of the label text. Size Specifies the font size of the label text. Font Underline Specifies the style of the line under the label text.Font Specifies the font face of the label text. Word Wrap Specifies whether or not to enable word wrapping for the label text.Font Strikeout Specifies whether or not to attach a strikeout line to the label text. . in degrees. Font Rotation Specifies the rotation angle of the label around its center. Font Shearing Specifies the shearing transformation of the label around its center. in degrees. Help Displays this help document. General tab This tab shows some general information of the chart legend. . Cancel Cancels the settings and closes this dialog. It contains the following tabs: q General tab Placement tab Border tab Font tab q q q OK Applies the settings and closes this dialog.Format Legend dialog This dialog helps you to format the legend of a chart. click the color indicator to access the Select Color dialog.Name Specifies the display name of the chart legend. or input a color string in the format #RRGGBB. Color Indicates the background color of the chart legend. Height Specifies the height of the chart legend. Fill Type Specifies the type for filling the chart legend. Width Specifies the width of the chart legend. To change the color. and then specify a new color. input Transparent in the text box. . which will be shown on the shortcut menu of the legend. Y Specifies the Y coordinate of the chart legend. If you want to make the background transparent. X Specifies the X coordinate of the chart legend. Secondary Placement Specifies the position of the legend on the basis of the Placement property. Show Tips Specifies whether to show the corresponding data information when the mouse pointer points at a target in the chart legend. . Show Percent Specifies whether to show the percentage of each legend.Transparency Specifies the transparency of the legend background. Placement Specifies the position of the legend in the platform. Show Value Specifies whether to show the value of each legend. Placement tab This tab shows the position-related information of the chart legend. Bottom Margin Specifies the distance between the legend labels and the bottom border of the legend. Right Margin Specifies the distance between the legend labels and the right border of the legend. Reverse Labels Specifies whether or not to arrange the legend labels in a reverse order. Top Margin Specifies the distance between the legend labels and the top border of the legend.Label Vertical Spacing Specifies the vertical distance between two adjacent legend labels. Border tab This tab shows information about borders of the chart legend. Label Horizontal Spacing Specifies the horizontal distance between two adjacent legend labels. . Left Margin Specifies the distance between the legend labels and the left border of the legend. Transparency Specifies the transparency of the legend borders. . Color Specifies the color of the legend borders. Border Type Specifies the type of the legend borders. Font tab This tab shows the font-related information of the chart legend. Font Specifies the font face of the legend labels.Line Style Specifies the line style of the legend borders. Thickness Specifies the thickness of the legend borders. Font Underline Specifies the style of the line under the legend labels. Font Shearing Specifies the shearing transformation of each legend label around its center. . Color Specifies the color of the legend labels. Font Strikeout Specifies whether or not to attach a strikeout line to the legend labels. in degrees. Fill Type Specifies the fill type of the legend labels.Size Specifies the font size of the legend labels. Font Style Specifies the font style of the legend labels. Font Effect Specifies the font effect of the legend labels. Font Rotation Specifies the rotation angle of each legend label around its center. Transparency Specifies the transparency of the legend labels. in degrees. Word Wrap Specifies whether or not to enable word wrapping for the label text. It contains the following tabs (some tabs may be not applicable for certain chart types): q General tab Border tab Coordinate tab Graph tab Threshold Line tab Axis X tab Axis Y tab Axis Z tab Bullet tab q q q q q q q q OK Applies the settings and closes this dialog. . Cancel Cancels the settings and closes this dialog. General tab This tab shows some general information of the chart paper. Help Displays this help document.Format Paper dialog This dialog helps you to format the paper of a chart. then specify a new color. input Transparent in the text box. or input a color string in the format #RRGGBB. Color Indicates the background color of the chart paper. To change the color. Fill Type Specifies the type for filling the chart paper. .Name Specifies the display name of the chart paper. which will be shown on the shortcut menu of the paper. click the color indicator to access the Select Color dialog. Height Specifies the height of the chart paper. X Specifies the X coordinate of the chart paper. Transparency Specifies the transparency of the chart paper background. If you want to make the background transparent. Y Specifies the Y coordinate of the chart paper. Width Specifies the width of the chart paper. Line Style Specifies the line style of the chart paper borders.Show Tips Specifies whether to show the corresponding data information when the mouse pointer points at a target in the chart paper. . Thickness Specifies the thickness of the chart paper borders. Border Type Specifies the type of the chart paper borders. Border tab This tab shows information about borders of the chart paper. It takes effect only when the option Show Tips is checked. Color Specifies the color of the chart paper borders. Transparency Specifies the transparency of the chart paper borders. Show Category and Series Specifies whether to show data of the category and value axes when the mouse pointer points at a target in the chart paper. Coordinate tab You can use this tab to view and configure properties of the coordinates. Scale Z Specifies the scaling ratio for the Z axis. Angle Y Specifies the rotation angle around the Y axis. Angle X Specifies the rotation angle around the X axis. Input an integer to set the effect. Scale X Specifies the scaling ratio for the X axis. Angle Z Specifies the rotation angle around the Z axis. Scale Y Specifies the scaling ratio for the Y axis. Perspective Specifies the perspective effect of the chart. Interactive . Show Wall Specifies whether or not to show the chart wall. Applies to 2-D bar/bench/line/area charts only. q Static Data Label Position . Applies to bar charts only.Specifies whether the chart can be interactive or not. Applies to line charts only. Bar Width Specifies the width of the bars. Line Thickness Specifies thickness of the lines. Depth Direction Specifies the angle of the axis along the depth of the bars/benches/lines/areas. q Depth Specifies the depth of the bars/benches/lines/areas. Graph tab You can use this tab to view and configure properties of the graphic object. Use Depth Specifies whether to make the chart visually three-dimensional. Show Floor Specifies whether or not to show the chart floor. q Value .Shows the category name for the chart section. Threshold Value1 Specifies the value of the first threshold line.Shows the value for the chart section.Specifies the position of the static data label. Threshold Line Color1 . q q q Show Pie Name Specifies whether or not to show the pie name.Shows the value and the percentage for the chart section.Shows the percentage of the section to the total. Only applies to the pie chart. Show Threshold Line1 Specifies whether or not to show the first threshold line. Category Name . Data Label Type Specifies in which way the value labels will be displayed around the chart section. Percent . Threshold Line tab You can use this tab to view and configure properties of the threshold lines. Value and Percent . Transparency Specifies the transparency of the threshold lines. Show Axis X Specifies whether or not to show the X axis. Show Threshold Line2 Specifies whether or not to show the second threshold line. Threshold Value2 Specifies the value of the second threshold line.Specifies the color of the first threshold line. Threshold Line Color2 Specifies the color of the second threshold line. . Min Value Specifies the minimal data value that will appear on the axis. Placement Specifies the position of the axis. Axis X tab You can use this tab to view and configure properties of the X axis. in degrees. the default rotation angle will be 30 anticlockwise. and when Use Depth is set to true. Increment Specifies the increment between two adjacent values of the axis. and the cut off part will be shown as suspension points. Show Axis Label Tips Specifies whether to display the complete label text when the mouser pointer points at a label on the axis. This option only applies to 2D chart types. Use Start Value Specifies whether or not to set the start value of the axis. q Angle Specifies to customize the rotation angle of the label text on the axis. If the text can not be completely displayed horizontally. When this option is true (checked) by default: q If the text can be completely displayed horizontally. the option will be disabled. . You can input the angle in the text box directly. Activated when Label Font Automatic Orientation is set to false (unchecked). Label Position Specifies whether to show the label text outside or inside the axis. This option applies to scatter and bubble charts. and only if the value on the category axis is not numeric.Max Value Specifies the maximal data value that will appear on the axis. Label Font Automatic Orientation Specifies to adjust the rotation angle of the label text on the axis automatically according to the length of the label text. Start Value Specifies the position from where the axis label will start to be shown. Axis Y tab You can use this tab to view and configure properties of the Y axis. the default rotation angle will be 0. in . Show Axis Label Tips Specifies whether to display the complete label text when the mouser pointer points at a label on the axis. Max Value Specifies the maximal data value that will appear on the axis. Label Font Automatic Orientation Specifies to adjust the rotation angle of the label text on the axis automatically according to the length of the label text. Start Value Specifies the position from where the axis label will start to be shown. Use Start Value Specifies whether or not to set the start value of the axis. Placement Specifies the position of the axis.Show Axis Y Specifies whether or not to show the Y axis. Increment Specifies the increment between two adjacent values of the axis. Min Value Specifies the minimal data value that will appear on the axis. the default rotation angle will be 0. Activated when Label Font Automatic Orientation is set to false (unchecked). You can input the angle in the text box directly. Show Axis Z Specifies whether or not to show the Z axis.degrees. Placement Specifies the position of the axis. the default rotation angle will be 30 anticlockwise. When this option is true (checked) by default: q If the text can be completely displayed horizontally. in . and the cut off part will be shown as suspension points. Axis Z tab You can use this tab to view and configure properties of the Z axis. Show Axis Label Tips Specifies whether to display the complete label text when the mouser pointer points at a label on the axis. q Angle Specifies to customize the rotation angle of the label text on the axis. Label Font Automatic Orientation Specifies to adjust the rotation angle of the label text on the axis automatically according to the length of the label text. If the text can not be completely displayed horizontally. the default rotation angle will be 30 anticlockwise. Comparative Measure Width Specifies the width of the comparative measures. When this option is true (checked) by default: q If the text can be completely displayed horizontally. measured in a percentage of the unit width. Enter a numeric value to change the width. measured in a percentage of the unit width. You can input the angle in the text box directly. and the cut off part will be shown as suspension points. Qualitative Ranges Width Specifies the width of the qualitative ranges. measured in a percentage of the unit width. Enter a numeric value to change the width.degrees. the default rotation angle will be 0. q Angle Specifies to customize the rotation angle of the label text on the axis. Bullet tab You can use this tab to view and configure properties of the bullets in a chart. If the text can not be completely displayed horizontally. Featured Measure Width Specifies the width of the featured measures. . Activated when Label Font Automatic Orientation is set to false (unchecked). Enter a numeric value to change the width. . . Help Displays this help document. Cancel Cancels the settings and closes this dialog.Format Platform dialog This dialog helps you to format the platform of a chart. It contains the following tabs: q General tab Border tab Data tab Others tab q q q OK Applies the settings and closes this dialog. General tab This tab shows some general information of the chart platform. If selected. q Absolute: The platform's position will be decided by its X and Y property values. Height Specifies the height of the platform. the X. Position Displays the position mode of the platform. Y and other position-related properties will be hidden or disabled. If the platform is directly contained in the report body. its position mode can be modified.Name Specifies the display name of the platform. Static: The platform will be positioned at the default location in its container. Y Specifies the Y coordinate of the platform. or a text box. . Relative: The platform will be positioned according to its default location and the X and Y property values. a tabular cell. Width Specifies the width of the platform. which will be shown on the shortcut menu of the platform. q q X Specifies the X coordinate of the platform. Color Indicates the background color of the platform. Border tab This tab shows information about borders of the chart platform. Line Style Specifies the line style of the platform borders. input Transparent in the text box. To change the color. If you want to make the background transparent. and then specify a new color. or input a color string in the format #RRGGBB.Fill Type Specifies a type for filling the platform. Border Type . Transparency Specifies the transparency of the chart background. Show Legend Specifies whether or not to show the legend. click the color indicator to bring out the Select Color dialog. Sort Category Specifies the sorting order for the category field values. . Data tab You can use this tab to view and configure properties of the chart data. Sort Series Specifies the sorting order for the series field values. Thickness Specifies the thickness of the platform borders. Reverse Category Specifies whether or not to reverse the category field value sequence. Color Specifies the color of the platform borders.Specifies the type of the platform borders. Transparency Specifies the transparency of the platform borders. Series Start Offset Specifies the starting offset of the series. the category and values axes. Swap Data Group Specifies to display values from different data fields by switching data between the category and series axes.. Category Start Offset Specifies the starting offset of the categories. Series Value Encoding Specifies the encoding format for values on the series axis... and XXXXX. . GBK. EUCJIS. UTF8. UTF8. Category End Offset Specifies the ending offset of the categories. Series End Offset Specifies the ending offset of the series. Others tab You can use this tab to view and configure some miscellaneous settings. and XXXXX. Formats here usually refer to the following: BIG5.. EUCJIS. Category Value Encoding Specifies the encoding format for values on the category axis. GBK.. Formats here usually refer to the following: BIG5.Reverse Series Specifies whether or not to reverse the series field value sequence.. the platform will be exported when you save the report result as a TXT file with Delimited Format selected. Export to XLS If true (checked).TOC Anchor Specifies whether or not to add the node that represents the platform to the TOC tree that is displayed in the TOC Browser. . Suppress When No Records If true (checked) and no records are returned by the report. Export to CSV If true (checked). the platform will not be displayed. the platform will be exported when you save the report result as an XLS file (make sure to check Excel 2000 in the Export dialog). etc). JReport will insert the selected function into the editing box at the insertion point completely with its required syntax items (parentheses. Select one operator and double-click it to insert the selected operator into the . and the dynamic formulas and measures that have been created in the report. For details about usage of the functions. commas. Functions box Displays a list of JReport functions that are available for formulas. refer to Built-in functions in the JReport Designer User's Guide. Operators box Displays a list of operators that are available for formulas. You can select one field and double-click it to insert the field into the editing box at the insertion point.Formula Editor dialog This dialog helps you to create a dynamic formula in a report. When you select one function and double-click it. Fields box Displays a list of those fields that are available for formulas. Formula Name Specifies the name of the formula. The fields include the dimension objects and detail information objects in the current business/report cube. For details about usage of the operators. JReport will then insert them in the formula. then the reference name will be @"Customer Name". If the field name contains spaces. refer to Operators in the JReport Designer User's Guide. q q q Note: If you refer to any field in the formula. the reference name for that field will be prefixed with an @ sign. There are several ways to work with formulas: q Select formula components from the Fields. the reference name in formula will be quoted with double-quotation marks (""). OK Creates the formula and adds it to the Resource View panel. if the field name is Customer Name. and then double-click the components. If the syntax is incorrect.formula text box at the insertion point. Editing box In this box. Cancel Doesn't add the formula and closes the dialog. Help Displays this help document. JReport provides an opportunity to correct the errors. . For example. Functions and Operators boxes in the Formula Editor. Type your formula in the editing box directly. Use the above two methods together. Check Tests the syntax of your formula. Color Converter A color palette is provided for you to insert the HEX code of a color simply by clicking the corresponding color in the color palette instead of inputting the HEX code manually. Paste formula text from the text document of other programs. you can build and edit your formula. Add Operators Selects a general operator to be used in the editing box. Group Properties dialog This dialog helps you to edit the properties of a group object. Help Displays this help document. It contains the following tabs: q General tab Others tab q OK Applies the settings and closes this dialog. Cancel Cancels the settings and closes this dialog. . General tab This tab shows some general information of the group object. you can type an integer which will be the number of groups to be displayed. . Sort Specifies a sorting direction for the groups of the group level.Expand Detail Data Specifies whether to expand or collapse the detailed records in the group level. Special Function Specifies a special function for the group level to group. N is the integer you type in the Select N text box. BOTTOM_N: The last N groups of the group level will be displayed. you can specify whether or not to still repeat the group header when a page break occurs on the group footer. q q Select N If you want only the first or last several groups of the group level to be displayed. Repeat While Group Footer If the group header is set to be repeated. Others tab You can use this tab to view and configure some miscellaneous settings. Shrink Footer Specifies whether or not to shrink the group footer when you shrink detailed records in the group level. Herein N is what you type in the Select N text box. This option is available only when the group field is of Date/Time type. Keep Group Together Specifies whether or not to try to keep groups wholly in a report page (try not to make a group across two pages). TOP_N: The first N groups of the group level will be displayed. Select Type Specifies the type for Select N condition: q ALL: The Select N condition will not take effect. and all groups will be retrieved. TOC Anchor Specifies whether or not to add the node that represents the object to the TOC tree that is displayed in the TOC Browser. . General tab This tab shows some general information of the image. . It contains the following tabs: q General tab Others tab q OK Applies the settings and closes this dialog. Cancel Cancels the settings and closes this dialog. Help Displays this help document.Image Properties dialog This dialog helps you to edit the properties of an image. Fit Height: The image will be scaled largest to fit the height of the image field. Fit Image: The image will be scaled largest to wholly show in the image field. Vertical Alignment . The mode can be: q Actual Size: The image will be shown in its actual size. Customize: The image size will be equal to the image field size.Name Specifies the display name of the image. Scaling Mode Specifies the scaling mode for the image. which will be shown on the shortcut menu of the image. q q q q Horizontal Alignment Specifies the horizontal alignment of the image in its container. Fit Width: The image will be scaled largest to fit the width of the image field. Picture Name Displays the image file name. The following is the meaning of different values: q 0 . the rectangle that holds the image maintains its original size. Title Specifies tip information about the image. Others tab You can use this tab to view and configure some miscellaneous settings. X Specifies the X coordinate of the image. Negative value .Rotate the image clockwise.Rotate the image anticlockwise. which may result in that the image exceeds the field border and therefore the parts that extend outside of the border will be cut off. Height Specifies the height of the image. Positive value . Y Specifies the Y coordinate of the image. Width Specifies the width of the image.Specifies the vertical alignment of the image in its container. which will be displayed when the mouse cursor hovers on the image. . Rotation Rotates the image at a specified angle in degrees. Alt Specifies the alternate text which will be shown if the image cannot be displayed.No rotation. q q Note: When you rotate an image. .TOC Anchor Specifies whether or not to add the node that represents the image to the TOC tree that is displayed in the TOC Browser. the image will not be exported when you save the report result as an XLS file (make sure to check Excel 2000 in the Export dialog). Export to XLS If true (checked). the image will not be displayed. Export to CSV If true (checked). the image will not be exported when you save the report result as a TXT file with Delimited Format selected. Suppress When No Records If true (checked) and no records are returned by the report. Insert Detail Column dialog The dialog helps you to insert a new detail column into a table. Cancel Does not retain any changes and closes the dialog. Resources Lists all the available data resources for the new detail column. OK Inserts the column with the specified resource and closes the dialog. Select the resource you want from the list. . Help Displays this help document. . . Select Fields Specifies the fields of the same type on which the filter control is based. Apply To Specifies the components to which the filter created with the filter control will be applied.Insert Filter Control dialog The dialog helps you to insert a filter control into a report for filtering all data components in the report (excluding its subreport) using the same data source. Cancel Cancels the operation and closes the dialog.OK Inserts a filter control into the report and closes the dialog. . Help Displays this help document. Resources Lists all the available data resources for new group columns. Adds the selected field to be used to group data in the table. Group By Lists the fields that are used to group data in the table. Removes the selected group by field. Sort .Insert Group Column dialog The dialog helps you to insert new group columns into a table. B. Group Left Above Specifies to place the selected group by field left above the detail information. Moves the selected group by field one step up. C). . No Sort Groups will be sorted in the original order in database. Cancel Does not retain any changes and closes the dialog. OK Inserts the group columns and closes the dialog. Group Left Specifies to place the selected group by field left to the detail information. A).Specifies how groups at the specific group level will be sorted. B. Help Displays this help document. q q Group Above Specifies to place the selected group by field above the detail information. q Ascend Groups will be sorted in an ascending order (A. Moves the selected group by field one step down. Descend Groups will be sorted in a descending order (C. You can click the Browse button to locate the image file. . The types and size of the images that can be used are defined by the administrator in the Upload panel. q Local File Specifies to use an image from the local file system.Insert Image dialog This dialog helps you to insert an image into a report. r File Name Specifies the path and name of the image file. Image From Specifies the source of the image file. Preview Displays a preview of the selected image. q Library Specifies to use an existing image. r Image URL Specifies the URL of the image file. r OK Inserts the image in the report and closes the dialog. Help Displays this help document. JReport will record the latest 10 entered URLs in the drop-down list. which locates in <install_root>\bin.proxyPort=XX to the server's startup file JRServer.bat. Cancel Cancels the insertion and closes the dialog. Select the one you want to use. you need to add the parameters -Dhttp. to successfully access the image via URL. Note: If your JReport Server is in an intranet.q Web URL Specifies to use an image via URL. r My Images The My Images folder is a virtual location where JReport Server stores the images that have once been inserted into reports. .proxyHost=XXX -Dhttp. Insert Parameter Control dialog The dialog helps you to insert a parameter control into a report for delivering parameter values to the report. Select a Parameter Specifies a parameter from the list where all the parameters except cascading parameters used by the current report are displayed. . . Help Displays this help document. Cancel Cancels the operation and closes the dialog.OK Inserts a parameter control into the report and closes the dialog. Insert Parameter Form Control dialog The dialog helps you to insert a parameter form control into a report for running reports from the current report. . Please Select Target Reports Specifies the reports to run. Cancel Cancels the operation and closes the dialog. r Include "Submit" Button Specifies whether the inserted parameter form control contains the Submit button. r Reports Specifies the target reports to run. OK Inserts a parameter form control into the report and closes the dialog. If Submit is not included. If Submit is included. you cannot finish the dialog. the new values will be applied automatically.q Current Report Specifies to run the current report with the specified parameters. once you change the values of a parameter in the parameter form control. Parameter Information Lists the parameters used by the selected reports. . and vice versa. If all the selected reports contain no parameters. q Others Specifies to run other reports. Once you select one of a group of cascading parameters. it is used to submit the parameter values you specified in the parameter form control. all the other parameters in the cascading group will be selected automatically. Help Displays this help document. r Select Parameters Specifies the parameters that are used to run the current report. OK Inserts the column with the specified resource and closes the dialog.Insert Summary Column dialog The dialog helps you to insert a new summary column into a table. Resources Lists all the available data resources for the new summary column. Select the resource you want from the list. Cancel Does not retain any changes and closes the dialog. . .Help Displays this help document. Help Displays this help document. It contains the following tabs: q General tab Font tab Border tab Others tab Display tab q q q q OK Applies the settings and closes this dialog. .Label Properties dialog This dialog helps you to edit the properties of a label. Cancel Cancels the settings and closes this dialog. General tab This tab shows some general information of the label. If the label is directly contained in the report body. the X. which will be shown on the shortcut menu of the label.Name Specifies the display name of the label. Position Displays the position mode of the label. X Specifies the X coordinate of the label. Y and other position-related properties will be hidden or disabled. q q Text Specifies the text of the label. Y . its position mode can be modified. or a text box. If selected. Static: The label will be positioned at the default location in its container. q Absolute: The label's position will be decided by its X and Y property values. Relative: The label will be positioned according to its default location and the X and Y property values. a tabular cell. Background Specifies the background color of the label. input Transparent in the text box. To change the color.Specifies the Y coordinate of the label. Foreground Specifies the foreground color of the label. Right Padding Specifies the space between the text of the label and its right border. Left Padding Specifies the space between the text of the label and its left border. Bottom Padding Specifies the space between the text of the label and its bottom border. click the color indicator to access the Select Color dialog and then specify a new color. Height Specifies the height of the label. Font tab This tab shows the font-related information of the label. If you want to make the background transparent. Width Specifies the width of the label. . Top Padding Specifies the space between the text of the label and its top border. To change the color. click the color indicator to access the Select Color dialog and then specify a new color. or input a color string in the format #RRGGBB. or input a color string in the format #RRGGBB. . Bold Specifies whether to make the label text bold or not. Underline Specifies whether the label text will be underlined or not. Strikethrough Specifies whether or not to attach a strikeout line to the label text. Size Specifies the font size of the label text. Vertical Alignment Specifies the vertical alignment mode of the text in the label. Horizontal Alignment Specifies the horizontal alignment mode of the text in the label.Font Specifies the font face of the label text. will not be parsed). JReport will parse HTML tag elements in the field value while the report is to be saved as an HTML file. Border tab This tab shows information about borders of the label. or the field value will appear in the HTML file the same as that in JReport Viewer (HTML tag elements in the field value. Color . You can modify all the border settings in this tab. Word Wrap Specifies whether or not to wrap the text to the label width. Ignore HTML Tag If this option is unchecked. if any. Autofit Specifies whether or not to automatically adjust the width of the label.Italic Specifies whether to make the label text italic or not. Top Line Specifies the style of the top border line. Left Line Specifies the style of the left border line. . Width Specifies the border width. Shadow Color Specifies the color of the border shadow. Others tab You can use this tab to view and configure some miscellaneous settings. Right Line Specifies the style of the right border line.Specifies the border color. Shadow Specifies whether the borders will have a shadow effect or not. Bottom Line Specifies the style of the bottom border line. Export to XLS If true (checked). Logic Column Specifies whether to show the label in the next visible table cell in the same row when the column which holds the label is hidden.TOC Anchor Specifies whether or not to add the node that represents the label to the TOC tree that is displayed in the TOC Browser. the label will not be displayed. Suppress When No Records If true (checked) and no records are returned by the report. Export to CSV If true (checked). the label will be exported when you save the report result as a TXT file with Delimited Format selected. the label will be exported when you save the report result as an XLS file (make sure to check Excel 2000 in the Export dialog). Display tab . . For details.You can use this tab to modify the display type of the label. see the Data Field Properties dialog. the number of retrieved records may not accord with the number set for Max Records. Max Records Specifies the maximum record number.Max Records dialog This dialog allows you to set the maximum number of records for components to retrieve. . All means that all records will be retrieved. Note: If any filter condition has been set on the component. OK Applies the settings to report components and closes this dialog. Help Displays this help document. and you can directly input a number here to retrieve the corresponding first records. Top 10/20/50/100 means that the first 10/20/50/100 records will be retrieved. Cancel Discards the settings and closes this dialog. which will filter out some records. It contains the following tabs: q General tab Font tab Border tab Others tab q q q OK Applies the settings and closes this dialog.Multivalue Container Properties dialog This dialog helps you to edit the properties of a multivalue container. Help Displays this help document. General tab This tab shows some general information of the multivalue container. . Cancel Cancels the settings and closes this dialog. Name Specifies the display name of the multivalue container. which will be shown on its shortcut menu. Position Specifies the position mode of the multivalue container. Y and other position-related properties will be hidden or disabled. q q X Specifies the X coordinate of the multivalue container. or a text box. its position mode can be modified. Static: The multivalue container will be positioned at the default location in its container. q Absolute: The multivalue container's position will be decided by its X and Y property values. a tabular cell. the X. Y . Relative: The multivalue container will be positioned according to its default location and the X and Y property values. If selected. If the multivalue container is directly contained in the report body. or input a color string in the text box. input Transparent in the text box. or input a color string in the format #RRGGBB. Background Specifies the background color of the multivalue container. Height Specifies the height of the multivalue container.Specifies the Y coordinate of the multivalue container. Foreground Specifies the foreground color of the multivalue container. click the color indicator to access the Select Color dialog and then specify a new color. To change the color. Width Specifies the width of the multivalue container. . Font tab This tab shows the font-related information of the multivalue container. To change the color. If you want to make the background transparent. click the color indicator to access the Select Color dialog and then specify a new color. . Border tab This tab shows information about borders of the multivalue container. Size Specifies the font size of the text.Font Specifies the font face of the text. Italic Specifies whether to make the text italic or not. Bold Specifies whether to make the text bold or not. Width Specifies the border width.Color Specifies the border color. Right Line Specifies the style of the right border line. Left Line Specifies the style of the left border line. . Bottom Line Specifies the style of the bottom border line. Top Line Specifies the style of the top border line. TOC Anchor Specifies whether or not to add the node that represents the multivalue container to the TOC tree that is displayed in the TOC Browser.Others tab You can use this tab to view and configure some miscellaneous settings. Export to XLS If true (checked). the multivalue container will not be displayed. the multivalue container will be exported when you save the report result as an XLS file (make sure to check Excel 2000 in the Export dialog). Export to CSV . Suppress When No Records If true (checked) and no records are returned by the report. If true (checked). the multivalue container will be exported when you save the report result as a TXT file with Delimited Format selected. . General tab This tab shows some general information of the navigation control.Navigation Control Properties dialog This dialog helps you to edit the properties of a navigation control. Cancel Cancels the settings and closes this dialog. . Help Displays this help document. It contains the following tabs: q General tab Border tab q OK Applies the settings and closes this dialog. If the navigation control is directly contained in the report body. a tabular cell. If selected. Y and other position-related properties will be hidden or disabled. the X. Y Specifies the Y coordinate of the navigation control. its position mode can be modified. Static: The navigation control will be positioned at the default location in its container. Position Displays the position mode of the navigation control. Relative: The navigation control will be positioned according to its default location and the X and Y property values. . q Absolute: The navigation control's position will be decided by its X and Y property values. q q X Specifies the X coordinate of the navigation control.Name Specifies the name of the navigation control. or a text box. or input a color string in the format #RRGGBB. Border tab This tab shows information about borders of the navigation control. Color Specifies the border color. If you want to make the background transparent. . click the color indicator to access the Select Color dialog and then specify a new color. input Transparent in the text box. Height Specifies the height of the navigation control. Background Specifies the background color of the navigation control. To change the color.Width Specifies the width of the navigation control. Bottom Line Specifies the style of the bottom border line.Width Specifies the border width. . Left Line Specifies the style of the left border line. Top Line Specifies the style of the top border line. Right Line Specifies the style of the right border line. Report Title Specifies the title of the report tab.New Page Report dialog This dialog helps you to create a new page report that contains one report tab. Choose Report Layout . Crosstab Creates a report containing a crosstab.Lists the report layouts on which you can create your report tab. q Banded Creates a report containing a banded object. Chart Creates a report containing a chart. q q q q OK Closes this dialog. Cancel Closes this dialog without creating a page report. the corresponding report wizard will be displayed. or a new page report will be created with a blank report tab. . and in accord with the selected report layout. Table Creates a report containing a table. Help Displays this help document. Blank Creates a report with nothing in it. New Report Tab dialog This dialog helps you to append a new report tab to the current report. Choose Report Layout . Report Title Specifies the title of the report tab. Lists the report layouts on which you can create your report tab. or a blank report will be created. Crosstab Creates a report containing a crosstab. and in accord with the selected report layout. q q q q OK Closes this dialog. Chart Creates a report containing a chart. the corresponding report wizard will be displayed. Help Displays this help document. . Cancel Closes this dialog without creating a report tab. Blank Creates a report with nothing in it. Table Creates a report containing a table. q Banded Creates a report containing a banded object. q OK Accepts a valid name (see above). underlines and spaces (except for at the beginning or end of the name). Cannot be the same as that of an existing toolbar. and returns to the Options dialog. Cancel Closes this dialog without creating a new toolbar. A valid toolbar name: q Can only contain alphanumeric characters. . Help Displays this help document.New Toolbar Name dialog This dialog helps you to input the name for the new toolbar. Name Specifies the name of the new toolbar. In this dialog. check those report tabs to be opened. To change the display state of the report tabs in the report. uncheck those to be closed. Description . the open report tabs in the current report are marked with a check symbol. Instance Name Shows the instance names of the report tabs in the report. Display Name Shows the display names of the report tabs in the report. and shows the display name and description of each report tab.Open Report Tabs dialog This dialog helps you to open or hide report tabs in the current report. and then click the OK button. and closes those deselected. opens the selected report tabs. Help Displays this help document. . Cancel Closes this dialog without changing the report display state. OK Closes this dialog.Shows the descriptions of the report tabs if any. Help Displays this help document. . Option tab This tab allows you to specify the skin of JReport Viewer user interface. OK Applies the settings and closes the Options dialog. Cancel Cancels the settings and closes the Options dialog. It contains the following tabs: q Option tab Customize tab q Restore Defaults Restores the default settings.Options dialog This dialog helps you to set the user interface of JReport Viewer. or Windows XP style. .Skin Specifies the skin of the JReport Viewer user interface. Classical. The skin can be the Standard. Customize tab This tab allows you to customize the toolbars in JReport Viewer. . Displays the New Toolbar Name dialog for you to input the name for the new toolbar. Available Tools Displays the tools that you can add to the toolbars. The new toolbar name will then be displayed in the Current Toolbar list box. Selected Tools Displays the tools of the toolbar selected in the Current Toolbar list box in the order that they will appear (from left to the right) on the toolbar. Removes the selected toolbar. If you want to customize a toolbar.Current Toolbar Lists all the available toolbars. The tools available in the box are determined by which profile is applied. click it to select. .Adds the selected tool from the Available Tools list box to the Selected Tools list box. Adjusts the location of the selected tool by moving it to the right on the toolbar. Adjusts the location of the selected tool by moving it to the left on the toolbar. Removes the selected tool. Empties the contents of the Selected Tools list box. Adds all the available tools from the Available Tools list box to the Selected Tools list box. Descend Lists data in a descending order. q Ascend Lists data in an ascending order. No Sort Keeps the data in their original order.Order/Select N dialog This dialog helps you to set the sort order and the Select N condition in a chart. q q Select N Specifies the Select N condition to define the number of category/series values that will be displayed . Order Specifies in which order data on the category/series axis of a chart will be displayed. q Select N r All If selected. . the category/series values will be sorted by the values of the summary selected with the direction specified. Cancel Discards the changes and closes the dialog. Help Displays this help document. Check this option and then type a character string in the text box to group all the category/series values beyond the top/bottom N category/series values. Bottom If selected. the category/series values will be sorted by the order specified in the Order box of the dialog. all category/series values in the chart will be displayed. Top If selected. If unchecked. specify a number in the text box to the right and the first N category/series values in the chart will be displayed. r r q Based On If checked. q OK Accepts the changes and closes the dialog.while others are hidden. Other Enabled when Top or Bottom is selected from the Select N drop-down list. specify a number in the text box to the right and the last N category/series values in the chart will be displayed. Width Shows the paper width. If you select the paper type as Custom size. q Type Specifies the paper type.Page Properties dialog This dialog helps you to control the report page settings. you can input the height of the paper here. If you select the paper type as Custom size. q q Orientation . Page Specifies the page properties. Height Shows the paper height. you can input the width of the paper here. Right Specifies the distance of report data to the right edge of the page. . Cancel Does not retain any changes and exits this dialog. q Margin Specifies the margin properties. Help Displays this help document. q Top Specifies the distance of report data to the top edge of the page.Specifies the paper orientation. q q q OK Applies all changes and closes this dialog. Landscape Displays the report data in a landscape orientation (horizontally). q Portrait Displays the report data in a portrait orientation (vertically). Bottom Specifies the distance of report data to the bottom edge of the page. Left Specifies the distance of report data to the left edge of the page. Cancel Cancels the settings and closes this dialog. Help Displays this help document. . General tab This tab shows some general information of the parameter control.Parameter Control Properties dialog This dialog helps you to edit the properties of a parameter control. It contains the following tabs: q General tab Font tab Border tab q q OK Applies the settings and closes this dialog. If the parameter control is directly contained in the report body. Parameter Displays the name of the parameter. Static: The parameter control will be positioned at the default location in its container. If selected. Position Displays the position mode of the parameter control. or a text box. Relative: The parameter control will be positioned according to its default location and the X and Y property values. a tabular cell. Format Specifies the display format of the parameter value. its position mode can be modified. q Absolute: The parameter control's position will be decided by its X and Y property values.Name Specifies the name of the parameter control. q q . Y and other position-related properties will be hidden or disabled. the X. Background Specifies the background color of the parameter control. Top Padding Specifies the space between the text of the parameter control and its top border. If you want to make the background transparent. To change the color. Font tab This tab shows the font-related information of the text in the parameter control.X Specifies the X coordinate of the parameter control. Left Padding Specifies the space between the text of the parameter control and its left border. or input a color string in the format #RRGGBB. Height Specifies the height of the parameter control. click the color indicator to access the Select Color dialog and then specify a new color. input Transparent in the text box. Width Specifies the width of the parameter control. Y Specifies the Y coordinate of the parameter control. or input a color string in the format #RRGGBB. Bottom Padding Specifies the space between the text of the parameter control and its bottom border. click the color indicator to access the Select Color dialog and then specify a new color. Right Padding Specifies the space between the text of the parameter control and its right border. Foreground Specifies the foreground color of the parameter control. To change the color. . Vertical Alignment Specifies the vertical alignment mode of the text. Underline Specifies whether the text will be underlined or not. Horizontal Alignment Specifies the horizontal alignment mode of the text. Bold Specifies whether to make the text bold or not.Font Specifies the font face of the text. Size Specifies the font size of the text. Italic . Border tab This tab shows information about borders of the parameter control.Specifies whether to make the text italic or not. Top Line Specifies the style of the top border line. Color Specifies the border color. Width Specifies the border width. Bottom Line Specifies the style of the bottom border line. Left Line . Specifies the style of the left border line. . Right Line Specifies the style of the right border line. Parameter Field Properties dialog This dialog helps you to edit the properties of a parameter field. It contains the following tabs: q General tab Font tab Border tab Others tab Display tab q q q q OK Applies the settings and closes this dialog. . Help Displays this help document. Cancel Cancels the settings and closes this dialog. General tab This tab shows some general information of the parameter field. Position Specifies the position mode of the parameter field. If the parameter field is directly contained in the report body. Relative: The parameter field will be positioned according to its default location and the X and Y property values. X . a tabular cell. which will be shown on the shortcut menu of the parameter. its position mode can be modified. If selected.Name Specifies the display name of the parameter field. Static: The parameter field will be positioned at the default location in its container. q Absolute: The parameter field's position will be decided by its X and Y property values. or a text box. q q Format Specifies the data format of the parameter field. Y and other position-related properties will be hidden or disabled. the X. click the color indicator to access the Select Color dialog. To change the color. . To change the color. or input a color string in the format #RRGGBB. and then specify a new color. Height Specifies the height of the parameter field. Y Specifies the Y coordinate of the parameter field.Specifies the X coordinate of the parameter field. input Transparent in the text box. Width Specifies the width of the parameter field. Foreground Specifies the foreground color of the parameter field. If you want to make the background transparent. Background Specifies the background color of the parameter field. click the color indicator to access the Select Color dialog and then specify a new color. or input a color string in the text box. Font tab This tab shows the font-related information of the parameter field. Vertical Alignment Specifies the vertical alignment mode of the text in the parameter field. Underline Specifies whether the field text will be underlined or not. Size Specifies the font size of the field text. Strikethrough . Bold Specifies whether to make the field text bold or not.Font Specifies the font face of the field text. Horizontal Alignment Specifies the horizontal alignment mode of the text in the parameter field. Word Wrap Specifies whether or not to wrap the text to the parameter field width. Italic Specifies whether to make the field text italic or not. or the field value will appear in the HTML file the same as that in JReport Viewer (HTML tag elements in the field value. if any. Autofit Specifies whether or not to automatically adjust the width of the parameter field. will not be parsed). . Border tab This tab shows information about borders of the parameter field.Specifies whether or not to attach a strikeout line to the field text. Ignore HTML Tag If this option is unchecked. JReport will parse HTML tag elements in the field value while the report is to be saved as an HTML file. Width Specifies the border width. Right Line Specifies the style of the right border line. Left Line Specifies the style of the left border line. Top Line Specifies the style of the top border line. . Bottom Line Specifies the style of the bottom border line. Shadow Color Specifies the color of the border shadow. Shadow Specifies whether the borders will have a shadow effect or not.Color Specifies the border color. Others tab You can use this tab to view and configure some miscellaneous settings. Button.TOC Anchor Specifies whether or not to add the node that represents the parameter field to the TOC tree that is displayed in the TOC Browser. Checkbox. the parameter field will be exported when you save the report result as a TXT file with Delimited Format selected. Export to XLS If true (checked). Hidden Field. Suppress When No Records If true (checked) and no records are returned by the report. Image. Display tab For a parameter field. Image Button. Text Area. . the parameter field will be exported when you save the report result as an XLS file (make sure to check Excel 2000 in the Export dialog). you can change its display type to one of the following: Text. Barcode. Drop-down List. Radio Button. Rank. List. the parameter field will not be displayed. Text Field. Export to CSV If true (checked). Submit. Disabled . Name Specifies the name of the list. Allow Multiple Specifies whether or not to allow multiple items to be selected. Selected Specifies the item to be selected. List Specifies to display the parameter field as list. Reset and Hidden. Title Specifies the title of the list. Disabled Specifies whether or not to make the drop-down list disabled. Title Specifies the title of the drop-down list. Drop-down List Specifies to display the parameter field as drop-down list. Reference: For the rest display types. see Data Field Properties dialog.Specifies whether or not to make the list disabled. Selected Specifies the item to be selected. Name Specifies the name of the drop-down list. . . General tab This tab shows some general information of the parameter form control. It contains the following tabs: q General tab Border tab Title tab q q OK Applies the settings and closes this dialog. Help Displays this help document. . Cancel Cancels the settings and closes this dialog.Parameter Form Control Properties dialog This dialog helps you to edit the properties of a parameter form control. Static: The parameter form control will be positioned at the default location in its container. Width Specifies the width of the parameter form control. its position mode can be modified.Name Specifies the name of the parameter form control. If the parameter form control is directly contained in the report body. a tabular cell. or a text box. Y Specifies the Y coordinate of the parameter form control. . If selected. Y and other position-related properties will be hidden or disabled. Position Displays the position mode of the parameter form control. q q X Specifies the X coordinate of the parameter form control. Relative: The parameter form control will be positioned according to its default location and the X and Y property values. q Absolute: The parameter form control's position will be decided by its X and Y property values. the X. click the color indicator to access the Select Color dialog and then specify a new color. Background Specifies the background color of the parameter form control. Width Specifies the border width. Show Title Specifies whether to show the title of the parameter form control. Color Specifies the border color. If you want to make the background transparent. . Border tab This tab shows information about borders of the parameter form control. input Transparent in the text box. To change the color.Height Specifies the height of the parameter form control. or input a color string in the format #RRGGBB. Right Line Specifies the style of the right border line. . Left Line Specifies the style of the left border line. It is available when the Show Title option is selected in the General tab of the same dialog. Title tab This tab shows information about the title of the parameter form control. Text Specifies the text of the title.Top Line Specifies the style of the top border line. Background Specifies the background color of the title. Bottom Line Specifies the style of the bottom border line. . or input a color string in the format #RRGGBB. input Transparent in the text box. Underline Specifies whether the text will be underlined or not.To change the color. Bold Specifies whether to make the text bold or not. Italic Specifies whether to make the text italic or not. If you want to make the background transparent. To change the color. Font Specifies the font face of the text. click the color indicator to access the Select Color dialog and then specify a new color. click the color indicator to access the Select Color dialog and then specify a new color. Horizontal Alignment Specifies the horizontal alignment mode of the text. or input a color string in the format #RRGGBB. Size Specifies the font size of the text. Foreground Specifies the foreground color of the title. 0 and later uses a high encryption level (128-bit RC4). Encryption Level . while the other option Acrobat 5.PDF Encrypt Option dialog This dialog helps you to set encryption options for the PDF file to be saved. Compatibility Specifies the encryption type to encrypt the PDF document.0 and later uses a low encryption level (40-bit RC4). The option Acrobat 3. Help Displays this help document. q Document Open Password Specifies the password to prevent others from opening the document without authorization. Confirm Password Confirms the password you have specified in the Document Open Password text box. Confirm Password Confirms the password you have specified in the Permissions Password text box. Changes Allowed Specifies the editing actions that are permitted in the PDF document.0 or later Acrobat version. Printing Allowed Specifies the printing quality for the PDF document. images and other content Allows others to select and copy the contents of the PDF document. Cancel Cancels the settings and closes the dialog. Require a password to open the document Specifies the Document Open Password to prevent others from opening the document without authorization. OK Saves the settings and exits the dialog. . q Use a password to restrict printing and editing of the document and its security settings Specifies the Permission Password to prevent others from printing and editing the document.Shows the level of the encryption compatibility that you specified in the Compatibility drop-down list. This option is available only if the Compatibility option is set to Acrobat 5. Enable text access for screen reader devices for the visually impaired Allows visually impaired users to read the PDF document with window readers. q q q Enable copying of text. The password you specify here cannot be the same as the one that you use to open the document. q Permissions Password Specifies the password to prevent others from printing and editing. Digital ID File Specifies whether to use a digital ID file from a specified directory. Method Specifies the digital signing method. . User Password Specifies a password for this digital ID file.PDF Sign Option dialog This dialog helps you to set signing options for the PDF file to be saved. Location Specifies your location accordingly. It is enabled when I agree to 'specified' portions of this document is selected from the Reason for Signing Document drop-down list. . Your Contact Information Specifies your contact information accordingly. Reason for Signing Document Specifies the reason for signing the document. Edit by Yourself Edits the reason for signing the document. Cancel Cancels the settings and closes this dialog. Help Displays this help document.Confirm Password Confirms the password. OK Applies the settings and closes this dialog. q Page Range Specifies the range of the pages that are to be printed. . q PDF Specifies to print the report result to a PDF file.Printable Version dialog This dialog helps you to set the print settings. Format Specifies the format to which the report result will be printed. HTML Specifies to print the report result to a HTML file. q All Specifies that all pages will be printed. Help Displays this help document. q OK Prints the report result with the specified settings to a PDF or HTML file and opens it in an associated program with which you can print the result to a printer. Cancel Cancels the print settings and closes this dialog.q Current Page Specifies that only the current page will be printed. Pages Specifies page numbers and/or page ranges separated by commas. . Help Displays this help document. OK Applies the settings and closes the dialog. Cancel Closes the dialog and discards any changes. Basic mode The basic mode provides function for creating simple filter conditions which are connected by the AND and OR operators. . It has the following two modes: q Basic Advanced q Advanced/Basic Switches the dialog to the advanced/basic mode.Query Filter dialog This dialog helps you to apply a filter to the business/report cube used by the specified data component to narrow down its data scope. Once a predefined filter is edited. r q Edit Edits the selected predefined filter. r . q User Defined Specifies to create a user defined filter to apply to the business/report cube. Predefined filters The names of the predefined filters which were created on the business/report cube in JReport Designer.Query Filter Specifies the filter you want to apply to the business/report cube. it will be saved as a user defined filter in the business/report cube. You can choose one of them to apply. Description Displays the description of the selected predefined filter. q Advanced mode . OR Logic operator OR which is applied to this and the next line. write it as "\. If you want to use wildcard character in the pattern string. [not] between Allows the system to evaluate whether or not data values are located between a range of values indicated in the predicate. q q q q q q q q q Value Specifies the value of how to filter the field. q = Equal to > Greater than >= Greater than or equal to < Less than <= Less than or equal to != Not equal to [not] in Causes an enumerated list of values to appear in the WHERE clause predicate. When you type in the value manually. if multiple values are required. they should be separated with ". Field Specifies the field to be filtered.". q AND Logic operator AND which is applied to this and the next line. used for evaluating for a true condition. You can either enter the value manually in the text box or select a value from the drop-down list. only "_" and "%" are supported.Deletes the current condition line. is [not] null It is used in WHERE clause predicates to match null values occurring in a specified data field. Logic Lists the logic operator." or "\\". and if ". Operator Specifies the operator to compose the filter expression. Click the button or to switch to filter the field by field or value. [not] like Like string pattern matching operator is used to compare the first expression string value to the pattern string (the second expression)." or "\" is contained in the values. Predefined filters The names of the predefined filters which were created on the business/report cube in JReport Designer. q User Defined Specifies to create a user defined filter to apply to the business/report cube. r q Edit Edits the selected predefined filter. You can choose one of them to apply. Query Filter Specifies the filter you want to apply to the business/report cube.The advanced mode enables the building of more complex filter conditions via the grouping of conditions. Once a predefined filter is edited. it will be saved as a user defined filter in the business/report cube. . Click the button or to switch to filter the field by field or value. and then clicking the Group button. OR Logic operator OR which is applied to this and the next line." or "\" is contained in the values. AND NOT Logic operator AND NOT which is applied to this and the next line. Conditions can also be added to an existing group by selecting the conditions and the group while holding the Ctrl button.r Description Displays the description of the selected predefined filter. Value Specifies the value of how to filter the field. Operator Specifies the operator to compose the filter expression. OR NOT Logic operator OR NOT Not which is applied to this and the next line. Delete Deletes the selected condition line. write it as "\." or "\\". Down Moves the selected condition or group down to a lower level. if multiple values are required. and if ". Ungroup Makes the selected condition ungrouped. Up Moves the selected condition or group up to a higher level. Condition Expression Displays the SQL statement of the filter condition.". Related topics: q Applying filters to business/report cubes . q AND Logic operator AND which is applied to this and the next line. q q q Field Specifies the field to be filtered. Add Condition Adds a new condition line. Logic Specifies the logic operator. When you type in the value manually. they should be separated with ". You can either enter the value manually in the text box or select a value from the drop-down list. Group Makes the selected conditions in one group. . OK Applies the new name to the report tab and closes this dialog. Cancel Discards the setting and closes this dialog. Input New Name Specifies the new name for the report tab. . Help Displays this help document.Rename Report Tab dialog This dialog helps you to rename the current report tab. Cancel Cancels the settings and closes this dialog. It contains the following tabs: q General tab Border tab Others tab q q OK Applies the settings and closes this dialog. . General tab This tab shows some general information of the report body.Report Body Properties dialog This dialog helps you to set the properties of the report body. Help Displays this help document. Background Specifies the background color and fill effect of the report body. input Transparent in the text box. or input a color string in the format #RRGGBB. To change the color. which will be shown on its shortcut menu. If you want to make the background transparent. click the color indicator to access the Select Color dialog and then specify a new color. Border tab This tab shows information about borders of the report body. .Name Specifies the display name of the report body. Width Specifies the border width. Top Line Specifies the style of the top border line. Left Line Specifies the style of the left border line.Color Specifies the border color. Right Line Specifies the style of the right border line. Bottom Line Specifies the style of the bottom border line. . Export to XLS If true (checked). the report body will be exported when you save the report result as a TXT file with . Export to CSV If true (checked).Others tab You can use this tab to view and configure some miscellaneous settings. Suppress When No Records If true (checked) and no records are returned by the report. the report body will be exported when you save the report result as an XLS file (make sure to check Excel 2000 in the Export dialog). the report body will not be displayed. TOC Anchor Specifies whether or not to add the node that represents the report body to the TOC tree that is displayed in the TOC Browser. .Delimited Format selected. For every parameter the report uses. a text box or a drop-down list. or select a predefined value from the drop-down list. If the parameter is of DateTime type. to specify multiple values for the parameter in the Enter . And if the parameter's Allow Multiple Values property is set to true in JReport Designer. you can click the button Values dialog. a calendar button will appear next to the drop-down list. which will facilitate your inputting.Report Parameters dialog This dialog helps you to input parameter values for a report. OK Accepts the parameter values for further processing. You can input the parameter value in the text box. Help Displays this help document. the dialog provides a prompt. It contains the following tabs: q General tab Others tab q OK Applies the settings and closes this dialog. General tab This tab shows some general information of the report. Help Displays this help document. Cancel Discards the settings and closes this dialog. .Report Properties dialog This dialog helps you to set the properties of a report. Result Buffer Size Specifies the size of the result buffer for storing the report result. Max Records Specifies the maximum number of records you want to display for the whole report. . Page Background Specifies the page background color. Records per Page Specifies the number of records in each page for the data buffer. Max Page Number Specifies the maximum number of pages in the data buffer.Name Specifies the report name. Para List Auto Specifies to get default parameter values either from a specified class or from values defined in the catalog. Others tab This tab shows some miscellaneous information of the current report.Embedded Fonts Specifies the True Type Fonts that have been used in the report. This property is only for exporting PDF files. Compress If No Record If this option is set to true (checked) and there is no record retrieved to the report. the report page will be compressed. National Language Support . Applet Width Specifies the applet width for the exported applets to be run in a web server. Compress Result Specifies whether or not to compress the exported RST file. Excel Buffer Size Specifies the size of the Excel buffer to store the XLS format report result. . Rows per Sheet Specifies the maximal number of rows for every worksheet when exporting the result to an XLS file. Applet Height Specifies the applet height for the exported applets to be run in a web server. Fast Pass If true (checked). the performance of the engine when saving the report result to a CSV format file on JReport Server will be improved.Specifies a language profile file. Save As dialog This dialog helps you to save a report as a new file. . The available directories vary with the folder selected. Set Original Catalog as Linked Catalog into Saved Page Report If checked. q Catalog Specifies the catalog for the new file. Help Displays this help document. This option is available only when Select Catalog Linked Model is checked in the Profile > Configure DHTML Profile > Properties > Advanced tab. Save Filter Criteria Specifies whether or not to save the filter criteria. This option is available only when Select Catalog Linked Model is checked in the Profile > Configure DHTML Profile > Properties > Advanced tab. .Report Name Specifies the name for the new file. Set Catalog Copy to Public Reports/My Reports If checked. The folder may be Public Reports or My Reports. Cancel Does not save the report as a new file and closes the dialog. Directory Specifies the directory for the new file. Folder Specifies where the new file will be saved. Description Specifies the description for the new file. The file format can be selected from the format drop-down list. the saved report will be linked with the catalog and the saved report will run with the catalog no matter whether the two are in the same directory. Save Sort Criteria Specifies whether or not to save the sort criteria. the saved report will run with the latest version of the catalog. q q q q OK Saves the new file with the specified settings and closes this dialog. the catalog will be copied to the directory where the report is saved and the saved report will run with the copied catalog. If later the catalog is updated. Advanced Displays the advanced save as settings. Save Filter Criteria Specifies whether or not to save the filtering criteria with the report. No Closes the report without saving any changes. Yes Applies the settings and closes this report. Help Displays this help document. Cancel Does not save the changes to the report and returns to the report.Save Report Template dialog This dialog requires your confirmation on whether or not to save the report template when saving a report. . You can use the option Pop Up Save Criteria Dialog in the Profile > Configure DHTML Profile > Properties > Default tab to control whether or not to display this dialog when saving a report. Save Sort Criteria Specifies whether or not to save the sorting criteria with the report. . check the Search in Whole Report checkbox. JReport will search . Disabled when Search in Whole Report is checked. q To find a certain field value. Note: If All is selected in the Value Range drop-down list. select the field from the Select Field drop-down list. To find text in the report content. the only item in the Value drop-down list will be All and you cannot change the value. when you submit the search. The content can be found in two places . Disabled when Search in Whole Report is checked. or in the report content. define the value range in the Value Range drop-down list and then select the value from the Value drop-down list. in which case. Value Range Specifies the range of the displayed values so that you can select a required value quickly from the Value field.Search dialog This dialog helps you to find specific text in a report.in the values of a certain field. type the search content in the Value box. q Select Field Specifies the field in which you want to find the text. . Highlight All Highlights all the matching text. Down Searches from the last found string to the end of the report. Search in Whole Report Finds text in the report content. q Search Searches the report or field value for the next match of the specified text. Match Case Finds text only if it matches the capitalization of the text you have entered. Cancel Cancels the operation and closes this dialog. Find Whole Word Finds text only if it matches a whole word. q Up Searches from the last found string to the beginning of the report. Value Specifies the text you want to find. The Select Field drop-down list and the Value Range drop-down list are disabled when this box is checked. Direction Specifies the searching direction. This option is selected by default. you can select a value from the drop-down list.for all the values of the selected field. Help Displays this help document. When Search in Whole Report is unchecked. Select Color dialog This dialog helps you to specify a color. . Swatches tab This tab allows you to select one from the web safe color swatches. Help Displays this help document. It contains the following tabs: q Swatches tab Color Picker tab q OK Closes this dialog and returns the color value specified in the current tab. Cancel Closes this dialog without changing the color value. The lower part is always displayed in the original color.Web Safe Colors Lists the web safe colors for you to select one. Color Picker tab This tab allows you to customize the toolbars in JReport Viewer. Transparent Click this swatch to delete the color and specify the object to be transparent. Color Indicator The upper part will be displayed in the color you selected from Web Safe Colors and labeled the hexadecimal value of the color (or "Transparent" if you click the Transparent swatch). . Clicking the lower part will restore the color to the original. . Color Indicator The upper part will be displayed in the color you have newly defined.Select Color Displays a color matrix. R Specifies the amount of red in a color. click anywhere in the matrix. Change saturation by moving the pointer horizontally. Color Slider Drag the slider to change the hue. To define a color. G Specifies the amount of green in a color. The lower part is always displayed in the original color. Clicking the lower part will restore the color to the original. and change brightness by moving the pointer vertically. Color Value Specifies the hexadecimal value of the color. .B Specifies the amount of blue in a color. The selected fields should be of the same type.Select Field dialog This dialog helps you to select some fields of the same type to replace the current fields in a filter control. Select Fields Specifies the fields which will replace the current fields in the filter control. Apply To Specifies the components to which the filter created with the filter control will be applied. . Help Displays this help document. .OK Applies the selected field to the filter control and closes the dialog. Cancel Cancels the selection and closes the dialog. Group Left Specifies to place the group by field in its own column left of the detail columns. Group Left Above Specifies to place the group by field in its own row and column above and left of the detail columns. Help Displays this help document.Select Group Position dialog The dialog helps you to specify the position of the group by field when you convert a table detail column to a group column. Cancel Cancels the conversion and closes the dialog. Group Above Specifies to place the group by field in its own row above the detail columns. . OK Applies the setting to convert the column and closes the dialog. all the dimension objects and detail information objects in the current business/ report cube and the dynamic formulas that have been created in the report will be listed. OK Applies the settings and closes this dialog. In this dialog.Select Resource dialog This dialog helps you to specify the field to which the dynamic measure object will be mapped. . Select the required field and then click OK to make it as the mapping field of the measure object. . Help Displays this help document.Cancel Closes the dialog. .Select Values dialog This dialog helps you to specify one or more values to apply a filter criterion. Chosen Lists all the values that have been chosen. Adds the selected value to the Chosen list. Available Specifies the values from this list to filter report data with. Add Adds a new line to the Chosen list for you to input a value. You can also double-click the item to edit it. Go to Goes to the specified value list. Prev Fetches the previous value list.Edit Edits the selected item in the Chosen list. Input a number N here and click the Get button to fetch a value list starting from the Nth value. . Help Displays this help document. Next Fetches the next value list. Remove Removes the selected item from the Chosen list. Number of List Items Specifies the number of list items here and click the Get button to fetch a value list. OK Applies all changes and closes this dialog. Cancel Closes the dialog and deletes any unsaved changes. Sort dialog This dialog helps you to specify the settings in order to sort the records or groups in a banded object. Descend Specifies to sort the data descendingly. Sort in Scope Specifies on which level the sorting is based. Moves up a sort expression line. Deletes the specified sort expression line. . Ascend Specifies to sort the data ascendingly. Field Specifies the field by which to sort the records or groups. This button appears after the first sort condition has been composed. Reset Restores this dialog to its opening status.Moves down a sort expression line. Apply Accepts the changes and re-loads the report result using the sort settings with this dialog displayed. Help Displays this help document. . Cancel Cancels the operation and closes this dialog. OK Accepts the changes and re-loads the report result using the sort settings with this dialog closed. Adds a new sort expression line after the current one. General tab This tab shows some general information of the special field. . Cancel Cancels the settings and closes this dialog.Special Field Properties dialog This dialog helps you to edit the properties of a special field. Help Displays this help document. It contains the following tabs: q General tab Font tab Border tab Others tab Display tab q q q q OK Applies the settings and closes this dialog. Select a new one from the drop-down list if you want to change the type. or a text box. Static: The special field will be positioned at the default location in its container. Relative: The special field will be positioned according to its default location and the X and Y property values. which will be shown on the shortcut menu of the special field. q Absolute: The special field's position will be decided by its X and Y property values. Y and other position-related properties will be hidden or disabled. its position mode can be modified. If selected. If the special field is directly contained in the report body. a tabular cell. q q Type Specifies the type of the special field. Position Specifies the position mode of the special field.Name Specifies the display name of the special field. the X. The following types are available: q Fetch Date Prints the date when the data is retrieved from the database. . Modified Date Prints the last modified date for the catalog. which is usually placed in the Details panel. You can specify the format of this special field in the Report Inspector. which is usually placed in the Group Header/Footer panel.q Fetch Time Prints the time when the data is retrieved from the database. q . Group Number Prints the group number. Record Number Prints the record number. Global Page N of M Prints a specific global page number out of the global total page number. SQL Statement Prints the SQL statements used to execute the query. Page Number Prints the page number for each page. Print Time Prints the current time on your computer. The operation is the same as Page N of M. Task ID Prints the internal task ID. Print Date Prints today's date (or the date designated on your computer). which usually placed in the Group Header/Footer panel. Modified Time Prints the last modified time for the catalog. Page N of M Prints the page number of the total page number. even though you have set the property Maximum Records before setting the filters. If you set filter conditions in the Filter dialog. print the number of records obtained after performing the filters. r q Total Group Number Prints the total group number. Total Fetched Records Prints the total number of records which take part in grouping calculation. Group Name Prints the group name. which is a unique time stamp. The possible result of the special field is as follows: r q q q q q q q q q q q q q q q If you don't set any filter condition in the Filter dialog. Total Page Number Prints the total number of pages in the report. Global Total Page Number Prints the global total page number of the whole report wherever the field is placed. print the very number of the record obtained after setting the property Maximum Records. which is usually placed in the group Header/Footer panel. Global Page Number Prints the global page number of the whole report wherever it is placed. or input a color string in the text box. except the ones created in the Filter dialog of JReport Viewer. . If you want to make the background transparent. or input a color string in the format #RRGGBB. Width Specifies the width of the special field. Height Specifies the height of the special field. and the Group Filter dialog and top N or bottom N condition in JReport Designer. input Transparent in the text box.q Total Records Prints the total number of records after all the filter conditions are performed. q X Specifies the X coordinate of the special field. Foreground Specifies the foreground color of the special field. You can modify all the font settings in this tab. Background Specifies the background color of the special field. User Name Prints the User ID with which you log onto JReport Server. To change the color. To change the color. click the color indicator to bring out the Select Color dialog and then specify a new color. click the color indicator to bring out the Select Color dialog and then specify a new color. Y Specifies the Y coordinate of the special field. Font tab This tab shows the font-related information of the special field. Size Specifies the font size of the field text. Horizontal Alignment Specifies the horizontal alignment mode of the text in the special field. Strikethrough . Vertical Alignment Specifies the vertical alignment mode of the text in the special field. Underline Specifies whether the field text will be underlined or not.Font Specifies the font face of the field text. Bold Specifies whether to make the object text bold or not. JReport will parse HTML tag elements in the field value while the report is to be saved as an HTML file. will not be parsed). You can modify all the border settings in this tab. Word Wrap Specifies whether or not to wrap the text to the special field width. Border tab This tab shows information about borders of the special field. Ignore HTML Tag If this option is unchecked.Specifies whether or not to attach a strikeout line to the field text. if any. Repeat Specifies whether to repeat the group name in the report result. Autofit Specifies whether or not to automatically adjust the width of the special field. Only available for table and it takes effect only when the group by field is placed in the detail row. Italic Specifies whether to make the field text italic or not. . or the field value will appear in the HTML file the same as that in JReport Viewer (HTML tag elements in the field value. Left Line Specifies the style of the left border line. Top Line Specifies the style of the top border line. Width Specifies the border width. Bottom Line Specifies the style of the bottom border line. Right Line Specifies the style of the right border line.Color Specifies the border color. Shadow . the special field will be exported when you save the report result as an XLS file (make sure to check Excel 2000 in the Export dialog). Others tab You can use this tab to view and configure some miscellaneous settings. Suppress When No Records If true (checked) and no records are returned by the report. Shadow Color Specifies the color of the border shadow. . Export to XLS If true (checked). TOC Anchor Specifies whether or not to add the node that represents the special field to the TOC tree that is displayed in the TOC Browser. the special field will not be displayed.Specifies whether the borders will have a shadow effect or not. .Export to CSV If true (checked). Available only for the group by fields in table. q current column The object will take value of the group by field in the current column. q Display tab You can use this tab to modify the render type of the special field. For details. Logic Column Specifies whether to show the special field in the next visible table cell in the same row when the column which holds the field is hidden. current row The object will take value of the group by field in the current row. see the Data Field Properties dialog. Data Evaluation Setting Specifies the group information for the object. the special field will be exported when you save the report result as a TXT file with Delimited Format selected. . Cancel Discards any modifications and closes this dialog. Input a positive integer in the text box to specify the number. OK Closes this dialog and applies the settings. Number of Columns Specifies the number of columns the tabular cell will be split into. Input a positive integer in the text box to specify the number. Number of Rows Specifies the number of rows the tabular cell will be split into. Help Displays this help document.Split dialog This dialog helps you to specify the number of rows and columns that the specified tabular cell will be split into. Cancel Cancels the settings and closes this dialog. .Table Cell Properties dialog This dialog helps you to edit the properties of a table cell. Help Displays this help document. General tab This tab shows some general information of the table cell. It contains the following tabs: q General tab Border tab Others tab q q OK Applies the settings and closes this dialog. or input a color string in the format #RRGGBB. input Transparent in the text box. . Background Specifies the background color of the table cell. which will be shown on the shortcut menu of the table cell. Border tab This tab shows information about borders of the table cell. click the color indicator to access the Select Color dialog and then specify a new color. To change the color.Name Specifies the display name of the table cell. If you want to make the background transparent. You can modify all the border settings in this tab. Width Specifies the border width. Right Line Specifies the style of the right border line. Left Line Specifies the style of the left border line. Bottom Line Specifies the style of the bottom border line.Color Specifies the border color. Top Line Specifies the style of the top border line. . the table cell will be exported when you save the report result as a TXT file with Delimited Format selected. When the Position property for the object in the cell is set to absolute. Vertical Alignment . the table cell will be exported when you save the report result as an XLS file (make sure to check Excel 2000 in the Export dialog). Export to CSV If true (checked). Export to XLS If true (checked).Others tab You can use this tab to view and configure some miscellaneous settings. Horizontal Alignment Specifies the horizontal alignment mode of the content in the table cell. this property does not take effect. q Row . None .The current cell provides header information for the rest of the row that contains it. Column . When the Position property for the object in the cell is set to absolute. this property does note take effect. This attribute specifies the set of data cells for which the current header cell provides header information.The current cell provides header information for the rest of the column that contains it. q q . Scope A representation of the standard HTML attribute scope.Specifies the vertical alignment mode of the content in the table cell.The scope attribute will not be generated when exporting to HTML. Cancel Cancels the settings and closes this dialog. General tab This tab shows some general information of the table. Help Displays this help document.Table Properties dialog This dialog helps you to edit the properties of a table. . It contains the following tabs: q General tab Border tab Others tab q q OK Applies the settings and closes this dialog. Y and other position-related properties will be hidden or disabled. Relative: The table will be positioned according to its default location and the X and Y property values. or a text box.Name Specifies the display name of the table. q Absolute: The table's position will be decided by its X and Y property values. a tabular cell. which will be shown on the shortcut menu of the table. If selected. q q X Specifies the X coordinate of the table. the X. Y . Position Specifies the position mode of the table. Static: The table will be positioned at the default location in its container. its position mode can be modified. If the table is directly contained in the report body. input Transparent in the text box. Width Specifies the width of the table. To change the color.Specifies the Y coordinate of the table. click the color indicator to bring out the Select Color dialog and then specify a new color. If you want to make the background transparent. Border tab This tab shows information about borders of the table. Background Specifies the background color of the table. or input a color string in the format #RRGGBB. . Height Specifies the height of the table. Right Line Specifies the style of the right border line. Top Line Specifies the style of the top border line. Width Specifies the border width. Left Line Specifies the style of the left border line. Others tab You can use this tab to view and configure some miscellaneous settings. .Color Specifies the border color. Bottom Line Specifies the style of the bottom border line. Export to XLS If true (checked). Export to CSV If true (checked). the table will not be displayed.TOC Anchor Specifies whether or not to add the node that represents the table to the TOC tree that is displayed in the TOC Browser. . Suppress When No Records If true (checked) and no records are returned by the report. the table will be exported when you save the report result as an XLS file (make sure to check Excel 2000 in the Export dialog). the table will be exported when you save the report result as a TXT file with Delimited Format selected. . Help Displays this help document. It contains the following tabs: q General tab Others tab q OK Applies the settings and closes this dialog. Cancel Cancels the settings and closes this dialog.Table Row Properties dialog This dialog helps you to edit the properties of a table row. General tab This tab shows some general information of the object. click the color indicator to access the Select Color dialog and then specify a new color. If you want to make the background transparent. . Background Specifies the background color of the table row. To change the color.Name Specifies the display name of the table row. or input a color string in the format #RRGGBB. input Transparent in the text box. which will be shown on its shortcut menu. Others tab You can use this tab to view and configure some miscellaneous settings. Export to XLS If true (checked). the table row will be exported when you save the report result as a TXT file with Delimited Format selected. . Export to CSV If true (checked).Suppress When No Records If true (checked) and no records are returned by the report. the table row will not be displayed. the table row will be exported when you save the report result as an XLS file (make sure to check Excel 2000 in the Export dialog). Data screen Specifies the business/report cube to use to create the table. Next Goes to the next screen. Finish Creates a report containing the table and closes the wizard.Table Wizard This wizard guides you through the process of creating a table report. It contains the following screens: q Data screen Display screen Group screen Summary screen Query Filter screen Style screen q q q q q Back Returns to the previous screen. . Help Displays this help document. This screen is hidden when there is only one cube in the current catalog. Cancel Closes the wizard without creating a report. . Display screen Specifies the fields to be displayed in the table. with which you can create the table.Available Data Resources Lists all the available business/report cubes in the current catalog. Display Fields . Removes the selected cube element.Resources Displays all the cube elements in the selected business/report cube. Adds the selected cube element to be displayed in the table. Moves the selected cube element one step down.Lists the cube elements that have been added to the table. . Display Name Specifies the display names of the added cube elements. Group screen Specifies the fields to group the data. Moves the selected cube element one step up. Descend. or No Sort.Resources Displays all the available dimension objects you can use to group the data in the table. Moves the selected group one step up. Moves the selected group one step down. Group By Lists all the dimension objects that have been added as group fields. Adds the selected dimension object as a group field. Summary screen Specifies the fields on which to create aggregation functions. Removes the selected dimension object. . Sort Specifies the sort order for each group: Ascend. Resources Displays all the available measure objects you can use to create aggregation functions in the table. . Removes the selected measure object. Adds the selected measure object as the summary field. Moves the selected measure object one step up. Display Name Specifies the display names of the measure objects.Summarized Fields Lists the groups that have been created in the table and the measure objects you have added to summarize data in each group. Moves the selected measure object one step down. Query Filter screen Specifies the filter which you want to apply to the selected business/report cube. . all the predefined filters of the business/report cube are listed in the Query Filter drop-down list. You can choose one of them to apply. If you prefer to define a filter on your own. select User Defined from the drop-down list. This screen is hidden when there is only one style available to be applied to the table. Style screen Specifies the style of the table. and then define it according to your requirements. refer to Query Filter dialog.In this screen. For details about options in the screen. . . Inherit Style Specifies to take the style of the parent component. Preview Shows a preview of the selected style.Style Lists all table styles for you to select one from. The option is available only when you specify to insert the table into a banded object. General tab This tab shows some general information of the tabular cell.Tabular Cell Properties dialog This dialog helps you to edit the properties of a tabular cell. It contains the following tabs: q General tab Border tab Others tab q q OK Applies the settings and closes this dialog. . Cancel Cancels the settings and closes this dialog. Help Displays this help document. . or input a color string in the format #RRGGBB.Name Specifies the display name of the tabular cell. which will be shown on its shortcut menu. input Transparent in the text box. Background Specifies the background color of the tabular cell. click the color indicator to access the Select Color dialog and then specify a new color. Border tab This tab shows information about borders of the tabular cell. To change the color. If you want to make the background transparent. Left Line Specifies the style of the left border line. Bottom Line Specifies the style of the bottom border line. Top Line Specifies the style of the top border line.Color Specifies the border color. Right Line Specifies the style of the right border line. . Width Specifies the border width. . Export to XLS If true (checked). the tabular cell will be exported when you save the report result as an XLS file (make sure to check Excel 2000 in the Export dialog).Others tab You can use this tab to view and configure some miscellaneous settings. Export to CSV If true (checked). the tabular cell will be exported when you save the report result as a TXT file with Delimited Format selected. Cancel Cancels the settings and closes this dialog. General tab This tab shows some general information of the tabular. . It contains the following tabs: q General tab Others tab q OK Applies the settings and closes this dialog. Help Displays this help document.Tabular Properties dialog This dialog helps you to edit the properties of a tabular. Relative: The tabular will be positioned according to its default location and the X and Y property values. If the tabular is directly contained in the report body. the X.Name Specifies the display name of the tabular. . a tabular cell. its position mode can be modified. If selected. Static: The tabular will be positioned at the default location in its container. which will be shown on the shortcut menu of the tabular. Position Specifies the position mode of the tabular. q Absolute: The tabular's position will be decided by its X and Y property values. or a text box. q q Vertical Auto Size Specifies whether or not to automatically adjust the height of the tabular according to the size of the components inserted. Y and other position-related properties will be hidden or disabled. If you want to make the background transparent. . Others tab You can use this tab to view and configure some miscellaneous settings. Y Specifies the Y coordinate of the tabular.Horizontal Auto Size Specifies whether or not to automatically adjust the width of the tabular according to the size of the components inserted. Height Specifies the height of the tabular. click the color indicator to access the Select Color dialog and then specify a new color. To change the color. X Specifies the X coordinate of the tabular. Width Specifies the width of the tabular. input Transparent in the text box. Background Specifies the background color of the tabular. or input a color string in the format #RRGGBB. Export to CSV If true (checked). Suppress When No Records If true (checked) and no records are returned by the report. . the tabular will be exported when you save the report result as a TXT file with Delimited Format selected. the tabular will be exported when you save the report result as an XLS file (make sure to check Excel 2000 in the Export dialog). Export to XLS If true (checked). the tabular will not be displayed.TOC Anchor Specifies whether or not to add the node that represents the tabular to the TOC tree that is displayed in the TOC Browser. Cancel Cancels the settings and closes this dialog. It contains the following tabs: q General tab Border tab Others tab q q OK Applies the settings and closes this dialog.Text Box Properties dialog This dialog helps you to edit the properties of a text box. . General tab This tab shows some general information of the text box. Help Displays this help document. Vertical Auto Size . Relative: The text box will be positioned according to its default location and the X and Y property values. q Absolute: The text box's position will be decided by its X and Y property values. the X. Static: The text box will be positioned at the default location in its container. Y and other position-related properties will be hidden or disabled.Name Specifies the display name of the text box. a tabular cell. If the text box is directly contained in the report body. Position Specifies the position mode of the text box. q q Vertical Alignment Specifies vertical justification of the text in the text box. which will be shown on its shortcut menu. its position mode can be modified. or a text box. If selected. To change the color. input Transparent in the text box. If you want to make the background transparent. X Specifies the X coordinate of the text box.Specifies whether or not to automatically adjust the height of the text box according to the size of the components inserted. . or input a color string in the format #RRGGBB. Border tab This tab shows information about borders of the text box. click the color indicator to bring out the Select Color dialog and then specify a new color. Y Specifies the Y coordinate of the text box. Width Specifies the width of the text box. Background Specifies the background color of the text box. Height Shows the height of the text box. Right Line Specifies the style of the right border line.Color Specifies the border color. Top Line Specifies the style of the top border line. Bottom Line Specifies the style of the bottom border line. . Left Line Specifies the style of the left border line. Width Specifies the border width. Others tab You can use this tab to view and configure some miscellaneous settings. the text box will not be displayed. Suppress When No Records If true (checked) and no records are returned by the report. TOC Anchor Specifies whether or not to add the node that represents the text box to the TOC tree that is displayed in the TOC Browser. Export to XLS If true (checked). Export to CSV If true (checked). the text box will be exported when you save the report result as an XLS file (make sure to check Excel 2000 in the Export dialog). the text box will be exported when you save the report result as a TXT file with . Delimited Format selected. . Value Specifies a positive integer N here so that records with the field value equal to one of the top N field values will be displayed.Top N dialog This dialog helps you to filter data to display records that meet the Top N condition. Cancel Closes the dialog and discards any changes. Help Displays this help document. . OK Applies the settings and closes the dialog. OK Applies the settings and closes the dialog. Next Goes to the next tab. . Cancel Cancels the settings and closes the dialog. Chart Type tab This tab allows you to set the type of the chart.To Chart dialog This dialog helps you to specify settings for converting a crosstab into a chart. It contains the following tabs: q Chart Type tab Display tab Style tab q q Back Returns to the previous tab. Help Displays this help document. Subtype Shows subtypes of the selected chart type in thumbnail form. Chart Type Groups Lists the subtypes defined for the chart. .Chart Type Lists all chart types for you to select one. Removes the selected subtype. Display tab This tab allows you to set the fields that will be displayed in the chart. Resources . . It is hidden when there is only one style available. Adds the selected dimension or measure object to be displayed in the chart. Category Lists the dimension object Series Lists the dimension object Show Values Lists the measure objects Order/Select N Opens the Order/Select N dialog to define the sort order and Select N condition in the chart. that will be displayed on the series axis of the chart.Displays all the cube elements used in the crosstab. that will be displayed on the category axis of the chart. Style tab This tab allows you to select a style for the chart. that will be displayed on the value axis of the chart. Removes the selected cube element. Style Lists all the styles for you to select from. q Custom There is no style information in this style and it is only used to support reports built with previous versions which did not bind any style or the bound style cannot be found in the style list. Preview Shows a preview of the selected style. . Inherit Style Specifies to take the style of the parent component. The option is available when the crosstab is in a banded object. . It contains the following tabs: q Display tab Style tab q Back Returns to the previous tab. Cancel Cancels the settings and closes the dialog. Help Displays this help document. Display tab This tab allows you to set the data fields that you want to display in the crosstab. OK Applies the settings and closes the dialog.To Crosstab dialog This dialog helps you to specify settings for converting a chart into a crosstab. Next Goes to the next tab. . Columns/Rows . Removes the selected cube element.Resources Displays the cube elements used in the chart. Adds the selected cube element to the crosstab. q q Aggregates Lists the measure objects q that will be the aggregate fields of the crosstab. You can edit the names if required. You can edit the names if required. q Moves the selected cube element one step up. Display Name Lists the display name for the selected measure objects. Display Name Lists the display name for the selected dimension objects.Lists the dimension objects q that will be displayed on the columns/rows of the crosstab. Moves the selected cube element one step down. Field Lists the measure objects that you selected to display in the crosstab. . Sort Specifies how the selected dimension objects will be sorted. Style tab This tab allows you to select a style for the crosstab. Field Lists the dimension objects that you selected to display in the crosstab. It is hidden when there is only one style available. Inherit Style Specifies to take the style of the parent component. Preview Shows a preview of the selected style. q Custom There is no style information in this style and it is only used to support reports built with previous versions which did not bind any style or the bound style cannot be found in the style list. The option is available when the chart is in a table .Style Lists all the styles for you to select one. .or banded object. Help Displays this help document. Go Goes to the specified page. Cancel Closes this dialog without turning the report page. .Turn to Page dialog This dialog helps you to input the page number so as to turn to the specified page. Input Page Number Specifies the page number you would like to turn to. . Cancel Closes this dialog without changing the magnification of the report page. Help Displays this help document. Zoom to Specifies the magnification in percentage. OK Closes this dialog and zooms the report page in or out to the magnification.Zoom dialog This dialog helps you to set a magnification of the report page. you will go through the following dialogs. q Add Aggregation dialog Aggregate On dialog Button Properties dialog Category Options dialog Chart Properties dialog Chart Wizard Color Picker dialog Conditional Formatting dialog Crosstab Properties dialog Crosstab Wizard Edit Additional Value dialog Edit Conditions dialog Edit Detail Table dialog Edit Image dialog Edit Link dialog Edit Multimedia dialog Enter Values dialog Export dialog Field Properties dialog Fill Effects dialog Filter Control Properties dialog Filter dialog Filter Inspector dialog Flash Properties dialog q q q q q q q q q q q q q q q q q q q q q q q . This section introduces each of these dialogs in alphabetical order. You can go into the links for details.JReport Studio dialogs While using JReport Studio. q Font dialog Format Category(X) Axis dialog Format Category(X) Gridline dialog Format Floor dialog Format Legend dialog Format Paper dialog Format Platform dialog Format Value(Y) Axis dialog Format Value(Y) Gridline dialog Format Wall dialog Formula Editor dialog Group Footer Properties dialog Group Header Properties dialog Image Properties dialog Insert Chart dialog Insert Crosstab dialog Insert Filter Control dialog Insert Image dialog Insert Multimedia dialog Insert Parameter Control dialog Insert Parameter Form Control dialog Insert Table dialog JReport Studio Wizard Label Properties dialog Navigation Control Properties dialog Page Setup dialog Parameter Control Properties dialog Parameter Field Properties dialog Parameter Form Control Properties dialog q q q q q q q q q q q q q q q q q q q q q q q q q q q q . q PDF Encrypt Option dialog PDF Sign Option dialog Print dialog Query Filter dialog RealMedia Properties dialog Report Body Properties dialog Report Parameters dialog Save As dialog Select a Report dialog Select Field dialog Select Resource dialog Select Values dialog Series Options dialog Special Field Properties dialog Split Cell dialog Summary Properties dialog Table Cell Properties dialog Table Footer Properties dialog Table Header Properties dialog Table Properties dialog Table Wizard Tabular Cell Properties dialog Tabular Properties dialog To Chart dialog To Crosstab dialog Windows Media Properties dialog q q q q q q q q q q q q q q q q q q q q q q q q q . then click <Add Aggregation…> or right-click a dynamic aggregation and then select Edit from the shortcut menu. Resource Name Click dialog.Add Aggregation dialog This dialog is displayed when you expand the Dynamic Resource > Aggregations node in the Resources panel. It helps you to create or edit a dynamic aggregation in a report. Maximum This function returns the highest value referred to by the argument. Minimum This function returns the lowest value referred to by the argument. Average The function is used to get the average value of the values referred to by the argument. Sum This function computes the sum of all the values referred to by the argument. q Count This function computes the number of values referred to by the argument. to select a field or a formula on which the aggregation is based on in the Select Resource Aggregate Specifies the function for the aggregation. DistinctCount q q q q q . Variance This function computes the variance of all the values referred to by the argument. OK Creates or edits the aggregation and closes the dialog.This function computes the number of distinct values referred to by the argument. StdDev This function computes the standard deviation of the values referred to by the argument. Help Displays this help document. q PopulationStdDev This function computes the population standard deviation of the values referred to by the argument. the aggregation name will change accordingly. q q Aggregation Name Specifies the name of the aggregation. Note that when you changing the resource name or aggregate function. Cancel Cancels the operation and closes the dialog. . Click a column header to select the column. click the Aggregate On button . Aggregate On Displays the field bound with the detail column. Function Specifies the function to summarize the field in the detail column. OK Creates the aggregation and closes the dialog. The field will be used to create the aggregation. Help Displays this help document. q It helps you to create a dynamic aggregation directly based on the field bound with the selected table detail column. . then on the Context toolbar.Aggregate On dialog The dialog appears when you do either of the following: q Right-click the field in a table detail column and select Aggregate On from the shortcut menu. Cancel Does not retain any changes and closes the dialog. Image Button The button is displayed as an image. q Button When Button is selected as the button type. Button Type q Button The button is displayed as a normal button. the following options are available. .Button Properties dialog This dialog appears when you right-click a button in a navigation control and select Properties from the shortcut menu. It helps you to modify the properties of the button. Font Style Specifies the font style of the text. Align Specifies the alignment way of the label in the button. Left Line Specifies the style of the left border line. q Color Specifies the border color. Top Line Specifies the style of the top border line. q q q q q Border Specifies the properties of the button border. or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB. q Background Specifies the background color of the button body. Font Color Specifies the font color of the text. click the color indicator to select a color. q . Font Specifies the font face of the text. Thickness Specifies the border width. q q q q q Button Body Specifies the properties of the button body. Font Size Specifies the font size of the text. q Width Specifies the width of the button. Right Line Specifies the style of the right border line. To change the color. If you want to make the background transparent. Bottom Line Specifies the style of the bottom border line.Button Label Specifies the properties of the button label. input Transparent in the text box. q Text Specifies the text of the label. Height Specifies the height of the button. . r File Name Specifies the path and name of the image file. Image From Specifies the source of the image file. q Local File Specifies to use an image from the local file system.Preview Displays a preview of the button according to the button properties. the following options are available. Image Button When Button Image is selected as the button type. You can click the Browse button to locate the image file. bat. Preview Displays a preview of the selected image. JReport will record the latest 10 entered URLs in the drop-down list. to successfully access the image via URL. Select the one you want to use. you need to add the parameters -Dhttp. OK Applies the button properties and closes this dialog.q Web URL Specifies to use an image via URL. q Library Specifies to use an existing image. r My Images The My Images folder is a virtual location where JReport Server stores the images that have once been inserted into reports. Cancel Cancels the changes and closes this dialog. Note: If your JReport Server is in an intranet. which locates in <install_root>\bin.proxyPort=XX to the server's startup file JRServer. r Image URL Specifies the URL of the image file. Help Displays this help document. .proxyHost=XXX -Dhttp. Chart Wizard. It helps you to set the sort order of the category values and define the number of the category values that will be displayed in the chart. No Sort Keeps the data in their original order in database.Category Options dialog This dialog appears when you click the Top N button above the Category box in the Bind Data screen of chart in the JReport Studio Wizard. Insert Chart dialog. or To Chart dialog. q q Category Selection Specifies the number of the category values that will be displayed in the chart. Category Order Specifies in which order data on the category axis of a chart will be displayed. Descend Lists data in a descending order. q Ascend Lists data in an ascending order. . Skip First If you check the Skip First option and input a number M in the text field to the right. specify a number in the field to the right and the last N category values will be displayed. Top N If selected. specify a number in the field to the right and the first N category values will be displayed. then the first M category values in the chart will be skipped and the Select N condition will take effect beginning with M+1. . Check this option and then type a character string in the text field to group all the category values beyond the top/ bottom N range. q q OK Accepts the changes and closes the dialog. the category values will be sorted by the order specified in the Category Order box of the dialog. Bottom N If selected.q Select Specifies the Select N condition to define the number of the category values that will be displayed. Help Displays this help document. The skipped values will be included in the Remaining Categories group together with all the category values beyond the top/bottom N range. Cancel Discards the changes and closes the dialog. all category values will be displayed. If unchecked. r r q Based On If checked. r All If selected. the category values will be sorted by values of the summary selected with the direction specified. Remaining Categories In Enabled only when Top N or Bottom N is selected from the Select drop-down list. Name Specifies the display name of the chart. center: Aligns the chart in the center of the report. Horizontal Alignment Specifies the horizontal justification of the chart.Chart Properties dialog The dialog appears when you right-click a chart and select Properties from the shortcut menu. Show Floor . which will be shown on the shortcut menu of the chart. Show Wall Specifies whether to show the wall in the chart. Choose an option from the drop-down list. It helps you to specify the properties of the chart. Height Specifies the height of the chart. right: Aligns the chart on the right of the report. Show Legend Specifies whether to make the legend in the chart visible. q q Width Specifies the width of the chart. q left: Aligns the chart on the left of the report. Help Displays this help document. Show Axis X Specifies whether to show the axis X. Cancel Cancels the changes and closes this dialog. Show Gridline Y Specifies whether to show the gridlines perpendicular to the axis Y. Show Gridline X Specifies whether to show the gridlines perpendicular to the axis X. . OK Applies the chart properties and closes this dialog. Show Axis Y Specifies whether to show the axis Y. only for 3-D chart types.Specifies whether to show the floor. q q Right-click the icon of a chart or any part of a chart other than the legend and label. then select Chart Wizard from the shortcut menu. then click Menu > Edit > Wizard. Select a chart. Chart Title Specifies a title for the chart. It helps you to change data and modify the type of the chart.Chart Wizard This wizard is displayed when you do one of the following: q Select a chart. then click the Chart Wizard button on the Context toolbar. . Show Values Lists the values you want to show in the chart. font style. alignment. q Adds a combo chart to the Primary Axis or Secondary Axis. Adds the selected resource to be displayed in the chart. Moves the selected view element one level up. that will be displayed on the category axis of the chart. Opens the Edit Additional Value dialog to edit the selected additional value. font color and background color properties for the chart title.Sets the font. size. . Resources Displays the view elements in the selected business view. Category Lists the group object Series Lists the group object that will be displayed on the series axis of the chart. Moves the selected view element one level down. Filter Opens the Query Filter dialog to specify the filter which you want to apply to the selected business view. q Primary Axis Adds a chart type to the primary axis. Active only when the option Secondary Axis is checked. Opens the Category Options dialog or Series Options dialog to define the sort order of the category or series values and specify the number of the category or series values that will be displayed in the chart. Secondary Axis Adds a chart type to the secondary axis. Edits the selected dynamic resource. Secondary Axis Specifies whether to show the secondary axis in the chart. Data Source Displays the business view that has been used in the chart. Help Displays this help document. . Cancel Cancels the changes and closes the wizard. OK Applies the changes and closes the wizard.Removes the selected resource. Standard tab This tab allows you to select one from the web safe color swatches.Color Picker dialog This dialog helps you to specify a color for an object. It contains the following tabs: q Standard tab Custom tab q OK Closes this dialog and returns the color value specified. Help Displays this help document. . Cancel Closes this dialog without changing the color value. The value is from 0 to 255.Web Safe Colors Lists the web safe colors for you to select one. G Specifies the amount of green in a color. # Specifies the hexadecimal value of the color. R Specifies the amount of red in a color. New . The value is from 0 to 255. The value is from 0 to 255. B Specifies the amount of blue in a color. Color matrix Select a color you want in the color matrix. R . Clicking this part will restore the color to the original. The hue of the matrix is based on the color you define on the color bar. Color bar Specifies a color on the bar which will be the hue of the color matrix.This part displays the color you select. Current This part always displays the original color. Custom tab This tab allows you to customize the color within a wider range. Clicking this part will restore the color to the original. The value is from 0 to 255. The value is from 0 to 255. G Specifies the amount of green in a color. B Specifies the amount of blue in a color. Current This part always displays the original color. The value is from 0 to 255. New This part displays the color you select. .Specifies the amount of red in a color. # Specifies the hexadecimal value of the color. It helps you to add some conditional formats to values of the selected field. . q Edits the selected condition. q Adds a new condition in the Edit Conditions dialog. Condition Displays all the conditions you have already added.Conditional Formatting dialog This dialog appears when you right-click a field and select Conditional Formatting from the shortcut menu. Format Specifies the format which will be applied to the field values when the specified condition is fulfilled.q Removes the selected condition. r Moves a condition down for a lower priority. r q Moves a condition up for a higher priority. Background Color Specifies the background color for the field values. Cancel Cancels the settings and closes the dialog. Size Specifies the font size for the field values. q Font Specifies the font type for the field values. Italic Specifies whether or not to make the field values italic. . q q q q q q q q OK Applies the settings and exits the dialog. Sample Text Displays a preview sample of your settings. Priority Specifies the priority of each condition. Bold Specifies whether or not to bold the field values. Border Specifies the border line style for the field values. Foreground Color Specifies the foreground color for the field values. Underline Specifies whether or not to underline the field values. Help Displays this help document. General tab This tab shows some general information of the crosstab.Crosstab Properties dialog The dialog appears when you right-click a crosstab and select Properties from the shortcut menu. It helps you to specify the properties of the crosstab and contains the following tabs: q General tab Border tab Crosstab tab Others tab q q q OK Applies the settings and closes this dialog. Help Displays this help document. . Cancel Cancels the settings and closes this dialog. Color Specifies the color of the borders. Choose an option from the drop-down list. Border tab This tab shows information about borders of the crosstab. Horizontal Alignment Specifies the horizontal justification of the crosstab. Width Specifies the width of the borders.Name Specifies the display name of the crosstab. q Left: Aligns the crosstab on the left of the tabular cell. input Transparent in the text box. If you want to make the background transparent. Center: Aligns the crosstab in the center of the tabular cell. or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB. To change the color. Right: Aligns the crosstab on the right of the tabular cell. Top Line . which will be shown on the shortcut menu of the crosstab. click the color indicator to select a color. q q Background Specifies the background color of the crosstab. Column Total on Left . Horizontal Gap Specifies the space between the content and left/right edge of a crosstab cell. Row Total on Top Specifies whether or not to display the Total rows for each column on the top of the crosstab. Choose a style from the drop-down list. Crosstab tab This tab shows the layout-related information of the crosstab. Left Line Specifies the line style of the left border.Specifies the line style of the top border. Choose a style from the drop-down list. Choose a style from the drop-down list. Vertical Gap Specifies the space between the content and top/bottom edge of a crosstab cell. Boundary Value Specifies the number of aggregate fields in one row/column. Bottom Line Specifies the line style of the bottom border. Right Line Specifies the line style of the right border. Choose a style from the drop-down list. Others tab You can use this tab to view and configure some miscellaneous settings.Specifies whether or not to display the Total columns for each row in the first column in the crosstab. Items per Row Block Specifies how many data blocks in the row direction should be split. Current Row Block Index Specifies the row index of data block. . Suppress Row Header Specifies whether or not to suppress the row headers. Table Style Specifies whether or not to add headers to the Total rows and columns. Current Column Block Index Specifies the column index of data block. Suppress Column Header Specifies whether or not to suppress the column headers. Items per Column Block Specifies how many data blocks in the column direction should be split. q q of a crosstab and select Crosstab Wizard from the shortcut menu. then click Menu > Edit > Wizard. Crosstab Title Specifies a title for the crosstab. then click the Crosstab Wizard button Right-click the icon on the Context toolbar. It helps you to change data of the crosstab.Crosstab Wizard This wizard is displayed when you do one of the following: q Select a crosstab. Select a crosstab. . Field Lists the group objects that will be displayed in the columns/rows of the crosstab. Label Specifies the display names of the aggregate/detail objects. You can double-click the cells to edit them if required. Adds the selected group object to be displayed on the rows of the crosstab.Sets the font. alignment. size. Aggregation Specifies the functions used to summarize data of the detail objects. Edits the selected dynamic resource. q q Summaries q Field Lists the aggregate/detail objects that you select to create summaries. You can double-click the cells to edit them if required. font color and background color properties for the crosstab title. . By default these are blank and no names will be created for the objects to label the summaries. Moves the selected view element one level down. By default these are blank and no names will be created for the group objects to label the columns/rows. font style. Data Source Displays the business view that has been used in the crosstab. Label Specifies the display names of the group objects. Filter Opens the Query Filter dialog to specify the filter which you want to apply to the selected business view. Adds the selected aggregation object Columns/Rows q or detail object to be the summary field of the crosstab. Sort Specifies the sort order of the group objects. Adds the selected group object to be displayed on the columns of the crosstab. q q Moves the selected view element one level up. Resources Displays the view elements in the selected business view. Help Displays this help document. OK Applies the changes and closes the wizard.Removes the selected resource. . Cancel Does not retain changes and closes the wizard. It also appears when you select an existing additional value and then click the Edit button helps you to edit an additional value. options in the dialog are as follows. Name Specifies the display name of the constant value. OK Applies the settings and closes the dialog. If it is an average value. Help Displays this help document. It varies according to value types. . The dialog If it is a constant value. Value Specifies a float number for the constant value. options in the dialog are as follows. which will be shown under the subtype in the Show Values box. . Cancel Closes the dialog and discards any changes.Edit Additional Value dialog This dialog is displayed when you add an additional value to the Show Values box in the chart wizard. Based On Specifies the aggregation object based on which the average value will be calculated.Name Specifies the display name of the average value. which will be shown under the subtype in the Show Values box. OK Applies the settings and closes the dialog. Cancel Closes the dialog and discards any changes. Help Displays this help document. . Cancel Cancels the settings and closes the dialog. It helps you to add a new condition or edit an existing condition for the selected field. . Basic mode The basic mode provides function for creating simple filter conditions which are connected by AND and OR operators. Help Displays this help document.Edit Conditions dialog The dialog appears when you click the button or in the Conditional Formatting dialog. and has the following two modes: q Basic Advanced q Advanced/Basic Switches the dialog to the advanced/basic mode. OK Applies the settings and exits the dialog. . Field Specifies the field to be filtered.Delete the current condition line. only "_" and "%" are supported. q q q q q q q q q Value Specifies the value of how to filter the field." or "\" is contained in the values. [not] like Like string pattern matching operator is used to compare the first expression string value to the pattern string (the second expression). used for evaluating for a true condition. q = Equal to > Greater than >= Greater than or equal to < Less than <= Less than or equal to != Not equal to [not] in Causes an enumerated list of values to appear in the WHERE clause predicate. q Advanced mode The advanced mode enables the building of more complex filter conditions via the grouping of conditions.". OR Logic operator OR which is applied to this and the next line.Operator Specifies the operator to compose the filter expression. You can either enter the value manually in the text box or select a value from the drop-down list." or "\ \". if multiple values are required. [not] between Allows the system to evaluate whether or not data values are located between a range of values indicated in the predicate. is [not] null It is used in WHERE clause predicates to match null values occurring in a specified data field. . When you type in the value manually. Logic Lists the logic operator. If you want to use wildcard character in the pattern string. they should be separated with ". q AND Logic operator AND which is applied to this and the next line. and if ". write it as "\. Delete Deletes the selected condition line. Group .Add Condition Adds a new condition line. " or "\ \". Value Specifies the value of how to filter the field. they should be separated with ". and then clicking the Group button. Conditions can also be added to an existing group by selecting the conditions and the group while holding the Ctrl button." or "\" is contained in the values.". write it as "\. Operator Specifies the operator to compose the filter expression. q AND Logic operator AND which is applied to this and the next line. When you type in the value manually. Logic Specifies the logic operator. Up Moves the selected condition or group up to a higher level. Condition Expression Displays the SQL statement of the condition. q q q Field Specifies the field to be filtered. OR NOT Logic operator OR NOT which is applied to this and the next line. OR Logic operator OR which is applied to this and the next line AND NOT Logic operator AND NOT which is applied to this and the next line. .Makes the selected conditions in a group. and if ". You can either enter the value manually in the text box or select a value from the drop-down list. Ungroup Makes the selected condition ungrouped. Down Moves the selected condition or group down to a lower level. if multiple values are required. It helps you to edit which fields will be displayed in the table when performing the go to detail action on the summary. Resources Displays all the group and detail objects in the selected business view.Edit Detail Table dialog This dialog appears when you right-click a summary and select Edit Detail Table from the shortcut menu. Removes the selected view element. Field Lists the view elements that have been added to the table. Label . Adds the selected view element to be displayed in the table. Moves the selected view element one step up. Help Displays this help document. . OK Applies the changes and closes the dialog. Cancel Cancels the changes and exits the dialog.Specifies the display names for the selected fields. Moves the selected view element one step down. It helps you to edit the image.proxyPort=XX to the server's startup file JRServer. q Library Specifies to use an existing image. . q Web URL Specifies to use an image via URL. Image From Specifies the source of the image file.proxyHost=XXX -Dhttp. r File Name Specifies the path and name of the image file. which is located in <install_root>\bin. q Local File Specifies to use an image from the local file system. You can click Browse button to locate the image file. Note: If your JReport Server is in an intranet which requires a proxy.Edit Image dialog This dialog appears when you right-click an image and select Edit from the shortcut menu.bat. you need to add the parameters -Dhttp. r Image URL Specifies the URL of the image file. to successfully access the image via URL. OK Applies the settings and closes the dialog. Preview Displays a preview of the selected image.r My Images The My Images folder is a virtual location where JReport Server stores the images that have once been inserted into reports. . Select the one you want to use. Cancel Cancels the changes and closes the dialog. Help Displays this help document. .Edit Link dialog This dialog appears when you right-click an object. It helps you to link the specified object to a report. Select Link Type Specifies the type of the link target. URL or E-mail address as required. click Edit Link on the shortcut menu. It can be one of the following: q Link to Report Link to URL Link to E-mail q q Link to Report It helps you to link a specified object to a report. Target Report Specifies the linked target report. Target Report Parameters Assigns values to the parameters of the target report. Main Report Field Lists all the DBFields. q Name Lists all parameters contained in the target report. summaries and parameters in the main report which are of the same data type as the parameters of the target report. q . formulas. OP Specifies the operator to set up links between the target report and the main report. .Target Component Specifies the target components in the selected report to link the object to. Removes the selected component. Removes the selected condition. Main Lists the DBFields in the main report which are of the same data type as the selected fields in the target report. Link to URL It helps you to link a specified object to a location specified by a URL. q Adds the selected field of the target report to set up link between the target report and the main report. q q q q Open in New Window If selected. q Adds the target components in the selected report to link the object to. Target Lists the selected fields of the target report. q Conditions Specifies the link conditions between the target report and the main report. the linked report will be loaded in a new window. Hyperlink Specifies the URL for the hyperlink that is to be used to link the object. . the URL will be loaded in a new window. Link to E-mail It helps you to link the specified object to an e-mail address. Open in New Window If selected. Hyperlink Specifies the e-mail address that the object will be linked to. Help Displays this help document. OK Applies the settings and closes the dialog. Cancel Cancels the changes and exits the dialog. . . Real Media File Specifies to insert a realmedia file to the current report. It helps you to edit the multimedia object.Edit Multimedia dialog This dialog appears when you right-click a multimedia object and select Edit from the shortcut menu. Type in the name or URL in the text box or click Browse to find the file. Windows Media File Specifies to insert a Windows Media file to the current report. File Name/URL Specifies the name or URL of the multimedia object that is to be inserted into the report. Flash Specifies to insert a flash file to the current report. q For Flash . Properties Specifies the properties of the multimedia object. Plug-in Page Specifies the URL of the plug-in page from which to download the player with which to play the multimedia object file (if it isn't already installed on your local disk). Auto Rewind Specifies whether or not to rewind the Windows Media file automatically. r r OK Applies the settings for the multimedia object and closes this dialog. Loop Number Specifies how many times you want to play the realmedia file. Play Count Specifies the number of times you want to play this media file. For Real Media File r r q r Auto Start Specifies whether to start the realmedia file automatically when the report is opened. . Cancel Cancels the edition and closes the dialog. Movie Quality Specifies the quality of the flash. Center Specifies whether to place the realmedia file in the center of the report. Loop Specifies whether to play the realmedia file repeatedly. Loop Specifies whether to play the flash file repeatedly.r Play Specifies whether to start the flash file automatically when the report is opened. For Windows Media File r r r q r Auto Start Specifies whether or not to start the Windows Media automatically when the report is opened. Help Displays this help document. while specifying values for a parameter. When the parameter is bound with a column.Enter Values dialog The dialog appears when you click the button you to specify multiple values for the parameter. Removes the selected values from the Selected Values box. It helps Available Values Lists all predefined parameter values for selection. Selected Values Lists the values selected. Adds all the selected values from the Available Values box to the Selected Values box. but the Display Column is different from the Bind Column. Adds the selected values from the Available Values box to the Selected Values box. The selected values are case sensitive. values of the Display Column are listed here. . All If selected. it means that the parameter value result is all the values in the DBMS. but the display column is different from the bind column. When the parameter is bound with a column. .CUSTOMERID. Cancel Does not retain any changes and closes the dialog.CUSTOMERS. Help Displays this help document. 2 and 3 as the parameter values.2. which are all the available values. you will get more customers even though available values are only 1 – 3. This is translated in SQL to remove the parameter which may select more values than listed in the available values list. CUSTOMERID>0 and CUSTOMERS. the (CUSTOMERS.Removes all the selected values from the Selected Values box. the field will show the string "All" which represents all the values in the DBMS. Note: When a multi-value parameter is inserted as a field into a report and All is selected as the value.CUSTOMERID<4 When you click SQL is: to add 1. the query is then: ( 1 = 1) In this case. OK Applies the selected values to the parameter and closes the dialog.CUSTOMERNAME FROM CUSTOMERS where CUSTOMERS. For example.CUSTOMERID IN ( 1. make sure the value you enter is that of the bind column. when the parameter query is: SELECT CUSTOMERS. This option is available when the parameter's Enable the "All" Option property is set to true in JReport Designer. Enter a value manually in the text box and then click the button next to add the value to the Selected Values box. Enter Values This option is available when the parameter's Allow Type-in of Value property is set to true in JReport Designer.3)) Run the same report again and this time check the All checkbox in the Enter Values dialog. Select Report Result Format Specifies the format to which the report result will be exported. otherwise you will be prompted to save the result file. the result will be directly opened in the web browser if the format is supported by a plug-in of the web browser. It helps you to set settings for exporting the report result to different formats.Export dialog This dialog appears when you click Menu > File > Export. View Report Result If selected. . the report result will be saved to a specified folder. q Style Group Specifies the style group that will be applied to the exported result. Help Displays this help document. Save to Version System If selected. When the <No Style> item in the Style Group drop-down list is selected. . Properties Specifies the properties for the selected format: r q PDF HTML Excel Text RTF XML PostScript r r r r r r OK Exports the report with the settings you specified. File Name Specify a name for the result file in the field. More/Less Options Click to show/hide the additional settings for exporting the report to the specified format.Save to File System If selected. the style group property defined for specific exporting format in JReport Designer will be applied to export the report result to that format. Cancel Cancels the operation and closes this dialog. the report result will be saved as a result version in JReport Server's versioning system. Field Properties dialog The dialog appears when you right-click a field and select Properties from the shortcut menu. It helps you to specify the properties of the field and contains the following tabs: q General tab Font tab Border tab q q OK Applies the settings and closes this dialog. Cancel Cancels the settings and closes this dialog. Help Displays this help document. General tab This tab shows some general information of the field. Name Specifies the display name of the field. Width Specifies the width of the field. Format Specifies the format of the field. Height Specifies the height of the field. Top Padding Specifies the space between the text of the field and its top border. Bottom Padding Specifies the space between the text of the field and its bottom border. Left Padding Specifies the space between the text of the field and its left border. Right Padding Specifies the space between the text of the field and its right border. Background Specifies the background color of the field. To change the color, click the color indicator to select a color, or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB. If you want to make the background transparent, input Transparent in the text box. Foreground Specifies the foreground color of the field. To change the color, click the color indicator to select a color, or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB. Font tab This tab shows the font-related information of the field. Font Specifies the font face of the text. Size Specifies the font size of the text. Horizontal Alignment Specifies the horizontal alignment mode of the text in the field. Vertical Alignment Specifies the vertical alignment mode of the text in the field. Bold Specifies whether to make the text bold or not. Underline Specifies whether the text will be underlined or not. Strikethrough Specifies whether or not to attach a strikeout line to the text. Italic Specifies whether to make the text italic or not. Autofit Specifies whether or not to automatically adjust the width of the field. Word Wrap Specifies whether or not to wrap the text to the field width. Ignore HTML Tag If this option is unchecked, JReport will parse HTML tag elements in the field value while the report is to be saved as an HTML file; or the field value will appear in the HTML file the same as that in JReport Studio (HTML tag elements in the field value, if any, will not be parsed). Border tab This tab shows information about borders of the field. Color Specifies the border color. Width Specifies the border width. Top Line Specifies the style of the top border line. Bottom Line Specifies the style of the bottom border line. Left Line Specifies the style of the left border line. Right Line Specifies the style of the right border line. Shadow Specifies whether the borders will have a shadow effect or not. Shadow Color Specifies the color of the border shadow. Fill Effects dialog This dialog helps you to specify either a gradient or an image as the fill effect of an object. It contains the following tabs: q Gradient tab Image tab q OK Applies the changes and closes the dialog. Cancel Does not retain any changes and closes the dialog. Help Displays this help document. Gradient tab This tab allows you to specify the gradient colors to fill the object. Fill Gradient Displays the type of gradient to fill the object. It is Linear by default. Start Color Specifies a color in the gradient graph. End Color Specifies the other color in the gradient graph. Start X Specifies the horizontal position, measured in the percentage of the object's width, from the left edge of the object, where the gradient starts. Start Y Specifies the vertical position, measured in the percentage of the object's height, from the top edge of the object, where the gradient starts. End X Specifies the horizontal position, measured in the percentage of the object's width, from the left edge of the object, where the gradient ends. End Y Specifies the vertical position, measured in the percentage of the object's height, from the top edge of the object, where the gradient ends. Preview Displays a preview of your settings. Image tab This tab allows you to specify an image to fill the object. Choose Image File Specifies the image file. Click Browse to select the required image. Display Specifies the layout style of the image in the object. It can be one of the following: Tile, Center and Scaled. Image X Displays the left position of the area, measured in the percentage of the image's width, from the left edge of the image. Image Y Displays the bottom position of the area, measured in the percentage of the image's width, from the bottom edge of the image. Width Displays the width of the area, measured in the percentage of the image's width. Height Displays the height of the area, measured in the percentage of the image's height. The above four options, namely Image X, Image Y, Width and Height, are used to define an area in the image and put the defined area of the image into the object. Their values are fixed. Preview Displays a preview of your settings. Filter Control Properties dialog This dialog appears when you right-click a filter control and select Properties from the shortcut menu. It helps you to edit the properties of the filter control and contains the following tabs: q General tab Font tab Border tab Title tab q q q OK Applies the settings and closes this dialog. Cancel Cancels the settings and closes this dialog. Help Displays this help document. General tab This tab shows some general information of the filter control. Name Specifies the name of the filter control. Format Specifies the field value format in the filter control. Filter On Displays the fields that the filter control is based on. You can click the button dialog to select other fields. Width Specifies the width of the filter control. Height Specifies the height of the filter control. Background Specifies the background color of the filter control. To change the color, click the color indicator to select a color, or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB. If you want to make the background transparent, input Transparent in the text box. Foreground Specifies the foreground color of the filter control. To change the color, click the color indicator to select a color, or click More Colors in the color indicator to to open the Select Field access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB. Show Title Specifies whether to show the title of the filter control. Font tab This tab shows the font-related information of the text in the filter control. Font Specifies the font face of the text. Size Specifies the font size of the text. Bold Specifies whether to make the text bold or not. Underline Specifies whether the text will be underlined or not. Italic Specifies whether to make the text italic or not. Border tab This tab shows information about borders of the filter control. Color Specifies the border color. Width Specifies the border width. Top Line Specifies the style of the top border line. Bottom Line Specifies the style of the bottom border line. Left Line Specifies the style of the left border line. Right Line Specifies the style of the right border line. Title tab This tab shows information about the title of the filter control. It is available when the Show Title option is selected in the General tab of the same dialog. Text Specifies the text of the title. q Auto Map Field Name Specifies whether to use the field name as the title. If selected, the Text box above is disabled for inputting. Background Specifies the background color of the title. To change the color, click the color indicator to select a color, or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB. If you want to make the background transparent, input Transparent in the text box. Foreground Specifies the foreground color of the title. To change the color, click the color indicator to select a color, or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB. Font Specifies the font face of the text. Size Specifies the font size of the text. Horizontal Alignment Specifies the horizontal alignment mode of the text. Bold Specifies whether to make the text bold or not. Underline Specifies whether the text will be underlined or not. Italic Specifies whether to make the text italic or not. Filter dialog The dialog appears when you click Menu > Edit > Filter. It helps you to set criteria for filtering records, and has the following two modes: q Basic Advanced q Inspector Opens the Filter Inspector dialog. Advanced/Basic Switches the dialog to the advanced/basic mode. OK Closes the dialog and filters the records of the report with the specified criteria. Cancel Cancels to set criteria for filtering records and exits the dialog. Help Displays this help document. Basic mode The basic mode provides function for creating simple filter conditions which are connected by AND and OR operators. Apply to Specifies the component to which the filter will be applied. Deletes the current condition line. Field Specifies the field to be filtered. Operator Specifies the operator to compose the filter expression. q = Equal to > Greater than >= Greater than or equal to < Less than <= Less than or equal to != Not equal to [not] in Causes an enumerated list of values to appear in the WHERE clause predicate, used for evaluating for a true condition. [not] like Like string pattern matching operator is used to compare the first expression string value to the pattern string (the second expression). If you want to use wildcard character in the pattern string, only "_" and "%" are supported. [not] between Allows the system to evaluate whether or not data values are located between a range of values indicated in the predicate. is [not] null It is used in WHERE clause predicates to match null values occurring in a specified data field. q q q q q q q q q Value Specifies the value of how to filter the field. You can either enter the value manually in the text box or select a value from the drop-down list. When you type in the value manually, if multiple values are required, they should be separated with ",", and if "," or "\" is contained in the values, write it as "\," or "\ \". Logic Lists the logic operator. q AND Logic operator AND which is applied to this and the next line. OR Logic operator OR which is applied to this and the next line. END Logic operator END which is applied to this line. q q Advanced mode The advanced mode enables the building of more complex filter conditions via the grouping of conditions. Apply to Specifies the component to which the filter will be applied. Add Condition Adds a new condition line. Delete Deletes the selected condition line or group. Group Makes the selected condition lines in a group. Condition lines can also be added to an existing group by selecting the condition lines and the group while holding the Ctrl button, and then clicking the Group button. Ungroup Makes the selected condition line or group ungrouped. Up Moves the selected condition line or group up to a higher level. Down Moves the selected condition line or group down to a lower level. Logic Specifies the logic operator. q AND Logic operator AND which is applied to this and the next line. OR Logic operator OR which is applied to this and the next line AND NOT Logic operator AND NOT which is applied to this and the next line. OR NOT Logic operator OR NOT which is applied to this and the next line. q q q Field Specifies the field to be filtered. Operator Specifies the operator to compose the filter expression. Value Specifies the value of how to filter the field. You can either enter the value manually in the text box or select a value from the drop-down list. When you type in the value manually, if multiple values are required, they should be separated with ",", and if "," or "\" is contained in the values, write it as "\," or "\ \". Condition Expression Displays the SQL statement of the filter. Filter Inspector dialog The dialog appears when you click the Inspector button in the Filter dialog. It lists all the filters the current web report is using for your information. Query Filter Lists the filters created via the Query Filter dialog. Dialog Filter Lists the filters created via the Filter dialog. On Screen Filter Lists the filters created via the Filter panel and via filter controls. Go To Filter Lists all the go to filters that are created when performing the go-to-by-value action on the report. OK Applies the changes and closes the dialog. Cancel Cancels the changes and exits the dialog. Help Displays this help document. Flash Properties dialog The dialog appears when you right-click a flash object and select Properties from the shortcut menu. It helps you to edit the properties of the flash object. Name Specifies the display name of the flash, which will be shown on the shortcut menu of the flash. Alternate Text Specifies the alternate text which will be shown if the flash cannot be displayed. Width Specifies the width of the flash. Height Specifies the height of the flash. Movie Quality Specifies the quality of the flash. Play Specifies whether to start the flash file automatically when the report is opened. Loop Specifies whether to play the flash file repeatedly. OK Applies the settings and closes this dialog. Cancel Cancels the settings and closes this dialog. Help Displays this help document. Font dialog This dialog appears when you select a label or field and click the Font button helps you to specify the font format of the label or field. on the toolbar. It Font Specifies the font face. Size Specifies the font size. Color Specifies the font color. To change the color, click the color indicator to select a color, or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB. Specifies whether to make the object bold. Specifies whether to make the object italic. Specifies whether to underline the object. Preview Shows the font effect. OK Applies the font format you specified and closes this dialog. Cancel Cancels to change the font format and closes the dialog. Help Displays this help document. Format Category(X) Axis dialog This dialog appears when you right-click a chart and then select Format Axes > Format Category(X) Axis from the shortcut menu. It helps you to format the category(X) axis of the chart, and consists of the following tabs: q General tab Font tab q OK Applies the changes and closes the dialog. Cancel Does not retain any changes and closes the dialog. Help Displays this help document. General tab This tab shows some general information of the category(X) axis of the chart. Line Specifies the line style for the category(X) axis. q Color Specifies the color of the category(X) axis. Thickness Specifies the thickness for the line of the category(X) axis. Transparency Specifies the transparency for the color of the category(X) axis. q q Labels Specifies the properties for the labels on the category(X) axis. q Show Axis Label Tips Specifies whether to show the complete label text when the mouse pointer points at a label on the category (X) axis. Label Position Specifies whether to show the label text outside or inside the category(X) axis. Label Font Automatic Orientation Specifies to adjust the rotation angle of the label text on the category(X) axis automatically according to the length of the label text, in degrees. Angle Specifies to customize the rotation angle of the label text on the category(X) axis. Activated when Label Font Automatic Orientation is unchecked. You can input the angle in the text box directly. q q q Value Control Specifies the value control for the category(X) axis. q Min Value Specifies the minimal data value that will appear on the category(X) axis. Max Value Specifies the maximal data value that will appear on the category(X) axis. Use Start Value Specifies whether to set the start value of category(X) axis. This option applies to scatter and bubble charts, and only if the value on the category axis is not numeric. Increment Specifies the increased amount between two adjacent values on the category(X) axis. This option applies to scatter and bubble charts. q q q Font tab This tab shows the font-related information of the category(X) axis. Font Specifies the font face of the label text. Size Specifies the font size of the label text. Fill Type Specifies the fill type of the label text. Color Specifies the color of the label text. Transparency Specifies the transparency of the label text. Font Style Specifies the font style of the text. It can be one of the following: Plain, Bold, Italic and Bold Italic. Format Category(X) Gridline dialog This dialog appears when you right-click a chart and then select Format Gridlines > Category(X) Gridline from the shortcut menu. It helps you to format the category(X) gridline of the chart. Color Specifies the color schema for category(X) gridlines in the chart. Transparency Specifies the transparency of the color of category(X) gridlines in the chart. Line Style Specifies the line style for category(X) gridlines in the chart. Thickness Specifies the thickness for category(X) gridlines in the chart. OK Applies the changes and closes the dialog. Cancel Does not retain any changes and closes the dialog. Help Displays this help document. General tab This tab shows some general information of the floor. Color . Cancel Does not retain any changes and closes the dialog. Fill Type Specifies the fill type for the floor of the chart. It helps you to format the floor of the chart and contains the following tabs: q General tab Border tab q OK Applies the changes and closes the dialog.Format Floor dialog This dialog appears when you right-click a chart and then select Format Walls > Format Floor from the shortcut menu. Help Displays this help document. Border tab This tab shows information about borders of the floor. Color Specifies the color for border of the chart floor. Line Style Specifies the style for border of the chart floor. Thickness Specifies the thickness for border of the chart floor.Specifies the color schema for the floor of the chart. . Transparency Specifies the transparency of the color schema that is applied to the floor of the chart. Border Type Specifies the type for the border of the chart floor. Transparency Specifies the transparency for color of the border. . Cancel Cancels the settings and closes this dialog. General tab This tab shows some general information of the chart legend.Format Legend dialog This dialog appears when you right-click a chart and select Format Legend from the shortcut menu. Help Displays this help document. This dialog helps you to format the legend of the chart and contains the following tabs: q General tab Placement tab Border tab Font tab q q q OK Applies the settings and closes this dialog. Show Value Specifies whether to show the value of each legend. Fill Type Specifies the type for filling the chart legend. click the color indicator to select a color. If you want to make the background transparent.Name Specifies the display name of the chart legend. input Transparent in the text box. To change the color. which will be shown on the shortcut menu of the legend. Show Percent . Transparency Specifies the transparency of the legend background. Width Specifies the width of the chart legend. Height Specifies the height of the chart legend. or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB. Color Indicates the background color of the chart legend. Show Tips Specifies whether to show the corresponding data information when the mouse pointer points at a target in the chart legend.Specifies whether to show the percentage of each legend. Placement Specifies the position of the legend in the platform. Bottom Margin Specifies the distance between the legend labels and the bottom border of the legend. Top Margin Specifies the distance between the legend labels and the top border of the legend. Secondary Placement Specifies the position of the legend on the basis of the Placement property. Left Margin Specifies the distance between the legend labels and the left border of the legend. Placement tab This tab shows the position-related information of the chart legend. Right Margin . Border tab This tab shows information about borders of the chart legend. Line Style Specifies the line style of the legend borders. Reverse Labels Specifies whether or not to arrange the legend labels in a reverse order. Transparency . Color Specifies the color of the legend borders.Specifies the distance between the legend labels and the right border of the legend. Border Type Specifies the type of the legend borders. Label Vertical Spacing Specifies the vertical distance between two adjacent legend labels. Label Horizontal Spacing Specifies the horizontal distance between two adjacent legend labels. Fill Type Specifies the fill type for the legend labels. Size Specifies the font size for the legend labels. in percent. Font Style . Thickness Specifies the thickness of the legend borders.Specifies the transparency of the legend borders. Font tab This tab shows the font-related information of the chart legend. Transparency Specifies the transparency for the legend labels. Color Specifies the color for the legend labels. Font Specifies the font face for the legend labels. . Italic and Bold Italic. Bold. It can be one of the following: Plain.Specifies the font style of the text. in degrees. Word Wrap Specifies whether or not to enable word wrapping for the label text. Font Rotation Specifies the rotation angle of each legend label around its center. It helps you to format the paper of the chart and contains the following tabs: q General tab Border tab Coordinate tab Graph tab Threshold Line tab q q q q OK Applies the settings and closes this dialog.Format Paper dialog This dialog appears when you right-click a chart and select Format Paper from the shortcut menu. General tab This tab shows some general information of the chart paper. Help Displays this help document. Cancel Cancels the settings and closes this dialog. . or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB. If you want to make the background transparent. click the color indicator to select a color. which will be shown on the shortcut menu of the paper. Color Indicates the background color of the chart paper. input Transparent in the text box. Transparency Specifies the transparency of the chart paper background. Width Specifies the width of the chart paper. Height Specifies the height of the chart paper. Show Tip Specifies whether to show the corresponding data information when the mouse pointer points at a target in the .Name Specifies the display name of the chart paper. Fill Type Specifies the type for filling the chart paper. To change the color. Color Specifies the color of the chart paper borders. Transparency Specifies the transparency of the chart paper borders.chart paper. Show Category and Series Specifies whether to show data of the category and value axes when the mouse pointer points at a target in the chart paper. Border tab This tab shows information about borders of the chart paper. It takes effect only when the option Show Tips is checked. Border Type Specifies the type of the chart paper borders. Thickness . Line Style Specifies the line style of the chart paper borders. Interactive Specifies whether the chart can be interactive or not. . Coordinate tab You can use this tab to view and configure properties of the coordinates. Angle Y Specifies the rotation angle around the Y axis. Input an integer to set the effect. Scale Y Specifies the scaling ratio for the Y axis.Specifies the thickness of the chart paper borders. Angle X Specifies the rotation angle around the X axis. Scale X Specifies the scaling ratio for the X axis. Perspective Specifies the perspective effect of the chart. This tab differs according to the following chart types: q Bar/Bench Line/Area Clustered Pie Donut Pie q q q Bar/Bench Specifies the properties on bars of the chart. q . q Normal Specifies to make the bars be quadrate.Graph tab You can use this tab to view and configure properties of the graphic object. Type Specifies the type of the bars. Cylinder Specifies to make the bars be columned. Direction Specifies the angle of the axis along the depth of the bars/benches. Inside Top If selected. r q Auto Fit If selected. . q q Static Data Label Specifies properties of the static data labels. Category Name . r r r r q Type Specifies in which way the value labels will be displayed around the chart section. r Value .Shows the percentage of the section to the total. Inside Bottom If selected. Outside Top If selected. Depth Specifies the depth of the bars/benches.Shows the value and the percentage for the chart section. Value Percent . the data labels will be displayed on the inside top of the nodes. the data labels will be displayed at the inside bottom of the nodes.Size Specifies the size of the bars in the chart. Applies to bar charts only. r r r Line/Area Specifies properties on lines/areas in the chart. Only applies to pie chart. Inside Center If selected. q Use Depth Specifies whether to make the chart visually three-dimensional. the data labels will be displayed on the outside top of the nodes. Available only when Show Static Data Label is set to true.Shows the category name for the chart section. Percent .Shows the value for the chart section. q Width Specifies the width of the bars. the data labels will be displayed automatically. Only applies to pie chart. q Show Static Data Label Specifies whether or not to show the static data labels. Depth Specifies the depth properties for bars of the chart. the data labels will be displayed in the inside center of the nodes. Position Specifies the position of the static data label. Size Specifies the size of the lines/areas in the chart. q . q Use Depth Specifies whether to make the chart visually three-dimensional. Position Specifies the position of the data labels on the areas. Available only when Show Static Data Label is set to true. q Show Static Data Label Specifies whether or not to show the static data labels. Depth Specifies the depth properties of the chart. q q Static Data Label Specifies properties of the static data labels. Applies to line charts only. q Line Thickness Specifies thickness of the lines. Direction Specifies the angle of the axis along the depth of the lines/areas. Depth Specifies the depth of the lines/areas. Bottom Center If selected. r r r r r r q Type Specifies in which way the value labels will be displayed around the chart section.Shows the percentage of the section to the total. . Value Percent . the data labels will be displayed in the top center of the nodes on the lines/areas. the data labels will be displayed on the top left of the nodes on the lines/areas. the data labels will be displayed on the top right of the nodes on the lines/areas. Percent . the data labels will be displayed in the bottom center of the nodes on the lines/areas. Top Center If selected. the data labels will be displayed on the bottom right of the nodes on the lines/areas. Only applies to pie chart. Top Right If selected. Bottom Right If selected.Shows the value and the percentage for the chart section.r Auto Fit If selected.Shows the value for the chart section.Shows the category name for the chart section. the data labels will be displayed automatically. r r r Clustered Pie Specifies properties on the clustered pies in the chart. Category Name . r Value . Bottom Left If selected. the data labels will be displayed on the bottom left of the nodes on the lines/areas. Top Left If selected. the data labels will be displayed next to the clustered pies.Pie q Show Pie Name Specifies whether or not to show the clustered pie name. the data labels will be displayed at the best fit position automatically. q Show Static Data Label Specifies whether or not to show the static data labels. Best Fit If selected. Sticker If selected. On Slices r r r r . the data labels will be displayed automatically. Position Specifies the position of the data labels on the clustered pies. r q Auto Fit If selected. Static Data Label Specifies properties of the static data labels. the data labels will be displayed beside the clustered pies and pointed by thin lines. Available only when Show Static Data Label is set to true. Slim Leg If selected. Shows the value and the percentage for the chart section. the data labels will be displayed on the slices of clustered pies. r Value .Shows the category name for the chart section. Donut Hole Specifies the percentage the hole’s thickness will take from the total radius of the donut pie circle. Only applies to pie chart. Category Name . q Show Static Data Label . Donut q Show donut Name Specifies whether or not to show the donut pie name. Value Percent .If selected. q Type Specifies in which way the value labels will be displayed around the chart section. Percent .Shows the value for the chart section. Static Data Label Specifies properties of the static data labels.Shows the percentage of the section to the total. r r r Donut Pie Specifies properties on the donut pies in the chart. the data labels will be displayed beside the donut pies and pointed by thin lines.Specifies whether or not to show the static data labels. the areas/bars/lines will be shown as sub tab in the Graph tab.Shows the value and the percentage for the chart section. There is no graph tab for bullet chart. Slim Leg If selected. Sticker If selected. r r r r q Type Specifies in which way the value labels will be displayed around the chart section.Shows the percentage of the section to the total. Best Fit If selected. q Threshold Line tab You can use this tab to view and configure properties of the threshold lines. r Value .Shows the category name for the chart section. the data labels will be displayed at the best fit position automatically. the data labels will be displayed automatically. r Auto Fit If selected. r r r Notes: q If the chart is a combo chart composed by areas/ bars/lines. q Position Specifies the position of the data labels on the donut pies. . Value Percent . Only applies to pie chart. Category Name . On Slices If selected. Percent . the data labels will be displayed next to the donut pies.Shows the value for the chart section. the data labels will be displayed on the slices of the donut pies. Available only when Show Static Data Label is set to true. Threshold Line Color Specifies the color of the first threshold line. Threshold Line Color Specifies the color of the second threshold line. q q Threshold Line2 Specifies the properties of the second threshold line.Threshold Line1 Specifies the properties of the first threshold line. q q Transparency Specifies the transparency of the threshold lines. . Threshold Value Specifies the value of the first threshold line. Threshold Value Specifies the value of the second threshold line. q Show Threshold Line1 Specifies whether or not to show the first threshold line. q Show Threshold Line2 Specifies whether or not to show the second threshold line. Format Platform dialog This dialog appears when you right-click a chart and select Format Platform from the shortcut menu. It you to format the platform of the chart and contains the following tabs: q General tab Border tab q OK Applies the settings and closes this dialog. Cancel Cancels the settings and closes this dialog. Help Displays this help document. General tab Specifies the color schema to fill the platform. Color Specifies the color with which to fill the platform. To change the color, click the color indicator to select a color, or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB, or click More Fill Effects to specify a gradient or an image as the fill effect in the Fill Effects dialog. If you want to make the background transparent, input Transparent in the text box. Transparency Specifies the transparency of the color. Border tab Specifies the properties for borders of the chart platform. Border Type Specifies the type for border of the platform. q None The object has no visible border lines. Raised The object has 3D borders that appear as if they are raised off the page. Recess The object has 3D borders that appear as if they are pressed into the page. Shadow The object has two shadowed borders, beneath and to the right of the object. Solid The object has single-line borders (default value). q q q q Color Specifies the color for border of the platform. Transparency Specifies the transparency for color of the border. Line Style Specifies the line style to apply to the border of the platform. Thickness Specifies the thickness of the border. End Caps Specifies the ending style of the border line. q Butt Ends unclosed subpaths and dash segments with no added decoration. Round Ends unclosed subpaths and dash segments with a round decoration that has a radius equal to half of the width of the pen. Square Ends unclosed subpaths and dash segments with a square projection that extends beyond the end of the segment to a distance equal to half of the line width. q q Line Joint Specifies the line joint style for the border line. q Miter Joins path segments by extending their outside edges until they meet. Round Joins path segments by rounding off the corner at a radius of half the line width. Bevel Joins path segments by connecting the outer corners of their wide outlines with a straight segment. Joint Round Joins path segments by rounding off the corner at a specified radius. q q q Radius Specifies the radius for the border joint of the platform border line. Available only when Line Joint is set to Joint Round. Dash Specifies the dash size of border line. q Auto Adjusted Dash If selected, the dash size will be adjusted automatically. Fixed Dash Size If selected, the dash size will be fixed size. q Format Value(Y) Axis dialog This dialog appears when you right-click a chart and select Format Axes > Format Value (Y) Axis from the shortcut menu. It helps you to format the value(Y) axis of the chart and contains the following tabs: q General tab Font tab q OK Applies the changes and closes the dialog. Cancel Does not retain any changes and closes the dialog. Help Displays this help document. General tab Specifies the general properties for the value(Y) axis of the chart. Line Specifies the line style for the value(Y) axis. q Color Specifies the color of the line. Thickness Specifies the thickness for the line. Transparency Specifies the transparency for the color of the line. q q Labels Specifies the properties for the labels on the value(Y) axis. q Show Axis Label Tips Specifies whether to display the complete label text when the mouser pointer points at a label on the value (Y) axis. Label Position Specifies whether to show the label text outside or inside the value(Y) axis. Label Font Automatic Orientation Specifies to adjust the rotation angle of the label text on the value(Y) axis automatically according to the length of the label text, in degrees. Angle Specifies to customize the rotation angle of the label text on the value(Y) axis. Activated when Label Font Automatic Orientation is unchecked. You can input the angle in the text box directly. q q q Value Control Specifies the value control for the value(Y) axis. q Min Value Specifies the minimum value that is to be displayed on the value(Y) axis. Max Value Specifies the maximum value that is to be displayed on the value(Y) axis. Use Start Value Specifies whether to set the start value of the value(Y) axis. This option applies to 2-D charts that have a wall. Increment Specifies the increased amount between two adjacent values on the value(Y) axis. This option applies to scatter and bubble charts. q q q Font tab Specifies the font format for text on the value(Y) axis. Font Specifies the font face of the label text. Size Specifies the font size of the label text. Fill Type Specifies the fill type of the label text. Color Specifies the color of the label text. Transparency Specifies the transparency of the label text. Font Style Specifies the font style of the text. It can be one of the following: Plain, Bold, Italic and Bold Italic. Format Value(Y) Gridline dialog This dialog appears when you right-click a chart and select Format Gridlines > Value(Y) Gridline from the shortcut menu. It helps you to format the value(Y) gridline of the chart. Color Specifies the color schema for value(Y) gridlines in the chart. Line Style Specifies the style for value(Y) gridlines in the chart. Transparency Specifies the transparency of the color of value(Y) gridlines in the chart. Thickness Specifies the thickness for value(Y) gridlines in the chart. OK Applies the changes and closes the dialog. Cancel Does not retain any changes and closes the dialog. Help Displays this help document. Format Wall dialog This dialog appears when you right-click a chart and select Format Walls > Format Wall from the shortcut menu. It helps you to format the wall of the chart and contains the following tabs: q General tab Border tab q OK Applies the changes and closes the dialog. Cancel Does not retain any changes and closes the dialog. Help Displays this help document. General tab This tab shows some general information of the wall. Wall Specifies the color or the fill effect of the wall of the chart. q Fill Type Specifies the fill type of the wall. Color Specifies the color of the wall. Transparency Specifies the transparency of the color schema that is applied to the wall of the chart. q q Bound Specifies the fill color or effect to compound with the basic fill which is set in the Wall area. q Fill Type Specifies the fill type of the wall. Color Specifies the fill color schema or effect to compound with the basic fill which is set for the walls of a chart in the Wall area. Transparency Specifies the transparency of the color schema that is applied here. q q Border tab This tab shows information about borders of the wall. Color Specifies the color schema for the border of the wall. Transparency Specifies the transparency of the color schema that is applied to the border of the wall. Thickness Specifies the thickness for the border of the wall. Line Style Specifies the line style for the border of the wall. Formula Editor dialog This dialog appears when you expand the Dynamic Resource > Formulas node in the Resources panel, then click <Add Formula…> or right-click a dynamic formula and then select Edit from the shortcut menu. It helps you to create or edit a dynamic formula in a report. Formula Name Specifies the name of the formula. Fields box Displays a list of those fields that are available to formulas. The fields include the group and detail objects in the current business view, and the dynamic formulas that have been created in the report. You can select one field and double-click it to insert the field into the editing box at the insertion point. Functions box Displays a list of JReport functions that are available to formulas. When you select one function and double-click it, JReport will insert the selected function into the editing box at the insertion point completely with its required syntax items (parentheses, commas, etc). For details about usage of the functions, refer to Built-in functions in the JReport Designer User's Guide. Operators box Displays a list of operators that are available to formulas. Select one operator and double-click it to insert the selected operator into the editing box at the insertion point. For details about usage of the operators, refer to Operators in the JReport Designer User's Guide. Editing box In this box, you can build and edit your formula. There are several ways to work with formulas: q Select formula components from the Fields, Functions and Operators boxes in the Formula Editor, and then double-click the components, JReport will then insert them in the formula; Type your formula in the editing box directly; Use the above two methods together; Paste formula text from the text document of other programs. q q q Note: If you refer to any field in the formula, the reference name for that field will be prefixed with an @ sign. If the field name contains spaces, the reference name in formula will be quoted with double-quotation marks (""). For example, if the field name is Customer Name, then the reference name will be @"Customer Name". Tests the syntax of your formula. If the syntax is incorrect, JReport provides an opportunity to correct the errors. Selects a general operator to be used in the editing box. A color palette is provided for you to insert the HEX code of a color simply by clicking the corresponding color in the color palette instead of inputting the HEX code manually. OK Creates or edits the formula and closes the dialog. Cancel Cancels the creation or edition of the formula and closes the dialog. Help Displays this help document. Group Footer Properties dialog The dialog appears when you right-click a table group footer and select Properties from the shortcut menu. It helps you to specify the properties of the group footer and contains the following tabs: q General tab Border tab q OK Applies the settings for the group footer properties and closes this dialog. Cancel Cancels the settings and closes this dialog. Help Displays this help document. General tab This tab shows some general information of the group footer. Name Specifies the display name of the group footer. Height Specifies the height of the group footer. Background Specifies the background color of the group footer. To change the color, click the color indicator to select a color, or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB, or click More Fill Effects to specify a gradient or an image as the fill effect in the Fill Effects dialog. If you want to make the background transparent, input Transparent in the text box. Border tab This tab shows information about borders of the group footer. Color Specifies the border color. Width Specifies the border width. Top Line Specifies the style of the top border line. Bottom Line Specifies the style of the bottom border line. Left Line Specifies the style of the left border line. Right Line Specifies the style of the right border line. Group Header Properties dialog The dialog appears when you right-click a table group header and select Properties from the shortcut menu. It helps you to specify the properties of the group header and contains the following tabs: q General tab Border tab q OK Applies the settings for the group header properties and closes this dialog. Cancel Cancels the settings and closes this dialog. Help Displays this help document. General tab This tab shows some general information of the group header. Name Specifies the display name of the group header. Height Specifies the height of the group header. Background Specifies the background color of the group header. To change the color, click the color indicator to select a color, or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB, or click More Fill Effects to specify a gradient or an image as the fill effect in the Fill Effects dialog. If you want to make the background transparent, input Transparent in the text box. Border tab This tab shows information about borders of the group header. Color Specifies the border color. Width Specifies the border width. Top Line Specifies the style of the top border line. Bottom Line Specifies the style of the bottom border line. Left Line Specifies the style of the left border line. Right Line Specifies the style of the right border line. Image Properties dialog The dialog appears when you right-click an image and select Properties from the shortcut menu. It helps you to edit the properties of the image. Name Specifies the display name of the image, which will be shown on the shortcut menu of the image. Picture Name Displays the image file name. Scaling Mode Specifies the scaling mode for the image. The mode can be: q actual size: The image will be shown in its actual size. customize: The image size will be equal to the image field size. fit image: The image will be scaled largest to wholly show in the image field. fit width: The image will be scaled largest to fit the width of the image field. fit height: The image will be scaled largest to fit the height of the image field. q q q q Horizontal Alignment Specifies the horizontal alignment of the image in its container. Vertical Alignment Specifies the vertical alignment of the image in its container. Rotation Rotates the image at a specified angle in degrees. The following is the meaning of different values: q 0 - No rotation. Positive value - Rotate the image clockwise. Negative value - Rotate the image anticlockwise. q q Note: When you rotate an image, the rectangle that holds the image maintains its original size, which may result in that the image exceeds the field border and therefore the parts that extend outside of the border will be cut off. Width Specifies the width of the image. Height Specifies the height of the image. Alt Specifies the alternate text which will be shown if the image cannot be displayed. Title Specifies tip information about the image, which will be displayed when the mouse cursor hovers on the image. OK Applies the settings and closes this dialog. Cancel Cancels the settings and closes this dialog. Help Displays this help document. Insert Chart dialog This dialog appears when you click Menu > Insert > Chart, or drag Chart from the Components panel to the destination. It helps you to insert a chart to a report. Chart Title Specifies a title for the chart. Sets the font, font style, size, alignment, font color and background color properties for the chart title. Data Source Specifies the data source on which the chart will be built. Filter Opens the Query Filter dialog to specify the filter which you want to apply to the selected business view. Resources Displays the view elements in the selected business view. Edits the selected dynamic resource. Adds the selected resource to be displayed in the chart. Show Values Lists the values you want to show in the chart. q Primary Axis Adds a chart type to the primary axis. Secondary Axis Adds a chart type to the secondary axis. Active only when the option Secondary Axis is checked. q Adds a combo chart to the Primary Axis or Secondary Axis. Opens the Edit Additional Value dialog to edit the selected additional value. Moves the selected view element one level up. Moves the selected view element one level down. Secondary Axis Specifies whether to show the secondary axis in the chart. Category Lists the group object Series Lists the group object that will be displayed on the series axis of the chart. that will be displayed on the category axis of the chart. Opens the Category Options dialog or Series Options dialog to define the sort order of the category or series values and specify the number of the category or series values that will be displayed in the chart. Removes the selected resource. OK Inserts a chart in the report and closes the dialog. Cancel Cancels the insertion and closes the dialog. Help Displays this help document. Insert Crosstab dialog This dialog appears when you click Menu > Insert > Crosstab, or drag Crosstab from the Components panel to the destination. It helps you to insert a crosstab to a report. Crosstab Title Specifies a title for the crosstab. Sets the font, font style, size, alignment, font color and background color properties for the crosstab title. Data Source Specifies a data source on which the crosstab will be built from the data source drop-down list. Filter Opens the Query Filter dialog to specify the filter which you want to apply to the selected business view. Resources Displays the elements in the selected business view. Edits the selected dynamic resource. Adds the selected group object to be displayed in the columns of the crosstab. Adds the selected group object to be displayed in the rows of the crosstab. Adds the selected aggregation object Columns/Rows q or detail object to be the summary field of the crosstab. Field Lists the group objects that will be displayed in the columns/rows of the crosstab. Label Specifies the display names for the selected group objects. Sort Specifies the sort order of the group objects. q q Summaries q Field Lists the fields that you select to create summaries. Label Specifies the display names for the selected fields. Aggregation Specifies the functions used to summarize data of the selected detail objects. q q Moves the selected view element one level up. Moves the selected view element one level down. Removes the selected resource. OK Inserts a crosstab and closes the dialog. Cancel Cancels the insertion and closes the dialog. Help Displays this help document. Insert Filter Control dialog The dialog is displayed when you drag Filter Control from the Components panel to a report, or click Menu > Insert > Filter Control. It helps you to insert a filter control into a report for filtering all data components in the report (excluding its subreport) using the same data source. Select Fields Specifies the fields of the same type on which the filter control is based. Apply To Specifies the components to which the filter created with the filter control will be applied. OK Inserts a filter control into the report and closes the dialog. Cancel Cancels the insertion and closes the dialog. Help Displays this help document. Insert Image dialog This dialog appears when you click Menu > Insert > Image, drag Image from the Components panel to a report, or click image into a report. on the Page screen of the JReport Studio Wizard. It helps you to insert an Image From Specifies the source of the image file. q Local File Specifies to use an image from the local file system. r File Name Specifies the path and name of the image file. You can click the Browse button to locate the image file. q Web URL Specifies to use an image via URL. r Image URL Specifies the URL of the image file. Note: If your JReport Server is in an intranet which requires a proxy, to successfully access the image via URL, you need to add the parameters -Dhttp.proxyHost=XXX -Dhttp.proxyPort=XX to the server's startup file JRServer.bat, which is located in <install_root>\bin. q Library Specifies to use an existing image. r My Images The My Images folder is a virtual location where JReport Server stores the images that have once been inserted into reports. Select the one you want to use. Preview Displays a preview of the selected image. OK Inserts the image into the report and closes the dialog. Cancel Cancels the insertion and closes the dialog. Help Displays this help document. Properties Specifies the properties of the multimedia object. Flash Specifies to insert a flash file to the current report. if the player isn't already installed on your local disk. Type in the name or URL in the text box or click Browse to find the file. File Name/URL Specifies the name or URL of the multimedia object that is to be inserted into the report. It helps you to insert a multimedia object to a report. Real Media File Specifies to insert a real media file to the current report. Windows Media File Specifies to insert a Windows Media file to the current report. q For Flash .Insert Multimedia dialog This dialog appears when you click Menu > Insert > Multimedia Object or drag Multimedia Object from the Components panel to the report. Plug-in Page Specifies the URL of the plug-in page from which to download the player with which to play the inserted multimedia object on a webpage. Movie Quality Specifies the quality of the flash. Center Specifies whether to place the realmedia file in the center of the report. r r OK Inserts the multimedia object to the report and closes the dialog. Loop Number Specifies how many times you want to play the realmedia file. Loop Specifies whether to play the flash file repeatedly. Auto Rewind Specifies whether or not to rewind the Windows Media file automatically. Cancel Cancels the insertion and closes the dialog.r Play Specifies whether to start the flash file automatically when the report is opened. For Windows Media File r r r q r Auto Start Specifies whether or not to start the Windows Media automatically when the report is opened. . For Real Media File r r q r Auto Start Specifies whether to start the realmedia file automatically when the report is opened. Help Displays this help document. Loop Specifies whether to play the realmedia file repeatedly. Play Count Specifies the number of times you want to play this media file. . Select a Parameter Specifies a parameter from the list where all the parameters except cascading parameters used by the current report are displayed. or click Menu > Insert > Parameter Control.Insert Parameter Control dialog The dialog is displayed when you drag Parameter Control from the Components panel to a report. It helps you to insert a parameter control into a report for delivering parameter values to the report. OK Inserts a parameter control into the report and closes the dialog. Help Displays this help document. .Cancel Cancels the operation and closes the dialog. q Current Report Specifies to run the current report with the specified parameters. q Others Specifies to run other reports. r Select Parameters Specifies the parameters that are used to run the current report. .Insert Parameter Form Control dialog The dialog is displayed when you drag Parameter Form Control from the Components panel to a report. all the other parameters in the cascading group will be selected automatically. Once you select one of a group of cascading parameters. Please Select Target Reports Specifies the reports to run. and vice versa. It helps you to insert a parameter form control into a report for running reports from the current report. or click Menu > Insert > Parameter Form Control. r Reports Specifies the target reports to run. If all the selected reports contain no parameters. Cancel Cancels the operation and closes the dialog. OK Inserts a parameter form control into the report and closes the dialog. the new values will be applied automatically. it is used to submit the parameter values you specified in the parameter form control. Help Displays this help document. once you change the values of a parameter in the parameter form control. If Submit is not included. Parameter Information Lists the parameters used by the selected reports. If Submit is included. you cannot finish the dialog. r Include "Submit" Button Specifies whether the inserted parameter form control contains the Submit button. . q q q Display tab Specifies the fields that you want to display in the table. Data Source Specifies a data source on which the table will be built from the data source drop-down list. . or drag Table from the Components panel to the destination. Filter Opens the Query Filter dialog to specify the filter which you want to apply to the selected business view. By default. Summary Table Creates a table with only group and summary information. Group Left Creates a table with group information left to the detail panel.Insert Table dialog This dialog appears when you click Menu > Insert > Table. and consists of the following tabs: q Display tab Group tab Summary tab q q Table Title Specifies a title for the table. Sets the font. font style. It helps you to insert a table into a report. alignment. size. Group Left Above Creates a table with group information left above the detail panel. the Group Left Above is selected. font color and background color properties for the table title. q Group Above Creates a table with group information above the detail panel. Table Type Selects a type for the table you want from the Table Type drop-down list. Adds the selected view element to be displayed in the table. Removes the selected view element. Removes the selected dynamic resource. Edits the selected dynamic resource.Resources Displays all the view elements in the selected business view. Field . Moves the selected view element one step down.Lists the view elements that have been added to the table. Moves the selected view element one step up. Group tab Specifies the fields to group the data. Resources . Label Specifies the display names for the added view elements. Summary tab Specifies the fields on which to create summaries. Field Lists all the group objects that have been added as the group fields. Sort Specifies the sort order for each group: Ascend. Removes the selected group object.Displays all the available group objects you can use to group the data in the table. or No Sort. Moves the selected group one step up. Descend. Adds the selected group object as a group field. . Moves the selected group one step down. . Edits the selected dynamic resource. Adds the selected aggregation object as the summary field. Removes the selected dynamic resource. Removes the selected aggregation object.Resources Displays all the available aggregation objects you can use to create summaries in the table. OK Inserts a table and closes the dialog. Help Displays this help document.Field Lists the groups that have been added in the table and the aggregation objects added to summarize data in each group. Moves the selected aggregation object one step up. . Moves the selected aggregation object one step down. Cancel Cancels the insertion and closes the dialog. Run Opens the report in JReport Studio. Page screen Specifies the page settings of the report. . Next Goes to the next screen. It guides you through the process of creating a web report. Save Saves the report to the server resource tree. and contains the following screens: q Page screen Layout screen Bind Data screen Style screen q q q Displays this help document.JReport Studio Wizard This wizard appears after you click Menu > File > New Report (or the New Report button on the Standard toolbar). Back Goes back to the previous screen. Templates Specifies the template to be applied to the report. q Blank Specifies to use the blank template. Template1 Specifies to use Template1, in which you can specify the report title and company logo. Template2 Specifies to use Template2, in which you can specify the company logo, company title, report title and sub title. q q Page Setup Opens the Page Setup dialog to specify the page properties. Report Title Specifies the display name of the report title. Company Logo Specifies the company logo image file. Company Title 1 Specifies the display name of the company title 1. Company Title 2 Specifies the display name of the company title 2. Sub Title Specifies the display name of the sub title. Specifies the font properties for report title, sub title or company title. q Font Lists all the available font faces that can be selected to apply to the title. Font Style Specifies the font style of the title. It can be one of the following: plain, bold, italic, and bold italic. Size Specifies the font size of the title. Align Specifies the position of the title to be left, right, center or justify. Font Color Specifies the font color of the title. Background Color Specifies the background color of the title. q q q q q Opens the Insert Image dialog to customize the image for company logo. Layout screen Specifies the layout of the report. Built-in layouts Lists the built-in layouts. q Default There is only a cell in the tabular. Top and Bottom There are two cells in the tabular. One is at the top, and the other is at the bottom. Each cell uses half the height of the tabular. T-Style There are two rows in the tabular. Each row uses half the height of the tabular. The top row has two cells with each using half the width of the row, and the bottom row has only a cell. q q q 2×3 There are six cells in the tabular. Each cell uses one third the height and one third the width of the tabular. T-Style 2 There are two rows in the tabular. Each row uses half the height of the tabular. The top row has only a cell, and the bottom row has two cells with each using half the width of the row. q Toolbar The toolbar is enabled when a tabular cell in the below edit layout box is selected. q Horizontal Split Splits the selected tabular cell into two cells horizontally. Vertical Split Splits the selected tabular cell into two cells vertically. Merge Merges the selected adjacent tabular cells that form a rectangular into one cell. Align Specifies how the component aligns in the tabular cell. r q q q Left Aligns the component to the left of the tabular cell. Center Aligns the component to the center of the tabular cell. Right Aligns the component to the right of the tabular cell. r r Edit layout box Specifies the component to be inserted into the selected tabular cell. q Existing Components Specifies a component from the ones existing in the open report to create the report. New Components Specifies the component you want to place in the tabular cell. r q Table Creates a table in the tabular cell. Crosstab Creates a crosstab in the tabular cell. Chart Creates a chart in the tabular cell. Blank Creates nothing in the tabular cell. r r r Tabular Cell Size Displays the size of the selected tabular cell, in percent. q Width Shows the width of the tabular cell. Height Shows the height of the tabular cell. q Bind Data screen Specifies the data source and the fields to be displayed in each component selected in the Layout screen. This screen differs according to the following component types: Table, Crosstab, Chart and Blank. For Table component Specifies the data displayed in the table. Table Title Specifies the title of the table. The title is a special label bound with the table. Though it can be positioned freely in a report, once you remove the table from the report, the title will be removed too. Specifies the font properties of the table title. Data Source Specifies the business view in the current catalog on which the table will be built. Filter Opens the Query Filter dialog to specify the filter you want to apply to the selected business view. Table Type Specifies the table type. q Group Above Creates a table with group information above the detail panel. Group Left Creates a table with group information left to the detail panel. Group Left Above Creates a table with group information left above the detail panel. Summary Table Creates a table with only group and summary information. q q q Display tab Specifies the fields to be displayed in the table. q Resources Displays all the view elements in the selected business view. Edits the selected dynamic resource. Removes the selected dynamic resource. q q q Adds the selected view element to be displayed in the table. q Removes the selected view element. Field Lists the view elements that have been added to the table. Label Specifies the display names of the added view elements. Moves the selected view element one step up. Moves the selected view element one step down. q q q q Group tab Specifies the fields to group the data. q Resources Displays all the available group objects you can use to group data in the table. q Adds the selected group object as a group by field. q Removes the selected group object. Field Lists all the group objects that have been added as the group by fields. Sort Specifies the sort order for each group: Ascending, Descending, or No Sort. Moves the selected group object one step up. Moves the selected group object one step down. q q q q Summary tab Specifies the fields on which to create summaries. q Resources Displays all the available aggregation objects you can use to create summaries in the table. q Edits the selected dynamic resource. Removes the selected dynamic resource. q q Adds the selected aggregation object as the summary field. q Removes the selected aggregation object. Field Lists the groups that have been added in the table and the aggregation objects added to summarize data in each group. Moves the selected aggregation object one step up. Moves the selected aggregation object one step down. q q q For Crosstab component Specifies the data displayed in the crosstab. Crosstab Title Specifies the title of the crosstab. The title is a special label bound with the crosstab. Though it can be positioned freely in a report, once you remove the crosstab from the report, the title will be removed too. Specifies the font properties of the crosstab title. Data Source Specifies the business view in the current catalog on which the crosstab will be built. Filter Opens the Query Filter dialog to specify the filter you want to apply to the selected business view. Resources Displays the elements in the selected business view. Edits the selected dynamic resource. Adds the selected group object to be displayed on the columns of the crosstab. Adds the selected group object to be displayed on the rows of the crosstab. Adds the selected aggregation object Columns/Rows q or detail object to be the summary field of the crosstab. Field Lists the group objects that will be displayed on the columns/rows of the crosstab. Label Specifies the display names of the group objects. By default these are blank and no names will be created for the group objects to label the columns/rows. You can double-click the cells to edit them if required. Sort Specifies the sort order of the group objects. q q Summaries q Field Lists the aggregate/detail objects that you select to create summaries. Label Specifies the display names of the aggregate/detail objects. By default these are blank and no names will be created for the objects to label the summaries. You can double-click the cells to edit them if required. Aggregation Specifies the functions used to summarize data of the detail objects. q q Moves the selected view element one level up. Moves the selected view element one level down. Removes the selected view element. For Chart component Specifies the data displayed in the chart. Chart Title Specifies the title of the chart. The title is a special label bound with the chart. Though it can be positioned freely in a report, once you remove the chart from the report, the title will be removed too. Specifies the font properties of the chart title. Data Source Specifies the business view in the current catalog on which the chart will be built. Filter Opens the Query Filter dialog to specify the filter you want to apply to the selected business view. Resources Displays the view elements in the selected business view. Edits the selected dynamic resource. Adds the selected resource to be displayed in the chart. Show Values Lists the values you want to show in the chart. q Primary Axis Adds a chart type to the primary axis. Secondary Axis Adds a chart type to the secondary axis. Active only when the option Secondary Axis is checked. q Adds a combo chart to the Primary Axis or Secondary Axis. Opens the Edit Additional Value dialog to edit the selected additional value. Moves the selected view element one level up. Moves the selected view element one level down. Secondary Axis Specifies whether to show the secondary axis in the chart. Category Lists the group object Series Lists the group object that will be displayed on the series axis of the chart. that will be displayed on the category axis of the chart. Opens the Category Options dialog or Series Options dialog to define the sort order of the category or series values and specify the number of the category or series values that will be displayed in the chart. Removes the selected resource. For Blank The Bind Data screen is disabled for Blank. Style screen Specifies the style of the report. Styles Lists all the available styles for you to select from. No style will be applied when you select None. Label Properties dialog The dialog appears when you right-click a label and select Properties from the shortcut menu. It helps you to specify the properties of the label and contains the following tabs: q General tab Font tab Border tab q q OK Applies the settings and closes this dialog. Cancel Cancels the settings and closes this dialog. Help Displays this help document. General tab This tab shows some general information of the label. Name Specifies the display name of the label, which will be shown on the shortcut menu of the label. Width Specifies the width of the label. Text Specifies the text of the label. Height Specifies the height of the label. Top Padding Specifies the space between the text of the label and its top border. Bottom Padding Specifies the space between the text of the label and its bottom border. Left Padding Specifies the space between the text of the label and its left border. Right Padding Specifies the space between the text of the label and its right border. Background Specifies the background color of the label. To change the color, click the color indicator to select a color, or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB. If you want to make the background transparent, input Transparent in the text box. Foreground Specifies the foreground color of the label. To change the color, click the color indicator to select a color, or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB. Font tab This tab shows the font-related information of the label. Font Specifies the font face of the label text. Size Specifies the font size of the label text. Horizontal Alignment Specifies the horizontal alignment mode of the text in the label. Vertical Alignment Specifies the vertical alignment mode of the text in the label. Bold Specifies whether to make the label text bold or not. Underline Specifies whether the label text will be underlined or not. Strikethrough Specifies whether or not to attach a strikeout line to the label text. Italic Specifies whether to make the label text italic or not. Autofit Specifies whether or not to automatically adjust the width of the label. Word Wrap Specifies whether or not to wrap the text to the label width. Ignore HTML Tag If this option is unchecked, JReport will parse HTML tag elements in the field value while the report is to be saved as an HTML file; or the field value will appear in the HTML file the same as that in JReport Studio (HTML tag elements in the field value, if any, will not be parsed). Border tab This tab shows information about borders of the label. You can modify all the border settings in this tab. Color Specifies the border color. Width Specifies the border width. Top Line Specifies the style of the top border line. Bottom Line Specifies the style of the bottom border line. Left Line Specifies the style of the left border line. Right Line Specifies the style of the right border line. Shadow Specifies whether the borders will have a shadow effect or not. Shadow Color Specifies the color of the border shadow. Navigation Control Properties dialog This dialog appears when you right-click a navigation control and select Properties from the shortcut menu. It helps you to edit the properties of the navigation control and contains the following tabs: q General tab Border tab q OK Applies the settings and closes this dialog. Cancel Cancels the settings and closes this dialog. Help Displays this help document. General tab This tab shows some general information of the navigation control. Name Specifies the name of the navigation control. Width Specifies the width of the navigation control. Height Specifies the height of the navigation control. Background Specifies the background color of the navigation control. To change the color, click the color indicator to select a color, or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB. If you want to make the background transparent, input Transparent in the text box. Border tab This tab shows information about borders of the navigation control. Color Specifies the border color. Width Specifies the border width. Top Line Specifies the style of the top border line. Bottom Line Specifies the style of the bottom border line. Left Line Specifies the style of the left border line. Right Line Specifies the style of the right border line. Page Setup dialog This dialog appears when you click the Page Setup link in the JReport Studio Wizard or click Menu > File > Page Setup in JReport Studio. It helps you to specify the page properties and consists of the following two options: q Web Report Print Report q OK Applies all changes and closes the dialog. Cancel Does not retain any changes and closes the dialog. Help Displays this help document. Web Report If selected, the unit of page size is pixel, and the dialog appears Resolution Specifies the paper resolution. If you select Custom Size, you can then input the paper's Width and Height. q Type Specifies the paper type. Width Specifies the paper width. Height Specifies the paper height. q q Margin Specifies the distance of the report data to the top, bottom, left, or right edge of the page. q Top Specifies the top margin of the page. Bottom Specifies the bottom margin of the page. Left Specifies the left margin of the page. Right Specifies the right margin of the page. q q q Print Report If selected, the unit of the page size is inch, and the dialog appears Page Specifies the paper size. If you select Custom Size, you can then input the paper's Width and Height. q Type Specifies the paper type. Width Specifies the width of the paper. Height Specifies the height of the paper. q q Orientation Specifies the paper orientation. q Portrait Displays the report data in a portrait orientation (vertically). Landscape Displays the report data in a landscape orientation (horizontally). q Margin Specifies the margin properties. q Top Specifies the distance of report data to the top edge of the page. Left Specifies the distance of report data to the left edge of the page. Bottom Specifies the distance of report data to the bottom edge of the page. Right Specifies the distance of report data to the right edge of the page. q q q Parameter Control Properties dialog This dialog appears when you right-click a parameter control and select Properties from the shortcut menu. It helps you to edit the properties of the parameter control and contains the following tabs: q General tab Font tab Border tab q q OK Applies the settings and closes this dialog. Cancel Cancels the settings and closes this dialog. Help Displays this help document. General tab This tab shows some general information of the parameter control. Name Specifies the name of the parameter control. Parameter Displays the name of the parameter. Width Specifies the width of the parameter control. Height Specifies the height of the parameter control. Top Padding Specifies the space between the text of the parameter control and its top border. Bottom Padding Specifies the space between the text of the parameter control and its bottom border. Left Padding Specifies the space between the text of the parameter control and its left border. Right Padding Specifies the space between the text of the parameter control and its right border. Background Specifies the background color of the parameter control. To change the color, click the color indicator to select a color, or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB. If you want to make the background transparent, input Transparent in the text box. Foreground Specifies the foreground color of the parameter control. To change the color, click the color indicator to select a color, or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB. Font tab This tab shows the font-related information of the text in the parameter control. Font Specifies the font face of the text. Size Specifies the font size of the text. Horizontal Alignment Specifies the horizontal alignment mode of the text. Vertical Alignment Specifies the vertical alignment mode of the text. Bold Specifies whether to make the text bold or not. Underline Specifies whether the text will be underlined or not. Italic Specifies whether to make the text italic or not. Border tab This tab shows information about borders of the parameter control. Color Specifies the border color. Width Specifies the border width. Top Line Specifies the style of the top border line. Bottom Line Specifies the style of the bottom border line. Left Line Specifies the style of the left border line. Right Line Specifies the style of the right border line. Parameter Field Properties dialog The dialog appears when you right-click a parameter field and select Properties from the shortcut menu. It helps you to modify the properties of the parameter field and contains the following tabs: q General tab Font tab Border tab q q OK Applies the settings and closes this dialog. Cancel Cancels the settings and closes this dialog. Help Displays this help document. General tab This tab shows some general information of the parameter field. Name Specifies the display name of the parameter field, which will be shown on the shortcut menu of the parameter field. Width Specifies the width of the parameter field. Format Specifies the data format of the parameter field. Height Specifies the height of the parameter field. Top Padding Specifies the space between the text of the parameter field and its top border. Bottom Padding Specifies the space between the text of the parameter field and its bottom border. Left Padding Specifies the space between the text of the parameter field and its left border. Right Padding Specifies the space between the text of the parameter field and its right border. Background Specifies the background color of the parameter field. To change the color, click the color indicator to select a color, or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB. If you want to make the background transparent, input Transparent in the text box. Foreground Specifies the foreground color of the parameter field. To change the color, click the color indicator to select a color, or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB. Font tab This tab shows the font-related information of the parameter field. You can modify all the font settings in this tab. Size Specifies the font size of the parameter field text. Horizontal Alignment Specifies the horizontal alignment mode of the text in the parameter field. Autofit Specifies whether or not to automatically adjust the width of the parameter field. Underline Specifies whether the field text will be underlined or not. Word Wrap . Italic Specifies whether to make the field text italic or not. Bold Specifies whether to make the object text bold or not. Vertical Alignment Specifies the vertical alignment mode of the text in the parameter field.Font Specifies the font face of the parameter field text. Strikethrough Specifies whether or not to attach a strikeout line to the parameter field text. or the field value will appear in the HTML file the same as that in JReport Studio (HTML tag elements in the field value. JReport will parse HTML tag elements in the field value while the report is to be saved as an HTML file. Width Specifies the border width. will not be parsed). if any. Ignore HTML Tag If this option is unchecked. You can modify all the border settings in this tab. Left Line Specifies the style of the left border line. Top Line Specifies the style of the top border line. Border tab This tab shows information about borders of the parameter field. Bottom Line Specifies the style of the bottom border line.Specifies whether or not to wrap the text to the parameter field width. Right Line . Color Specifies the border color. .Specifies the style of the right border line. Shadow Color Specifies the color of the border shadow. Shadow Specifies whether the borders will have a shadow effect or not. .Parameter Form Control Properties dialog This dialog appears when you right-click a parameter form control and select Properties from the shortcut menu. It helps you to edit the properties of the parameter form control and contains the following tabs: q General tab Border tab Title tab q q OK Applies the settings and closes this dialog. Name Specifies the name of the parameter form control. General tab This tab shows some general information of the parameter form control. Cancel Cancels the settings and closes this dialog. Help Displays this help document. Background Specifies the background color of the parameter form control. Border tab This tab shows information about borders of the parameter form control. Top Line Specifies the style of the top border line. If you want to make the background transparent. Show Title Specifies whether to show the title of the parameter form control. To change the color. Color Specifies the border color. Width Specifies the border width. or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB. input Transparent in the text box. . Height Specifies the height of the parameter form control.Width Specifies the width of the parameter form control. click the color indicator to select a color. . To change the color. Background Specifies the background color of the title. Foreground Specifies the foreground color of the title. If you want to make the background transparent. click the color indicator to select a color. click the color indicator to select a color.Bottom Line Specifies the style of the bottom border line. Text Specifies the text of the title. Left Line Specifies the style of the left border line. To change the color. It is available when the Show Title option is selected in the General tab of the same dialog. input Transparent in the text box. Title tab This tab shows information about the title of the parameter form control. or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB. or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB. Right Line Specifies the style of the right border line. Font Specifies the font face of the text. . Size Specifies the font size of the text. Underline Specifies whether the text will be underlined or not. Horizontal Alignment Specifies the horizontal alignment mode of the text. Bold Specifies whether to make the text bold or not. Italic Specifies whether to make the text italic or not. It helps you to set encryption options for the PDF file to be saved. Compatibility Specifies the encryption type to encrypt the PDF document. q Document Open Password .0 and later uses a low encryption level (40-bit RC4). while the other option Acrobat 5. Encryption Level Shows the level of the encryption compatibility that you specified in the Compatibility drop-down list. Require a password to open the document Specifies the Document Open Password to prevent others from opening the document without authorization. The option Acrobat 3.PDF Encrypt Option dialog This dialog appears when you check the Encrypt checkbox in the Export dialog.0 and later uses a high encryption level (128-bit RC4). Enable text access for screen reader devices for the visually impaired Allows visually impaired users to read the PDF document with window readers. Cancel Cancels the settings and closes this dialog. q Permissions Password Specifies the password to prevent others from printing and editing. Changes Allowed Specifies the editing actions that are permitted in the PDF document. Printing Allowed Specifies the printing quality for the PDF document. OK Applies the encryption option settings and closes this dialog. Help Displays this help document. . This option is available only if the Compatibility option is set to Acrobat 5.0 or later Acrobat version. Use a password to restrict printing and editing of the document and its security settings Specifies the Permission Password to prevent others from printing and editing the document. q Confirm Password Confirms the password you have specified in the Document Open Password text box. images and other content Allows others to select and copy the contents of the PDF document.Specifies the password to prevent others from opening the document without authorization. Confirm Password Confirms the password you have specified in the Permissions Password text box. q q q Enable copying of text. The password you specify here cannot be the same as the one that you use to open the document. User Password Specifies a password for this digital ID file. Confirm Password . Method Specifies the digital signing method. Digital ID File Specifies whether to use a digital ID file from a specified directory.PDF Sign Option dialog This dialog appears when you check the Sign checkbox in the Export dialog. It helps you to set signing options for the PDF file to be saved. OK Applies the signing option settings and closes this dialog. Help Displays this help document. Your Contact Information Specifies your contact information accordingly. . Edit by Yourself Edits the reason for signing the document.Confirms the password. Cancel Cancels the settings and closes this dialog. Reason for Signing Document Specifies the reason for signing the document. It is enabled when I agree to 'specified' portions of this document is selected from the Reason for Signing Document drop-down list. Location Specifies your location accordingly. Cancel Cancels the print settings and closes this dialog. . Help Displays this help document.Print dialog This dialog appears when you click Menu > File > Print. General tab This tab shows some general information of the report to be printed. It helps you to set settings for printing the report result and contains the following tabs: q General tab Appearance tab q OK Prints the report result with the specified settings to a PDF or HTML file and opens it in an associated program with which you can print the result to a printer. . q . q Printer Specifies the name of the printer.Print Method Specifies the printing method to print the report result. Select one from the drop-down list.. Select one from the drop-down list. This kind of files can only be opened and printed by serial port printer on Windows via DOS command.to. Pages. Printer Specifies the settings of the printer. Media Tray Specifies the media tray for the printer.. Print to File Prints the document to a file instead of a printer.. q All All pages will be printed. q q Print Range Specifies the pages to be printed. q Monochrome Specifies to print the reports in Monochrome. The number of copies will be applied to all specified pages. Copies Specifies the information of the copies. q Number of Copies Specifies the number of copies you want to print. If checked. Color Specifies the color of the report to be printed. 3. when you print two copies of a three-page report. . q Appearance tab This tab shows the appearance of the report to be printed. 3.Specifies the pages to be printed. 2. Collate Specifies the printing order for printing multiple-page reports. 2. 1. the page order is 1. q Draft Specifies to print the report in draft quality. Job Name Specifies the name of the print task. Normal Specifies to print the report in normal quality. Tumble Imposes each consecutive pair of print-stream pages upon the front and back sides of consecutive media sheets.q Color Specifies to print the reports in Color. q q Sides Specifies the print sides for the printed reports. High Specifies to print the report in high quality. Duplex Imposes each consecutive pair of print-stream pages upon the front and back sides of consecutive media sheets. q q . q q Job Attributes Specifies the properties of the print task. User Name Specifies the name of the user. such that the orientation of each pair of print-stream pages on the medium is correct for the reader as if for binding on the long edge. q One Side Imposes each consecutive print-stream page upon the same side of consecutive media sheets. Quality Specifies the printing quality. q Priority Specifies the print priority for this task. such that the orientation of each pair of print-stream pages on the medium is correct for the reader as if for binding on the short edge. Basic mode The basic mode provides function for creating simple filter conditions which are connected by AND and OR operators. It helps you to apply a filter to the business view used by the specified data component to narrow down data scope.Query Filter dialog This dialog appears when you click the Filter button in the Bind Data screen of the JReport Studio Wizard. The dialog contains the following two modes: q Basic Advanced q Advanced/Basic Switches the dialog to the advanced/basic mode. OK Applies the filter and closes the dialog. Help Displays this help document. . Cancel Does not retain changes and closes this dialog. Delete the selected condition line. Operator Specifies the operator to compose the filter expression. . Field Specifies the field to be filtered. is [not] null It is used in WHERE clause predicates to match null values occurring in a specified data field. [not] like Like string pattern matching operator is used to compare the first expression string value to the pattern string (the second expression). if multiple values are required. q q q q q q q q q Value Specifies the value of how to filter the field. [not] between Allows the system to evaluate whether or not data values are located between a range of values indicated in the predicate. You can either enter the value manually in the text box or select a value from the drop-down list.". only "_" and "%" are supported. q AND Logic operator AND which is applied to this and the next line. Logic Lists the logic operator. used for evaluating for a true condition. and if ".q = Equal to > Greater than >= Greater than or equal to < Less than <= Less than or equal to != Not equal to [not] in Causes an enumerated list of values to appear in the WHERE clause predicate. q Advanced mode The advanced mode enables the building of more complex filter conditions via the grouping of conditions. When you type in the value manually. they should be separated with "." or "\ \". write it as "\. OR Logic operator OR which is applied to this and the next line. ." or "\" is contained in the values. If you want to use wildcard character in the pattern string. q User Defined Specifies to create a user defined filter to apply to the business view.Filter Specifies the filter you want to apply to the business view. You can choose one of them to apply. Predefined filters The names of the predefined filters which were created on the business view in JReport Designer. q . Ungroup Makes the selected group ungrouped." or "\ \". Up Moves the selected condition or group up to a higher level. Down Moves the selected condition or group down to a lower level. Group Makes the selected conditions in a group. if multiple values are required." or "\" is contained in the values. Condition Expression Displays the SQL statement of the condition. they should be separated with ". q AND Logic operator And which is applied to this and the next line. OR Logic operator Or which is applied to this and the next line.Add Condition Adds a new condition line. You can either enter the value manually in the text box or select a value from the drop-down list. Logic Specifies the logic operator. and if ". Value Specifies the value of how to filter the field. . q q q Field Specifies the field to be filtered. Conditions can also be added to an existing group by selecting the conditions and the group while holding the Ctrl button. and then clicking the Group button. write it as "\. OR NOT Logic operator Or Not which is applied to this and the next line. Operator Specifies the operator to compose the filter expression. AND NOT Logic operator And Not which is applied to this and the next line. Delete Deletes the selected condition line.". When you type in the value manually. Cancel Cancels the settings and closes this dialog. It helps you to specify the properties of the RealMedia object and contains the following tabs: q General tab Controls tab q OK Applies the settings and closes this dialog. Help Displays this help document. General tab This tab shows some general information of the object. .RealMedia Properties dialog The dialog appears when you right-click a RealMedia object and select Properties from the shortcut menu. Width Specifies the width of the object. Loop . Alternate Text Specifies the alternate text which will be shown if the object cannot be displayed. Center Specifies whether to place the presentation in the center of the image window and display it in its original size (the size is determined by the Width and Height properties). Auto Start Specifies whether to start the media file automatically when the report is opened. The controls will be reproduced in the container as they appear in RealPlayer. Controls tab This tab specifies the RealPlayer controls you want to display.Name Specifies the display name of the object. Height Specifies the height of the object. Fast-forward Button. Play Button Specifies whether to show the Play Button. the Volume Slider and Mute checkboxes will be checked correspondingly. which shows the currently playing position within the clip. which is used for displaying presentations. you can check Volume Slider or Mute respectively.Specifies whether to play the media file repeatedly. Rewind Button. which contains the following playback controls: Play Button. Otherwise. Fast-forward Button Specifies whether to show the Fast-forward Button. the media file will be played back according to the specified number. If checked. Pause Button. which is connected to the www. Home Control Specifies whether to show the Home Button. Loop Number Specifies the number of the times the media file will loop during playback. Position Slider Specifies whether to show the Position Slider. Position Field Specifies whether to show the Position Field. Stop Button. and copyright for the currently playing clip. Information Panel Specifies whether to show the Information Panel that displays the title. Rewind Button . which consists of the Information Panel and the Mute/ Volume Bar. Pause Button Specifies whether to show the Pause Button.com website. Volume Information Specifies whether to show the Information/Volume Bar. Image Window Specifies whether to show the Image Window. All Controls Specifies whether to show all controls. Position Slider and Home Button. Control Panel Specifies whether to show the Control Panel. which means the Loop option will be ignored even though the loop number is set to zero. Mute Button and Volume Slider Specifies whether to show the Mute Button and Volume Slider.real. which shows the position of the current clip that identifies the clip's current place within the presentation timeline and the total clip length. author. Stop Button Specifies whether to show the Stop Button. Note: If you have checked the Loop option and specified the Loop Number at the same time. which consists only of a text message area. and the current clip position indicator. Status Bar Specifies whether to show the Status Bar.Specifies whether to show the Rewind Button. which displays the title. author. . and copyright for the currently playing clip or portion of a multi-clip. Status Field Specifies whether to show the Status Field. which consists of a text message area. Information Field Specifies whether to show the Information Field. the network congestion LED. Help Displays this help document. Color Specifies the color of the report body. To change the color. Name Specifies the display name of the report body. which will be shown on the shortcut menu of the report body.Report Body Properties dialog The dialog appears when you click Menu > Edit > Report Body Properties. It helps you to specify the properties of the report body and contains the following tabs: q General tab Border tab q OK Applies the settings and closes this dialog. click the color indicator to select a color or click More Colors in the color indicator to . General tab This tab shows some general information of the report body. Cancel Cancels the settings and closes this dialog. Choose a style from the drop-down list. Top Line Specifies the line style of the top border of the report body. Choose a style from the drop-down list. Right Line Specifies the line style of the right border of the report body.access the Color Picker dialog to specify a new color. Left Line Specifies the line style of the left border of the report body. Bottom Line Specifies the line style of the bottom border of the report body. or input a color string in the format #RRGGBB. Border tab This tab shows information about borders of the report body. Choose a style from the drop-down list. You can also click More Fill Effects in the color indicator to specify a gradient or an image as the fill effect of the report body in the Fill Effects dialog. . If you want to make the color transparent. Color Specifies the color of the borders. input Transparent in the text box. Choose a style from the drop-down list. Width Specifies the width of the border. you can click the button OK Accepts the parameter values for further processing. You can input the parameter value in the text box.Report Parameters dialog This dialog appears when you click Run in the JReport Studio Wizard to run a web report with parameters. If the parameter is of DateTime type. . or select a predefined value from the drop-down list. a text box or a drop-down list. Cancel Cancels the settings and closes this dialog. the dialog provides a prompt. It helps you to input parameter values for the report. For every parameter the report uses. And if the parameter's Allow Multiple Values property is set to true in JReport Designer. click the calendar button to set a DateTime value with calendar. Help to specify multiple values for the parameter in the Enter Values dialog. .Displays this help document. Cancel Does not save the file as a new one and closes the dialog. It can be Web Report or Web Report Template. The option Web Report Template is available to administrators with the privilege of publishing resources. the dialog appears . Options in the dialog vary according to the file type you select.Save As dialog This dialog appears when you click Menu > File > Save As (or the Save As button on the Standard toolbar) or click Save on the JReport Studio Wizard. or save web report template if you are an administrator with the privilege of publishing resources. Save Saves the new file with the specified settings and closes this dialog. File Type Specifies the type of the file. It helps you to save the current web report. If you select Web Report from the File Type drop-down list to save the current report. Help Displays this help document. The folder may be Public Reports or My Reports. Size Displays the file size.Save in Specifies where the report will be saved. Type Displays the file type. q Name Displays the file names. Last Modified q q q . If selected. Advanced Run and Schedule commands for the report are not available. If later the catalog is updated. Advanced Run and Schedule commands for the report are not available. Set Catalog Copy to Target Folder If checked. the corresponding Run. the saved report will run with the latest version of the catalog. r r q Catalog Specifies the catalog for the new file. To execute a report means to run. Advanced Displays the advanced settings. Inactive The report cannot be executed. If selected. q Status Specifies the status of the report. the corresponding Run. the dialog appears . If you are an administrator with the privilege of publishing resources. the saved report will be linked with the catalog and the saved report will run with the catalog no matter whether the two are in the same directory. advanced run and schedule to run it. r Set Original Catalog as Linked Catalog into Saved Report If checked.Displays the last modified time of the file. you are able to see the option Web Report Template from the File Type drop-down list. Incomplete The report is not completely designed and cannot be executed. By selecting the option you can save the web report template in the current web report. r Active The report can be executed. Description r q Specifies the description for the new file. the catalog will be copied to the directory where the report is saved and the saved report will run with the copied catalog. File Name Specifies the name for the report. which is the system level authorization. File Name Specifies the name of the web report template. You can type the name as required to save it as a new wsld file or select one from the template box above to overwrite an existing wsld file according to Publish privilege.Template box Lists the existing web report templates. . q Name Displays the file names. Type Displays the file type.Select a Report dialog This dialog appears when you click Menu > File > Open (or the Open button you to select the report you want to open. Size Displays the file size. It helps Open Specifies the catalog file which contains the report you want to open. File Type Specifies the type of the file. on the Standard toolbar). OK . q q q File Name Specifies the name for the new file. Last Modified Displays the last modified time of the file. Help Displays this help document. Cancel Does not retain any changes and closes the dialog. .Applies the changes and closes the dialog. Apply To . Select Fields Specifies the fields of the same type to add into the Filter panel. It allows you to select fields you want.Select Field dialog This dialog appears when you click + on the title bar of the Filter panel or click beside the Filter On text box in the Filter Control Properties dialog. or to replace the current fields in the filter control. . OK Applies the selected field and closes the dialog. Cancel Cancels the selection and closes the dialog.Specifies the components to which the filter will be applied. Help Displays this help document. OK Selects the field and closes this dialog. Select the required field and Cancels the selection of a field and closes the dialog.Select Resource dialog This dialog is displayed when you click in the Add Aggregation dialog. all the group objects dynamic formulas then click OK. Help Displays this help document. In this dialog. . Cancel and detail objects in the current business view and the that have been created in the report will be listed. It helps you to specify the field on which the dynamic aggregation will be based. . . It helps you to specify a value to apply a filter criterion. You can search for values in the following value list using the quick search toolbar. Available Values Specifies the value to filter data with.Select Values dialog This dialog appears when you right-click a table field and select Filter > More from the shortcut menu. Opens the quick search toolbar as follows. Cancels the selection of a value. Match Case Specifies whether to search for text that meets the case of the typed text. Cancel Cancels to filter the table column and closes the dialog. . OK Closes the dialog and filters the table column with the value you specified. X Closes the quick search toolbar. r Highlight All Specifies whether to highlight all matched text. q q Lists the advanced options. Match Whole Word Specifies whether to search for text that looks the same as the typed text. r r q Highlights the next matched text. q Highlights the previous matched text.The following are more about the usage of the quick search toolbar: q Text field Type in the text you want to search for in the text field and the matched text will be highlighted among the values. Help Displays this help document. Series Options dialog This dialog appears when you click the Top N button above the Series box in the Bind Data screen of chart in the JReport Studio Wizard. It helps you to set the sort order of the series values and define the number of the series values that will be displayed in the chart. q q Series Selection Specifies the number of the series values that will be displayed in the chart. Chart Wizard. q Ascend Lists data in an ascending order. . or To Chart dialog. Series Order Specifies in which order data on the series axis will be displayed. Insert Chart dialog. No Sort Keeps the data in their original order in database. Descend Lists data in a descending order. Cancel Discards the changes and closes the dialog. . the series values will be sorted by the order specified in the Series Order box of the dialog. Skip First If you check the Skip First option and input a number M in the text field to the right. all series values will be displayed. Help Displays this help document. specify a number in the field to the right and the first N series values will be displayed. then the first M series values in the chart will be skipped and the Select N condition will take effect beginning with M +1. r All If selected. Remaining Series In Enabled only when Top N or Bottom N is selected from the Select drop-down list. specify a number in the field to the right and the last N series values will be displayed. r r q Based On If checked. The skipped values will be included in the Remaining Series group together with all the series values beyond the top/bottom N range. the series values will be sorted by values of the summary selected with the direction specified. Bottom N If selected. Check this option and then type a character string in the text field to group all the series values beyond the top/bottom N range.q Select Specifies the Select N condition to define the number of series values that will be displayed. If unchecked. q q OK Accepts the changes and closes the dialog. Top N If selected. Help Displays this help document.Special Field Properties dialog The dialog appears when you right-click a special field and select Properties from the shortcut menu. Cancel Cancels the settings and closes this dialog. Name . It helps you to edit the properties of the special field and contains the following tabs: q General tab Font tab Border tab q q OK Applies the settings and closes this dialog. General tab This tab shows some general information of the special field. Foreground Specifies the foreground color of the special field. To change the color. Left Padding Specifies the space between the text of the special field and its left border. If you want to make the background transparent. or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB. The following types are available: q Modified Date Prints the last modified date for the catalog. or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB. Font tab This tab shows the font-related information of the special field. Modified Time Prints the last modified time for the catalog. click the color indicator to select a color. To change the color. click the color indicator to select a color. input Transparent in the text box. Top Padding Specifies the space between the text of the special field and its top border. Right Padding Specifies the space between the text of the special field and its right border. Bottom Padding Specifies the space between the text of the special field and its bottom border. You can modify all the font settings in this tab. Select a new one from the drop-down list if you want to change the type. which will be shown on the shortcut menu of the special field.Specifies the display name of the special field. Background Specifies the background color of the special field. User Name Prints the User ID with which you log onto JReport Server. Type Specifies the type of the special field. q q Height Specifies the height of the special field. Width Specifies the width of the special field. . Bold Specifies whether to make the object text bold or not. Word Wrap . Strikethrough Specifies whether or not to attach a strikeout line to the field text. Autofit Specifies whether or not to automatically adjust the width of the special field. Size Specifies the font size of the special field text. Horizontal Alignment Specifies the horizontal alignment mode of the text in the special field.Font Specifies the font face of the special field text. Vertical Alignment Specifies the vertical alignment mode of the text in the special field. Underline Specifies whether the field text will be underlined or not. Italic Specifies whether to make the field text italic or not. Width Specifies the border width. Top Line Specifies the style of the top border line. Border tab This tab shows information about borders of the special field. or the field value will appear in the HTML file the same as that in JReport Studio (HTML tag elements in the field value. Ignore HTML Tag If this option is unchecked.Specifies whether or not to wrap the text to the special field width. Bottom Line Specifies the style of the bottom border line. Right Line Specifies the style of the right border line. Color Specifies the border color. if any. Left Line Specifies the style of the left border line. You can modify all the border settings in this tab. . will not be parsed). JReport will parse HTML tag elements in the field value while the report is to be saved as an HTML file. Shadow Specifies whether the borders will have a shadow effect or not. Shadow Color Specifies the color of the border shadow. . It helps you to specify the number of rows and columns that the specified tabular cell will be split into. . Split Cell Into Specifies the number of rows and columns to split the selected tabular cell into. Cancel Cancels to split the cell and closes this dialog. Input a positive integer in the text box to specify the number. q Number of Rows Specifies the number of rows the tabular cell will be split into. Input a positive integer in the text box to specify the number.Split Cell dialog The dialog appears when you right-click a tabular cell and click button on the toolbar or click Menu > Format > Split. q OK Closes this dialog and splits the tabular cell. Number of Columns Specifies the number of columns the tabular cell will be split into. Help Displays this help document. Name Specifies the display name of the summary field. . General tab This tab shows some general information of the summary field. Cancel Cancels the settings and closes this dialog.Summary Properties dialog The dialog appears when you right-click a summary field and select Properties from the shortcut menu. It helps you to specify the properties of the summary field and contains the following tabs: q General tab Font tab Border tab q q OK Applies the settings and closes this dialog. Width Specifies the width of the summary field. Help Displays this help document. or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB. Foreground Specifies the foreground color of the summary field. If you want to make the background transparent. Right Padding Specifies the space between the text of the summary field and its right border. . Left Padding Specifies the space between the text of the summary field and its left border. Background Specifies the background color of the summary field. To change the color. Height Specifies the height of the summary field. Font tab This tab shows the font-related information of the summary field. or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB.Format Specifies the format of the summary field. input Transparent in the text box. Bottom Padding Specifies the space between the text of the summary field and its bottom border. To change the color. click the color indicator to select a color. Top Padding Specifies the space between the text of the summary field and its top border. click the color indicator to select a color. Italic Specifies whether to make the text italic or not. Word Wrap Specifies whether or not to wrap the text to the summary field width. Ignore HTML Tag . Size Specifies the font size of the text. Strikethrough Specifies whether or not to attach a strikeout line to the text. Underline Specifies whether the text will be underlined or not. Bold Specifies whether to make the text bold or not. Vertical Alignment Specifies the vertical alignment mode of the text in the summary field. Autofit Specifies whether or not to automatically adjust the width of the summary field. Horizontal Alignment Specifies the horizontal alignment mode of the text in the summary field.Font Specifies the font face of the text. if any. will not be parsed). Top Line Specifies the style of the top border line. Right Line Specifies the style of the right border line. Width Specifies the border width.If this option is unchecked. . Shadow Specifies whether the borders will have a shadow effect or not. Border tab This tab shows information about borders of the summary field. Shadow Color Specifies the color of the border shadow. or the field value will appear in the HTML file the same as that in JReport Studio (HTML tag elements in the field value. JReport will parse HTML tag elements in the field value while the report is to be saved as an HTML file. Color Specifies the border color. Left Line Specifies the style of the left border line. Bottom Line Specifies the style of the bottom border line. . Table Cell Properties dialog The dialog appears when you right-click an empty table cell and select Properties from the shortcut menu. Cancel Cancels the settings and closes this dialog. Width Specifies the width of the table cell. General tab This tab shows some general information of the table cell. It helps you to specify the properties of the table cell and contains the following tabs: q General tab Border tab q OK Applies the settings and closes this dialog. Help Displays this help document. Horizontal Alignment Specifies the horizontal alignment mode of the text in the table cell. Height . Background Specifies the background color of the table cell. click the color indicator to select a color. Color Specifies the border color. Bottom Padding Specifies the space between the text of the table cell and its bottom border. To change the color. Width . Border tab This tab shows information about borders of the table cell. Vertical Alignment Specifies the vertical alignment mode of the text in the table cell. Left Padding Specifies the space between the text of the table cell and its left border. input Transparent in the text box. If you want to make the background transparent. or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB. Top Padding Specifies the space between the text of the table cell and its top border.Specifies the height of the table cell. Right Padding Specifies the space between the text of the table cell and its right border. Bottom Line Specifies the style of the bottom border line.Specifies the border width. Right Line Specifies the style of the right border line. Top Line Specifies the style of the top border line. . Left Line Specifies the style of the left border line. . General tab This tab shows some general information of the table footer. Help Displays this help document.Table Footer Properties dialog The dialog appears when you right-click a table footer and select Properties from the shortcut menu. Name Specifies the display name of the table footer. Cancel Cancels the settings and closes this dialog. It helps you to specify the properties of the table footer and contains the following tabs: q General tab Border tab q OK Applies the settings and closes this dialog. . Background Specifies the background color of the table footer. or click More Fill Effects to specify a gradient or an image as the fill effect in the Fill Effects dialog. If you want to make the background transparent. To change the color. click the color indicator to select a color. Border tab This tab shows information about borders of the table footer. Bottom Line Specifies the style of the bottom border line. Top Line Specifies the style of the top border line. Width Specifies the border width. Color Specifies the border color. input Transparent in the text box. or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB.Height Specifies the height of the table footer. .Left Line Specifies the style of the left border line. Right Line Specifies the style of the right border line. . Help Displays this help document. Cancel Cancels the settings and closes this dialog. It helps you to specify the properties of the table header and contains the following tabs: q General tab Border tab q OK Applies the settings and closes this dialog. General tab This tab shows some general information of the table header. Name Specifies the display name of the table header.Table Header Properties dialog The dialog appears when you right-click a table header and select Properties from the shortcut menu. Color Specifies the border color.Height Specifies the height of the table header. To change the color. Border tab This tab shows information about borders of the table header. or click More Fill Effects to specify a gradient or an image as the fill effect in the Fill Effects dialog. Repeat On Each Page Specifies whether to repeat the table header on each page of the report. Top Line Specifies the style of the top border line. Width Specifies the border width. input Transparent in the text box. If you want to make the background transparent. or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB. . Background Specifies the background color of the table header. click the color indicator to select a color. . Right Line Specifies the style of the right border line. Left Line Specifies the style of the left border line.Bottom Line Specifies the style of the bottom border line. Horizontal Alignment Specifies the horizontal justification of the table. Help Displays this help document. It helps you to specify the properties of the table and contains the following tabs: q General tab Border tab q OK Applies the settings and closes this dialog. . Choose an option from the drop-down list. Name Specifies the display name of the table. q left: Aligns the table on the left of the report. which will be shown on the shortcut menu of the table. Cancel Cancels the settings and closes this dialog. General tab This tab shows some general information of the table.Table Properties dialog The dialog appears when you right-click a table and select Properties from the shortcut menu. Width Specifies the border width. . To change the color. Expand Data Specifies whether or not to enable JReport Studio users to expand or collapse dimensions in the table. If you want to make the background transparent. Top Line Specifies the style of the top border line. Border tab This tab shows information about borders of the table. Bottom Line Specifies the style of the bottom border line. or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB. input Transparent in the text box. click the color indicator to select a color. Color Specifies the border color. center: Aligns the table in the center of the report.q right: Aligns the table on the right of the report. q Background Specifies the background color of the table. Right Line Specifies the style of the right border line. .Left Line Specifies the style of the left border line. Display tab Specifies the fields to be displayed in the table. font color and background color properties for the table title. alignment.Table Wizard This wizard is displayed when you do one of the following: q Select a table. It helps you to change data of the table and consists of the following tabs: q Display tab Group tab q Table Title Specifies a title for the table. font style. Select a table. then click the Table Wizard button Right-click the icon on the Context toolbar. size. q q of a table and select Table Wizard from the shortcut menu. Filter Opens the Query Filter dialog to specify the filter which you want to apply to the selected business view. . Data Source Displays the business view that has been used in the table. then click Menu > Edit > Wizard. Sets the font. Adds the selected view element to be displayed in the table. Edits the selected dynamic resource. Removes the selected dynamic resource.Resources Displays all the view elements in the selected business view. Removes the selected view element. Field . Moves the selected view element one step down.Lists the view elements that have been added to the table. Label Specifies the display names of the selected fields. Group tab Specifies the fields to group the data. Resources . Moves the selected view element one step up. Sort Specifies the sort order for each group: Ascend. Cancel Does not retain changes and closes this wizard. .Displays all the available group objects you can use to group the data in the table. OK Applies the changes and closes the wizard. Descend. Moves the selected group one step down. Help Displays this help document. Field Lists all the group objects that have been added as the group fields. Moves the selected group one step up. or No Sort. Adds the selected group object as a group field. Removes the selected group object. Top Padding Specifies the space between the text of the tabular cell and its top border. Height Specifies the height of the tabular cell. Background Specifies the background color of the tabular cell. Vertical Alignment Specifies the vertical alignment mode of the text in the tabular cell. Bottom Padding Specifies the space between the text of the tabular cell and its bottom border. . Horizontal Alignment Specifies the horizontal alignment mode of the text in the tabular cell. Left Padding Specifies the space between the text of the tabular cell and its left border. Right Padding Specifies the space between the text of the tabular cell and its right border. Width Specifies the width of the tabular cell. It helps you to specify the properties of the tabular cell.Tabular Cell Properties dialog The dialog appears when you right-click a tabular cell and select Properties from the shortcut menu. Help Displays this help document. click the color indicator to select a color.To change the color. If you want to make the background transparent. input Transparent in the text box. Cancel Cancels the settings and closes this dialog. . OK Applies the settings and closes this dialog. or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB. or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range or input a color string in the format #RRGGBB. Height Specifies the height of the tabular. It helps you to edit the properties of the tabular. Cancel . If you want to make the background transparent. OK Applies the settings and closes this dialog. input Transparent in the text box.Tabular Properties dialog The dialog appears when you right-click a tabular and select Properties from the shortcut menu. Width Specifies the width of the tabular. To change the color. Background Specifies the background color of the tabular. click the color indicator to select a color. Help Displays this help document. .Cancels the settings and closes this dialog. Adds the selected group or aggregation object to be displayed in the chart. align. Resources Displays all the view elements used in the crosstab. font style.To Chart dialog This dialog appears when you right-click a crosstab and then select To Chart on the shortcut menu or click Menu > Edit > To Chart. size. font color and background color properties for the title. Specifies the font. Category . It allows you to specify settings for converting a crosstab into a chart. Title Specifies a title for the chart. OK Applies the settings and closes the dialog. Specifies the types for chart and sets the values for the Primary Axis or Secondary Axis separately. Moves the selected view element one level up. q Primary Axis Adds a chart type to the primary axis. Moves the selected view element one level down. that will be displayed on the series axis of the chart. . Adds a combo chart to the Primary Axis or Secondary Axis. Help Displays this help document. Removes the selected view element. Cancel Cancels the settings and closes the dialog. q Secondary Axis Specifies whether to show the secondary axis in the chart. Opens the Category Options dialog or Series Options dialog to define the sort order of the category or series values and specify the number of the category or series values that will be displayed in the chart.Lists the group object Series Lists the group object Show Values that will be displayed on the category axis of the chart. Secondary Axis Adds a chart type to the secondary axis. It allows you to specify settings for converting a chart into a crosstab. font style. Specifies the font. Adds the selected group object to be displayed in the columns of the crosstab. Title Specifies a title for the crosstab. align. font color and background color properties for the title. Resources Displays all the view elements used in the chart. .To Crosstab dialog This dialog appears when you right-click a chart and then select To Crosstab on the shortcut menu or click Menu > Edit > To Crosstab. size. Sort Specifies how the selected group objects will be sorted. Moves the selected view element one level down.Adds the selected group object to be displayed in the rows of the crosstab. . q Moves the selected view element one level up. Field Lists the aggregation objects that you selected to display in the crosstab. Label Specifies the display names of the summary fields. that will be displayed on the columns/rows of the crosstab. Adds the selected aggregation object Columns/Rows Lists the group objects q to be the summary field of the crosstab. Label Specifies the display names of the added group objects. Removes the selected view element. q q Summaries Lists the aggregation objects q that will be the summary fields of the crosstab. OK Applies the settings and closes the dialog. Cancel Cancels the settings and closes the dialog. Field Lists the group objects that you selected to display in the crosstab. Help Displays this help document. Name Specifies the display name of the Windows Media. General tab This tab shows some general information of the Windows Media.Windows Media Properties dialog The dialog appears when you right-click a Windows Media object and select Properties from the shortcut menu. Help Displays this help document. Alternate Text . Cancel Cancels the settings and closes this dialog. It helps you to specify the properties of the Windows Media object and contains the following tabs: q General tab Controls tab q OK Applies the settings and closes this dialog. Skip Previous. Fast Rewind. Show Audio Controls Specifies whether or not to show the Mute Button and the Volume Slider on the Control Bar.Specifies the alternate text which will be shown if the Windows Media cannot be displayed. Width Specifies the width of the Windows Media. Show Controls Specifies whether or not to show the Windows Media Player controls. Controls tab This tab specifies the properties for the media file to control the options when playing the media file. Auto Start Specifies whether or not to start the media file automatically when the report is opened in JReport Studio. Skip Ahead. Auto Rewind Specifies whether or not to rewind the media file automatically. and Preview . Show Position Controls Specifies whether or not to show the Fast Forward. Play Count Specifies the number of times you want to play this media file. Height Specifies the height of the Windows Media. It is only enabled when the Control Bar is visible. Show Status Bar Specifies whether to show the Status Bar. . Show Go To Bar Specifies whether to show the Go To Bar. Show Tracker Specifies whether to show the Tracker Bar. Show Caption Specifies whether to show the Closed Captioning Displayed Panel. Show Display Specifies whether to show the Display Panel.buttons on the Control Bar. This section introduces each of these dialogs in alphabetical order. you will go through the following dialogs.JDashboard dialogs While using JDashboard. q Color Picker dialog Customize Component Title Bar dialog Customize Value dialog Edit Filter Control dialog Edit Image dialog Edit Label dialog Edit Slider dialog Edit Special Field dialog Enter Values dialog Insert Filter Control dialog Insert Image dialog Insert Slider dialog Insert Special Field dialog Open Dashboard dialog Save As dialog Themes dialog q q q q q q q q q q q q q q q . You can go into the links for details. Color Picker dialog This dialog helps you to specify a color for an object. Standard tab This tab allows you to select one from the web safe colors. It contains the following tabs: q Standard tab Custom tab q OK Closes this dialog and returns the color value specified. Displays this help document. Ignores the setting and closes this dialog. . Cancel Closes this dialog without changing the color value. The value is from 0 to 255. Clicking this part will restore the color to the original. The value is from 0 to 255. The value is from 0 to 255. . G Specifies the amount of green in a color. R Specifies the amount of red in a color.Colors Lists the colors for you to select one. B Specifies the amount of blue in a color. New This part displays the color you select. # Specifies the hexadecimal value of the color. Current This part always displays the original color. Color matrix Select a color you want in the color matrix. The value is from 0 to 255.Custom tab This tab allows you to customize the color within a wider range. B Specifies the amount of blue in a color. R Specifies the amount of red in a color. New . The value is from 0 to 255. The hue of the matrix is based on the color you define on the color bar. The value is from 0 to 255. G Specifies the amount of green in a color. # Specifies the hexadecimal value of the color. Color bar Specifies a color on the bar which will be the hue of the color matrix. Clicking this part will restore the color to the original.This part displays the color you select. . Current This part always displays the original color. Component Title Bar Specifies the way of showing the component title bar. OK Closes this dialog and applies the setting. Save into My Preferences Settings Specifies whether to save the setting here into your profile. Displays this help document. Ignores the setting and closes this dialog. Icon on Component Title Bar Specifies the way of showing the icons on the component title bar.Customize Component Title Bar dialog This dialog helps you to customize the way of showing component title bar and the icons on it. Cancel Cancels the setting and closes this dialog. . For details about the special functions. To customize the values. . refer to Specifying special function for group by field in the JReport Designer User's Guide. All Values This option is selected by default. which means that all the values of the selected field will be available on the slider. Special Function Specifies a special function from the drop-down list. options in the dialog are as follows. you need unselect this option. It helps you to customize the values of the selected field and varies with the slider type: Range of Values or Single Value. Available to Date/Time/DateTime type fields.Customize Value dialog The dialog appears when you specify the fields to bind to a slider and click the Customize button in the Insert Slider dialog or Edit Slider dialog. If the slider type is Range of Values. options in the dialog are as follows. . For Date/Time/DateTime type fields. If the slider type is Single Value.From Specifies the start value of the value range. You can select the value from the drop-down list or type it into the text field. You can select the value from the drop-down list or type it into the text field. Ignores the setting and closes this dialog. Cancel Cancels customizing the values for the selected field. To Specifies the end value of the value range. you can also use the calendar button specify a value. OK Closes this dialog and saves the customized values. For Date/Time/DateTime type fields. to to Displays this help document. you can also use the calendar button specify a value. Removes the selected value. Name Specifies the values in the Name box. OK .Special Function Specifies a special function from the drop-down list. All Values This option is selected by default. refer to Specifying special function for group by field in the JReport Designer User's Guide. which means that all the values of the selected field will be available on the slider. Adds a value line to the Name box. You can select a value from the drop-down list or type a value into the text field. Available to Date/Time/DateTime type fields. To customize the values. For details about the special functions. you need unselect this option. Closes this dialog and saves the customized values. Displays this help document. . Ignores the setting and closes this dialog. Cancel Cancels customizing the values for the selected field. Select Fields Specifies the fields to bind to the filter control. The common usage is to select one field. . Title Specifies a title for the filter control. To filter components using different data sources.Edit Filter Control dialog This dialog is displayed after you click It helps you to edit the filter control. Apply To Specifies the data components from the drop-down list to apply the filter control to. on the title bar of a filter control and then select Edit Setting. and then based on the field to filter the data of the components created from the same data source as the field. <All> means all data components involving the selected fields in the dashboard. All the selected fields should be of the same data type. choose a common field all the data sources contain and select the field in all the data sources. Displays this help document.OK Closes this dialog and applies the changes to the filter control. . Ignores the setting and closes this dialog. Cancel Cancels the edition and closes this dialog. bat. You can click the Browse button to locate the image file. q Local File Specifies to use an image from the local file system. r File URL Specifies the URL of the image file. q Web URL Specifies to use an image via URL. Note: If your JReport Server is in an intranet which requires a proxy. which is located in <install_root>\bin. to successfully access the image via URL. r File Name Specifies the path and name of the image file. It helps you to select another image to replace the the button current image.proxyPort=XX to the server's startup file JRServer.Edit Image dialog This dialog is displayed when you hover the cursor on an image in the dashboard header and then click in the appearing dotted rectangle.proxyHost=XXX -Dhttp. you need to add the parameters -Dhttp. . Image From Specifies the source of the image file. q Library Specifies to use an existing image. Preview Displays a preview of the selected image. Displays this help document. Select the one you want to use.r My Pictures The My Pictures folder is a virtual location where JReport Server stores the images that have once been inserted into JDashboard. Cancel Cancels the change of the image and closes this dialog. OK Closes this dialog and use the selected image to replace the current image. Ignores the setting and closes this dialog. . To change the color. size.Edit Label dialog This dialog is displayed when you hover the cursor on a label and then click the button in the appearing dotted rectangle. Font Color Specifies the color of the text. Background Color Specifies the background color of the label. Font Size Specifies the font size of the text from the drop-down list. . It helps you to edit the properties of the label such as font. the way of aligning text etc. or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range. click the color indicator to select a color. color. Font Face Specifies the font of the text from the drop-down list. border. I Specifies whether to make the text italic. Border Line Specifies the line style of the border from the drop-down list. U Specifies whether to underline the text. click the color indicator to select a color. Height Specifies the height of the label. Width Specifies the width of the label. q q q . click the color indicator to select a color. Align Right Specifies to align the text to the right. Align Left Specifies to align the text to the left.To change the color. Border Color Specifies the color of the border. To change the color. Border Width Specifies the width of the border. Padding Specifies the space between the text and the borders of the label. or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range. Preview box Displays a preview of the label with the specified properties. or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range. Align Center Specifies to align the text in the center. B Specifies whether to make the text bold. Border Specifies the border properties of the label. Apply Applies the properties but does not close the dialog.OK Closes this dialog and applies the properties to the label. . Ignores the setting and closes this dialog. Cancel Cancels the edition and closes this dialog. Displays this help document. on the title bar of a slider and then select Edit Setting. It Title Specifies a title for the slider. you can select one value at runtime. you can select a range of values at runtime. q Select Fields .Edit Slider dialog This dialog is displayed after you click helps you to edit the slider. Not available for numeric data type fields. Single Value If selected. Slider Type Specifies whether the slider is used to specify a range of values or to specify a single value: q Range of Values If selected. Customize Opens the Customize Value dialog for you to customize the values of the selected field. All the selected fields should be of the same data type. <All> means all data components involving the selected fields in the dashboard.Specifies the fields to bind to the slider. The common usage is to select one field. and then based on the field to filter the data of the components created from the same data source as the field. Apply To Specifies the data components from the drop-down list to apply the slider to. . Ignores the setting and closes this dialog. Cancel Cancels the edition and closes this dialog. To filter components using different data sources. OK Closes this dialog and applies the changes to the slider. Displays this help document. choose a common field all the data sources contain and select the field in all the data sources. size. Font Size Specifies the font size of the text from the drop-down list. Font Color Specifies the color of the text. Field Type The current special field is selected by default.Edit Special Field dialog This dialog is displayed when you hover the cursor on a special field (User Name or Print Date) and in the appearing dotted rectangle. color. . the date format drop-down list is displayed for you to choose one. If Print Date is selected. It helps you to edit the properties of the then click the button special field such as font. border. the way of aligning text etc. Font Face Specifies the font of the text from the drop-down list. Border Specifies the border properties of the special field.To change the color. I Specifies whether to make the text italic. Border Width Specifies the width of the border. click the color indicator to select a color. click the color indicator to select a color. Align Left Specifies to align the text to the left. To change the color. B Specifies whether to make the text bold. Height Specifies the height of the special field. Width Specifies the width of the special field. U Specifies whether to underline the text. or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range. Align Right Specifies to align the text to the right. Background Color Specifies the background color of the special field. or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range. Border Color q q q . Align Center Specifies to align the text in the center. Border Line Specifies the line style of the border from the drop-down list. Preview box Displays a preview of the special field with the specified properties. Ignores the setting and closes this dialog.Specifies the color of the border. click the color indicator to select a color. OK Closes this dialog and applies the properties to the special field. Displays this help document. Cancel Cancels the edition and closes this dialog. Apply Applies the properties but does not close the dialog. . or click More Colors in the color indicator to access the Color Picker dialog in which you can select a color within a wider range. Padding Specifies the space between the text and the borders of the special field. To change the color. Removes the selected values from the Selected Values box. Adds the selected values from the Available Values box to the Selected Values box. The selected values are case sensitive. but the Display Column is different from the Bind Column. Available Values Lists all predefined parameter values for selection. When the parameter is bound with a column. It helps you to specify multiple values for the parameter.Enter Values dialog The dialog appears when you click the button while specifying values for a parameter in the configuration panel of a library component. values of the Display Column are listed here. Selected Values Lists the values selected. . Enter a value manually in the text box and then click the button next to add the value to the Selected Values box. CUSTOMERID>0 and CUSTOMERS. Note: When a multi-value parameter is inserted as a field into a library component and All is selected as the value. the query is then: ( 1 = 1) In this case. Displays this help document. Cancel Cancels changing the parameter values and closes this dialog.Adds all the values from the Available Values box to the Selected Values box. which are all the available values. This option is available when the parameter's Enable the "All" Option property is set to true in JReport Designer. it means that the parameter value result is all the values in the DBMS. 2 and 3 as the parameter values.CUSTOMERID.3)) Run the same dashboard again and this time check the All checkbox in the Enter Values dialog. when the parameter query is: SELECT CUSTOMERS. make sure the value you enter is that of the bind column. OK Closes this dialog and applies the specified values to the parameter. Enter Values This option is available when the parameter's Allow Type-in of Value property is set to true in JReport Designer.CUSTOMERS.CUSTOMERID IN ( 1. you will get more customers even though available values are only 1 – 3. Ignores the setting and closes this dialog. but the display column is different from the bind column.CUSTOMERNAME FROM CUSTOMERS where CUSTOMERS. the field will show the string "All" which represents all the values in the DBMS. . When the parameter is bound with a column. Removes all the values from the Selected Values box. For example. This is translated in SQL to remove the parameter which may select more values than listed in the available values list. the (CUSTOMERS. All If selected.CUSTOMERID<4 When you click SQL is: to add 1.2. To filter components using different data sources. <All> means all data components involving the selected fields in the dashboard. Select Fields Specifies the fields to bind to the filter control. Title Specifies a title for the filter control. The common usage is to select one field. It helps you to insert a filter control into the dashboard body to filter component data.Insert Filter Control dialog This dialog is displayed when you drag Filter Control from the Toolbox panel to the dashboard body. All the selected fields should be of the same data type. . Apply To Specifies the data components from the drop-down list to apply the filter control to. choose a common field all the data sources contain and select the field in all the data sources. and then based on the field to filter the data of the components created from the same data source as the field. . Ignores the setting and closes this dialog.OK Closes this dialog and inserts the filter control in the dashboard body. Cancel Cancels the insertion and closes this dialog. Displays this help document. proxyHost=XXX -Dhttp. You can click the Browse button to locate the image file. you need to add the parameters -Dhttp.proxyPort=XX to the server's startup file JRServer.bat. q Library Specifies to use an existing image. It helps you to insert an image into the dashboard header. q Web URL Specifies to use an image via URL.Insert Image dialog This dialog is displayed when you drag Image from the Toolbox panel to the dashboard header. r My Pictures The My Pictures folder is a virtual location where JReport Server stores the images that have once . Image From Specifies the source of the image file. r File URL Specifies the URL of the image file. q Local File Specifies to use an image from the local file system. r File Name Specifies the path and name of the image file. Note: If your JReport Server is in an intranet which requires a proxy. which is located in <install_root>\bin. to successfully access the image via URL. Preview Displays a preview of the selected image. Cancel Cancels the insertion and closes this dialog. Select the one you want to use. Ignores the setting and closes this dialog. . Displays this help document. OK Closes this dialog and inserts the selected image in the dashboard header.been inserted into JDashboard. Slider Type Specifies whether the slider is used to specify a range of values or to specify a single value: q Range of Values If selected. q Select Fields . Title Specifies a title for the slider. you can select a range of values at runtime. Single Value If selected. It helps you to insert a slider into the dashboard body to filter component data. Not available for numeric data type fields. you can select one value at runtime.Insert Slider dialog This dialog is displayed when you drag Slider from the Toolbox panel to the dashboard body. Displays this help document. <All> means all data components involving the selected fields in the dashboard. All the selected fields should be of the same data type. Cancel Cancels the insertion and closes this dialog. Ignores the setting and closes this dialog. The common usage is to select one field. and then based on the field to filter the data of the components created from the same data source as the field. To filter components using different data sources. Apply To Specifies the data components from the drop-down list to apply the slider to. OK Closes this dialog and inserts the slider in the dashboard body. Customize Opens the Customize Value dialog for you to customize the values of the selected field. . choose a common field all the data sources contain and select the field in all the data sources.Specifies the fields to bind to the slider. OK Closes this dialog and inserts the selected special field in the dashboard header. It helps you to insert User Name or Print Date in the dashboard header. Displays this help document. Print Date Inserts Print Date in the dashboard header. User Name Inserts User Name in the dashboard header.Insert Special Field dialog This dialog is displayed when you drag Special Field from the Toolbox panel to the dashboard header. . Cancel Cancels the insertion and closes this dialog. Ignores the setting and closes this dialog. Displays this help document. Open In Browse to the directory in the server resource tree where the target dashboard is located and then select the dashboard. File Name Shows the selected dashboard file name. The resource table shows the resources in the current directory.Open Dashboard dialog This dialog helps you to open another dashboard in the web browser. Use the button to go to the parent folder. OK Closes this dialog and opens the selected dashboard. Ignores the setting and closes this dialog. Cancel Cancels opening another dashboard and closes this dialog. . Cancel Cancels saving the dashboard in a different place and closes this dialog. OK Closes this dialog and saves the dashboard. to go to Displays this help document. Save In Specifies the directory in the server resource tree where you want to save the dashboard. File Name Specifies the file name for the dashboard to save. Ignores the setting and closes this dialog. Use the button the parent folder. .Save As dialog This dialog helps you to save the dashboard in a different place. The resource table shows the resources in the current directory. Move the cursor on the arrow and when the cursor becomes a hand icon. Each theme is displayed in a rectangle with the name and three color boxes.Themes dialog This dialog is displayed after you click on the side bar and then select Themes from the menu list. click the arrow to show that the color in each color box is for which window element. . Theme list The left panel lists the themes for choosing. Hover the cursor on a rectangle to show an arrow at the right most of the rectangle. It helps you to change the theme of the current dashboard. Cancel Cancels changing the theme and closes this dialog. OK Closes this dialog and applies the selected theme to the current dashboard. . Displays this help document.Preview The right panel shows a preview of the current dashboard window with the selected theme. Apply Applies the selected theme to the current dashboard without closing this dialog. Ignores the setting and closes this dialog. alll of which will allow you to further understand JReport Server.Appendixes This chapter presents additional information about JReport Server. q Appendix 1: Properties in the server. including specific reference and several lists of properties.properties file Appendix 2: Preference properties Appendix 3: System database properties in JReport server cluster Appendix 4: Mapping list of UI options and properties Appendix 5: Dynamic names Appendix 6: Language and region name list for National Language Support Appendix 7: Properties for scheduling reports via URL Appendix 8: DHTML tag library q q q q q q q . member.properties file which is created in <install_root>\bin when the first time JReport Server is started. This property is available only when the license key you use for your JReport Server is cluster enabled. Each clustered server should have an unique member ID.Appendix 1: Properties in the server. enable property.properties file in <install_root>\bin. enable is false.properties file This appendix provides a list of properties in the server. the property will be added in server. Specifies the name of the cluster.enabled is set to true. the server's performance and reliability will be affected. and the default value of the property varies as follows: q Default Value (Range) Description If there already exists the server.enable true/false Specifies whether or not to activate the cluster feature on the server. when you want a clustered server to work individually (not in a cluster environment). after you use the cluster enabled key to launch your JReport Server. Therefore.properties and its default value is true.name jreport-cluster ENGINE . and the detailed information about these properties. the default value for cluster. properties file in <install_root> \bin but without the cluster.id Specifies the member ID for the clustered server. q When the cluster feature is activated on a clustered server. When the property cluster. you can turn off the cluster feature on it by setting this property to false. cluster. after you use the cluster enabled key to launch your JReport Server. you must specify a unique cluster name for the servers that will join the cluster to build the cluster. the server will call the remote methods to accomplish tasks. If there is no server. The value of this property should be an integer no less than 1. cluster. Property Name CLUSTER cluster. however by using RMI. server.password ftps. A larger share of CPU usage will speed up performance. The performance of JReport Server is influenced by the usage of the CPU that the JReport engine can occupy. this property is used by parameters and export formats (HTML. RcServlet) listens. you can modify this option to enable the engine to share a larger part of CPU usage when it is running.buffer_size -1 FTPS ftps. PDF.algorithm ftps. Specifies that there should be only one thread when the engine is running. To tune JReport Server to the best performance.truststore.dashboard.type HTTPSERVER httpserver. Specifies FTPS key store type. RTF. Specifies FTPS key store file.password ftps.keystore. Specifies FTPS trust manager algorithm. Specifies the port for accessing JDashboard page.keystore.admin.port 8887 . Specifies FTPS trust store password.type ftps. Specifies the buffer size (MB) used in the RAM for each report when sorting on DHTML reports. Specifies FTPS trust store file. This port is where the servlet for remote administration (jet. A port used to configure and administer the server remotely. Specifies FTPS trust store type. The default value -1 means that the buffer size is controlled by the system automatically. The property value is used to encode the displaying value of parameters and report data when exporting to these formats.priority 2 (0 ~ 4) engine. Specifies the CPU utilization priority for the engine. XLS.default_encoding - In JReport Engine.file ftps.algorithm ftps. Specifies FTPS key store password. The maximum number of Client sockets that can be queued when waiting to be accepted by the JReport Server socket.servlets.single_thread true engine.sort.truststore.file ftps.keystore.keymanager. The minimal size required by JReport is 4 MB.port 8889 (1 ~ 65535) - httpserver. and email). Specifies FTPS key manager algorithm. engine.truststore.trustmanager.backlog 50 httpserver.engine. host.max. By default this property does not appear in the server.host.host.properties .host.propfile <install_root>\bin\redirect. even if httpserver. the slower the speed. The more requests that are executed. Specifies the HTTP Server name. However.max.handlers 50 (1 ~ 2147483647) httpserver.host. Specifies the path and file name of the RcServlet property file.host. you can set the maximum number of user handlers to a comparatively small number.admin. For Linux environment.httpserver. httpserver.host.name. numbers less than 1024 are usually reserved by system.connections 1000 (1 ~ 2147483647) The maximum number of connections that a standalone server can accept.name * If httpserver. you need set httpserver.all true Specifies whether JReport Server listens on all network addresses.all=false. The number of the executed requests is in inverse proportion to the speed of the response. To improve the running speed. Specifies the TCP port on which JReport Server listens when the server is started. use this property to specify IP addresses that JReport Server listens on.all=false httpserver. In order to listen on more than one IP address on Linux.properties <install_root>\bin \admin. httpserver. for example: httpserver.name=IP1 IP2 IP3 httpserver.properties file and you need add it manually if you want to use it. all=false.redirect. The maximum number of user handlers that JReport Server can hold.propfile httpserver. at most one IP address can be gotten because of JDK's own reason.servlet.all=true.host.port JREntServer/1. JReport Server can respond to requests from the client-side simultaneously.name httpserver. Specifies the path and file name of the redirect property file.1 8888 (1 ~ 65535) httpserver. This port can be an integer between 1 and 65535. and then set the desired IP addresses separated by a blank as the value of httpserver. New requests sent to a standalone server will be refused when the amount of connections that the server is processing exceeds this number. so numbers larger than 1024 are recommended. The port used for visiting JReport Console page via HTTPS schema. The location of the keystore file. you can use HTTPS schema to visit JReport Server UI in the standalone mode. The valid values are JKS and PKCS12. The default value 0 means infinite.port 6889 httpserver.ssl. The port used for visiting JDashboard page via HTTPS schema. in seconds.ssl.algorithm sunx509 httpserver. This will turn the web server into a JReport Server.JRServlet to any web server that supports servlets.password httpserver. HttpServlet.timeout 0 httpserver.http. The HTTP Server will never be forced to terminate if it is set to 0. the request will be refused back to the client.keystore.httpserver. If true.ssl.ssl.keystore. The encryption/decryption protocol to be used on the socket. For IBM JVMs you should use IbmX509.dashboard.shutdown. Specifies the maximum number of milliseconds that a request from a client-side can be blocked before being refused by the server. servlet. The password used to protect the integrity of the keystore.ssl.port 6888 httpserver.timeout 0 httpserver.admin.type <install_root>\bin\keystore jinfonet JKS httpserver. JRServlet. The type of keystore to be instantiated. If there are still no connection handlers free after the maximum number of milliseconds has been reached.enable false httpserver.servlet. You can install jet. which implements the interface of javax. The X509 algorithm to use.ssl. The port used for visiting JReport Administration page via HTTPS schema.protocol SSL httpserver. httpserver. Specifies Socket time line. It should be different from the Administration Port for HTTP schema.server.servlets. it will be forced to terminate.timeout 500 (1 ~ 2147483647) . The valid values are SSL and TLS. When the time exceeds the specified duration when shutting down the HTTP Server.servlet. in seconds.ssl.port 6887 httpserver.socket.properties Specifies the path and file name of the servlet property file. The core of JReport Server is jet.server.ssl. It should be different from the dashboard port for HTTP schema. It should be different from the Port for HTTP schema.ssl. Specifies a shut-down time limit for the HTTP Server.propfile <install_root>\bin \servlet. This defaults to the Sun implementation (SunX509).keystore httpserver. Specifies the time interval (in milliseconds) for the monitor thread.maxnumber.config.properties /servlet/sendfile log.running monitor.url PERFORMANCE . Otherwise.overtime.config.interval 60000 MONITOR monitor. Specifies the time interval (in milliseconds) for when the monitor statistics of the server are updated. a report will be marked as a large report when its running time exceeds the time limit. Specifies the sendfile servlet mapping path.config.savereport 2 (1 ~ 2147483647) 30000 (1 ~ 9223372036854775807) monitor.server.savereport 60 (1 ~ 9223372036854775807) 2 (1 ~ 2147483647) 20 monitor. Specifies to enable auto-update of logging configuration changes (by manually modifying the configuration file) at runtime.webapp. If set to true.refresh.interval 10000 (1 ~ 9223372036854775807) http://localhost:8848/monitor/index.interval 10000 (1 ~ 9223372036854775807) monitor. Specifies the interval value (in milliseconds) for when logging configuration changes will be autoupdated. RequestDispatcher.interval monitor.web. any changes to the configuration file will not take effect until you restart JReport Server. This property will only function after the log.jsp monitor. Specifies the time limit (in milliseconds) of over-time running reports.update false log. Specifies the location (full absolutepath file name) of the logging configuration file.cluster.filename <install_root>\bin\LogConfig. For example.use_old_forward_method false Specifies whether to use old implementation for javax. Specifies the maximum number of completed reports that can be kept in the cache.sendfile LOG log. any changes to the logging configuration file at runtime will automatically take effect after the specified update interval.savereport monitor.servlet.refresh. JSP jsp. Specifies the time interval (in milliseconds) for when the monitor statistics of the clustered server are updated.update property has been set to true.config.forward() or use new implementation. where the Monitor link on the system toolbar of the JReport Administration page (port 8889 by default) links to.number.maxminute. Specifies the maximum completed report count that is to be shown on the Finished tab. Specifies the maximum time limit (in minutes) for a report status to be shown on the Finished tab.update. Specifies JReport Server Monitor URL.httpserver. No further catalogs can be cached if the number of cached catalogs reaches this number.thread false performance. the I/ O efforts in certain circumstance may be considerably reduced so that the overall performance will be improved.compressio false performance. If your system already has high CPU usage. depending on different circumstances.cacherpt performance.max.catpoolsize true true true true 10 Specifies to cache all the images that are used in reports.cachecat performance. Specifies the maximum number of concurrent reports in the running queue.interval 60 performance.loadfont performance.commit. performance. Note: Compressing swap files will increase CPU usage because it uses a compression algorithm to shrink data. More Info Specifies the maximum size for caching images.preloadcatcls performance. Specifies to cache catalogs in the memory. More Info Specifies to commit every change in the Version list. More Info Specifies whether or not to compress the temporary data generated during runtime before it is swapped to disk. enabling this option will increase CPU usage.exe_gc performance.commit. Specifies to enable the HTML pipeline function. More Info Specifies the maximum number of catalogs that can be cached by the server. in MBs.html.cacheallimg performance.pipeline performance.imgpoolsize performance. By compressing the swap files. Schedule list or Completed list.performance.reports false false 10 false 0 Specifies whether to control garbage collection by JReport.cacheimg performance. and such impact may overcome the performance gain that comes from reducing I/O time. More Info Specifies to enable the image cache function. Specifies the time interval for when JReport Server will commit the changes in the Version list. This number must be less than or equal to the number permitted by the license. performance. Additional reports that are requested will be queued until space in the running queue is available. More Info Specifies to load catalog related Java classes when JReport Server starts. Schedule list or Completed list. Specifies to cache reports in the memory. Specifies the catalogs to be loaded when JReport Server starts. Specifies to pre-load fonts when JReport Server starts.preloadedcats true - . following the rule of "First in. queue. not the normal running queue.properties file.Run tasks according to their priority levels. Specifies to load reports related Java classes when JReport Server starts.9 Specifies the priority levels of the waiting tasks that will be promoted to accelerated tasks.policy. Set one or more priority levels separated by comma as the property value. Accelerated tasks have higher priority than other tasks and run in a separate accelerated queue.policy.Run tasks according to the time when they are started. The valid property values are as follows: q queue. q q q .showimgdetail true QUEUE queue.preloadenginecls performance. The priority levels are from 1 to 10 in an ascending order with 10 having the highest priority and by default priority 9 and 10 tasks would be processed in the accelerated queue.Increase the priority level of waiting tasks each time after the specified number of tasks are completed. Specifies to load engine related Java classes when JReport Server starts. Specifies the way of controlling queue. 1 . No further reports can be cached if the number of cached reports reaches this number. More Info Specifies whether to display the detailed status of the cached images.policy 0 0 .size 0 Specifies the maximum number of accelerated tasks in the accelerated queue. properties file. Specifies the maximum number of reports that can be cached by the server. 2 . performance. You need to set the property queue.performance.preloadedrpts performance.Increase the priority level of waiting tasks each time after a specified period. 3 .rptpoolsize true true 10 Specifies the reports that are to be loaded when JReport Server starts. First out". You need to set the property queue.accelerated.readjust in the server.accelerated 10.preloadrptcls performance. waitingtime in the server. This property is created in the server. If time is out.dir %ReportHome%\properties .dir %ReportHome%\history resource. The property value is measured by the completed tasks. You should better set a different root directory for the report resources on each clustered server.root %ReportHome%\jreports Specifies the report root directories of the report resources. This is a property which redirects the <install_root>\properties folder in a JReport Server cluster environment.default_public_catalog /SampleReports/SampleReports. You need to set this property when queue. Specifies the time length for the temporary report result files to be kept after they have been generated. By default it is 86400 seconds (24 hours).life 86400 resource. The property controls readjusting upward the priority of waiting tasks each time after the specified number of tasks are completed.share. The clock count returns to 0 and it counts periodically. all the files in the temp folder will be deleted except the files which are being used. Each clustered server should use this property to redirect the properties folder to its own location. This property is created in the server. resource. 300 is the minimum number. properties file only when the server is started in a JReport cluster environment. This property is created in the server.queue. Specifies the history directories of the report resources on the clustered servers.policy.policy=2. queue. You should better set a different history folder to store the parameter information and versioning result files on each clustered server.properties file only when the server is started in a JReport cluster environment.readjust 4 You need to set this property when queue. Specifies the default public catalog that will be shown automatically when JReport Server is accessed using a web browser. The property controls readjusting upward the priority of waiting tasks each time after a specified time period.waitingtime 1200 RESOURCE resource.hist.policy=3.properties.result.cat resource. The property value is measured in seconds.policy. Specifies the properties directories of the report resources on the clustered servers.share.properties file only when the server is started in a JReport cluster environment. time 0 . Each clustered server should use an individual realm folder to store its security information. All the files in the temp folder will be deleted when JReport Server restarts. This property is created in the server.properties file and you need add it manually if you want to use it. realms.enabled 30 0 false false Specifies the retry interval in seconds when trying to recover a task. Specifies the period an automatic cached data result is kept.expired. Specifies the maximum retry times when trying to recover a task. Specifies whether to enable to automatically cache report data. This property is created in the server. see Managing cached report data.dir %ReportHome%\realm Specifies the realm directories of the report resources on the clustered servers. In JReport cluster environment this property will be saved in the server's system database and is not created in the server. resource.share.auto_recover_task.realm.never. expire=false. autocache. such as the result files generated when you run a report.enabled=true and server.properties file.autocache.interval server.free true Specifies that any resource nodes not bound with an ACL are accessible.recreate_all_results server. properties file only when the server is started in a JReport cluster environment.max_times server. SERVER server.auto_recover_task. This property takes effect when server.undefine.share. resource. and users.autocache.properties file. In JReport cluster environment this property will be saved in the server's system database and is not created in the server.dir %ReportHome%\temp Specifies the temporary directories of the report resources on the clustered servers.temp. Realms and users are organized into a folder tree structure. such as ACLs. For more about cached report data. properties file only when the server is started in a JReport cluster environment. groups.resource. Each clustered server should use an individual temp folder to store its temporary files generated during its working process. Specifies whether to re-create all the result files when recovering a task. By default this property does not appear in the server. server.auto_recover_task.autocache. max_count 3000 (0 ~ 2147483647) server. To avoid this case. Specifies the maximum number of completed records that will be kept the Completed table. The value should be between 4 MB and 1024*1024 MB. In JReport cluster environment this property will be saved in the server's system database and is not created in the server. autocache.never.properties file.autocache. server. Internet Explorer will not hold the connection open.server.connection. Setting this property to false will disconnect the connection once it has received the response. Set the value to zero if you do not want to limit the record count.write_in_queue=true.completed. enabled=true. completed.disk. and the scheduled tasks need not wait for the operation results to return.keepalive true Specifies to keep the connection alive after it has connected to JReport Server. That is.max. it is possible that many tasks try to write records into the completed task table at the same time.completed.usage 512 Specifies the maximum hard disk space for automatic cached data. it will write a record into the completed task table.properties file. set server.enabled=true.properties file and you need add it manually if you want to use it.write_in_queue false server. In JReport cluster environment this property will be saved in the server's system database and is not created in the server. This property takes effect when server. and it may block new tasks. In JReport cluster environment this property will be saved in the server's system database and is not created in the server. By default this property does not appear in the server. This property takes effect when server.expire true server. It will become a bottleneck because the operation is synchronized.autocache.properties file.autocache. Before a scheduled task finishes. If there are a number of scheduled tasks running concurrently. Specifies whether automatic cached data never expires. all operations of writing into the completed task table will be performed in a separate thread one by one. . If the value is true. see Managing cached report data.server.properties file. they will be displayed the data they are privileged to see according to the cached report bursting setting in the report. server.memory. Specifies the mode when scheduling a report with cached report bursting to publish it to the HTML and DHTML formats: q server.enable. the default value of this property will be true. can exist simultaneously. only the newly created session is active.enableDynamicResource false Specifies whether to enable getting server resources from their real paths.dir <install_root>\dynamicclasses Specifies a folder location on the server machine to hold all the UDS jar files.The scheduled result includes full data.crd. and all the other former sessions created by the same user will be terminated by JReport Server automatically. For more about cached report data. if you choose Custom Installation for Standalone Server and with the Enable Resources from Real Paths option checked. server. server. when installing JReport Server. The minimum value is 4 MB and can be increased up to 80% of the total Java maximum heap size (-Xmx value in JRServer.bat). All cached report data being used to run reports will share the same memory space. a user can log onto JReport Server repeatedly without having to terminate any of his/her former sessions until the number of sessions reaches the number permitted by the license. false . Specifies that multiple sessions created by one user. If the value is false.enableMultipleLogin true .The scheduled result only contains the data that the user who did the scheduling is allowed to see.usage 4 Specifies the maximum memory usage when running a report using cached report data. In JReport cluster environment this property will be saved in the server's system database and is not created in the server. However.dynamic. Then when end users view the result. so that you can specify to load the classes from that folder.class. see Scheduling to HTML/ DHTML. q For details.cachedreportbursting true true . http. Specifies the maximum size in KB of the attachments in one e-mail sent by the server.font. More Info Specifies whether to enable the profiling system.param_values.invalidate_httpsession_when_logout server.properties file.algorithm 0 (0 and 1) server.output_encoding - server. the permission accumulation algorithm will be used. comma (. By default. When it is set to 0.clearrecord_lagging_time 300 server.profiling. Specifies the language the server uses. If it is set to 1.send_size true en 2000 server. the user permission replacement algorithm will be used. By default. this property does not appear in the server. unlimited records will be allowed in the user's Background Tasks list.).delimiter semicolon (. The oldest records will be removed when records exceed the specified number. Specifies the maximum number of records to display in the user's Background Tasks list. colon (:).)+ server. By default this property does not appear in the server.permission.properties file and you need add it manually if you want to use it. quotes ("). Specifies the encoding of JReport internal servlets. Specifies the lagging time in seconds after when JReport Server clears up the UID's Background Tasks list after the last user who logged in with the UID logs out.). JReport Server will collect and store report running information to the profiling database.enable false . add this property to the server.ondemandlist.). If the value is set to 0.ondemandlist.get_remote_host false Specifies that JReport Server will automatically record and transmit the IP address of a client who has delivered a request to the engine. server.path <install_root>\font Specifies a font location for server resources. semicolon (. Specifies an algorithm for calculating a principle's permission. jrservlet uses the JVM's encoding. and braces ({}).mail.language server.user_max_records 100 server.http.server. Specifies a delimiter to separate values when a parameter of a report contains multiple values.properties file. You can then view profiling report from JReport Server Monitor. Valid delimiters include blank space ( . server. If the profiling system is enabled. To use a delimiter that is different from the default. Specifies whether to invalidate the session when the user logs out. and then set a value to it. In JReport cluster environment this property will be saved in the server's system database and is not created in the server. When the property is set to true.cleanup_user_folder true Specifies whether to remove a user's My Reports node (/ USERFOLDERPATH/UserID) from the server resource tree when the user is deleted from the security system. server. Specifies the RMI IP address or host name of the local server.realm. this property does not appear in the server.enable_linked_catalog false server. server. Specifies whether the JReport Server can be administered from a remote client via RMI APIs.auth file by specifying a path of it. In order to enable the server. The specified realm should exist. Specifies whether the JReport Server is monitorable by a JReport Server Monitor. properties file.properties file. it enables to pre-define a linked catalog in the server level for the My Reports and Public Reports folders to inherit. Specifies whether to enable the remote method invocation server. otherwise the server will use an existing realm as active realm.host server. add this property to the server.restore. properties file to locate the rmi.properties file. C:\JReport\Server\bin \rmi.rmiadminservice. server.enable localhost IP address 1129 (1 ~ 65535) false server. in the event of the server crashing. the My Reports and the Public Reports folders cannot inherit linked catalog.resource.resource. for example.auth file.task false Specifies to re-run all interrupted tasks upon restarting the server. and set the selected active realm by this property in the server. and then specify a directory as its value.enable true server.auth_file - server.properties file.port server.rmimonitor. If the property is set to false as default.rmiserver. By default.server.properties file to locate the rmi. Specifies the RMI port that the local server uses. This property enables the server.auth.active defaultRealm Specifies the realm that takes effect when the server starts up.rmi. The server will then record a warning message in the log file.rmi.rmi.enable false . group.rmiserver. The value should be an int. responses will be made without any security checking.temp.timeout 1800000 server. The value should be an int. The server will log the client out after timeout.size 50 server. server. The default session timeout is 1800000 seconds. and users and groups are mapped to roles. This property controls the maximum number of temporary files in one folder. When it is set to false.server. server.cache.cache. Specifies the number of group objects that can be stored in the security cache.cache. When JReport Server resides behind a firewall.user.security. Specifies the number of ACL (Access Control List) objects that can be stored in the security cache.authorization false Specifies whether to activate the role based security in replace of the default applied security of setting permissions for users.cache.session. Specifies a timeout limit for when the client cannot send requests to JReport Server. By default this property does not appear in the server.security. If the value is 0.properties file and you need add it manually if you want to use it. which is 500 hours. Specifies whether to enable security checking on remote requests. Specifies the number of user objects that can be stored in the security cache. This does not apply to Remote Configuration and Administration. groups and roles.max_file_per_folder 500 . JReport Server will create sub folders in the <install_root>\temp directory to put temporary files which are for holding bursting data only. The value should be an int. the only way to pass through the firewall in order to obtain the remote objects from the client side is to use an open port while the remote method invocation server is enabled.security true server. permissions are defined on roles only.security.rolebased.size 50 server.size 100 server.fixed_port 0 Specifies a port for exporting server remote objects.security.size 1000 server. Specifies the number of role objects that can be stored in the security cache. an anonymous port will be used. In JReport cluster environment this property will be saved in the server's system database and is not created in the server. In the role based security.role.protection.properties file. The value should be an int. This property allows you to specify a fixed port that you can open in the firewall setting. version.ui. Specifies task duration check frequency in seconds.max_amount_per_subfolder 3000 server.ui. If set to true. a new column named Parameter Contents will be added to the version table.group false Specifies whether to display group permissions in the permission setting UI for the server resource tree node and Version Properties.website /help/tutorial/index.duration. and the Scheduling to Version and Advanced Run dialogs.user false server.retain.version. In JReport cluster environment this property will be saved in the server's system database and is not created in the server.jinfonet.version.help /help/server/en/userguide/index.htm http://www. and the Scheduling to Version and Advanced Run dialogs.htm server.url.role true server. More Info Specifies to retain the parameter file (if there is one) when an archive version is removed from the version table.paramfile false server. Specifies whether to display role permissions in the permission setting UI for the server resource tree node and Version Properties. server.from.subfolder_amount TASK task. By default. Specifies to enable the "Publish to Version System" option when previewing a report result. Specifies the number of the server history folders.url.check_cycle 100 30 .properties file. Specifies whether to display user permissions in the permission setting UI for the server resource tree node and Version Properties.url.set_permission. Specifies to show the parameter contents in the version table. the parameter file will be kept in the history folder. This button is located on the upper-right corner of the JReport Console page and JReport Administration page. and the Scheduling to Version and Advanced Run dialogs. Specifies the help documentation URL the Help button links to. More Info Specifies the maximum amount of subfolders in each subfolder in the history folder.ui.paramcontents false server.set_permission. Specifies JReport Tutorial documentation URL.version.set_permission.com server. Note that the value must be an integer greater than 0. This button is located on the upper-right corner of the JReport Console page.version.server. If set to true.tutorial server. Specifies the website URL the Jinfonet Home button links to. JReport Server checks task duration every 30 seconds.show.temp false server. . the report is opened directly. By default this property is ignored unless server. a File Download dialog will be displayed asking to either open the report or save the report result file after activating a direct running task or submitting an advanced running task as the PostScript format.schedule 5 WEB web. task. task.ondemand 7 Specifies the default priority level for the direct or advanced running tasks.initial. The priority levels are from 1 to 10 in ascending order of lowest priority to highest priority. the Duration tab will be available in the Advanced Run and Schedule dialogs. web. If false. a File Download dialog will be displayed asking to either open the report or save the report result file after activating a direct running task or submitting an advanced running task as the PDF format. By default this property is ignored unless server.force_ps_download_dialog false If true. Specifies the default priority level for the scheduled running tasks.priority.design_servlet_path web.properties is modified to set queue. This property is available to administrators. Specifies the DHTML servlet mapping path.properties is modified to set queue. the report is opened directly. Specifies the DHTML servlet mapping path for loading reports.enable false Specifies whether to enable setting a time duration for a task and asking JReport Server to cancel the task or to notify you or someone else of the task status via e-mail if the task has not yet finished running when the task duration is up. If true. a File Download dialog will be displayed asking to either open the report or save the report result file after activating a direct running task or submitting an advanced running task as the Excel format. If false.force_excel_download_dialog /webreporting /dhtmljsp /jrdhtml /dhtml false web. If false. the report is opened directly.dhtml_servlet_entry_path web.dhtml_jsp_path web. The priority levels are from 1 to 10 in ascending order of lowest priority to highest priority.force_pdf_download_dialog false If true. Specifies the web design servlet mapping path.dhtml_servlet_path web.initial. If the value is set to true.duration.priority.task. Specifies the mapping path of the DHTML JSP files.policy not equal to 0. This property is available to administrators.policy not equal to 0. page. and can browse the server machine's file system by folder selector. Specifies a valid folder path in which folders can be browsed through a JSP folder selector when admin users publish resources locally from a client machine.force_rtf_download_dialog false If true. JReport Server requires a new realm name.login. If false.web. the report is opened directly. a File Download dialog will be displayed asking to either open the report or save the report result file after activating a direct running task or submitting an advanced running task as the Text format. web.monitor. Web browser remembers user name and password automatically.help_servlet_path web.option. the whole file system can be browsed.option. only admin users are able to publish resources locally from a client machine. which allows you to log in without having to input user name and password. Specifies whether to support encoding in Advanced Run mode.jreport_servlet_path web. The link is an entry to JReport Server Monitor UI in JReport Server.option. Specifies the JReport servlet mapping path. Specifies to enable and display the Monitor link on the system toolbar of the JReport Administration page.page. If false.page.force_text_download_dialog false If true. When this property is set to true. Specifies whether to display the Enable Converting Encoding option in the Advanced Run and Schedule dialogs. the report is opened directly. Specifies whether to display the report's DB setting options in the Advanced Run and Schedule dialogs. If the value is null.link.enable /jrserver true web.page. In the server publishing mechanism.use_new_realm_name /help false Specifies the DHTML help servlet mapping path. a File Download dialog will be displayed asking to either open the report or save the report result file after activating a direct running task or submitting an advanced running task as the XML format. web.convert. web.db true web. a File Download dialog will be displayed asking to either open the report or save the report result file after activating a direct running task or submitting an advanced running task as the RTF format. web.force_xml_download_dialog false If true.encoding web. then the user name and password that web browser remembers cannot log in. the report is opened directly.option.rootdir_of_folder_selector true - . If false.ie.encoding true web. Specifies to support exporting to "DHTML" in Advanced Run mode.option.to_ps web.page. There is a folder named "skin" in <install_root>\public_html. Specifies whether the URLs contained in the HTML contents returned by JReport Server uses relative paths.option. web.tasklistener web.page.to_xml web. Specifies to support exporting to "Applet" in Advanced Run mode.page. Any running report (submitted using the Run or Advanced Run command) will be considered as a large report and put into the Background Tasks list after the time limit.skin.option. Specifies to support exporting to "Text" in Advanced Run mode.option.page.option. Specifies to support exporting to "HTML" in Advanced Run mode.option.timeouts.page.cachecat and performance.page. it will avoid problems caused by you having a proxy server between JReport Server and their clients.stylegroup true web. In integration environment.web.option. Specifies to support task listener.page.to_html web.report_wait 170 web. When the value of this property is set to true.mark_unviewed true performance.to_text web.to_dhtml web.option. Specifies to show the file name extensions of the catalog and report files.to_excel web.to_pdf web. Specifies the try-view time limit (in seconds). after deploying jreport. Specifies whether to mark the unviewed version results in bold. war to an application server this value will be changed to /jreport/skin automatically.page.page.option. Specifies to support exporting to "PDF" in Advanced Run mode.page. this folder is relative with context path. Specifies to support exporting to "Excel" in Advanced Run mode.page.dir /skin web.version.show_name_with_postfix true web. It contains all files concerning DHTML skin.option.cacherpt .page.option. Specifies to support exporting to "PostScript" in Advanced Run mode. Specifies to display the Enable Style Group option in the Advanced Run and Schedule dialogs.show_catalog false Specifies to display catalogs on the JReport Console page (port 8888 by default).page. Specifies to support exporting to "XML" in Advanced Run mode.use_relative_app_url true true true web. Specifies to support exporting to "Rich Text Format" in Advanced Run mode.to_applet web.option.option.option.to_rtf true true true true true true true true web. for example.page. while the rest of the report continues to be processed.interval When the value of the performance. Schedule list or Completed list in the specified interval. It is meaningful to set this property if your license permits a large number of concurrent reports and you want a smaller maximum number of concurrent reports.thread property is set to True. Schedule list and Completed list immediately.commit. JReport Server will commit every change in the Version list.thread and performance.commit. Additional report requests will be placed into a waiting queue. By doing this. upon deleting a scheduled task in the Schedule list. JReport Server will only commit changes in the Version list.rptpoolsize Each cached report uses some heap memory. it is also displayed with dirty data.html. JReport Server will commit the action and refresh the Schedule list.commit. while the other reports wait in the queue until one of the four has finished.thread property is false. it will be up to 20 reports that can be running concurrently. an . JReport Server enables you to cache reports and catalogs in memory.max. thereby improving performance. When data in a chart spans across one page.pipeline To speed up report delivery. The performance.The process for viewing reports is a combination of both loading reports from disk and generating report files. so that you do not have to load them from disk.max. you can avoid frequently overwriting any related files in JReport Server. performance. which means that the maximum number of concurrent reports depends on the license you have purchased. you can set performance. performance. For example. By default the property value is 0. It is obvious that skipping either one of these two steps will shorten the elapsed time. If this value is set to True. For example. Note: Data such as Total Page Number displayed in one page is temporary.reports This property allows you to customize the maximum number of concurrent reports.commit. including background run reports and scheduled reports. performance. if you have a 20-report license.commit. thereby improving performance. Typically the JReport license allows an unlimited number of concurrent reports which can cause too many reports to complete for system resources at the same time. and is called dirty data.reports = 4. If the heap memory is used up. The JReport Engine outputs the content of the result in an HTML file to the web browser as soon as a single page has finished processing. For example. performance. To achieve better performance. Setting the property to a suitable value in accordance with your computer's usage will lead to marked improvement in performance. so that only four reports run at the same time. The valid value range is between 0 and the maximum number of concurrent reports permitted by the license. JReport Server delivers a single page of content at a time. the running speed may be comparatively slow. if you have an unlimited license and you don't use queue control.interval property takes effect only when the performance. Dirty data is refreshed when the JReport Engine finishes processing. q The user permission replacement algorithm The user permission replacement algorithm is applied if server. if the administrator did set permissions for the principle. JReport Server creates 100 folders in the history folder (<reporthome>\history). named 101 to 200. This property functions the same as the Enable "Publish to Versioning System" for Background Tasks View option in the Configuration > Advanced panel of the JReport Administration page.permission. In this algorithm. -ms10m -mx512m means that the initial heap size is 10M and the maximum heap size is 512M. If the administrator did not set permissions or set no permission for the principle. Click the link to publish the result to version in the current format.temp Specifies to enable the Publish to Versioning System option when previewing a report. and each of these folders can further contain 3000 subfolders (also set by this property). then folder 4. in folder 1.version. server. When all 100 folders have been filled up with subfolders. When folder 2 is filled up. In this algorithm. a principal's permission is the sum of permissions assigned by the administrator and those inherited from its permission inherit tree.from.algorithm Specifies an algorithm for calculating a role. until all 100 folders have all been filled up. When the amount of subfolders in folder 1 has reached the maximum subfolder amount.permission.max_amount_per_subfolder Specifies the maximum amount of subfolders in each subfolder in the history folder. the principle's permission will be those set by the administrator.OutOfMemoryException will be thrown.version. and so on. You can refer to Java Virtual Machine documentation for more information. Two algorithms are supported: q The permission accumulation algorithm The permission accumulation algorithm is applied if server. For example. By default. server. folder 5. such as archive versions and parameter files. and continue storing the history information in these folders. Flag -ms/-Xms specifies the initial heap size and flag -mx/-Xmx specifies the maximum heap size. and so on.algorithm=1. a link Publish to Versioning System will be added to the upper-left corner of the report preview page (preview a report result using the Run command). . However. If the value is set to true. However. First. then a fourth 100 folders. folder 3 will be used. user or group's permission.algorithm=0. these subfolders cannot hold any further subfolders. JReport Server puts the history information. a fifth 100 folders. it starts to put files in folder 2.permission. if the administrator didn't set permissions for the principle. starting with folder 101. the principle's permission will be those inherited from its permission inherit tree. JReport Server will create another 100 folders. the principle's permissions will be those inherited from the permission inherit tree. server. another 100 folders will be created. When the second 100 folders are full. . Specifies whether to display the Number column in the version table of a catalog. and the detailed information about these properties. Specifies whether to display the Report Tabs column on the My Tasks > Running page. Specifies whether to display the Error Message column on the My Tasks > Completed page. Specifies whether to display the Start Time column on the My Tasks > Running page.Appendix 2: Preference properties This appendix provides a list of properties in the preference. Specifies whether to display the Result column on the My Tasks > Background Tasks page. Specifies whether to display the Task Type column on the My Tasks > Running page. Properties in preference. Specifies whether to display the Parameters column on the My Tasks > Running page. Specifies whether to display the Parameter File column on the My Tasks > Running page. which are created in <install_root>\realm\defaultRealm once the JReport Server and DHTML preferences are configured and saved in the Profile dialog on the JReport Administration page. Specifies whether to display the Requester column on the My Tasks > Running page. . Specifies whether to display the Engine Status column on the My Tasks > Completed page.properties files. Specifies whether to display the Completed Time column on the My Tasks > Completed page. Specifies whether to display the Report column on the My Tasks > Running page.properties and DHTMLpreference.properties Property Name active_catalog active_engine_status active_launch_type active_parameters active_parameters_values active_report active_reports active_started_time active_submitter active_task_id active_task_name active_task_type background_format background_status cat_version_number completed_catalog completed_completed_time completed_engine_status completed_error_message Default Value false false false false true true false true false false true true true true true false true false false Description Specifies whether to display the Catalog column on the My Tasks > Running page. Specifies whether to display the Engine Status column on the My Tasks > Running page. Specifies whether to display the Schedule Name column on the My Tasks > Running page. Specifies whether to display the Launch Type column on the My Tasks > Running page. Specifies whether to display the Catalog column on the My Tasks > Completed page. Specifies whether to display the Task ID column on the My Tasks > Running page. Specifies whether to display the Status column on the My Tasks > Background Tasks page. the server will keep the completed tasks until you delete them from the My Tasks > Completed page. Specifies whether to display the Schedule Name column on the My Tasks > Completed page. Specifies whether to display the Launch Type on the My Tasks > Completed page.PDF 3 .TEXT 4 . Specifies whether to display the Requester column on the My Tasks > Completed page. Specifies whether to display the Results column in the version table of a result.XML 8 .Applet 1 .PostScript 6 . If the property Default Format for Viewing Report of a report tab or a web report has been set to a specific format when the report is designed in JReport Designer. Specifies whether to enable customizing the environment language for JReport Server. If the value is set to 0. Specifies whether to display the Parameter File on the My Tasks > Completed page. Specifies whether to display the Parameters on the My Tasks > Completed page.Excel 5 . Specifies whether to display the Task Type column on the My Tasks > Completed page.DHTML q q q q q q q q doc_version_creator doc_version_number doc_version_output doc_version_parameters enable_setting_display_language true true true true false Specifies whether to display the Creator column in the version table of a result. Specifies whether to display the Result Files on the My Tasks > Completed page. Specifies whether to display the Parameters column in the version table of a result.HTML 2 . Specifies whether to display the Report Tabs column on the My Tasks > Completed page.Rich Text Format 7 . the value in Designer has higher priority than the one here. Specifies whether to display the Version Number column in the version table of a result.completed_is_successful completed_launch_type completed_parameter_file completed_parameters completed_report completed_reports completed_result_files completed_submitter completed_task_id completed_task_name completed_task_type days_definition_for_completed true false false false true false false false false true true 0 Specifies whether to display the Is Successful column on the My Tasks > Completed page. q default_view_format 8 0 . Specifies for how many days JReport Server will keep the completed tasks in the Completed table. Specifies whether to display the Report column on the My Tasks > Completed page. Specifies the default format for viewing reports. Specifies whether to display the Task ID column on the My Tasks > Completed page. . Auto select 1 . which is the resolution of your monitor.GIF 2 . Specifies the delimiter to separate fields in Text format results.Java Plug-In 1.dhtml_resolution false 20 96 Specifies whether to apply flow layout in RTF format results. Specifies the percentage to compress images in the PDF format result by.JavaScript format 1 . Specifies whether a task can be performed on a manually specified clustered server when scheduling a report or running a report in Advanced mode.drilldown_pdf false jrs. The default value is obtained from the operation system. Specifies the Java runtime environment to run applets.Java Plug-In 1.applet_type false 3 Specifies whether to reset all users' default language to the one specified via locale_nls. This property is applied to local publishment only.enable_to_prefer_server true true jrs. q jrs. 72 DPI on Unix or 96 on Windows.3 for Windows q jrs. Specifies the image chart type.format_chart false 0 If this property is set to true.is_multi_files is set to true. q 0 .embedded_css false jrs. enable_save_used_parameter_values jrs.excel2000 is set to true.JPEG 3 .excel_advanced jrs. Specifies the layout of Excel format results.The original layout of the report is adopted.compress_image_pdf jrs.2 for Windows 3 . Specifies whether to show additional settings for exporting to Excel. Only available in clustered environments. the .css file will be generated individually. q 0 .drilldown false jrs. that is the report result is generated to multiple HTML files. the layout will be in columned format.best_editing_rtp jrs.delimiter jrs.excel2000 jrs. The Drilldown feature enables you to inspect certain items for further detailed data. This property takes effect only when jrs. otherwise. q 2 . for example.folder_selector_format 2 Specifies the type of the tool used for selecting folder paths from the file system. . Specifies whether to generate HTML format report results with the Drilldown feature enabled.PNG q q q jrs.If the Columned property of the report tab is set to true in JReport Designer.excel_layout false true true .VBScript format 2 . This property takes effect only when jrs. only the report data will be exported without format in Excel format results.frameapplet true Specifies whether to show an Applet window when exporting to Applet. in DPI. When jrs. Specifies whether to generate PDF format report results with the Drilldown feature enabled. q jrs. false .JSP format q q is_forced_language jrs. is_applet_chart is set to false. this property is of no use. Specifies whether to embed the cascading style sheet (CSS) in the exported HTML files. Specifies the resolution of the DHTML result to zoom in/out. Specifies whether to enable saving parameter values for reuse next time when specifying parameter values in order to run reports. The Drilldown feature enables you to inspect certain items for further detailed data. You can set higher/lower value to zoom in/out. Enables the Word Wrap property for all objects. 2 . You can set higher/lower value to zoom in/out. for example.is_multi_files false Specifies whether to generate report result to multiple HTML files.is_csv jrs.Generates the report result to a single HTML file.has_page_number true jrs.Generates the report result to multiple HTML files. which is the resolution of your monitor. Values: q jrs.Disables the Word Wrap property for all objects. q jrs.is_multi_files is set to false.is_tab .delimiter .is_csv . q q .is_only_data jrs. That is. false .Uses a Java applet to display charts.has_pdf_permis_pasw jrs.is_multi_files is set to false. that is the report result is generated to a single HTML file.has_hyperlink true Specifies whether to remove hyperlinks from the exported HTML format results. You need to set the delimiter via jrs. Specifies whether to include drawing objects in exported Excel results.is_quotemark jrs. q q jrs. including Report Header/Footer.User defined delimiter.Delimited format q jrs.Charts will be displayed as images. false . Specifies the way of displaying charts in the HTML format result: q jrs. the Text results will only contain data in Detail panel.Normal Text format false .delimiter.is_text_delimiter jrs. This property takes effect only when jrs.is_wordwrap 0 Specifies the way of dealing with word wrap in Excel format results. 1 .Tab delimiter jrs.is_norm_txt true Specifies whether the results are in normal Text format: q true .Keeps all the settings of each object's Word Wrap property originally specified in the report. and box. q jrs. oval.hasHeadFoot false false true jrs. The default value is obtained from the operation system. q true .is_norm_txt is set to false. such as line.CSV format jrs. the Word Wrap property is made true for all objects. the Word Wrap property is made false for all objects. Page Header/Footer and Group Header/Footer. Specifies whether to use a permission password to restrict users from printing and editing PDF format results.is_norm_txt is set to false. This property takes effect only when jrs.is_applet_chart true true .is_repeat false true false Specifies whether to include report data in XML format results. Specifies whether to use value of the previous cell in the same column when a cell in Text format results has no value. This property takes effect only when jrs. If false. that is the report result is generated to a single HTML file.jrs.has_shapes jrs. Specifies the delimiter type to separate fields in Text format results. Specifies whether to contain all headers and footers in Text format results. This property takes effect only when jrs.html_resolution 96 jrs.is_norm_txt is set to false. Specifies whether to remove page numbers from the exported HTML format results. Specifies whether to use quote marks in Text format results. in DPI. 72 DPI on Unix or 96 on Windows. That is. Specifies the resolution of the HTML result to zoom in/out. q 0 . This property takes effect only when jrs. pdf_contact_inf jrs. Specifies whether to remove margins from PDF format results.pdf_compatibitly false 1 0 .pdf_digital_path jrs. Specifies the password to help restrict users from printing and editing PDF format results. q jrs. q jrs.Filling in form fields and signing 3 . Specifies whether to remove margins from RTF format results. You cannot use the same password as jrs. which uses a low encryption level (40-bit RC4).pdf_check_enablecopy jrs.0 and later. Specifies the encryption type to encrypt PDF format results. Specifies the reason for signing PDF format results.0 and later. deleting. pdf_compatibitly=1.Acrobat 5.pdf_edit_yourself jrs. and rotating pages 2 . q 0 . This property is available only when jrs.no_margin_html jrs.Inserting.pdf_check_enableaccess true Specifies whether to allow visually impaired users to read PDF format results with screen readers.pdf_document_reson None Specifies your contact information for signing PDF format results.None 1 .pdf_location jrs. Specifies the digital ID file from a specified directory for PDF format results.password_pdf jrs.no_margin_ps jrs.no_margin_pdf jrs.jrs.Acrobat 3.Any except extracting pages q q q q jrs. Specifies whether to remove margins from PostScript format results. Specifies the password to help prevent users from opening PDF format results without authorization. which uses a high encryption level (128bit RC4). 1 .Commenting filling in form fields.pdf_encrypt jrs. Specifies the editing actions that are permitted in PDF format results. password_pdf. and signing 4 .no_margin_rtf jrs. . Specifies whether to allow users to select and copy the contents of PDF format results. The value can be one of the following: q None I am the author of this document I have reviewed this document I am approving this document I attest to the accuracy and integrity of this document I agree to the terms defined by the placement of my signature on this document I agree to 'specified' portions of this document q q q q q q jrs. Specifies your location for signing PDF format results.pdf_changallow false false false false 4 Specifies whether to remove margins from HTML format results.pdf_permis_pasw false - Specifies your reason for signing PDF format results. Specifies whether to encrypt PDF format results. text_overflow 1 Specifies whether the text overflow is visible or hidden in HTML format results. and cannot be adjusted according to the font size settings in the web browser. JReport will take the result of the whole report as a dataset to transform the report by sequence and to generate the report result in PDF format.Using an absolute font size. q false . q jrs.udchar_height - Specifies the value for each unit of the vertical density between columns in Text format results.VISIBLE 1 . The default value -1 means that no value is set.Windows Certificate Security 1 .pdf_printallow 2 Specifies the printing quality for PDF format results.relative_font_size false Specifies whether to generate the HTML format report result using a relative font size or an absolute font size. q true .Use Unix End-of-line characters. Specifies whether to include gridlines in Excel format results. q 0 . The resulting density is a direct ratio of the value you specify.Default Certificate Security 2 . q jrs.When you run a report in PDF format. q 0 .toc_pdf jrs. there will be no clearance between the columns. Specifies whether to use Windows end-of-line characters to indicate the start of a new line in Text format results. q 0 .print_mode_pdf false false Specifies the password for the digital ID file specified via jrs.Use Windows end-of-line characters.pdf_sign jrs.VeriSign Digital Signatures q q jrs.txt_compress jrs.print_gridlines jrs. pdf_digital_path. Specifies the digital signing method for PDF format results.jrs.Using a relative font size. Specifies whether to generate Text format results in a compressed size. Only the Unix End-of-line character <lf> will be used. JReport will take the result of the whole report as a graphic to transform the report by the method of simulated printer and generate the report result in PDF format. q true .HIDDEN q jrs. Specifies the page footer text for Excel format results.print_footer jrs.pdf_user_pasw jrs.None 1 .High Resolution q q jrs.Low Resolution (150 dpi) 2 . that is to say. true . the greater the value.print_header jrs. Specifies the page header text for Excel format results.When you run a report in PDF format. false .txt_windows false false true Specifies whether to generate the PDF format report result with a Table of Contents. The font size can be adjusted according to the font size settings in the web browser. . q jrs. false . By default the density will be specified by JReport.pdf_sign_method false -1 Specifies whether to add digital sign to PDF format results. That is. Two characters <cr> and <lf> will be used at the end of a line. which means that the font size is fixed. the smaller the height between columns. udchar_width - Specifies the value for each unit of the horizontal density between columns in Text format results.Firefox q jrs.properties file in <install_root>\bin after JReport Server shuts down. Specifies whether to display the last logout time of a user on the top banner of JReport Server. reports are displayed in the HTML format with accessibility attributes.user_last_logout_time false jrs.jrs. Specifies whether to display the Cancelled column on the My Tasks > Background Tasks page. you can save the specified parameter values for the report as a list. Specifies whether to display the Start Time column on the My Tasks > Background Tasks page.IE or Chrome 1 . Specifies whether the table and crosstab components will be output as table objects in the HTML format result. Specifies whether to display the Report Version Number column on the My Tasks > Background Tasks page. Specifies whether to set the accessible version of JReport Server as the default portal instead of JReport Console page. In the accessible version. Specifies whether to display only the CSS styles in the style list. the logout time will be recorded in the logout. the smaller the width between columns.web_browser 0 0 . Specifies the web browser for which the HTML result adapts. Specifies the environment language for JReport Server. Specifies whether to display the last login time of a user on the top banner of JReport Server.use_html_table jrs. If true. Specifies whether to display the Catalog Version Number column on the My Tasks > Background Tasks page. That is. Specifies whether the accessibility attributes defined for report elements via the Report Inspector will be exported to the HTML format report result. Specifies whether to display the Catalog column on the My Tasks > Background Tasks page. This property is used to control the maximum number of the saved parameter value lists for the report.zip_result locale_nls max_autocomplete_list_num false false en_US 3 Specifies whether to compress Applet format results and make the size smaller. If true. q jrs.use_section508_compliant_page false false jrs. the login time will be recorded in the login. With the help of reader agent end users can navigate through the server resource to view the target report. Specifies whether to display the Elapse Time column on the My Tasks > Background Tasks page. The resulting density is a direct ratio of the value you specify. the greater the value. All UI text and messages will be displayed in the specified language. and table/crosstab components are output as HTML data table. When specifying parameter values in order to run or schedule to run a report. ondemands_cancelled ondemands_catalog ondemands_catalog_version ondemands_parameter ondemands_report_version ondemands_started_time ondemands_time ondemands_time_elapse only_css_style false false false false false true true false true .use_section508_output false jrs.properties file in <install_root>\bin after JReport Server shuts down. Specifies whether to display the Parameters column on the My Tasks > Background Tasks page. By default the density will be specified by JReport.zip_applet_result jrs.user_last_login_time true jrs. Specifies whether to compress JReport Result format results and make the size smaller. See Accessibility for more information. Specifies whether to display the Finish Time column on the My Tasks > Background Tasks page. The value can be standard.Icons 1 . or xp (xp means Windows XP). The value can be Top. Specifies skin style of waiting pages. . Specifies whether to display the Report Tabs column on the My Tasks > Scheduled page. Specifies whether to display the Task Type column on the My Tasks > Scheduled page. Specifies whether to display the Next Run Time column on the My Tasks > Scheduled page.Thumbnails q q parameters_display_size popup_dhtml_window reports_description reports_last_modified reports_type rpt_version_number scheduled_catalog scheduled_is_enable scheduled_is_successful scheduled_last_run_at scheduled_launch_type scheduled_next_run_at scheduled_report scheduled_reports scheduled_submitter scheduled_task_id scheduled_task_name scheduled_task_type skin_enable_loading_statue skin_enable_waitting_page skin_format skin_statue_align skin_style skin_tip_font_family skin_tip_font_isblod skin_tip_font_isitalic skin_tip_font_isunderline 100 true true true true true false true false false false true true false false false true true true true standard Bottom Default Tahoma true false false Specifies the display length in characters of the parameters that are to be applied to both the completed and active schedules. or Right.Details 2 . Specifies whether to display the Version Number column in the version table of a report. Customize. Specifies font face of tip text in the waiting pages. Specifies whether to display the Requester column on the My Tasks > Scheduled page. Specifies whether to display the Type column on the Reports page. Specifies whether tip text font is bold in the waiting pages. Specifies whether to upload a local image to Server as the loading status image appearing in waiting pages. Specifies whether to display the Description column on the Reports page. Specifies whether tip text font is underline in the waiting pages. Specifies whether to display the Launch Type column on the My Tasks > Scheduled page. Specifies whether tip text font is italic in the waiting pages. Specifies whether to show a DHTML window when you view a report in DHTML format.page_style 1 Specifies the View Mode on the Reports page: q 0 . Specifies whether to display the Task ID column on the My Tasks > Scheduled page. Specifies whether to display the Last Modified column on the Reports page. Specifies whether to display the Report column on the My Tasks > Scheduled page. Specifies whether to display the Catalog column on the My Tasks > Scheduled page. Specifies whether to display the Schedule Name column on the My Tasks > Scheduled page. Specifies whether to show waiting pages and customize them. Bottom. Specifies the relative position of the image as compared to tip text in waiting pages. or Appointment. Specifies the skin format applied to JReport Server and JReport Viewer UI. classical. Specifies whether to display the Last Run Time column on the My Tasks > Scheduled page. The value can be Default. Specifies whether to display the Is Successful column on the My Tasks > Scheduled page. Specifies whether to display the Is Enabled column on the My Tasks > Scheduled page. Left. the DHTML report will automatically be switched to run in background mode. Specifies whether to display the Result column in the version table of a report. timeout. Specifies whether to display the Parameters in the version table of a report. including the following: q Advanced users can use a formula to control the value of a property. In JReport Viewer. Editing group and report properties (can be accessed by using the Group and Report command on the shortcut menu). special fields.skin_tip_font_size skin_waitting_page skin_waitting_statue version_creator version_number version_output version_parameters 11 waiting. such as editing group and report properties from the shortcut menu.jsp loadingxp. in JReport Viewer.autorefresh false false Specifies whether to make summaries aligned vertically.close. which are created via the report wizard and have the same summary function.mode. which are created in JReport Designer. Properties in DHTMLpreference. it will be displayed as a checkbox.createreport_prompt true . convertquery_prompt true dhtml. with mixed value.gif true true true true Specifies font size of tip text in the waiting pages.task. Specifies whether to prompt the Query Filter dialog when inserting the first field from the Resource View panel into a blank component. timeout 900 true true 180 dhtml. This property specifies the time (in seconds) after which the report will be closed if end user chooses this way to close a DHTML report. Specifies whether to enable the Auto Refresh feature. Specifies whether to display the Creator column in the version table of a report. After the specifies time expires. some features are only available for advanced users. and parameters (can be accessed by using the Properties command on the shortcut menu).bcfilter_prompt dhtml.mode. Specifies whether to display the Version Number column in the version table of a report. in seconds.report.advanceuser Default Value false Description Specifies whether to enable the DHTML advanced features. so as to make the server session never time out when any JReport Viewer window is open. Specifies the JSP file name which will be used after the JSP file is uploaded to server. Specifies whether to move DHTML reports to run in background mode automatically after a specified time period.align_summaries dhtml.background. Modifying the properties of images. q q q dhtml. such as the options in the Export and Other tabs. Specifies whether to prompt the Convert Data Fields dialog when performing data analytic actions on reports. The auto refresh time interval equals user session time out minus 16 seconds.background. timeout dhtml. Specifies whether to prompt with a message box when JReport is going to adjust the page size if the width of a table exceeds the defined page size. This means that this option is currently controlled by a formula. dhtml. the report will not be closed immediately. If a Boolean type property in a report is set to be controlled by a formula. which automatically refreshes the DHTML window at certain intervals. It's recommended to set the value to no less than 30 seconds.properties Property Name dhtml. Further options are available for advanced users.edit dhtml. Specifies the time allowed for a DHTML report to run in foreground mode. When end user clicks the close button of the web browser to close a DHTML report. Specifies an image file name which will be used after the image is uploaded to server. or the detailed information created from the go-to-detail function.default dhtml. a URL. the editing mark will not be shown when a report object receives focus. If it is set to false. Specifies size of the grids. Specifies the maximum number of records that will be retrieved by components in the report.customize_indent false Specifies whether to allow customizing the indent of groups created via the report wizard. Specifies whether to show the Resource View panel. default dhtml.07 false 10800 true true dhtml. end users can go back to the master report by clicking the master report name link. Specifies whether to show the Bottom N item on the Filter submenu.grid_color dhtml.report.report.mwttp. filter_menu_bottomn dhtml.report. Specifies whether to show editing marks (dashed outlines for objects and report body). When creating skins. Specifies the indent of the groups created via the report wizard.grid_inches_size dhtml.popup. and the corresponding images in <intall_root> \public_html\images\dhtml\xxx. in inches. this property will decide where the corresponding link targets will be displayed. in seconds.default 0 false #808080 0. and report objects cannot be moved or resized. You can also create your own skin and apply it to your DTHML user interface.report.master. Specifies whether to show the Top N item on the Filter submenu. The style files should be saved in <intall_root>\public_html\style\dhtml\xxx (xxx is the name of the skin). Specifies whether to show the master report in the same window when opening a detail report. default true true false dhtml. action dhtml.edit dhtml.properties in <intall_root>\public_html\skin. a detail report. when end users create groups in a report via the report wizard in JReport Viewer.currentprofile dhtml. in inches.popup. Specifies whether to allow using the mouse wheel to scroll up/down reports. filter_menu_more dhtml. filter_menu_all dhtml.dhtml. JReport provides you with three sets of skins: classical.max_reports -1 true true true true 60 . Specifies whether to display a new web browser window for the link target. style files and image files. By default. pay attention to the following: q A skin must have a name and it is defined in the file skin. and xp. the groups will be indented according to the width of the group fields. Specifies the idle time before the DHTML window is locked.locktimeout dhtml.default false dhtml. a chart hyperlink. When it is set to false.do. Specifies whehter to use another thread to perform an action instead of the request thread.default dhtml. When defining such links in JReport Designer.default dhtml. Specifies whether to make the DHTML window locked after specified time period. Specifies whether to show the Remove Filter item on the Filter submenu.multi. Specifies the maximum number of DHTML reports that can be opened at the same time.currentskin standard Specifies the profile which will be used as the default profile to run reports in DHTML. Specifies the skin of the DHTML user interface.locktimeout. Specifies whether to show the More item on the Filter submenu. q dhtml. which can be a link report.detail. the master report will be closed after the detail report is opened.recordnumber. Specifies the color of the grids. customize_indent_size dhtml.dso. if you have specified Server Setting as the target frame of the links. Specifies whether to show a shortcut menu when you click the right mouse button.link.privew.thread. filter_menu_topn dhtml.report.is. If true. dhtml. standard. A skin includes two parts. save. Specifies whether to make a DHTML report release its memory automatically if JReport Server has not received a request from the report for a period of time. Specifies whether to check the Save Filter Criteria option by default when saving a report to a report version or as a new report. The displayed pages are complete. tab dhtml.show_grids dhtml. Specifies whether to make a DHTML report release its memory automatically if JReport Server has not received a request from the report for a period of time. crosstab. in seconds. Specifies the time after which a DHTML report will release its memory automatically if JReport Server has not received a request from the report. Specifies whether to show grids in JReport Viewer report area. If it is set to false. catalog_linked_mode true default default .reports. all data will be fetched before report pages are formatted. q dhtml.pipe_line false Specifies the way of running and laying out a report as the DHTML format.reportset.on_demand false true Specifies whether to limit the number of DHTML reports that can be opened at the same time. in seconds. This shows the total number of pages but will take longer to show the first page.timeout blank 10800 dhtml.report. q dhtml.showSpalshScreen dhtml. dhtml. and banded object. Specifies whether or not to snap an object to grids when moving it by dragging and dropping in JReport Viewer report area. dhtml.save.It means to copy the catalog to the target directory where the report is saved. Specifies whether to pop up the save criteria dialog after performing some filter/sort action on a report in JReport Viewer and closing the report. chart. Specifies the default report layout when creating a report in JReport Viewer.timeout.It means to link the saved report with the catalog. dhtml. Can be blank.edit true dhtml. Specifies the default selected style for the four types of components when creating them via the report wizard in JReport Viewer: table.save.report.title false Specifies whether to switch among report tabs in a report.reportset.sort. all report pages will be formatted. edit dhtml. copy .save.stylegroup true true true true false onlyFirstTime true Commercial<CSS> Specifies whether to enable setting the linked catalog model when saving report into a new directory in DHTML. If the property is set to true.report. The first page will be displayed more quickly.reportlayout dhtml. Specifies whether to show the splash screen.popup. The contents of the displayed pages may be incomplete for lack of data integrity and will then be refreshed when their data is ready. edit dhtml.switch. catalog_linked_mode_edit dhtml. data will be fetched for the required page and then the page will be formatted. table.filter.with.criteria dthml. If the property is set to true.save. If it is set to false.snap_to_grids dhtml. The value can be any of the CSS style in the <install_root>\style directory. which is the JReport logo and displays when a DHTML report is opened. Specifies the way of running and laying out a report as the DHTML format.dhtml. the required pages will be formatted. The total number of pages will not be known and will show as a + sign. crosstab.criteria dhtml. Powered by JReport Specifies the title for the DHTML window (displayed on the DHTML window title bar).criteria dhtml. Specifies the linked catalog model when saving report into a new directory in DHTML.max_reports.timeout 10800 Specifies the time after which a DHTML report will release its memory automatically if JReport Server has not received a request from the report. . chart and section. Specifies whether to check the Save Sort Criteria option by default when saving a report to a report version or as a new report.report.report.timeout. and report.groupbyname dhtml." to separate the toolbars.toc.info.toolbar.default false 100 . Specifies whether to show the tool tips for toolbar commands.default dhtml. Use "|" to separate the commands and ". Specifies whether to show the groups by name in the TOC panel. Specifies the commands and the sequence of the commands that will be displayed on the toolbars defined by dhtml. dhtml. go to the Options dialog.toc.tooltips dhtml. This property is deprecated. Specifies whether to show the User Information bar.toolbox. Specifies the zoom ratio at which DHTML pages will be displayed. Specifies whether to place the group headers in a table vertically when creating a new table or inserting new groups to a table in JReport Viewer.info dhtml. Specifies whether to show a default toolbar in the DHTML window.default dhtml. This bar is on the top of the JReport Viewer window which shows information about the user.toolbar.items false false true Standard|View| Analysis| 16|17|18|19|20|22| 0|7|8| 43|0|.toolbar.userbar.default Specifies whether to show the Toolbox panel. false true false Specifies whether to show the TOC Browser.zoom. catalog.0|11|13|0| 25|24| 9|1|0|.0|28|29|0| 23|0|.default dhtml. If you are not clear about the toolbar commands.dhtml. To create toolbars. dhtml. go to the Options dialog to set them. Specifies the toolbars that will be displayed in the DHTML window. vertical_group_header dhtml. Use "|" to separate the toolbars.toolbar. This property takes effect when server. The value should be between 4 MB and 1024*1024 MB.autocache.disk. Specifies the class name of user's load balancer.valid_time cluster. The property value should be an integer in seconds.check_interval cluster. 1 . The property value should be an integer.lease.enabled server.realm. Specifies the active lease number in a cluster. The property value should be a positive integer.max.autocache.copy_number 2 cluster.scheduler. Specifies how many copies will be made in a cluster when a new file or folder is added to the realm folder.enabled=true and server. server.enabled=true.Appendix 3: System database properties in JReport Server cluster This appendix provides a list of properties stored in the server's system database which is created when a JReport clustered server is started. loadbalance.active_count cluster. This property takes effect when server.enable_notify_server_down false Specifies whether to notify somebody via e-mail when a server in the cluster is down.crd_result. q Default Value (Range) Description cluster.never. The property value should be an integer. see Managing cached report data.scheduler. it becomes an active scheduler and will compete to trigger the schedule. Specifies the e-mail addresses of the people to whom you want to send a notification e-mail when a server in the cluster is down. Specifies how many memory copies will be shared in a cluster.lease. The property value should be an integer in seconds.storage.scheduler.share_memory. This property takes effect only when the cluster.scheduler. Specifies the time interval the cluster will use to check the number of active leases.expired.storage.lease.enable_notify_server_down property holds a true value. If a distributed scheduler is enabled with lease. 2 . q q q See Built-in load balancing algorithm for details about the four load balancing types.copy_number 300 2 2 cluster. The e-mail address is specified by the cluster. Specifies how many copies will be made in a cluster when a new file or folder is added to the history folder.copy_number 2 LOADBALANCE loadbalance.Uses Least Current Reports Algorithm to allocate tasks.custom_class SERVER server.autocache. 3 .type 1 (0 ~ 3) 0 .autocache. The property value should be an integer. The property value should be an integer.usage 512 . Specifies the maximum hard disk space for automatic cached data.node_number cluster. Specifies the period of time that the clustered server can hold a lease before releasing it. Specifies the period an automatic cached data result is kept.Randomly allocates tasks.time false 0 Specifies whether to enable to automatically cache report data.lease. Specifies the load-balance type.enabled 2 30 false cluster.storage.expire=false.history.notify_server_down_address - cluster.autocache. notify_server_down_address property. Specifies whether to enable lease for a distributed scheduler in the cluster.autocache. For more about cached report data. and the detailed information about these properties.Uses Round Robin Algorithm to allocate tasks.Uses Least Weighted Current Reports Algorithm to allocate tasks. Property Name CLUSTER cluster. Specifies how many copies will be made in a cluster when a new file or folder is added to the cached report data (CRD) result folder. ConfigurationAdvanced.realm. This property functions the same as the Enable "Publish to Versioning System" for Background Tasks View option in the Configuration > Advanced panel of the JReport Administration page. For more about cached report data. all the others can be set on the JReport Administration UI.custom_class and server. bat). "D:\\newjrentserver\\").admin. server.cluster.usage server.from. Specifies to enable the "Publish to Version System" option when previewing a report result.properties LDAPProperties. If the value is set to true.api.server.cfg. This property takes effect when server. // Creates instance of RptServer .server.completed.server. jet. Specifies the maximum memory usage when running a report using cached report data.expire server.crd.enabled=true. This does not apply to Remote Configuration and Administration.never. responses will be made without any security checking.completed. The following demo API code shows you how to set these two properties: import import import import import import jet. see Managing cached report data. When it is set to false. jet.max_count true 3000 (0 ~ 2147483647) 4 Specifies whether automatic cached data never expires. a link Publish to Versioning System will be added to the upper-left corner of the report preview page (preview a report result using the Run command). The specified realm should exist.getProperties(). jet.cluster.autocache.server.ClusterAdminService. The server will then record a warning message in the log file.Member. except for loadbalance.api. The minimum value is 4 MB and can be increased up to 80% of the total Java maximum heap size (-Xmx value in JRServer.properties clusterWeight.server. Set the value to zero if you do not want to limit the record count. Specifies the maximum number of completed records that will be kept the Completed table.server.api.autocache. server. All cached report data being used to run reports will share the same memory space. jet. otherwise the server will use an existing realm as active realm.memory.properties file.LoadBalancer. Click the link to publish the result to version in the current format.active defaultRealm Specifies the realm that takes effect when the server starts up.xml Description Configuration for sending e-mails Configuration for performance weight in a cluster Configuration for LDAP support Mapped Server UI JReport Administration page > Configuration > Export > E-mail JReport Administration page > Cluster > Weight JReport Administration page > Configuration > LDAP > Server Setting properties by using API For the cluster properties that are stored in the server's system database.HttpUtil.HttpRptServer.admin.api.api.api.http.temp false Properties in the following configuration files are also stored in the server's system database when a JReport clustered server is started: File Name mailconfig.security true Specifies whether to enable security checking on remote requests. public class APIDemo { public static void main(String[] args) { // Set report home "d:\\newJREntServer" System.put("reporthome". jet. and set the selected active realm by this property in the server.max_count. server.http.version.server. initEnv(System.setLoadBalanceCustomClass("").getProperties()). System. there need exist APILocalBalancer implements interface LoadBalancer. //load balance class System.out. //get current max completed record count. HttpRptServer httpRptServer = HttpUtil.getAdminService().getConfigService(). //set max completed record count. getConfigurationAdvanced(). // adminService. } } .getHttpRptServer(). int compledRecordCount = configAdvanced.println("load balance class" + adminService.getLoadBalanceCustomClass()). configAdvanced.println(" ========httpRptServer= " + httpRptServer).getClusterAdminService(). ConfigurationAdvanced configAdvanced = httpRptServer.setMaxCompletedRecordCount(50).out.HttpUtil.setLoadBalanceCustomClass("APILocalBalancer"). //set load balance. adminService.getAdminService(). ClusterAdminService adminService = httpRptServer.getMaxCompletedRecordCount(). dashboard.cache.ssl.protocol httpserver.admin.name JReport Administration page > Configuration > Cache > Report Cache Cache Loaded Catalogs Maximum Number of Catalogs to be Cached Cache Loaded Reports Maximum Number of Reports to be Cached Report Buffer Size for Sort Action performance.cache.role.port httpserver.password httpserver.max.cache.enable httpserver.ssl.port httpserver.port httpserver.security.size JReport Administration page > Configuration > Cache > Image Cache Cache Images performance.size server.group.ssl.keystore.user.servlet.ssl.connections httpserver.host. Most of these listed UI options are the administrative configuration options which can be accessed on the JReport Administration page by administrators. A few of them are available on the JReport Console page to end users too.ssl.cacherpt performance.Appendix 4: Mapping list of UI options and properties This appendix provides a list of JReport Server UI options and their corresponding properties of the same functionality in the property files. UI Option Property in server.admin.ssl.size server.realm.dashboard.sort.security.catpoolsize performance.host.ssl.cacheimg .ssl.properties in <install_root> \bin JReport Administration page > Configuration > Service Port Dashboard Port Administration Port Maximum Number of Handlers Maximum Number of Connections Connection Timeout in Enable Secure Socket Layer Connection Secure Port Dashboard Secure Port Secure Administration Port Keystore File Path Keystore Password Keystore Type Keystore Protocol Keystore Algorithm Servlet Properties File Name Active Realm All Network Addresses Network Address At httpserver.ssl.rptpoolsize engine.protection.max.keystore.cache.buffer_size JReport Administration page > Configuration > Cache > Security Cache User Cache Size Role Cache Size Group Cache Size Protection Cache Size server.propfile server.all httpserver.algorithm httpserver.active httpserver.port httpserver.timeout httpserver.handlers httpserver.type httpserver.keystore httpserver.cachecat performance.size server.security.port httpserver.security.port httpserver. compressio JReport Administration page > Configuration > Advanced No Security Check Enable "Publish to Versioning System" for Background Tasks View Keep Connection Alive Enable Multiple Users to Login Using the Same User Name Enable Resources from Real Paths Enable Task Duration Enable Linked Catalog Show Extensions for Known File Types Role Based Authorization Permission Setting UI Displays > User Permission Setting UI Displays > Role Permission Setting UI Displays > Group Permission Algorithm User Session Timeout Time Limit before Moving to Background Status Refresh Interval Temporary Files Life Engine Priority server.enableDynamicResource task.disk.keepalive server.usage server.preloadrptcls performance.autocache.memory.hist.duration.enabled server.max.dir resource.report_wait task.share.version.set_permissions.connection.result.preloadenginecls performance.life engine.temp server.dir server.root resource.resource.timeout web.from.show_name_with_postfix server.preloadcatcls performance.imgpoolsize performance.ui.preloadedrpts performance.preloadedcats performance.option.port cluster.set_permissions.role server.share.All used images Maximum Image Cache Size Show Details performance.autocache.cacheallimg performance.share.enableMultipleLogin server.host server.algorithm server.timeouts.rmi.properties.enable server.group server.rolebased.duration.share.enable_linked_catalog web.ui.crd.security server.rmi.dir resource.authorization server.session.usage .priority JReport Administration page > Cluster > Configuration Cluster Name Properties Directory Realm Directory Resource Root History Directory Temporary Files Directory Server's RMI Host Server's RMI Port Enable Cluster cluster.check_cycle resource.temp.page.name resource.enable JReport Administration page > Cached Data > Cached Report Data > Cache Configuration Maximum Memory Usage Automatic Cache Maximum Disk Usage server.user server.dir resource.showimgdetail JReport Administration page > Configuration > Performance Catalogs to Be Preloaded Preload Catalog Referred Classes Preload Engine Referred Classes Preload Report Referred Classes Reports to Be Preloaded Preload Fonts Compress Swap Files performance.realm.ui.permission.loadfont performance.set_permissions. ondemand JReport Console page > Reports > Schedule > General Priority task.time JReport Console page > Reports > Advanced Run > General Priority task.autocache.expire server.authentication smtp.port mailbox default.properties in <install_root>\bin JReport Administration page > Configuration > Export > Fax Fax Machine/Fax Server Timeout Retries Dialing Modem Class Flow Control Flow Control Command Port Initialization String Fax Gateway Connector Server IP Server Port Login ID Password Fax Sender Special Parameters via_fax_server time_out max_retries dialing modem_class flow_control flow_command port init_string connector server_ip server_port user_id password user_name special_parameters UI Option Property in preference.server.autocache.mail Tag_MaxMailSize Tag_MaxMailPage UI Option Property in faxconfig.server smtp.properties in <install_root>\bin JReport Administration page > Configuration > Export > E-mail SMTP Server Server Requires Authentication SMTP Server Port E-mail Address Default E-mail Format Compress Attachment as Java Archive Maximum Split PDF File Size Maximum Split PDF File Page smtp.initial.never.properties in <install_root> \realm\defaultRealm JReport Administration/Console page > Profile > Customize Server Preferences General .priority.Expires > Never Expires > Custom server.expired.schedule UI Option Property in mailconfig.initial.priority.format compress. user_last_login_time jrs.Default Format for Viewing Report Pop-up DHTML Window Only CSS style can be available in style list Display the Last Login Time Display the Last Logout Time Keep Completed Tasks for Parameter Display Size Folder Selector Type Skin Format Columns Shown in Reports List Type Description Last Modified Columns Shown in Scheduled List Task ID Schedule Name Next Run Time Last Run Time Is Successful Catalog Report Report Tabs Launch Type Task Type Requester Is Enabled Columns Shown in Running List Task ID Schedule Name Start Time Catalog Report Report Tabs Launch Type Task Type Requester Parameter File Parameters Engine Status Columns Shown in Completed List Task ID Schedule Name Completed Time Is Successful Catalog Report default_view_format popup_dhtml_window only_css_style jrs.user_last_logout_time days_definition_for_completed parameters_display_size folder_selector_format skin_format reports_type reports_description reports_last_modified scheduled_task_id scheduled_task_name scheduled_next_run_at scheduled_last_run_at scheduled_is_successful scheduled_catalog scheduled_report scheduled_reports scheduled_launch_type scheduled_task_type scheduled_submitter scheduled_is_enable active_task_id active_task_name active_started_time active_catalog active_report active_reports active_launch_type active_task_type active_submitter active_parameters active_parameters_values active_engine_status completed_task_id completed_task_name completed_completed_time completed_is_successful completed_catalog completed_report . use_html_table jrs.drilldown jrs.has_page_number jrs.has_hyperlink jrs.relative_font_size=false .zip_result jrs.is_multi_files=false jrs.is_multi_files=true jrs.no_margin_html jrs.Report Tabs Launch Type Task Type Requester Parameter File Parameters Engine Status Error Message Result Files Columns Shown in Background Tasks List Catalog Finish Time Elapse Time Start Time Catalog Version Number Report Version Number Parameters Number Report Results Parameters Creator Number Columns Shown in Catalog Versions List Number Columns Shown in Result Versions List Number Results Parameters Creator Export Formats JReport Result Zip Result DHTML Resolution HTML No Margin Multiple Files Embedded CSS Single File No Hyperlink No Page Number Drilldown Section 508 Compliant Output Use HTML Data Table Absolute Font Size completed_reports completed_launch_type completed_task_type completed_submitter completed_parameter_file completed_parameters completed_engine_status completed_error_message completed_result_files ondemands_catalog ondemands_time ondemands_time_elapse ondemands_started_time ondemands_catalog_version ondemands_report_version ondemands_parameter version_number version_output version_parameters version_creator rpt_version_number cat_version_number doc_version_number doc_version_output doc_version_parameters doc_version_creator Columns Shown in Report Result Versions List jrs.dhtml_resolution jrs.embedded_css jrs.use_section508_output jrs. drilldown_pdf jrs.pdf_printallow jrs.pdf_location jrs.excel_advanced=false jrs.pdf_check_enablecopy jrs.pdf_compatibitly jrs.relative_font_size=true jrs.no_margin_pdf jrs.compress_image_pdf jrs.pdf_encrypt jrs.Relative Font Size Use Chart > Applet Chart Use Chart > Image Chart Use Chart > Image Chart drop-down list Resolution Web Browser Text Overflow PDF No Margin Compress Image Generate charts and barcodes using images (recommended) Generate charts and barcodes using vector graphics TOC Drilldown Encrypt Encrypt > Compatibility Encrypt > Document Open Password jrs.pdf_edit_yourself jrs.excel_layout=false jrs.toc_pdf jrs.is_applet_chart=false jrs. images and other content Encrypt > Enable text access for screen reader devices for the visually impaired Sign Sign > Method Sign > Digital ID File Sign > User Password Sign > Reason for Signing Document Sign > Or Other Reason Sign > Location Sign > Your Contact Information Excel Word Wrap Preserve Report Formatting Normal Formatting Excel 2000 More Options Less Options Include Shapes in Export Print Page Header Print Page Footer Print Gridlines jrs.has_shapes jrs.text_overflow jrs.excel2000 jrs.html_resolution jrs.print_mode_pdf=false jrs.is_wordwrap jrs.print_gridlines jrs.pdf_user_pasw jrs.excel_advanced=true jrs.pdf_check_enableaccess jrs.print_header jrs.excel_layout=true jrs.password_pdf Encrypt > Use a password to restrict jrs.format_chart jrs.pdf_sign_method jrs.pdf_contact_inf .pdf_sign jrs.pdf_document_reson jrs.print_footer jrs.web_browser jrs.pdf_digital_path jrs.is_applet_chart=true jrs.print_mode_pdf=true jrs.pdf_permis_pasw jrs.has_pdf_permis_pasw printing and editing of the document and its security settings Encrypt > Permissions Password Encrypt > Printing Allowed Encrypt > Changes Allowed Encrypt > Enable copying of text.pdf_changallow jrs. delimiter= jrs.enable_to_prefer_server jrs.use_section508_compliant_page jrs.frameapplet jrs.zip_applet_result jrs.is_norm_txt=false jrs.is_text_delimiter=jrs.is_only_data jrs.hasHeadFoot jrs.txt_windows=false .no_margin_ps jrs.is_repeat jrs.udchar_height jrs.applet_type=2 jrs.is_quotemark jrs.no_margin_rtf jrs.2 for Windows Java Plug-In 1.is_text_delimiter=jrs.udchar_width jrs.txt_compress jrs.txt_windows=true jrs.Text Delimited Format Delimited Format > Use Quote Mark Delimited Format > Repeat Last Column Value If Null Delimited Format > Custom Delimiter Delimited Format > Tab Delimited Delimited Format > CSV Format Horizontal Density Vertical Density Compress Header and Footer Windows End-of-line (CR-LF) Unix End-of-line (LF) RTF Best Editing No Margin XML Only Data PostScript No Margin Applet Pop-up Window Zip Result Java Plug-In 1.enable_save_used_parameter_values max_autocomplete_list_num jrs.3 for Windows Advanced Enable Waiting Page Specify Default Language Specify Default Language > Language Specify Default Language > Reset All Users' Preference Identify Server Preference Use Accessible Version Enable Saving Parameter Values Maximum Number of Auto Complete Parameters List Enable Waiting Page > Customize Default Format Customize Format Customize Format > Enable Customize Loading Status Image Customize Format > Server-side File Name Customize Format > Alignment to Customize Format > Tip Text Font Customize Format > Size Customize Format > Bold skin_style=Default skin_style=Customize skin_enable_loading_statue skin_waitting_statue skin_statue_align skin_tip_font_family skin_tip_font_size skin_tip_font_isblod skin_enable_waitting_page enable_setting_display_language locale_nls is_forced_language jrs.is_tab jrs.is_text_delimiter=jrs.delimiter & jrs.is_csv jrs.best_editing_rtp jrs.applet_type=3 jrs. criteria dhtml.reports.popup.with.save.createreport_prompt Automatically Zoom Max Records dhtml.zoom.mwttp.default dhtml.default dhtml.default dhtml.default dhtml.default dhtml.default dhtml.properties in <install_root>\realm\defaultRealm JReport Administration/Console page > Profile > Configure DHTML Profile Features Default Profile Properties > Default User Information Bar Toolbar Table of Contents Resource View Toolbox Right-click Menu Pop Up New Window for Links Editing Marks Pop Up Save Criteria Dialog Save Filter Criteria Save Sort Criteria Switch Reports with Tab Show Master Report Tool Tips on Toolbars Always Prompt Query Filter Always Prompt to Convert Data Fields Mouse Wheel Turn to Page dhtml.tooltips dhtml.toolbar.sort.switch.popup.default dhtml.Customize Format > Italic Customize Format > Underline Specify a JSP as Waiting Page Specify a JSP as Waiting Page > File Name Reports page View Mode My Tasks > Background Tasks > Preferences Result Start Time Finish Time Status Catalog Elapse Time Catalog Version Number Report Version Number Parameters Cancelled skin_tip_font_isitalic skin_tip_font_isunderline skin_style=Appointment skin_waitting_page page_style background_format ondemands_started_time ondemands_time background_status ondemands_catalog ondemands_time_elapse ondemands_catalog_version ondemands_report_version ondemands_parameter ondemands_cancelled UI Option Property in dhtmlPreference.recordnumber.toolbox.default dhtml.dso.tab dhtml.link.currentprofile Always Prompt Whether to Adjust Page Size dhtml.userbar.toc.filter.default dhtml.default dhtml.convertquery_prompt dhtml.detail.default dhtml.bcfilter_prompt dhtml.popup.criteria dhtml.save.master.default .privew.criteria dhtml.save. filter_menu_topn dhtml.report.save.background. background.filter_menu_bottomn dhtml.save dhtml.toc.reportset.timeout dhtml.edit & dhtml.sort dhtml.edit & dhtml.max_reports.reportset.pipe_line dhtml.customize_indent_size dhtml.timeout.timeout.stylegroup dhtml.edit & dhtml.report.Browser Page Title Remove Filter Top N Bottom N More Show Grids Snap to Grids Grid Size Grid Color Report Layout Report Style Group Customize Group Indent Align Summaries Vertically Properties > Advanced Advanced User Auto Refresh Show Group by Name View Incomplete Pages Format Page on Demand Lock Screen Timeout Report Tab Timeout Page Report Timeout Background Mode Timeout Maximum Number of Open Reports Select Catalog Linked Model Show Splash Screen dhtml.locktimeout dhtml.mode.timeout.report.locktimeout.filter_menu_more dthml.on_demand dhtml.report. catalog_linked_mode dhtml.title dhtml.reportlayout dhtml.advanceuser dhtml.edit & dhtml.snap_to_grids dhtml.print dhtml.mode.report.grid_inches_size dhtml.grid_color dhtml.save.catalog_linked_mode_edit & dhtml.filter dhtml.edit & dhtml.profile_last_modified . max_reports dhtml.timeout dhtml.align_summaries dhtml.search jrs.autorefresh dhtml.timeout dhtml.groupbyname dhtml.saveresult dhtml.customize_indent & dhtml.show_grids dhtml.report.filter_menu_all dhtml.saveas dhtml.profile_desc jrs.properties in <install_root>\realm \defaultRealm JReport Administration page > Profile > Configure DHTML Profile > Features Profile list Name Description Last Modified DHTML Profile > Basic Save Save as Filter Sort Export Printable Version Search dhtml.report.report.report.showSpalshScreen UI Option Property in *_profile.profile jrs.report. reset dhtml.resize dhtml.open dhtml.zoom dhtml.create dhtml.toc dhtml.help dhtml.rotate .toolbox dhtml.nav dhtml.skin dhtml.toolbar dhtml.preview dhtml.contextmenu.popup DHTML Profile > Function Visibility > Right-click Menu Display Name Filter Sort Go to Drill Show/Hide Rotate dhtml.grid dhtml.contextmenu.move dhtml.show_or_hide dhtml.bcfilter dhtml.contextmenu.contextmenu.tocrosstab dhtml.insert_or_remove dhtml.tochart dhtml.contextmenu.rotatecrosstab dhtml.recordnumber dhtml.split dhtml.filter dhtml.refresh dhtml.userbar dhtml.sort dhtml.reportsetbar dhtml.displayname dhtml.pagesetup dhtml.drill dhtml.Style Zoom Change Skin Go to Open Refresh Reset Undo/Redo Navigation Page Setup Max Records Help DHTML Profile > Advanced Query Filter To Chart To Crosstab Rotate Split Merge New Editing Marks Chart Type Insert/Remove Grid Pivot Resize Move Resource View Toolbox Drill dhtml.contextmenu.dso dhtml.charttype dhtml.unredo dhtml.merge dhtml.pivot dhtml.goto dhtml.style dhtml.menu dhtml.drill DHTML Profile > Function Visibility User Information Bar Page Report Bar Toolbar Menu Table of Contents Right-click Menu dhtml.contextmenu.goto dhtml. linkreport dhtml.delete dhtml.detailreport dhtml.charttype dhtml.type cluster.tochart dhtml.bcFilter dhtml.active_count cluster.crd_result.enabled cluster.scheduler.search dhtml.contextmenu.contextmenu.history.number_copies cluster.refresh dhtml.check_interval cluster.expand dhtml.storage.lease.scheduler.lease.contextmenu.style UI Option Property in the clustered server's system database JReport Administration page > Cluster > Configuration Load Balancer Type Cluster Scheduler Lease Cluster Scheduler Lease Active Count Cluster Scheduler Lease Valid Time Cluster Scheduler Lease Check Interval Cluster Storage History Number of Copies loadbalance.contextmenu.scheduler.contextmenu.realm.xml in <install_root> \properties JReport Administration page > Configuration> LDAP > Server Enable LDAP Version2/Version3 Enable Direct Authentication to LDAP Server enableLDAPSupport ldapVersion enableNoneImportedLDAPSupport Enable Auto-Import of Users from enableAutoImportLDAPUser LDAP Server LDAP URL LDAP Server Port url serverPort .lease.share_memory.contextmenu.contextmenu.number_copies Copies Cluster Storage CRD Result Number of Copies Cluster Memory Storage Number of Copies Notify via E-mail When a Server Is Down E-mail Address cluster.node_number cluster.notify_server_down_address UI Option Property in LDAPProperties.properties dhtml.contextmenu.scheduler.enable_notify_server_down cluster.contextmenu.storage.storage.lease.reset dhtml.contextmenu.Reset Refresh Search Chart Type To Chart To Crosstab Link Report Detail Report Delete Query Filter Expand Data Properties Style dhtml.contextmenu.contextmenu.tocrosstab dhtml.valid_time cluster.number_copies Cluster Storage Realm Number of cluster.contextmenu. Root Entry Directory Manager DN Password Encryption Type Import LDAP Groups to User Attribute Name User Common Name User Password Distinguished Name Filter (for user schema) Group Common Name Group Member Type Distinguished Name Filter (for group schema) Admin Group rootEntry directoryManagerDN password isUsingSSL importGroupType userAN userCN userPassword userDN userFilter groupCN groupMemeberType groupDN groupFilter groupAdminGroup . SampleReports. Forms the file name using the system variables. Returns the system configuration region (e.g. Returns the hour of the day (e. Returns the catalog file name.g. 001.g.pdf. 25).wst.pdf). (e. with its extension (e. 002. Returns the day of the month. Strings Defined Description (Sample) Forms the file name using the date/time when the result is generated (e. Returns the report file name. .g. then only the last generated report result can be kept on disk. 2006). shown in number format (e. Returns the file encoding (e.g.g. Cp1252). Returns the hour of the day (e. a dynamic result file name must be used. CustomerAnalysis). AM).g. Forms the file name using user name. the string "[sheet]" will be interpreted literally as "[sheet]" itself. en). However for formats such as .g. .g.cls). Returns the year in short form (e.rsd. catalog path and report path) and extension (e. and .g.g. with its path and extension (e. Returns the report tab name in the report (e. Returns the minute of the hour (e. 12).cls). SampleReports). too many results may be generated in a single directory. It is used for the 12-hour time. SampleReports. Mike).g. without its extension and path (e. Returns the second of the minute (e.cat). GMT-05. JReport Server provides you with the following defined strings to form a dynamic name: By Time yyyy yy MM dd hh HH mm ss m User name z System language zone encoding region JReport pathcat CAT cat pathcls CLS cls sheet Returns the catalog file name.pdf. It is used for the 24-hour time. since when a fixed directory path is specified.g. Returns the catalog file name. 00). Returns the AM/PM marker (e. 00). you can use a dynamic directory path to avoid report management difficulties. Returns the month of the year. report1). US).g. Returns the system configuration time zone (e. Returns the report file name.g.g.g. 00:00:00 AM). Returns the name of the user who is currently logged onto the computer (e.rst.CustomerAnalysis.g. In order to save the result generated every time. 06).g. Returns local computer configuration language (e.00).Appendix 5: Dynamic names When you run a report periodically. Returns the report file name. Similarly.g. 2006-07-25. and if you publish the report result with a fixed name.path2.g.g. with its extension (e. with its full path (e.g.g.cat). Returns the ordinal number (e. CustomerAnalysis. path1. path. Returns the year (e. 05). 003. without its path and extension (e. 05). Naming Rules q The defined strings are case-sensitive. txt myPDFResult_CT[zone][language] [region]my$$[1]. The number of digits of the ordinal number is determined by the total number of "z"s.. such as 2006. etc. 002. However. For example. [region][yy]." in the naming result file.[MM]. r q When you publish a report to e-mail. 02.html as the result file name. zzz only indicates 001 and zz only indicates 01. if the string is $$[m].html .cls. and if the string is $$$$[m]. you should add another dollar sign ($). zzz indicates 001. q You should never use square brackets to enclose strings that are not defined in the above table. if the string is [yy]Year[MM]Month. C:\folder[zz]\folder is incorrect because the sequence for directory is not supported. q q More than one defined string can be used in the dynamic result file name.pdf myRSTResult_SampleReports. q q Notes: q There are two differences between the naming rules of dynamic result file name and the dynamic directory name: r String "z" is only supported in the naming result file.05.rst. but not in the naming dynamic directory. For example.[dd].txt myPDFResult_CTGMT-05..rst myRSTResult_[zzz]. an error message will be shown. you can add a dollar sign ($) before the string. For example. myHTMLResultSampleReports_CustomerAnalysis_01..[hh]. myRSTResult_002.30. the result file name will be $$$[m]. that is. html. Strings that are not in square brackets will be directly used as (part of) the file name. if you use myHTMLResult_[yy]$[YYYY][MM]M[dd]D[ABCD] $name$cls[cls]. [mm]. instead of a specific year. the result could be 02Year2thMonth. string "z" is not dynamic. not to be parsed as defined strings. for example. "/" will be replaced by ". but appears in square brackets. If the string is not a defined string but enclosed by square brackets. you will get an error message (Invalid file name). since ABCD is not defined.00enUSmy$[1]. this rule does not apply.pdf myRSTResult_[pathcat][CLS]. Here are some examples of the dynamic result file name: The Sample Name myTXTResult_[yyyy].. etc. Characters are permitted to be added between different defined strings.. the result file name will be [yyyy]. .[dd]. [yyyy]. For example. myHTMLResult_02[YYYY]06M21D$name $clsCustomerAnalysis.rst myHTMLResult[cat]_[cls]_[zz]. for naming a dynamic directory. the result file name will be $[m].rst myRSTResult_001. except for the ordinal number (z).14.45. If you want the square brackets and the strings enclosed by them to appear in the file name exactly as they are.[ss].[MM]. For example.rst.q Defined strings must be enclosed by square brackets ([ ]) which must appear in pairs.html myHTMLResult_[yy]$[YYYY][MM]M[dd]D $name$cls[cls].10.SampleReports. [yyyy]. if the string is $[yyyy].html The Sample Result File Name myTXTResult_2003. For example. myHTMLResultSampleReports_CustomerAnalysis_02. and zz indicates 01. catCustomerAnalysis. such as [m][name].html. If you want to keep the dollar sign ($) together with the square brackets and the strings. For example. . If you want to view the full name. go through this appendix to search for it. you can only view the abbreviation of national languages or regions supported by it. Language Two-letter lower-case symbols aa ab af am ar as ay az ba be bg bh bi bn bo br ca co cs cy da de dz el en eo es et eu fa Language Afar Abkhazian Afrikaans Amharic Arabic Assamese Aymara Azerbaijani Bashkir Byelorussian Bulgarian Bihari Bislama Bengali. Bangla Tibetan Breton Catalan Corsican Czech Welsh Danish German Bhutani Greek English Esperanto Spanish Estonian Basque Persian .Appendix 6: Language and region name list for National Language Support In JReport Server. Lettish Malagasy Maori Macedonian .fi fj fo fr fy ga gd gl gn gu ha he hi hr hu hy ia id ie ik is it iu ja jw ka kk kl km kn ko ks ku ky la ln lo lt lv mg mi mk Finnish Fiji Faroese French Frisian Irish ScotsGaelic Galician Guarani Gujarati Hausa Hebrew (formerly iw) Hindi Croatian Hungarian Armenian Interlingua Indonesian (formerly in) Interlingue Inupiak Icelandic Italian Inuktitut Japanese Javanese Georgian Kazakh Greenlandic Cambodian Kannada Korean Kashmiri Kurdish Kirghiz Latin Lingala Laothian Lithuanian Latvian. Pushto Portuguese Quechua Rhaeto-Romance Kirundi Romanian Russian Kinyarwanda Sanskrit Sindhi Sangho Serbo-Croatian Sinhalese Slovak Slovenian Samoan Shona Somali Albanian Serbian Siswati Sesotho Sundanese Swedish Swahili Tamil .ml mn mo mr ms mt my na ne nl no oc om or pa pl ps pt qu rm rn ro ru rw sa sd sg sh si sk sl sm sn so sq sr ss st su sv sw ta Malayalam Mongolian Moldavian Marathi Malay Maltese Burmese Nauru Nepali Dutch Norwegian Occitan (Afan) Oromo Oriya Punjabi Polish Pashto. te tg th ti tk tl tn to tr ts tt tw ug uk ur uz vi vo wo xh yi yo za zh zu Telugu Tajik Thai Tigrinya Turkmen Tagalog Setswana Tonga Turkish Tsonga Tatar Twi Uighur Ukrainian Urdu Uzbek Vietnamese Volapuk Wolof Xhosa Yiddish (formerly ji) Yoruba Zhuang Chinese Zulu Region Region AFGHANISTAN ALBANIA ALGERIA AMERICAN SAMOA ANDORRA ANGOLA ANGUILLA ANTARCTICA ANTIGUA AND BARBUDA ARGENTINA ARMENIA ARUBA AUSTRALIA AUSTRIA A2 AF AL DZ AS AD AO AI AQ AG AR AM AW AU AT . AZERBAIJAN BAHAMAS BAHRAIN BANGLADESH BARBADOS BELARUS BELGIUM BELIZE BENIN BERMUDA BHUTAN BOLIVIA BOSNIA AND HERZEGOWINA BOTSWANA BOUVET ISLAND BRAZIL BRITISH INDIAN OCEAN TERRITORY BRUNEI DARUSSALAM BULGARIA BURKINA FASO BURUNDI CAMBODIA CAMEROON CANADA CAPE VERDE CAYMAN ISLANDS CENTRAL AFRICAN REPUBLIC CHAD CHILE CHINA CHRISTMAS ISLAND COCOS (KEELING) ISLANDS COLOMBIA COMOROS CONGO. Democratic Republic of (was Zaire) CONGO. People's Republic of COOK ISLANDS COSTA RICA COTE D'IVOIRE CROATIA (local name: Hrvatska) CUBA CYPRUS CZECH REPUBLIC DENMARK DJIBOUTI AZ BS BH BD BB BY BE BZ BJ BM BT BO BA BW BV BR IO BN BG BF BI KH CM CA CV KY CF TD CL CN CX CC CO KM CD CG CK CR CI HR CU CY CZ DK DJ . METROPOLITAN FRENCH GUIANA FRENCH POLYNESIA FRENCH SOUTHERN TERRITORIES GABON GAMBIA GEORGIA GERMANY GHANA GIBRALTAR GREECE GREENLAND GRENADA GUADELOUPE GUAM GUATEMALA GUINEA GUINEA-BISSAU GUYANA HAITI HEARD AND MC DONALD ISLANDS HONDURAS HONG KONG HUNGARY ICELAND INDIA INDONESIA IRAN (ISLAMIC REPUBLIC OF) IRAQ DM DO TL EC EG SV GQ ER EE ET FK FO FJ FI FR FX GF PF TF GA GM GE DE GH GI GR GL GD GP GU GT GN GW GY HT HM HN HK HU IS IN ID IR IQ .DOMINICA DOMINICAN REPUBLIC EAST TIMOR ECUADOR EGYPT EL SALVADOR EQUATORIAL GUINEA ERITREA ESTONIA ETHIOPIA FALKLAND ISLANDS (MALVINAS) FAROE ISLANDS FIJI FINLAND FRANCE FRANCE. REPUBLIC OF MONACO MONGOLIA MONTSERRAT MOROCCO MOZAMBIQUE MYANMAR LV LB LS LR LY LI LT LU MO MK MG MW MY MV ML MT MH MQ MR MU YT MX FM MD MC MN MS MA MZ MM . THE FORMER YUGOSLAV REPUBLIC OF MADAGASCAR MALAWI MALAYSIA MALDIVES MALI MALTA MARSHALL ISLANDS MARTINIQUE MAURITANIA MAURITIUS MAYOTTE MEXICO MICRONESIA. REPUBLIC OF KUWAIT KYRGYZSTAN IE IL IT JM JP JO KZ KE KI KP KR KW KG LAO PEOPLE'S DEMOCRATIC REPUBLIC LA LATVIA LEBANON LESOTHO LIBERIA LIBYAN ARAB JAMAHIRIYA LIECHTENSTEIN LITHUANIA LUXEMBOURG MACAU MACEDONIA. FEDERATED STATES OF MOLDOVA.IRELAND ISRAEL ITALY JAMAICA JAPAN JORDAN KAZAKHSTAN KENYA KIRIBATI KOREA. DEMOCRATIC PEOPLE'S REPUBLIC OF KOREA. Occupied PANAMA PAPUA NEW GUINEA PARAGUAY PERU PHILIPPINES PITCAIRN POLAND PORTUGAL PUERTO RICO QATAR REUNION ROMANIA RUSSIAN FEDERATION RWANDA SAINT KITTS AND NEVIS SAINT LUCIA SAMOA SAN MARINO SAO TOME AND PRINCIPE SAUDI ARABIA SENEGAL SEYCHELLES SIERRA LEONE SINGAPORE NA NR NP NL AN NC NZ NI NE NG NU NF MP NO OM PK PW PS PA PG PY PE PH PN PL PT PR QA RE RO RU RW KN LC WS SM ST SA SN SC SL SG SAINT VINCENT AND THE GRENADINES VC .NAMIBIA NAURU NEPAL NETHERLANDS NETHERLANDS ANTILLES NEW CALEDONIA NEW ZEALAND NICARAGUA NIGER NIGERIA NIUE NORFOLK ISLAND NORTHERN MARIANA ISLANDS NORWAY OMAN PAKISTAN PALAU PALESTINIAN TERRITORY. ) SK SI SB SO ZA GS ES LK SH PM SD SR SJ SZ SE CH SY TW TJ TZ TH TG TK TO TT TN TR TM TC TV UG UA AE GB US UM UY UZ VU VA VE VN VG VI .S. PIERRE AND MIQUELON SUDAN SURINAME SVALBARD AND JAN MAYEN ISLANDS SWAZILAND SWEDEN SWITZERLAND SYRIAN ARAB REPUBLIC TAIWAN TAJIKISTAN TANZANIA. HELENA ST.SLOVAKIA (Slovak Republic) SLOVENIA SOLOMON ISLANDS SOMALIA SOUTH AFRICA SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS SPAIN SRI LANKA ST. UNITED REPUBLIC OF THAILAND TOGO TOKELAU TONGA TRINIDAD AND TOBAGO TUNISIA TURKEY TURKMENISTAN TURKS AND CAICOS ISLANDS TUVALU UGANDA UKRAINE UNITED ARAB EMIRATES UNITED KINGDOM UNITED STATES UNITED STATES MINOR OUTLYING ISLANDS URUGUAY UZBEKISTAN VANUATU VATICAN CITY STATE (HOLY SEE) VENEZUELA VIET NAM VIRGIN ISLANDS (BRITISH) VIRGIN ISLANDS (U. WALLIS AND FUTUNA ISLANDS WESTERN SAHARA YEMEN YUGOSLAVIA ZAMBIA ZIMBABWE WF EH YE YU ZM ZW . util in <install_root>\help\server\en\api for their details. Note: For the properties which are not mentioned in the following sections. running reports in different ways. style group. notification. you can refer to the package jet. The properties detailed in this section are as follows: q Launching type properties Running reports at a specific time properties Running reports periodically properties Jrs.cs. launching type. It covers properties of task.Appendix 7: Properties for scheduling reports via URL This appendix presents the properties concerned with scheduling reports via URL. and publishing reports to different formats.is_between properties Task properties Publishing to the versioning system properties Publishing to the file system properties Publishing to e-mail properties Publishing to a printer properties Publishing to fax properties Publishing to FTP properties Notification properties Style group properties Encrypting PDF properties q q q q q q q q q q q q q . run immediately. at a specific time or periodically. 1.cs. 1 . the launching type properties are as follows: Time: The details of each property are as follows: q jrs.run periodically jrs.launch_type Constant: jet. q . 0 .cs.APIConst.Launching type properties When scheduling reports via URL.run at time. Possible values: timezone ID strings of java default is current locale. 8}.TAG_LAUNCH_TYPE Description: Specifies to run a report immediately.util. 8 .APIConst.TAG_TIMEZONE Description: Specifies the timezone.util. Possible values: {0.timezone Constant: jet. cs.exe_month Constant: jet.exe_year Constant: jet.APIConst.exe_hour Constant: jet.util.APIConst.TAG_EXE_YEAR Description: Specifies which year to run the report.APIConst.APIConst.is_hourly is false).TAG_EXE_HOUR Description: Specifies which hour in a day to run the report (when jrs.util.TAG_EXE_DAY Description: Specifies which day to run the report.cs.TAG_EXE_MIN Description: Specifies which minute in a hour to run the report (when jrs.cs.cs.APIConst. Possible values: 0 to 59minute q q q q . Possible values: 0 to 11 jrs.TAG_EXE_MONTH Description: Specifies which month to run the report. the running reports at a specific time properties are as follows: q jrs.Running reports at a specific time properties When scheduling reports via URL.exe_day Constant: jet.util. Possible values: 1 to 31 jrs. Possible values: 0 to 23hour jrs.is_hourly is false).util.util.cs. Possible values: 1980 to 2099 jrs.exe_min Constant: jet. APIConst. 1 . 6 . q Properties about monthly q jrs.util.Running reports periodically properties When scheduling reports via URL. 3 Wednesday. false}.Tuesday. 0 .day Constant: jet.APIConst. the report will run once every 2 days. Possible values: {true. 1 .Saturday Example: jrs.SCH_DAY Description: Specifies to run on the xth day in a month (when monthly is selected and jrs. 2}.week Constant: jet.SCH_IS_WEEKDAY Description: Specifies whether to run a report on a specific weekday (i.cs.APIConst.days_id Constant: jet.SCH_WEEKDAYS Description: Specifies on which day to run in a week (when weekly is selected).is_day Constant: jet. 4.APIConst. Possible values: A digit string. 5. jrs. For example. Possible values: {true. 1. 0 . Monday .APIConst.Monday.is_weekday is false). 6}. The default is true. 1. q . The default is false. 5 .APIConst.cs.cs.Friday).SCH_WEEK Description: Specifies that the report will run once every how many weeks specified here (when frequency weekly is selected).util.is_day is true).is_weekday Constant: jet.SCH_DAY Description: Specifies that the report will run once every how many days specified here (when frequency daily is selected and jrs. if the value is set to 1.SCH_IS_DAY Description: Specifies whether to run on the xth day in a month (when monthly is selected).SCH_DAYS_ID Description: Specifies whether the schedule will run daily.Thursday. the running reports periodically properties are as follows: q jrs.day Constant: jet. 2 . Possible values: 1 to 99 weeks jrs.weekly. 2.util. If the value is set to 2.util.util.monthly Properties about daily q jrs.Sunday. jrs. Possible values: {0. false}.util.e.cs.weekdays Constant: jet. the report will run once everyday. 3. Possible values: 1 to 999 days q Properties about weekly q jrs.cs. {0.util.cs.Friday.cs. 4 . weekly or monthly.APIConst. 2 .daily.weekdays=05 means running on Sunday and Friday. second.Possible values: 1th to 31th.util.APIConst. The default is true. Possible values: 0 to 59minute.week Constant: jet.APIConst.APIConst. 2.SCH_IS_HOURLY Description: Specifies to run the schedule every hour. jrs. The default is 1.min Constant: jet. jrs. 4.cs. 5. 3 . 2 .Saturday.Sunday. The default is 0 jrs.month Constant: jet.last week.is_hourly is false).util.SCH_IS_PM Description: Specifies whether to run PM or AM in a day (when jrs.hours Constant: jet.fourth.util. 6.util.cs.Friday. false}. 6 .SCH_MONTH Description: Specifies that the report will run once every how many months specified here (when frequency monthly is selected).cs. Possible values: 1 to 99 hours.APIConst.APIConst.SCH_AT_MIN Description: Specifies to run at which minute in an hour (when jrs.hour Constant: jet.is_hourly is true).first. q q Properties about hourly q jrs.util.SCH_WEEK Description: Specifies to run on the xth week in a month (when monthly is selected and jrs. 1.util. false}. The default is 0.SCH_MIN Description: Specifies to run at which minute in a hour (when jrs.APIConst. The default is 0.Wednesday.cs. 3 .cs. q q q q q .cs.is_hourly is false). 4 . 1 .APIConst. Possible values: {1. Possible values: 0 to 59minute. 5 Thursday.APIConst.SCH_WEEKDAY Description: Specifies to run on which day in the week (when monthly is selected and jrs. 3.is_day is false). 4 . The default is true. jrs. 2.is_hourly Constant: jet. jrs. The default is 1.at_min Constant: jet. Possible values: 1 to 6 months.third. The default is 1. The default is 7.weekday Constant: jet. Possible values: {true.SCH_HOUR Description: Specifies to run at which hour in a day (when jrs. 7}. 2 . Possible values: 1 to 12hour.cs. Possible values: {0. 0 . The default is 1. 7 .util.util.util. 3. jrs. q jrs.is_pm Constant: jet.Tuesday.cs.SCH_HOURS Description: Specifies that the report will run once every how many hours specified here (when frequency hourly is selected).is_hourly is false).APIConst.cs. jrs.is_day is false). Possible values: {true. 4}. 1 .Monday. Possible values: 1 to 999 minutes Note: The property jrs.cs. false} jrs.util.is_minutely to true.util.SCH_MINUTES Description: Specifies that the report will run once every how many minutes specified here (when frequency minutely is selected).SCH_IS_MINUTELY Description: Specifies whether to run the schedule every minute. Possible values: {true.is_hourly has the higher priority. if you set both jrs.cs.q jrs.cs.APIConst. q .is_hourly is true).SCH_IS_BETWEEN Description: Specifies whether to run between the start time and the finish time (when jrs. false} Properties about minutely q jrs.util.is_between Constant: jet.minutes Constant: jet.APIConst.is_minutely Constant: jet.APIConst. Possible values: {true. That is.is_hourly and jrs. the schedule will run the task based on hour. is_between is true).SCH_HOUR Description: Specifies the start hour of a period of time (when jrs. is_between is true). jrs.APIConst. exe_month.is_hourly is true.cs. the specified time is represented by the properties of jrs.SCH_HOUR2 Description: Specifies the finish hour of a period of time (when jrs. jrs.cs.util. Possible values: 1-12hour jrs.exe_min.util.is_hourly is true.is_between properties are as follows: q jrs. Possible values: 0-59minute.util. false} Note: If the value is true.APIConst.is_minutely is true).cs.cs.cs. false} jrs.APIConst. jrs.is_hourly is true.is_between is true).Jrs. The default is 0.SCH_IS_PM2 Description: Specifies the finish PM or AM of a period of time (when jrs. jrs.is_hourly or jrs.exe_hour or jrs.hour2 Constant: jet.is_between properties When scheduling reports via URL.util. jrs.is_between is true).is_after Constant: jet. Possible values: 0-59minute jrs.is_between is true).cs.APIConst. false} .APIConst. Possible values: {true.is_pm2 Constant: jet.is_hourly is true. jrs. Possible values: 1-12hour.exe_year.SCH_MIN2 Description: Specifies the finish minute of a period of time (when jrs.SCH_IS_PM Description: Specifies the start PM or AM of a period of time (when jrs. jrs. Possible values: {true.SCH_MIN Description: Specifies the start minute of a period of time (when jrs.min2 Constant: jet. jrs.util.is_pm Constant: jet.hour Constant: jet.is_hourly or jrs. jrs.cs. Possible values: {true.util.is_between is true). the jrs.APIConst. Possible values: {true. jrs.cs.is_hourly is true. jrs.is_before Constant: jet.is_hourly is true.SCH_IS_AFTER Description: Specifies to run after the specified time (when jrs.exe_day.APIConst. q q q q q q q jrs.util.SCH_IS_BEFORE Description: Specifies to run before the specified time (when jrs.is_minutely is true). false} jrs.APIConst.min Constant: jet.util. The default is 5. cease_sec.Note: If the value is true. the specified time is represented by the properties of jrs. jrs. jrs.cease_year. . jrs.cease_hour. jrs.cease_min or jrs.cease_month.cease_day. TAG_TASK_CLASS Description: Specifies the class name of the task.util. the task properties are as follows: q jrs.cs. Possible values: {true.SendMailTask".server.jrtasks.util.APIConst. param$PM=3&jrs.cls jrs.jrtasks.PublishToDiskTask". jrs.catalog Constant: jet.report Constant: jet.util.server. task_listener_class).task_class Constant: jet.server.server.UpdateRptTask".TAG_TASK_ID Description: Specifies the task ID of a scheduled task.cs.TAG_REPORT Description: Specifies the report name.task_id Constant: jet.schedule.TAG_CATALOG Description: Specifies the catalog's full path.param$PM=true&jrs.cs.util.param$PM=16.APIConst.server.param$PARAMETER_NAME=true before the parameter values to declare that the parameter supports multiple values.schedule. when specifying values for it.cs. "jet.jrtasks. you need to add _isMultiple_jrs.cs.TAG_PARAM_PREFIX + PARAMETER_NAME Description: Specifies parameter values for running the report.util.param$ + PARAMETER_NAME Constant: jet.Task properties When scheduling reports via URL.APIConst.TAG_HAS_TASK_LISTENER Description: Specifies whether or not to implement TaskListener.jrtasks.APIConst.schedule. Example: EmployeeInformation. "jet. Example: /SampleReports/SampleReports. q q q q q .has_task_listener Constant: jet.PrintRptTask". Possible values: "jet.param$PToday=May+21%2c+1998 Note: For a multi-value parameter. "jet. false} jrs.schedule. q jrs. Example: jrs.SendJRMailTask". For example.APIConst.TAG_TASK_LISTENER_CLASS Description: Specifies the user's Java class name which implements the TaskListener (jrs.util. This property is unnecessary if a new schedule is submitted.jrtasks.cat jrs. &_isMultiple_jrs.APIConst.task_listener_class Constant: jet.cs.cs. Possible value: a class name (String) jrs.util.APIConst.schedule. "jet. PARAMETER_NAME=VALUE.util.TAG_DB_PSWD Description: Specifies the new database password if you do not want to use the default DB password in the catalog. jrs.cmd=jrs. rpt_language=de&jrs.APIConst.param_values=STARTDATE%3d1998-05-10%2cENDDATE%3d1998-07-10 (original: STARTDATE=1998-05-10.param_values Constant: jet.APIConst.param_values=PTODAY%3dMay%2021%5c%2c%201998%2cTERMSDAYS%3d30 (original: PTODAY=May 21\. Format: PARAMETER_NAME=VALUE.util.rpt_encoding Constant: jet. properties).util. cat&jrs.report=/SampleReports/EmployeeInformation. This is the escaped string of the parameter values of the report.enable_nls=true&jrs.cs.TAG_DB_USER Description: Specifies the new database user ID if you do not want to use the default DB user ID stored in the catalog.g.TAG_REPORT_LANGUAGE Description: Specifies the language in which to generate the report... You can also use jrs. cat&jrs.ENDDATE=1998-07-10) q jrs.TAG_JDBC_URL q q q .cs.jsp?jrs.result_type=2&jrs.cs. Examples: jrs. you should set this command as jrs. then you will have to rename the language property file to ReportName_de. for example C:\JReport\Server\history\1 \JReport_System_User457188937.rpt_language Constant: jet. If you only want to use jrs..cs.properties in EmployeeInformation.web_vw&jrs.util. rpt_language=aaa r r q jrs.APIConst.report=/SampleReports/EmployeeInformation. de_DE in ReportName_de_DE. properties.jdbc_url Constant: jet.rpt_language=de&jrs.cat/EmployeeInformation.db_pswd Constant: jet.jsp?jrs.cls's real path folder.db_user Constant: jet. jrs.cls&jrs.catalog=/SampleReports/SampleReports.APIConst.rpt_language=de.TAG_PARAM_VALUES Description: Specifies parameter values for running the report. if the language property file is named ReportName_de_DE.cls&jrs.rpt_language=de_DE.TERMSDAYS=30) jrs.APIConst.cs. then you can use the following URL to run NLS report: http://localhost:8888/dhtmljsp/dhtml.APIConst. properties. Examples: r http://localhost:8888/jrserver/SampleReports/SampleReports. The value you set for this command should be consistent with the language and country code part of the language property file name (e.rpt_country=DE to achieve the same goal.catalog=/SampleReports/SampleReports.properties to EmployeeInformation_aaa. 1998.rpt_country=DE If you change EmployeeInformation_de_DE. cls?jrs.enable_nls=true&jrs.q jrs.TAG_REPORT_ENCODING Description: Specifies the encoding in which to generate the report.rpt_language=de_DE http://localhost:8888/dhtmljsp/dhtml.util.cs. For example.util. jrs.enable_nls=true&jrs. ) of jet. jrs.mail_to_referuser Constant: jet.APIConst. Example: Running a report with user's JDBC connection object by using JReport Server API.printer Constant: jet.cs. myCon).util.TAG_JDBC_CONNECTION_OBJECT Description: Specifies to dynamically use the user's java. //set the parameter "jrs..sql.cs.if_print Constant: jet.TAG_PRINTER Description: Specifies the printer for printing the report result.TAG_IF_PRINT Description: Specifies whether or not to print the report result.runReport(userID.) and submitScheduledTask(..put("jrs.TAG_JDBC_DRIVER Description: Specifies the new JDBC driver in the catalog to run a report.sql.Connection myCon = java....util.Description: Specifies the new JDBC URL in the catalog to run a report. jrs.util.util.cs.wp Constant: jet.Connection object instead of //the default DB settings in the catalog.named_wp Constant: jet.APIConst.APIConst.Connection object to run a report.cs. catalog. false} q q q q .TAG_WHERE_PORTION Description: Specifies the where portion. jrs.jdbc_driver Constant: jet.APIConst.APIConst. propParams).TAG_NAMED_WHERE_PORTION Description: Specifies the named where portion that exists in the catalog.cs.server. This parameter can be used in methods runReport(. runReportNotWaitResult(.getConnection(dbUrl).util. jrs.api. //run the report using this java.cs. java.cs. The default value is false jrs. q jrs. report set.sql.sql.TAG_MAIL_TO_REFERUSER Description: Specifies whether or not to send mails to each user who is authorized to view a report with cached report bursting.util.APIConst. Possible values: {true.jdbc_connection_object" to run a report.APIConst.).DriverManager.jdbc_connection_object Constant: jet.jdbc_connection_object".RptServer. rptServer.util. propParams.. q q jrs.Connection object.sql. //create the java. the publishing to the versioning system properties are as follows: q jrs.cs.Publishing to the versioning system properties When scheduling reports via URL.APIConst.expire_days Constant: jet.util. . The default value is 30.TAG_EXPIRE_DAYS Description: Specifies the number of days a result version will be kept until it expires. cs. The default is false q q q q q q q q q .html Constant: jet.TAG_IS_DHTML Description: Specifies to generate a DHTML TOC (To HTML). Possible values: {true.util. jrs.APIConst.APIConst.use_table Constant: jet.util. false}.rst_dir Constant: jet. false}.cs.util. jrs. Possible values: {true.cs. jrs. false}.Publishing to the file system properties When scheduling reports via URL. false}.APIConst.rst jrs.util. Possible values: {true.TAG_HAS_PAGE_NUMBER Description: Specifies to generate page numbers (To HTML).rst Constant: jet.APIConst. Possible values: {true.APIConst.APIConst.cs.has_page_number Constant: jet.html_dir Constant: jet. The default is true.TAG_HTML Description: Specifies the filename for the published HTML file.cs.util. false}.has_hyperlink Constant: jet.htm jrs. the publishing to the file system properties are as follows: q jrs.TAG_IS_CHART_APPLET Description: Specifies that the chart in HTML file is an applet (To HTML).is_dhtml Constant: APIConst.is_applet_chart Constant: jet.cs.APIConst.util. Possible values: /publish_site jrs.APIConst. Possible values: {true.TAG_HTML_DIR Description: Specifies the path for the published HTML file.cs.is_multi_files Constant: jet.TAG_RST Description: Specifies the result filename for the published JReport result file. false}.util.TAG_USE_TABLE Description: Specifies to use the HTML table to generate the HTML page (To HTML).TAG_RST_DIR Description: Specifies the path for the published JReport result file. jrs. Possible values: /publish_site jrs.TAG_HAS_HYPERLINK Description: Specifies to generate hyperlinks in the HTML file (To HTML). jrs.APIConst.cs. Possible values: {true.TAG_IS_MULTI_FILES Description: Specifies whether HTML is generated to a single or to multiple files (To HTML).cs.util. The default is true.util. The default is true. The default is true. Possible values: EmployeeInformation. The default is false. Possible values: EmployeeInformation. cs. jrs. Possible values: {true. false}. The default is false.util.cs. Possible values: {true. 1}.cs. Possible values: {true. false}. 1 .APIConst.util.IE or Chrome.APIConst. The default is false.txt q q q q q q q q q q .TAG_TEXT_DIR Description: Specifies the path of the published TXT file. the exporting speed is much improved.TAG_PRINT_MODE_PDF Description: Specifies whether to use Generate charts and barcodes using images (recommended) (false) or Generate charts and barcodes using vector graphics (true) (To PDF). jrs.cs.print_mode_pdf Constant: jet.text Constant: jet.relative_font_size Constant: jet.APIConst. The default is false.APIConst. 0 .pdf Constant: jet.no_margin_html Constant: jet. jrs. The default is false.compress_image_pdf Constant: jet.text_dir Constant: jet.cs.TAG_NO_MARGIN_HTML Description: Specifies that there is no margin in the HTML page (To HTML).APIConst. Possible values: /publish_site jrs.util.cs. Possible values: {true. Possible values: {true.util. jrs.APIConst.APIConst. The default is false.util. The default is 0. false}.APIConst.APIConst. Possible values: EmployeeInformation.no_margin_pdf Constant: jet.TAG_TEXT Description: Specifies the filename of the published TXT file. jrs.TAG_COMPRESS_IMAGE_PDF Description: Specifies the compression ratio of the image in the report (To PDF). The default is 20.rst jrs. jrs.cs.util.cs.cs.util.TAG_NO_MARGIN_PDF Description: Specifies to display no margin (To PDF).TAG_PDF_DIR Description: Specifies the path of the published PDF file. Possible values: EmployeeInformation. By checking Generate charts and barcodes using vector graphics. Possible values: 1 to 100.web_browser Constant: jet.util.util.cs.cs.APIConst.TAG_WEB_BROWSER Description: Specifies which web browser to generate the HTML pages for (To HTML).util.TAG_PDF Description: Specifies the filename of the published PDF file. false}.pdf_dir Constant: jet.q jrs.APIConst. jrs. Possible values: /publish_site jrs.Firefox.TAG_RELATIVE_FONT_SIZE Description: Specifies to generate HTML pages with a relative font size (To HTML).drilldown Constant: jet. false}.util. Possible values: {0.TAG_DRILLDOWN Description: Specifies to drilldown on the HTML page (To HTML). cs. jrs. The default is false. Possible values: {true.util. jrs.delimiter='. The default is true. The default is true.TAG_DELIMITER Description: If jrs.cs.APIConst.cs.delimiter to specify a delimiter character.util.APIConst.util.APIConst.TAG_IS_NORMAL_TEXT Description: Specifies whether this text file is in Delimited Format or not (To TEXT).TAG_TEXT_IS_DELIMITER Description: Specify a delimiter to separate fields (To TEXT).util. false}. false}.TAG_IS_QUOTEMARK Description: Specifies that quotation marks should be placed in the published text file.util. Possible values: {true.cs.txt_compress Constant: jet. you can use jrs.APIConst. jrs.is_norm_txt Constant: jet.APIConst.APIConst. When it is set to false. for example.TAG_IS_TAB Description: Uses a Tab delimiter to separate the fields.is_tab Constant: jet.delimiter Constant: jet.cs.'.util. Possible values: {true.cs.cs. jrs.is_quotemark Constant: jet.udchar_width Constant: jet. It would be given up if the value is 0 or less than 0 (To TEXT).APIConst. the output format is Delimited Format.is_text_delimiter Constant: jet. jrs.util. The default is false.cs.cs. jrs.excel_dir Constant: jet.is_csv Constant: jet.TAG_IS_REPEAT Description: Specifies whether the same content is repeated (To TEXT).APIConst. Possible values: A user defined delimiter.cs.cs.APIConst.q jrs.util.TAG_EXCEL_DIR q q q q q q .TAG_CHAR_HEIGHT Description: Specifies the user defined height. false} The default is true.is_repeat Constant: jet. It would be given up if the value is 0 or less than 0 (To TEXT).util.APIConst.cs.TAG_TXT_COMPRESS Description: Specifies to compress the published text file.APIConst.util. jrs.udchar_height Constant: jet.APIConst. Possible values: {true.delimiter. jrs. Possible values: {true. jrs.hasHeadFoot Constant: jet.TAG_CHAR_WIDTH Description: Specifies the user defined width.is_text_delimiter=jrs. jrs. false}.TAG_IS_CSV Description: Exports to the CSV format text file.TAG_HASHEADFOOT Description: Specifies to generate the page header or footer (To TEXT). Possible values: It has three values: r q jrs. false}.util. r r q jrs.util. rst jrs.APIConst.cs.util.APIConst.cs.xml jrs.APIConst. Possible values: EmployeeInformation. Possible values: EmployeeInformation.TAG_NO_MARGIN_PS Description: Specifies that no margins are included (To PostScript).cs. jrs.APIConst.xml_dir Constant: jet. Possible values: /publish_site q jrs.TAG_XML Description: Specifies the result filename for publishing to XML file.APIConst.no_margin_rtf Constant: jet.rtf Constant: jet.cs.cs. Possible values: EmployeeInformation.util. Possible values: {true.util.TAG_IS_ONLY_DATA Description: Specifies to contain only data in the published XML file.ps Constant: jet.cs. jrs. The default is false. Possible values: /publish_site jrs.is_only_data Constant: jet.TAG_EXCEL Description: Specifies the filename of the published Excel file.TAG_RTF Description: Specifies the result filename for publishing to Rich Text Format. jrs. Possible values: {true.util.APIConst.TAG_XML_DIR Description: Specifies the path for publishing to XML file.APIConst.ps_dir Constant: jet.TAG_PS_DIR Description: Specifies the path for publishing to Rich Text Format. false}. Possible values: EmployeeInformation.xml Constant: jet.util. false}.util.cs. false}.APIConst.APIConst.util.rst jrs.TAG_PS_DIR Description: Specifies the path of the published PostScript file.APIConst.util.to_disk Constant: jet.cs.no_margin_ps Constant: jet.TAG_NO_MARGIN_RTF Description: Specifies that no margins are included (To Rich Text Format).APIConst. The default is false. The default is false.excel Constant: jet. Possible values: /publish_site jrs.cs.cs. Possible values: /publish_site jrs.TAG_TO_DISK Description: Specifies that the report is scheduled for publishing to disk.Description: Specifies the path of the published Excel file.rst jrs. false} q q q q q q q q q q .util.util.util. Possible values: {true.rtf_dir Constant: jet.TAG_PS Description: Specifies the result filename of the published PostScript file. Possible values: {true.cs. auth_uid=admin&jrs.to_disk_pdf_path_type Constant: jet. 1 .publishing to a real disk path q Examples Example 1: Publish a report to a real disk path in PDF format http://localhost:8888/jinfonet/submitSchedPage.jrtasks.task_class=jet. catalog=%2fSampleReports%2fSampleReports.to_disk=true&jrs. to_disk_text_path_type=1&jrs. HTML or PDF.pdf&jrs.to_pdf=true Example 2: Publish a report to a real disk path in TXT format http://localhost:8888/jrserver?jrs.cls&jrs.cmd=jrs.server.server. For example.report=%2fSampleReports% 2fEmployeeInformation. text_dir=d:\&jrs.cs.txt&jrs.PublishRptTask&jrs. 1}.jrtasks. jrs.catalog=%2fSampleReports% 2fSampleReports.schedule.q jrs.cmd=jrs.PublishRptTask&jrs.pdf_dir=d:\&jrs.report=%2fSampleReports%2fEmployeeInformation.jsp?jrs.auth_pwd=admin&jrs.result_type=2&jrs.cls&jrs.to_disk_pdf_path_type=1&jrs.pdf=abc. 0 .to_text=true . task_class=jet.TAG_TO_DISK_PDF_PATH_TYPE Description: Specifies whether to schedule the report for publishing to a real disk path or to the JReport Server resource path in PDF format.APIConst.text=abc. Possible values: {0. to_disk=true&jrs.submit_schedule&jrs.schedule.util.to_disk_???_path_type ??? specifies the format of the published report.cat&jrs.submit_schedule&jrs.result_type=3&jrs.cat&jrs. See the example below.auth_uid=admin&jrs. auth_pwd=admin&jrs.publish to the JReport Server resource path. TAG_JRMAIL + NUMBER Description: Contains specifications (JReport mail properties) of one send-mail task for a report.mailattach1%3dd%3a%5ctest1.util.mailcc Constant: jet. 3.mailto%3dreader2%252c%2520reader3% 26 jrs.TAG_MAIL_SUBJECT Description: Specifies the "SUBJECT" of the e-mail.jinfonet. 3 .APIConst.util.util.cs.mailsubject%3dtest% 2520sending%2520normal%2520emails%2520without%2520report%26jrs.cs.mailsubject%3dreport%2520EmployeeInformation%26jrs.mailto%3dhelen%40support. 0 . 8.mailformat%3d4%26jrs.txt q Properties in jrs.%26jrs.mailto%3dreader1%26jrs.cs.util. This property is used via URL or via invoking Server API.cs.Publishing to e-mail properties When scheduling reports via URL. the publishing to e-mail properties are as follows: q jrs.mailsubject%3dreport% 2520EmployeeInformation%26jrs.Attachment in HTML Format.APIConst.mailcomments%3dto%2520user2.TAG_MAIL_TO Description: Specifies the mail address.txt&jrs.jrmail0=jrs.TAG_MAIL_CC Description: Specifies the mail address to be carbon copied to. 9}. com%26jrs. jrs. 4 . 2.jrmail q jrs.TAG_MAIL_BCC Description: Specifies the mail address to be blind carbon copied to. 6.APIConst.mailbcc Constant: jet. Example: jrs.mailformat %3d0%26jrs. 5. 5 .Attachment in JReport Result Format.mailsubject%3dtest%2520sending% 2520normal%2520emails%2520without%2520report%26jrs.APIConst.util.util.cs.Attachment in Excel Format.jrmail + NUMBER Constant: jet.txtjrs.mailattach0%3dd%3a%5ctest3. jrs. 2 .cs.csmail0=jrs. 1. 7.APIConst. jinfonet. jrs. 6 .APIConst.Attachment in Text q q q q q . jrs.APIConst. Example: jrs.csmail + NUMBER Constant: jet.mailcomments Constant: jet.E-mail Result in Plain Text E-mail Format.mailformat Constant: jet.mailsubject Constant: jet.mailattach0%3dd%3a%5ctest0.cs.util.mailto Constant: jet. jrs.TAG_NORMAL_MAIL + NUMBER Description: Contains specifications (JReport mail properties) of one send-mail task for sending an email with or without an attachment.mailattach1%3dd%3a%5ctest2.com&jrs.TAG_MAIL_COMMENT Description: Specifies the "COMMENTS" field of the e-mail. 1 .cs.Attachment in PDF Format. Possible values: {0.jrmail1=jrs.mailcomments%3dto%2520user1.util.APIConst.%26jrs.TAG_MAIL_FORMAT Description: Specifies the mail format.E-mail Result in HTML E-mail Format.mailto%3dtim%40support. csmail1=jrs.txt%26jrs. 4. util.Attachment in PostScript Format.udchar_height Constant: jet.txt" is the URLencoded string of "d:\test1.TAG_NO_MARGIN_MAIL Description: Specifies that there are no margins for the report in the e-mail.mailencoding Constant: jet.TAG_MAIL_ENCODING Description: Specifies the encoding of the mails.TAG_USE_TABLE_MAIL Description: Specifies to use the HTML table to generate an HTML format e-mail. Possible values: {true. 7 . The default is false. Possible values: The attached file name Example: jrs. UTF-16. Possible values: UTF-8.mailencoding is used to specify the mail encoding in the URL. false}.txt (where "d%3a%5ctest1.util. jrs.mailattach + NUMBER Constant: jet.cs.Format.APIConst.mailcompress Constant: jet. Specify jrs.Attachment in XML Format.APIConst. When sending mails by RMI API.mailattach0=d%3a%5ctest1. jrs.TAG_CHAR_WIDTH Description: Specifies the user defined character width. The default is false. Possible values: {true. Possible values: {true.util. The default is false. and UTF-8 (use UTF-8 rather than UTF8) will be used as the mail encoding.TAG_CHAR_HEIGHT Description: Specifies the user defined character height. false}. specify the same correct value of -Djreport.mailencoding=UTF-8. which means to generate the HTML table. It has no effect if the value is 0 or less than 0 (for TEXT format). 8 . jrs. The default value is 0. wrong characters may be returned in the mail.cs. Note: jrs.no_margin_mail Constant: jet.TAG_MAIL_COMPRESS Description: Specifies whether to enable Java archive compress.cs.TAG_MAIL_ATTACH Description: Specifies the attached file for this mail.url.APIConst.cs.cs.url.APIConst.APIConst.APIConst.util. In order to avoid such problems. You can attach multiple files with one mail. jrs.util.udchar_width Constant: jet.use_table_mail Constant: jet.cs. 9 . your web application calls JReport Server (standalone) via the RMI function from WebSphere.util.encoding on both the server and RMI client side. It has no effect if the value is 0 or less than 0 (for TEXT format).Attachment in RTF Format. false}.cs. r . ISO8859-1 and so on. do as follows: r q q q q q q Specify -Djreport.txt") jrs.util. q jrs. sometimes.encoding=UTF-8 for both JVM running JReport Server and WebSphere. For example.APIConst. jrs. cat&jrs.margins_bottom Constant: jet.util. jrs.margins_right Constant: jet.cs.PrintConst.TAG_MARGINS_BOTTOM Description: Specifies the length of the bottom margin to print the report result.cs.cs. the following properties are available for use: r q q jrs.cs.util.util.margins_top Constant: jet. jrs.cs. jrs.PrintConst.schedule.util.cs.TAG_MARGINS_RIGHT Description: Specifies the length of the right margin to print the report result. jrs.print_copies Constant: jet.TAG_PRINT_COPIES Description: Specifies the number of copies to print the report result.cs.util. jrs.margins_unit_mm Constant: jet.TAG_PRINTER Description: Specifies the printer with which to print the report result. Values: There are two values: s r r r r jrs.PrintConst.APIConst.PrintConst.margins_left Constant: jet.cmd=jrs.catalog=% 2fSampleReports%2fSampleReports.PrintConst.TAG_MARGINS_LEFT Description: Specifies the length of the left margin to print the report result.PublishRptTask&jrs. task_class=jet. jrs.jrtasks.PrintConst.util.TAG_PRINT_MEDIATRAY Description: Specifies the custom tray to put the printing paper.margins_unit Constant: jet.print_mediatray Constant: jet.util.util.TAG_MARGINS_TOP Description: Specifies the length of the top margin to print the report result.util.printer Constant: jet. jrs.Publishing to a printer properties When scheduling reports via URL.cs.report=%2fSampleReports%2fBanded_Link.util.has_margins is true.cs.util.cls&jrs.MARGINS_UNIT_MM Description: Specifies mm as the margin unit.TAG_HAS_MARGINS Description: Specifies whether to have margins in the printed report result.TAG_MARGINS_UNIT Description: Specifies the unit to print the report result. When jrs.PrintConst.MARGINS_UNIT_INCH Description: Specifies inch as the margin unit.server. .submit_schedule&jrs.margins_unit_inch Constant: jet.PrintConst. Example: http://localhost:8888/jrserver?jrs.cs.cs.has_margins Constant: jet.PrintConst.PrintConst. the publishing to a printer properties are as follows: q jrs.launch_type=0&jrs. s q jrs. print_mediatray=Form-Source&jrs.margins_top. jrs. you must set the value for the following properties at the same time: jrs.margins_bottom=7&jrs.margins_right.margins_left=8&jrs.to_printer=true&jrs. margins_right=9&jrs.margins_top=7&jrs. jrs.margins_unit.printer=smartprint&jrs.print_usejdk=2&jrs.print_copies=2&jrs.margins_unit=jrs. otherwise. it can not work smoothly. . margins_unit_mm Note: In this case. margins_left.margins_bottom and jrs.has_margins=true&jrs. jrs. cs.APIConst.util. jrs.to_fax_quality_normal Constant: jet.TAG_TO_FAX_QUALITY_FAST Description: Indicates the fast fax quality. jrs. s s r jrs. Possible values: {true.TAG_TO_FAX_TO Description: Specifies the fax recipient.util. jrs.TAG_TO_FAX_QUALITY_BEST Description: Indicates the best fax quality.APIConst.to_fax_to_fax_num Constant: jet. Possible values: {jrs.APIConst.cs.util.cs.to_fax_quality Constant: jet.to_fax_quality_normal} s jrs.TAG_TO_FAX_IS_INCLUDE_COVER Description: Specifies whether to send a cover sheet with the fax.cs.to_fax_from_company_name Constant: jet. the publishing to fax properties are as follows: q jrs.APIConst. jrs.util.to_fax_date Constant: jet.util.util.cs.APIConst.util. jrs.APIConst.to_fax_from Constant: jet.util.util. false} r jrs.to_fax_to Constant: jet.cs.cs.to_fax Constant: jet.TAG_TO_FAX_QUALITY_NORMAL Description: Indicates the normal fax quality.cs.util.util.cs.TAG_TO_FAX Description: Specifies whether to publish the report result to fax.Publishing to fax properties When scheduling reports via URL.TAG_TO_FAX_FROM_COMPANY_NAME Description: Specifies the sender's company.APIConst.APIConst.APIConst.cs.APIConst.TAG_TO_FAX_DATE Description: Specifies the date on which the fax is to be sent.to_fax_is_inclue_cover Constant: jet. jrs.cs.to_fax_quality_fast. jrs.to_fax_quality_best Constant: jet.cs.TAG_TO_FAX_TO_FAX_NUMBER Description: Specifies the fax number of the recipient.TAG_TO_FAX_FROM Description: Specifies the fax sender.to_fax_from_phone Constant: jet. jrs.util.APIConst.to_fax_quality_best.to_fax_quality_fast Constant: jet.TAG_TO_FAX_QUALITY Description: Specifies the fax quality. Possible values: {true. jrs. s s s s s .TAG_TO_FAX_FROM_PHONE Description: Specifies the sender's phone number. false} s jrs.APIConst. APIConst.s jrs.TAG_TO_FAX_URGENT Description: Specifies whether the fax is urgent.to_fax_please_comment Constant: jet. jrs.cs. false} jrs.cs.util. false} s s s s s .APIConst.TAG_TO_FAX_COMMENTS Description: Specifies the comments of the fax.to_fax_please_reply Constant: jet.TAG_TO_FAX_PLEASE_COMMENT Description: Specifies whether the recipient is required to comment on the content of the fax. Possible values: {true.util.APIConst. Possible values: {true.TAG_TO_FAX_FOR_REVIEW Description: Specifies whether the fax is for review.util.APIConst.TAG_TO_FAX_SUBJECT Description: Specifies the subject of the fax.APIConst.cs.APIConst.TAG_TO_FAX_PLEASE_REPLY Description: Specifies whether a reply is required for the fax.util.cs.to_fax_subject Constant: jet. Possible values: {true.util.to_fax_for_review Constant: jet. jrs. false} jrs.util.cs.to_fax_urgent Constant: jet. false} jrs. Possible values: {true.cs.to_fax_comments Constant: jet. TAG_FTP_PSD Description: Specifies the password for logging in the FTP server.TAG_JRFTP Description: The JReport FTP.util.TAG_FTP_UN Description: Specifies the user name for logging in the FTP server.ftpPsd Constant: jet.APIConst.APIConst.cs.APIConst. Possible values: 123456 jrs.ftp Constant: jet.TAG_FTP_LBL Description: Specifies the label of the FTP server.ftpLbl Constant: jet.util.ftpUn Constant: jet.ftpLoc Constant: jet.ftpHost Constant: jet.cs.TAG_FTP_PORT Description: Specifies the port of the FTP server.cs. jrs.APIConst.TAG_FTP_HOST Description: Specifies the host of the FTP server.cs.util.to_FTP Constant: jet.util.util.cs.util. Possible values: 192.util. It is used to parse multiple sites.TAG_TO_FTP Description: Specifies whether to publish the report result to FTP.TAG_FTP_LOC Description: Specifies the remote directory on the FTP server to which the files will be published.util.126.APIConst. Possible values: 21 jrs.cs.TAG_FTP_ACCT Description: Specifies the account for logging in the FTP server.1 jrs. Possible values: FTP user1 jrs.util. Possible values: FTPHandler class name or null which is the default value.ftpAcct Constant: jet. false} jrs.APIConst.cs.168.APIConst.APIConst.cs.cs.cs.APIConst. jrs.APIConst.TAG_FTP_HANDLER_CLASS Description: Specifies the FTP client-end handler class for communicating with the FTP server.Publishing to FTP properties When scheduling reports via URL. Possible values: {true.ftpProt q q q q q q q q q q .ftpPort Constant: jet. the publishing to FTP properties are as follows: q jrs. Possible values: Jreport/FTP/20061218/ jrs.util. jrs.ftpHdlCls Constant: jet. Possible values: Jinfonet FTP Site jrs. cs.EXPLICIT.TAG_FTPS_TRANS_MODE Description: Specifies the transfer mode of FTPS.cs.APIConst.TAG_FTPS_TM_ALG Description: Specifies the trustmanager algorithm of FTPS.APIConst.util. 1}.APIConst.cs.TAG_FTPS_SEC_PROT Description: Specifies the security protocol of FTPS.util. 0 .APIConst.util.sftpC2SCmpA Constant: jet.TAG_FTPS_CONN_TYPE Description: Specifies the connection type of FTPS.FTPS q jrs.cs. 3}. Possible values: {0.ftpsTSType Constant: jet. 1. 0 .ftpsKSType Constant: jet.APIConst. jrs.TAG_FTPS_KS_PSD Description: Specifies the keystore password of FTPS.cs.util.TAG_FTPS_TS_FILE Description: Specifies the truststore file of FTPS.cs. jrs.TAG_FTPS_KS_TYPE Description: Specifies the keystore type of FTPS.TAG_SFTP_C2S_CmpA q q q q q q q q q q q q .cs.ftpsTransMode Constant: jet. Possible values: {true. 3 . jrs.APIConst. jrs.cs.cs.ftpsTSFile Constant: jet. 1 .APIConst.util.util.SCP.cs.cs.util.util.util. 2 .SFTP.APIConst.FTP.TAG_FTPS_EN_NO_SEC Description: Specifies whether to enable falling back to the no-security FTP connection if the explicit FTPS connection is not available. jrs.IMPLICIT jrs.cs.ftpsKSFile Constant: jet.Constant: jet.APIConst.ftpsKMAlg Constant: jet. jrs. false} jrs. jrs.APIConst. 1 .util. 2. Possible values: truststore_file_name jrs.ftpsTSPsd Constant: jet.TAG_FTPS_KS_FILE Description: Specifies the keystore file of FTPS.ftpsTMAlg Constant: jet.APIConst. jrs.TAG_FTP_PROT Description: Specifies the protocol for communicating with the FTP server.TAG_FTPS_TS_PSD Description: Specifies the truststore password of FTPS.cs.util.ftpsKSPsd Constant: jet.util.cs.APIConst. jrs.APIConst.ftpsEnNoSec Constant: jet.ftpsSecProt Constant: jet.APIConst.TAG_FTPS_TS_TYPE Description: Specifies the truststore type of FTPS. Possible values: {0.util.ftpsConType Constant: jet.TAG_FTPS_KM_ALG Description: Specifies the keymanager algorithm of FTPS.util. sftpS2CLang Constant: jet.sftpKexAlgs Constant: jet. Possible values: {100} (the only value) TAG_FTP_CONNECTION_IS_OK r .util.cs. q jrs.cs.sftpKH Constant: jet.util.util.cs.cs.TAG_SFTP_C2S_CphA Description: Specifies the C2S cipher algorithms of SFTP/SCP. jrs.APIConst. no} jrs.cs.TAG_SFTP_C2S_MA Description: Specifies the C2S MAC algorithms of SFTP/SCP.util.cs. jrs.TAG_FTP_CONNECTION_FAILED Description: The connection cannot be created because the host name/IP or port is not valid. jrs.util.sftpHKAlgs Constant: jet.sftpSHKC Constant: jet.TAG_SFTP_KexAlgs Description: Specifies the kex algorithms of SFTP/SCP.util.cs.sftpS2CCmpA Constant: jet.util. jrs.APIConst.ftp_param_validation Constant: jet.APIConst. jrs.sftpS2CCphA Constant: jet.sftpC2SCphA Constant: jet.cs.util. Possible values: {yes.cs.APIConst.APIConst. jrs.APIConst.APIConst.TAG_SFTP_S2C_MA Description: Specifies the S2C MAC algorithms of SFTP/SCP.sftpS2CMA Constant: jet.APIConst.TAG_SFTP_HKAlgs Description: Specifies the host key algorithms of SFTP/SCP.APIConst.TAG_SFTP_S2C_Lang Description: Specifies the S2C language of SFTP/SCP. jrs.TAG_SFTP_S2C_CphA Description: Specifies the S2C cipher algorithms of SFTP/SCP.CMD_FTP_PARAM_VALIDATION Description: Specifies the command of checking the validation of FTP connection options.APIConst.cs. Possible values: The following four properties r q q q q q q q q q q q TAG_FTP_CONNECTION_FAILED Constant: jet.APIConst. jrs.sftpC2SMA Constant: jet.APIConst.TAG_SFTP_S2C_CmpA Description: Specifies the s2c compression algorithms of SFTP/SCP.cs.util.APIConst. jrs.sftpC2SLang Constant: jet. jrs.TAG_SFTP_C2S_Lang Description: Specifies the C2S language of SFTP/SCP.util.TAG_SFTP_KNOWNHOSTS Description: Specifies the knownhosts file of SFTP/SCP.cs.cs.Description: Specifies the C2S compression algorithms of SFTP/SCP.util.TAG_SFTP_SHKC Description: Specifies whether to check the strict host key.util.util. TAG_FTP_EMBEDDED_CSS Description: Specifies whether to embed the cascading style sheet (CSS) in the exported HTML .util.APIConst. Possible values: {200} (the only value) r TAG_FTP_NO_PERMISSION Constant: jet.TAG_FTP_ZIP_RESULT Description: Specifies whether to zip the FTP RST result. Possible values: PRECISION_ANY.TAG_TO_FTP_HTML Description: Specifies whether the FTP has HTML format.TAG_FTP_RST_FILE Description: Specifies the file name of the FTP RST result.ftpRstFn Constant: jet. Possible values: {400} (the only value) r q jrs.APIConst. Possible values: ftpHtmlFilename jrs. PRECISION_LOW.cs.ftpHtml Constant: jet. false} s r r jrs.APIConst.cs.ftpHtmNoM Constant: jet.APIConst.APIConst.ftpZipRst Constant: jet.cs.APIConst.util.TAG_FTP_RST_PRECISION Description: Indicates the precision level of the RST result.TAG_FTP_INVALID_FOLDER Description: The connection can be built but the directory where the report result files reside cannot be found.ftpHtmMF Constant: jet.ftpRst Constant: jet.cs.util.APIConst. Possible values: {300} (the only value) TAG_FTP_INVALID_FOLDER Constant: jet.TAG_FTP_CONNECTION_IS_OK Description: The connection is valid.util.APIConst.util.TAG_FTP_NO_MARGIN_HTML Description: Specifies if no margin is set in the HTML page.util.Constant: jet. false} jrs.ftpHtmlFn Constant: jet. Possible values: FTPrstFileName jrs.TAG_FTP_NO_PERMISSION Description: The connection can be built but the user name or password is not valid.APIConst. Possible values: {true.util.util.cs.cs. Possible values: {true.TAG_TO_FTP_RST Description: Specifies whether the FTP has RST (JReport result) format. Possible values: {true.ftpHtmEC Constant: jet.cs.cs.util.cs.util.ftpRstPcs Constant: jet.TAG_FTP_IS_MULTI_FILES Description: Specifies whether the HTML result is generated to multiple files or to one file.util.APIConst.cs.APIConst. Possible values: {true. false} r jrs. Possible values: {true.util.APIConst.TAG_FTP_HTML_FILE Description: Specifies the file name of the FTP HTML format.cs. PRECISION_HIGH r r q jrs.cs. false} r jrs. false} jrs. false} s r jrs. Possible values: {true. 1 .APIConst. false} jrs.ftpHtmRsl Constant: jet. the .APIConst.GIF.TAG_FTP_USE_HTML_TABLE Description: Specifies whether to use HTML data table or not.Auto-select.TAG_FTP_HAS_PAGE_NUMBER Description: Specifies whether the page number is generated. Possible values: {true.cs.APIConst. Possible values: {true.ftpHtmWB Constant: jet. 0 . 1 .util.PNG jrs.Firefox jrs.cs.IE or Chrome. 2 . Possible values: {true.cs.TAG_FTP_RELATIVE_FONT_SIZE Description: Specifies whether to use relative font size to generate the HTML page. When false.cs.APIConst.cs. false} jrs.util.APIConst. 1. 3 . 2.APIConst.TAG_FTP_DRILLDOWN Description: Specifies whether the HTML page can be drilled down.TAG_FTP_USE_SCOPE Description: Specifies whether to use the Scope attribute or not.util.cs.TAG_FTP_HAS_HYPERLINK Description: Specifies whether the hyperlink is generated.util. in dpi. Possible values: {true.util.ftpHtmDD Constant: jet. Possible values: {0.APIConst.util. 3}. Possible values: {true. false} r r r r r r r r .cs. false} s jrs.ftpHtmUHT Constant: jet. Possible values: {0.util. Possible values: {true. false} jrs.TAG_FTP_IS_CHART_APPLET Description: Specifies whether the chart in HTML file is an applet.TAG_FTP_HTML_RESOLUTION Description: Specifies the resolution of the HTML page. Possible values: {true. false} jrs.TAG_FTP_WEB_BROWSER Description: Specifies the web browser for which the HTML result adapts.css file will be generated individually.ftpHtmPN Constant: jet.files when generating multiple files. false} jrs. 0 .util.JPEG.TAG_FTP_USE_SECTION508_OUTPUT Description: Specifies whether to use Section 508 compliant output or not.cs.cs. 1}.APIConst. Possible values: {true.ftpHtmFC Constant: jet. Possible values: 96 jrs.ftpHtmICA Constant: jet.ftpHtmUSO Constant: jet.ftpHtmUS Constant: jet.util.cs.util. false} jrs.ftpHtmRFS Constant: jet.cs.APIConst.APIConst.ftpHtmHL Constant: jet.APIConst.util.TAG_FTP_FORMAT_CHART Description: Specifies the image format in HTML file. TAG_FTP_PDF_ENCRYPT Description: Specifies whether PDF encrypt is enable or not.TAG_FTP_TEXT_OVERFLOW Description: Specifies the text overflow type.cs. 1 .hasftpPdfPmP Constant: jet.cs.APIConst.TAG_FTP_NO_MARGIN_PDF Description: Specifies if no margin is set in the PDF page.ftpHtmPcs Constant: jet.cs.cs. 1}.ftpPdfCIm Constant: jet. Possible values: {true.util. Possible values: 20 r jrs.TAG_FTP_IS_COMPRESS_PDF Description: Specifies whether to compress image in PDF file.TAG_FTP_PDF_FILE Description: Specifies the file name of FTP PDF format. Possible values: {0. Possible values: {true.APIConst.cs. Possible values: {0.APIConst. Possible values: {true.APIConst. It is measured by percentage.TAG_TO_FTP_PDF Description: Specifies whether the FTP has PDF format. 1 .util.cs.TAG_FTP_PDF_PWD Description: Specifies the PDF password.util.util.APIConst.util.util.util.r jrs.ftpPdfFn Constant: jet.APIConst.cs.ftpHtmTO Constant: jet.TAG_FTP_HTML_PRECISION Description: Indicates the precision level of the HTML result.APIConst. false} jrs.ftpPdfNoM Constant: jet.cs.ftpPdfEcr Constant: jet.TAG_FTP_PDF_COMPATIBITLY Description: Specifies the PDF compatibility.cs.ftpPdf Constant: jet. false} s r r jrs. 0 .APIConst. PRECISION_HIGH} r q jrs. Possible values: {true.util.VISIBLE jrs.APIConst.APIConst. 1}.util. Possible values: {PRECISION_ANY. Possible values: 12345678 jrs. false} s r jrs.APIConst.cs. PRECISION_LOW.cs. false} jrs.TAG_FTP_DRILLDOWN_PDF Description: Specifies whether drilldown is enabled in the PDF page.cs.ftpPdfPwd Constant: jet.Acrobat 5.util. 0 .TAG_HAS_FTP_PDF_PERMIS_PASW s s . Possible values: ftppdffilename jrs.util.0 and later jrs.HIDDEN. false} r jrs.ftpPdfCmp Constant: jet.0 and later.ftpPdfDD Constant: jet.TAG_FTP_COMPRESS_IMAGE_PDF Description: Specifies the image compress ratio in PDF file.Acrobat 3. Possible values: {true.ftpPdfIsC Constant: jet.APIConst.util. false} jrs.cs.ftpPdfDP Constant: jet. jrs. s s s s . Possible values: {true. 1.util.util.cs. 2}. 2}.cs. false} s s s s r jrs. 0 . jrs.util. Possible values: SignReason jrs.util.APIConst.util. Possible values: digitalpath jrs.commenting filling in form fields and signing.APIConst.util.TAG_FTP_PDF_EDIT_YOURSELF Description: Edits the reason for signing the document. Possible values: {0.high resolution jrs.ftpPdfSgn Constant: jet.cs. Possible values: {true. Possible values: {0.Default Certificate Security. 4 .cs. 2. 3 .APIConst. 3. 1.TAG_FTP_PDF_PERMIS_PASW Description: Specifies the PDF permission password.ftpPdfEAc Constant: jet.none.TAG_FTP_PDF_CHECK_ENABLECOPY Description: Specifies whether to be able to copy the PDF page.TAG_FTP_PDF_PRINTALLOW Description: Specifies the PDF print allow value.util.cs.ftpPdfChg Constant: jet.cs.TAG_FTP_PDF_CHECK_ENABLEACCESS Description: Specifies whether can access the PDF page. 2 .Windows Certificate Security.cs.Description: Specifies whether to set PDF permission password.ftpPdfPrt Constant: jet.TAG_FTP_PDF_SIGN Description: Specifies whether to be able to sign the PDF page.TAG_FTP_PDF_DIGITAL_PATH Description: Specifies the PDF digital sign path.filling in form fields and signing.APIConst.TAG_FTP_PDF_SIGN_METHOD Description: Specifies the PDF digital sign method. 1 .inserting. Possible values: {true. Possible values: {0.util.any except extracting pages jrs. false} s jrs.APIConst.util. 1 .cs.ftpPdfECp Constant: jet. 4}. 1 .APIConst.cs.APIConst.APIConst.ftpPdfPsw Constant: jet.ftpPdfDR Constant: jet.ftpPdfPmP Constant: jet. 0 .ftpPdfSM Constant: jet. 2 VeriSign Digital Signatures jrs.TAG_FTP_PDF_USER_PASW Description: Specifies the password for the digital ID file. Possible values: {true.APIConst.low resolution (150 dpi). 0 .util.none.TAG_FTP_PDF_DOCUMENT_REASON Description: Specifies the reason for signing the document. false} s jrs.cs.APIConst. 1.ftpPdfEdt Constant: jet.TAG_FTP_PDF_CHANGALLOW Description: Specifies the PDF change allow value.APIConst. deleting and rotating pages. 2 .util. cs.util.ftpPdfPcs Constant: jet. false} jrs.s jrs.ftpPdfGTp Constant: jet.cs.APIConst. false} jrs. Possible values: ftpexcelfilename jrs. Possible values: {true.TAG_FTP_PDF_LOCATION Description: Specifies the PDF location message.util.APIConst.APIConst.ftpExlPcs Constant: jet.util.cs.APIConst. Possible values: {true.TAG_FTP_EXCEL_LAYOUT Description: Specifies whether to use new Excel layout.util.TAG_FTP_PDF_PRECISION Description: Indicates the precision level of PDF.util. Possible values: {true.cs.cs.ftpExlWW Constant: jet.TAG_FTP_TOC_PDF Description: Specifies whether the PDF has TOC. Possible values: pdffilelocation jrs. Possible values: {true. Possible values: {true.APIConst.APIConst. Possible values: {true. false} jrs.cs.ftpExl Constant: jet.APIConst.TAG_FTP_EXCEL_WORDWRAP Description: Specifies whether the Excel has wordwrap format.TAG_FTP_EXCEL_FILE Description: Specifies the file name of FTP Excel format.ftpPdfToc Constant: jet.util.TAG_FTP_EXCEL2000 Description: Specifies whether the Excel has Excel 2000 format.APIConst.ftpExlLyt Constant: jet.ftpPdfCnt Constant: jet. Possible values: {PRECISION_ANY.ftpExlFn Constant: jet.TAG_FTP_EXCEL_PRECISION r r r r .util. Possible values: {true. false} jrs.cs.APIConst.cs. false} jrs. PRECISION_HIGH} r r r q jrs.TAG_FTP_PRINT_MODE_PDF Description: Specifies whether it is for print mode.util.cs.ftpExl2k Constant: jet.TAG_FTP_GIF_TRANSPARENT_PDF Description: Specifies whether the figure is transparent or not.cs. false} jrs. PRECISION_LOW. false} r jrs.util.cs.ftpPdfLoc Constant: jet.cs.util.TAG_FTP_PDF_CONTACT_INF Description: Specifies the PDF contact information.APIConst.util.APIConst.APIConst.TAG_TO_FTP_EXCEL Description: Specifies whether the FTP has Excel format.ftpPdfPM Constant: jet. Possible values: contactname s r jrs.util. APIConst.TAG_FTP_TXT_WINDOWS Description: Specifies whether to apply "\r\n" for OS390 and Windows or "\n" for UNIX.util.util.TAG_FTP_TEXT_FILE Description: Specifies the file name of FTP TXT format.APIConst.ftpTxtCmp Constant: jet. PRECISION_LOW.TAG_TO_FTP_TXT Description: Specifies whether the FTP has TXT format.TAG_FTP_TXT_COMPRESS Description: Specifies whether to compress the published text file. Possible values: {true.ftpTxtWin Constant: jet.util. false} r jrs.util. Possible values: {true.cs.util.APIConst. false} r r r r q jrs.Description: Indicates the precision level of Excel. false} jrs.APIConst.ftpTxtIDl Constant: jet.ftpExlAdv Constant: jet.TAG_FTP_PRINT_GRIDLINES Description: whether to include gridlines when printing the exported Excel file.cs.util.util. false} jrs. Possible values: {true. Possible values: {true.ftpExlHS Constant: jet.cs.APIConst. Possible values: {true. Possible values: {true. Possible values: {true. Possible values: FtpTextFileName jrs.cs.ftpTxt Constant: jet.util.TAG_FTP_PRINT_HEADER Description: whether to include page header when printing the exported Excel file. false} jrs.APIConst. Possible values: {PRECISION_ANY. such as line. PRECISION_HIGH} r jrs. oval.ftpTxtFn Constant: jet.APIConst.cs.ftpExlPrF Constant: jet.TAG_FTP_HAS_SHAPES Description: Specifies whether to include the drawing objects in the exported Excel file. false} jrs.ftpExlPrH Constant: jet.cs. false} jrs.cs. Possible values: {true.util.cs.APIConst.ftpExlPGL Constant: jet.TAG_FTP_PRINT_FOOTER Description: whether to include page footer when printing the exported Excel file. false} jrs. Possible values: {true.util.APIConst.cs.TAG_FTP_TEXT_IS_DELIMITER Description: Specifies whether the delimiter is tab or CSV.util. and box.TAG_FTP_EXCEL_ADVANCED Description: Specifies whether the advanced Excel setting is enabled or not.cs.ftpTxtHF Constant: jet.TAG_FTP_HASHEADFOOT Description: Specifies whether to generate the page header or footer.APIConst. false} jrs. r r r r .APIConst.cs. ftpTxtPcs Constant: jet. Possible values: {true.TAG_FTP_CHAR_WIDTH Description: Specifies the user defined character width. Possible values: {true.ftpTxtRpt Constant: jet.cs.APIConst.ftpTxtRes Constant: jet.ftpTxtQM Constant: jet.ftpTxtDlm Constant: jet. Possible values: {true.cs. false} s r jrs. Possible values: {true.util.ftpTxtNrm Constant: jet.TAG_FTP_RESOLUTION Description: Specifies whether to set resolution of text file. Possible values: {true.TAG_FTP_TEXT_PRECISION Description: Indicates the precision level of Text.util.APIConst.Possible values: {TAG_FTP_IS_CSV.TAG_FTP_IS_NORMAL_TEXT Description: Specifies whether the text file is a standard data format or not.ftpRtf Constant: jet.APIConst.APIConst. false} jrs.cs.ftpTxtChH Constant: jet.TAG_FTP_IS_CSV Description: Specifies whether the result file is CSV format.cs.APIConst.cs.cs.APIConst.cs.cs. Possible values: "".util.APIConst.util. Possible values: {true.util.APIConst. false} r r r r r r r q jrs.TAG_FTP_DELIMITER Description: Specifies a delimiter which will be used in standard data format.util.util.cs. false} jrs. PRECISION_HIGH} jrs.cs. false} jrs. false} .TAG_FTP_IS_QUOTEMARK Description: Specifies to use quote marks in the text file. TAG_FTP_IS_TAB} s jrs. Possible values: {true.cs.APIConst.TAG_FTP_IS_TAB Description: Specifies whether the delimiter is tab char. Possible values: {RECISION_ANY.ftpTxtCsv Constant: jet. false} jrs. " " jrs.util. false} jrs. Possible values: {true. Possible values: {true. false} jrs.util.APIConst.APIConst.TAG_TO_FTP_RTF Description: Specifies whether the FTP has RTF format. PRECISION_LOW.TAG_FTP_CHAR_HEIGHT Description: Specifies the user defined character height.TAG_FTP_IS_REPEAT Description: Specifies whether the value of the previous cell in the same column will be used when a cell in the exported CSV text has no value.ftpTxtTab Constant: jet.ftpTxtChW Constant: jet.util.util. ftpXmlXsd Constant: jet. Possible values: {PRECISION_ANY. false} r jrs. . Possible values: {true.util.cs. PRECISION_LOW.ftpXml Constant: jet.util. Possible values: {true. and the exported XML schema file will contain all the detailed information from the report.util.ftpXmlPcs Constant: jet.TAG_TO_FTP_PS Description: Specifies whether the FTP has PostScript format. Possible values: FtpXmlFileName jrs. including all the property values of each report object.TAG_FTP_RTF_PRECISION Description: indicate the precision level of RTF.TAG_TO_FTP_XML Description: Specifies whether the FTP has XML format.util.APIConst. false} r jrs.APIConst. Possible values: {PRECISION_ANY.TAG_FTP_RTF_FILE Description: Specifies the file name of FTP RTF format.r jrs. PRECISION_LOW. false} jrs.cs. The exported XML schema file will only contain the structure information of the report.util.util.TAG_FTP_NO_MARGIN_RTF Description: Specifies whether there is no margin in the RTF file.TAG_FTP_XSDFILE Description: Specifies the directory and the name of an existing XML schema (.TAG_FTP_XML_PRECISION Description: Indicates the precision level of XML. PRECISION_HIGH} r r r q jrs.APIConst.cs.ftpXmlIOD Constant: jet. the exported XML file will also contain elements controlled by formulas.APIConst. Possible values: {true.util.ftpXmlFn Constant: jet.util. PRECISION_HIGH} r r r q jrs. Possible values: FtpXsdFileName jrs.APIConst.TAG_FTP_BEST_EDITING_RTF Description: Specifies whether to apply flow layout when exporting the report to RTF.cs.TAG_FTP_PS_FILE Description: Specifies the file name of FTP PostScript format.ftpRtfFn Constant: jet.cs.xsd) file.TAG_FTP_XML_FILE Description: Specifies the file name of FTP XML format.cs.ftpRtfNoM Constant: jet. false} jrs. Possible values: {true.cs.ftpPs Constant: jet.util.APIConst.cs.ftpPsFn Constant: jet. false} jrs. If false.cs.APIConst.APIConst.util.util. Possible values: {true. the exported XML file will only contain the database column information.TAG_FTP_IS_ONLY_DATA Description: If true.cs.APIConst.APIConst.cs. Possible values: FtpRtfFileName jrs.APIConst.ftpRtfBE Constant: jet.ftpRtfPcs Constant: jet. false} jrs.TAG_FTP_NO_MARGIN_PS Description: Specifies whether there is no margin in the PostScript file.TAG_FTP_IS_DHTML Description: Specifies whether to show DHTML page.TAG_FTP_PS_PRECISION Description: Indicates the precision level of PostScript. PRECISION_HIGH} r q jrs.cs.ftpIsDht Constant: jet.ftpPsPcs Constant: jet.APIConst.util.TAG_FTP_END Description: Specifies the JReport FTP delimiter for multiple FTPs.util. jrs. false} q .Possible values: FtpPsfilename r jrs.APIConst.ftpPsNoM Constant: jet.util. Possible values: {true.cs.APIConst.APIConst.cs. Possible values: {PRECISION_ANY. Possible values: {true.ftp_end Constant: jet.cs.util. PRECISION_LOW. TAG_NOTIFICATION_EMAILS Description: Specifies the e-mail notification list for successful/failed scheduled tasks. jrs.TAG_SUCCESS_NOTIFY Description: Specifies to send e-mail notification for successful reports.cs. Possible values: {true.cs.util.APIConst. The default is false.fail_notify Constant: jet. q q .APIConst.util.APIConst.notification_emails Constant: jet. false}. Possible values: {true.cs. The default is false. jrs.TAG_FAIL_NOTIFY Description: Specifies to send e-mail notification for failed reports. the notification properties are as follows: q jrs.util. false}.Notification properties When scheduling reports via URL.success_notify Constant: jet. Style group properties When scheduling reports via URL.has_style Constant: jet. false}.cs.util.TAG_HAS_STYLE Description: Specifies to enable the style group that has been set for the report. the style group properties are as follows: q jrs.cs.TAG_STYLE_GROUP Description: Specifies the style group. jrs. q . The default is false.style_group Constant: jet.APIConst. Possible values: {true.util.APIConst. jrs.util.has_pdf_permis_pasw Constant: jet.pdf_printallow Constant: jet.util.APIConst.TAG_PDF_CHECK_ENABLEACCESS Description: Specifies whether to allow visually impaired users to read the PDF document with window readers.APIConst.util.cs.TAG_PDF_PRINTALLOW Description: Specifies the printing quality for the PDF document.cs.APIConst. 0 . false} jrs.Acrobat 3. jrs.util.TAG_PDF_CHECK_ENABLECOPY Description: Specifies whether to enable selecting and copying the contents of the PDF document.high resolution.cs.pdf_changallow Constant: jet.cs.TAG_PDF_ENCRYPT Description: Specifies whether to enable PDF encryption. 1. Possible values: {true.pdf_enableaccess Constant: jet. Possible values: {0.util.APIConst.pdf_encrypt Constant: jet.Acrobat 5.util. 2 .cs.util.0 and later. 2}. 2 .inserting.APIConst.APIConst. 1 .commenting filling in form fields and signing.TAG_PDF_CHANGALLOW Description: Specifies the editing actions that are permitted in the PDF file.cs. This property is available only if the encryption type is set to Acrobat 5. 2.0 or later Acrobat version.password_pdf Constant: jet.none. Possible values: {true. 4 . Possible values: {0.none.pdf_permis_pasw Constant: jet. jrs.low resolution (150 dpi). jrs. false} jrs. Possible values: {0.TAG_HAS_PDF_PERMIS_PASW Description: Specifies whether to use a permission password to prevent others from printing and editing the document.cs.APIConst.pdf_compatibitly Constant: jet.TAG_PDF_PERMIS_PASW Description: Specifies the permission password. 1 .util. false} jrs. jrs.APIConst. 1.cs.Encrypting PDF properties The following are properties to encrypt the PDF format file: q jrs.0 and later. Possible values: {true. 1 .filling in form fields and signing.TAG_PASSWORD_PDF Description: Specifies the password to open the PDF document. 1}. false} q q q q q q q q .APIConst.pdf_enablecopy Constant: jet. 3 . 4}. 0 .TAG_PDF_COMPATIBITLY Description: Specifies the encryption type to encrypt a PDF document.util. 0 . 3. deleting and rotating pages.cs.any except extracting pages. Possible values: {true. These custom tags can be used to componentize JSP pages. This attribute is required. The name of the report the user wants to run.tld in <intall_root>\public_html\dhtmljsp to the folder where your JSP pages are located. This attribute is required. Specifies the ID of the tag set. which includes custom tags such as mainpage. and it checks user information. Add Jinfonet_DHTML_taglib. This attribute is required. The user name for logging in JReport Server.Appendix 8: DHTML tag library JReport DHTML provides a DHTML tag library. you can use web.string tagsetid .jar in <install_root>\lib to the war file you want to publish to the web server. It contains the following attributes: Attribute id .tld</taglib-location> </taglib> Embedded tags dhtml The dhtml tag is a container for the other tags.string user . you should firstly copy the file Jinfonet_DHTML_taglib. The name of the catalog for the report. toc and report. 2. DHTML tags are classified as below: q Embedded tags Component tags Action tags q q Before you can use the DHTML tag library in JReport Server.string catalog . All tags to be used should be included in this tag. For technique topics on the JSP tag library. The user password for logging in JReport Server.sun.string report . Add JRWebDesign. And if you want to use the DHTML tag library in any web server. head.string password .tld in <intall_root>\public_html\dhtmljsp to the war file in which your JSP pages reside. and imports resources for the other tags. references can be found in JSP online documentation on the Sun Microsystems website http://www. <taglib> <taglib-uri>Jinfonet_DHTML_taglib</taglib-uri> <taglib-location>/WEB-INF/Jinfonet_DHTML_taglib. or alternatively.xml to specify a path. . For example.string Description Specifies the ID of the tag. runs a report.com. you should first: 1. increasing productivity and encapsulating recurring tasks so that they can be reused across more than one application. relative: Object is positioned according to the normal flow. q top: Aligns the frame to the top of the web browser window. it follows the layout rules of HTML. mainpage The mainpage tag displays the DHTML page in an IFrame. e. or 0 to hide it. Use 1 to show the frame border. Sets or retrieves whether the frame can be scrolled. no: The frame cannot be scrolled. absolute: Object is positioned relative to parent element's position—or to the body object if its parent element is not positioned—using the top and left properties. right: Aligns the frame to the right of the web browser window. Default value is 1. q static: Default. report_params .string All parameters (name/value pair) that are required for running the report. It can be a relative or absolute value. or use all to display all the components. 70% or 1000px. and then offset by the top and left properties.g. The top position of the frame. The web browser determines whether scroll bars are necessary. measured in pixels. Sets or retrieves the type of positioning used for the object. The user can set any one or more of them.string name . q q id .report_path . 70% or 1000px. The height of the frame. middle: Aligns the frame to the middle of the web browser window. . Specifies the frame name. bottom: Aligns the frame to the bottom of the web browser window. Object has no special positioning. q q controls=[userInfoBar|rptSetBar|toolbar| Toc|Dso|report|toolbox|linkbar|all] All components that the user wants to display. measured in pixels. left: Aligns the frame to the left of the web browser window. q auto: Default. catalog _version integer The catalog version.string position=[static/absolute/relative] Specifies the ID of the frame. It can be a relative or absolute value. q q q q frameborder=[1/0] scrolling=[yes/no/auto] Sets or retrieves whether to display the frame border. e. and the parameters are separated by & character.string The path of the report.g. Specifies where the frame appears in the web browser window. yes: The frame can be scrolled. The left position of the frame. It contains the following attributes: Attribute width=length height=length top=length left=length align=[top/middle/|bottom/left/right] Description The width of the frame. <jinfonet:toolboxbutton component_type="Banded Object"/> will display the Banded Object button. "Image". -1 means 650 pixels.web.valueOf(DHTMLConstant. Attribute width=length Description The width of the report browser. Use -1 to set it to 100% of Internet Explorer window's height. In other web browsers. height=length top=length left=length id class_name style . This attribute is required. Sets a style for the object. measured in pixels. For example. For example. button The button tag is for displaying buttons which match toolbar buttons but they can be placed anywhere in JReport Viewer. The height of the report browser. Attribute buttonid Description Identifies the specific button. "Banded Object". those constants with a prefix "TOOLBAR_" and of int data type represent the buttonid. <jinfonet:button buttonid="<%=String. The top position of the report browser. These constants are available for component_type: "Label".Component tags toc The toc tag is for displaying the TOC Browser. Use -1 to set it to 100% of Internet Explorer window's width. and you can then know the buttonid according to the constant name. You can obtain a constant Java class jet.jar located at <install_root>\lib. toolbar The toolbar tag is for displaying the toolbar. Specifies the ID of the tag. measured in pixels. measured in pixels. "Crosstab". resview The resview tag is for displaying the Resource View panel. toolbox The toolbox tag is for displaying the Toolbox. DHTMLConstant from the package JRWebDesign.dhtml. TOOLBAR_NEW)%>"> will display the New button. In this class. toolboxbutton The toolboxbutton tag is for displaying buttons which match Toolbox buttons but they can be placed anywhere in JReport Viewer. This attribute is required. Attribute component_type Description Identifies the specific button. and "Chart". -1 means 600 pixels. Retrieves the class of the object. "Table". In other web browsers. report The report tag is for DHTML report browser. This attribute is required. measured in pixels. The left position of the report browser. string Sets the window or frame at which to target content. Specifies the maximum number of the items in the list. the root path refers to <install_root>\public_html. filterform The filterform tag will generate a form for filtering the data. the root refers to <install_root> \public_html\dhtmljsp. applyto .string Description Specifies the ID of the tag. It contains the following attributes: Attribute id . The user can set any one or more of them. . get: Appends the arguments to the Form Action URL and opens it as if it were an anchor. applyto . method . q q forward . This attribute is required.string bind_column string logic . post: Sends the data through an HTTP post transaction. Specifies the column by which to sort or filter. q q forward . target .string Description Specifies the ID of the tag.string Specifies the instance name of the component on which the sorting will be based. This attribute is required. This attribute is required. the root refers to <install_root> \public_html\dhtmljsp. target . only for filterform. if with no /. This attribute is required. the root path refers to <install_root>\public_html. get: Appends the arguments to the Form Action URL and opens it as if it were an anchor. Only for filterform. method .string Sets or retrieves how to send the form data to the server. If it starts with /.string Specifies the instance name of the component on which the sorting will be based.string Specifies the page to redirect. post: Sends the data through an HTTP post transaction. Action tags sortform The sortform tag will generate a form for sorting the data. This attribute is required. It contains the following attributes: Attribute id . or use all to display all the components. Its value can be "AND" or "OR".string maxsize integer Description Specifies the ID of the tag. if with no /. column The column tag will generate a list to provide sorting manners for the sortform tag or field values for the filterform tag.controls=[rptSetBar|linkbar|all] Specifies whether to display the components.string Specifies the page to redirect. If it starts with /. This attribute is required. It contains the following attributes: Attribute id . Specifies the relationship between the filter criterion and the next one.string Sets the window or frame at which to target content.string Sets or retrieves how to send the form data to the server. Specifies the style of the list.integer Specifies the ID of the sortform or filterform tag which includes the column tag. Specifies the top position of the list. Specifies the left position of the list. . Specifies the class name. Reference: For examples about the tags. save the code to tagtest.integer left .string width . Specifies the width of the list. To test the examples.html in <install_root>\help\server\en\samples.string top . This attribute is required. refer to the file ExampleCodeForTags. where some sample code for different tags is provided.parent_id string class_name string style .jsp and then put it in <install_root>\public_html \dhtmljsp. Documents Similar To JReport Server User's GuideSkip carouselcarousel previouscarousel nextCon2715 Baumann Oowc1891622DOS commands vs linuxEnhanced Info Set FeaturesSBOP_PC_10_NW_ReleaseNotes[1]966309 - Content of Table TCOLL in SAP_BASIS 700 - 7.02 and 7.31 - 7.40SWPM10SP7 Diag Agent UnattendedDB2 Classroom 1.0 - WelcomeEMSSCORBUv1systemcopy_70_sr3_javaSantosh Kumari Resume 7y QA Expsoftware engineer, programmerfusioninventory-agent_windows-x64_2.3.2_en.pdfBPC IP.pdfpt850tadm-b0909Canham - Getting Started With R Practices for Maintaining Office 2010Orbix 3311 Admin Guide JavaConfio Ignite Oracle Aug2012Curso de Sem.-sem200 en Sembw350 What's New in SAP E-Recruiting 6.00Genopt-type56.pdfOracle WebLogic Server 11gData Recovery and High Availability Guide and Reference.pdfConfiguracion MMProgramsPowerGUI 3.5 UserGuideSkyEdge_DPS_Commands.pdfccaCadence Tools Command ReferenceFooter MenuBack To TopAboutAbout ScribdPressOur blogJoin our team!Contact UsJoin todayInvite FriendsGiftsLegalTermsPrivacyCopyrightSupportHelp / FAQAccessibilityPurchase helpAdChoicesPublishersSocial MediaCopyright © 2018 Scribd Inc. .Browse Books.Site Directory.Site Language: English中文EspañolالعربيةPortuguês日本語DeutschFrançaisTurkceРусский языкTiếng việtJęzyk polskiBahasa indonesiaSign up to vote on this titleUsefulNot usefulYou're Reading a Free PreviewDownloadClose DialogAre you sure?This action might not be possible to undo. Are you sure you want to continue?CANCELOK