Installation Guide for the Informative Workspace Overviewer

This version of the overviewer requires that you have the following software installed and operational on your machine before you begin:

ProjectOverviewer Version 3

1. Download the standalone war file from here
2. For first time usage, creates the directory of {user.home}/.hackystat/projectoverviewer if it doesn't already exist.
3. Deploy the war file into your favorite servlet container, e.g. Tomcat or Jetty.
4. Go to the browser at http://localhost:8081/projectoverviewer and your system is ready to go!
5. If you want the system to automatically update information for you, you need to refresh the page at least every hour. Some browser plug-in like Auto-Refresh can help with this.

ProjectOverviewer Version 2 TreeMap

1. Download the executable jar file from here
2. Double click the jar file to launch the application.
3. For first time usage, please create a new project under the Project menu option. (The Repository URL must be valid for a successful project creation.)
4. Now you can choose different metrics for the size and color to represent your project.

ProjectOverviewer Version 1

For Windows XP OS

1. Download the source code here
2. Expand the source to a directory that does not contain spaces. (Example C:\ICS414\informative-workspace)
3. Start the tomcat server. If you set up tomcat correctly, then you just need to open a command line and enter 'catalina start' to start the tomcat server.
4. In the distribution folder, there should be a war file named project-overviewer.war that you can deploy onto your tomcat server. Deploy this file to the tomcat server by opening a web browser and navigating to: http://localhost:8080
5. From here click on tomcat manager. The username and password are set in your tomcat-users.xml file in the CATALINA_HOME/conf folder - example:

<?xml version='1.0' encoding='utf-8'?>
<tomcat-users>
  <role rolename="manager"/>
  <role rolename="admin"/>
  <role rolename="password"/>
  <user username="admin" password="password" roles="admin,manager"/>
</tomcat-users>

6. Once you've entered the manager, go to the bottom of the page and look for "War file to deploy." Browse for the project-overviewer.war file in the distribution folder and click 'ok' and then 'Deploy'.
7. Now navigate to http://localhost:8080/project-overviewer for the homepage.
8. Your informative workspace's heart is now pumping!

Note

For the directory tree to function completely, please make sure to have a "xml" sub-folder in the folder where you put the war file in. Also, copy the repository-files.informative-workspace.xml to the xml folder. (this file can be located in the /xml folder from the distribution) A sample directory would look like the following:

= projectFolder
  = project-overviewer.war
  = xml
    = repository-files.informative-workspace.xml

Without the repository-files.informative-workspace.xml file, the directory tree will only display sensor data for the pass 1 hour.