Browser version script

Oracle® Business Intelligence Publisher
Deploying Oracle Business Intelligence Publisher in J2EE Application Servers

Release 10.1.3.2.1
Part No. B32481-02
April 2007

This document contains the following topics:

Introduction

Oracle BI Publisher offers you the most efficient, scalable reporting solution available for complex, distributed environments. It provides a central architecture for generating and delivering information to employees, customers, and suppliers—both securely and in the right format. Oracle BI Publisher reduces the high costs associated with the development, customization and maintenance of business documents; while increasing the efficiency of reports management.

For the most current information please check:

Oracle BI Publisher Web Page:

http://www.oracle.com/technology/products/applications/publishing/index.html

BI Publisher/XML Publisher Forum:

http://forums.oracle.com/forums/forum.jspa?forumID=245

This document contains instructions for deploying BI Publisher manually on a J2EE application server. The Oracle Business Intelligence Enterprise Edition install media contains the following BI Publisher components:

These items can be found on the Oracle BI EE install media under the top level directory: Server_Ancillary\Oracle_Business_Intelligence_Publisher

Individual components are located as follows:

Directory Component
fonts Font files
generic xmlpserver.war (for non-oc4j application servers)
oc4j xmlpserver.ear (for oc4j)
XMLP XMLP repository
XMLP\DemoFiles Data source for demo reports
BI_Publisher_Desktop Template Builder for Word Add-in
doc User’s Guide, Javadocs, demos, and samples

Note: The application uses Apache Axis and the OpenSymphony Quartz Scheduler open-source software packages. The Apache license agreement for Axis is included on the install media under Server_Ancillary\Oracle_Business_Intelligence_Publisher\doc\ApacheLicense.txt and can also be obtained from http://www.apache.org/licenses/LICENSE-2.0.

System Requirements

Note: For the list of application servers and databases on which Oracle BI Publisher has been certified, see Oracle Business Intelligence Publisher Release Notes (Release 10.1.3.2.1) on the http://www.oracle.com/technology/products/xml-publisher/xmlpdocs.html.

About Oracle BI Publisher Desktop Tools

Oracle Business Intelligence Publisher provides Microsoft Office-based design tools that automate the design process for creating templates for Oracle BI Publisher.

The BI Publisher desktop tools include the following:

The system requirements for the Oracle BI Publisher Desktop tools are:

System Requirements for BI Publisher Desktop Tools
Component Supported Versions
Client Operating System
  • Windows 2000

  • Windows 2003 SP1 (32-bit only)

  • Windows XP SP2 and later

Template Builder for Word Add-in
  • Microsoft Word 2000, 2002, 2003

Requires:
  • Microsoft .NET Framework 2.0

  • Java Runtime or JDK 1.4 or later

Excel Analyzer
(If not installed on your computer, you will be prompted to download it the first time you select the Excel Analyzer button from the View Report page.)
  • Microsoft Excel 2000, 2002, 2003

Requires:
  • Microsoft .NET Framework 2.0

See the topic Installing Oracle BI Publisher Desktop Tools.

About Postinstallation Tasks

After installing the BI Publisher server, perform the following to complete your installation. These tasks are described in detail in Postinstallation Tasks.

BI Publisher Server Application 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 integration with the Oracle BI server and Presentation Services

    Set up the BI Publisher Demo Reports

    Install the Template Builder for Word Add-in

Deploying the Application Server

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

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:

  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:

  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 Configure the BI Publisher Repository and Set Up Fonts:

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 Server_Ancillary\Oracle_Business_Intelligence_Publisher\XMLP on your install 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 Server_Ancillary\Oracle_Business_Intelligence_Publisher\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.

Postinstallation Tasks

This section describes the required and optional tasks to be performed after the successful installation of the BI Publisher server into an OC4J instance or other J2EE application server.

Postinstall Checklist

To complete your BI Publisher install, perform these tasks:

Configuring the Scheduler Database

To schedule reports you must configure a database and install the BI Publisher scheduler schema.

Note: BI Publisher is supported to run against any database that supports JDBC based on Java 1.4.2 or Java 5.0 (1.5). For the list of databases on which BI Publisher has been certified, see Oracle Business Intelligence Publisher Release Notes (Release 10.1.3.2.1) on the http://www.oracle.com/technology/products/xml-publisher/xmlpdocs.html.

The following scheduler setup options are described in detail in the following sections:

Configuring the Scheduler on Oracle Database 10g

Follow the steps below to configure Oracle Database 10g for BI Publisher:

  1. Create a user on the database with connect and resource privileges (for example: bipubsched).

  2. Log in to BI Publisher as a user with Administrator privileges and select the Admin tab.

  3. Under System Maintenance, select Scheduler Configuration.

  4. Enter the database connection information for the target Oracle database and user.

    Database Type: 10g

    Connection String: jdbc:oracle:thin://<hostname>:<port#>:<oracle SID>

    Username/Password for the database user (for example: bipubsched)

    Database Driver Class: oracle.jdbc.driver.OracleDriver

  5. Click the Test Connection button to make sure the connection information is valid.

  6. Click the Install Schema button to install the scheduler tables.

  7. Restart the BI Publisher application.

Proceed to Setting Up Integration with Oracle BI.

Configuring the Scheduler on SQL Server with Oracle Application Server/OC4J 10.1.3

Important: Your Microsoft SQL Server database must be set up using "Mixed Mode" authentication.

  1. Create a user on the database and assign the user the "db_owner" role.

  2. Download DataDirect JDBC drivers.

    Oracle provides a JDBC driver for non-Oracle databases called Oracle DataDirect. This document refers to Oracle DataDirect version 3.4. Please refer to the following links for more information and to download the drivers:

  3. Set up DataDirect on OC4J.

    For more information, see the Oracle Containers for J2EE Services Guide.

  4. Register the DataDirect JDBC Driver on OC4J.

  5. Redeploy the application.

  6. Set up the connection to the Microsoft SQL Server database in BI Publisher.

Proceed to Setting Up Integration with Oracle BI.

Configuring the Scheduler on Microsoft SQL Server 2000 with Tomcat

  1. Register the JDBC Driver for Microsoft SQL Server 2000 on Tomcat.

    You can download the JDBC Driver for Microsoft SQL Server 2000 from the following location:

    http://www.microsoft.com/downloads/details.aspx?familyid=9f1874b6-f8e1-4bd6-947c-0fc5bf05bf71&displaylang=en

  2. Set up the connection to the Microsoft SQL Server database in BI Publisher.

  3. Restart the BI Publisher application.

Proceed to Setting Up Integration with Oracle BI.

Setting Up Integration with Oracle BI

  1. Open your browser to the login page. For example:

  2. Open your browser, http://hostname:port/xmlpserver to see the welcome page.

    For example: http://localhost:8888/xmlpserver

  3. Log in as an administrator.

    Note: If this is the first time you have logged in, enter the credentials: Administrator/Administrator.

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

  4. In the Oracle BI Publisher Enterprise screen, click the Admin tab.

    The Admin view contains the following sections and links:

    Section Links to Configuration Screens
    Data Sources
    • JDBC Connection

    • JNDI Connection

    • File

    Security Center
    • Security Configuration

    • Roles and Permissions

    Delivery Delivery Configuration
    System Maintenance
    • Server Configuration

    • Scheduler Configuration

    • Refresh Metadata

    Runtime Configuration
    • Properties

    • Font Mappings

    Integration Oracle BI Presentation Services
  5. Set up Oracle BI as a data source.

    See the Oracle Business Intelligence Infrastructure Installation and Configuration Guide for information on the appropriate settings.

  6. Set up integration with Oracle BI Presentation Services.

  7. Set other runtime properties as desired. From the Admin tab, under Runtime Configuration, select Properties. See the Oracle Business Intelligence Publisher User's Guide for information on the runtime properties.

  8. Restart the application server.

Setting Up the BI Publisher Demo Data Sources

BI Publisher provides a set of demonstration reports for you to view and run as samples.

The sample reports use a file-based data source and a JDBC data source. Follow the steps below to configure the data sources.

Configuring the Demo File Data Source

The XMLP directory contains the DemoFiles data source directory. Set up this folder as a file-based data source as follows:

  1. Locate the DemoFiles directory in your installation.

    For example: C:\OracleBI\xmlp\XMLP\DemoFiles

    If you performed a manual installation, the XMLP directory will be located where you copied it in the step Configuring the BI Publisher Repository and Copying Fonts.

  2. Log in to BI Publisher with Administrator credentials.

  3. Select the Admin tab.

  4. In the Data Sources section, select File.

  5. Select the data source with the name "demo files".

  6. Enter the path to the DemoFiles folder.

    For example: C:\OracleBI\xmlp\XMLP\DemoFiles

  7. Click Apply to save the changes.

Configuring the Demo JDBC Data Source

Note: The demo data source must be connected to an Oracle Database with the sample schemas and users HR and OE unlocked.

  1. Select the Admin tab.

  2. In the Data Sources section, select the JDBC Connection link.

  3. Select the select the data source with the name "demo".

  4. In the Update Data Source screen, change the connection string to point to an Oracle 10g database with unlocked OE user.

  5. Click the Test Connection button to confirm that BI Publisher can access the database.

  6. Click Apply to save the changes.

Installing Oracle BI Publisher Desktop Tools

The Oracle BI Publisher Desktop tools are recommended for users who will be designing report layout templates.

Obtain the BI Publisher Desktop tools as follows:

Important: If you have installed an earlier version of the Template Builder for Word or the Excel Analyzer you must remove the previous versions of both applications before installing a new version of either.

TTY Access to Oracle Support Services

Oracle provides dedicated Text Telephone (TTY) access to Oracle Support Services within the United States of America 24 hours a day, seven days a week. For TTY support, call 800.446.2398.

Documentation Accessibility

Our goal is to make Oracle products, services, and supporting documentation accessible, with good usability, to the disabled community. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Accessibility standards will continue to evolve over time, and Oracle is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For more information, visit the Oracle Accessibility Program Web site at http://www.oracle.com/accessibility/ .

Accessibility of Code Examples in Documentation

Screen readers may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, some screen readers may not always read a line of text that consists solely of a bracket or brace.

Accessibility of Links to External Web Sites in Documentation

This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites.

Legal Notices

The Programs (which include both the software and documentation) contain proprietary information; they are provided under a license agreement containing restrictions on use and disclosure and are also protected by copyright, patent, and other intellectual and industrial property laws. Reverse engineering, disassembly, or decompilation of the Programs, except to the extent required to obtain interoperability with other independently created software or as specified by law, is prohibited.

The information contained in this document is subject to change without notice. If you find any problems in the documentation, please report them to us in writing. This document is not warranted to be error-free. Except as may be expressly permitted in your license agreement for these Programs, no part of these Programs may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose.

If the Programs are delivered to the United States Government or anyone licensing or using the Programs on behalf of the United States Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the Programs, including documentation and technical data, shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement, and, to the extent applicable, the additional rights set forth in FAR 52.227-19, Commercial Computer Software--Restricted Rights (June 1987). Oracle Corporation, 500 Oracle Parkway, Redwood City, CA 94065.

The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup, redundancy and other measures to ensure the safe use of such applications if the Programs are used for such purposes, and we disclaim liability for any damages caused by such use of the Programs.

The Programs may provide links to Web sites and access to content, products, and services from third parties. Oracle is not responsible for the availability of, or any content provided on, third-party Web sites. You bear all risks associated with the use of such content. If you choose to purchase any products or services from a third party, the relationship is directly between you and the third party. Oracle is not responsible for: (a) the quality of third-party products or services; or (b) fulfilling any of the terms of the agreement with the third party, including delivery of products or services and warranty obligations related to purchased products or services. Oracle is not responsible for any loss or damage of any sort that you may incur from dealing with any third party.