Deployment
Prerequisites
-
Operating Systems: Independent.
We have tested OpenI on Linux (Red Hat, Suse) and Windows
(XP/2003/2000). Since OpenI is completely Java-based, it
should run on any operating system that has a compatible
JVM.
- OLAP Server: Supports Mondrian and Microsoft Analysis
Services.
With release 1.1, OpenI distribution includes a copy of open
source OLAP server Mondrian,
which is used as the default OLAP server instance. Since OpenI
utilizes the XMLA protocol to connect to OLAP servers, you
can use OpenI with any XMLA-compliant OLAP server, such as
Microsoft Analysis Services. If you are planning to use OpenI
with Microsoft Analysis Services, you will need to have an
instance of Microsoft Analysis Services running WITH the XMLA
interface provider. See setup details in the Set
up XMLA Provider | Microsoft Analysis Services (msas)
section.
- Application Server: Any J2EE server.
OpenI is a J2EE web application and is deployed as a web archive
(WAR) file. In order to deploy it, you will need a J2EE server
(like tomcat) installed and running. Default instance of OpenI
assumes you have at least 2 logins defined on your J2EE server,
"admin" and "tomcat", which by default
have access to the sample projects bundled with OpenI. See
more on security in Application
Security section.
- Database (optional): Any relational database server
(with JDBC support if using Mondrian).
Although the default installation of OpenI doesn't directly
connect to a database, the OLAP servers do require at least
one database instance. While Microsoft Anlaysis Services uses
its native drivers to connect to the database, Mondrian uses
JDBC drivers to connect to the database. To run the sample
project included with OpenI, we provide instructions on setting
up a MySQL database in Set up XMLA Provider
| Mondrian section.
Install
OpenI from Binary
-
- Copy the openi.war, openi-projects.war,
and mondrian.war into the webapps folder
of your J2EE server. For example, if you are running tomcat
as your J2EE server on Linux:
- cp openi.war <tomcat_home>/webapps/
- cp openi-projects.war <tomcat_home>/webapps/
- cp mondrian.war <tomcat_home>/webapps/
- Restart J2EE server if necessary
Note: If you are upgrading from a previous version of OpenI
(or Mondrian) on Tomcat, then you need to manually clean up
all OpenI and Mondrian related files from Tomcat's working
area as well. To do this: go to <tomcat_home>/work/Catalina/locahost
folder, and delete folders named openi, openi-projects,
and mondrian.
-
- Log in using "admin" username (default application
assumes you have a username "admin" defined in your
J2EE security database, and that it belongs to a security
group or role called "admin" . For more details,
see the Security section)
-
To build OpenI from source, you will need tomcat installed on the build machine (version 5.0.x or above).
We include all the jar files and class files exposed by tomcat to its appliactions (in <tomcat_home>/common/classes, common/endorsed, common/lib,
shared/classes, shared/lib) in the classpath to compile the OpenI codebase.
-
- Unzip contents into an empty folder
- Make a copy of build.template.properties and rename
it to build.properties
-
Change entries in build.properties
to match your environment:
- catalina.home should refer to your tomcat home
directory, e.g. catalina.home=/usr/share/tomcat
- Windows users: Remember to use forward slashes (/) as
directory name separator. For e.g. "c:/applications/tomcat",
not "c:\applications\tomcat\"
-
Compile OpenI:
-
Copy the WAR files to J2EE server's webapps
folder:
-
- Log in using "admin" username (default application
assumes you have a username "admin" defined in your
J2EE security database, and that it belongs to a security
group or role called "admin" . For more details,
see the Security section)
Set up XMLA Provider Interface
Mondrian
When using Mondrian as an XMLA provider, you can use your existing
Mondrian cubes, or use the sample foodmart project. Either way,
you must first install the mondrian.war that comes with OpenI.
Please note that this is a newer version than the official 1.1.5
Mondrian release, and it includes bug fixes to support XMLA
interface.
cp openi/mondrian.war <tomcat_home>/webapps
Integrate with existing Mondrian cubes
-
Copy existing FoodMart.xml (existing
mondrian cube definition file) to <tomcat_home>/webapps/mondrian/WEB-INF/queries
-
Configure your <tomcat_home>/webapps/mondrian/WEB-INF/datasources.xml,
Catalog property in DataSourceInfo should
match with the location of your cube definition file from
previous step.
Running Mondrian with Sample App under MySql
-
Install mysql
-
Create foodmart database: mysqlcreate
foodmart
-
Create foodmartuser at mysql prompt:
mysql> grant all privileges on foodmart.* to foodmartuser@'localhost'
identified by 'foodmartpassword'
-
From command prompt, run the create database
script:
mysql -u foodmart -p < openi/conf/mondrian/create-foodmart-mysql.sql
-
Copy openi/mondrian.war to <tomcat_home>/webapps/
(if you haven't already)
-
Customize mondrian datasources, making sure
the servername, user, passwords all match up to the values
you just created:
<tomcat_home>/webapps/mondrian/WEB-INF/datasources.xml
<DataSourceInfo>
<![CDATA[Provider=mondrian;
Jdbc=jdbc:mysql://localhost/foodmart?user=foodmartuser&password=foodmartpassword;
JdbcDrivers=com.mysql.jdbc.Driver;Catalog=/WEB-INF/queries/FoodMart.xml]]>
</DataSourceInfo>
Microsoft Analysis Services (msas)
OpenI communicates with Microsoft Analysis Services (MSAS)
as the XMLA-based OLAP server, using MSAS with service pack
3a and XMLA SDK version 1.1. To enable the XMLA interface
of an MSAS instance, you need to follow these steps (in the
exact order):
- See Instructions
at msdn site
- We are assumming you have already installed Microsoft
Analysis Services. If not:
- Install SQL 2000 (optional) and apply Service Pack
3a.
- Install Microsoft Analysis Services (MSAS) and apply
Service Pack 3a.
- On the machine where MSAS is installed, install IIS 6.0
- Install Microsoft XML Core Services (MSXML). Use MSXML
4.0 for the 1.1 version of the XML Download
here
- Install XML for Analysis SDK 1.1 Download
here
- Create virtual directory (/xmla), using path to C:\Program Files\Microsoft XML For Analysis SDK\Isapi
- Enable web service extension(name = xmla, path to C:\Program Files\Microsoft XML For Analysis SDK\Isapi\mdxisapi.dll
- Verify installation: goto http://localhost/xmla/msxisapi.dll
you should see something like this:
<?xml version="1.0" ?>
- <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
- <SOAP-ENV:Body>
- <SOAP-ENV:Fault>
<faultcode>XMLAnalysisError.88BA0800</faultcode>
<faultstring>The Web Service supports only
the POST operation.</faultstring>
<faultactor>XML for Analysis Provider</faultactor>
- <detail>
- <faultstring>
<Error ErrorCode="2293893120"
Description="The
Web Service supports only the POST operation."
Source="XML
for Analysis Provider" />
</faultstring>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
- You can also try running one of the xmla sdk sample applications
in your xmla install directory:
- C:\Program Files\Microsoft XML For Analysis SDK\Samples
- Unfortunately, these do not come compiled, and in order
to compile these, you need either VB or the .NET SDK. It
is recommended that you have one of these samples handy,
because they are quite useful when debugging the jpivot+xmla
implementation.
Configure OpenI Datasource
Once OpenI and the appropriate XMLA provider interface are
installed and running, don't forget to configure the OpenI
datasources. A datasource definition defines the XMLA interface
URL that OpenI will use to discover and query the OLAP cubes.
To do this:
-
Go to http://localhost:8080/openi
-
Login as an administrator (application
adminstrator or project administrator)
-
Go to Administration | Configure Datasource
-
There are 2 default datasource definitions
provided with OpenI: msas, which assumes a local
instance of Microsoft Analysis Services with a sample Foodmart
2000 olap database, and mondrian, which assumes
a local instance of Mondrian with its own sample Foodmart
database. Each datasource is defined by a URL (e.g. http://localhost:8080/mondrian/xmla)
which points to the XMLA interface, and the name of a catalog,
which defines the name of the olap database. Based on the
OLAP datasource you are using, Mondrian or Microsoft, edit
either the msas or mondrian datasource
to make sure it is pointing to the correct URL, port number,
and the catalog.
Application Security
There are 3 built-in role definitions in the OpenI web application.
Here is a table summarizinng their authorization rules:
| Role |
Project visibility |
Project Administration |
Save Public |
Save Private |
Configure Datasource |
Create New |
| app admin |
all projects in subdomain |
YES |
YES |
YES |
YES |
YES |
| project admin |
must be declared for each project |
YES |
YES |
YES |
YES |
YES |
| project user |
must be declared for each project |
NO |
NO* |
YES |
YES |
YES |
* Project users can request a project admin to publish their
private reports into public folders
OpenI ships with two built-in usernames: "admin",
which has "app admin" privileges, and "tomcat"
which has "project user" privileges for the sample
project. These usernames MUST BE defined in the J2EE security
database and the "admin" login MUST BE assigned
to a group/role called "admin". Of course, you can
create your own logins and assign them to any of these roles.
For example, if you have a Tomcat deployment using the default
security database, you need to ensure the following:
-
Find <tomcat-home>/conf/tomcat-users.xml
-
Configure a user in the admin role as
follows:
<user username=”admin” password=”password”
roles=”admin”/>
<user username=”tomcat” password=”password”/>
Note: By default, the "admin" role has application
admin level access to OpenI application, which is defined
in <tomcat-home>/webapps/openi/WEB-INF/web.xml,
and the "tomcat" user has user-level access to the sample
"openi" project, which is defined in <tomcat-home>/webapps/openi-projects/openi/project.xml.
-
Find <tomcat-home>/conf/server.xml
-
Ensure you have the following definition
entry for the security realm:
<Realm className="org.apache.catalina.realm.UserDatabaseRealm"
debug="0" resourceName="UserDatabase"/>
-
In Tomcat’s case, you have a choice
of other security realms based on where you want to store
the user database (see http://jakarta.apache.org/tomcat/tomcat-5.0-doc/realm-howto.html).
Based on the security realm you choose for the OpenI web
application, you need to ensure that the user database has
the users and roles defined in it.
Alternately, if you don’t want to use these usernames
and would rather have your existing usernames to have access,
you can directly modify the OpenI web application’s
web.xml itself. For this:
-
Find <tomcat-home>/webapps/openi-projects/WEB-INF/application.xml
and open it in an editor
-
Find the entry named <ApplicationAdmins>
which should look like: <applicationAdmins>admin</applicationAdmins>
-
Replace admin by a comma-separated list
of usernames (note that these usernames will have "application
admin" level access to the application, i.e. they can
view/modify all the projects)
Concept of a Project
OpenI uses the concept of projects to define a specific collection
of OLAP reports. Each project has its own look-and-feel definitions,
list of reports, and security hierarchy.
In fact, this concept flows over from our “real-life”
implementation of OpenI – where we serve different “clients”
from a single OpenI instance and each “client”
needs their own space carved out within the OpenI instance.
So, for example, when client A accesses the OpenI URL, they
only see their “projects”, while client B sees
a completely different list of projects, and so on. We feel
that this concept is more universal than just in the case
of different clients needing to see separate list of projects.
For example, projects can be department-specific, where within
an organization, you have an “accounting” project
with accounting related reports, a separate “marketing”
project with marketing related reports, and so on. That way,
you separately setup access rights and administration separately
for each project so accounting can’t see marketing reports
and vice-versa.
Sample Project
The default binary distribution contains one project called
"foodmart". All projects are contained in the openi-projects.war.
If you look under <tomcat-home>/webapps/openi-projects,
you will see a "foodmart" folder, which is for the
"foodmart" project. Each project is essentially
a similar folder underneath the "openi-projects"
folder.
Create a New Project
To create a new project, you can simply make a copy of the
"foodmart" folder under "open-projects"
and rename it (project name must be unique). Each project
has the following contents:
-
project.xml -- this has project-specific
properties, most of them are configurable via the "Administration
- Manage Project" link on the OpenI site.
-
images -- folder for project-specific
image files
-
public -- folder for "public"
analyses, i.e. analysis that are visible to all users that
have access to the project
-
In addition, there is a folder for each
user who has created "private" analyses. These
analyses are only visible to the user, and hence are kept
under a folder under the username.
To further configure the new project, access the project
by logging into the web interface (http://localhost:8080/openi)
as an application admin. You should see the project listed
in the main page. Once you are inside the project, expand
"Administration" on the left nav, and click on "Manage
Project". This enables you to define the following:
-
Project Name: Name of the project for
display purposes
-
Stylesheet: Stylesheet to use for project's
HTML look and feel
-
Logo: Logo image for the left navigation
top and for the initial project list
-
Splash Image: Image to display when a
user first enters into the project
-
Splash Page: HTML content to display when
a user first enters into the project
-
Menu Module Configuration: Top-level nodes
(categories) for the left navigation
-
Project Admins: list of comma-separated
usernames that will be "project admins" for this
project
-
Project Users: list of comma-separated
usernames that will be "project users" for this
project
-
Project Category: Category under which
the project should be filed in the initial project list
page
- Header Message: Configurable message that can replace the
default datetime display on the top right of the site
Once the project is set up, you can start
defining data sources and create new reports under the context
of that project. More details are available in the User
Guide. Also, a "living" version of OpenI documentation
is available at OpenI wiki.
|