Skip to content

Commit

Permalink
MONDRIAN: Deleted MondrianGuiDef.java, as it is now being generated f…
Browse files Browse the repository at this point in the history 
…rom Mondrian_SW.xml when mondrian is build. Updated workbench.html with Schema Workbench launch instructions.

[git-p4: depot-paths = "//open/mondrian/": change = 9031]
  • Loading branch information
Somita Arora committed Apr 3, 2007
1 parent 5f360cf commit 674ef90
Show file tree
Hide file tree
Showing 4 changed files with 184 additions and 4,521 deletions.
24 changes: 8 additions & 16 deletions build.xml
View file
Expand Up @@ -377,14 +377,13 @@ META-INF/**"/>
<copy file="${java.dir}/mondrian/olap/mondrian.dtd"
todir="${lib.dir}"/>

<!-- // Begin : somita April 02, 2007 : To resolve equals(==) problem in mondrian.xml that causes tree breaks in Schema Workbench -->
<!-- Workbench needs a different model. See Mondrian_SW.xml for details. -->
<xomgen
model="${java.dir}/mondrian/olap/mondrian_SW.xml"
model="${java.dir}/mondrian/olap/Mondrian_SW.xml"
destdir="${java.dir}"
classname="mondrian.gui.MondrianGuiDef"
dtdname="mondrian_SW.dtd"
/>
<!-- // End : sarora -->

<xomgen
model="${java.dir}/mondrian/rolap/aggmatcher/DefaultRulesSchema.xml"
Expand Down Expand Up @@ -1141,19 +1140,12 @@ xalan.jar"/>
</jar>
</target>

<!--*********************************************************************-->
<!-- Workbench Run targets -->
<!--*********************************************************************-->
<!-- Begin : sac, April 02, 2007 : Added workbench run target -->
<target name="workbench-run" >
<!-- check if mondrian.jar and workbench jar file exists -->
<available file="${jar.file}" property="mondrian.jar.exists"/>
<available file="${workbench.jar.file}" property="workbench.jar.exists"/>

<java jar="${workbench.jar.file}" fork="yes"/>

</target>
<!-- End : sac -->
<target name="workbench-run" >
<!-- check if mondrian.jar and workbench jar file exists -->
<available file="${jar.file}" property="mondrian.jar.exists"/>
<available file="${workbench.jar.file}" property="workbench.jar.exists"/>
<java jar="${workbench.jar.file}" fork="yes"/>
</target>

<!--
Retroweaver re-engineers JDK 1.5-compatible code so it can run under
Expand Down
218 changes: 172 additions & 46 deletions doc/workbench.html
View file
@@ -1,4 +1,6 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<!--
== $Id$
== This software is subject to the terms of the Common Public License
Expand All @@ -9,133 +11,257 @@
== All Rights Reserved.
== You must accept the terms of that agreement to use this software.
-->

<link rel="stylesheet" type="text/css" href="stylesheet.css">

<head>
<link rel="stylesheet" type="text/css" href="stylesheet.css"/>
<title>Mondrian Schema Workbench</title>

<title>Mondrian Schema Workbench</title>
</head>



<body>

<!-- doc2web start -->

<!-- page title -->
<div class="contentheading">Mondrian Schema Workbench</div>

<!-- end page title -->

<p>The Mondrian Schema Workbench allows you to visually create and test Mondrian OLAP cube schemas.</p>


<img src="images/workbench_schema_editor.png">

<p>It provides the following functionality:</p>
<ul>


<ul>

<li>Schema editor integrated with the underlying data source for validation. (See above)</li>

<li>Test MDX queries against schema and database <a href="images/workbench_mdx_query_runner.png">Screenshot</a></li>

<li>Browse underlying databases structure <a href="images/workbench_jdbc_explorer.png">Screenshot</a></li>

</ul>

<p></p>


<h2>Using the Workbench</h2>

<p></p>

<table style="text-align: left; border-collapse:collapse"
border="1" cellpadding="10" cellspacing="0">

<table style="text-align: left; border-collapse: collapse;" border="1" cellpadding="10" cellspacing="0">

<tbody>


<tr>

<td style="vertical-align: top;">
<p>Edit or create your equivalent of the demo/workbench.bat script, which sets the classpath for the
workbench. Include drivers for your database on the classpath.</p>
<p>Run the script to start the workbench.</p>
In windows:<blockquote>
<pre>
@echo off

rem base Mondrian JARs
set CP=../lib/commons-dbcp.jar;../lib/commons-collections.jar;../lib/commons-pool.jar
set CP=%CP%;../lib/eigenbase-properties.jar;../lib/eigenbase-resgen.jar;../lib/eigenbase-xom.jar
set CP=%CP%;../lib/javacup.jar;../lib/log4j-1.2.9.jar;../lib/mondrian.jar
set CP=%CP%;../lib/jlfgr-1_0.jar;../lib/jmi.jar;lib/mof.jar;../lib/commons-math-1.0.jar
set CP=%CP%;../lib/commons-vfs.jar;../lib/commons-logging.jar

rem Workbench GUI code and resources
set CP=%CP%;../lib/workbench.jar

rem add all needed JDBC drivers to the classpath
set CP=%CP%;../testlib/mysql-connector-java-3.1.11-bin.jar
set CP=%CP%;../testlib/postgresql-driver-jdbc3-74-214.jar

rem set the log4j.properties system property "-Dlog4j.properties=<.properties or .xml file>"
rem in the java command below to adjust workbench logging

java -Xms100m -Xmx500m -cp "%CP%" mondrian.gui.Workbench
</pre>
</blockquote>

<p>In UNIX/Linux:</p>
<blockquote>
<pre>java -jar lib/workbench.jar mondrian.gui.Workbench</pre>
</blockquote>
<p>To build and create the workbench jar, at the command line, type:</p>
<pre> ant workbench<br></pre>
<p>Example output:</p>
Buildfile: build.xml<br>
Overriding previous definition of reference to jdk<br>
<br>
version:<br>
<br>
prepare:<br>
<br>
parser:<br>
&nbsp; [javacup] Files are up to date.<br>
<br>
generate.resources:<br>
&nbsp;&nbsp; [resgen] C:\MONDRIAN_SourceForge\open\mondrian\src\main\mondrian\resource\MondrianResource.java is up to date<br>
&nbsp;&nbsp; [resgen] C:\MONDRIAN_SourceForge\open\mondrian\classes\mondrian\resource\MondrianResource.properties is up to date<br>
&nbsp;&nbsp; [resgen] C:\MONDRIAN_SourceForge\open\mondrian\src\main\mondrian\resource\MondrianResource_en_US.java is up to date<br>
&nbsp;&nbsp; [resgen]
C:\MONDRIAN_SourceForge\open\mondrian\classes\mondrian\resource\MondrianResource_en_US.properties
is up to date<br>
&nbsp;&nbsp; [resgen] C:\MONDRIAN_SourceForge\open\mondrian\src\main\mondrian\resource\MondrianResource_de_DE.java is up to date<br>
&nbsp;&nbsp; [resgen]
C:\MONDRIAN_SourceForge\open\mondrian\classes\mondrian\resource\MondrianResource_de_DE.properties
is up to date<br>
&nbsp;&nbsp; [resgen] C:\MONDRIAN_SourceForge\open\mondrian\src\main\mondrian\resource\MondrianResource_de.java is up to date<br>
&nbsp;&nbsp; [resgen]
C:\MONDRIAN_SourceForge\open\mondrian\classes\mondrian\resource\MondrianResource_de.properties
is up to date<br>
&nbsp;&nbsp; [resgen] C:\MONDRIAN_SourceForge\open\mondrian\src\main\mondrian\resource\MondrianResource_es_ES.java is up to date<br>
&nbsp;&nbsp; [resgen]
C:\MONDRIAN_SourceForge\open\mondrian\classes\mondrian\resource\MondrianResource_es_ES.properties
is up to date<br>
<br>
def:<br>
<br>
compile.java:<br>
<br>
compile:<br>
<br>
info:<br>
&nbsp;&nbsp;&nbsp;&nbsp; [echo] ==============================================================<br>
&nbsp;&nbsp;&nbsp;&nbsp; [echo] | Mondrian configuration
info&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
|<br>
&nbsp;&nbsp;&nbsp;&nbsp; [echo] ==============================================================<br>
&nbsp;&nbsp;&nbsp;&nbsp; [echo] project.location&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; = C:\MONDRIAN_SourceForge\open\mondrian<br>
&nbsp;&nbsp;&nbsp;&nbsp; [echo]
jdk.home&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
= C:\Program Files\Java\jdk1.5.0_05<br>
&nbsp;&nbsp;&nbsp;&nbsp; [echo] catalina.home&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; = C:\apache-tomcat-5.5.12<br>
&nbsp;&nbsp;&nbsp;&nbsp; [echo] junit.home&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; = C:\junit4.0<br>
&nbsp;&nbsp;&nbsp;&nbsp; [echo] mondrian.foodmart.catalogURL = file:C:\MONDRIAN_SourceForge\open\mondrian/demo/FoodMart.xml<br>
&nbsp;&nbsp;&nbsp;&nbsp; [echo] mondrian.foodmart.jdbcURL&nbsp;&nbsp;&nbsp; = jdbc:odbc:MondrianFoodMart<br>
&nbsp;&nbsp;&nbsp;&nbsp; [echo]
mondrian.jdbcDrivers&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; =
sun.jdbc.odbc.JdbcOdbcDriver<br>
&nbsp;&nbsp;&nbsp;&nbsp; [echo] ==============================================================<br>
<br>
compile.tests:<br>
<br>
jar:<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [jar] Building jar: C:\MONDRIAN_SourceForge\open\mondrian\lib\mondrian.jar<br>
<br>
workbench:<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [jar] Building jar: C:\MONDRIAN_SourceForge\open\mondrian\lib\workbench.jar<br>
<br>
BUILD SUCCESSFUL<br>
Total time: 47 seconds<br>
<p>This will create <code>lib/workbench.jar</code>.&nbsp;Include drivers for your database on the classpath.</p>


<p>To start the workbench., at the command prompt, type</p>
<p>In Windows:</p>
<blockquote>
<pre>ant workbench-run<br></pre>
<p>Or the following</p>
<pre>java -jar lib/workbench.jar<br></pre>

</blockquote>


<p>In UNIX/Linux:</p>

<blockquote>
<pre>java -jar lib/workbench.jar </pre>

</blockquote>
</td>

</tr>


<tr>
<td style="vertical-align: top;"><p>Set properties for
connection to your cube database via <code>Tools > Preferences</code>.</p>

<td style="vertical-align: top;">
<p>Set properties for
connection to your cube database via <code>Tools &gt; Preferences</code>.</p>


<blockquote>
<p><img src="images/workbench_preferences.png"></p>

<p><img src="images/workbench_preferences.png"></p>

</blockquote>


<p>These preferences and the last 4 schemas edited are kept in a "workbench.properties" file in the root of the classpath.</p>


<p>If you change the connection properties, you will need to close/save the existing schema editor(s) and restart to
see the effects.</p></td>
see the effects.</p>
</td>

</tr>


<tr>

<td style="vertical-align: top;">

<p>Create a new schema or open an existing one.</p>


<p>If you open an existing schema, the Workbench validates that the tables
and columns underlying the cube definitions actually exist in the
database.</p>


<blockquote>
<img src="images/workbench_get_schema.png">
</blockquote>

</td>

</tr>


<tr>

<td style="vertical-align: top;">

<p>Create or edit elements in the schema. The Workbench validates your changes against the cube database tables and column names.</p>


<blockquote>
<img src="images/workbench_database_validation.png">
</blockquote>


<p>The Workbench validates edits against the Mondrian schema DTD.</p>


<blockquote>
<img src="images/workbench_database_error.png">
</blockquote>

</td>

</tr>


<tr>

<td style="vertical-align: top;">

<p>Save your schema and run some MDX queries to test.
Error messages and results are displayed.</p>


<blockquote>
<img src="images/workbench_mdx_query_runner.png">
</blockquote>

</td>

</tr>


</tbody>
</table>


<p>&nbsp;</p>

<hr noshade size="1"/>

<hr noshade="noshade" size="1">
<p>
Author: Sherman Wood, JasperSoft; last modified April 2007.<br/>
Author: Sherman Wood, JasperSoft; last modified April 2007.<br>

Version: $Id$
(<a href="http://p4web.eigenbase.org/open/mondrian/doc/workbench.html?ac=22">log</a>)<br/>
(<a href="http://p4web.eigenbase.org/open/mondrian/doc/workbench.html?ac=22">log</a>)<br>

Copyright (C) 2007 JasperSoft<br>

Copyright (C) 2007-2007 Julian Hyde and others</p>

<br />

<br>


<!-- doc2web end -->

Expand Down

0 comments on commit 674ef90

Please sign in to comment.