After the installation finishes, some shortcuts are created with which you can conveniently launch JReport Server.
To start JReport Server using shortcut:
After you have installed JReport Server, many batch files are automatically generated in <install_root>\bin
. They are for assisting you with using and maintaining JReport Server. All of these batch files can be edited to suit different circumstances. However, make sure that you understand their functions when you want to edit them.
The following table lists the JReport Server launch files.
File | Description | Usage | Options |
---|---|---|---|
browser.bat | This tool detects the default client browser and installation path. It is invoked by launchpad.bat. | - | - |
CmdSender.bat CmdSender.sh |
This tool is for sending commands to JReport Server. If the option "-s" or "-p" is not used, the JVM system property "reporthome" must be defined so that CmdSender.bat/CmdSender.sh will use it to get data from the local machine. | cmdsender [-s:<server> -p:<port> -u:<user>] -w:<password> shutdown|localshutdown|(local:on|off) |
|
DBMaintain.bat DBMaintain.sh |
This tool is for administrators to back up and restore JReport Server data.
|
DBMaintain -[?|cleanup|B<[systemtables|realmtables|profiling]:<filename>>|R<[systemtables|realmtables|profiling]:<filename>>] |
|
DJRServer.bat DJRServer.sh |
This tool is used to launch JReport Server with debug and log information. The output log files are in the <install_root>\logs directory. In case of problems, you may run this batch to reproduce the problem. Open the files to see the detail information and find out the problem. Send the log files to support@jinfonet.com if you are unable to resolve the problem. |
DJRServer [-?|-p <port>|-ap <adminport>|-realm <realmname>|-l backlog|-m <max>|-t <timeout>|-s <filename>|-web <directory>|-env|-silent||-local|-vDebug|-vError|-jrs.admin.server <host:port>|-cleanup] |
|
JRServer.bat JRServer.sh |
This tool is used to launch JReport Server in standalone mode without any predefined options.
On Windows, you can start server by double-clicking on JRServer.bat. If you cannot start the server successfully in this way, the reason will be displayed in the MS-DOS command prompt. |
JRServer [-?|-p <port>|-ap <adminport>|-realm <realmname>|-l backlog|-m <max>|-t <timeout>|-s <filename>|-web <directory>|-env|-silent||-local|-vDebug|-vError|-logall|-jrs.admin.server <host:port>|-cleanup]
Notes:
|
|
jrenv.bat jrenv.sh |
This tool is for generating the report environment file report.env in the current directory. This file can help the Jinfonet support staff assist you when you run into problems. | - | - |
launchpad.bat | This tool is used to start JReport Server in the standalone mode and launch the JReport Server Start Page. | - | - |
makewar.bat makewar.sh |
See here. | - | - |
MigrationBV52.bat MigrationBV52.sh |
This tool is used to convert all the resources from JReport versions which are lower than V5.2 Build 590 to the resources of JReport Server V8. If you install the new version to the same folder as the old one, the parameter can be omitted. | MigrationBV52 [orgReportHome] |
|
MigrationV52.bat MigrationV52.sh |
This tool is used to convert all the resources of which the versions are between V5.2 Build 590 (included) and V6 (not included) to the resources of the latest JReport Server. If you install the new version to the same folder as the old one, the parameter can be omitted. | MigrationV52 [orgReportHome] |
|
NJRServer.bat NJRServer.sh |
This tool is used to launch JReport Server without JIT option. If your server often crashes with JIT option, try this batch file instead of JRServer.bat. | 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.server <host:port>|-cleanup] |
|
register.bat | It is invoked by browser.bat. | - | - |
RMIAuthFileCreator.bat RMIAuthFileCreator.sh |
This tool is used to generate the rmi authentication file. JReport Server uses the authentication file to secure remote objects. If no argument was provided, an authentication file named "rmi.auth" will be created in <install_root>\bin , using the user ID and install key of JReport Server. |
RMIAuthFileCreator [authFileName [userid key]] |
|
rp.bat rp.sh |
This tool is for replacing user ID and license key. | rp UID Key | - |
rptconv.bat rptconv.sh |
This tool is for converting old resources such as reports, visual analysis, library components, dashboards, catalogs etc. to be current version. | rptconv "-source=source_path" ["-target=destination_path"] [-r] [-s] |
|
startAdministration.bat | This tool is used to launch the JReport Administration page from the Start menu after the server is started. | - | - |
startConsole.bat | This tool is used to launch the JReport Console page from the Start menu after the server is started. | - | - |
stopServer.bat | This tool is used to exit JReport Server from the Start menu. | - | - |
stopServer.sh | This tool is used to exit JReport Server. | - | - |
Examples of running rptconv.bat/rptconv.sh to convert reports
rptconv "-source=C:\JReport\Server\jreports\Invoice Report.cls" "–target=C:\temp"
This will convert C:\JReport\Server\jreports\Invoice Report.cls to C:\temp\Invoice Report.cls.
rptconv "-source=C:\JReport\Server\jreports\Invoice Report.cls" "–target=C:\temp\1.cls.xml"
This will convert C:\JReport\Server\jreports\Invoice Report.cls, save the converted report to C:\temp
, and name it as "1.cls.xml" (if license allows).
rptconv "-source=C:\JReport\Server\jreports\Invoice Report.cls"
This will convert C:\JReport\Server\jreports\Invoice Report.cls, save the converted report in the same directory, and name it as "converted_Invoice Report.cls".
rptconv "-source=C:\JReport\Server\jreports\Invoice Report.cls" -r
This will overwrite C:\JReport\Server\jreports\Invoice Report.cls.
rptconv "-source=C:\JReport\Server\jreports" "–target=C:\temp"
This will convert all the resources in C:\JReport\Server\jreports and save the converted resources to C:\temp
. The converted resources use the same file names as source resources.
rptconv "-source=C:\JReport\Server\jreports" "–target=C:\temp" -s
This will convert all the resources in C:\JReport\Server\jreports and in the subdirectories and save the converted resources to C:\temp
. The converted resources take the same file names and directory structure as source resources.
rptconv "-source=C:\JReport\Server\jreports" "–target=C:\temp\*.cls" -s
This will convert all the resources in C:\JReport\Server\jreports and in the subdirectories and save the converted resources to C:\temp
. The converted resources take the same directory structure as source resources and the suffixes of their file names are all changed to ".cls".
rptconv "-source=C:\JReport\Server\jreports" -r -s
This will convert all the resources in C:\JReport\Server\jreports and in the subdirectories. The converted resources overwrite the source resources.
rptconv "-source=C:\JReport\Server\jreports"
This will convert all the resources in C:\JReport\Server\jreports. All the converted resources are saved in the same directory and named as "converted_SourceResourceName".
The usage is similar to converting a directory. You can specify the wildcard to filter resources, for example:
rptconv "-source=C:\JReport\Server\jreports\*.cls" "–target=C:\temp"
This will convert all the reports with the suffix ".cls" in C:\JReport\Server\jreports
and save the converted reports to C:\temp
.
Notes:
The class of the standalone server is jet.server.JREntServer. You can start JReport Server with the following command instead of using the generated batch files:
JAVA -classpath <classpath> -Djava.compiler=NONE -Dreporthome=<install_root> jet.server.JREntServer [options]
<install_root>\lib
: JRESServlets.jar; JREntServer.jar; JREngine.jar; javax.servlet-api-3.1.0.jar; log4j-core-2.7.jar; log4j-api-2.7.jar; <install_root>\bin
and check whether they are valid. Jslc.dat is the License control file. Open report.ini, and you will find the configuration information, including the temp, template and the help path. JReport will use the temp path to export the temporary files so you should make sure that the temp folder specified in report.ini exists and has space available.Option | Description |
---|---|
-? | Print brief help message. |
-p port | The port that this server listens on, default is 8888. |
-ap adminport | The port number that the remote administration uses, default is 8889. |
-l backlog | Maximum length of queue for incoming connection indications. |
-m max | Maximum number of connection handlers. |
-t timeout | Connection timeout in milliseconds. |
-s filename | Servlet property file name. |
-realm realmname | Active realm when the server starts up.
The specified realm should exist, otherwise the server will use an existing realm as the active realm. The server will then record a warning message in the log file, and set the selected active realm by the server.realm.active property in the server.properties file. |
-web directory | Web application server root directory, default is <install_root>\public_html . |
-local | Administration on local host only. |
-vDebug | Enables the JReport Engine to output messages to a file and sets engine log file's log level to INFO. |
-vError | Enables the JReport Engine to output messages to a file and sets engine log file's log level to ERROR. |
-env | Print environment settings when the server starts up. |
-silent | Outputs nothing, not even the server start information. |
-log[:file Name] (deprecated) | Outputs the JReport Engine messages to the log file as specified and uses the -vDebug level. |
-logall | Sets all loggers' log level to INFO. |
-jrs.admin.server host:port | The admin server host and RMI port. |
-cleanup | Checks integrality of the server data and cleans up the invalid data. |
Notes:
<install_root>\bin
.<install_root>\bin
directory.