Upgrade Instructions

If you are not installing for the first time, here are the instructions for upgrading your installation:
  1. Download the files
  2. Upgrade the J2EE application JasperReportsIntegration.war
  3. Upgrade the database objects
  4. Upgrade the APEX test application

1. Download the files

As always, you first have to download the files from here and unzip them.

2. Upgrade the J2EE application JasperReportsIntegration.war

2.1. Make a backup

First, make a backup of all the configuration and report files in your existing environment.

2.2. A regular installation of the J2EE application

The next step is to install the J2EE application regularly as described in section 2. Installation in the J2EE server.

2.3. Copy your report files into the proper location

The report files from your backup need to be copied into the target reports directory. If you already have a shared configuration directory, then the J2EE application will already find the relevant files.

With regards to the conf/application.properties file it is best to use the new configuration file and manually transfer the old settings into the new configuration file.

There are new settings in the new configuration file which didn't exist in the old one before.

#====================================================================
# 2.3.0.0    D. Aust        08.04.2015    New config parameter:
#                                    - application.infoPageIsEnabled
#====================================================================

#====================================================================
# Application properties (global)
#====================================================================
[application]
configFileVersion=2.3.0
jndiPrefix=java:comp/env/jdbc/
# infoPageIsEnabled will show the initial start page of the j2ee application
# including testing and the environment settings
infoPageIsEnabled=true

#====================================================================
# JDBC datasource configuration
# http://www.orafaq.com/wiki/JDBC#Thin_driver
# type=jndi|jdbc
#====================================================================
[datasource:default]
type=jdbc
name=default
url=jdbc:oracle:thin:@127.0.0.1:1521:XE
username=my_oracle_user
password=my_oracle_user_pwd

#====================================================================
# Native JNDI datasource, to be configured in the application server
# name: jndi_test
#====================================================================
#[datasource:jndi_test]
#type=jndi
#name=jndi_test

#====================================================================
# JDBC datasource configuration
# http://www.orafaq.com/wiki/JDBC#Thin_driver
# additional jdbc configurations, please uncomment
#====================================================================
#[datasource:test]
#name=test
#url=jdbc:oracle:thin:@127.0.0.1:1521:XE
#username=my_oracle_user
#password=my_oracle_user_pwd

#====================================================================
# Direct printing
#====================================================================
[directPrinting]
isEnabled=false

# for debugging purposes does it make sense to display the
# print dialog ON THE SERVER before printing. You can even cancel the
# request through the print dialog
# DON'T do that in production (displayPrintDialog=true)!!!
displayPrintDialog=false

#====================================================================
# Save File on Server
#====================================================================
[saveFileOnServer]
isEnabled=false

# allow only certain directories on the server to write to
#directoryWhitelist=/Users/daust/oc-jasper/tmp,/Users/daust/oc-jasper

#====================================================================
## Syntax for specifying properties:
## http://commons.apache.org/configuration/userguide/howto_basicfeatures.html#Basic_features_and_AbstractConfiguration
#====================================================================

2.2. Restart the J2EE server

Restart the J2EE server, so that it will pick up the new configuration. It should be enough to restart the J2EE application only unless you have changed the environment of the J2EE server itself.

3. Upgrade the database objects

The database objects required for the integration have to be installed into each application schema that you want to use with the integration. Thus we have to upgrade all schemas that use the integration kit.

The installation instructions will refer to the application schema (in which you install the software) as [application schema]. The password for the application schema will be referred to as [application schema password].

Thus when I use an instruction like sqlplus [application schema]/[application schema password]@[database] please replace that with the actual values of your local installation. For example, if you want to install the integration kit into the schema HR with the password hr1 into your local XE instance (having a TNS entry named xe) then this instruction translates to:

sqlplus hr/hr1@xe

For a typical upgrade of an existing schema you don't have to do the installation as SYS. The user already has the proper rights and privileges. All you need to do is to upgrade the schema objects.

6.1 Database installation (Application Schema)

  1. Open a command shell:
    • e.g. on Windows: Start > Execute : cmd
  2. Go to the subdirectory patch (of where you extracted the file):
    • cd patch
  3. Connect as the application schema to the local instance (using sqlplus)
    • sqlplus [application schema]/[application schema password]@[database]
  4. Run the upgrade script
    • @patch.sql

4. Upgrade the APEX test application

The test application will allow for basic testing of the integration with all relevant parts. Install the application file apex\f121_JasperReportsIntegration-Test_x.x.x.x.sql into your workspace. You can just replace the existing one.