JasperReports Server Shell (JRSH)

JRSH is a Command Line Interface for JasperReports Server. It's designed for fast and easy interaction with JasperReports Server.

Requirements
Getting started
Frequently used operations
Specifying the file path on Windows

Requirements

Java >= 1.7 (Oracle or OpenJDK)

Getting started

This short guide will walk you through getting a basic usage of JRSH in different modes, and demonstrate some simple operations.

First, you need to download a zip file with actual snapshot and unpack it. The snapshot folder contains the next content:

├── jrsh.jar
├── jrsh
└── jrsh.bat

Second, you need to execute a bash script jrsh with parameters. The parameters determine in which mode the application will work. There are three different modes:

Script Mode
Tool Mode
Shell Mode

In Script mode you should specify a script file with *.jrs file extension. That file contains an operation sequence. The sequenced operations are performed one by one. To run the script just execute in your terminal:

$> jrsh --script /Users/alex/jrsh/scripts/my_script.jrs

Here is a script file example:

#################
# my_script.jrs #
#################
login superuser%superuser@localhost:8080/jasperserver-pro
export /public/Samples

In the Tool mode an application executes only one operation. To switch it you must specify a connection string which follows the format:

[username]|[organization]%[password]@[url] (organization is optional)

See usage example example below.

$> jrsh superuser%superuser@localhost:8080/jasperserver-pro \ 
   import \
   /Users/alex/file.zip

And the last mode is Shell. This is an interactive mode. It executes your operation until you interrupt the app using Ctrl+C key. To switch to Shell mode all you need is tospecify a connection string.

$> jrsh superuser%superuser@localhost:8080/jasperserver-pro

Frequently used operations

Import

This is most frequently used operation. It imports resources to JRS. You can import a zip file with resources or specify the folder with the unzipped resources to import.

Import examples:

Resources import

$> import /Users/alex/folder

Zip file import

$> import /Users/alex/archive.zip

Import resources with specifying import arguments

$> import /Users/alex/folder \ 
   with-update \ 
   with-skip-user-update \ 
   with-include-access-events

Export

Export operation is used to export resources from the JRS. You can specify which resource you want to export, and it is also possible to specify where you want to save it. Similar to Import operation, you can specify the arguments of Export operation.

Export examples:

Export repository

$> export repository /public/Samples/Reports/RevenueDetailReport

Export repository with specifying export arguments

$> export repository /public/Samples/Reports/RevenueDetailReport \ 
   with-include-access-events with-user-roles

Export repository with specifying an export file

$> export repository /public/Samples/Reports/RevenueDetailReport \
   to \
   /Users/alex/jrs/downloads/export.zip

Specifying the file path on Windows

Originally JRSH was created for Unix-like operation systems. Windows support was added later. So if your OS is Windows you should use a double backslash to separate subfolder and files. See example below:

$> import "D:\\Temp\\Jrsh\\import_archive.zip"

Here is the link with explanation why we should use double backslashes.

initialzero/jrsh