Checklist before installation
The latest eazyBI version supports Jira versions from 7.0 to 8.11. In addition, you will need MySQL 5.5 - 5.7, PostgreSQL 9.x or 10.0, MS SQL Server 2008 or later, or Oracle 10g or later database. The eazyBI plugin should work on Linux, Windows, and macOS. You can also check supported versions in Atlassian Marketplace.
Please contact eazyBI support if you have questions about supported versions or if you have any issues with your specific environment.
For Jira versions from 7.0 to 8.11 only Java 8 is supported by Atlassian (and is bundled with Windows and Linux installation packages). Starting from Jira version 8.2 also Java 11 is supported. Only Oracle or OpenJDK JVMs are supported.
Jira memory settings
Please review your current Jira memory settings before installing eazyBI. If your Jira server will not have enough available memory then eazyBI might fail to start as well as overall Jira performance could be affected.
To ensure better performance of eazyBI it is recommended to set Jira Java VM available memory to 2 GB or more. See Increasing Jira Memory for detailed instructions on how to do it in your Jira installation.
JVM_MAXIMUM_MEMORY=2048m in your
setenv.bat file (if you run Jira as Windows service then please follow Increasing Jira Memory / Windows service instructions instead). Later while using eazyBI check Jira Administration / System / Troubleshooting & Support / System Info / Java VM Memory Statistics page to see how much available memory is used and if it is necessary to increase it more.
If eazyBI plugin startup fails and you get
SystemStackError: stack level too deep errors in
localhost.*.log file (please see Troubleshooting for file location) then you have specified too low
-Xss max stack size setting for Java VM. You can see if this
-Xss option is used in Jira Administration / System / Troubleshooting & Support / System Info / JVM Input Arguments. Please either remove
-Xss option or increase it (recommended setting is
-Xss1024k) until eazyBI plugin starts without “stack level too deep” error.
It is possible to run eazyBI report queries in a separate JVM process. Please read more about the Child process option if you would like to enable it.
You can check your current JVM default encoding in Jira Administration / System / Troubleshooting & Support / System Info / System Encoding.
Download the eazyBI add-on from the Atlassian Marketplace page or install using Jira Add-ons Manager.
You should have Jira system administration rights to install add-ons. Go to the main Administration screen and then go to the Add-ons link. Then either find and install the eazyBI add-on from Atlassian Marketplace, or if you have downloaded the add-on then go Manage Add-ons page and upload the downloaded eazyBI add-on file.
After eazyBI add-on installation, click the Configure link to navigate to the eazyBI settings page. Or if you click Exit Administration then you should 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 Jira 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 Jira 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_jira) 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 Jira XML backup or in the Jira database schema backup.
The following are database server specific instructions for eazyBI database setup.
If you migrate the eazyBI database and change the database adapter, you might get an error. To solve this, please disable and re-enable the eazyBI app before continuing.
As a MySQL administrator create a MySQL user
eazybi_jira with access rights to all databases which start with eazybi_jira:
secret with a chosen password). When you will save eazyBI settings then a database connection will be established and a database will be created. Later when additional eazyBI accounts will be created then each account data will be stored in separate databases with names
eazybi_jira_dwh_N where N is the account ID number.
You should add the MySQL JDBC driver to your application server. If you have done it already for the Jira main database then you don’t need to do anything, eazyBI will use the same installed MySQL JDBC driver.
If you have a large number of Jira issues then for faster eazyBI Jira data import it is recommended to tune MySQL memory settings. The following
my.cnf settings are recommended:
innodb_buffer_pool_size will specify how much database data MySQL can store in memory – adjust it to your available server memory (the more data MySQL will store in memory the less disk input/output operations will be performed). If you will change
innodb_log_file_size then it will require that you delete existing MySQL log files before starting the MySQL server.
max_connections as needed based on MySQL usage by all applications. eazyBI connection pool will use up to 50 database connections.
Please ensure that MySQL eazybi_jira database tables are using the InnoDB storage engine (which is a default starting from MySQL 5.5) and not the old MyISAM storage engine.
Create a PostgreSQL database user with
After saving eazyBI plugin settings, a new
eazybi_jira database will be created and each new eazyBI account will store data in a new
dwh_N schema (where N is the account ID number) in the same database.
If you have a large number of Jira issues then for faster eazyBI Jira data import it is recommended to tune PostgreSQL memory settings. The following
postgresql.conf settings are recommended:
shared_buffers will specify how much database data PostgreSQL can store in memory – adjust it to your available server memory (the more data PostgreSQL will store in memory the less disk input/output operations will be performed).
wal_buffers affects the performance of writing transaction logs to disk.
max_connections as needed based on PostgreSQL usage by all applications. eazyBI connection pool will use up to 50 database connections.
If you are using the SSL mode to connect to PostgresSQL sever, note that the default SSL mode in the driver of eazyBI is
verify_full . Starting from eazyBI version 5.3.0 it is possible to switch the SSL mode by using the Database advanced settings. The following settings switches the SSL to "require" mode:
Please, check the PostgreSQL documentation for more details on what are the possible options of SSL mode.
Microsoft SQL Server
Create an MS SQL Server user
eazybi_jira – if you will use SQL Server Management Studio then select SQL Server authentication and uncheck Enforce password policy. In addition, from Server Roles select
dbcreator (to allow creation of a new
eazybi_jira database). If you do not want to grant the
dbcreator role to this user then create the
eazybi_jira database manually and use the
eazybi_jira user as the owner of this database.
In database connection settings, provide the host name, leave the port blank (if default 1433 is used) and leave the instance blank (if default should be used) and enter a database, username, and password. After saving the settings, a new database will be created (if not yet present) and each new eazyBI account will store data in a new
dwh_N schema (where N is the account ID number) in the same database.
By default, eazyBI uses a bundled jTDS JDBC driver to connect to Microsoft SQL Server. The jTDS driver does not support an SSL connection to SQL Server. If SSL is required for your SQL Server connection, then you can use the Microsoft JDBC driver which supports SSL connections. Please download the latest JDBC driver and copy
sqljdbc41.jar into the
lib subdirectory of the Jira installation directory (by default
C:\Program Files\Atlassian\JIRA\lib). After re-enabling eazyBI you should see both jTDS and Microsoft JDBC driver options in the settings page.
Create an Oracle database user
eazybi_jira. For example, create from
sqlplus with the Oracle
secret with chosen password). Please make sure eazybi_jira user has no
TABLESPACE quota or it is large enough. In the database connection settings, provide a host name, database name (instance or SID name of database), username and password. You can use the same database instance that is used by Jira, all eazyBI data will be stored in a separate
eazybi_jira user schema.
eazyBI will use the Oracle JDBC driver
ojdbc8.jar from the Jira installation directory
lib subdirectory. If you are using Oracle as a Jira database then this JDBC driver file should be present there. If you run Jira on another database than Oracle and want to use the SQL database sources in eazyBI, you should add this file manually. In this case, the Jira restart might be needed for Jira to detect the new driver.
If you would like to specify in database connection settings the Oracle service name instead of SID name, then please prefix it with
/. So in the Database field use either
You can also specify the Oracle database connection's TNS alias (when using the
tnsnames.ora file) or a full TNS connection string. In this case, do not specify a Host name in the eazyBI database connection parameters, just specify the TNS alias or a connection string in the Database name:
- When using a TNS alias then please ensure that
oracle.net.tns_adminJava property is set to the TNS admin directory.
- When using a TNS full connection string then you do not need to set this Java property, you can enter in the Database name the full connection string, for example:
It is recommended to set the
OPEN_CURSORS system parameter to 1000. eazyBI keeps open prepared statements for frequently used SELECT, INSERT and UPDATE statements and calls them with different bind variable values.
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.
Database advanced settings
You can use the eazyBI Database advanced settings (eazyBI → System Administration → Settings → tab General) to change eazyBI database parameters.
It is recommended that you test them first in a test environment.
Increase database max pool size
Available from the eazyBI version 5.0.0.
In previous eazyBI versions (till version 4.6.3), the parameter was defined in Advanced settings. Please remove the parameter from your eazyBI advanced settings when upgrading to eazyBI version 5.0.0 or more recent.
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 an example following settings will increase max pool size to 40
Before increasing this parameter, please check your database maximum allowed connections. By default, eazyBI could use up to 50 connections, but increasing this parameter will lead to more connections used.
You can calculate total max connections using the following formula:
(pool size connections for main eazyBI process) + (pool size connections for eazyBI Child process, if it's enabled) + (maximum concurrent report queries, see Increase concurrent report queries)
For example, if you increase the database connection pool to 40 connections and use the eazyBI Child process, then eazyBI could use up to 40 + 40 + 10 = 90 connections.
Please read more about the Child process option which is recommended for larger Jira Server instances.
Select license type Atlassian Marketplace (if you created a trial license key there) or eazybi.com (if you received a beta tester license key).
Enter the corresponding license key (and also organization name in case of eazybi.com license type). If there will be any issues with entered license name or key then you will see the corresponding error message.
If you are using Atlassian Marketplace license and latest versions of Add-ons Manager then license information will be entered in Add-ons Manager and in this screen you will only see current license information.
After you have entered database connection and license information click Update database and license settings to continue.
If you need to return back to eazyBI Settings screen then log in as Jira user with system administration rights and in any eazyBI page click on System Admin link on the top right corner and then select Settings.
Perform the first Jira data import
If database connection and license information were correct, then eazyBI database will be created as well as first eazyBI account (with the default name “Jira reports”). In one eazyBI account, you can import one or several Jira projects, create reports, charts and dashboards and give access to selected Jira users and groups. If in your Jira server you have many different projects which 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 Jira projects.
After clicking Create, a new Jira source application will be created and you can
- select which Jira projects you would like to import in first eazyBI account
- select if you would like to import status transitions history
- how frequently a regular issue import should be scheduled (by default once per day)
- select custom fields which to import (read more about supported custom field types)
Click Import to start the issues import.
Check import results
After the import is completed, go to 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 Jira server.
Export of large tables to Excel or CSV
If you will need to export to Excel or CSV tables with many thousand rows then please see Jira server configuration instructions.
REST API request error
eazyBI Jira import will perform REST API requests from the Jira server to itself (which is necessary for Jira Agile and Tempo Timesheets data import). If you see an error
Failed to make a REST API request to the Jira Base URL ...
in the settings page then it means that there are Jira server setup problems which do not allow to make such REST API requests. Potential causes for these problems are the following:
If your Jira server uses an HTTPS connection and you also see the following message:
Please install Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files to enable SSL certificate validation for REST API requests
If your java version is >= than 1.8.0_151 then you can set the unlimited policy in the
<JAVA_HOME>/jre/lib/security/java.securityfile search for the line
#crypto.policy=unlimitedand remove the
#character to uncomment it and save the file. You will have to restart Jira to take this into action.
For older versions you need to download the file from the given link (JAVA7 - http://www.oracle.com/technetwork/java/javase/downloads/jce-7-download-432124.html, JAVA8 - http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html) and copy files US_export_policy.jar and local_policy.jar to the directory <JAVA_HOME>/jre/lib/security (or for even older version in <JAVA_HOME>/lib/security), where JAVA_HOME is the java.home in Jira Administration / System / System Info.
For Java 11 this is enabled by default.
The Jira server name (from Jira Base URL) is not resolved to the correct IP address on the Jira server. If you are using a Linux server then try to test it with the following command from the Jira server:
where JIRA_BASE_URL is the Base URL in Jira Administration / System / System Info. Please send the output of this command to eazyBI support if you need help to resolve this issue.
Other potential cause can be port mapping using
iptableswhich probably is mapping ports just for incoming connections and not for local connections.
Please see the Local REST API requests section in advanced settings documentation to learn more how to disable local REST API requests or to specify a different Jira base URL for local REST API requests.
Microsoft's IIS data import error
If you are using Microsoft IIS web server which proxies the incoming requests to Jira, then you might get an error message when clicking the Import button in the Source Data tab. The potential cause for this error is that IIS can be configured to return custom error messages and IIS is discarding the body of HTTP requests with the HTTP status code 422. To ensure that the HTTP body is returned for these error messages, you need to set the <httpErrors> element attribute existingResponse value to PassThrough.
Please read more about the IIS error page configuration.
If the initial eazyBI page does not open or opens with an error message, then check in the Jira installation directory
logs subdirectory log files with name
localhost.*.log. Please provide these log files to eazyBI support.
After eazyBI has started it will create own log files.
Sometimes after reinstalling add-ons, Jira is not releasing all memory and it might cause slowdown. In this case, try restarting Jira server process.
Please contact eazyBI support if you have any issues with eazyBI installation and setup.