These instructions explain how to install and set up SuperWEB2 on Apache Tomcat. If you are an end user of SuperWEB2 then you do not need to follow these steps–your system administrator will already have set up SuperWEB2; all you need to connect is your web browser. See the SuperWEB2 User Guide for more information.
These are the instructions for installing just SuperWEB2. Alternatively, on Windows as a quick start option you can install the SuperSTAR Suite. This installs all the SuperSTAR applications, including SuperWEB2, the Java Runtime Environment, and Apache Tomcat, as part of a single install process.
- For full details of the system requirements for SuperSTAR, refer to Installation Requirements, Compatibility and Supported Platforms.
SuperWEB2 requires the following third party software:
You will need to ensure that the firewall rules are configured appropriately to allow connections to the machine running Tomcat. By default, Tomcat uses port 8080. For more information about the ports used by the entire SuperSTAR suite, see Port Usage.
Step 1 - Install Tomcat
Before you can install SuperWEB2 you need to install Tomcat. There is a Tomcat deployment supplied with SuperWEB2, or you can use the latest supported version downloaded directly from the Tomcat website.
WingArc Australia recommends that you independently assess the security requirements for any network exposed computer application and take appropriate steps to protect it. Refer to the official Tomcat documentation for more details about the security aspects of Tomcat.
To install the Tomcat deployment supplied with SuperWEB2:
- Extract the SuperWEB2 ZIP file.
Copy the Tomcat directory from the extracted files to the location where you want to install Tomcat and SuperWEB2.
On Windows the standard installation location is C:\ProgramData\STR\SuperWEB2\Tomcat (this is the location used if you install SuperWEB2 using the SuperSTAR Suite installer), but you can choose a different location if you prefer.On Linux, choose an appropriate location to install Tomcat, such as /opt/Tomcat.
Step 2 - Install SuperWEB2
- Extract the SuperWEB2 ZIP file if you have not already done so.
Copy War Files\ webapi.war from the extracted files to <tomcat_home>\webapps
The location of <tomcat_home>\webapps will depend on where you have installed Tomcat on your system. On Windows if you are using the standard installation location it will be C:\ProgramData\STR\Tomcat\webapps:
webapi.war contains all the SuperWEB2 files. Its contents will be extracted to <tomcat_home>\webapps\webapi when you start Tomcat.
- Copy tomcatLibs\spring-agent.jar from the extracted files to <tomcat_home>\lib
- (Windows only) Go back to the files you extracted from the SuperWEB2 ZIP and locate the tomcatScripts directory, then copy the four files from this directory (sw2.bat , sw2-install-service.bat , sw2-service.bat and sw2-uninstall-service.bat ) to <tomcat_home>\bin :
Step 3 - Set Environment Variables
To run Tomcat and SuperWEB2 you need to set the value of the following environment variables:
The location where Tomcat is installed
|The location of either the Java Development Kit or Java Runtime Environment on your system, depending on which one you are using.|
Follow the appropriate steps below, depending on whether you are using Windows or Linux.
You can either set
JAVA_HOME as Windows system environment variables, or you can set them in the supplied scripts for launching Tomcat / SuperWEB2.
To set the values in the scripts, locate the following lines in sw2.bat, sw2-install-service.bat and sw2-uninstall-service.bat:
rem set CATALINA_HOME=C:\ProgramData\STR\SuperWEB2\Tomcat rem set JAVA_HOME=C:\Program Files\AdoptOpenJDK\jdk-22.214.171.124-hotspot rem set JRE_HOME=C:\Program Files\Java\jre11
Remove the comments and set the value of
CATALINA_HOME to match the location of <tomcat_home> on your system, and set either
JRE_HOME to match the location of Java on your system.
set CATALINA_HOME=C:\ProgramData\STR\SuperWEB2\Tomcat set JAVA_HOME=C:\Program Files\Java\jdk-11.0.9 rem set JRE_HOME=C:\Program Files\Java\jre11
On Linux, set the environment variables to match the locations of Java and Tomcat on your system
export JAVA_HOME="/usr/lib/jvm/java-11" export CATALINA_HOME="/opt/Tomcat"
Step 4 - Start Tomcat/SuperWEB2
You are now ready to start Tomcat and SuperWEB2. You can either start Tomcat manually or install it as a Service that will start automatically when the machine starts.
Windows: Start Tomcat Manually
Go to <tomcat_home>\bin and execute sw2.bat.
If you do not want to use the supplied batch file, you can create your own script for running Tomcat.
- Go to the <tomcat_home>\bin directory and create a file called setenv.bat
Edit the file in a text editor, and define the Tomcat environment variables. For example:CODE
set CATALINA_HOME=C:\ProgramData\STR\SuperWEB2\Tomcat set CATALINA_OPTS=-javaagent:"%CATALINA_HOME%\lib\spring-agent.jar" -Dorg.omg.CORBA.ORBClass=org.jacorb.orb.ORB -Dorg.omg.CORBA.ORBSingletonClass=org.jacorb.orb.ORBSingleton -Djacorb.home="%CATALINA_HOME%\webapps\webapi\WEB-INF\classes" -Djava.net.preferIPv4Stack=true -Xmx2G -XX:MaxPermSize=512m -Dfile.encoding=UTF-8
Make sure you change the value of CATALINA_HOME to match the location of <tomcat_home> on your system.
- Save the batch file.
You can now start Tomcat by executing the standard catalina.bat script supplied with the Tomcat installation (located in <tomcat_home>\bin). It will automatically detect and load your environment variable settings from setenv.bat.
Windows: Install the Service
Follow these steps to set up Tomcat as a Windows service:
Go to <tomcat_home>\bin and execute sw2-install-service.bat. This will install a Windows service called SuperWEB2.
You must execute sw2-install-service.bat with administrator permissions, otherwise it will not be able to install the Windows service.
Go to the Windows Services console and start the service.
Linux: Start Tomcat
On Linux, first make sure that catalina.sh in <tomcat_home>/bin is set as an executable file. You may need to run a command similar to the following to change the properties if not:
chmod a+x catalina.sh
Once the startup script is properly configured, start Tomcat from the <tomcat_home>/bin directory as follows:
Alternatively, to start Tomcat in the background, use the following command:
Step 5 - Verify the Installation
Verify that SuperWEB2 is installed by opening a web browser. The default URL for SuperWEB2 is http://<hostname>/webapi or http://<hostname>:<port>/webapi (where
<hostname> is the server running the SuperWEB2 application and
<port> is the port to connect on).
By default, you should be able to connect to SuperWEB2 using http://localhost:8080/webapi
Verify that you can login to SuperWEB2 and open a dataset.
If this is a new installation you can login using the default user1 test account. Learn more about the default user accounts.
If you have installed SuperWEB2 on a different machine to SuperSERVER, you must configure the SuperWEB2 connection to SuperSERVER.
Step 5 - Post Install Configuration
Once you have completed the installation, there are some required changes you should make before you go into production:
- Configure the User Data Repository (UDR). The UDR is used to save user tables and custom groups (recodes). By default it is configured to use an embedded H2 database. Although this is adequate for demonstration and testing purposes, it must be replaced with a full RDBMS system such as SQL Server or Oracle for production use (some features are not supported with the embedded H2 database). Learn more...
facelets.DEVELOPMENTparameter in <tomcat_home>\webapps\webapi\WEB-INF\web.xml to false. Learn more...
- Update the support email address in the login error messages. Learn more...
- Apply your corporate branding to the SuperWEB2 interface, and configure your own branded templates for downloading tables, maps and graphs. Learn more...
- Disable Tomcat session persistence. Session persistence across restarts of the Tomcat server is enabled by default in the Tomcat configuration. You should disable this feature before using SuperWEB2 in production. Learn more...
- Update <tomcat_home>\bin\sw2.bat (copied at Step 2) to include JVM startup recommendations. Learn more...
In addition, if you anticipate that SuperWEB2 users will build and populate very large tables, consider implementing the Job Queue Manager. This component is subject to additional licensing. Learn more...