Jump to content
JasperReports Library 7.0 is now available ×
  • This documentation is an older version of JasperReports Server Installation Guide. View the latest documentation.

    Procedure for Installing and Deploying the WAR File in WebSphere

    Perform the procedures in this section to install and deploy the JasperReports Server WAR file in WebSphere.

    Installing WebSphere and a Database

    To install WebSphere and a database:

    1. Make sure you're using a supported version of WebSphere. See the TIBCO JasperReports Server Supported Platform Datasheet for more information.
    2. Check that the WebSphere installation created a JAVA_HOME system environment variable. The variable needs to be set to the JAVA directory in the WebSphere installation.
    3. Install the database (PostgreSQL, MySQL, Oracle, SQL Server, or DB2).


    The target database can be on a remote server. WebSphere should reside on the local machine.

    Preparing Server Files

    To prepare JasperReports Server files:

    1. Unpack TIB_js-jrs_6.4.0_bin.zip to a top-level directory. Unpacking the ZIP file creates the directory TIB_js-jrs_6.4.0_bin.
    2. (Required) Manually create and load the JasperReports Server database.
    3. (Optional) Manually create and load the sample databases. See Manually Creating the JasperReports Server Database for instructions.
    4. (Required) Manually import the default users and organization.
    a. Copy the <dbType>_master.properties file for your database from sample_conf and paste it to buildomatic:
    cd <js-install>/buildomatic
    Copy from — <js-install>/buildomatic/sample_conf
    Paste to — <js-install>/buildomatic

    For example, copy sample_conf/postgresql_master.properties to buildomatic.

    b. Rename the file you copied to default_master.properties.
    c. Edit the default_master.properties file:
    Set appServerType to skipAppServerCheck.
    Change dbUsername, dbPassword, and dbHost to the appropriate settings for your database.
    If you're using a port other than the default for your database, or if you've installed the database on a remote machine, change the dbPort field under Custom Properties to the appropriate settings.

    Each sample_conf/<dbType>_master.properties file contains appropriate sample values.

    d. Start your database server.
    e. Open a Command Prompt as Administrator and run these commands:

    Buildomatic Targets to Execute



    cd <js-install>/buildomatic

    Go to the buildomatic directory

    js-ant create-js-db Create the jasperserver repository database

    js-ant init-js-db-pro

    js-ant import-minimal-pro

    Initializes database, loads core application data

    js-ant create-sugarcrm-db

    js-ant create-foodmart-db (Optional) Creates sample databases

    js-ant load-sugarcrm-db

    js-ant load-foodmart-db (Optional) Loads sample data into the sample databases

    js-ant import-sample-data-pro

    (Optional) Loads the demos that use the sample data

    5. Set up your license file. For information, refer to Setting Up the JasperReports Server License.

    Configuring CSRFGuard, Hibernate, and Quartz Settings

    Before deploying the JasperReports Server WAR file, update the CSRFGuard, Hibernate, Quartz, and settings as described here.

    Configure CSRFGuard, Hibernate and Quartz settings in the WAR file:

    1. The WAR file is an archive format in a single file.
    a. Extract the Websphere.jrs.csrfguard.properties file using the following command:
    cd <js-install>"%JAVA_HOME%/bin/jar" xf jasperserver-pro.war WEB-INF/csrf/Websphere.jrs.csrfguard.properties[/code]                    

    This creates the WEB-INF/csrf folder in the current location and places the extracted file there.

    b. Rename the file from Websphere.jrs.csrfguard.properties to jrs.csrfguard.properties using the following command:
    mv ./WEB-INF/csrf/Websphere.jrs.csrfguard.properties ./WEB-INF/csrf/jrs.csrfguard.properties
    2. Extract the web.xml file using the commands below:
    cd <js-install>"%JAVA_HOME%/bin/jar" xf jasperserver-pro.war WEB-INF/web.xml[/code]                    

    The jar command creates the WEB-INF folder in the current location and places the extracted file there.

    Open the WEB-INF/web.xml file for editing and replace every occurrence of




    For example, change the following:

    <resource-ref>    <description>JasperServer Metadata repository</description>        <res-ref-name>jdbc/jasperserver</res-ref-name>        <res-type>javax.sql.ConnectionPoolDataSource</res-type>        <res-auth>Container</res-auth> </resource-ref>[/code]                    


     <resource-ref>    <description>JasperServer Metadata repository</description>        <res-ref-name>jdbc/jasperserver</res-ref-name>        <res-type>javax.sql.DataSource</res-type>        <res-auth>Container</res-auth> </resource-ref>[/code]                    

    Do the same for the Supermart and Foodmart databases.

    3. Copy the already configured files for hibernate.properties and js.quartz.properties to the WEB-INF folder.

    (Buildomatic configured these files for your database type in the steps above.)






    4. Edit the scheduler URI port value for WebSphere in the js.quartz.properties:

    Edit js.quartz.properties:

    Set :




    5. If you want to configure JasperReports Server to automatically schedule and email reports, enter your mail server information in the js.quartz.properties file. Modify all report.scheduler.mail.sender.* properties for your mail server.
    6. Now that you have modified/updated the individual configuration files, you must replace them in the WAR file archive using the following commands.
    cd <js-install>"%JAVA_HOME%binjar" uf jasperserver-pro.war WEB-INF/hibernate.properties"%JAVA_HOME%binjar" uf jasperserver-pro.war WEB-INF/js.quartz.properties"%JAVA_HOME%binjar" uf jasperserver-pro.war WEB-INF/csrf/jrs.csrfguard.properties[/code]                    
    7. If you have modified the web.xml file, replace that file in the WAR file archive using the following additional commands.
    cd <js-install>"%JAVA_HOME%binjar" uf jasperserver-pro.war WEB-INF/web.xml[/code]                    
    8. (WebSphere 8 only) If you're using WebSphere 8, enter the following additional commands:
    cd <js-install>zip -d jasperserver-pro.war WEB-INF/lib/stax-api-1.0.2.jarzip -d jasperserver-pro.war WEB-INF/lib/jta-1.1.jar[/code]                    
    9. Delete the WEB-INF directory you created, along with the edited files it contains.

    Configuring a JDBC Provider in WebSphere

    To configure a JDBC Provider in WebSphere:

    1. Launch the WebSphere Administrative Console and navigate to Resources > JDBC > JDBC Providers.
    2. On the JDBC providers page, click the Guided Activity link at the top of the JDBC Providers page and follow the Integrated Solutions Console instructions:
    a. Configure credentials for a secure database:
    Use the J2C authentication aliases panel to create a new authenticated user.
    In Global Security, click New and enter the user alias, user ID, and password. The following table shows the credentials that WebSphere uses to access the database.

    J2C Authentication Alias Settings


    Example User ID

    Example Password



    postgres postgres



    root password









    SQL Server


    sa sa
    b. Connect to a database panel. From the Scope drop-down, choose Node:<node_name>,Server=<server_name>
    c. Click the New button to create a new JDBC Provider.
    d. Select your database type:
    If you're using PostgreSQL, MySQL, or a TIBCO JDBC driver — select User-defined.
    If you want to use the JDBC driver built and distributed by the MySQL project, see MySQL Example
    If you're using a vendor-supplied driver for DB2, Oracle, or SQL Server — select your database.
    e. Select or enter these options. Your options depend on your database type.
    Database type Implementation class name or type Name

    User-defined (PostgreSQL)


    PostgreSQL JDBC Provider

    MySQL com.mysql.jdbc.jdbc2.optional.

    MySQL JDBC Provider



    MySQL JDBC Provider

    (TIBCO JDBC Oracle)
    tibcosoftware.jdbcx.oracle.OracleDataSource TIBCO JDBC Provider - Oracle
    (TIBCO JDBC SQL Server)


    TIBCO JDBC Provider - SQL Server
    tibcosoftware.jdbcx.db2.DB2DataSource TIBCO JDBC Provider - DB2

    DB2 Universal JDBC Driver Provider

    Connection pool data source

    DB2 Universal JDBC Driver Provider


    Connection pool data source

    Oracle JDBC Driver

    SQL Server

    Connection pool data source

    Microsoft SQL Server JDBC Driver

    3. Click Next and enter the database classpath information for the JDBC provider.
    a. For TIBCO JDBC drivers for Oracle, SQL Server, or DB2, locate the correct JAR in
    Oracle — <js-install>buildomaticconf_sourcedboraclejdbcTIoracle-X.X.jar
    SQL Server — <js-install>buildomaticconf_sourcedbsqlserverjdbcTIsqlserver-X.X.jar
    DB2 — <js-install>buildomaticconf_sourcedbdb2jdbcTIdb2-X.X.jar

    Copy the JAR file to a location in your WebSphere deployment and specify that location for the JDBC driver path.


    If JasperReports Server is deployed on the same host as DB2, delete the following file to avoid conflicts: <db2>/SQLLIB/java/db2jcc.jar

    b. For PostgreSQL, MySQL, and vendor drivers for Oracle, SQL Server, and DB2, enter the following:


    For example, enter:


    Alternatively, you can copy the jar to a location in your WebSphere deployment and specify that location for the JDBC driver path.


    If JasperReports Server is deployed on the same host as DB2, delete the following file to avoid conflicts: <db2>/SQLLIB/java/db2jcc.jar

    4. To ensure you have full support for import/export from the command line, copy your JDBC driver to the following location. If you are not using the command line for import/export, you can skip this step:







    5. Click Next to proceed to the next step.
    6. Review the JDBC provider information you entered and click Finish.

    To define the JDBC data source and expose it through JNDI:

    1. Click the name of the JDBC provider that you just created. For example, for PostgreSQL, click PostgreSQL JDBC Provider.


    To use a database other than PostgreSQL, configure the database connections and custom properties as described in Configuring Other Database Connections.

    2. Click Data sources in the Additional Properties of the JDBC provider details panel.
    3. To create a new data source, click New. The new data source wizard appears.
    4. Enter the data source name: jasperserver
    5. Enter the JNDI name: jdbc/jasperserver
    6. Click Next, choose Select an existing JDBC provider, then select PostgreSQL JDBC Provider from the drop-down list.
    7. Click Next and accept the default helper class (com.ibm.websphere.rsadapter.GenericDataStoreHelper). Select the check box to use this data source in container managed persistence (CMP).
    8. Click Next and select the Setup security aliases, as shown in the following table.

    Field Name

    PostgreSQL Value

    Component-managed authentication alias


    Mapping configuration alias


    Container-managed authentication alias


    9. Click Next, review the summary information, and click Finish.

    To set the connection pool size:

    1. In the list of JDBC data sources, click the newly created jasperserver data source to edit it.
    2. Click Additional Properties > Connection Pool Properties.

    You'll see that Maximum Connections is set to 10 by default.

    3. Set Maximum Connections to 50. You may want to set it to a higher value if necessary.
    4. Click Save.

    To define custom properties:

    1. In the list of JDBC data sources, select the check box for the newly created jasperserver data source and click Test Connection.

    In the Messages area a success or failure message appears. The failure message gives you information about which custom properties you need to define. For example, in the case of PostgreSQL 9.0, a message indicates that the error is related to a null database name.


    If you are using the TIBCO JDBC driver with SQL Server, and you see an error such as the following:

    Could not find stored procedure 'master..xp_jdbc_open2' DSRA0010E: SQL State = HY000, Error Code=2,812

    Add the following variable to Custom properties:

    enable2Phase = false

    2. Navigate to the jasperserver data sources General Properties page.
    3. In Additional Properties on the right side of the General Properties page, click Custom properties.
    4. Scroll down the list of properties and select databaseName. Set the value to jasperserver.
    5. Set serverName to the correct value for your server.

    To create optional sugarcrm and foodmart data sources:

    1. If you plan to run the sample reports, use the values in the following table to create the foodmart and sugarcrm JNDI data sources.
    Field Name Value

    Data source name



    JNDI name



    2. Click Save directly to the master configuration.

    Next, deploy the WAR file in WebSphere as described in Deploying the WAR File in WebSphere.

    Deploying the WAR File in WebSphere

    To deploy the JasperReports Server WAR file in WebSphere:

    1. In the Administrative Console, navigate to Applications > New Application and select New Enterprise Application.

    JasperReports Server is a modern application, based on Java Servlet version 2.4, so you do not select the older, WebSphere V4‑compliant application type.

    2. Browse to <js-install>/jasperserver-pro.war on the local file system. Keep the default setting (Fast path) selected and click Next.
    3. On the Select installation options page, accept all the default settings and click Next.
    4. On the Map modules to servers page, make sure the JasperReports Server module is mapped to the cell, node, and server that you want. Click Next.
    5. On the Map modules to servers page, select jasperserver. Click Next.
    6. On the Map resource references to resources page, map the resources you want:
    a. First, select the Browse button under the jdbc/jasperserver resource. In the page that opens, select the jdbc/jasperserver radio button, and click Apply. Then select the check box next to the jdbc/jasperserver resource.
    b. If you plan to run the sample reports, follow the same steps for jdbc/surgarcrm and jdbc/foodmart, making sure to select the correct radio button for each one.
    c. When you have mapped all resources, select the check boxes next to every resource have mapped.
    d. Click Next.
    7. On the Map virtual hosts page, choose the JasperServer UI application module. Click Next.
    8. In the Map context roots for Web modules, enter jasperserver-pro.
    9. Click Next, review the summary information and start the installation process. (The installation process may take a while.)
    10. Click Save directly to the master configuration.

    Setting JVM Options

    To set the Java JVM Options:

    For the JasperReports Server XML/A functionality to work, special Java JVM options need to be set to resolve class conflicts between the WebSphere and JasperReports Server web services implementation. JVM options also provide the optimal resources for running JasperReports Server.

    To configure your Java JVM options:

    1. Select Enterprise Applications > jasperserver-pro_war > Target specific application status > (server name).
    2. Expand Java and Process Management > Process Definition > Java Virtual Machine > Generic JVM arguments.
    3. In the Generic JVM Options text box, paste in the following JVM options that explicitly specify JasperReports Server classes for AXIS and Xalan, as well as optimize JVM resources:

    Generic JVM Options on Windows

    Options for all databases

    Additional for JDK 1.7

    Additional for Oracle

    set JAVA_OPTS=%JAVA_OPTS% -Doracle.jdbc.defaultNChar=true[/code]                    

    Generic JVM Options on Linux

    Options for all databases

    Additional for JDK 1.7

    Additional for Oracle

    export JAVA_OPTS="$JAVA_OPTS -Doracle.jdbc.defaultNChar=true"[/code]                    


    Setting the Oracle localization option, defaultNChar, can substantially impact the performance of JDBC queries. If you don't need to support UTF-8 for your Oracle database, you can omit this setting.

    4. Click Save on the console task bar.

    To configure class loading:

    1. Select Enterprise Applications > jasperserver-pro_war > Class loading and update detection.
    2. In the section Class loader order, select Classes loaded with local class loader first (parent last).
    3. (WebSphere 8.x only) In the WAR class loader policy section select Single class loader for application.
    4. Save directly to your master configuration.
    5. Restart WebSphere.

    Next, start JasperReports Server as described in Starting and Restarting JasperReports Server.

    User Feedback

    Recommended Comments

    There are no comments to display.

    This is now closed for further comments

  • Create New...