Knowledge Base Article Knowledge Base Article

Getting started » Install on Liferay » Install with Liferay Marketplace
Install with Liferay Marketplace

Install from Liferay Marketplace

Install Visioneo portlet through the awesome Liferay Marketplace! 

Visioneo application makes use of these third-party software.


Permanent memory (MaxPermSize)

If your server makes use of java 8 then you can ignore this MaxPermSize section

Visioneo portlet is a large application because it embeds a BIRT runtime. Therefore, memory argument "MaxPermSize" of your portal should be increased before install. 

Usually Liferay 6.x bundles are setup with 256 Mb, basically we have to increase it of 100Mb.  For example we can set it to 512 Mb, with a tomcat bundle or a jboss bundle it would be:

  • Stop Liferay portal
  • Edit your configuration file:
    • Tomcat, Jetty: edit <Tomcat home>/bin/setenv.bat   
    •  jBoss: edit <Jboss home>/bin/standalone.conf.bat
    • Glassfish
      • use Glassfish  administration console (typically http://localhost:4848 default login: admin pwd: <blank>)
      • alternatively if you have troubles with this console, edit domain.xml: typically it would be <glassfish home>/domains/domain1/config/domain.xml
  • replace MaxPermSize=256m  with MaxPermSize=512m
  • Start Liferay portal
Heap memory
The default heap memory of a Liferay bundle (1Gb) is fine to evaluate the product, but in a production context increase it as much as you can. A few examples:
  • the configuration used for latest Visioneo loading tests (from 30 to 50 concurrent users running continuously reporting actions) has 3 Gb heap memory.
  • currently runs on a virtual server with only 1Gb heap memory and java 8. The portal is never restarted unless a new Visioneo version is deployed.
  • Windows 32 bits servers should not exceed about 1.5Gb heap memory

Edit your configuration file as explained above for MaxPermSize argument, and this time adjust -Xmx argument

In this example we set it to 2 Gb: -Xmx2048m
That's it! You liferay portal is now ready to become a first-class reporting platform! 

Remove older Visioneo versions

If an older Visioneo version was already installed, we need to remove it first.

  • Backup your portlet.xml file if you customized it (<visioneo home>/WEB-INF/portlet.xml)
  • In Liferay control panel ->  ("Application Manager" with Liferay 6.2, and "Update Manager" with older Liferay versions) -> Remove visioneo reportlet
  • Stop the portal
  • Check in your deployment folder if visioneo-portlet  application has been completely removed  (i.e. in Tomcat: <Tomcat home>/webapps/visioneo-portlet). If this folder still exists, remove it manually. 

Deploy visioneo app

The install process works like a charm with Liferay 6.2. Just click install from "purchased" screen, it might last a few minutes.

With Liferay 6.1.x, you have to check the max file size allowed by your portal: Control panel -> Server Administration ->  File upload -> Document & Media-> Max file size -> Set 60000000 or higher (60 Mb). With the default setup (3 Mb) it would fail to download, and you get the "Please wait..." spinner forever. Please visit this topic for more informations.

At the end of the process, in your Liferay server console / logs you will see something like:

[PortletHotDeployListener] 5 portlets for visioneo-portlet are available for use (3 portlets for versions older than 2.2)

If your console is stuck on the step  "Deployment will start in a few seconds...", you have to restart Liferay to complete the install.

Check Visioneo category in Liferay UI

When the application is deployed, we can see in liferay applications new portlets under a "Visioneo" category. If you can't see this new category, please stop / restart the portal to complete the install. This issue sometimes occurs with large plugins such Visioneo portlet.

With version 2.2, here is what we see:


Both Professional and Community Editions have these 5 portlets available. However only two of them are actually useable with a Community Edition (see details below), others are specific to Professional Edition features. Let's go for a review:

Name Description Community Edition
 BIRT report This is the main portlet, a complete reporting application formerly named "Visioneo reportlet" in the control panel. It allows to display BIRT reports and interact with parameters, drill actions and export in various formats Yes
 Toolbar buttons (From version 2.2) Very simple portlet allowing to run visioneo actions from outside a report window  Yes
 External parameter Powerful portlet allowing to display report parameters outside a report window. a limited mode is made available in the Community Edition: we can display external parameters, but they won't refresh reports. Thus you can evaluate how it will be easy to define external parameters in your portal pages, if you decide later to purchase a professional edition! Demo only
 Repository BIRT (From version 2.2) Allows to test and store your BIRT repository location in the database of the portal.  Demo only
 Refresh button Very simple portlet allowing to refresh a report from outside a report window.  Demo only


Define your first reportlet window!

Drag & drop a BIRT report on a portal page. The first actions are always longer to be run, it is normal a BIRT engine needs to be warmed up!  

Click the portlet options to access "preferences mode", and select your report preferences. For example select the "welcome" report to see all parameter types in action! 

With the default configuration, the reportlet window is maximized when this mode is selected. Thus it is more convenient to edit your preferences:

Note that Liferay makes use of specific and very convenient configurations files to extend the portlet.xml descriptor, especially liferay-portlet.xml. This file is located in /WEB-INF folder, for instance on tomcat: <Tomcat home>/webapp/visioneo-portlet/WEB-INF/liferay-portlet.xml

Define security roles

If you use a default Liferay bundle, the security roles should be already correctly setup in liferay-portlet.xml, you can ignore this sectionIn this file, you will find these entries:

                    <role-link>Power User</role-link>  

For each entry, "role-name" is the internal role used by Visioneo, when "role-link" is the Liferay role name as you can see it in the Control Panel of the portal . These roles can be accessed from BIRT reports if necessary. By the way, we can access to any information related to the logged user from birt reports, including Liferay "Custom fields"! 

To start up, the most important role to check is "administrator". You can see in the reportlet admin dialog which roles are correctly mapped.

Add your own BIRT reports

Develop your own BIRT reports using Eclipse report designer, and upload them to Liferay portal. They are immediately available through Visioneo portlet windows! See how to add reports & subfolders for more informations.

From version 2.2, the report-design below is available in all distributions and is completely standalone (it does not make use of any resource such an image or a library).

If you just begin with BIRT:

How to restart Visioneo application?

If you need to restart Visioneo application (for example after some changes in "portlet.xml" descriptor), then you should restart Liferay portal. It is important, if you restart Visioneo separately a couple of times your application server might face to memory troubles.

Average (0 Votes)