Upgrade

This section describes how to upgrade to the latest version of SuperWEB2 from an earlier version.

You must upgrade both SuperSERVER and SuperADMIN before upgrading to SuperWEB2. Learn more about upgrading SuperSERVER.

Step 1 - Plan for the Upgrade

When you upgrade SuperWEB2, it is generally not possible to simply copy across the modified configuration files from your old version. After upgrading you will need to merge your configuration changes into the new versions of the files.

Before starting, it is a good idea to make a note of all the configuration adjustments you have made to your existing system.

To avoid downtime, you may wish to leave your existing deployment running while you install the new release of SuperWEB2 on a new sever. This will allow users to continue to access your system while you complete the upgrade.

Once you have finished applying the relevant configuration adjustments to the new server you can then redirect users to the new version.

Step 2 - Backup Old SuperWEB2 Configuration

Although you will not be able to reuse the configuration files from your old version, you should backup these files before starting. If necessary, this will allow you to check any customisations that you had made to the old version, or roll back to the previous version if necessary.

The following files are the minimum subset that you should backup:

• Any language customisations you have made to <tomcat_home>\webapps\webapi\WEB-INF\common_labels.properties, <tomcat_home>\webapps\webapi\WEB-INF\database_labels.properties and <tomcat_home>\webapps\webapi\WEB-INF\message.properties (and the corresponding versions for other languages)

• Any custom UDF and TXDs saved in <tomcat_home>\webapps\webapi\WEB-INF\resources

• Any HTML info pages saved in <tomcat_home>\webapps\webapi\info

• Any customisations you have made to the metadata pages in <tomcat_home>\webapps\webapi\help

• All files in <tomcat_home>\webapps\webapi\WEB-INF\data\.repository

• <tomcat_home>\webapps\webapi\WEB-INF\classes\configuration.properties 

• <tomcat_home>\webapps\webapi\WEB-INF\web.xml

• <tomcat_home>\webapps\webapi\WEB-INF\faces-config.xml

However, you are recommended to backup the whole of the <tomcat_home>\webapps\webapi directory just in case.

The location of <tomcat_home> will depend on the location where Tomcat is installed on your system. For example, the default location on Windows is C:\ProgramData\STR\SuperWEB2\Tomcat

Step 3 - Install SuperWEB2

1. Stop Tomcat if it is running.

2. Delete the following files and directories (some of these files may not exist on your system, depending on which version you are upgrading from):

   • <tomcat_home>\work

   • <tomcat_home>\lib\hsqldb-*.jar

   • <tomcat_home>\lib\webservices-rt.jar

   • <tomcat_home>\lib\spring-agent.jar

   • <tomcat_home>\webapps\webapi

   • <tomcat_home>\webapps\webapi.war

3. If applicable, prepare the User Data Repository for the upgrade by making sure that the SuperWEB2 user that writes to your external database has both ALTER and CREATE privileges over the tables in that database. If your database administrator will not allow the SuperWEB2 user to have ALTER and CREATE privileges, you will need to manually upgrade the databases. See the steps below for more information.

   

   If you are not sure which user is configured for the connection to the external User Data Repository, check the details specified in <tomcat_home>\conf\server.xml

   

   When you run SuperWEB2 it will automatically update any saved data in the User Data Repository to the latest version. This process is not reversible, so you may wish to backup your data from the external database first in case you ever need to revert to the previous version of SuperWEB2.

4. Extract the SuperWEB2 ZIP file.

5. Copy War Files\webapi.war from the extracted files to <tomcat_home>\webapps

6. Start Tomcat and verify that you can connect to SuperWEB2 in a web browser.

Step 4 - Reapply Customisations

You will now need to reapply any customisations from your previous deployment.

Do not simply copy your backed up configuration files across. The files have changed in this release. You will need to recreate your customisations by merging your changes with the new versions of the files.

Manual Upgrade of User Data Repository

If your database administrator will not allow the SuperWEB2 user to have CREATE TABLE and ALTER TABLE privileges, then you will need to manually upgrade the tables in the User Data Repository database.

If SuperWEB2 does not have the appropriate privileges, you may see an "insufficient privileges" error message similar to one of the following in the SW2.log file:

Caused by: java.sql.SQLException: ORA-01031: insufficient privileges

au.com.str.services.repository.exception.SchemaUpdateException: Failed to perform automatic UDR setup from file sql/sw2/upgrade_9_18_0_mssql.sql. Manual database setup may be required. 

To resolve this, you can either temporarily grant the SuperWEB2 database user the required additional permissions, or if this is not an option contact WingArc Support for assistance and we can advise you how to manually run the SQL scripts on the database.

Step 5 - Advise Users that the Upgrade is Complete

Once you have finished reapplying any customisations, you can advise your users that the upgrade is complete. In some cases, users may need to manually refresh their browsers to see the latest version of SuperWEB2. This is because their web browser may have cached the resources from the previous version (such as the product logo and the stylesheets).

If users are still seeing the old look and feel of SuperWEB2, this can be resolved in most cases by pressing F5 (or Ctrl-F5) to refresh the web browser.