Oracle Business Intelligence Publisher Install Guide Release 10.1.3.2.1 Part Number B40084-01

Contents

Previous

Next

Installing Manually into a J2EE Application Server

Introduction

The BI Publisher install media contains:

• BI Publisher server application

• BI Publisher runtime libraries

• BI Publisher fonts

• BI Publisher desktop tools

• Documentation: User’s Guide, Javadocs, demos, and samples

Individual components are located as follows:

Installation Process Overview

The server application allows you to create, manage and schedule reports. You must perform the following steps as described in this document to deploy Oracle BI Publisher manually:

1. Deploy BI Publisher on the application server.

2. Configure the BI Publisher repository and install fonts.

3. Perform postinstallation tasks:

   Create the BI Publisher scheduler schema on the database server (required to send and schedule reports).

   Set up the BI Publisher Demo Reports

Installing into a J2EE Application Server

BI Publisher is a pure J2EE application and has been extensively tested on:

• Oracle AS 10.1.3

• OC4J Standalone 10.1.3

• Apache Tomcat 5.5

• IBM WebSphere 6.0, 6.1

• Sun Java System Web Server 6.1, 7.0

Oracle AS 10.1.3 and OC4J 10.1.3 Deployment

Depending on how you have installed Oracle Application Server or OC4J, there are several methods you can use to deploy BI Publisher. The following steps use the admin_client.jar file to deploy BI Publisher on Oracle AS 10.1.3 or OC4J 10.1.3. Please refer to the Oracle Containers for J2EE Deployment Guide to see which deployment method is best for your installation.

1. Deploy the xmlpserver.ear to your OC4J instance.

   Example:

   C:\SOAJ2EE\j2ee\home> C:\SOAJ2EE\jdk\jre\bin\java -jar admin_client.jar deployer:oc4j:opmn://myserver.company.com/home oc4jadmin oc4jadmin -deploy -file C:\Temp\BIPublisher10132\Disk1\manual\oc4j\xmlpserver.ear -deploymentName xmlpserver -bindAllWebApps

2. Launch the BI Publisher application.

   Open your browser to http://hostname:port/xmlpserver

   For example:

   http://localhost:8888/xmlpserver

3. If you see the login page, proceed to Configuring the BI Publisher Repository and Installing Fonts.

Apache Tomcat 5.5 Deployment

There are several approaches available to deploy applications to the Tomcat servlet container. Please see the Apache Tomcat Application Developer’s Guide to determine which method is appropriate for your installation. The following steps use the Tomcat Web Application Manager to deploy BI Publisher on Apache Tomcat 5.5:

Important: Apache Tomcat deployments of BI Publisher require that folder and file names use ASCII characters only. Any non-ASCII character will be displayed incorrectly.

1. Open the Tomcat home page.

2. Select Tomcat Manager and log in.

3. From the Tomcat Web Application Manager page, under the Deploy region, browse for and select the manual\generic\xmlpserver.war from your install media. Select the Deploy button.

4. Ensure the xmlpserver application successfully deployed. If successful, /xmplserver will appear on the Tomcat Web Application Manager page under the list of Applications.

5. Open your browser, http://hostname:port/xmlpserver to see the login page.

   For example: http://localhost:8080/xmlpserver

6. If you see the login page, proceed to Configuring the BI Publisher Repository and Installing Fonts.

IBM WebSphere 6.0 and 6.1 Deployment

This section describes one example of how to deploy the BI Publisher application to the IBM WebSphere 6.0 or 6.1 application server. Refer to your WebSphere documentation for the appropriate procedure to install into your environment.

1. Access the WebSphere Administrative Console, select Install New Application.

2. Choose the manual/generic/xmlpserver.ear file from your installation media.

3. Select the Generate Default Bindings checkbox and click Next.

4. On the Select installation options page, select the Distribute application checkbox and the Create MBeans for resources checkbox.

5. On the Map modules to servers page, select xmlpserver.war.

6. On the Map virtual hosts for Web modules page select xmlpserver.war.

7. On the Summary screen, review your selections, and select Finish.

8. You will see the deployment status on the screen. Once you see the success message, select the Save to Master Configuration link.

9. Restart BI Publisher.

   From the WebSphere Administration Console, select the Enterprise Applications link, choose "xmlpserver" and click the Stop button. Once stopped, choose "xmlpserver" and click the Start button.

10. Launch BI Publisher:

    Open your browser to http://hostname:port/xmlpserver to see the login page.

    For example: http://localhost:8080/xmlpserver

11. If you see the login page, proceed to Configuring the BI Publisher Repository and Installing Fonts.

Sun Java System Web Server 6.1 Deployment

This section describes one example of how to deploy the BI Publisher application. Follow the guidelines in your Sun Java System Web Server 6.1 documentation for the appropriate method for your installation.

Important: To successfully deploy BI Publisher on Sun Java System Web Server 6.1 you must perform the predeployment and postdeployment configuration steps described in this section:

• Before you deploy, you must ensure that the maxUploadSize property is set appropriately as described in Step 1.

• After you deploy, you must configure the system.xml file as described in Step 11.

  The xdoparser.jar files include files from the W3C org.w3c.dom package that are excluded from the same package included with the Sun Java System Web Server system jar files. To ensure these files are loaded from the xdoparser.jar file, you must configure the server.xml file to load the xmlparser.jar files first.

1. Ensure the maxUploadSize property is set appropriately to handle the size of the BI Publisher WAR file. It is recommended that you set the maxUploadSize property to 100 megabytes.

   To set the maxUploadSize property:

   In the <WebServer-install-dir>/bin/https/webapps/admin-app/WEB-INF/web.xml, add the following parameter:

   <init-param>
      <param-name>maxUploadSize</param-name>
      <param-value>100000000</param-value>
   </init-param>

   For example:

   <servlet-name>webappdeploy</servlet-name>
   <servlet-class>com.sun.web.admin.servlets.DeployServlet</servlet-class>
   <init-param>
      <param-name>maxUploadSize</param-name>
      <param-value>100000000</param-value>
   </init-param>

2. Restart the application server.

3. In a browser, open the Admin Console of the Sun Java System Web Server 6.1.

4. Select a Server from the list and click Manage.

5. Select the Virtual Server Class tab.

6. Select a Class from the list and click Manage.

7. From the Select a Virtual Server drop-down list, choose your server and click Manage.

8. Select the Web Applications tab.

9. On the Deploy Web Application page, browse for and select manual\generic\xmlpserver.war (non-oc4j version) from your install media. In the Application URI field, enter /xmlpserver then click OK.

   Please note where this WAR file deployed, indicated in the Installation Directory field.

10. Click OK to deploy the application. A message appears informing that you must apply the changes. Click Apply in the top right corner, then click Apply Changes.

11. Configure the Sun Java System Web Server server.xml file to load the xdoparser.jar files first:

    • Open <WebServer-install-dir>/<https-name-of-webserver-instance>/config/server.xml

    • Add the following class path as the first entry for the serverclasspath attribute value in the <JAVA> tag:

      <WebServer-install-dir>/<https-name-of-webserver-instance>/webapps/<https-name-of-web-server-instance>/xmlpserver/WEB-INF/lib/xdoparser.jar

      Example from server.xml:

      <JAVA javahome="C:/Sun/WebServer6.1/bin/https/jdk" 
      serverclasspath="C:/Sun/WebServer6.1/https-xmlphost/webapps/https-xmlphost/xmlpserver/WEBINF/lib/xdoparser.jar;C:/Sun/WebServer6.1/bin/https/jar/webserv-rt .jar;${java.home}/lib/tools.jar;C:/Sun/WebServer6.1/bin/https/jar/webserv-ext.jar;C:/Sun/WebServer6.1/bin/https/jar/webserv-jstl.jar;C:/Sun/WebServer6.1/bin/https/jar/ktsearch.jar" 
      classpathsuffix="" envclasspathignored="true" 
      nativelibrarypathprefix="" debug="false" debugoptions="-Xdebug 
      -Xrunjdwp:transport=dt_socket,server=y,suspend=n" dynamicreloadinterval="-1">
      

12. Launch the BI Publisher application:

    Open your browser to http://hostname:port/xmlpserver to see the login page.

    For example: http://localhost:8080/xmlpserver

13. If you see the login page, proceed to Configuring the BI Publisher Repository and Installing Fonts.

Sun Java System Web Server 7.0 Deployment

This section describes one example of how to deploy the BI Publisher application. Follow the guidelines in your Sun Java System Web Server 7.0 documentation for the appropriate method for your installation

1. In a browser, open the Admin Console of the Sun Java System Web Server 7.0.

2. Select the Virtual Servers tab under Configurations.

3. Select the virtual server, into which you will deploy the BI Publisher application.

4. Select the Web Applications tab, and then click New.

5. Browse for and select manual\generic\xmlpserver.war (non-oc4j version) from your install media. (Optionally, you can also specify a Web application archive located on the server.)

6. In the Application URI field, enter /xmlpserver then click OK.

7. Enable the application.

8. Click Deployment Pending.

9. Click the Deploy button to deploy the BI Publisher application.

10. Launch the BI Publisher application:

    Open your browser to http://hostname:port/xmlpserver to see the login page.

    For example: http://localhost:8080/xmlpserver

11. If you see the login page, proceed to Configuring the BI Publisher Repository and Installing Fonts.

Configuring the BI Publisher Repository and Installing Fonts

After deploying BI Publisher in your application server, you must set up the BI Publisher repository and install the font files.

To set up the repository, copy the xmlp repository directory to a location on your server, then edit the configuration file to point to the saved location as follows:

1. Copy the XMLP repository directory from \manual on your installation media to your server.

2. Open the xmlp-server-config.xml file located in the

   <application installation>/WEB-INF/ directory, where your application server unpacked the war or ear file.

   Example:

   In an AS/OC4J 10.1.3 deployment, the location is <ORACLE_HOME>/j2ee/home/applications/xmlpserver/xmlpserver/WEB-INF/xmlp-server-config.xml

   The file contains the following:

   <?xml version="1.0" encoding="UTF-8"?>
   <xmlpConfig xmlns="http://xmlns.oracle.com/oxp/xmlp">
    <resource>
       <file path="%s_Reports_Path%"/>
    </resource>
   </xmlpConfig>

3. Replace %s_Reports_Path% with file path to the location where you copied the XMLP repository directory on your server.

   For example, if you copied the repository directory to/home/repository/XMLP, update the xmlp-server-config.xml file as follows:

   <?xml version="1.0" encoding="UTF-8"?>
   <xmlpConfig xmlns="http://xmlns.oracle.com/oxp/xmlp">
    <resource>
       <file path="/home/repository/XMLP"/>
    </resource>
   </xmlpConfig>

   Save xmlp-server-config.xml after updating.

4. Copy the font files from the manual\fonts on the install media to the fonts directory of the Java Runtime Environment used by your J2EE container/application server.

   Example for Apache Tomcat:

   C:\Program Files\Java\jre1.5.0_07\lib\fonts

   Example for Oracle Application Server or OC4J:

   <ORACLE_HOME>…\jdk\jre\lib\fonts

   Example for WebSphere:

   <WebSphere dir>/AppServer/java/jre/lib/font

5. Restart your application server.

6. Launch BI Publisher:

   Open your browser to http://hostname:port/xmlpserver

   For example:

   http://localhost:8888/xmlpserver

7. Log in with user name "Administrator" and password "Administrator".

   Important: Please change the Administrator password on the Account tab under Preferences.

Copyright © 2004, 2007, Oracle. All rights reserved.