The new SpagoBI (version 3.6.0) – Installation instructions and Troubleshooting

SpagoBI released their new version i.e. 3.6.0 with more enhancements and bug fixes on Oct 22 last month. This tool is becoming more popular worldwide now, and user will get the new version more attractive and stronger from the last version. You can get the release notes at http://forge.ow2.org/project/shownotes.php?release_id=5019 , which will help you to know the changes and enhancements done in this version.

Easy way to install from windows installer

  1. Download “InstallerSpagoBI-3.6_06112012.zip” from http://forge.ow2.org/project/showfiles.php?group_id=204.
  2. Extract the zip file in your preferred location and run the setup file i.e. SpagoBI.exe.
  3. Follow the setup instructions to complete the installations.
  4. Login into the server at http://localhost:8080/SpagoBI/ with biadmin / biadmin and play with the examples. This installation will work with HSQL and it has examples for different reporting engines.

Notes: After you install SpagoBI with sample data, you can configure it to work with external database. Please find mysql configuration steps in sections below.

Manual installation on Windows/Linux from All-In-One package:

  1. Download “All-In-One-SpagoBI-3.6.0_22102012.zip” from http://forge.ow2.org/project/showfiles.php?group_id=204.
  2. Extract the zip file in your preferred location and run the startup fileWindows: run the batch file i.e. /bin/SpagoBIStartup.bat (You should have admin permission or, run the cmd through administrator)Linux: run ./SpagoBIStartup.sh from inside /bin folder (Run it from sudo command or, root account)
  3. Login into the server at http://localhost:8080/SpagoBI/ with biadmin/biadmin and play with the examples.

Notes: After you install SpagoBI with sample data, you can configure it to work with external database. Please find mysql configuration steps in sections below.

Configure external database MySQL:

  1. Install SpagoBI Metadata DB (MySQL)
    1. Install MySQL 5.1 or, later.
    2. Download “mysql-dbscript-3.6.0 _22102012.zip” from http://forge.ow2.org/project/showfiles.php?group_id=204.
    3. Create a mysql database named “spagobi” and import the schema from .sql file downloaded above with following command:
      mysql –u<username> –p<password>  spagobi < MySQL_create.sql
      mysql –u<username> c –p<password>  spagobi < MySQL_create_quartz_schema.sql
  2. Configure data sources
    • Open /conf/server.xml and add a new Data Source, fragment of XML under <GlobalNamingResources> tags,

e.g. <Resource auth=”Container” driverClassName=”com.mysql.jdbc.Driver” maxActive=”20″        maxIdle=”10″ maxWait=”-1″ name=”jdbc/spagobi” password=”root” type=”javax.sql.DataSource” url=”jdbc:mysql://localhost/spagobi” username=”root”/>

This is the Connection poll for SpagoBI metadata.

    • We can add more data sources for each data warehouse we have.

e.g. <Resource auth=”Container” driverClassName=”com.mysql.jdbc.Driver” maxActive=”20″ maxIdle=”10″ maxWait=”-1″ name=”jdbc/foodmart” password=”root” type=”javax.sql.DataSource” url=”jdbc:mysql://localhost/foodmart” username=”root”/>

    • Comment all previous data sources which were present for HSQL.
    • Make sure the context information for data sources defined above are embedded in /webapps/SpagoBI\META-INF /context.xml. You can insert this xml in server.xml if you prefer.

i.e.
<ResourceLink global=”jdbc/spagobi” name=”jdbc/spagobi” type=”javax.sql.DataSource”/>

<ResourceLink global=”jdbc/foodmart” name=”jdbc/foodmart” type=”javax.sql.DataSource”/>

  1. Configure DBMS Type
    • We must configure DBMS type used by SpagoBI under \webapps\SpagoBI\WEB-INF\classes\hibernate.cfg.xml

                          <property name=”hibernate.dialect”>org.hibernate.dialect.MySQLDialect</property>

                           <!–

                           <property name=”hibernate.dialect”>org.hibernate.dialect.SQLServerDialect</property>

                           <property name=”hibernate.dialect”>org.hibernate.dialect.PostgreSQLDialect</property>

                           <property name=”hibernate.dialect”>org.hibernate.dialect.Oracle9Dialect</property>

                           <property name=”hibernate.dialect”>org.hibernate.dialect.IngresDialect</property>

                           <property name=”hibernate.dialect”>org.hibernate.dialect.HSQLDialect</property>

                           <property name=”hibernate.dialect”>org.hibernate.dialect.DB2400Dialect</property>       

                            –>

    • Then we would need to configure hibernate dialect for JBPM workflow engine: look at file /webapps/SpagoBI/WEB-INF/classes/jbpm.cfg.xml, there is a reference to JBPM hibernate file:

<string name=’resource.hibernate.cfg.xml’ value=’jbpm.hibernate.cfg.xml’ />

May be you read jbpm.hibernate.cfg.hsql.xml instead of jbpm.hibernate.cfg.xml,           jbpm.hibernate.cfg.hsql.xml is the hibernate file suitable for HSQLDB; if you are not using HSQLDB change resource.hibernate.cfg.xml property to jbpm.hibernate.cfg.xml.

    • Then, edit /webapps/SpagoBI/WEB-INF/classes/jbpm.hibernate.cfg.xml and change the following as according to your database server.

<property name=”hibernate.dialect”>org.hibernate.dialect.MySQLDialect</property>

    • At last you have to configure Quartz scheduler engine: edit /webapps/SpagoBI/WEB-INF/classes/quartz.properties you will read something like:

# job store delegate class –

# Hsqldb delegate class

org.quartz.jobStore.driverDelegateClass=org.quartz.impl.jdbcjobstore.HSQLDBDelegate

# Mysql/Ingres delegate class

#org.quartz.jobStore.driverDelegateClass=org.quartz.impl.jdbcjobstore.StdJDBCDelegate

# Postgres delegate class

#org.quartz.jobStore.driverDelegateClass=org.quartz.impl.jdbcjobstore.PostgreSQLDelegate

# Oracle delegate class

#org.quartz.jobStore.driverDelegateClass=org.quartz.impl.jdbcjobstore.oracle.OracleDelegate

#-

Uncomment the job store delegate class suitable to your database server and comment all others.

  1. Database schema configuration

When creating SpagoBI metadata tables, they should be put into the default schema of the JDBC connection’s user.  In case this is not possible, you should edit hibernate.cfg.xml adding the following line:

<property name=”hibernate.default_schema”><name of the schema></property>

– modify SpagoBI/WEB-INF/classes/jbpm.hibernate.cfg.xml adding the following line:

<property name=”hibernate.default_schema”><name of the schema></property>

                Notes: you can skip this step.

  1. Restart the SpagoBI server, login into the server at http://localhost:8080/SpagoBI/ with biadmin / biadmin. This installation will work with MySQL , meta data.

Upgrade from older version to new version (Simple Upgrade):

  1. Stop the SpagoBI Server.
  2. Remove or, move (for backup purpose) your current SpagoBI installation folder.
  3. Install the latest version you want to install, through steps in section “Easy way to install from windows installer” or, “Manual installation on Windows/Linux from All-In-One package”.
  4. Download the upgrade script for MySQL from http://forge.ow2.org/project/showfiles.php?group_id=204 .
    Notes: Make sure you have downloaded the required version of script.
  5. Run the db script downloaded above and the upgrade is done.
  6. Start the SpagoBI server, login into the server at http://localhost:8080/SpagoBI/ with biadmin / biadmin. This installation will work with MySQL  upgrade version meta data.

Notes: This upgrade works well in case you have not done any personalization changes in installation files of older version.

Troubleshoot/Help for the issue I came across during installation: 

  1. Very first error we got was “Address already in use” as the shutdown port 8005 was already being used on the system. Changed the port to 7005 in server.xml (located under conf folder) and it worked.
  2. We came across another issue where everything were perfect but we were not able to see the login screen and it was showing an error as follows:

[main] 28 Dec 2011 09:13:46,072 ERROR it.eng.spagobi.commons.SingletonConfigCache.<init>:36 – The table sbi_config is EMPTY

[main] 28 Dec 2011 09:13:46,074 ERROR it.eng.spagobi.commons.SingletonConfigCache.get:53 – The property ‘SPAGOBI.DATE-FORMAT-SERVER.format’ doens’t have any value assigned, check SBI_CONFIG table

[main] 28 Dec 2011 09:13:46,074 ERROR it.eng.spagobi.commons.SingletonConfigCache.get:53 – The property ‘SPAGOBI.TIMESTAMP-FORMAT.format’ doens’t have any value assigned, check SBI_CONFIG table

[main] 28 Dec 2011 09:13:48,272 ERROR it.eng.spagobi.commons.initializers.metadata.MetadataInitializer.init:

163 – Error while initializing metadata

We explored the forums and different channels and came to know that this is a bug logged into Jira and they have uploaded a patch to be downloaded at http://www.spagoworld.org/jira/browse/SPAGOBI-712.
We downloaded the patch and extracted it into ……./webapps/SpagoBI/WEB-INF/classes, the server is working fine now.

3. While working with linux, once unzipped the “All-in-one….”  Package and tried to start spagoBI server with the command, sudo sh SpagoBIStartup.sh, I got a access denied error. I used chmod command and gave all permission to the folder as follows:

          chmod 777 –R SpagoBI-DEMO-3.5 and it worked.

Comments are closed.