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.

1 - Prerequisites

Glassfish server is not yet supported when Portal Access Control List (Liferay PACL) is enabled.

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 (only if PACL is disabled, as mentionned above)
      • 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
The default heap memory of a Liferay bundle (1Gb) is fine to evaluate the product, but increase it upto 2Gb or more if you can. For example the configuration used for latest Visioneo loading tests (from 30 to 50 concurrent users running continuously reporting actions) has 3 Gb 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! 

2 - 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. 

3 - 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] 3 portlets for visioneo-portlet are available for use

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

4 - Check Visioneo category in Liferay UI

When the application is deployed, we can see in liferay applications 3 new portlets under a "Visioneo" category:

  • Visioneo reportlet
  • Visioneo external parameter
  • Visioneo refresh button

 If you can't see this new category, you  need to stop / restart the portal to complete the install. This issue sometimes occurs with large plugins such Visioneo portlet. 

 

With a Visioneo Community Edition (CE) we only need  "Visioneo reportlet".  This portlet is a full reporting software, containing everything we need to display birt reports, select parameters values, run export etc.

"External parameter" and "Refresh" portlets are mainly intended to the Professional Edition. Though 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!

5 - Define your first reportlet window!

Drag & drop visioneo reportlet on a portal page. The first actions are always longer to be run, it is normal a BIRT engine needs to be warmed up!  If you didn't change the portlet descriptor (portlet.xml file), by default a "radar" report is displayed. 

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

6 - Define security roles

If you use a default Liferay bundle, the security roles should be already correctly setup in liferay-portlet.xml, you should not have anything to do. Anyway it is very simple. In this file, you will find these entries:

        <role-mapper>  
                    <role-name>manager</role-name>  
                    <role-link>Administrator</role-link>  
        </role-mapper> 
        <role-mapper>  
                    <role-name>administrator</role-name>  
                    <role-link>Administrator</role-link>  
        </role-mapper>   
         <role-mapper>  
                    <role-name>standard</role-name>  
                    <role-link>User</role-link>  
        </role-mapper>      
         <role-mapper>  
                    <role-name>poweruser</role-name>  
                    <role-link>Power User</role-link>  
        </role-mapper>
 

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 your 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 your Liferay server. They are immediately available through Visioneo portlet windows! See how to add reports & subfolders for more informations.

 

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. This point should be fixed in next version.

Average (0 Votes)