SpagoBI 3 - Installation Angelo Bernabei 2011/06/20 16:49
spagobi_server - SpagoBI 3 - Installation
Table of Contents Install JDK .............................................................................................................................................................................. Install Tomcat ......................................................................................................................................................................... Install SpagoBI Metadata DB ................................................................................................................................................ Deploy SpagoBI WebApplication on Tomcat ....................................................................................................................... Configure SpagoBI ................................................................................................................................................................. Edit server.xml ..................................................................................................................................................................... Set Up Data Source ............................................................................................................................................................. Set up Environment variables .............................................................................................................................................. Context /SpagoBI ................................................................................................................................................................. Context /SpagoBI*Engine .................................................................................................................................................... Thread Manager ................................................................................................................................................................... Some additional Libraries ...................................................................................................................................................... Run & Test... ..........................................................................................................................................................................
Page 2 - last modified by Angelo Bernabei on 2011/06/20 16:49
3 3 3 3 4 4 4 4 5 5 5 5 6
spagobi_server - SpagoBI 3 - Installation
• • • • •
Install JDK Install Tomcat Install SpagoBI Metadata DB Deploy SpagoBI WebApplication on Tomcat Configure SpagoBI ° Edit server.xml ° Set Up Data Source ° Set up Environment variables · Environment variable: resource-path · Environment variable: spagobi-sso-class · Environment variables: spagobi-service-url · Environment variables: spagobi-host-url ° Context /SpagoBI ° Context /SpagoBI*Engine ° Thread Manager • Some additional Libraries • Run & Test... These are the steps to install SpagoBI:
Install JDK If you haven't installed JVM ( 1.5 or 1.6 )in your computer, you have to download it from SUN site and install it.
Install Tomcat Download Tomcat 6.0.18 from http://tomcat.apache.org/download-60.cgi and unzip apache-tomcat-6.0.18.zip. To test if the installation is correct, you have to: • try to double-click on apache-tomcat-6.0.18/bin/startup.bat • Open Browser to http://localhost:8080 • You should be able to see the "Tom cat"
Install SpagoBI Metadata DB SpagoBI use a schema to store some information about configuration, document template, etc... You have to create this schema using a SQL script according to your DBMS Type ( Oracle... MySQL .. etc...): you can find available scripts in "Scripts db" package of SpagoBI Server release. Those released files may contain, apart from .sql scritps, a README.txt file and patches to be applied to SpagoBI Server: in this case you have to follow the instructions of README.txt after having deployed SpagoBI war files as explained here below. For example, in MySql you have to open "MySql Query Browser" and execute this file: • MySQL-create.sql • MySQL-create-quartz-schema.sql And to recreate Foodmart you have to open "MySql Administrator" and execute an import of foodmart DB. Remember to change the MySQL File dimension ( my.ini)
Deploy SpagoBI WebApplication on Tomcat Copy all WAR in WEBAPP Folder of Tomcat, run Tomcat with startup.bat. This operation extracts all WAR files and allows you to edit the configuration files. Don't worry if Tomcat writes some type of error in console or log files
Page 3 - last modified by Angelo Bernabei on 2011/06/20 16:49
spagobi_server - SpagoBI 3 - Installation
Configure SpagoBI And now you have to edit some configurations file.
Edit server.xml This is the main configuration file of Tomcat and in this file we have to • Set up DataSource • Set up Environment variables From the version *2.3* the context information are embedded in *META-INF/context.xml*, these files are already included in all packages. If you don't use the 6.0.18 version of Tomcat you have to check in [ http://www.apache.org ] how these configurations are made.
Set Up Data Source To add a new Data Source you have to insert this fragment of XML under <GlobalNamingResources> <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" /> <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" /> The first is the Connection poll for SpagoBI metadata and the second is the Connection pool for Foodmart ( the DWH for demos ) The JDBC driver must be presented in the folder lib
Set up Environment variables To add a new Variable you have to insert this fragment of XML under <GlobalNamingResources> <Environment name= "<VARIABLE-NAME>" type= "java.lang.String" value= "<VARIABLE-VALUE>" /> Remember to insert in each Context the resource-link: <ResourceLink global= "<VARIABLE-NAME>" name= "<VARIABLE-NAME>" type= "java.lang.String" /> Environment variable: resource-path <Environment name= "spagobi-resource-path" type= "java.lang.String" value= "C:\spagobi2.0\resources" /> SpagoBI Server uses this path to read some resources like: • • • • •
QBE DataMart Mondrian XML schema Talend JOB Image included in report HTML file
Remember to create this PATH !!!!! Environment variable: spagobi-sso-class <Environment name= "spagobi-sso-class" type= "java.lang.String" value= "it.eng.spagobi.services.common.FakeSsoService" /> These classes implements the interaction between SpagoBI and the SSO system. • it.eng.spagobi.services.common.FakeSsoService(NO SSO) • it.eng.spagobi.services.cas.CasSsoService ( CAS 2.0 )
Page 4 - last modified by Angelo Bernabei on 2011/06/20 16:49
spagobi_server - SpagoBI 3 - Installation
• it.eng.spagobi.services.cas.CasSsoServiceNoProxy( CAS 2.0 , without WebService Security ) • it.eng.spagobi.services.cas.CasSsoService3 ( CAS 3.0 ) • it.eng.spagobi.services.cas.CasSsoService3NoProxy ( CAS 3.0, without WebService Security ) Environment variables: spagobi-service-url <Environment name= "spagobi-service-url" type= "java.lang.String" value= "http://localhost:8080/SpagoBI" /> This URL is only for back-end service You have to change this value if SpagoBI core and some Engines are not installed in the same server Environment variables: spagobi-host-url <Environment name= "spagobi-host-url" type= "java.lang.String" value= "http://localhost:8080" /> This URL is used to produce some address in html. This is useful if there is a proxy server between the SpagoBI Server and the Browser
Context /SpagoBI These context information are embedded in META-INF/context.xml, but you can insert this xml in server.xml if you prefere. <Context docBase= "SpagoBI" path= "/SpagoBI" privileged= "true" reloadable= "true" > <ResourceLink global= "jdbc/spagobi" name= "jdbc/spagobi" type= "javax.sql.DataSource" /> <ResourceLink global= "jdbc/foodmart" name= "jdbc/foodmart" type= "javax.sql.DataSource" /> <ResourceLink global= "spagobi-resource-path" name= "spagobi-resource-path" type= "java.lang.String" /> <ResourceLink global= "spagobi-sso-class" name= "spagobi-sso-class" type= "java.lang.String" /> <ResourceLink global= "spagobi-host-url" name= "spagobi-host-url" type= "java.lang.String" /> </Context> You have to define /SpagoBI Context, this configuration depends on the Tomcat version ( check on [ http:// www.apache.org ] )
Context /SpagoBI*Engine These context information are true for all ENGINE and are embedded in META-INF/context.xml, but you can insert this xml in server.xml if you prefere. <Context docBase= "SpagoBIJasperReportEngine" path= "/SpagoBIJasperReportEngine" privileged= "true" reloadable= "false" > <ResourceLink global= "jdbc/foodmart" name= "jdbc/foodmart" type= "javax.sql.DataSource" /> <ResourceLink global= "jdbc/spagobi" name= "jdbc/spagobi" type= "javax.sql.DataSource" /> <ResourceLink global= "spagobi-resource-path" name= "spagobi&#95;resource-path" type= "java.lang.String" /> <ResourceLink global= "spagobi-sso-class" name= "spagobi-sso-class" type= "java.lang.String" /> <ResourceLink global= "spagobi-service-url" name= "spagobi-service-url" type= "java.lang.String" /> </Context>
Thread Manager SpagoBI uses a Thread manager in off-line activities to: • Execute Talend JOB • Execute Process ( CommonJ Engine ) It's possible to configure the number of thread, in server.xml you have to put: <Resource auth= "Container" factory= "de.myfoo.commonj.work.FooWorkManagerFactory" maxThreads= "5" name= "wm/SpagoWorkManager" type= "commonj.work.WorkManager" /> *Important*: you have to put this resource link in /SpagoBITalendEngine and /SpagoBICommonJEngine Context: <ResourceLink global= "wm/SpagoWorkManager" name= "wm/SpagoWorkManager" type= "jcommonj.work.WorkManager" />
Some additional Libraries Each SpagoBI WebApplication contains all required libraries to run, for the resources defined in server.xml you have to include these libraries in /LIB folder.
Page 5 - last modified by Angelo Bernabei on 2011/06/20 16:49
spagobi_server - SpagoBI 3 - Installation
• • • • •
commonj-twm.jar concurrent.jar mysql-connector-java-3.1.13-bin.jar foo-commonj.jar some required libraries for JDBC Drivers.
You can find these libraries in source distribution or All-In-One-SpagoBI-3.x.x-apache-tomcat-6.0.18-xxxx.zip
Run & Test... Open Browser : [ http://localhost:8080/SpagoBI ] You can use this users: • • • • •
biadmin bitest bimodel bidev biuser
The password and username are the same.
Page 6 - last modified by Angelo Bernabei on 2011/06/20 16:49