Top | Web home | SourceForge home
$Id: //guest/paul_dymecki/mondrian/doc/install.html#1 $
(C) Copyright 2002, Kana Software, Inc.
Author	Julian Hyde

How to build and install Mondrian

1. Contents

1. Contents
2. Modification history
3. Setup build environment
4. Build
5. Run the demo
6. Run the web app
7. Debug tomcat using IntelliJ
8. Miscellaneous
   1. Coding guidelines
9. Appendix A: Product instllation instructions

2. Modification history

3. Setup build environment

Here are the steps to setup a build environment.

1. Install JDK 1.3.1.
2. Install Ant.
3. Install Tomcat.
4. Install Xalan.
5. Install JUnit.
6. Go to ${xalan.home}/bin, and copy xalan.jar and xml-apis.jar to ${tomcat.home}/common/lib. (This shouldn't be necessary, because these JARs are in mondrian.war, but I think there's a bug in Tomcat/4.0.3.)
7. Modify build.bat, setting JAVA_HOME, ANT_HOME, TOMCAT_HOME, XALAN_HOME, JUNIT_HOME.

Optional:

1. Install Jikes.

4. Build

As follows:

cd ${project.location}
build

5. Run the demo

You first need a database. I wanted to distribute a hsqldb database, but when loaded and indexed, the 300,000 rows/20Mb data set turned into a 400Mb datafile. So, two choices:

1. If you have Microsoft Access, create a System ODBC DSN called MondrianFoodMart pointing to ${project.location}/demo/access/FoodMart.mdb. The JDBC connect string will be jdbc:odbc:MondrianFoodMart.
2. If you have Oracle, create the dataset by importing ${project.location}/demo/oracle/FoodMart.dmp. Setup your environment:
   1. Set ORACLE_HOME in build.bat, or in your environment.
   2. Append %ORACLE_HOME%/jdbc/lib/classes12.zip to CLASSPATH in build.bat, or in your environment.
   3. In build.xml, make sure that the property mondrian.jdbcDrivers includes oracle.jdbc.OracleDriver.
   4. In build.xml, set the property mondrian.foodmart.jdbcURL. It should probably include a username and password, for example jdbc:oracle:oci8:foodmart/foodmart@myoracle.
3. If you have another database, create and populate the schema by running the scripts FoodMartTables.sql, FoodMartData.sql and FoodMartIndexes.sql in ${project.location}/demo/. You may need to modify the scripts for your database's particular DDL syntax. Examples:
   • The scripts work with hsqldb as is.
   • For mySQL, you will need to change all varchar columns in FoodMartTables.sql to varchar(30),  and change all false/true values in FoodMartData.sql to 0/1;
   • For postgres, change DOUBLE to DOUBLE PRECISION in FoodMartTables.sql.
   • Oracle versions of these scripts are available in demo/oracle (but it's easier to import FoodMart.dmp, as described above).
   • (Please let me know your experiences with other databases.)

Edit the "FoodMartTest" target in build.xml.

Run

cd ${project.location}
build test

6. Run the web app

1. First install Tomcat, as above.
2. Make sure the web.xml file in ${project.location}/webapp/WEB-INF is correct for your environment. In particular, check the paths in the init parameters to MDXQueryServlet.
3. build deploy-webapp.
4. Start up tomcat.
5. Hit http://localhost:8080/mondrian.

7. Debug tomcat using IntelliJ

1. add ${tomcat.home}/webapps/mondrian.war to intellij's classpath
2. edit ${tomcat.home}/bin/catalina.bat as follows:

   :doJpda
   if not "%SECURITY_POLICY_FILE%" == "" goto doSecurityJpda
   %_EXECJAVA% %JAVA_OPTS% %CATALINA_OPTS% -Xdebug -Xnoagent
     -Xrunjdwp:transport=dt_socket,address=%JPDA_ADDRESS%,server=y,suspend=n %DEBUG_OPTS%
     -Djava.endorsed.dirs="%JAVA_ENDORSED_DIRS%" -classpath "%CLASSPATH%"
     -Dcatalina.base="%CATALINA_BASE%" -Dcatalina.home="%CATALINA_HOME%"
     -Djava.io.tmpdir="%CATALINA_TMPDIR%" %MAINCLASS% %CMD_LINE_ARGS% %ACTION%
   goto end

3. create ${tomcat.home}/bin/setenv.bat as follows:

   set JPDA_ADDRESS=5000

4. cd e:\jakarta-tomcat-4.0.3\bin
5. catalina jpda run
6. attach intellij's debugger to port 5000

8. Miscellaneous

8.1. Coding guidelines

• Indentation 4.
• Tab stop 4.
• Use tabs, not space.
• K&R bracing convention (that is, open braces on the same line as the preceding 'if', 'else', 'while' statement or 'class' declaration).
• Use braces even for single-line blocks.
• Declare variables as near to their first use as possible.
• Don't initialize variables with 'dummy' values just to shut up the compiler.
• Try to keep lines shorter than 80 characters.
• Javadoc comments on methods are written in the active ('Collects garbage.') not imperative ('Collect garbage.')
• When editing HTML documents, don't use an editor which reformats the HTML source (such as Word).

Appendix A. Product installation instructions

These are the products I used to build mondrian. Install all of the products marked 'required'. (I use /-es in paths because I am run MKS on Windows 2000, and it makes things simpler.)

In the following, the symbol ${project.location} means the root of your source tree.

Where the instructions suggest setting an environment variable, it is often sufficient to edit the corresponding line in ${project.location}/build.bat.