On this page:
Checklist before installation
The latest eazyBI version supports Confluence versions from 6.0 to 7.14. In addition, you will need MySQL 5.5 - 5.7 (MySQL 8 is supported starting from the eazyBI version 6.2), PostgreSQL 9.x - 12.x, MS SQL Server 2008 or later, or Oracle 10g or later database. Linux, Windows, and macOS operating systems are supported. Please contact eazyBI support if you have questions about supported versions or if you have any issues with your specific environment.
Java 8 is supported for the Confluence versions 6.x and 7.x as well as Java 11 is supported starting from the Confluence version 7.1. Only Oracle or OpenJDK JVMs are supported.
Confluence memory settings
Please review your current Confluence memory settings before installing eazyBI. If your Confluence server will not have enough available memory then eazyBI might fail to start as well as overall Confluence performance could be affected.
To ensure better performance of eazyBI it is recommended to set Confluence Java VM available memory to 2 GB or more. See Confluence documentation for more information.
It is recommended to enable the Child process option to run eazyBI report queries in a separate JVM process.
It is recommended to use UTF-8 encoding for Confluence.
If NFS is used for the Confluence local or shared (in case of Data Center) home then it is recommended to use NFSv4 (instead of the old NFSv3).
eazyBI uses the "flock" command which may freeze when accessing files on the old NFSv3 mount and the locking is not properly configured. Please validate on all Confluence Data Center nodes that "flock" is working correctly if using the old NFSv3 (update CONFLUENCE_SHARED_HOME with the corresponding path):
The "flock" should finish after a few seconds. If it hangs for more than 10 seconds then it is not working properly. The most common cause is that a firewall is blocking ports used for file locking.
Download the eazyBI app and install it in Confluence Administration / Manage apps.
After the eazyBI app installation, click the Get started link to navigate to the eazyBI getting started page. After reloading the page you should also see the eazyBI link in the top navigation bar.
It might take about half a minute while eazyBI is loading for the first time. If you selected the eazyBI link then you should see the eazyBI welcome page. You should be logged in as a Confluence user with system administration rights to set-up eazyBI. Click Set up eazyBI to continue.
eazyBI will store data in an additional MySQL, PostgreSQL, Microsoft SQL Server, or Oracle database. You can use the same database server which is used by Confluence or you can also use a different database server. It is recommended that you create a separate database user for eazyBI needs (by default with the name
eazybi_confluence) which will then create additional databases in a specified database server.
Please make regular backups of the additional eazyBI database in the production environment. eazyBI database contents will not be included in the standard Confluence XML backup or in the Confluence database schema backup.
The following are database server-specific instructions for the eazyBI database setup.
If there will be any issues with establishing the database connection or with the database creation then you will see the corresponding error messages after clicking the Update button.
Increase database max pool size
Each eazyBI processes, like displaying report results or performing the import, requires a connection to the database. By default, eazyBI is allowed to use 20 concurrent connections to the database. If you see errors in log files like
ActiveRecord::ConnectionTimeoutError (could not obtain a database connection. The max pool size is currently 20; consider increasing it.)
Increase eazyBI connection pool size in eazyBI general settings tab under "Edit database advanced settings" link, as for example the following settings will increase max pool size to 40
Please read more about the Child process option which is recommended for larger Confluence Server and Confluence Data Center instances.
Select license type Atlassian Marketplace (if you created a trial license key there) or eazybi.com (if you have received a partner license key)..
Enter the corresponding license key (and also the organization name in case of eazybi.com license type). If there will be any issues with the entered license name or key then you will see the corresponding error message.
After you have entered the license information click Update license settings to continue.
If you need to return back to the eazyBI Settings screen then log in as a Confluence user with system administration rights and in any eazyBI page click on the System Admin link on the top right corner and then select Settings.
Perform the first Confluence data import
If database connection and license information were correct, then the eazyBI database will be created as well as the first eazyBI account (with the default name “Confluence reports”). In one eazyBI account, you can import one or several Confluence spaces, create reports, charts and dashboards and give access to selected Confluence users and groups. If in your Confluence server you have many different spaces that are used by different user groups then most probably you will need to create several eazyBI accounts and in each account import related subset of Confluence spaces.
After clicking Create, a new Confluence source application will be created and you can
- select which Confluence spaces you would like to import in the first eazyBI account;
- select if you would like to search queries;
- how frequently a regular issue import should be scheduled (by default once per day);
- select if page create, update, view events should be processed (necessary for importing page views).
Click Import to start the data import.
Check import results
After the import is completed, go to the Analyze tab and try to open sample reports.
Export to PDF
If you would like to export dashboard pages to PDF or send regular emails with eazyBI dashboards as PDF attachments then please install the headless Google Chrome browser and Microsoft's Core Fonts on your Confluence server.
If the initial eazyBI page does not open or opens with an error message, then check in the Confluence installation directory
logs subdirectory log files with the name
catalina.*.log. Please provide these log files to eazyBI support.
After eazyBI has started it will create its own log files.
Sometimes after reinstalling apps, Confluence is not releasing all memory and it might cause a slowdown. In this case, try restarting the Confluence server process.
Please contact eazyBI support if you have any issues with the eazyBI installation and setup.