Knowledge Base Article Knowledge Base Article

Getting started » Install on eXo Platform

Install on eXo Platform

eXo is a great java portal: intuitive to use, an awesome look, and a large set of web applications embedded. It shares the same trunk as Gatein, and therefore inherits of a great portlet container which is perfectly suited to Visioneo reportlet windows! This tutorial has been realized with the Open Source eXo Platform 4.0.6 bundled with Tomcat, and visioneo v2.0.final

Overview

Visioneo application has been originally developed on Gatein Portal, and consequently is very easy to embed in eXo Platform!

Adjust JVM configuration

If you have just downloaded eXo platform bundle, once it is unzipped you need to change a few configuration parameters.

eXo documentation recommends using" setenv-customize.bat" (windows) or "setenv-customize.sh" (Linux) in order to customize JVM setup. These files are located under $TOMCAT_HOME/bin folder, with a "sample" suffix to disable them. For example on Windows we have to rename "setenv-customize.sample.bat" to "setenv-customize.bat", and uncomment in this file the settings we want to change. The most important points are:

  • increase  EXO_JVM_PERMSIZE_MAX. Keep in mind a BIRT engine is a very large application, and eXo platform already embeds an impressive set of portlets/gadgets.
  • Facultative (but recommended for a first install): set EXO_TOMCAT_UNPACK_WARS to true.
    • It makes customization easier, we can directly change files (portlet.xml, css, jsp...) under <eXo tomcat root>/webapp/<exploded folder of the application>. 
    • If not unpacked: we can still customize everything in the .WAR file, and redeploy it. 
    • If not unpacked: the reportlet application can't access .rptdesign demo reports with a relative path. By default only the default radar chart report will be available, we need to setup an absolute path for birtReportPath & birtResourcePath parameters in portlet.xml.

For this tutorial, below setup has been used:

REM ---------------------------------------------------------------------------
REM Default JVM configuration
REM ---------------------------------------------------------------------------
SET EXO_JVM_SIZE_MAX=1g
SET EXO_JVM_SIZE_MIN=1g
SET EXO_JVM_PERMSIZE_MAX=512m
SET EXO_JVM_PERMSIZE_MIN=512m
 
REM ---------------------------------------------------------------------------
REM Default Tomcat configuration
REM ---------------------------------------------------------------------------
REM Global Tomcat settings
SET EXO_TOMCAT_UNPACK_WARS=true

Deploy visioneo reportlet on eXo

Well, it could'nt be easier:

  • Stop eXo, if it is started
  • Drop your downloaded visione-portlet.war into  $TOMCAT_HOME/webapps
  • Done! 

Tomcat will automatically deploy the application when eXo starts.

It is recommended to keep the deployment context unchanged: in this case, it is simply the name of the .WAR file "visioneo-portlet.war". If you want to use a different context name, you need to update gatein-resources.xml file consequently. 

Start eXo portal

See eXo Platform help for more informations

With a tomcat bundle:

Register visioneo portlet

Login to your eXo platform portal, typically http://localhost:8080/portal/classic/home

Under the admin menu, select "Applications"

 

Click "Import Applications", and confirm. You should then be able to see Visioneo reportlet among other eXo web applications, in "Categories" portlet window. 

 

Your birt portlet is now ready to use! Edit a page and add one or more reportlet(s) within. In this example we take advantage of the "container" eXo widget to set up a layout with 2 columns. We drag & drop a visioneo portlet into each column. We also put a content portlet in the first column (in picture below we named it "Dashboard comment"), to be able to add live comments related to our dashboard.

 

Then open "Edit mode" to set up each reportlet window: we select here which birt report to display, default values of report parameters , and tons of facultative configuration settings! Here, we set a radar chart report in the first reportlet, and a treemap report in the second one.

We can also  select the grey theme (default is blue), because it is well suited to the default eXo theme. More important, in the "Report" tab, we need to reduce the report width, which is 800px by default. For this example we set up 525px for each reportlet window. 

When you want to apply your reportlet preferences, since the popup window displayed by eXo is pretty small, most of the time whe need to use a vertical scrollbar to reach the Visioneo "Apply" button. 

If you want to use the maximization feature, in "Portlet Setting" enable the info bar:

Save the page and enjoy your dashboard! The first run of a report is always a bit longer, a BIRT engine needs to warm up first!

Portal user attributes in your BIRT reports

eXo platform smartly implements JSR portlet specifications, thus we are able to take advantage of user portal attributes in dataset queries! See this article for more informations

Install a light visioneo package (Deprecated)

A visioneo light package is more flexible than a quickstart one: it makes possible to restart the reportlet application independantly in a few seconds, without problems which may be caused by a birt platform restart. However with eXo, to take advantage of a light package we need to resolve a conflict between birt runtime and eXo platform.

In order to install a "light" visioneo package with Tomcat eXo bundle,  we have to:

  • remove a jar <eXo server root>/lib/rhino-1.7R3.jar
  • copy js.jar contained in a birt runtime (1.7.R2 rhino version) to <eXo server root>/lib
  • Install dependencies as described in Getting started article
  • install a visioneo light bundle .WAR as described above for a quickstart bundle

This way it will work. Though there could be side effects in some eXo applications using rhino since it is an older version. Therefore in addition we can override it in these applications, by copying rhino-1.7R3.jar into WEB-INF/lib folders of these applications. 

With a jBoss7 server it would be easier (at least theorically...) because we could just exclude rhino-1.7R3.jar from the reportlet application.

Tags: install
Average (0 Votes)
Most Recent
Install on Jahia 26 April 2015
Getting started 01 April 2015
Install on Gatein 07 February 2014