BackPrevious Page Next PageNext

Running as a Standalone Server

Starting using shortcuts

Starting using launch files

Starting using Java

Starting using shortcuts

After the installation finishes, some shortcuts are created with which you can conveniently launch JReport Server.

To start JReport Server using shortcut:

Starting using launch files

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)
  • -s
    The server host name.
  • -p
    The administration port.
  • -u
    The admin user name.
  • -w
    The admin password.
  • shutdown
    Shuts down the server.
  • localshutdown
    Shuts down the local server.
  • local
    The administration tasks are available to local host only.
  • gc
    Run the Java garbage collector.
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>>]
  • -?
    Displays the usage information and then exits.
  • -cleanup
    Checks integrality of the server data and cleans up the invalid data.
  • -Bsystemtables:<filename>/-Brealmtables:<filename>/-Bprofiling:<filename>
    Backs up the data in the database with the related data to a specified file.

    For example, for backing up the server data realmtables to file c:\jsback.dat, you can type:

    DBMaintain -Brealmtables:c:\jsback.dat

  • -B0realmtables:<filename>
    Only backs up the data in the realm database.
  • -Rsystemtables:<filename>/-Rrealmtables:<filename>/-Rprofiling:<filename>
    Restores the data including the related data outside the database from a specified file.

    For example, for restoring server data realmtables from the file c:\jsback.dat, you can type:

    DBMaintain -Rrealmtables:c:\jsback.dat

  • -R0realmtables:<filename>
    Only restores the data in the realm database.
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]
  • -?
    Prints this help message.
  • -p <port>
    The port number to listen on.
  • -ap <adminport>
    The port number which is used by the administration tools.
  • -realm <realmname>
    Specifies the active realm.
  • -l <backlog>
    The maximum queue length for incoming connections.
  • -m <max>
    The maximum number of connection handlers.
  • -t <timeout>
    The connection timeout in milliseconds.
  • -s <filename>
    The servlet property file name. If this option is not used, the file servlet.properties in <install_root>\bin will be used as the servlet property file when launching JReport Server.
  • -web <directory>
    The root directory when accessing the server via the web. Its default value is <install_root>\public_html.
  • -env
    Prints the environment.
  • -silent
    No output is sent to the console.
  • -local
    The administration tasks are available on local host only.
  • -vDebug
    Enables the JReport Engine to output messages to a file and sets all log files' log level to INFO.
  • -vError
    Enables the JReport Engine to output messages to a file and sets all log files' log level to ERROR.
  • -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.
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:

  • You may need to set an appropriate -Dfile.encoding option in the file to start JReport Server in order to view characters correctly.
  • 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.
  • -?
    Prints this help message.
  • -p <port>
    The port number to listen on.
  • -ap <adminport>
    The port number which is used by the administration tools.
  • -realm <realmname>
    Specifies the active realm.
  • -l <backlog>
    The maximum queue length for incoming connections.
  • -m <max>
    The maximum number of connection handlers.
  • -t <timeout>
    The connection timeout in milliseconds.
  • -s <filename>
    The servlet property file name. If this option is not used, the file servlet.properties in <install_root>\bin will be used as the servlet property file when launching JReport Server.
  • -web <directory>
    The root directory when accessing the server via the web. Its default value is <install_root>\public_html.
  • -env
    Prints the environment.
  • -silent
    No output to the console.
  • -local
    The administration tasks are available on local host only.
  • -vDebug
    Enables the JReport Engine to output messages to a file and sets all log files' log level to INFO.
  • -vError
    Enables the JReport Engine to output messages to a file and sets all log files' log level to ERROR.
  • -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.
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]
  • orgReporthome
    The reporthome of the original JReport Server. If this parameter is not provided, the value of "reporthome" of new JReport Server will be used as its value.
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]
  • orgReporthome
    The reporthome of the original JReport Server. If this parameter is not provided, the value of "reporthome" of new JReport Server will be used as its value.
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]
  • -?
    Prints this help message.
  • -p <port>
    The port number to listen on.
  • -ap <adminport>
    The port number which is used by the administration tools.
  • -realm <realmname>
    Specifies the active realm.
  • -l <backlog>
    The maximum queue length for incoming connections.
  • -m <max>
    The maximum number of connection handlers.
  • -t <timeout>
    The connection timeout in milliseconds.
  • -s <filename>
    The servlet property file name. If this option is not used, the file servlet.properties in <install_root>\bin will be used as the servlet property file when launching JReport Server.
  • -web <directory>
    The root directory when accessing the server via the web. Its default value is <install_root>\public_html.
  • -env
    Prints the environment.
  • -silent
    No output to the console.
  • -local
    The administration tasks are available on local host only.
  • -vDebug
    Enables the JReport Engine to output messages to a file and sets all log files' log level to INFO.
  • -vError
    Enables the JReport Engine to output messages to a file and sets all log files' log level to ERROR.
  • -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.
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]]
  • ?
    Shows the usage message.
  • authFileName
    The RMI authentication file name. If only input this argument, the user ID and install key of JReport Server will be used to create the authentication file.
  • userid
    The user ID, which will be used to generate the contents of the authentication file.
  • key
    The key which will be used to generate contents of the authentication file.
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]
  • -source
    Specify the source path of the resources that are to be converted.
  • -target
    Specify the destination path for the converted resources.
  • -r
    Replace the source resource with the converted version.

    If this option is set, ["-target=destination_path"] is ignored.

    If both "-r" and "-target" are not specified, the converted resources are saved in the same directory as the source resources and named as "converted_SourceResourceName".

  • -s
    Convert all the resources in the specified directory, including the resources in all subdirectories.
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

Notes:

Starting using Java

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]

Notes:

BackPrevious Page Next PageNext