User Guide

Jaspersoft Integration
Version Control
Date Changed by Version Page Comments

Combining the three installation and setup

19 January 2022 Rebecca Neil 1 All
guides into one guide and reformatting all.

07 February 2022 Ed Kovalev 2 All Reviewed document

Adjusted document to resolve comments

14 February 2022 Rebecca Neil 3 All
made during review.
Adjusted document to resolve comments
22 February 2022 Rebecca Neil 4 All
made during review.

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 2 of 82

Contents
1 Overview................................................................................................................................... 5
2 Installation of Jaspersoft Reporting...........................................................................................6
2.1 ROOT functions and process - Create user jsadmin on a client server.............................6
2.2 Granting user jsadmin root permission via the visudo file..................................................6
2.3 Download the correct Jasper Report install file for Linux....................................................6
2.4 Granting ownership of the installation file to user jsadmin..................................................6
2.5 Making the TIB_js-jrs-cp_7.8.0_linux_x86_64.run executable...........................................7
2.6 Creating required directories..............................................................................................7
2.7 Granting ownership of the new directories to user jsadmin................................................7
2.8 Sourcing the correct Oracle JDBC driver for Jasper Reports.............................................7
2.9 Running the Jasper Reports installation file on the client server........................................8
2.10 Jasper Reports Setup Wizard............................................................................................8
2.11 Sourcing the correct font jar file for Jasper Reports.........................................................13
2.12 Updating the default font for Jasper Reports....................................................................13
2.13 Starting Jasper Report server..........................................................................................14
2.14 Installation of Apache Log4j 2 Logging Library.................................................................15
2.15 Enabling the Jaspersoft service on bootup.......................................................................16
2.16 Opening the Jaspersoft Server reporting service via Google Chrome..............................17
3 Configuration of the Jaspersoft Server....................................................................................18
3.1 Installation of Jaspersoft Server on a Clients Server........................................................18
3.2 Jaspersoft Server Status..................................................................................................18
3.3 Start/Stop using jasper.service Linux Service..................................................................19
3.4 Changing the Port Number..............................................................................................20
3.5 SSL.................................................................................................................................. 21
3.6 Creation of a new Jasper Admin User..............................................................................21
3.7 Microlistics WMS Report Manager Configuration.............................................................24
3.7.1 Configuring the ISIS.config file..................................................................................24
3.7.2 Running and Validating field_install..........................................................................25
3.7.3 Microlistics WMS General Parameters......................................................................30
3.7.4 Running of a Default Report......................................................................................31
3.7.5 Installing client icons.................................................................................................32
4 Building and Deploying Jaspersoft Reports.............................................................................34
4.1 Jaspersoft Server............................................................................................................. 34
4.2 Jaspersoft Studio Installation...........................................................................................34
4.3 Setting up Jaspersoft Studio............................................................................................34
4.3.1 Data Adaptor Connection Creation...........................................................................34
4.3.2 Server Connection Creation......................................................................................40

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 3 of 82

 4.4 Creating a new Jaspersoft Report....................................................................................43
4.5 Editing the report.............................................................................................................. 55
4.5.1 Altering Text Fields...................................................................................................55
4.5.2 Adding a Static Text or Text Field to a report............................................................56
4.5.3 Adding another elements..........................................................................................60
4.5.4 Adding icons............................................................................................................. 60
4.5.5 Previewing the Report...............................................................................................64
4.5.6 Compiling the Report................................................................................................64
4.6 Publishing the report to the Jaspersoft Server.................................................................66
4.7 Verifying the Report Published to the Jaspersoft Server..................................................71
4.8 Running the report via the Report Manager.....................................................................75
4.9 Modifying a Published Report..........................................................................................76
5 Troubleshooting...................................................................................................................... 78
5.1.1 Report Manager........................................................................................................78
5.1.2 Jaspersoft Server......................................................................................................79
5.1.3 ERequest Details......................................................................................................80
6 Additional References............................................................................................................. 81

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 4 of 82

1 Overview
Jaspersoft has been adopted as the standard reporting engine for Microlistics WMS as the
previous reporting method (igen reports) is both inflexible and outdated.

Jaspersoft integration allows a modern and flexible reporting framework for developers and
power users to create and adjust warehouse operation reports and is available in modern
releases (i.e., 5.0_dublin and later).

This user guide is broken into three sections:

Installation of Jaspersoft Reporting

This section provides instruction how to install Jaspersoft on to a client’s server and
is the starting place when a new system is required to have Jaspersoft installed.

This section is required to be completed by a Microlistics Administrator.

Configuration of Jaspersoft server

This section will guide the implementer through the process of configuring Jaspersoft
Reports after the installation of the server is complete.

This section is required to be completed by a Microlistics Implementor.

Building and Deploying Jaspersoft Reports

This section provides the necessary steps on how to start with Jaspersoft Studio and
build custom reports.

This section is required to be completed by a Microlistics Implementor.

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 5 of 82

2 Installation of Jaspersoft Reporting
The following provides the instructions on how to install Jaspersoft Reporting on to a
client’s server. This section should be completed by a Microlistics Administrator.

2.1 ROOT functions and process - Create user jsadmin on a client server
To create the jsadmin user on the client server, the following steps are required to be
completed:

1. Log into the client server as root

2. At the prompt type sudo su – press enter
3. Type useradd jsadmin – press enter

2.2 Granting user jsadmin root permission via the visudo file
To grant user jsadmin root permission via the visudo file, the following steps are required
to be completed:

1. Remain within your current location

2. At the prompt type visudo – press enter
3. Type I (eye) to edit the visudo file – press enter
4. Scroll to find the following string ## Allow root to run any commands anywhere
5. Place the cursor underneath the user root
6. Type jsadmin ALL=(ALL) ALL – press enter
7. Press - esc
8. Type :wq! – press enter to save the changes made to the visudo file

Note
Using the :wq! command saves all changes made to a Linux file when using the vi text editor. If
you don’t wish to save your changes, press esc, type :q! then press enter.

2.3 Download the correct Jasper Report install file for Linux
The instructions to download the Jasper Report installation file for Linux are below:

1. Go to URL: https://community.jaspersoft.com/project/jasperreports-server/releases
2. Find and select the file TIB_js-jrs-cp_7.8.0_linux_x86_64.run
3. Complete the Jaspersoft Registration Process
4. Then after completing the registration process, FTP the file to the /usr/local/ directory
on the client’s server

2.4 Granting ownership of the installation file to user jsadmin

The following details how to grant ownership of the installation file to the jsadmin user:

1. At the prompt type cd /usr/local/ - press enter

2. Type chown jsadmin.jsadmin TIB_js-jrs-cp_7.8.0_linux_x86_64.run - press enter

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 6 of 82

2.5 Making the TIB_js-jrs-cp_7.8.0_linux_x86_64.run executable
The following steps detail how to make the run file executable:

1. Remain in the directory /usr/local/

2. At the prompt type chmod +x TIB_js-jrs-cp_7.8.0_linux_x86_64.run - press enter

Note
Items highlighted within the red border shows that the jaspersoft installation file is now executable
and is owned by user jsadmin as explained in steps 7.4 & 7.5 respectively.

2.6 Creating required directories

The following details how to create the required directories:

1. As root, remain in directory /usr/local/

2. At the prompt type mkdir jasperreports-server-7.8.0 - press enter
3. Now type cd jasperreports-server-7.8.0 – press enter
4. At the prompt type mkdir apache-tomcat – press enter
5. Now type cd apache-tomcat – press enter
6. At the prompt type mkdir lib – press enter

2.7 Granting ownership of the new directories to user jsadmin

The following details how to grant ownership of the new directories to the jsadmin user:

1. At the prompt type chown jsadmin.jsadmin jasperreports-server-7.8.0 - press

enter

Note
Items highlighted within the red border indicate that the user jsadmin now has ownership rights
of the newly created directory jasperreports-server-7.8.0 including the two subdirectories apache-
tomcat and lib as explained in steps 7.6 & 7.7 respectively.

2.8 Sourcing the correct Oracle JDBC driver for Jasper Reports
The following details how to find and download the required driver for Jaspersoft Reports:

1. Go to URL -
https://jar-download.com/artifacts/com.oracle.ojdbc/ojdbc8/19.3.0.0/source-
code
2. Download the file ojdbc8-19.3.0.0.jar to a directory on your pc
3. Once you have the file, ftp the ojdbc8-19.3.0.0.jar file into directory
/usr/local/jasperreports-server-7.8.0/apache-tomcat/lib on the client server

Note
If you’re unable to copy the ojdbc8-19.3.0.0.jar file into the /apache-tomcat/lib directory due to
permission restrictions, use the chmod 777 command to make the directories readable, writable and

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 7 of 82

 executable for everyone.

2.9 Running the Jasper Reports installation file on the client server
The following details how to run the installation file on the client’s server:

1. As root navigate to the /usr/local/ directory

2. When at the prompt type ./TIB_js-jrs-cp_7.8.0_linux_x86_64.run - press enter
3. Now follow the steps as outlined in the next step

2.10 Jasper Reports Setup Wizard

The below provides instruction on the actions to be taken when running the Jasper
Reports Setup Wizard:

Step Example image Required user action

1
Message:
“Welcome to the
JasperReports Server CP
7.8.0 Setup Wizard…”

User Action:
Press [Enter] to continue

2
User Action:
Press [Enter] to continue

3
User Action:
Press [Enter] to
continuedopn

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 8 of 82

 4
User Action:
Press [Enter] to continue

5
User Action:
Press [Enter] to continue

6
User Action:
Press [Enter] to continue

7
User Action:
Press [Enter] to continue

8
User Action:
Press [Enter] to continue

9
User Action:
Press [Enter] to continue

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 9 of 82

 10
User Action:
Press [Enter] to continue

User Action:
11
Press [Enter] to continue

12
User Action:
Press [Enter] to continue

13
User Action:
Press [Enter] to continue

14
User Action:
Press [Enter] to continue

15
User Action:
Press [Enter] to continue

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 10 of 82

 16
User Action:
Press [Enter] to continue

17
User Action:
Press [Enter] to continue

18
User Action:
Press [Enter] to continue

19
User Action:
Press [Enter] to continue

20
User Action:
Press [Enter] to continue

21
User Action:
Press [Enter] to continue

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 11 of 82

 22
User Action:
Press [Enter] to continue

23
User Action:
Press [Enter] to continue

24
User Action:
Press [Enter] to continue

25
User Action:
Press [Enter] to continue

26
User Action:
Enter option [1]

27
User Action:
Create an installation
directory within the
/usr/local/ directory

For example type:

/usr/local/jasperreports-
server-7.8.0-Installation
as the installation
destination folder

Then press Enter

28
User Action:
Press [Enter] to continue

29
User Action:
Enter Y to continue

30
User Action:
Enter y to continue

31
User Action:
Enter Y to continue

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 12 of 82

 32
User Action:
Press [Enter] to continue

33
User Action:
Enter Y to continue:

34
User Action:
Await installation of
Jasper Reports – “0% to
100%”

Enter n to continue

35
Jasper Reports setup now
completed

2.11 Sourcing the correct font jar file for Jasper Reports
The following details how to source the correct font jar file:

1. Go to the URL:
https://wisetechglobal.sharepoint.com/:f:/r/sites/Acquisitions/Microlistics/Projects/
Projects/06%20Internal/JasperSoft%20implementation/Jasper%20Report%20Guide
%20-%20Impl/final?csf=1&web=1&e=G1zqPt
2. Download the file mWMSFont.jar to a directory on your pc
3. Once you have the file, ftp the mWMSFont.jar file into directory
/usr/local/jasperreports-server-7.8.0/apache-tomcat/webapps/jasperserver/
WEB-INF/lib on the client server.

Note
If you’re unable to copy the mWMSFont.jar file into the
/apache-tomcat/webapps/jasperserver/WEB-INF/lib directory due to permission restrictions, use
the chmod 777 command to make the directories readable, writable and executable for
everyone.

2.12 Updating the default font for Jasper Reports

The following details how to update the default font:

1. Navigate to
/usr/local/jasperreports-server-7.8.0/apache-tomcat/webapps/jasperserver/
WEB-INF/classes directory as jsadmin user
2. At the prompt type vim + jasperreports.properties - press enter
3. Press o to start editing the file
4. Copy and paste the following two lines into the file:
net.sf.jasperreports.default.font.name = mWMSFont
© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 13 of 82
 net.sf.jasperreports.default.font.size = 10
5. Press Esc to exit inserting mode
6. Press :q! to save the change

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 14 of 82

 Note
The vim + jasperreports.properties command will jump to the last line of the file:

The o command will start inserting a new line:

Adding two properties in the file:

After saving the change, please run command cat jasperreports.properties to confirm the two
properties exist in the file

2.13 Starting Jasper Report server

The following details how to start the Jasper Report server:

1. Now navigate to the newly created Jasper reports installation directory as outlined in
6.10, step 27.
2. For example, /usr/local/jasperreports-server-7.8.0-Installation

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 15 of 82

 3. Once you’re within the installation directory, type ./ctlscript.sh start – press enter

Note
The ctlscript.sh script is found in the installation folder created in table section T1.27 and once
triggered the apache-tomcat services are activated and confirmed by an automated message as
per below:

2.14 Installation of Apache Log4j 2 Logging Library

By default, Jaspersoft Server version 7.8.0, will be using the Apache Log4j 2 logging
library (version 2.13.3) which has a known security issue.

Apache Log4j 2 logging library therefore needs to be updated, to version 2.16.0, the steps
to do this are below:

1. Login to the Linux server as the jsadmin user

2. Stop the Jaspersoft Server by running systemctl stop jasper.service

3. Go to the <jasper-server-installation>/apache-tomcat/webapps/jasperserver/WEB-
INF/lib/ directory by typing:

cd jasper-server-installation>/apache-tomcat/webapps/jasperserver/WEB-
INF/lib/

4. Delete the seven 2.13.3 version log4j jar files in this directory as below:

rm -f log4j-1.2-api-2.13.3.jar log4j-core-2.13.3.jar log4j-jul-

2.13.3.jar log4j-web-2.13.3.jar log4j-api-2.13.3.jar log4j-jcl-
2.13.3.jar log4j-slf4j-impl-2.13.3.jar

5. Download the log4j-2.16.0.zip file to your local PC.

The URL to download this file is:

https://wisetechglobal.sharepoint.com/:f:/r/sites/Acquisitions/Microlistics/Projects/
Projects/06%20Internal/JasperSoft%20implementation/Jasper%20Report%20Guide
%20-%20Impl/final?csf=1&web=1&e=UjeLRD

6. Unzip the log4j-2.16.0.zip file. It will have seven jar files:

 log4j-1.2-api-2.16.0.jar
 log4j-api-2.16.0.jar
 log4j-core-2.16.0.jar
 log4j-jcl-2.16.0.jar

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 16 of 82

  log4j-jul-2.16.0.jar
 log4j-slf4j-impl-2.16.0.jar
 log4j-web-2.16.0.jar

7. FTP (in binary mode), the seven jar files to <jasper-server-installation>/apache-

tomcat/webapps/jasperserver/WEB-INF/lib/

8. Check that the log4j jar files in 2.16.0 version exist under the <jasper-server-
installation>/apache-tomcat/webapps/jasperserver/WEB-INF/lib/ directory, for
example:

[jsadmin@pixie lib]$ pwd

/usr/local/jasperreports-server-7.8.0/apache-tomcat/webapps/
jasperserver/WEB-INF/lib
jsadmin@pixie lib]$ ls -la log4j*
-rwxrw-r-- 1 jsadmin jsadmin 207909 Dec 15 14:05 log4j-1.2-api-
2.16.0.jar
-rwxrw-r-- 1 jsadmin jsadmin 301892 Dec 15 14:05 log4j-api-2.16.0.jar
-rwxrw-r-- 1 jsadmin jsadmin 1789565 Dec 15 14:05 log4j-core-
2.16.0.jar
-rwxrw-r-- 1 jsadmin jsadmin 12847 Dec 15 14:05 log4j-jcl-2.16.0.jar
-rwxrw-r-- 1 jsadmin jsadmin 30977 Dec 15 14:05 log4j-jul-2.16.0.jar
-rwxrw-r-- 1 jsadmin jsadmin 24258 Dec 15 14:05 log4j-slf4j-impl-
2.16.0.jar
-rwxrw-r-- 1 jsadmin jsadmin 35359 Dec 15 14:05 log4j-web-2.16.0.jar

9. Start the Jaspersoft Server by running systemctl start jasper.service.

10. Confirm that the Jaspersoft Server is up and running by accessing the URL:
http://<jasper-server-ip>:<jasper-server-port>/jasperserver/login.html

2.15 Enabling the Jaspersoft service on bootup

The following details how to enable the Jaspersoft service on bootup:

1. Go to the general drive located on Phoenix:\general\Implementation\JasperSoft\

Software
2. Copy the “jasper.service” file and paste it into the following directory
/etc/systemd/system on the client’s server
3. Log into the client’s server and navigate to the directory /etc/systemd/system
4. At the prompt type systemctl daemon-reload – press enter

Note
Alternative ways to start and stop the Japsersoft service from within the /etc/system/system
directory.

To manually start the Jaspersoft service

At the prompt type – systemctl start jasper.service – press enter

To manually stop the Jaspersoft service

At the prompt type – systemctl stop jasper.service – press enter

To enable auto-start on-boot

At the prompt type – systemctl enable jasper.service – press enter

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 17 of 82

2.16 Opening the Jaspersoft Server reporting service via Google Chrome
The following details how to open the Jaspersoft Server reporting service via Google
Chrome:

1. Open Google chrome

2. Now type the client IP address into the empty URL field followed by
:8080/jasperserver/login.html – press enter

You can click on “Need help logging in ?” and default logins are : jasperadmin /
jasperadmin

Note
When a client IP is entered into the URL field as per the image below, the Jaspersoft Server
splash screen appears and is ready to be utilised.
- EG: 10.70.0.70:8080/jasperserver/login.html

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 18 of 82

3 Configuration of the Jaspersoft Server
The Jaspersoft Server installation will be completed by a Microlistics administrator on all
client server boxes, following the instructions provided in the above section.

Instructions to find the service, start and stop the service, and the check status of the
service is provided below:

3.1 Installation of Jaspersoft Server on a Clients Server

The installation of the Jaspersoft Server is done as the Linux user jsadmin who is
provided the privileges to start and stop the Jaspersoft Server.

A Linux systemd service named jasper.service is created so that the jsadmin user can
start and stop the Jaspersoft Server.

Note
Only the user jsadmin is to be used to start and stop the Linux services created for
JasperServer. Credentials will be provided by the Microlistics administrator post installation.

3.2 Jaspersoft Server Status

Once the installation is completed, ensure that the Jaspersoft server is running on the
required port for the client:

Note
The default port used once the installation is completed is 8080. If any other service is already
running on this port for the client, then this port number will need to be changed to a new port in
the tomcat directory. This is covered in section 3.4.

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 19 of 82

3.3 Start/Stop using jasper.service Linux Service
The below section will detail how to stop and start the jasper.service Linux service:

1. To check if Jasper Reports Server is installed, first see if the below Jaspersoft Server
URL is accessible.

http[s]://{hostname}:{port}/jasperserver/login.html

2. If the link is not accessible, then it means that the Jaspersoft Server is not installed or
not running.

3. To check if the Jaspersoft Server (jasperserver) is running, from the Linux command
line, type the bellow:

ps -ef | grep jasperserver

The jsadmin user should show that the jasperserver is running as shown below:

[jsadmin@pixie conf]$ ps -ef | grep jasperserver

jsadmin 1199049 1198581 0 May25 ? 00:00:20 postgres:
jasperdb jasperserver 127.0.0.1(9008) idle
jsadmin 1199084 1198581 0 May25 ? 00:00:24 postgres:
jasperdb jasperserver 127.0.0.1(9024) idle
jsadmin 1557740 1556137 0 20:40 pts/17 00:00:00 grep --
color=auto jasperserver
jsadmin 2214186 1198581 0 May26 ? 00:00:22 postgres:
jasperdb jasperserver 127.0.0.1(31290) idle

If server is not running, then need to connect to the Jaspersoft Server with the
jsadmin user and start the server.

4. To start or stop the Jaspersoft Server use the Linux system service jasper.service as
the jsadmin user:

a. Login to the Jaspersoft Server with the user jsadmin

b. Check if the systemd Linux service for the Jaspersoft Server exists (this will be
created by the administer during installation and if it does not exist then report this
to the administrator, so it is created). To check if the jasper.service is present,
type:

cd /etc/systemd/system
ls jasper.service

The above command should then list the jasper.service as shown below:

[jsadmin@pixie system]$ cd /etc/systemd/system

[jsadmin@pixie system]$ pwd
/etc/systemd/system
[jsadmin@pixie system]$ ls jasper.service
jasper.service

c. If the jasper.service is present, then start the Jasper Service using the below
command:

systemctl start jasper.service

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 20 of 82

 d. To stop the service, use the below command:

systemctl stop jasper.service

e. To check if the service is started and running, then use the below command:

systemctl status jasper.service

This command will show the Jasper Service as active when started as shown
below:

[jsadmin@pixie system]$ systemctl status jasper.service

jasper.service - The Jasper Service
Loaded: loaded (/etc/systemd/system/jasper.service; enabled;
vendor preset: disabled)
Active: active (exited) since Fri 2021-05-21 12:01:33 AEST; 2
weeks 3 days ago
Main PID: 1437284 (code=exited, status=0/SUCCESS)
Tasks: 0 (limit: 199990)
Memory: 12.5M
CGroup: /system.slice/jasper.service

Warning: Journal has been rotated since unit was started. Log
output is incomplete or unavailable.

5. If any errors occur when the service is started, these can be identified by looking at the
service logs. Any errors should be reported to the Microlistics Administrator to be
resolved.

a. To show the entire log, use the following command:

journalctl -u jasper.service

b. To show the last logs, use the following command:

journalctl -u jasper.service -f

Note
Once the Jaspersoft Server is started and if a report failure happens, any server logs should
be checked and provided when an issue is reported. The logs can be found in:

<jasper-server-installation>/apache-tomcat/logs/catalina.out

3.4 Changing the Port Number

If there is a service is already running on the default port (8080), the port number for the
Jaspersoft Server can be altered and set to 8085. Once the port is changed, the server
will need to be stopped and restarted using jasper.service to make sure the change is
applied.

To change the port number:

1. Go to the /{jasperserver_installation_directory}/apache-tomcat/conf/ directory and

open the server.xml file in Linux.

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 21 of 82

 2. Edit the line as shown below in the server.xml file and change the port to the required
port number:

<Connector port="8080" protocol="HTTP/1.1" connectionTimeout="20000"

redirectPort="8443"/>

Note
Once the port is changed, for the changes to take effect, the Jaspersoft Server needs to be
stopped and restarted using jasper.service.

3.5 SSL
If SSL is not required, then SSL will not be used and by default, SSL is not enabled in the
Jaspersoft Server.

If SSL is required, then the client’s SSL certification will need to be provided for
installation.

To enable SSL:

1. The Microlistics Administrator will need to enable SSL at the server side and the
provided certificate will need to be installed.

Further information about this is in the below link:

Enabling SSL in Tomcat | Jaspersoft Community

2. Then the ISIS.config file will need to be altered as detailed in section 3.7.1 of this
document.

3. The report manager will require extra configuration which is detailed in section 3.7.3 of
this document.

3.6 Creation of a new Jasper Admin User

The creation of a new jasper admin user is recommended instead of using the default
user. The following steps detail how to create the new user:

1. Select Manage and then Users as shown below:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 22 of 82

 2. And then select Add User:

3. The Add Users screen will then be displayed, enter all required details, and then
press Add User:

Note
The default user is jasperadmin which is created as a part of the Jaspersoft
Server installation. The username and password for default is jasperadmin.

4. The new Jasper admin user must be provided the ADMINISTRATOR role. This can
be done by selecting the newly created user and then select Edit:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 23 of 82

 5. The ADMINSTATOR role can then be selected in the Roles Available and then click
the > button to move it to the Roles Assigned section, press Save once complete:

6. Once the new admin user is created, switch across to it by selecting the new user in
the screen below and then selecting Login as User:

7. The default admin user should then be disabled or deleted which can also be done in
the above screen by selecting the default admin user and then pressing the Delete
User button or unclicking the User is enabled option:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 24 of 82

 Note
The field installation step will need configuration for the new jasper admin user
with the newly created username and password in the ISIS.config file as
mentioned in Section 6.7.1 point 1 when the new jasper admin user is created.

An example is shown below:

3.7 Microlistics WMS Report Manager Configuration

Once the above installation is completed, the Microlistics WMS Report Manager needs to
be configured. This section provides the initial setup for testing Jasper reports via the
Report Manager and how to debug and test the reports.

3.7.1 Configuring the ISIS.config file

The below details the settings required for the ISIS.config file:

Before field_install is run, it must be first checked that the ISIS.config file (located in
$ISIS_HOME) is configured with the correct parameters and added as required:

The parameters that can be configured in the ISIS.config file are:

jasper = --ssl -pro -port {jasperserverport} -j {jaspermagician} -p

{password} -o {remote_oracle_host_ip}

For example:

jasper = --ssl –pro -port 8085 -j jsadmin123 -p somepassword123 -o

10.70.4.25

The parameter details are below:

--ssl is provided if SSL is enabled

--pro is provided in the cases where the client already has installed the
jasperserver-pro edition (--pro is used only if there is an existing
professional license version installed. If it’s the Community Edition that is
installed, -pro is not required to be used)
-j sets the newly created jasper admin user
-p sets the newly created password for jasper admin
© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 25 of 82
 -port sets the new port if not using the default port.
-o sets the remote oracle host ip address/host name

Note
Ensure to configure these parameters as required if not using the default values. If using the
default port, the default jasper admin user, if no SSL is enabled, not using Jaspersoft Server
professional license version, and not connecting to a remote oracle host, then no configuration
as above is required in the ISIS.config file.

3.7.2 Running and Validating field_install

Once the ISIS.config file is set as required, field_install must be run as per standard to
install the required build.

After field_install has been successfully run, it is then required to login to the Jaspersoft
Server and validate if the Directories, Data source, Users, Server attributes and Icons
have been created as required:

1. Login to the Jaspersoft Server.

Note
To login to the Jaspersoft Server, the login URL is:
http[s]://{hostname}:{post}/jasperserver/login.html

a. Select View and then select Repository:

b. Check if the directory mWMS is created in the Jaspersoft Server as shown below:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 26 of 82

 c. Check if the mWMS datasource is created under the root mWMS directory
(/mWMS/mWMS) as shown below:

d. Check if the /mWMS/Icons directory is created as shown below:

e. Check if the $ISIS_ORACLE_USER has been created by the jasper_install script

(this script is run via the field_install script and does not need to be run
separately).

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 27 of 82

 Note
The $ISIS_ORACLE_USER can be found by selecting Manage, Users

f. Select View and then Repository and check if the $ISIS_ORACLE_USER

directory under mWMS is created. Also check if the Custom, Client_Icons and
Site_local directories under the $ISIS_ORACLE_USER directory have been
created:

g. All the report files will be deployed to the respective directories under the Custom
folder. Check if the respective report unit with a Type of “Report” are present in
the mWMS/$ISIS_ORACLE_USER/Custom directory:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 28 of 82

 h. Select Manage and Server Settings:

i. Select Server Attributes, and check that the following server attributes have been
created and set to the correct values as shown below:

mWMS_Schema
mWMS_Database
mWMS_Password

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 29 of 82

 j. A default client icon will be copied from the default icons directory i.e.,
/mWMS/Icons to the mWMS/$ISIS_ORACLE_USER/Client_Icons for all clients in
the $ISIS_ORACLE_USER schema, to check this:

Go to View and then select Repository:

Find the directory for the $ISIS_ORACLE_USER and then select Client_icons:

k. It must also be validated that the Oracle server and the Jasper Installation are on
the same box or not. If setup on different boxes, a manual correction of the
datasource URL in the datasource connector created by the jasper_install script is
required to be done as below:

1. To change the localhost value in the datasource URL, select mWMS in the
Repository and then selecting the Edit button:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 30 of 82

 2. The Edit Data Source Properties screen is then displayed and the value in
the URL field is required to be altered, changing localhost to the host name
where oracle is installed:

3. Once the required changes are made, then the connection can be tested by
selecting Test Connection.

4. All changes should be saved by select the Save button.

3.7.3 Microlistics WMS General Parameters

The following parameters are required to be added for Microlistics WMS to connect with
the installed Jaspersoft Server:

JASPER_SERVER: The default value is “jasperserver” which is for the Community

Edition. This parameter is used in cases where the jasperserver-pro version has already
been installed, in this case the value needs to be set to jasperserver-pro in this case.

JASPER_SERVER_PORT: The port where the Jaspersoft Server is running – the default
value is 8080. If the port has been set to a different number, then this parameter also
needs to be set to the same value.

JASPER_SERVER_HOST: The default host value, this is usual set to localhost, as it is

expected that the Jaspersoft Server will usually be running on the same box as the oracle
database.

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 31 of 82

 JASPER_SERVER_SSL: If SSL is to be enabled this value needs to be set to ‘Y’. By
default, SSL is not enabled, and this parameter does not then need to be set.

An example is shown below of the setting of the above parameters:

Updat
Parameter Value Description
e
Constant value for
JASPER_SERVER jasperserver Y
JASPER_SERVER
This is the host server where
JASPER_SERVER_HOS
localhost jasper server has been Y
T
installed and running
JASPER_SERVER_POR
8080 Jasper server port no Y
T

3.7.4 Running of a Default Report

A default report called CLIENT can be setup and run to check that the Jaspersoft Server
installation has been successful.

The steps to create this report are below:

1. Via SQL Developer, create a record in the IS_PRINTS_NAME table as shown below:

Note
The CLIENT, PRINT_QUEUE and ID should be set as required.

2. Via SQL Developer, create a record in the IS_RPT_REQUEST table as shown below
to generate the report:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 32 of 82

 Note
The REQUEST_NUMBER and CLIENT fields should be set as required.

3. Start up the Report Manager via the usual method and ensure that the CLIENT.PDF
file is generated in the spool directory of $ISIS_HOME. If the report is generated, this
means that the Jaspersoft Server Installation is a success.

4. The PERFORMED field in the IS_RPT_REQUEST table will be updated with system
date once the report is generated successfully.

3.7.5 Installing client icons

The default client icons created under mWMS/$ISIS_ORACLE_USER/Client_Icons
directory can be replaced with new icons if required. Any image format such as JPEG,
GIF, and PNG can be used.

The script client_icon (which is located in the $ISIS_HOME/tools directory) is used to

install new client icons.

Note
Client icons need to have the same name as the spelling of the IS_CLIENT.CODE that
that the report is being generated for as Jaspersoft Reports will only recognise client icons
that have this naming.

1. To install a client icon, the following command is required to be run if the jasperadmin
user, port and the other usage params are defaulted:

client_icon -c <LogoName> {directory_path}/filename.jpg

For example:

client_icon -c 0021051 /share/home/delta_logo.jpg

2. If any of the default values have been altered, then the command should be run as
below:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 33 of 82

 client_icon --ssl -port {portnumber} -u {username} -c <LogoName>
{directory_path}/filename.jpg

3. Once the log has been installed, it will appear the on the Jaspersoft Server under the
users schema, under the Client_Icons directory:

Note
The usage of the client_icon script, can be found by typing: client_icon -help

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 34 of 82

4 Building and Deploying Jaspersoft Reports
The following section will detail how to build and deploy Jaspersoft Reports:

4.1 Jaspersoft Server

Ensure that the Jaspersoft Server is installed and running on the server, section 3
provides instructions on how to check.

4.2 Jaspersoft Studio Installation

To install TIBCO Jaspersoft® Studio 6.16.0, go to the below link and download
the .exe file:

https://community.jaspersoft.com/project/jaspersoft-studio/releases

The file to download:

Accept the license and install (the directory that the software is installed is up to the user
installing the software).

4.3 Setting up Jaspersoft Studio

Jaspersoft Studio requires two connections before reports can be created:
 Data Adapter: Required to test the report being created.
 Servers: Required to deploy the report to the Jaspersoft Server.

4.3.1 Data Adaptor Connection Creation

To create a Data Adaptor connection:

1. In the Repository Explorer, click on Data Adapters and then right click and select
Create Data Adapter:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 35 of 82

 2. When the Data Adapter Wizard is displayed, select Database JDBC Connection
and then press Next:

3. Provide the schema connection details:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 36 of 82

 Details should be entered as detailed below:

Name: Enter the same name as the username of the database

JDBC Driver: Enter oracle.jdbc.driver.OracleDriver
JDBC Url: Enter jdbc:oracle:thin:@HOST_NAME:ORACLE_SID for example
jdbc:oracle:thin:@10.70.4.20:1521:YETI
Username: Enter the username of the database schema
Password: Enter the password of the database schema

An example is shown below:

4. Next the JDBC driver details are required to be provided, to do this:

a. Go to the below URL:

https://wisetechglobal.sharepoint.com/sites/Acquisitions/Microlistics/Projects/
_layouts/15/download.aspx?
UniqueId=158b1a625bce4be28199a4b7a6ceb88f&e=IsQlR5

b. Download the file ojdbc8-19.3.0.0.jar to a directory on your pc.

c. Once the file is downloaded, select Driver Classpath as shown below:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 37 of 82

 d. Then select Add:

e. In the File Browser screen as shown below, locate the file downloaded in step 4b
above and then select Open:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 38 of 82

 f. Once the Data Adapter Wizard is redisplayed, select Test:

g. A sucessful message should then appear and once this appears select OK.

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 39 of 82

 h. Then press Finish:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 40 of 82

 i. Then the Data Adaptor will get created as shown below:

4.3.2 Server Connection Creation

The below details how to create a connection to the Jaspersoft Server via Jaspersoft
Studio. This will allow new reports to be created and deployed:

1. Under the Repository Explorer, click on Servers, and then right click and select
Create JasperReports Server Connection:

2. When the JasperReports Server Access Configuration Popup is displayed, enter:

URL: URL of the Jaspersoft Server

User: Username of the Jasper Admin User
Password: Password of the Jasper Admin User

An example is shown below:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 41 of 82

 3. Click on Test Connection, and then the connection will be tested and then a
Successful message should be displayed as shown below:

4. Click on OK, and then Finish to complete the creation of the connection.

5. Once connection is established, the reports can be viewed that are already publi+
6. shed to the Jaspersoft Server under the mWMS/$ISIS_ORACLE_USER/directory.

a. To view these reports, double on mWMS as shown below:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 42 of 82

 b. Then locate the directory for the $ISIS_ORACLE_USER and then double click on
the Custom directory and similar to the below will be shown:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 43 of 82

4.4 Creating a new Jaspersoft Report
This section provides the instructions to create a new report:

Note
If any of the views shown below are not shown, then using Help and searching for the
required view (for example Outline view) will provide the instructions on how to display the
view.

1. In JasperSoft Studio, select the Project Explorer tab:

2. Then click on the New button and select Project:

Then the New Project Wizard will be shown:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 44 of 82

 3. Select the JasperReports Project, then press Next:

4. Enter the Name of the Project to be created and then press Finish.

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 45 of 82

 5. The new project will then be created and can be seen in the Project Explorer as below:

Once the project is created, then a Jaspersoft Report can then be created, to do this:

1. In the Project Explorer, select the project just created, and then right click and select
New and then select Jasper Report:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 46 of 82

 2. The New Report Template Wizard will then be displayed, select Simple Blue and
then press Next:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 47 of 82

 3. Ensure that the correct Project is selected and then enter a name for the report to be
created in the File Name field and then press Next:

4. In the Data Source screen, select the Data Adaptor created above in the Data
Adaptor list:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 48 of 82

 5. Then the following will be displayed:

There are two options to provide a data source for the report being created:

 Provide a direct data source

 Create a dataset separately

a. To provide a direct data source, in the below screen, ensure the correct Data
Adaptor is selected and then on the right-hand side of the screen, enter the query
that will be used as the basis of the new report:

Then press Next, and then the Fields screen will be displayed:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 49 of 82

 Select the fields from the left side of the screen and then press the > button to
move the fields to the right side of the screen:

After the > is pressed is shown below:

Press Next and then the Group By options can be selected, select a field to group
by (if required) and then press the > button:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 50 of 82

 All required information is now collected for the report, and the Finish screen is
then displayed stating this. Press the Finish button to continue:

And then the following will be displayed:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 51 of 82

 b. To provide a dataset separately, in the below screen, ensure the correct Data
Adaptor is selected and then press Finish:

When Finish is pressed, then the below will be displayed:

To provide the dataset to be used, then select the DataSet and Query editor
dialog button:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 52 of 82

 Select this button and then the Dataset and Query Dialog screen will be displayed:

In this screen, select the Dataset to be used by selecting the required adaptor from
the dropdown box:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 53 of 82

 On the right side of the screen, the SQL statement to select the required fields from
the required table should be added:

Then press the Read Fields button:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 54 of 82

 When the Read Fields button is pressed, the bottom section of the screen will then
be populated with the fields from the SQL query:

Press OK to continue and then the report will again be shown in Design mode:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 55 of 82

 Note
The second method of creating a dataset will create a virtually blank report, and each of
the fields required on the report will then manually need to be added, by adding Text
Boxes and assigning each field to the text box. For training purposes, it is best that the
first method be used as it will create a more complete report.

4.5 Editing the report

The report can now be edited to make changes:

4.5.1 Altering Text Fields

Text fields can be altered by doubling clicking in the required field and then altering the
text. For example, in the report generated above to change the Title of the report from
TITLE to Client Details, double click in the TITLE field and then change the text as shown
below:

Once this is done, the report will then look like the below:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 56 of 82

 Alternatively, the field can be selected, then in the bottom left section of the screen, select
the Static Text tab and then in the Text field alter the value:

Other fields can be deleted by click on the required field and then pressing delete. For
example, deleting the text Add a description here has been done below:

4.5.2 Adding a Static Text or Text Field to a report

A static text or text field can be added to report, this is done by selecting the Static Text or
Text Field option in the Palette view to the right-hand side of the screen, then dragging
this to the required position on the report:

1. Select the Text Field option:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 57 of 82

 2. Then drag to the required position on the report:

3. Then change the value in the Text Field by either double clicking on it and altering
the value or using the Text Field tab in the bottom right of the screen and changing
the Text Field Expression value:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 58 of 82

 Then a similar thing can be done to add the values of the field which are selected from the
query that was used to create the dataset, for example if want to add another Text field
which is populated with the client code from the IS_CLIENT table, then this is done by:

1. Add another Text Field as detailed above:

2. Then select the Text Field just added and in the bottom right-hand side of the screen,
select the Text Field tab:

3. Press the Expression Editor at the end of the Expression field:

4. The Expression Editor will then be displayed:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 59 of 82

 5. In the Expression Editor, double click on the field that the Text Field should be
populated by:

And then the Expression field should then be populated with this value as shown above.

6. Press Finish in the Expression Editor and then the report should look similar to the
below:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 60 of 82

 7. Continue adding more Text Fields and setting to the required values until all fields are
added.

4.5.3 Adding another elements

Other elements can be added to the report such as lines, page numbers etc.

These are all added by similar methods to the adding of a text field.

For example, if want to add an extra line to the report, then select Line from the Palette at
the top right of the screen and then drag it to the required position on the report.

Similar can be done for Page Numbers.

4.5.4 Adding icons

To add an icon to a report:

1. Select the Image option from the Palette on the right-hand side of the screen:

2. Then drag to the required position on the report, once this is done, the Create new
image element popup will be displayed:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 61 of 82

 3. Select the Select a resource from JasperReports Server and then press OK.

4. Select the icon in the Options section:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 62 of 82

 5. Then in the Find Resources popup locate the icon to be added, for example:

6. Then press Finish, then the Create new image element popup should again be
displayed, this time with the Option field populated:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 63 of 82

 7. Press OK and then the icon will be added to the report as shown below:

Note
New icons can be added to the Jaspersoft Server Repository by following the instructions
in section 6.7.5.

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 64 of 82

4.5.5 Previewing the Report
At any time, the report can be previewed, by selecting the Preview option as shown
below:

When this is selected, then the report will be shown as below where the final version of
the report can be viewed and adjusted as required, ensure that the Data Adaptor is set to
the correct value:

4.5.6 Compiling the Report

Once the report is completed, it should be compiled to ensure that the report does not
have any errors before it is published to the Jaspersoft Server.

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 65 of 82

 To compile the report:

1. Select the Compile option as shown below:

2. At the bottom of the report, will show the results of the compile:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 66 of 82

4.6 Publishing the report to the Jaspersoft Server
Once the report has been viewed and compiled in Jaspersoft Studio, the report can then
be published to the Jaspersoft Server to the client schema connection that was created in
section 4.3.2.

Once the report is published to the Jaspersoft Server, then the report can be tested via
the Microlistics WMS Report Manager.

The steps below detail how to publish the report:

1. On the Design tab of the Main Report, press the Publish Report to JasperReports
Server button:

2. Once this is selected, then the Publish To JasperReports Server wizard will be
displayed. Select the user schema from the list provided. To do this first click on the
Server Connection, this will then display similar to the below:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 67 of 82

 3. Then click on the mWMS option and select the schema from the list displayed and
then select the Custom directory:

4. Ensure that the Create Report Unit button is ticked and then press Next:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 68 of 82

 5. Select the Resources to publish and the Publish Strategy should be set to Ignore as
shown below:

6. Press Next and then in the Configure the data source screen, select the Data
Source from Repository option and then click the icon:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 69 of 82

 7. In the Find Resource screen, click on mWMS:

8. And the click on the > symbol next to mWMS and then select the mWMS option and
then press Finish:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 70 of 82

 9. The Configure Data Source screen should then be displayed with the Data Source
from Repository field populated with /mWMS/mWMS:

10. Then click Finish:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 71 of 82

 11. A message should then be displayed, stating Success! and that the resources were
published to the Jaspersoft Server:

4.7 Verifying the Report Published to the Jaspersoft Server

The next step is to verify that the report has been correctly published to the Jaspersoft
Server.

The steps to do this are detailed below:

1. Login to the Jaspersoft Server (http[s]://{hostname}:{post}/jasperserver/login.html) with

the jasper admin user.

2. Next, the schema user must be logged in as to run the report in the Jaspersoft Server,
to do this:

a. Select Manage, and then Users as shown below:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 72 of 82

 b. When the Manage Users screen is displayed, locate the schema from the list
displayed and click on it:

c. Then press Login as User on the right-hand side of the screen:

d. The user that was just selected to log in as should then be displayed at the top of
the screen, when the Repository screen is then redisplayed after selecting Login
as User is pressed:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 73 of 82

 3. The report can now be run via the Jaspersoft Server, to do this:

a. In the Repository Folder List, click on mWMS:

b. Then from the list of folders displayed, select the correct user, in this example it is
natpharma and then select the Custom folder:

The right-hand side of the screen will then display all the reports available.

c. Find the report that was created in section 4.4 as shown below:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 74 of 82

 Then click on the report and then press Run:

d. The report will then be displayed from the Jaspersoft Server which verifies that the
report can be generated and run from the Jaspersoft Server:

e. Then click Back to return to the Repository.

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 75 of 82

4.8 Running the report via the Report Manager
Once the report has been successfully generated by the Jaspersoft Server, it can then be
setup to be created via the Report Manager in Microlistics WMS.

The steps below detail how to do this:

1. A record first needs to be created in the Printer Reports screen (menu option: 509)
for the report. An example is below:

2. A record then needs to be created via SQL Developer in the IS_RPT_REQUEST

table. An example is shown below:

Note

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 76 of 82

 For the above record, the REQUEST_NUMBER field should be set to the next
number in the sequence otherwise a unique constraint error could occur on insert of
the record.

3. Ensure that the Report Manager is running, and the report manager will then process
the request created in the IS_RPT_REQUEST table and when the request is
processed, then the PERFORMED field will be updated to the date/time that the
request was processed.

4. The generated report can then be viewed in the Printer Spooler (menu option: 557) in
the Microlistics GUI as shown below:

4.9 Modifying a Published Report

A published report can be modified if required. This is done via the Jaspersoft Studio.

The steps to modify a report are detailed below:

1. In Jaspersoft Studio, go to the Repository Explorer and locate the report to be

altered.

For example, to alter the report created above, then click on:

Servers > mWMS > natpharma > Custom > Example_client_report

And then the following will be displayed.

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 77 of 82

 Double click on the Main jrxml file to open it:

2. Alter the report by altering the dataset to add more fields (see section 4.5 for more
information).

3. Add additional fields to the report (see section 4.5.2 for more information).

4. Once finished modifying the report, preview it (see section 4.5.5 for more
information), compile it (see section 4.5.6) for more information, then publish it to the
Jaspersoft Server (see section 4.6).

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 78 of 82

5 Troubleshooting
5.1.1 Report Manager
The following details which log files to check if an issue is found with the generation of the
test report:

Note
All log files referred to in the below are in the $ISIS_HOME/errorlogs directory.

 For any error that occur before the call that is triggered from the Report Manager to
the Jaspersoft Server to fetch the report, will log details in the:
- dat file,
- IS_ERRORLOG table and log file

 For any error that was received as response for the call once the request is triggered
from the report manager, logs to the:
- dat file,
- the IS_ERRORLOG table and log file
- creates an html file for error response received from Jaspersoft Server.

An example of the error reporting in the REPORT_MANAGER.dat file is below:

An example of the error reporting in the REPORT_MANAGER.log file is below:

The Jasper error response body is saved to below path as a HTML file in below format:

$ISIS_HOME/errorlogs/incidents/REPORT_MANAGER_$
{ISIS_ORACLE_USER}_yyyymmdd_hh24miss.html

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 79 of 82

 An example is shown below:

5.1.2 Jaspersoft Server

Any exception received from the Jaspersoft Server can be checked in the Jaspersoft
Server logs to see the exception stack trace.

The log files can be found in the jasper server installation tomcat directory as below:

<jasper-server-installation>/apache-tomcat/logs/catalina.out

The catalina.out log file will have the latest logs.

Old log files can also be checked for exceptions and are timestamped for example:

catalina.2022-01-24.log

Example of the log file is below:

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 80 of 82

5.1.3 ERequest Details

For any issues that arise during report generation post Jaspersoft Server installation and
running of the Jaspersoft Server.
Provide the below information whenever a problem arises:

 $ISIS_HOME/errorlogs/REPORT_MANAGER.debug
 $ISIS_HOME/errorlogs/REPORT_MANAGER. {$ISIS_ORACLE_USER }.dat
 $ISIS_HOME/errorlogs/REPORT_MANAGER. {$ORACLE_SID}.
{$ISIS_ORACLE_USER}.log
 $ISIS_HOME/errorlogs/incidents/REPORT_MANAGER_$
{ISIS_ORACLE_USER}_yyyymmdd_hh24miss.html (if created for the error for
whatever datetime it matches)
 extract_o of the associated order
 catalina.out or catalina-{datetime}.log – as per the error occurred timing

For any issues that arises when trying to start jasper.service

Any error that happens when trying to start the jasper.service can be identified by
executing the below commands to see the service logs. Please notify the Microlistics
administrator who did initial install of the issues along with any errors logged:

 To show the entire log:

journalctl -u jasper.service

 To find the last logs:

journalctl -u jasper.service -f

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 81 of 82

6 Additional References
Below are additional resources which may also be helpful:

Getting Started with Jaspersoft Studio | Jaspersoft Community

Documentation | Jaspersoft Community

© 2022 Microlistics – part of the WiseTech Global group. Jaspersoft Integration | 82 of 82