Redeploying iDashboards In Tomcat
This document is intended for iDashboards users who wish to deploy a service release of iDashboards in the Apache Tomcat application server. A service release differs from a major release in that it typically contains no new functionality, but rather only bug fixes. A major release is designated by a number, for example ‘8.5’. A service release is an update to a major release, and its name consists of the major release number followed by a letter, for example ‘9.0’.
If its corresponding major release (or a service release thereof) is already deployed, replacing it with a new service release of iDashboards is a fairly simple process. A repository update will not be required; therefore, it is not necessary to back up the repository where major release backing up the repository is highly recommended. (Frequent repository backups are good practice, however.) Typically, the only thing that needs to be done is to deploy the new idashboards.war file. This document explains how to do that in the Apache Tomcat application server. For other application servers, their provided documentation must be consulted.
In the steps outlined below, <Tomcat Install Dir> refers to the directory where the Tomcat application server was installed. For assistance, contact firstname.lastname@example.org.
Verify your current iDashboards Version
First, verify that your current version of iDashboards is the same major release as the service release you are about to deploy. To determine the release number, log into the iDashboards Admin application. On the Admin Home screen, at or near the bottom of the table of license information, is the build ID, which will look something like this:
The group of characters before the first hyphen, which in the above example would be ‘8.0i’, is the version of iDashboards that is running, and ‘8.0’ would be its major release version.
Undeploying the iDashboards .war Files
With Tomcat still running, navigate to <Tomcat Install Dir>\webapps on the iDashboars web server, there you will find the iDashbaords war files. Remove the war file from the webapps directory. What this will do is cause the Tomcat server to start the undeploying process. You will know when this process has finished when the complimentary directory have disappeared after a couple moments. At this point, you can place the new three new war files into <Tomcat Install Dir>\webapps directory. This will start the deploying process of the new war file. The three new iDashboards war files are located in the ‘bin’ directory of the CDROM image.
Shut down the Tomcat Application Server
Tomcat should be still running from the services or system tray icon that looks like this and whose tooltip reads Apache Tomcat or ‘iDashboards Server’. Right-click the icon and choose ‘Stop service’ from the popup menu to stop it.
If Tomcat is running on a Linux or Unix server, there is unfortunately no standard way for shutting down Tomcat. Ask the server administrator to shut it down.
Updating Reports Module
iDashboards Reports Module is packaged in a ZIP file, named idb_reports_module.zip, which is in the ‘bin’ directory of the iDashboards xx_EnterpriseSuite_CDROM.zip distribution ZIP file. To deploy it, make sure there is no existing subdirectory named ‘report’ in the <ivizgroup home> directory, if the directory exists then with Tomcat stopped remove the directory from <ivizgroup home> and unzip the idb_reports_module.zip file directly into the <ivizgroup home> directory. Unzipping it will create a subdirectory named ‘report’.
On a Windows server, right click the system tray icon for the Tomcat application server and choose ‘Start service’ from the popup menu. This can also be done from Microsoft Services. For a Unix or Linux server, ask the server administrator to restart Tomcat.
Verify the newly-deployed iDashboards version
To verify that the new version of iDashboards has been properly deployed, log into the iDashboards Admin application and check the version as described in step 1 above.
- X Platform
- Enterprise Suite