Requirements
- Private flex.bi installation is supported on Mac OS X, Linux and Windows.
- Java SE 7 or Java SE 8 should be installed.
- MySQL (version 5.x), PostgreSQL (version 9.x), MS SQL (version 2008 or later) and Oracle (version 11g or later) are supported as Private flex.bi database.
Installation
Ask flex.bi support to provide download URL for latest private flex.bi full distribution zip file.
Unzip downloaded full distribution zip file in a selected directory. It will create flex.biflexbi_private
subdirectory where all private flex.bi files will be located.
...
app
- for private flex.bi customizations (e.g. custom layouts or view templates)bin
- startup and other shell scriptsconfig
- configuration filesdata
- for storing uploaded fileseazybiflexbi_private.jar
- main application archive filelib
- additional Ruby files or *.jar files (added if necessary)log
- web request and queue job log files
...
You can create a separate user flexbi_private
and grant access to all MySQL databases which start with flex.biflexbi_private
prefix:
GRANT ALL PRIVILEGES ON `flexbi_private%`.* TO 'flexbi_private' @ '%' IDENTIFIED BY 'secret' ; |
(Replace secret with chosen password). When you will specify the database connection parameters in flex.bi then flex.bi_private
then a flexbi_private
database will be created. Later when additional flex.bi accounts will be created then each account data will be stored in separate databases with names flexbi_jira_dwh_N
where N is account ID number.
In addition you should download download the MySQL JDBC driver and copy the included mysql-connector-java-*.jar
to flex.biflexbi_private/lib
directory (MySQL JDBC driver is not included in Private flex.bi distribution due to GPL license restrictions).
...
You can create separate user flex.biflexbi_private
with database creation rights:
CREATE ROLE flex.biflexbi_private PASSWORD 'secret' LOGIN CREATEDB; |
If you do not want to add add the CREATEDB
role to flex.bito the flexbi_private
user then manually create manually the database flex.biflexbi_private
with flex.bi database with flexbi_private
user as an the owner.
Each new flex.bi account will store data in a new flex.biflexbi_jira_dwh_N
schema (where N is account ID number) in the same database.
...
shared_buffers
will specify how much database data PostgreSQL can store in the memory - adjust it to your available server memory (the more data PostgreSQL will store in the memory the less disk input/output operations will be performed). wal_buffers
affects performance of writing transaction logs to disk.
Microsoft SQL Server
Create a MS SQL Server user flex.biflexbi_private
– 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 the creation of new databases) or create manually flex.bimanually create the flexbi_private
database with flex.biflexbi_private
user as an the owner.
Each new flex.bi account will store data in a new flex.biflexbi_jira_dwh_N
schema (where N is account ID number) in the same database.
Oracle
Create an Oracle database user flex.biflexbi_private
:
CREATE USER flex.biflexbi_private IDENTIFIED BY secret DEFAULT TABLESPACE users; GRANT CONNECT, RESOURCE TO flex.bi_private; |
In this configuration all flex.bi data will be stored in one flex.biflexbi_private
schema.
Start application
...
Wait until you see the message Listening for HTTP requests on localhost:8080
and then open http://localhost:8080
in your browser – you should see the flex.bi settings page.
In the flex.bi settings page specify database connection parameters for flex.biflexbi_private
database. By default all flex.bi account specific data will be stored in the same database (as described earlier in Database section). If you want you can select Use separate DWH database option and specify a different database where account specific schemas (with uploaded or imported data) should be stored. Database connection parameters will be stored in config/database.toml
file.
In addition in the settings page please specify your flex.bi license information – the license name and key. License information will be stored in the config/eazybiflexbi.toml
file.
If database and license information will be correct then you will be redirected to a sign up page where you can create the first system administration user account.
...
flexbi.
...
toml configuration file
In config/flexflexbi.bi.toml
file you can configure different flex.bi parameters. The configuration file uses TOML format. Please see comments and commented examples for each section in this file.
...
Linux service startup script
bin/init.d/flex.biflexbi.sample
is a Linux service startup script which can be modified and copied to /etc/init.d/flex.bi
. Please specifyflex.biflexbi_HOME
variable in this script to point to flex.biflexbi_private
directory full path. By default this startup script will use $flex.bi$flexbi_HOME/bin/start.sh
to start flex.bi – if needed then create a separate copy of start.sh
script if different parameters should be used when starting flex.bi as a service.
...
If you would like to export dashboard pages to PDF or send regular emails with flex.bi dashboards as PDF attachments then please install PhantomJS on your Private flex.bi server and specify its location in flexflexbi.bi.toml
file.
Troubleshooting
If Private flex.bi initial page does not open or opens with error message then check either console output or check the log file log/flex.biflexbi-web.log
if it has any error messages.
After flex.bi has started up it will store its log files in log
subdirectory:
flex.biflexbi-web.log
contains log of web requestsflex.biflexbi-queues.log
contains log of background queue jobs
...