Professional Documents
Culture Documents
Jasper Server Pro Install Guide
Jasper Server Pro Install Guide
Version 3.0
http://www.jaspersoft.com/ 2008 JasperSoft Corporation. All rights reserved. Printed in the U.S.A. JasperSoft, the JasperSoft logo, JasperAnalysis, JasperServer, JasperETL, JasperReports, iReport, and Jasper4 products are trademarks and/or registered trademarks of JasperSoft Corporation in the United States and in jurisdictions throughout the world. All other company and product names are or may be trade names or trademarks of their respective owners.
Table of Contents
1 Introduction .................................................................................................................................7
1.1 About JasperServer Professional ......................................................................................................... 7 1.2 Conventions .......................................................................................................................................... 7 1.3 JasperServer Distributions.................................................................................................................... 7 1.4 Installer Distribution Support................................................................................................................. 8 1.4.1 Operating Systems Supported................................................................................................. 8 1.4.2 Components Included in the Installer ...................................................................................... 8 1.4.3 Applications Supported by the Installer ................................................................................... 8 1.4.4 Application Versions Supported............................................................................................... 8 1.4.5 Java Version Supported........................................................................................................... 8 1.5 War File Binary Distribution Support..................................................................................................... 9 1.6 Release Notes and Application Support ............................................................................................... 9 1.7 Prerequisites for Installation.................................................................................................................. 9 1.7.1 System Requirements.............................................................................................................. 9 1.8 Support for Internationalization ........................................................................................................... 10
0708.JSP30.21
JasperServer Professional Installation Guide 3.2 Using Start/Stop Scripts Without Bundled Installation........................................................................ 16 3.3 Logging into JasperServer .................................................................................................................. 16 3.4 Starting the Included iReport .............................................................................................................. 17 3.5 JasperServer Log Files ....................................................................................................................... 17
4 5
Uninstalling JasperServer........................................................................................................18 Install Using the War File Distribution for Tomcat or JBoss ................................................19
5.1 Introduction ......................................................................................................................................... 19 5.1.1 Applications Supported by the War File Distribution ............................................................. 19 5.1.2 Application Versions Supported............................................................................................. 19 5.2 Obtain the War File Distribution .......................................................................................................... 19 5.3 Unpack the War File Distribution Zip .................................................................................................. 19 5.4 Setup the JasperServer Database...................................................................................................... 20 5.4.1 MySQL Database Setup Steps.............................................................................................. 20 5.4.2 Oracle Database Setup Steps ............................................................................................... 20 5.4.3 DB2 Database Setup Steps ................................................................................................... 21 5.4.4 Microsoft SQL Server Database Setup Steps ....................................................................... 21 5.4.5 PostgreSQL Database Setups Steps .................................................................................... 23 5.5 Deploy JasperServer War to the Application Server .......................................................................... 23 5.5.1 Most Database Servers ......................................................................................................... 23 5.5.2 Microsoft SQL Server............................................................................................................. 23 5.6 Prepare for Database Configuration ................................................................................................... 24 5.6.1 Default Database Configuration Values ................................................................................ 24 5.6.2 Expand the Archived War File ............................................................................................... 24 5.7 Configure Hibernate Properties File ................................................................................................... 25 5.8 Deploy JDBC Database Driver ........................................................................................................... 25 5.9 Database Connection Steps for Tomcat............................................................................................. 26 5.9.1 MySQL context.xml for Tomcat.............................................................................................. 26 5.9.2 Oracle context.xml for Tomcat............................................................................................... 26 5.9.3 DB2 Conext.xml for Tomcat................................................................................................... 27 5.9.4 Microsoft SQL Server context.xml for Tomcat ....................................................................... 27 5.9.5 PostgreSQL context.xml for Tomcat...................................................................................... 27 5.10 Database Connection Steps for JBoss ............................................................................................... 28 5.10.1 MySQL Datasource for JBoss ............................................................................................... 28 5.10.2 Oracle Datasource for JBoss................................................................................................. 28 5.10.3 DB2 Datasource for JBoss .................................................................................................... 28 5.10.4 Microsoft SQL Server Datasource for JBoss......................................................................... 29 5.10.5 PostgreSQL Datasource for JBoss........................................................................................ 29 5.11 Extra Configuration Step for JBoss..................................................................................................... 29 5.12 Setup JasperServer License............................................................................................................... 29 5.13 Set Java JVM Options ........................................................................................................................ 31 5.13.1 JVM Options for JBoss .......................................................................................................... 31 3
JasperServer Professional Installation Guide 5.14 Start JasperServer .............................................................................................................................. 32 5.15 Login to JasperServer......................................................................................................................... 32 5.15.1 JasperServer Heartbeat......................................................................................................... 32 5.16 Setup and Load Sample Data............................................................................................................. 33 5.16.1 MySQL Sample Database Create and Populate ................................................................... 33 5.16.2 Oracle Sample Database Create and Populate .................................................................... 33 5.16.3 DB2 Sample Database Create and Populate ........................................................................ 34 5.16.4 Microsoft SQL Server Sample Database Create and Populate ............................................ 34 5.16.5 PostgreSQL Sample Database Create and Populate ........................................................... 34 5.16.6 Check Context.xml or JBoss Datasource for Sample Data Config ....................................... 34 5.17 Import the JasperServer Sample Metadata ........................................................................................ 35 5.17.1 Prepare for Running the Import Utility ................................................................................... 35 5.17.2 Run the Import Utility ............................................................................................................. 35 5.17.3 Microsoft SQL Server Run Import Utility................................................................................ 36 5.18 Report Scheduling Configuration........................................................................................................ 36 5.18.1 js.quartz.properties ................................................................................................................ 36 5.18.2 js.mail.properties.................................................................................................................... 37 5.18.3 js.schedular.properties........................................................................................................... 37 5.18.4 More Information on Report Scheduling Configuration ......................................................... 37 5.19 Restart JasperServer .......................................................................................................................... 37 5.20 Update XMLA Connection Definitions (Optional) ............................................................................... 37 5.21 Troubleshooting your JasperServer Configuration ............................................................................. 38
Install Using War File Distribution for WebSphere Application Server ...............................39
6.1 Introduction ......................................................................................................................................... 39 6.2 Obtain the War File Distribution .......................................................................................................... 39 6.3 Unpack the War File Distribution ........................................................................................................ 39 6.4 Setup the JasperServer Database...................................................................................................... 39 6.5 Configure Database Connections....................................................................................................... 39 6.5.1 Default Database Configuration Values ................................................................................ 39 6.5.2 Configuring JDBC Provider.................................................................................................... 40 6.5.3 Configuring Database User ................................................................................................... 40 6.5.4 Configuring JDBC Data Sources ........................................................................................... 40 6.5.5 Check the Hibernate Properties Configuration ...................................................................... 41 6.6 Setup JasperServer License............................................................................................................... 41 6.7 Deploy the JasperServer War to the Application Server .................................................................... 41 6.8 Set Java JVM Options ........................................................................................................................ 41 6.9 Start JasperServer .............................................................................................................................. 42 6.10 Login to JasperServer......................................................................................................................... 42 6.11 Setup Sample Data............................................................................................................................. 42 6.12 Report Scheduling Configuration (Optional)....................................................................................... 42 6.13 Restart JasperServer .......................................................................................................................... 43
0708.JSP30.21
JasperServer Professional Installation Guide 6.14 Update XMLA Connection Definitions (Optional) ............................................................................... 43 6.15 Troubleshooting your JasperServer Configuration ............................................................................. 43
JasperServer Professional Installation Guide 8.7.1 8.7.2 Upgrade Sample Databases (if necessary)........................................................................... 53 Configure and Run Import of Sample Data ........................................................................... 53
8.8 Additional Notes on JasperServer Upgrade ....................................................................................... 54 8.8.1 Using mysqldump for Database Backup ............................................................................... 54 8.8.2 Additional Configuration Files ................................................................................................ 54 8.8.3 Clear the Tomcat Work Directory .......................................................................................... 54 8.8.4 Clear the Repository Cache Table......................................................................................... 55 8.8.5 Update XMLA Connections (Optional)................................................................................... 55 8.8.6 Upgrade the Liferay Portal ..................................................................................................... 55 8.8.7 Upgrade Using Export and Import Operations ...................................................................... 55
Appendix A: Configuring the Import-Export Utility .....................................................................64 Appendix B: Troubleshooting .......................................................................................................67 Appendix C: Java 1.6 JVM Settings ..............................................................................................74 Appendix D: Configuring and Using Ant ......................................................................................75
0708.JSP30.21
1 Introduction
1.1 About JasperServer Professional
JasperServer builds on JasperReports as a comprehensive family of Business Intelligence products, providing robust static and interactive reporting, report scheduling, and data analysis capabilities within an easy to use server environment.
1.2 Conventions
For clarity, this document uses the following conventions when referring to file locations, user names, passwords, and other values that are specific to your environment: Convention Paths and File Locations <js-install> <apache-tomcat> Meaning The root directory where JasperServer will be installed. The directory where Tomcat is installed. If you plan to use the instance of Tomcat that is included in the installer, Tomcat is installed under the <js-install> directory. The directory where JBoss is installed. The directory where MySQL is installed. If you plan to use the instance of MySQL that is included in the installer, MySQL is installed under the <js-install> directory. The directory where java is installed The directory where user unpacks the WAR file distribution ZIP. The user name and password of the default JasperServer login administrative user. The user name and password for the default database user.
<jboss> <mysql>
JasperServer Documentation
Note: For a complete list of applications supported by the WAR file distribution, refer to the release notes that are included in the root directory of the distribution file set.
Category
Windows
Disk
Installed Footprint
Recommended Minimum
10 GB free
Recommended
~600MB
40 GB +
MAC
Disk RAM CPU (class)
Linux
Disk RAM CPU (class) ~600MB 10 GB free 512 MB 1 GHz (single Pentium) 40 GB + 1 GB + 1.5 GHz + (multi-core Pentium)
Solaris
Disk RAM CPU (class) ~600 MB 10 GB free 512 MB UltraSparc II 40 GB + 1 GB +
AIX
Disk RAM CPU (class) ~600 MB 10 GB free 512 MB 40 GB + 1 GB +
HP-UX
Disk RAM CPU (class) ~600 MB 10 GB free 512 MB 40 GB + 1 GB +
10
2 Installing JasperServer
When you run the installation executable, you are prompted to specify information about the third party applications that JasperServer relies on. These third party applications are Apache Tomcat and the MySQL database. This section sets forth all the steps you might encounter when installing JasperServer. Note: When you run the installer against an existing database instance, the database must be running at install time.
2.1.1 Welcome
The first step introduces the installer and allows you to continue or exit. Click Next.
11
JasperServer Professional Installation Guide The first option is to choose a "bundled Tomcat". If you choose this option, the installer puts an instance of Tomcat 5 onto your system. Click Next. You are prompted for the server port and shutdown port that Tomcat will use. Most users accept the default values that are displayed. Accept the default values or enter alternate values and then click Next. The second option is to choose an "existing Tomcat". If you already have an instance of Tomcat on your system, then you can choose this option. Choose the "existing Tomcat" option and click Next. You are prompted for its location. Enter the correct location for Tomcat or click Browse to locate and select another location. Click Next. You are prompted for Tomcat's server port and shutdown port. Accept the default values or enter alternate values and then click Next.
Security Note: JasperSoft recommends that you change your database user password from the default value to a new, secure value. The second option is to choose an "existing MySQL". If you already have an instance of MySQL running on your system, then you can choose this option. Choose the "existing MySQL" option and click Next. You are prompted for the location of MySQL, and the port to use. Note that the MySQL instance must reside on your local machine (ie. localhost or 172.0.0.1). Enter the correct location for MySQL or click Browse to locate and select another location. Click Next. You are prompted for the user name and password of the MySQL administrative user. Enter this user name and password information and click Enter. Values to be entered or set to defaults if installing to an existing installation of MySQL: Binary Directory Port IP or Host Name MySQL Root User Name MySQL Root Password Database User Name Database User Password The directory where the mysql and mysqladmin binaries are located. The port number that MySQL uses (default is 3306). The value is hard coded to 172.0.0.1. Note that your existing MySQL instance must reside on the local machine. User name of the database administrative user. Password of the database administrative user. jasperdb. The installer creates this user which is used to connect to the jasperserver database. password. The installer uses this default password for the jasperdb account.
Security Note: JasperSoft recommends that you change your database user password from the default value to a new, secure value.
12
Sugar CRM data that simulates three years of operations for a fictitious company that relies on the SugarCRM open source application Foodmart data that simulates three years of operations for a fictitious company. JasperServer repository resources such as Reports, Analysis Views, Ad Hoc Topics, Domains, Data Sources, and Input Controls. JasperSoft strongly recommends that you install this data, unless you are not interested in testing or evaluating with the default sample data. Click Yes to install the sample data and click Next.
13
JasperServer Professional Installation Guide If you take the Checkbox default, the heartbeat is enabled. If you deselect the Checkbox, the heartbeat component is disabled. You can later enable or disable the heartbeat by modifying the jasperserver-pro/WEB-INF/applicationContextlogging.xml file. For additional information on enabling and disabling the heartbeat component refer to the JasperServer Professional Administrator Guide.
Updates to the MySQL database: If you installed to an existing MySQL database, new schemas and users are created in your database instance: MySQL Updates Database "jasperserver" created Notes This holds the JasperServer Application metadata and customer business data such as Reports, Analysis Views, Data Sources, Permissions, Roles, and Users. JasperServer connects to the database using this user. Database created if install sample data option was chosen. Database created if install sample data option was chosen.
Database user "jasperdb" created Sample database "foodmart" created Sample database "sugarcrm" created
JasperServer Professional Installation Guide Windows: C:\Documents and Settings\<username>\Local Settings\Temp\bitrock_installer_<number>.log Linux: /tmp/bitrock_installer_<number>.log
2. 3.
15
URL http://<hostname>:8080/jasperserver-pro
<hostname> is the name of the computer hosting JasperServer. <ip_address> is the IP address of the computer hosting JasperServer (if not using hostname). 8080 is the default port number for the Apache Tomcat application server. If you used a different port when installing your application server, specify its port number when you connect to JasperServer.
In Windows, you can also launch the JasperServer login page from the desktop of its host by clicking Start> All Programs> JasperServer Pro> JasperServer.
16
JasperServer Professional Installation Guide If the login page appears, JasperServer has started properly. You may now login with the following username and password: Username: jasperadmin Password: jasperadmin If you installed the sample data then additional sample end-users are created. These end users are non-administrative users who have less system privileges than an administrative user. End-users: Username: joeuser Password: joeuser Username: demo Password: demo Security Note: Once you have completed the evaluation or testing of your JasperServer instance, you should change your administrative password and change the passwords for the sample end-users (or remove the sample end-users). (special SuperMart Dashboard demonstration end-user) (sample standard end-user) (default administrative user)
17
4 Uninstalling JasperServer
In Windows, click Start > All Programs > JasperServer Pro > Uninstall to uninstall JasperServer. In addition, in Windows, you can open the Control Panel and double-click the Add or Remove Software option. Locate JasperServer in the list of installed software and click Change/Remove. You are prompted to remove the software. Indicate Yes and follow the on-screen instructions. Under Linux, the <js-install> directory includes an executable that removes JasperServer from the host. From the command line as the root user (or any user with sufficient privileges), enter: cd <js-install> ./uninstall You are prompted whether to remove JasperServer. Press Y and then press Enter to remove JasperServer from this computer.
18
19
20
JasperServer Professional Installation Guide In your Windows or Linux environment you should set the following variable so that it is used during the Oracle database create steps. This allows i18n internationalization to work properly: set NLS_LANG=AMERICAN_AMERICA.WE8ISO8859P1 export NLS_LANG=AMERICAN_AMERICA.WE8ISO8859P1 First move to the scripts/oracle directory: cd <unpacked-war-dir>/scripts/oracle Enter the following commands: sqlplus /nolog SQL> connect SYS/password@ORCL as SYSDBA SQL> create user jasperadmin identified by password; SQL> grant connect, resource, dba to jasperadmin; SQL>connect jasperadmin/password@ORCL SQL> @jasperserverCreate-oracle.ddl (use your password, your SID) (create schema) (start sqlplus client) (use your SYS password, your SID) - Windows - Linux
SQL> @jasperserverCreateDefaultSecurity-oracle.sql (populate minimal data) SQL>exit The Oracle database is now setup for use with JasperServer.
JasperServer Professional Installation Guide Set up base.properties file for SQL Server The database configuration parameters for SQL Server are found in the base.properties file. These properties are used for setting up the jasperserver database, for deploying the jasperserver war file to your application server, and for loading the the JasperServer sample data. In this section of the installation we will setup the jasperserver database, however, we will check and set all of the properties so that they can be used in later sections of the install process. The base.properties file is found at the following location: <unpacked-war-dir>/scripts/config/base.properties The properties that should match your SQL Server database instance (and application server instance) are the following:
dbServerType=sqlserver dbServerHost=localhost dbServerPort=1433 username=jasperadmin password=password jasperserverDbName=jasperserver sugarcrmDbName=sugarcrm foodmartDbName=foodmart (type of database) (host running the database) (port that database listens on) (username for jasperserver databases) (password for jasperserver databases) (name of db for Jasperserver metadata) (name of db for sugarcrm sample data) (name of db for foodmart/SuperMart sample data) (path for import sample data) (webapp path)
importCatalog=sqlserver/js-catalog-sqlserver
webappPath=C:/apache-tomcat/webapps/jasperserver-pro
Create and Populate JasperServer Database for SQL Server Use SQL Server Management Studio or another tool to create a SQL Server login to be used as the owner for the JasperServer databases, which matches the username value in your base.properties file. Create a database owned by this login, with a name matching the jasperserverDbName value. If you will be installing sample data, you should also create databases with names matching the foodmartDbName and sugarcrmDbName values (these will be used in a later section). To create the jasperserver database, do the following: In Windows: cd <unpacked-war-dir>\scripts %ANT_HOME%\bin\ant init-jasperserver-db In Linux or Unix: cd <unpacked-war-dir>/scripts $ANT_HOME/bin/ant init-jasperserver-db If the scripts succeed, the SQL Server database is now setup for use with JasperServer and you can move to the JasperServer war deployment section. If there is a failure, look at the error message and check for one of the following problems: The database hostname is incorrect, or the database is down or unreachable The database is not listening on the specified port, possibly because it is using dynamic ports The username and password in the configuration do not match a valid SQL Server username and password SQL Server is only set up for Windows authentication (It needs to have mixed-mode authentication enabled) The jasperserverDbName is not a valid database
22
JasperServer Professional Installation Guide The login specified by username doesnt own the jasperserverDbName database, or doesnt have sufficient permissions to run the scripts.
JasperServer Professional Installation Guide cd <unpacked-war-dir>/scripts $ANT_HOME/bin/ant deploy-webapp This target automates the following configuration steps: Copying and unpacking the WAR to the application server directory Configuring the hibernate.properties file Configuring the Tomcat context.xml file
The following steps still have to be done manually (see following sections for information on these steps): Copying the JDBC driver to the application server directory Configuring the JBoss datasource file Set up JasperServer license
Default Config for Oracle localhost N/A jasperadmin password 1521 Orcl
OracleUnicodeDialect
Default Config for MS SQL Server localhost jasperserver jasperadmin password 1433 N/A
Default Config for PostgreSQL localhost jasperserver postgres postgres 5432 N/A
PostgreSQLDialect PostgreSQLDelegate
Database Host Database Name Database User Database Password Database Port Database SID Hibernate Dialect Quartz Driver Delegate
DB2SQLDialect
SQLServerDialect
StdJDBCDelegat e
StdJDBCDelegate
DB2v8Delegate
StdJDBCDelegat e
Your instance of JasperServer should be modified to support the values in your own database environment.
(Tomcat) (JBoss)
JasperServer Professional Installation Guide mkdir jasperserver-pro cd jasperserver-pro jar xvf ../jasperserver-pro.war cd .. rm r jasperserver-pro.war or del jasperserver-pro.war JBoss mv jasperserver-pro jasperserver-pro.war copy jasperserver-pro jasperserver-pro.war (add .war to end of dir name) (same in Windows) (remove the original WAR file) (x - extract, v - verbose, f - is filename)
Note: For SQL Server the above setup should already be automatically handled by the deploy-webapp Ant target.
JasperServer Professional Installation Guide <unpacked-war-dir>/scripts/drivers/sqljdbc.jar <unpacked-war-dir>/scripts/drivers/postgresql-8.2-504.jdbc3.jar To your application server lib location: <apache-tomcat>/common/lib <apache-tomcat>/lib <jboss>/server/default/lib (Tomcat 5) (Tomcat 6) (JBoss) (SQL Server) (PostgreSQL)
26
27
In the same file, check the settings for the SugarCRM and Foodmart databases.
Note: The PostgreSQL driver needs a special configuration when running under JBoss. Refer to section B.11, "JBoss Modifications", in the Troubleshooting Appendix B for more information.
JasperServer Professional Installation Guide You must modify your application server java startup options to point to your license file. The JasperServer license file is in the following location: <unpacked-war-dir>/jasperserver.license
Setup JasperServer License for Tomcat: Tomcat file Locate this line Add this line below (Windows) Example (Windows) Add this line below (Linux) Example (Linux) <tomcat>/bin/setclasspath.bat or setclasspath.sh
JAVA_ENDORSED_DIRS=%BASEDIR%\common\endorsed JAVA_ENDORSED_DIRS="$BASEDIR"/common/endorsed (Windows) (Linux)
Alternate Configuration for Tomcat: Create file Add JAVA_OPTS setting example (Windows) Add JAVA_OPTS setting example (Linux)
<tomcat>/bin/setenv.bat or setenv.sh set JAVA_OPTS=%JAVA_OPTS% -Djs.license.directory="C:\jasperserver-pro-bin"
JAVA_OPTS="$JAVA_OPTS -Djs.license.directory=/home/user/jasperserver-pro-bin"
Setup JasperServer License for JBoss: JBoss file Locate this line Add this line below (Windows) Example (Windows) Add this line below (Linux) Example (Linux) <jboss>/bin/run.bat or run.sh
set JAVA_OPTS=%JAVA_OPTS% -Dprogram.name=%PROGNAME% JAVA_OPTS="$JAVA_OPTS -Dprogram.name=$PROGNAME" set JAVA_OPTS=%JAVA_OPTS% -Djs.license.directory="<unpacked-war-dir>" (Windows) (Linux)
Alternate License Configuration All Application Servers: Copy the file <unpacked-war-dir>/jasperserver.license to the home directory of the user that runs your application server. Copy license file from Copy license file to (Windows) Copy license file to (Linux) <unpacked-war-dir>/jasperserver.license C:\Documents and Settings\<user>\jasperserver.license /home/<user>/jasperserver.license
30
Note: You can cut and paste these settings from files in the <unpacked-war-dir>/scripts/java-settings directory. Additional Settings for Oracle Localization In order to support Localization when running JasperServer with an Oracle database there is an additional java option that should be set. Additional Java Setting for Localization of Oracle Only: Tomcat file JBoss file JAVA_OPTS setting (Windows) JAVA_OPTS setting (Linux)
<tomcat>/bin/setclasspath.bat or setclasspath.sh (or setenv.bat, setenv.sh) <jboss>/bin/run.bat or run.sh set JAVA_OPTS=%JAVA_OPTS% -Doracle.jdbc.defaultNChar=true JAVA_OPTS="$JAVA_OPTS -Doracle.jdbc.defaultNChar=true "
Note: You can cut and paste these settings from files in the <unpacked-war-dir>/scripts/java-settings directory. Settings for Java 1.6 If you are using Java 1.6, the recommended settings are slighly different than those for Java 1.5. Also, there are specific settings needed to avoid class conflicts between java 1.6 and JasperServer web services. For Java 1.6 JVM settings, refer to Appendix C "Java 1.6 JVM Settings". General Note on Java Settings The settings specified in this section apply specifically to the Sun JVM. Other JVM implementations may or may not have equivalent settings.
31
The JasperServer log output goes to the following location: <apache-tomcat>/webapps/jasperserver-pro/WEB-INF/logs/jasperserver.log <jboss>/server/default/deploy/jasperserver-pro/WEB-INF/logs/jasperserver.log (Tomcat) (JBoss)
You can change the log4j logging level for the overall application or for particular classes by modifying the following property: <apache-tomcat>/webapps/jasperserver-pro/WEB-INF/ log4j.properties <jboss>/server/default/deploy/jasperserver-pro/WEB-INF/ log4j.properties The application server console log should also be checked for errors. (Tomcat) (JBoss)
Operating System - type and version JVM - type and version Application Server - type and version Database - type and version JasperServer - type and version
JasperServer Professional Installation Guide Unique, anonymous identifier value You can also manually enable or disable the heartbeat by modifying the jasperserver-pro/WEB-INF/applicationContextlogging.xml file. For additional information on enabling and disabling the heartbeat component refer to the JasperServer Professional Administrator Guide.
(use your password, your SID) (this runs for 5 minutes or so) (use your password, your SID) (this runs for 15 minutes or so)
33
JasperServer Professional Installation Guide This would be a good time to check that you have the settings correct for the two databases you created above: foodmart and sugarcrm. These files were configured in section 5.9, "Database Connection Steps for Tomcat", or section 5.10 "Database Connection Steps for JBoss", above.
(Windows) (Linux)
(Windows) (Linux)
JasperServer Professional Installation Guide js-import.bat --input-dir db2/js-catalog-db2 js-import.sh --input-dir db2/js-catalog-db2 Microsoft SQL Server For SQL Server the import is handled with an Ant task. See section 5.17.3 "Microsoft SQL Server Run Import Utility". (Windows) (Linux)
PostgreSQL cd <unpacked-war-dir>/scripts js-import.bat --input-dir postgresql/js-catalog-postgresql js-import.sh --input-dir postgresql/js-catalog-postgresql Notes: The import command depends on the JAVA_HOME variable being set in your environment. There are two dashes (--) in front of the command option. (Windows) (Linux)
5.18.1 js.quartz.properties
The Quartz properties file is found at the following location: <apache-tomcat>/webapps/jasperserver-pro/WEB-INF/js.quartz.properties <jboss>/server/default/deploy/jasperserver-pro/WEB-INF/js.quartz.properties PostgreSQL (Non-Optional) PostgreSQL has a non-default setting for the Quartz driver delegate class. It be set to the following: org.quartz.jobStore.driverDelegateClass = org.quartz.impl.jdbcjobstore.PostgreSQLDelegate A sample Quartz properties file can be copied to your deployed JasperServer from the following location: <unpacked-war-dir>/scripts/postgresql/js.quartz-postgresql.properties
36
JasperServer Professional Installation Guide Be sure to change the name of this file to js.quartz.properties. DB2 (Non-Optional) DB2 has a non-default setting for the Quartz driver delegate class: org.quartz.jobStore.driverDelegateClass = org.quartz.impl.jdbcjobstore.DB2v8Delegate If you have installed the JasperServer repository into a non-standard schema, you will need to set the additional property (ie if not the default schema): org.quartz.jobStore.tablePrefix=<your schema>.QRTZ_ A sample Quartz properties file can be copied to your deployed JasperServer from the following location: <unpacked-war-dir>/scripts/db2/js.quartz-db2.properties Be sure to change the name of this file to js.quartz.properties. All Other Databases The default Quartz driver delegate setting found in the JasperServer war file is appropriate for all other certified (nonPostgreSQL) databases. It will look like the following: org.quartz.jobStore.driverDelegateClass=org.quartz.impl.jdbcjobstore.StdJDBCDelegate Note: For more information on the Quartz Framework, see the quartz website: http://www.opensymphony.com/quartz
5.18.2 js.mail.properties
The mail server configuration file is found at the following location: <apache-tomcat>/webapps/jasperserver-pro/WEB-INF/js.mail.properties <jboss>/server/default/deploy/jasperserver-pro/WEB-INF/js.mail.properties
5.18.3 js.schedular.properties
The web link URL configuration file is found at the following location: <apache-tomcat>/webapps/jasperserver-pro/WEB-INF/js.scheduling.properties <jboss>/server/default/deploy/jasperserver-pro/WEB-INF/js.scheduling.properties
JasperServer Professional Installation Guide If you would like to run the samples that uses this XMLA interface, you should update your XMLA connection definitions. For instance, an analysis view that uses this connection is: SugarCRM Sample XMLA Analysis View The XMLA connection definitions to update with your local configuration values the following: /Analysis Components/ Analysis Connections/ Foodmart XMLA Connection /Analysis Components/ Analysis Connections/ SugarCRM XMLA Connection The updates are made by editing repository objects in your running instance of JasperServer via the UI. To make these updates, take these steps: Login to JasperServer as an Administrative user (such as jasperadmin). Navigate to the Repository Management page via the View> Repository menu item. Click to expand the Analysis Components folder, then the Analysis Connections folder. Click to highlight the Foodmart XMLA Connection resource, and then click the Edit icon. Edit the information on this page for: o o o URI (hostname and port) Login Username Login Password
Click Next, then Save. Make the same updates for the SugarCRM XMLA Connection resource.
38
JasperServer Professional Installation Guide Setting Database Host Database Name Database User Database Password Database Port Database SID Hibernate Dialect Default Config for MySQL localhost jasperserver jasperdb password 3306 N/A MySQLDialect Default Config for Oracle localhost N/A jasperadmin password 1521 Orcl OracleDialect Default Config for MS SQL Server localhost jasperserver jasperadmin password 1433 N/A SQLServerDialect Default Config for PostgreSQL localhost jasperserver postgres postgres 5432 N/A PostgreSQLDialect
You must configure JDBC Provider and Database Connections for your WebSphere Application Server.
Save Master Configuration. Note: The MySQL JDBC driver must be version number 3.1.14 (or greater).
Parameter Name Data source name JNDI name Component-managed authentication alias Existing JDBC Provider
Example Value jasperserver jdbc/jasperserver <database user alias> MySQL JDBC Provider
40
JasperServer Professional Installation Guide Go back to the JDBC Data Sources list and click jasperserver link. Find Additional Properties section and click Custom Properties link. Click New button and filter properties by Name=url. Click url property and enter the connection url (example: jdbc:mysql://localhost/jasperserver?useUnicode=true&characterEncoding=UTF-8). Go back to the JDBC Data Sources list and test the connection using Test button. Create sugarcrm and foodmart database connections if you are planning to run JasperServer Sample Reports. Save Master Configuration.
Map all resource references to the target JNDI names. After the application is successfully installed, save master configuration.
Option Target
Value
41
Linux
JAVA_OPTS="$JAVA_OPTS -Djavax.xml.soap.MessageFactory=org.apache.axis.soap.MessageFactoryImpl " JAVA_OPTS="$JAVA_OPTS -Djavax.xml.soap.SOAPConnectionFactory=org.apache.axis.soap.SOAPConnectionFactoryImpl " JAVA_OPTS="$JAVA_OPTS -Djavax.xml.soap.SOAPFactory=org.apache.axis.soap.SOAPFactoryImpl " JAVA_OPTS="$JAVA_OPTS -Djavax.xml.transform.TransformerFactory=org.apache.xalan.processor.TransformerFactoryImpl "
Note: You can cut and paste these settings from the java-settings-websphere.txt in the <unpacked-war-dir>/scripts/javasettings directory.
JasperServer Professional Installation Guide Refer to Section 5.18, "Report Scheduling Configuration", for more information report scheduling setup. Note: for the PostgreSQL database, there is a non-optional configuration step.
43
44
Setting Database Host Database Name Database User Database Password Database Port Database SID Hibernate Dialect
Default Config for MySQL localhost jasperserver jasperdb password 3306 N/A MySQLDialect
Default Config for Oracle localhost N/A jasperadmin password 1521 Orcl OracleDialect
Default Config for MS SQL Server localhost jasperserver jasperadmin password 1433 N/A SQLServerDialect
Default Config for PostgreSQL localhost jasperserver postgres postgres 5432 N/A PostgreSQLDialect
You must configure JDBC Provider and Database Connections for your WebLogic Application Server.
Parameter Name Name JNDI Name Database Type Database Driver Supports Global Transactions One-Phase Commit
Example Value JasperServerDataBase JasperServerDataBase MySQL MySQLs Driver (Type 4) Versions:using com.mysql.jdbc.Driver Checked Checked
Parameter Name Name JNDI Name Database Type Database Driver Supports Global Transactions One-Phase Commit
Example Value FoodmartDataBase FoodmartDataBase MySQL MySQLs Driver (Type 4) Versions:using com.mysql.jdbc.Driver Checked Checked
JasperServer Professional Installation Guide Database Type Database Driver Supports Global Transactions One-Phase Commit MySQL MySQLs Driver (Type 4) Versions:using com.mysql.jdbc.Driver Checked Checked
Parameter Name Database Name Host Name Port Database User Name Password Confirm Password
Parameter Name Database Name Host Name Port Database User Name Password Confirm Password
JasperServer Professional Installation Guide jdbc:mysql://localhost:3306/sugarcrm jdbc:mysql://localhost:3306/foodmart. The URL for JasperServer Data Base should be change to jdbc:mysql://localhost:3306/jasperserver?useUnicode=true&characterEncoding=UTF-8
Modify setDomainEnv Script The following line should be added to your setDomainEnv file: Add to setDomainEnv.bat (Windows)
set PRE_CLASSPATH=%DOMAIN_HOME%/lib/js-1.6R5.jar;%DOMAIN_HOME%/lib/xalan-2.4.1.jar;%DOMAIN_HOME%/lib/xercesImpl-2.6.2.jar; %DOMAIN_HOME%/lib/dom4j-1.6.1.jar;%DOMAIN_HOME%/lib/jdom-1.0.jar;%DOMAIN_HOME%/lib/xom-1.0.jar;
47
Copy from: jasperserver-pro/WEB-INF/lib To: the WebLogic domain lib folder dom4j-1.6.1.jar jaxen-1.1.1.jar jdom-1.0.jar js-1.6R5.jar mysql-connector-java-<ver>-bin.jar xalan-2.4.1.jar xercesImpl-2.6.2.jar xom-1.0.jar
Example Value jasperserver-pro Custom Roles and Policies Use the defaults defined by the deployment's targets
(Administrative user)
JasperServer Professional Installation Guide Password: jasperadmin If you logged in successfully, the JasperServer home page appears. Refer to the JasperServer User Guide to begin adding reports and other objects to JasperServer. Note: The first time you login to JasperServer 3.0, you will be prompted to opt-in or opt-out to the JasperServer Heartbeat. Refer to Section 5.15.1, "JasperServer Heartbeat", for more information.
49
50
8.4.1 MySQL
cd <unpacked-war-dir-3.0>/scripts/upgrade Login to your mysql client: mysql -u root -p Run the upgrade scripts: mysql>use jasperserver; mysql>source upgrade-mysql-2.1.0-3.0.0.sql;
8.4.2 Oracle
cd <unpacked-war-dir-3.0>/scripts/upgrade Login to you sqlplus client then do the following:
51
JasperServer Professional Installation Guide SQL>connect jasperadmin/password@ORCL SQL>@upgrade-oracle-2.1.0-3.0.0.sql SQL>@upgrade-oracle-3.0.0-3.0.1.sql (if you have the 3.0.1 War File Dist)
Your JasperServer instance has now been upgraded to 3.0. If there are problems on startup refer to section B.2, "Database Connectivity Errors" in the Troubleshooting Appendix B. Note: The first time you login to JasperServer 3.0, you will be prompted to opt-in or opt-out to the JasperServer Heartbeat. Refer to Section 5.15.1, "JasperServer Heartbeat", for more information. Note: If you update your sample data in the sections below, your jasperadmin password might be updated to "jasperadmin".
52
SQL> drop user foodmart cascade; SQL> create user foodmart identified by password; SQL> grant connect, resource, dba to foodmart; SQL> connect foodmart/password@ORCL SQL> @foodmart-oracle.sql; SQL Server Use the Ant target update-foodmart to run the update script. In Windows: cd <unpacked-war-dir>\scripts %ANT_HOME%\bin\ant update-foodmart In Linux or Unix: cd <unpacked-war-dir>/scripts $ANT_HOME/bin/ant update-foodmart (this runs for 15 minutes or so)
JasperServer Professional Installation Guide cd <unpacked-war-dir-3.0>/scripts js-import.bat --input-dir js-catalog --update js-import.sh --input-dir js-catalog --update Oracle cd <unpacked-war-dir-3.0>/scripts js-import.bat --input-dir oracle/js-catalog-oracle --update js-import.sh --input-dir oracle/js-catalog-oracle --update (Windows) (Linux) (Windows) (Linux)
Additionally, refer to Appendix A, "Configuring the Import-Export Utility", for information on running the import utility.
Note: The default MySQL database username in 3.0 is "jasperdb". In 2.1, the default database username is "jasperadmin". In both cases, the default password is "password".
54
JasperServer Professional Installation Guide js-export.sh --everything --output-dir my-2.1-resources Import Your Business Data into 3.0 Copy the "my-2.1-resources" directory to <install-3.0>/scripts cd <js-install-3.0>/scripts js-import.bat --input-dir my-2.1-resources js-import.sh --input-dir my-2.1-resources (Windows) (Linux) (Linux)
If you have business data in your 3.0 instance, it will not be overwritten with the imported data unless you specify the additional import option: "--update". Now, your JasperServer 3.0 instance should be updated with your current business data. If you encounter any errors or have any trouble with the configuration of import-export, refer to Appendix A: "Configuring the Import-Export Utility".
56
9.1 MySQL
Jasperserver Database cd <unpacked-war-dir-2.1>/scripts/upgrade mysql> use jasperserver; mysql> source upgrade-mysql-2.0.0-2.1.0.sql; Sample Database cd <unpacked-war-dir-2.1>/scripts/upgrade/sample mysql> use foodmart; mysql> source upgrade-mysql-sample-foodmart-2.1.0.sql;
9.2 Oracle
SQL> connect jasperadmin/password@ORCL SQL> @upgrade-oracle-2.1.0-3.0.0.sql The same script upgrade principle should be applied to JasperServer instances older than 2.0.
JasperServer Professional Installation Guide Next, you will move to your already installed JaspeServer 3.0 location: cd <js-install-3.0>/scripts Make sure your 3.0 import-export is configured for you database settings as described in section 8.8.7. Edit the ant file: build-convert-export.xml. Look for the <import-dir> property and set it to the full path of the 2.0 export directory that you just created. For example: <property name="import-dir" value="C:\Program Files\jasperserver-pro-2.0\my-2.0-resources"/> Then, run the ant script that will convert your 2.0 export file so that the SecureMondrianConnection issue is fixed, and will import the contents of the converted export file into your 3.0 system: ant -f build-convert-export.xml convert-repository-to-3.0-from-export
58
You can use the jasperdb user or the root user to carry out this operation. Refer to section 8.8.1, "Using mysqldump for Database Backup", for more information on running the mysqldump command. Oracle Refer to your Oracle documentation for details. Microsoft SQL Server Refer to your SQL Server documentation for details. PostgreSQL Refer to your PosrgreSQL documentation for details.
59
60
JasperServer Professional Installation Guide Note: As described in the JasperServer Professional Administrator Guide, the secretKey, secretKeyAlgorithm, and cipherTransformation property settings must be consistent with each other. For instance, different algorithms expect different key lengths. Encryption Now Enabled Once the changes described above are made, encryption is enabled for the JasperServer application upon the next restart.
Oracle Change directory to: .cd <js-install>/scripts/oracle Login to your SQLPlus client: .sqlplus jasperadmin/password@MY_SID Drop the jasperserver database, create a new one and load the jasperserver schema: .SQL> drop tablespace jasperserver including contents and datafiles; .SQL> create tablespace jasperserver datafile 'jasperserver.dbf' size 100m reuse autoextend on next 50m maxsize 1000m extent management local autoallocate segment space management auto;
61
JasperServer Professional Installation Guide .SQL> connect jasperadmin/password@MY_SID .SQL> @jasperserverCreate-oracle.ddl .SQL> @jasperserverCreateDefaultSecurity-oracle.sql Microsoft SQL Server Change directory to: .cd <js-install>/scripts/sqlserver Drop the jasperserver database, create a new one and load the jasperserver schema: .sqlcmd -S localhost\jasperserver -Q "DROP DATABASE jasperserver" .sqlcmd -S localhost\jasperserver -Q "CREATE DATABASE jasperserver" .sqlcmd -S localhost\jasperserver -d jasperserver -i jasperserverCreate-sqlserver.ddl .sqlcmd -S localhost\jasperserver -d jasperserver -i jasperserverCreateDefaultSecurity-sqlserver.sql PostgreSQL Change directory to: .cd <js-install>/scripts/postgresql Drop the jasperserver database, create a new one and load the jasperserver schema: Start psql using an admin account (such as "postgres"): psql -U postgres Enter the following commands: drop database jasperserver; create database jasperserver encoding='utf8'; \c jasperserver \i jasperserverCreate-postgresql.ddl \i jasperserverCreateDefaultSecurity-postgresql.sql
10.10
You can now start your application server. Your database should already be running.
62
10.11
Login to JasperServer
You can now login to JasperServer. Enter your username and password in the same manner as you did before encryption was turned on. You can check the contents of the JIUser table in the jasperserver database and examine the password column to see that the password is no longer stored in plain text.
63
Import batch script for Windows. Import shell script for Linux Database and hibernate dialect settings file Spring configuration files All of the JasperServer jar files and JDBC drivers
metadata.jdbc.driverClassName=com.ibm.db2.jcc.DB2Driver
64
JasperServer Professional Installation Guide metadata.jdbc.url=jdbc:db2://localhost:50000/jsprsrvr:driverType=4;fullyMaterializeLobData=true;fullyMaterializeInputStr eams=true;progressiveStreaming=2;progresssiveLocators=2;currentSchema=JSPRSRVR; metadata.jdbc.username=db2admin metadata.jdbc.password=password metadata.jndi=jdbc/jasperserver metadata.upperCaseNames=true Sample Settings for SQL Server Modify the items in bold to match your own environment setup: metadata.hibernate.dialect=org.hibernate.dialect.SQLServerDialect metadata.jdbc.driverClassName= com.microsoft.sqlserver.jdbc.SQLServerDriver metadata.jdbc.url= jdbc:sqlserver://localhost:1433;databaseName=jasperserver;SelectMethod=cursor metadata.jdbc.username=jasperadmin metadata.jdbc.password =password Sample Settings for PostgreSQL Modify the items in bold to match your own environment setup: metadata.hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect metadata.jdbc.driverClassName= org.postgresql.Driver metadata.jdbc.url=jdbc:postgresql://localhost:5432/jasperserver metadata.jdbc.username=postgres metadata.jdbc.password=postgres
JasperServer Professional Installation Guide ./js-export.sh --uris /reports --output-dir /home/user/my-reports (instead of ~/my-reports)
66
JasperServer Professional Installation Guide When using Tomcat, JasperServer configuration properties are found in the following files: <apache-tomcat>/webapps/jasperserver-pro/META-INF/context.xml <apache-tomcat>/webapps/jasperserver-pro/WEB-INF/hibernate.properties <apache-tomcat>/apache-tomcat/webapps/jasperserver-pro/WEB-INF/web.xml JBoss File Locations When using JBoss, some of the JasperServer configuration properties are found in the following files: <jboss>/server/default/deploy/js-mysql-ds.xml or <jboss>/server/default/deploy/js-oracle-ds.xml <jboss>/server/default/deploy/jasperserver-pro.war/WEB-INF/hibernate.properties <jboss>/server/default/deploy/ jasperserver-pro.war/WEB-INF/web.xml <jboss>/server/default/deploy/ jasperserver-pro.war/WEB-INF/jboss-web.xml
This database configuration in <tomcat>/conf tree overrides the context.xml found in your jasperserver directory. If you are having database trouble in this scenario, it is recommended that you keep things simple by: Deleting your <tomcat>/webapps/jasperserver.war file o This causes the jasperserver directory to be used
Deleting your <tomcat>/Catalina/Localhost/jasperserver.xml o This causes the META-INF/context.xml from your jasperserver directory.
Note: For the JasperServer Pro product the filename and directory names are jasperserver-pro
JasperServer Professional Installation Guide Note: In JasperServer 2.1 and earlier the suggested default DB user name was "jasperadmin".
Section 5.12, "Setup JasperServer License", has additional information on configuring the JasperServer license.
JasperServer Professional Installation Guide A database is case-sensitive with respect to table names if it considers customer and Customer to be two different tables. If JasperServer is using a case-sensitive database, its important that the table names specified in query strings in the JRXML files match the actual table names found in the database. This type of problem may occur if you are transferring data from one database to another, which may result in the case of table names changing. Under Windows MySQL, table and column names are not case-sensitive. Under Linux MySQL, table and column names are case-sensitive. Linux MySQL can be configure to be non-case-sensitive by setting the configuration parameter lower_case_table_names to 1 in the my.ini or my.cnf file. In the MySQL documentation see the section Identifier Case Sensitivity for more information. Table and column names in Oracle and PostgreSQL are case-sensitive.
Note: Refer to section 5.13, "Set Java JVM Options", for more information on Java JVM settings.
JasperServer Professional Installation Guide it may be due to an incorrect character in the following file: scripts/ji-export-util/jdbc.properties. The URL in this file should be checked. It should look like the following: jdbc:mysql://localhost:3306/jasperserver?useUnicode=true&characterEncoding=UTF-8 Note the ampersand "&" character. It is incorrect if it looks like the following: "&". The "&" is only correct in HTML or XML context. It is incorrect in a properties file. The error described in this section is known to happen if the user has i18n characters in their repository objects.
JasperServer Professional Installation Guide <jboss>/server/default/deploy/jasperserver-pro.war/WEB-INF Edit properties file to match your PostgreSQL settings: <jboss>/server/default/deploy/jasperserver-pro.war/WEB-INF/js.jdbc-postgresql.properties The operations above will fix the JBoss with PostgreSQL error that has the following error message: org.hibernate.exception.GenericJDBCException: could not execute query org.postgresql.util.PSQLException: Large Objects may not be used in auto-commit mode Reference Link: http://forums.java.net/jive/thread.jspa?messageID=228420
Linux
JAVA_OPTS="$JAVA_OPTS -Djavax.xml.soap.MessageFactory=org.apache.axis.soap.MessageFactoryImpl " JAVA_OPTS="$JAVA_OPTS -Djavax.xml.soap.SOAPConnectionFactory=org.apache.axis.soap.SOAPConnectionFactoryImpl " JAVA_OPTS="$JAVA_OPTS -Djavax.xml.soap.SOAPFactory=org.apache.axis.soap.SOAPFactoryImpl " JAVA_OPTS="$JAVA_OPTS -Djavax.xml.transform.TransformerFactory=org.apache.xalan.processor.TransformerFactoryImpl "
Note: Refer to Appendix C: "Java 1.6 JVM Options" for more specific configuration information.
73
Note: You can cut and paste these settings from files in the <unpacked-war-dir>/scripts/java-settings directory.
Additional Java 1.6 Web Services Settings Java 1.6 includes a web services implementation that can conflict with JasperServer's AXIS based web services classes. In order to prevent these conflicts we will add the special JVM settings specified below. Java JVM Settings for Java 1.6 Only: Tomcat file JBoss file JAVA_OPTS setting (Windows)
<tomcat>/bin/setclasspath.bat or setclasspath.sh (or setenv.bat, setenv.sh) <jboss>/bin/run.bat or run.sh set JAVA_OPTS=%JAVA_OPTS% -Djavax.xml.soap.MessageFactory=org.apache.axis.soap.MessageFactoryImpl set JAVA_OPTS=%JAVA_OPTS% -Djavax.xml.soap.SOAPConnectionFactory=org.apache.axis.soap.SOAPConnectionFactoryImpl set JAVA_OPTS=%JAVA_OPTS% -Djavax.xml.soap.SOAPFactory=org.apache.axis.soap.SOAPFactoryImpl set JAVA_OPTS=%JAVA_OPTS% -Djavax.xml.transform.TransformerFactory=org.apache.xalan.processor.TransformerFactoryImpl
JAVA_OPTS="$JAVA_OPTS -Djavax.xml.soap.MessageFactory=org.apache.axis.soap.MessageFactoryImpl " JAVA_OPTS="$JAVA_OPTS -Djavax.xml.soap.SOAPConnectionFactory=org.apache.axis.soap.SOAPConnectionFactoryImpl " JAVA_OPTS="$JAVA_OPTS -Djavax.xml.soap.SOAPFactory=org.apache.axis.soap.SOAPFactoryImpl " JAVA_OPTS="$JAVA_OPTS -Djavax.xml.transform.TransformerFactory=org.apache.xalan.processor.TransformerFactoryImpl "
Note: You can cut and paste these settings from files in the <unpacked-war-dir>/scripts/java-settings directory. Note: If you do not utilize JasperServer web services or resources that use them, you will not need the settings in the table above.
74
75