Wednesday, April 1, 2009

Installation for Oracle WebLogic Server

If you need to install BI Publisher to other than the default embedded version of OC4J server then the installation process is always manual steps. No installer. You can go through the BI Publisher Installation guide for the detail. But today, I’ll cover the BI Publisher installation for Oracle WebLogic Server. I use WebLogic Server 10GR3 (10.3) version as example.

BI Publisher Installation with WebLogic Server

I have already installed WebLogic Server 10GR3 version and created a domain where I’m going to install BI Publisher Enterprise Server. So I’m going to cover the steps from this point. If you’re interested in how to install and create the domain please take a look at the WebLogic Server’s installation guide.

The installation process consists of the following main steps:

  • Unarchive BI Publisher Application file (WAR)
  • Configure BI Publisher Repository
  • Deploy BI Publisher Application
  • Validate the Deployment

Unarchive BI Publisher Application File

1. Create a staging folder

First we need to create a staging folder where we’ll unarchive the BI Publisher application file (xmlpserver.war) and locate the BI Publisher Repository.

e.g. D:\bea\BIP

2. Locate xmlpserver.war file to the staging folder

Note that you need to get the xmlpserver.war file from non-oc4j folder.

3. Move to the staging folder

4. Unjar the xmlpserver.war file by using jar utility with ‘xvf’ option.

e.g. D:\bea\BIP>jar xvf xmlpserver.war

5. Delete the xmlpserver.war file from the staging folder

6. Create a new folder called, ‘xmlpserver.war’

7. Move all the unjar-ed files to this new folder.

It should be something like this.

unjarred_war

Configure BI Publisher Repository

BI Publisher Repository is where all the BI Publisher reports are stored and all the BI Publisher server configuration settings are also stored. You can find the default BI Publisher Repository under the installation media. For example, I have deployed Oracle BI EE R10.1.3.4 suite installation media under ‘D:\Media\BI’ folder so the BI Publisher Repository can be found at:

D:\Media\BI\Windows\Server_Ancillary\Oracle_Business_Intelligence_Publisher\XMLP

1. Copy the BI Publisher Repository (entire ‘XMLP’ folder) to the staging folder.

At this point my staging folder looks like this. (My example renamed the folder name to be ‘XMLP_WL’ but this is not necessary.)

staging_folder

Now we need to register the BI Publisher Repository path in one of the BI Publisher configuration file before starting the deployment. And this is the reason why we had to unarchive the xmlpserver.war file before the deployment.

2. Open xmlp-server-config.xml file. This file can be found under WEB-INF folder.

e.g. D:\bea\BIP\xmlpserver.war\WEB-INF

3. Change the BI Publisher Repository path that is set in ‘file path’ in the file.

Before

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

After (Example)

<?xml version="1.0" encoding="UTF-8"?>
<xmlpConfig xmlns="http://xmlns.oracle.com/oxp/xmlp">
  <resource>
    <file path="D:\bea\BIP\XMLP_WL"/>
  </resource>
</xmlpConfig>

Deploy BI Publisher with WebLogic server

1. Start WebLogic Server Administration Console

Admin_Console

2. Click ‘Deployment’ menu in left hand side ‘Domain Structure’ box.

Admin_Console_Deployment

3. Click ‘Install’ button

4. Select the staging folder for the ‘current location’

5. Select ‘xmlpserver.war’ , which is the one that has just been created in the previous step.

deployment1

6. Click ‘Next’ button

7. Select ‘Install this deployment as an application’ and click ‘Next’ button.

deployment2

You can change the context name if needed. In this example I’ll keep it as it is, which is ‘xmlpserver’. You can leave the others as default.

8. Click ‘Next’ button.

deployment3

9. Click ‘Finish’ to start the deployment.

Once the deployment process is completed, go to ‘Deployment’ page by clicking ‘Deployment’ menu in the left hand side ‘Domain Structure’ box, and make sure that ‘Health’ column for the ‘xmlpserver’ shows ‘OK’ status. If you see ‘Failed’ then you need to click the link to see the detail error and fix it.

deployment_ok

UPDATE:

You need to update the weblogic server startup script in order to configure the BI Publisher scheduler setting appropriately. Here is how from the release note.

---------------------------------------------------------------------------------

If you are deploying BI Publisher to WebLogic Server 10.3.1, you must add the following setting at startup for the domain that contains the BI Publisher server in the /weblogic_home/user_projects/domains/base_domain/bin/startWebLogic.sh script :

-Dtoplink.xml.platform=oracle.toplink.platform.xml.jaxp.JAXPPlatform

This setting is required to enable BI Publisher to find the TopLink JAR files to create the Scheduler tables.

---------------------------------------------------------------------------------

Note that, the class name should be JAXPPlatform, not JAXXPlatform. An older version of the release note has this wrong, so make sure.

Validate the Deployment

You can validate the deployment by logging into BI Publisher Enterprise Server and run one sample report.

1. Go to BI Publisher login window.

You can type an URL something like below to your browser to open the login window.

http://hostname:port/xmlpserver (e.g. http://knishida-lap.us.oracle.com:7001/xmlpserver)

login_window

2. Type username and password. The default username and password are ‘Administrator/Administrator’

If you have successfully logged in and see the page like the below then your deployment is successful.

default_page

However, I’d recommend you hold on to cheer the ‘success’ with proseco until you run at least one report. Fortunately there is a set of sample reports in the BI Publisher Repository that can run without database access. But you need to do one simple configuration to enable the reports.

3. Go to ‘Admin’ tab and click ‘File’ link under ‘Data Sources’ menu

data_source

4. Click ‘demo files’

data_source2

5. Modify the Directory path

This ‘DemoFiles’ folder is actually located under the BI Publisher Repository. So modify the file path according to your repository location.

My BI Publisher Repository is located at ‘D:\bea\BIP\XMLP_WL’ so it should be something like, ‘D:\bea\BIP\XMLP_WL\DemoFiles’

data_source3

6. Click ‘Apply’ button to save the change.

7. Go back to ‘Reports’ tab and go to ‘Shared Folder’ –> ‘Financials’

babalance_letter_menu

8. Click ‘Balance Letter’ to view the report

Once you get the report output then now your BI Publisher deployment on WebLogic server is working! Now you can go outside and cheer with whatever you like!

babalance_letter

By Kanichiro Nishida, Technical Manager, Oracle EPM&BI Consulting

10 comments:

  1. Thanks for the example, it was a big help!

    ReplyDelete
  2. Thanks for your post.It made my life simple.

    ReplyDelete
  3. Thank you. Much appreciated! Why can't Oracle learn from this approach?

    ReplyDelete
  4. Thanks a lot buddy.
    Rocking Article ...

    With present release the file locations were different but was able to figure them out and After deployment application will be in prepared state.(Don't panic)We just need to start it from Deployments

    ReplyDelete
  5. BI Publisher scheduler configuration is not working, its giving error.. i have followed the steps still facing issue TopLink error.. Any work around?

    ReplyDelete
  6. Hi,
    In Oracle BI Publisher 10.1.3.4.1 i did Report Repository configuration like below:

    Repository type: XML DB
    path:c:oracle bi/xmlp/xmlp/
    Connection type: jdbc
    URL:jdbc:oracle:thin:@192.168.55.88:1521:orcl
    username:
    password:
    Databasedrive class:oracle.jdbc.driver.orcle.driver

    i saved this settings.

    After that i'm getting error Msg Like this:

    Error
    The server can not be used due to a configuration error, please contact the administrator. If you are the administrator, please consult BI Publisher user guide for proper configuration.
    Error Detail:
    oracle.apps.xdo.servlet.resources.ResourceNotFoundException: C:/OracleBI/xmlp/Admin/Security/principals.xml

    Guys please help me to find the solution..........

    Thanking You!

    ReplyDelete
  7. Hi all, i have requirement of integrating BI publisher(deployed on weblogic) with LDAP usin kerberos authentication method. we can integrated with LDAP using security configuration option available on BIP but there is no provision to specify authentication method.

    ReplyDelete
  8. Hi Kan,

    I have the following configuration installed on my server:
    FormsReports domain (version 11.1.2) on top of the 10.3.5 WebLogic.
    Is it possible to get the 11.1.1.5 BIP xmlpserver.ear file from the patch 11.1.1.5 (patch# 13683731) and deploy it with my current WebLogic? Is this a supported configuration?

    Thank you

    ReplyDelete
  9. Hi Lia, unfortunately, that's not supported. From 11g, you can't grab the ear file and deploy it, instead you need to install from the BI suite package... I know it's not easy as it used to be, and we're trying to do something about it though...

    ReplyDelete
  10. Very precise and to the point Kan. Thanks a ton

    ReplyDelete