There are two methods for upgrading a server that has been deployed to Apache Tomcat.

For instructions on new installations for Tomcat, see Apache Tomcat Example Deployment.

Recommended Method

If you deployed the SOAtest and Virtualize Server using the method described in Apache Tomcat Deployment Example 1 (Recommended Method), use the following instructions to upgrade the WAR file.

1. Stop Tomcat Server and locate the <SOAVIRT_HOME> directory.
2. Copy the config.properties file from the <SOAVIRT_HOME>/WEB-INF directory to a temporary location.
3. Backup the workspace folder to a temporary location outside the <SOAVIRT_HOME> directory.
   • This is only required if the working.dir property in the config.properties file is not specified. See working.dir for details.
4. Delete the contents of the <SOAVIRT_HOME> directory. 
5. Extract the contents of the new WAR file into <SOAVIRT_HOME>.
6. Replace the config.properties file in the <SOAVIRT_HOME>/WEB-INF directory with the config.properties file from step 2.
7. Open the config.properties file and verify the license configuration.
8. If you backed up the workspace folder in step 3, copy the workspace folder back into <SOAVIRT_HOME>.
9. Start Tomcat (for example, from <TOMCAT_HOME>/bin).

Shortcut Method

If you deployed the SOAtest and Virtualize Server using the method described in Apache Tomcat Deployment Example 2 (Shortcut Method), use the following instructions to upgrade the WAR file.

1. Stop Tomcat Server and locate the <TOMCAT_HOME>/webapps/ROOT directory.
2. Backup the workspace folder to a temporary location outside the ROOT directory.
   • This is only required if the working.dir property in the config.properties file is not specified. See working.dir for details.
3. Delete the contents of the <TOMCAT_HOME>/webapps/ROOT directory.
4. Extract the contents of the new WAR file into <TOMCAT_HOME>/webapps/ROOT.
5. Open the config.properties file from the <TOMCAT_HOME>/webapps and verify license configuration.
6. If you backed up the workspace folder in step 2, copy the workspace folder back into the ROOT directory.
7. Start Tomcat (for example, from <TOMCAT_HOME>/bin).

Confirming Server Readiness

You can confirm that your server is ready and available a couple ways.

Browser Request Method

To confirm that your server is ready, browse to http://<HOST>:<PORT>/soavirt/api/v6/status (for example, http://localhost:9080/soavirt/api/v6/status) and check the "licensed" field under "soatest" and/or "virtualize" (as appropriate for your license) in the response. The "license" field should be set to true and a list of licensed features (both active and inactive) will follow.

Curl Command Method

Run the following command to check the health status of the server:

curl -X GET "http://<HOST>:<PORT>/soavirt/api/v6/healthcheck" -H "accept: */*" 

This command returns a 200 status code if the server is healthy and a 500 status code if there is an issue with the server.

If your server is healthy, you can validate your existing deployments with a command like the following:

curl -X GET "http://<HOST>:<PORT>/soavirt/api/v6/virtualAssets?fields=id%2Cname%2Cenabled" -H "accept: application/json" 

The output should show you available virtual assets.