Running as a Standalone Server
This topic introduces three ways of running Logi JReport Server as a Standalone Server.
Below is a list of the sections covered in this topic:
Starting Using Shortcuts
After the installation finishes, some shortcuts are created with which you can conveniently launch Logi JReport Server.
To start Logi JReport Server using a shortcut:
- Double-click the shortcut for Logi JReport Server on your desktop.
- Select Start Server in the Logi JReport folder on the Start menu.
Starting Using Launch Files
After you have installed Logi JReport Server, many batch files are automatically generated in <install_root>\bin
. They are for assisting you with using and maintaining Logi 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 Logi 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 Logi 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 Logi 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 Logi 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] |
|
docker-container-migration.sh | See here. | ||
JRServer.bat JRServer.sh | This tool is used to launch Logi 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 Logi Analytics support staff assist you when you run into problems. | - | - |
launchpad.bat | This tool is used to start Logi JReport Server in the standalone mode and launch the Logi JReport Server Start Page. | - | - |
makewar.bat makewar.sh | See here. | - | - |
MigrationBV52.bat MigrationBV52.sh | This tool is used to convert all the resources from Logi JReport versions which are lower than V5.2 Build 590 to the resources of Logi 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 Logi JReport Server. If you install the new version to the same folder as the old one, the parameter can be omitted. | MigrationV52 [orgReportHome] |
|
MigrationTool.bat MigrationTool.sh | See here. | - | - |
NJRServer.bat NJRServer.sh | This tool is used to launch Logi 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. Logi 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 Logi 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] |
|
startConsole.bat | This tool is used to launch the Logi JReport Server console from the Start menu after the server is started. | - | - |
stopServer.bat | This tool is used to exit Logi JReport Server from the Start menu. | - | - |
stopServer.sh | This tool is used to exit Logi JReport Server. | - | - |
Examples of running rptconv.bat/rptconv.sh to convert reports
- To convert a single resource:
rptconv "-source=C:\JReport\Server\jreports\Payroll Report.cls" "–target=C:\temp"
This will convert C:\JReport\Server\jreports\Payroll Report.cls to C:\temp\Payroll Report.cls.
rptconv "-source=C:\JReport\Server\jreports\Payroll Report.cls" "–target=C:\temp\1.cls.xml"
This will convert C:\JReport\Server\jreports\Payroll 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\Payroll Report.cls"
This will convert C:\JReport\Server\jreports\Payroll Report.cls, save the converted report in the same directory, and name it as "converted_Payroll Report.cls".
rptconv "-source=C:\JReport\Server\jreports\Payroll Report.cls" -r
This will overwrite C:\JReport\Server\jreports\Payroll Report.cls.
- To convert all resources (reports, visual analysis, library components, dashboards, catalogs etc.) in a directory:
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".
- To convert a type of resources with same suffixes in a directory:
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 toC:\temp
.
Notes:
- There must be one and only one catalog file in the directory where the resources to be converted reside.
- If the resources to be converted contain UDO or UDF, make sure the corresponding classes or jars are included in the class path of rptconv.bat/rptconv.sh.
Starting Using Java
The class of the standalone server is jet.server.JREntServer. You can start Logi 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]
- -classpath
The classpath must include the following packages originally in your<install_root>\lib
: JRESServlets.jar; JREntServer.jar; JREngine.jar; jakarta.servlet-api-4.0.2.jar; log4j-core-2.9.1.jar; log4j-api-2.9.1.jar; - -Djava.compiler=NONE
This is without JIT. This is not a required option. However, if you encounter problems running the server and you think that they relate to the Java VM, you can try turning off the JIT compiler and then running again. - -Djreport.url.encoding
Specifies the encoding to encode/decode escape characters in URL strings. If not specified, the system default encoding will be used. For example:java ... -Djreport.url.encoding=8859-1...
- -Dreporthome
This is where Logi JReport Server is installed. It is the Destination Location you specified when you installed it. This option is required. When you set the reporthome, upon launching, Logi JReport will try to find the jslc.dat and report.ini files in<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. Logi 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. - -Dfile.encoding
Specifies the encoding to encode/decode escape characters in the server data. If not specified, the system default encoding will be used. For example:java ... -Dfile.encoding=8859-1...
- -Dresolution
Sets the system resolution in DPI. If not specified, the system default resolution will be used, which is the resolution of your monitor. For example,-Dresolution=96
. - [options]
Option Description -? Print brief help message. -p port The port that this server listens on, default is 8888. -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 Logi JReport Engine to output messages to a file and sets engine log file's log level to INFO. -vError Enables Logi 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 Logi 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:
- For detailed information on how to configure the logging and debugging information, read the LogConfig.properties file in
<install_root>\bin
. - Some of the common options will be used in later topics. In addition, Logi JReport has automatically generated some batch files for you so that you do not have to write a complicated command line. You can find these in the
<install_root>\bin
directory.