Archimede setup

Archimede is Java-based, it is multi-platform and will run on any Operating System (Windows, Linux, etc.).

On http://sourceforge.net/projects/archimede/ you will find Archimede's latest version. Download it in a folder (ex. : c:\archimede or /home/user/archimede).

Ensure that you have each of the four elements installed :

Note : You will have to work with environment variable. For a short introduction of this concept read the following page : http://en.wikipedia.org/wiki/Environment_variable. For an explanation about editing environment variable on windows read the following :   http://www.winnetmag.com/Windows/Article/ArticleID/37950/37950.html

For linux read http://www.comptechdoc.org/os/linux/usersguide/linux_ugenvironment.html .



1 - J2SE Software Development Kit (or JDK) 1.4.1+ 

This can be downloaded from http://java.sun.com.

Create a JAVA_HOME environment variable containing the path to the JDK (do not confuse with Java Runtime Environement).

Add to PATH

%JAVA_HOME%\bin (Windows)

$JAVA_HOME/bin (Linux)

For windows you will have to reboot.

For testing your java environment, open a command prompt and type the following :

java –version

This should give you the java version, then type the following :

javac –help

This should give you the java help menu.

2 - J2EE Servlet 2.3+ container (ex: Tomcat 4.1+) 

This can be downloaded from http://jakarta.apache.org/tomcat. Install examples to test your application server.

If you have difficulties with Tomcat installation you can read : http://www.onjava.com/pub/a/onjava/2001/03/29/tomcat.html (Windows/Linux) or http://www.cs.laurentian.ca/badams/c2206/install-notes/tomcat5/ (Windows).

When the Tomcat installation is done, open your web browser and go to http://localhost:8080/jsp-examples/ and test a few examples. If you got an error message while testing, try to copy JAVA_HOME/lib/tools.jar in the folder TOMCAT_HOME/common/lib (where TOMCAT_HOME is the Tomcat root directory). Then restart the server.

3 - Ant

Ant can be downloaded from http://ant.apache.org. Read carefully http://ant.apache.org/manual/install.html, don't forget to create the required environment variables.

Create a ANT_HOME environment variable containing the path to ANT.

Add to PATH 

%ANT_HOME%\bin (Windows)

$ANT_HOME/bin (Linux)

For windows you will have to reboot. 

For testing your Ant installation, open a command prompt and type the following :

ant

If you receive a "build.xml does not exist!" error message, your Ant installation is working fine. Then you have to copy the file TOMCAT_HOME/server/lib/catalina.jar (where TOMCAT_HOME is the Tomcat root directory) in the folder ANT_HOME/lib.

4 - Supported relational databases (list : http://db.apache.org/torque)

We recommend MySQL. It can be downloaded from http://www.mysql.com. For MySQL Installation and Configuration see : http://dev.mysql.com/doc/mysql/en/Quick_Standard_Installation.html. If you want to use another database, you will have to copy the JDBC driver .JAR file to /war/WEB-INF/lib into Archimede directory. Please consult your database documentation for more details. We suggest you to use a visual tool for you database testing.

MySQL : You can use the following visual administration console : http://www.mysql.com/products/administrator/. By default the MySQL administrator account is "root" and have no password. This is correct for the moment and leave it like that until you have finished the Archimede setup.

We will not create a database now. This will be done later with Ant.



When you are assured that all of the above is working fine then you are ready to install Archimede !

Download Archimede. Open the folder where it is and uncompress the files. You will have to modify two configuration files in the Archimede root folder :

Note: use a text utilitie to edit the files but do not use NotePad (Windows). For Windows, we recommend WordPad or jEdit (http://www.jedit.org/).

1. build.properties

Specifies the Tomcat application server parameters. For windows, change directory separators from "\" (back slashes) to "/" (forward slashes), by example, "C:\tomcat\webapps" will be "C:/tomcat/webapps". Simply follow the examples (do no forget to specify the administrator and password for Tomcat)

2. archimede-config.xml

Read the comments for a description of the parameters. You don't have to invert directories separators in this file.

Open a command prompt and go into the Archimede directory, then type the command :

ant deploywar

Ant will construct a WAR file for the web application and will place it on the server.

To create the database and insert the tables :

First you will have to modify the parameters for the database in the file :

build-torque.properties

Simply follow the examples.

If you choose to use a database that is not named "archimede" you will have to modify this file :

/schema/project-schema.xml

Find this line : <database name="archimede" defaultIdMethod="native"> and put the name of the database that you want to use.

Open a command prompt and go into the Archimede directory, then type the command :

ant –f build-torque.xml sql

Ant will generate the SQL schema for your database. Then type the command :

ant –f build-torque.xml create-db

If you get error messages at this step maybe this is because your database server is not accessible (verify this with a visual administration console). It is also possible that yours parameters are wrong (double check the build-torque.properties and project-schema.xml files), did you put the right JDBC driver and did you copy the appropriate JAR file into the /war/WEB-INF/lib folder of Archimede ?

ant –f build-torque.xml insert-sql

If you get error messages at this step maybe you did not put the same database name into build-torque.properties and project-schema.xml.

Open your web browser and go to http://localhost:8080/archimede

When you execute Archimede for the first time, the necessary elements will be automatically inserted into the database. Also, an administrator account will be created with the following data :



- Username : admin

- Password : admin

It is strongly suggested to change the password of this account.

Note: Do not reload application from the application server. The database connections are not recycled by this action.