Upgrade - SuperWEB2

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

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

Step 1 - Backup Old SuperWEB2 Configuration

It is quite likely that your existing SuperWEB2 installation will have multiple files you have modified from the defaults. You should backup these files before starting the upgrade.

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

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

You may wish to backup the whole of the <tomcat_home>\webapps\wepapi directory just in case.

The location of <tomcat_home> will depend on the location where Tomcat is installed on your system. The default location for Space-Time Research deployments of Tomcat is C:\ProgramData\STR\SuperWEB2\Tomcat

Step 2 - Prepare for Upgrade

1. Make sure Tomcat is not 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 SuperWEB2 8.0 format. 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.

Step 3 - Install SuperWEB2

1. Extract the SuperWEB2 ZIP file.
2. Copy War Files\webapi.war from the extracted files to <tomcat_home>\webapps
3. Copy tomcatLibs\spring-agent.jar from the extracted files to <tomcat_home>\lib
4. Start Tomcat and verify that you can connect to SuperWEB2 in a web browser.

Step 4 - Reapply any Customisations

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

Do not simply copy your backed up configuration files across, as there may have been other changes to these files in this release. You will need to re-apply your customisations to the new versions of the configuration 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 will see an error message similar to the following:

To resolve this:

1. Run Tomcat at least once so that the SuperWEB2 war file gets extracted.
2. Unzip the following .jar file: <tomcat_home>\webapps\webapi\WEB-INF\lib\userdata-repositoryservice.jar
3. Browse to the extracted files and locate userdata-repositoryservice\au\com\str\services\repository\dao\impl\sql\upgrade_8_0_1_<db>.sql (where <db> is the type of RDBMS you are using for the UDR).
4. Provide this file to your database administrator and ask them to execute the SQL commands to upgrade the databases to the correct version.

5. In addition, ask your database administrator to execute the following SQL:

   SQL

   TRUNCATE TABLE SCHEMAINFO;
   INSERT INTO SCHEMAINFO (ID, VERSION) VALUES (1, 2);
   

6. Once you have completed these steps you can delete the files you extracted from the .jar file (although do not delete the .jar file itself, as this is required to connect SuperWEB2 to the User Data Repository).