Requirements
- A private flex.bi installation that 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 a private flex.bi database.
Installation
Ask flex.bi support to provide a download URL for the latest private flex.bi full distribution .zip file.
Unzip the downloaded full distribution .zip file in directory of your choice. It will create a flexbi_private
subdirectory where all private flex.bi files will be located.
Note |
---|
On Windows there exists a length limit for the file path - 260 characters. Flex.bi has a deep nested directory structure. System full file paths may exceed this limitation if the |
Table of Contents
Directory structure
The flexbi_private
directory contains the following subdirectories and files:
app
- for private flex.bi customizations (e.g. custom layouts or view templates)bin
- startup and other shell scriptsconfig
- configuration filesdata
- for storing uploaded filesflexbi_private.jar
- main application archive filelib
- additional Ruby files or *.jar files (added if necessary)log
- web request and queue job log files
Database setup
flex.bi will store data in an additional MySQL, PostgreSQL, Microsoft SQL Server or Oracle database. It is recommended that you create a separate database user for flex.bi (by default with the name flexbi_private
) which will then create additional databases on the specified database server.
...
The following are specific database server instructions for flex.bi database setup.
Panel | ||||
---|---|---|---|---|
MySQLYou can create a separate
(Replace secret with yur chosen password). When you specify the database connection parameters in flex.bi then a flex In addition you should download MySQL JDBC driver and copy the included Please also tune MySQL memory settings to speed up data import and data queries. The following
|
Panel | ||||
---|---|---|---|---|
PostgreSQLYou need to create a separate user
If you do not want to add the Each new flex.bi account will store data in a new Please tune PostgreSQL memory parameters. The following
|
Panel | ||
---|---|---|
Microsoft SQL ServerCreate a MS SQL Server user Each new flex.bi account will store data in a new OracleCreate an Oracle database user
In this configuration all flex.bi data will be stored in one |
Start application
On Mac OS X and Linux start the application with the bin/start.sh
shell script. Please review the bin/start.sh
script and if necessary customise it (e.g. increase Java memory parameters in the JAVA_OPTS
environment variable).
...
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.
eazybi.toml configuration file
In the config/eazybi.toml file you can configure different flex.bi parameters. The configuration file use the TOML format. Please see comments and commented examples for each section in this file.
...
In the accounts section you can provide the connection parameters and schema definition files for accounts with custom schemas. See “FoodMart custom” account as example.
Linux service startup script
bin/init.d/flexbi.sample
is a Linux service startup script which can be modified and copied to /etc/init.d/flexbi
. Please specify the EAZYBI_HOME
variable in this script to point to the flexbi_private
directories full path. By default this startup script will use $EAZYBI_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.
Windows service
Private flex.bi distribution by default does not include support for running as a Windows service. But you can use an application like AlwaysUp to create a Windows service that will start bin\start.bat
file from the Private flex.bi installation directory.
Provide access to flex.bi from other computers
By default Private flex.bi will be accessible just locally at the address http://localhost:8080
. If you want to provide access to Private flex.bi from other computers then edit bin/start.sh
or bin\start.bat
and add -b 0.0.0.0
at the end of the startup command (see comments for further explanation).
...
Note |
---|
On Linux or Mac OS X if you would like to start an application which listens to HTTP port 80 then you need to start application as |
Export to PDF using PhantomJS
If you would like to export dashboard pages to the PDF format 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 the eazybi.toml
file.
Troubleshooting
If the Private flex.bi initial page does not open or opens with error message then check the console output or check the log file log/eazybi-web.log
for any error messages.
...