Loading...
Helix SwarmHelix Swarm
Loading...

install.html

  • //
  • guest/
  • julian_hyde/
  • mondrian/
  • doc/
  • install.html #8
  • View
  • Commits
  • Open Download .zip Download (14 KB) 
  1. <html>
  2.  
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  5. <meta name="GENERATOR" content="Microsoft FrontPage 4.0">
  6. <meta name="ProgId" content="FrontPage.Editor.Document">
  7. <title>Mondrian installation guide</title>
  8. <link rel="stylesheet" type="text/css" href="stylesheet.css" />
  9. </head>
  10.  
  11. <body bgcolor="#ffffff">
  12.  
  13. <table border="1" class="clsStd" width="100%">
  14.   <tr>
  15.     <td colspan="2"><a href="index.html" style="color: #000066">Top</a> |
  16.     <a href="http://public.perforce.com/guest/julian_hyde/mondrian/doc/index.html" style="color: #000066">Web home</a> |
  17.     <a href="http://sourceforge.net/projects/mondrian/" style="color: #000066">SourceForge home</a></td>
  18.     <td width="0" align="right" rowspan="2">
  19.     <a href="http://sourceforge.net" style="color: #000066"><img src="http://sourceforge.net/sflogo.php?group_id=35302&type=1" width="88" height="31" border="0" alt="SourceForge.net Logo"></a></td>
  20.   </tr>
  21.   <tr>
  22.     <td colspan="2"><em>$Id: //guest/julian_hyde/mondrian/doc/install.html#8 $</em></td>
  23.   </tr>
  24.   <tr>
  25.     <td colspan="3"><em>(C) Copyright 2002, Kana Software, Inc.</em></td>
  26.   </tr>
  27.   <tr>
  28.     <th align="right" width="30%">Author</th>
  29.     <td colspan="2">Julian Hyde</td>
  30.   </tr>
  31. </table>
  32.  
  33. <h1><font size="6">How to build and install Mondrian</font></h1>
  34.  
  35. <h2><a name="1_Contents">1. Contents</a></h2>
  36. <ol>
  37.   <li><a href="#1_Contents">Contents</a>
  38.   <li><a href="#2_Modification_history">Modification history</a>
  39.   <li><a href="#3_Setup_build_environment">Setup build environment</a>
  40.   <li><a href="#4_Build">Build</a>
  41.   <li><a href="#5_Run_the_demo">Run the demo</a>
  42.   <li><a href="#6_Run_the_web_app">Run the web app</a>
  43.   <li><a href="#7_Debug_tomcat_using_IntelliJ">Debug tomcat using IntelliJ</a><li>
  44.   <a href="#8_Miscellaneous">Miscellaneous</a>
  45.     <ol>
  46.       <li><a href="#8_1_Coding_guidelines">Coding guidelines</a></li>
  47.     </ol>
  48.   <li><a href="#Appendix_A_Product_installation_instructions">Appendix A: 
  49.   Product instllation instructions</a></li>
  50. </ol>
  51.  
  52. <h2><a name="2_Modification_history">2. Modification history</a></h2>
  53. <table border="1" class="clsStd" width="100%">
  54.   <tr>
  55.     <th>Date</th>
  56.     <th>Revision</th>
  57.     <th>Author</th>
  58.     <th>Comment</th>
  59.   </tr>
  60.   <tr>
  61.     <td><I>February 7<SUP>th</SUP>, 2002</I></td>
  62.     <td><em>1</em></td>
  63.     <td><i>Julian Hyde</i></td>
  64.     <td><em>Created</em></td>
  65.   </tr>
  66.   <tr>
  67.     <td><I>March 5<SUP>th</SUP>, 2002</I></td>
  68.     <td><em>2</em></td>
  69.     <td><i>Julian Hyde</i></td>
  70.     <td><em>Tomcat install</em></td>
  71.   </tr>
  72.   <tr>
  73.     <td><I>March 28<SUP>th</SUP>, 2002</I></td>
  74.     <td><em>3</em></td>
  75.     <td><i>Julian Hyde</i></td>
  76.     <td><em>Xalan, JUnit and Oracle.<br>
  77.     Moved product info to an appendix.</em></td>
  78.   </tr>
  79.   </table>
  80.  
  81. <h2><a name="3_Setup_build_environment">3. Setup build environment</a></h2>
  82.  
  83. <p>Here are the steps to setup a build environment.</p>
  84.  
  85. <ol>
  86.   <li>Install <a href="#JDK">JDK 1.3.1</a>.</li>
  87.   <li>Install <a href="#Ant">Ant</a>.</li>
  88.   <li>Install <a href="#Tomcat">Tomcat</a>.</li>
  89.   <li>Install <a href="#Xalan">Xalan</a>.</li>
  90.   <li>Install <a href="#JUnit">JUnit</a>.</li>
  91.   <li>Go to <i></i><code><i>${xalan.home}</i>/bin</code>, and copy <code>
  92.   xalan.jar</code> and <code>xml-apis.jar</code> to <i></i><code><i>${tomcat.home}</i>/common/lib</code>. 
  93.   (This shouldn't be necessary, because these JARs are in <code>mondrian.war</code>, 
  94.   but I think there's a bug in Tomcat/4.0.3.)</li>
  95.   <li>Modify <code>build.bat</code>, setting <code>JAVA_HOME</code>, <code>ANT_HOME</code>, 
  96.   <code>TOMCAT_HOME</code>, <code>XALAN_HOME</code>, <code>JUNIT_HOME</code>.</li>
  97. </ol>
  98.  
  99. <p>Optional:</p>
  100. <ol>
  101.   <li>Install <a href="#Jikes">Jikes</a>.</li>
  102. </ol>
  103.  
  104. <h2><a name="4_Build">4. Build</a></h2>
  105. <p>As follows:</p>
  106. <blockquote>
  107. <pre>cd <i>${project.location}</i>
  108. build</pre>
  109. </blockquote>
  110. <h2><a name="5_Run_the_demo">5. Run the demo</a></h2>
  111. <p>You first need a database. I wanted to distribute a hsqldb database, but when loaded and indexed, the 300,000
  112. rows/20Mb data set turned into a 400Mb datafile. So, two choices:</p>
  113. <ol>
  114.   <li>If you have <b>Microsoft Access</b>, create a System ODBC DSN called
  115.     MondrianFoodMart pointing to <code><i>${project.location}</i>/demo/access/FoodMart.mdb</code>.
  116.     The JDBC connect string will be <code>jdbc:odbc:MondrianFoodMart</code>. </li>
  117.   <li>If you have <b>Oracle</b>, create the dataset by importing <code>${project.location}/demo/oracle/FoodMart.dmp</code>. 
  118.   Setup your environment:<ol>
  119.   <li>Set <code>ORACLE_HOME</code> in <code>build.bat</code>, or in your 
  120.   environment.</li>
  121.   <li>Append <code>%ORACLE_HOME%/jdbc/lib/classes12.zip</code> to <code>
  122.   CLASSPATH</code> in <code>build.bat</code>, or in your environment.</li>
  123.   <li>In <code>build.xml</code>, make sure that the property <code>
  124.   mondrian.jdbcDrivers</code> includes <code>oracle.jdbc.OracleDriver</code>.</li>
  125.   <li>In <code>build.xml</code>, set the property <code>
  126.   mondrian.foodmart.jdbcURL</code>. It should probably include a username and 
  127.   password, for example <code>jdbc:oracle:oci8:foodmart/foodmart@myoracle</code>.</li>
  128. </ol>
  129.   </li>
  130.   <li>If you have another database, create and populate the schema  by running the scripts <code>FoodMartTables.sql</code>,
  131.     <code>FoodMartData.sql</code> and <code>FoodMartIndexes.sql</code> in <code>${project.location}/demo/</code>. You may need to modify the scripts for your database's
  132.     particular DDL
  133.     syntax. Examples:<ul>
  134.     <li>The scripts work with <b>hsqldb</b> as is.</li>
  135.     <li>For <b>mySQL</b>, you will need to change all <code>varchar</code> 
  136.         columns in <code>FoodMartTables.sql</code> to
  137.         <code>varchar(30)</code>,&nbsp; and change all
  138.         <code>false</code>/<code>true</code> values in <code>
  139.         FoodMartData.sql</code> to <code>0</code>/<code>1</code>;</li>
  140.     <li>For <b>postgres</b>, change <code>DOUBLE</code> to <code>DOUBLE
  141.     PRECISION</code> in <code>
  142.         FoodMartTables.sql</code>.</li>
  143.     <li>Oracle versions of these scripts are available in <code>demo/oracle</code> 
  144.     (but it's easier to import <code>FoodMart.dmp</code>, as described above).</li>
  145.     <li>(Please let me know your experiences with other databases.)</li>
  146.     </ul>
  147.     </li>
  148. </ol>
  149. <p>Edit the &quot;FoodMartTest&quot; target in <code>build.xml</code>.</p>
  150. <p>Run</p>
  151. <blockquote>
  152.   <pre>cd <i>${project.location}</i>
  153. build test</pre>
  154. </blockquote>
  155. <h2><a name="6_Run_the_web_app">6. Run the web app</a></h2>
  156. <ol>
  157.   <li>First install Tomcat, as above.</li>
  158.   <li>Make sure the <code>web.xml</code> file in <code>${project.location}/</code><code>webapp/WEB-INF</code> 
  159.   is correct for your environment. In particular, check the paths in the init 
  160.   parameters to <code>MDXQueryServlet</code>.</li>
  161.   <li><code>build deploy-webapp</code>.</li>
  162.   <li>Start up tomcat.</li>
  163.   <li>Hit <a href="http://localhost:8080/mondrian">
  164.   http://localhost:8080/mondrian</a>.</li>
  165. </ol>
  166. <h2><a name="7_Debug_tomcat_using_IntelliJ">7. Debug tomcat using IntelliJ</a></h2>
  167. <ol>
  168.   <li>add <code><i>${tomcat.home}</i>/webapps/mondrian.war</code> to intellij's 
  169.   classpath</li>
  170.   <li>edit <code><i>${tomcat.home}</i>/bin/catalina.bat</code> as follows:
  171.   <blockquote>
  172. <pre><code>:doJpda
  173. if not &quot;%SECURITY_POLICY_FILE%&quot; == &quot;&quot; goto doSecurityJpda
  174. %_EXECJAVA% %JAVA_OPTS% %CATALINA_OPTS% -Xdebug <font color="#FF0000"><i><b>-Xnoagent
  175.  </b></i></font> -Xrunjdwp:transport=<font color="#FF0000"><i><b>dt_socket</b></i></font>,address=%JPDA_ADDRESS%,server=y,suspend=n %DEBUG_OPTS%
  176.   -Djava.endorsed.dirs=&quot;%JAVA_ENDORSED_DIRS%&quot; -classpath &quot;%CLASSPATH%&quot;
  177.   -Dcatalina.base=&quot;%CATALINA_BASE%&quot; -Dcatalina.home=&quot;%CATALINA_HOME%&quot;
  178.   -Djava.io.tmpdir=&quot;%CATALINA_TMPDIR%&quot; %MAINCLASS% %CMD_LINE_ARGS% %ACTION%
  179. goto end</code></pre>
  180.   </blockquote>
  181.   </li>
  182.   <li>create <code><i>${tomcat.home}</i>/bin/setenv.bat</code> as follows:
  183.   <blockquote>
  184. <pre><code>set JPDA_ADDRESS=5000</code></pre>
  185.   </blockquote>
  186.   </li>
  187.   <li><code>cd e:\jakarta-tomcat-4.0.3\bin</code></li>
  188.   <li><code>catalina jpda run</code></li>
  189.   <li>attach intellij's debugger to port 5000</li>
  190. </ol>
  191. <h2><a name="8_Miscellaneous">8. Miscellaneous</a></h2>
  192. <h3><a name="8_1_Coding_guidelines">8.1. Coding guidelines</a></h3>
  193. <ul>
  194.   <li>Indentation 4.</li>
  195.   <li>Tab stop 4.</li>
  196.   <li>Use tabs, not space.</li>
  197.   <li>K&R bracing
  198. convention (that is, open braces on the same line as the preceding 'if', 'else', 'while' statement or 'class' declaration).</li>
  199.   <li>Use braces even for single-line blocks.</li>
  200.   <li>Declare variables as near to
  201. their first use as possible.</li>
  202.   <li>Don't initialize variables with 'dummy' values just
  203. to shut up the compiler.</li>
  204.   <li>Try to keep lines shorter than 80 characters.</li>
  205.   <li>Javadoc comments on
  206. methods are written in the active ('Collects garbage.') not imperative ('Collect
  207. garbage.')</li>
  208.   <li>When editing HTML documents, don't use an editor which reformats the
  209. HTML source (such as Word).</li>
  210. </ul>
  211.  
  212. <h2><a name="Appendix_A_Product_installation_instructions">Appendix A. Product 
  213. installation instructions</a></h2>
  214.  
  215. <p>These are the products I used to build mondrian. Install all of the products
  216. marked 'required'. (I use <code>/</code>-es in paths because I am run MKS on
  217. Windows 2000, and it makes things simpler.)</p>
  218.  
  219. <p>In the following, the symbol <code><i>${project.location}</i></code> means the root of your
  220. source tree.</p>
  221.  
  222. <p>Where the instructions suggest setting an environment variable, it is often 
  223. sufficient to edit the corresponding line in <code><i>${project.location}</i>/build.bat</code>.</p>
  224.  
  225. <table border="1" class="clsStd" width="100%">
  226.   <tr>
  227.     <th>Product</th>
  228.     <th>Required?</th>
  229.     <th>Version</th>
  230.     <th>Comment</th>
  231.   </tr>
  232.   <tr>
  233.     <td><a name="JDK">JDK</a></td>
  234.     <td>Yes</td>
  235.     <td>1.1 or later (I use version 1.3.1.)</td>
  236.     <td>Available from <a href="http://developer.java.sun.com/" target="_blank">http://developer.java.sun.com/</a>.
  237.       I downloaded <code>j2sdk-1_3_1_02-win.exe</code>, and extracted to <code>E:/jdk1.3.1_02</code>. Set
  238.       <code> JAVA_HOME</code> to same, and <code> CLASS_PATH</code> to <code>%JAVA_HOME%/lib/dt.jar</code>.</td>
  239.   </tr>
  240.   <tr>
  241.     <td><a name="Ant">Ant</a></td>
  242.     <td>Yes</td>
  243.     <td>1.4.1 or later&nbsp;</td>
  244.     <td>I downloaded
  245. <a href="http://jakarta.apache.org/builds/jakarta-ant/release/v1.4.1/bin/jakarta-ant-1.4.1-bin.zip">
  246. jakarta-ant-1.4.1-bin.zip</a>,  extracted to <code>E:/jakarta-ant-1.4.1</code>, 
  247.     and set <code>ANT_HOME</code> to the same.</td>
  248.   </tr>
  249.   <tr>
  250.     <td><a name="Tomcat">Tomcat</a></td>
  251.     <td>Yes</td>
  252.     <td>4.0 or later (I use version 4.0.3)</td>
  253.     <td>Available from <a href="http://jakarta.apache.org/tomcat" target="_blank">
  254.     http://jakarta.apache.org/tomcat</a>. I downloaded <code>
  255.     jakarta-tomcat-4.0.3.zip</code>,  extracted to <code>E:/jakarta-tomcat-4.0.3</code>, 
  256.     and set <font face="Verdana"><code>TOMCAT_HOME</code></font> to the same.</td>
  257.   </tr>
  258.   <tr>
  259.     <td><a name="Jikes">Jikes</a></td>
  260.     <td>No</td>
  261.     <td>&nbsp;</td>
  262.     <td>Available from <a href="http://oss.software.ibm.com/developerworks/opensource/jikes/" target="_blank">http://oss.software.ibm.com/developerworks/opensource/jikes/</a>.
  263.       I <code>downloaded jikes-1.15-windows.zip</code>, and extracted <code>jikes.exe</code>
  264.       to <code>C:/winnt/system32</code>. Then uncomment the relevant lines of <code><i>${project.location}</i>/build.properties</code>.</td>
  265.   </tr>
  266.   <tr>
  267.     <td><a name="Xerces">Xerces</a></td>
  268.     <td>&nbsp;</td>
  269.     <td>1.4.1 or later</td>
  270.     <td><code>xerces.jar</code> is included with Tomcat.</td>
  271.   </tr>
  272.   <tr>
  273.     <td><a name="Xalan">Xalan</a></td>
  274.     <td>Yes</td>
  275.     <td>2.3.1 or later</td>
  276.     <td>Available from <a href="http://xml.apache.org/xalan-j/" target="_blank">
  277.     http://xml.apache.org/xalan-j/</a>. I downloaded <code>xalan-j_2_3_1-bin.zip</code>, 
  278.     extracted to <code>E:/xalan-j_2_3_1</code>, and set <code>XALAN_HOME</code> 
  279.     to the same.</td>
  280.   </tr>
  281.   <tr>
  282.     <td><a name="JUnit">JUnit</a></td>
  283.     <td>Yes</td>
  284.     <td>3.7 or later</td>
  285.     <td>Available from <a href="http://www.junit.org/">http://www.junit.org/</a>. I downloaded <code>
  286.     junit3.7.zip</code>, 
  287.     extracted to <code>E:/junit3.7</code>, and set <code>JUNIT_HOME</code> 
  288.     to the same.</td>
  289.   </tr>
  290.   <tr>
  291.     <td>Intellij IDEA (a Java IDE)</td>
  292.     <td>No</td>
  293.     <td>2.5.1</td>
  294.     <td>You can download a 30-day evaluation copy from <a href="http://www.intellij.com/idea/" target="_blank">http://www.intellij.com/idea/</a>.
  295.       Follow the instructions in <code>Install.txt</code> in <code>idea-2_5_1.zip</code>
  296.       to there.
  297.       <p>Create a project <code><i>${project.location}</i>/mondrian.ipr</code>.
  298.       Set the compiler output path to <code><i>${project.location}</i>/classes/</code>.
  299.       Add <code>javacup.jar</code> and <code>xerces.jar</code>
  300.       in <code><i>${project.location}</i>/lib/</code> to the class
  301.       path.</p>
  302.       <p>To use Ant build, click the '6: Ant Build' tab, click '+', choose <code><i>${project.location}</i>/build.xml</code>, then right-click, choose
  303.       'Properties', and choose 'Include project classpath'. (<code>javacup.jar</code> 
  304.       is needed in order to build the <code>parser</code> target.)</td>
  305.   </tr>
  306.   <tr>
  307.     <td>hsql Database Engine</td>
  308.     <td>No</td>
  309.     <td>1.61</td>
  310.     <td>
  311. <p>Available from <a href="http://hsqldb.sourceforge.net/" target="_blank">http://hsqldb.sourceforge.net/</a>.
  312. I extracted <code>hsqldb_v.1.61.zip</code> to <code>E:/hsqldb_v.1.61</code>,
  313. then edited <code>bin/run.bat</code>. You will need to add <code>hsqldb.jar</code> 
  314. to your classpath.</p>
  315.     </td>
  316.   </tr>
  317.   <tr>
  318.     <td>mySQL</td>
  319.     <td>No</td>
  320.     <td>?</td>
  321.     <td>
  322. ?</td>
  323.   </tr>
  324.   <tr>
  325.     <td>Postgres</td>
  326.     <td>No</td>
  327.     <td>?</td>
  328.     <td>
  329. ?</td>
  330.   </tr>
  331.   <tr>
  332.     <td>JavaCUP (parser generator)</td>
  333.     <td>Included with source distribution, as <code>lib/javacup.jar</code>.&nbsp;</td>
  334.     <td>v0.10g (with modifications)</td>
  335.     <td>Available from <a href="http://www.cs.princeton.edu/~appel/modern/java/CUP/" target="_blank">http://www.cs.princeton.edu/~appel/modern/java/CUP/</a>.
  336.       I modified version v.0.10g to add an Ant task, and to output error
  337.       messages in a format which Emacs can parse.</td>
  338.   </tr>
  339.   </table>
  340.  
  341. <p>&nbsp;</p>
  342.  
  343. <b>
  344.   <table border="1" width="100%" class="clsStd">
  345.     <tr>
  346.       <td>End <i>$Id: //guest/julian_hyde/mondrian/doc/install.html#8 $</i></td>
  347.     </tr>
  348.   </table>
  349.   <p>&nbsp;&nbsp;&nbsp; </p>
  350. </b>
  351.  
  352. </body>
  353.  
  354. </html>
# Change User Description Committed
#8 1609 Julian Hyde mondrian:
Forgot a couple of files last change.
Unit tests for builtin functions.
Don't... return null members (e.g. [Gender].[F].PrevMember). «		 23 years ago
#7 1603 Julian Hyde mondrian:
Add Andreas' taglib;
Rename 'mondrian.rolap.Util.assert' to 'assertTrue', becau...se 'assert' is a keyword in jdk 1.4;
Fix 'NON EMPTY';
JUnit framework for tests;
Add Oracle dataset. «		 23 years ago
#6 1583 Julian Hyde mondrian:
add transformer scripts for postgres, hsql;
fix bugs in SqlQuery;
add roadmap. 		23 years ago
#5 1576 Julian Hyde mondrian:
fix dataset (add column customer.ordinal);
create dataset for oracle;
get quer...ies working on oracle;
get format strings working;
refactor out new packages mondrian.rolap.agg and mondrian.rolap.sql. «		 23 years ago
#4 1507 Julian Hyde Mondrian:
Forgot to add MDXQueryServlet.java;
Installation instructions for Tomcat. 		23 years ago
#3 1496 Julian Hyde Mondrian:
Qualify table names with schemas.
Add 'Hierarchy.schema', 'Cube.factSchema','Hi...erarchy.table' attributes.
MondrianDef is now generated (so we need boot.jar). «		 23 years ago
#2 1475 Julian Hyde Saffron.
Re-integrate Median, etc. 		23 years ago
#1 1453 Julian Hyde mondrian: first source check-in 23 years ago