You are on page 1of 11

SpagoBI Configuration

Alberto Ghedin
2014/07/29 12:08

......................................................................................... 6 Data Source Configuration ............................................................................................................... 11 Page 2 ................................................................................................. 10 JNDI name .................................................................... 10 Date Format ............................................................................... 10 Language .............last modified by Alberto Ghedin on 2014/07/29 12:08 ............................................................................. 6 SpagoBI Configuration .................................................................................................................................................................................................................................................. 10 Context name ............................................................ 9 Maximum file size ....................................................................................................................SpagoBI Configuration Table of Contents Engines Configuration ................................................................... 9 Database schema ...................................................................................................................................................... 7 Mail Server .......................................................................................................................................................................................................................................................................................... 8 DBMS Type .............................................................spagobi_server ......................... 5 External Engines .... 3 Internal Engines ........................................................................................................................................................................................................................................................................... 5 Summary of engine configuration options ................................................................................................................................................................................................................................................................................................................................................................................................................ 7 Logging ...................................................................................................................................................................................................................................................... 10 SpagoBI Installation as a portal application ..............................................................................................................................

• Engines Configuration ° Internal Engines ° External Engines ° Summary of engine configuration options • Data Source Configuration • SpagoBI Configuration ° Logging ° Mail Server ° DBMS Type · Database schema ° Maximum file size ° Date Format ° Language ° Context name ° JNDI name • SpagoBI Installation as a portal application Engines Configuration All Engines have a default configuration at startup. You can manually edit engines configuration via the Engines Management functionality under the Resources menu in SpagoBI homepage. please check here .SpagoBI Configuration This section describes the configuration procedure for SpagoBI 3 and later.spagobi_server . Page 3 .last modified by Alberto Ghedin on 2014/07/29 12:08 . For older versions.

Using the editor you can modify engine configuration as follows: • edit the URL of external engines.spagobi_server .last modified by Alberto Ghedin on 2014/07/29 12:08 . • create a duplicate instance of an engine to balance load. /SpagoBIJPivot ) For each type of engine the administrator can set: • • • • • • label name description document type: predefined list of document types that can be implemented using the engine engine type: external or internal Data Set: if this option is enabled.SpagoBI Configuration In this list you can find one instance of each engine type. in case you installed that engine in a diferent server.g.. There are 2 types of engines: • Internal: installed within /SpagoBI context • External: installed within a specific context (e. any analytical document of this type can be associated to a dataset from the document detail page Page 4 .

spagobi_server .SpagoBI Configuration • Data Source: if this option is enabled. External Engines In this case you need to set: • URL: the URL used by browser to call the Engine • Driver: the implementation class of specific driver Page 5 . any analytical document of this type can be associated to a data source from the document detail page Details about the configuration process for each engine are provided below. Internal Engines In this case you only need to set the implementation class.last modified by Alberto Ghedin on 2014/07/29 12:08 .

SpagoBIKpiInternalEngine EXTERNAL Name Data Set Data Source Birt X X Geo X JPivot X JPalo X JasperReport X QBE X X Talend Weka Worksheet Engine X ConsoleEngine X GeoReportEngine X Accessibility Engine X SmartFilterEngine X Data Source Configuration SpagoBI administrator must configure every DB connection used in documents under Resource -> Engines Management.engines.kpi.SpagoBIDashboardInt Chart X it.spagobi.eng.SpagoBIDossierInternalE Office Document it.officedocument.eng.engines.spagobi_server .documentcomposition.dashboard.SpagoBI Configuration Summary of engine configuration options INTERNAL Name Data Set Dashboard X Data Source Class it.dossier.engines.chart.spagobi. these connections can be used in Analitical Documents.engines.eng.spagobi. Once defined.eng.eng. Page 6 .eng.SpagoBIOfficeD Document Composition it.last modified by Alberto Ghedin on 2014/07/29 12:08 .spagobi.SpagoBID Kpi X it.engines.SpagoBIChartInternalEngin Dossier X it.engines.spagobi.spagobi.

properties There are four possible logging levels: • DEBUG • ERROR • WARN Page 7 . For example in Tomcat you have to define Connection Pool in server. After that.xml and add a resource link in every Context.SpagoBI Configuration There are two different options to configure the connection to a DB: • Use JNDI This is the recommended way. but you must configure JNDI resource in your Application Server. you can TEST your connection using button { The result should be: SpagoBI Configuration This section describes how to configure different options for SpagoBI. • Use JDBC In this case SpagoBI create a new connection for every document execution.spagobi_server . Logging Each WebApplication uses Log4J to log debug and error information.last modified by Alberto Ghedin on 2014/07/29 12:08 . remember to insert JDBC Driver Library in your System. You can adjust the logging verbosity level by editing the following file: WEB/classes/log4j.

from="spagobi@eng. Hence.SpagoBI Configuration • INFO Note: for more information about log4j configuration [ http://logging.eng.scheduler.spago.spagobi_server .PROFILES.org/log4j/ ] Each WebApplication writes its log file under TOMCAT_HOME/logs. Mail Server SpagoBI uses 3 mail profiles • scheduler: used by SpagoBI Scheduler • user: used to send documents by e-mail • kpi_alarm: used to send alarms These profiles can be configured via Tools -> Manages Configurations: In order to configure mail profiles.PROFILES.Log4JLogger" > <CONFIG trace_min_log_severity= "0" debug= "false" append= "true" trace_thread_name= "false" /> </LOGGER> </TRACING> Simply set debug="true" and debug for Spago will be enabled. if you want to debug Spago.it" Page 8 . Spago has a specific logging system that gets redirected in log4j.scheduler.smtphost="mail. SpagoBI uses Spago as J2EE Application Framewor.eng. select MAIL in the filter bar and you will be shown the mail profiles. This option can be changed if needed.last modified by Alberto Ghedin on 2014/07/29 12:08 .PROFILES.xml <TRACING> <LOGGER isDefault= "true" name= "Spago" class= "it. you will need to change the Spago Log Level at TOMCAT_HOME/webapps/SpagoBI/ WEB-INF/conf/config/tracing.apache. Below the parameters that can be configure for each mail profile: MAIL.smtpport="110" MAIL.it" v MAIL.scheduler.tracing.

0.PROFILES.eng.password="" MAIL.password="" DBMS Type It is compulsory to properly configure the type of DBMS used by SpagoBI. this file contains a reference to JBPM hibernate file: <string name= 'resource.cfg.eng.PROFILES.xml is the hibernate file suitable for HSQLDB.cfg.dialect">org.dialect">org.from" name="spagobi@eng.it" MAIL.user.cfg.scheduler.PROFILES.jdbcjobstore.driverDelegateClass=org.cfg.PROFILES.hibernate.user" name="" MAIL.smtphost="mail.it" MAIL.hsql.cfg.xml.hsql.scheduler.jdbcjobstore.0.xml' value= 'jbpm.xml instead of jbpm.jobStore.smtpport="110" MAIL.0.jdbcjobstore.hibernate.hibernate. then edit apache-tomcat-6.dialect. you need to configure the Quartz scheduler engine by editing apachetomcat-6.PROFILES. This can be done by editing apache-tomcat-6.xml by adding the following line: Page 9 . The file looks similar to what is shown below: # job store delegate class # Hsqldb delegate class org.kpi_alarm. Finally.dialect.jdbcjobstore.hibernate.user.hibernate.cfg.PROFILES.password="" MAIL.user="" MAIL.properties. in case you are using SpagoBI Scheduler.SQLServerDialect</property> <property name="hibernate.hibernate.smtpport="110" MAIL.hibernate.dialect.user.kpi_alarm. you should edit hibernate.hibernate. <property name= "hibernate.xml' /> In case your file reads jbpm.driverDelegateClass=org.18/webapps/SpagoBI/WEB-INF/classes/quartz.PostgreSQLDelegate # Oracle delegate class #org.cfg.dialect" >org.driverDelegateClass=org.hibernate.jobStore.18/webapps/SpagoBI/WEB-INF/classes/jbpm.quartz.hibernate.PostgreSQLDialect</property> <property name="hibernate. Database schema SpagoBI metadata repository (DB tables) should reside in the default schema of the user using the JDBC connection.from="spagobi@eng.dialect.it" MAIL. as shown below.xml and change <property name= "hibernate.PROFILES.dialect.kpi_alarm.dialect">org.HSQLDBDelegate # Mysql /Ingres delegate class #org.it" MAIL.dialect">org.quartz.quartz.user.MySQLDialect </property> according to your database server.PROFILES.SpagoBI Configuration MAIL.hibernate.xml: jbpm.DB2400Dialect</property> --> If you are using the SpagoBIWorkflowEngine.cfg.smtphost="mail.18/webapps/SpagoBI/WEB-INF/classes/jbpm.jobStore.quartz.hibernate.quartz.user="" MAIL.kpi_alarm.cfg.impl.PROFILES.HSQLDialect</property> <property name="hibernate.xml file and setting the proper Hibernate .dialect.impl.hibernate. In case this is not possible.cfg.quartz.driverDelegateClass=org.quartz.spagobi_server .dialect">org.last modified by Alberto Ghedin on 2014/07/29 12:08 .hibernate.impl.dialect" >org.jobStore.StdJDBCDelegate # Postgres delegate class #org.quartz.oracle.user. you also need to configure the Hibernate dialect for JBPM workflow engine.IngresDialect</property> <property name="hibernate.PROFILES.kpi_alarm.cfg.hibernate.xml property to jbpm.OracleDelegate #Simply uncomment the job store delegate class suitable to your database server and comment all others.hibernate.impl.xml As shwon below.PROFILES.Oracle9Dialect</property> <property name="hibernate. This is done by editing the hibernate.dialect. if you are not using HSQLDB change resource.PROFILES.MySQLDialect </property> <!-<property name="hibernate.dialect">org.dialect.

DATE-FORMAT-ES_ES.format"dd/MM/yyyy" SPAGOBI.DATE-FORMAT-EN_US.qrtz_ .default_schema" ><name of the schema ></property> .DATE-FORMAT-FR_FR.quartz.tablePrefix=<name of the schema>.DATE-FORMAT-SERVER.last modified by Alberto Ghedin on 2014/07/29 12:08 . The default language is read from the browser.LANGUAGE.DATE-FORMAT.default_schema" ><name of the schema ></property> .extJsFormat="d/m/Y" SPAGOBI. Language SpagoBI supports Java standard i18n.spagobi_server .format="dd/MM/yyyy" SPAGOBI.extJsFormat=valueCheck="m/d/Y" SPAGOBI.xml by adding the following line: <property name= "hibernate.[fr.extJsFormat="d/m/Y H:i:s" Note that these formats only affect formats of dates shown in documents parameter selection.DATE-FORMAT-IT_IT.extJsFormat="d/m/Y" SPAGOBI.ES]" SPAGOBI.format="dd/MM/yyyy" SPAGOBI. You can set different language supported via Tools -> Manages Configurations by changing the following properties of the LANGUAGE_SUPPORTED Category SPAGOBI.jobStore.modify SpagoBI/WEB-INF/classes/quartz.format="MM/dd/yyyy" SPAGOBI.format="dd/MM/yyyy" SPAGOBI. You can configure it via Tools -> Manages Configurations by editing the following properties of the DATE-FORMAT Category SPAGOBI.DATE-FORMAT-ES_ES.FR].format="dd/MM/yyyy" SPAGOBI.US]. The date format depends in general on the LOCALE options. To set a different maximum file size.format="dd/MM/yyyy hh:mm:ss" SPAGOBI.IT].LANGUAGES="[it. change the following property of GENERIC_CONFIGURATION Category SPAGOBI.modify the queries inside SpagoBI/WEB-INF/conf/config/statements.modify SpagoBI/WEB-INF/classes/jbpm.extJsFormat="d/m/Y" SPAGOBI.SpagoBI Configuration <property name= "hibernate.TIMESTAMP-FORMAT.cfg.xml adding the schema before tables' names. The format of dates actually passed to SpagoBI reports (as parameters values) do not depend on the LOCALE.extJsFormat="d/m/Y" SPAGOBI.DATE-FORMAT-IT_IT.DATE-FORMAT-EN_US.US" Context name You can change the context name via Tools -> Manages Configurations by changing this property of GENERIC_CONFIGURATION Category SPAGOBI.TEMPLATE_MAX_SIZE=5242880 Date Format It is possible to customize the date format displayed by SpagoBI drivers.hibernate.DATE-FORMAT-SERVER.LANGUAGE_SUPPORTED. Each user can choose the preferred language.DATE-FORMAT.extJsFormat="d/m/Y" SPAGOBI.default="en. Maximum file size You can set different values via Tools -> Manages Configurations.properties by adding the following line: org.[es.LANGUAGE_SUPPORTED.DATE-FORMAT-FR_FR.TIMESTAMP-FORMAT.SPAGOBI_CONTEXT=/SpagoBI JNDI name You can change the JNDI names used to lookup environment variables via Tools -> Manages Configurations by changing the following properties of the GENERIC_CONFIGURATION Category Page 10 .[en.

spagobi.xml where you can change some JNDI names such as: <INTEGRATION_CLASS_JNDI>java://comp/env/spagobi_sso_class </INTEGRATION_CLASS_JNDI> <SPAGOBI_SERVER_URL_JNDI_NAME>java://comp/env/spagobi_service_url </ SPAGOBI_SERVER_URL_JNDI_NAME> <RESOURCE_PATH_JNDI_NAME>java://comp/env/spagobi_resource_path </RESOURCE_PATH_JNDI_NAME> We recommend to chane these names only in case you have trouble with your Application Server SpagoBI Installation as a portal application You can install SpagoBI as simple WebApplication or in Portal Environment via Tools -> Manages Configurations by changing the SPAGOBI.0 is distributed as Web Application by default.init.security.eng.RESOURCE_PATH_JNDI_NAME= java://comp/env/spagobi_resource_path SPAGOBI_SSO. In addition. If you are using another portal you will need to insert other specific configurations. You may have problems with classloader and missing libraries. each External Engine has engine-config. you will need to: • Modify SPAGOBI.spagobi_server .SPAGOBI_HOST_JNDI= java://comp/env/spagobi_host_url SPAGOBI.SPAGOBI-MODE.SPAGOBI-MODE property of the GENERIC_CONFIGURATION Category SPAGOBI.xml • <! Start Initializer to enable when running in web mode > <INITIALIZER class= "it.init.xml eXo platform uses this listener.SecurityInitializer" config= "" /> <INITIALIZER class= "it. Page 11 .TREE_INITIALIZATION" /> <! End Initializer to enable when running in web mode > • Uncomment listner in TOMCAT_HOME/webapp/SpagoBI/WEB-INF/web.INTEGRATION_CLASS_JNDI=java://comp/env/spagobi_sso_class Note that these properties are valid only within SpagoBI core project.SpagoBI Configuration SPAGOBI.SPAGOBI-MODE. depending on the portal.mode="WEB or "PORTLET" SpagoBI 2.last modified by Alberto Ghedin on 2014/07/29 12:08 .eng.spagobi.TreeInitializer" config= "SPAGOBI.mode • Modify security connector ( read next paragraph ) • Comment inizializer in TOMCAT_HOME /webapp/SpagoBI/WEB-INF/conf/config/initializer. In case you wish to install as a portal.