Skip Headers
Oracle® Beehive Installation Guide
Release 2 (2.0) for Linux x86
Part Number E16641-05
Go to Documentation Home
Home		 Go to Book List
Book List		 Go to Table of Contents
Contents		 Go to Feedback page
Contact Us
Go to previous page
Previous		 Go to next page
Next
View PDF

8 Installing Oracle Beehive Portlets

This chapter describes how to install, configure, and uninstall Oracle Beehive Portlets.

It covers the following topics:

Introduction to Oracle Beehive Portlets

This section provides a brief description of Oracle Beehive Portlets and the authentication mechanism used by the portlets.

This section includes the following topic:

Oracle Beehive Portlets Architecture

The Oracle Beehive Portlets includes the following components:

Figure 8-1 shows the Oracle Beehive Portlets architecture.

Figure 8-1 The Oracle Beehive Portlets Architecture

Description of Figure 8-1 follows
Description of "Figure 8-1 The Oracle Beehive Portlets Architecture"

Oracle Beehive Portlets

Oracle Beehive Portlets is a simplified, customizable Web component that provides quick access to your most frequently used Beehive functions. When you need full access to all of your personal or workspace-related content, Oracle Beehive Portlets provides shortcuts to one or more Beehive applications, depending on what you want to do.

Oracle Beehive Portlets are JSR-168 compliant portlets that can be deployed in the portals containers (for example, IBM WebSphere Portal and Oracle WebLogic Portal). They have all the portlet logic for the given portal container in terms of invoking the UI framework with the necessary customizations and user preferences. The portlet JSP puts together the HTML of the portlet containing the JavaScript code, and responds to the initial request for the portlet rendering. Subsequently, the JavaScript in the page makes calls to the Portlet Proxy servlet from the browser to get the data and display it.

Oracle Beehive Portlets Proxy Servlet

The Oracle Beehive Portlets proxy servlet is the component that responds to the JavaScript calls from the browser for retrieving the data. The proxy forms the REST URL, establishes connections to the Portlet service, and fetches data to serve the JavaScript calls.

Oracle Beehive Portlets Service

The Oracle Beehive Portlets Service is a Beehive service that is deployed in the Beehive Application Tier. It makes the CSI (Oracle Beehive internal API) calls to the Oracle Beehive server to fetch the appropriate data. It can be managed and administered by using the Beehive administration tools like other Beehive services.

Authentication in Oracle Beehive Portlets

After Oracle Beehive Portlets is installed in a portal, they can be included on Portal pages by the administrators. Access to the portal pages and hence the portlets is controlled by the Portal. In addition, the Proxy servlet has to be protected by the same authentication mechanism as the portal. This is typically done by using the same single sign-on mechanism for both the portal and the proxy. This ensures that the proper user credentials are setup in the Proxy session. The Proxy servlet gets the username from the servlet session and uses it to fetch data from the Oracle Beehive Portlets Service. To ensure that the same user account exists in both the Portal and Beehive server, the same LDAP repository should be used for both.

Installing Oracle Beehive Portlets

This section describes the steps to install and configure Oracle Beehive Portlets on the portals certified by Oracle Corporation.

This section includes the following topics:

General Requirements for Installing Oracle Beehive Portlets

Installing Oracle Beehive Portlets includes the following tasks:

Configuring the Oracle Beehive Portlets Service

To complete the configuration of the Oracle Beehive Portlets service you must set the PortletProxyName and PortletProxyKey parameters. These parameters can be set using the Beehive administration tools.

Note:

The property value of PortletProxyName and PortletProxyKey can be decided by the administrator.

After setting the parameters, restart the portlet service. Use the following commands to set the parameters using the beectl tool:

  1. Change the directory to <Oracle Beehive home>/beehive/bin.

  2. Run the following beectl command to set the PortletProxyName property:

    beectl modify_property --component _PortletService --name PortletProxyName --value <portlet proxy name>

  3. Run the following beectl command to set the PortletProxyKey property:

    beectl modify_secure_property --component _PortletService --name PortletProxyKey --obfuscated --value

  4. Run the following command to activate the configuration:

    beectl activate_configuration

For more information about customizing Oracle Beehive Portlets, see "Customizing Oracle Beehive Portlets" in the Oracle Beehive Administrator's Guide.

Installing Oracle Beehive Portlets on Your Portal Server

You must first install the portlets.war file according to instructions provided by your portal server. Instructions for installing some of the portlets are included in the following sections.

Installing Oracle Beehive Portlets Proxy Servlet

This section describes how to install the Oracle Beehive Portlets proxy servlet.

To install the Oracle Beehive Portlets proxy servlet:

  1. Modify the values for the parameters in the web.xml file of the Oracle Beehive Portlets proxy servlet. The web.xml file is available in the proxy.war file. Table 8-1 lists these parameters.

    Note that some applications' servers allow changing a servlet parameter after install through their administration interface while in others you have to extract the web.xml file, modify it, and then jar it back in the proxy.war file. For more information, refer to your application server administration guide.

    Table 8-1 Parameters in the web.xml File

    Parameter Value Description

    auth_method

    PROXY

    This value should always be set to proxy in production deployment.

    zimbraUrlPrefix

    HOSTNAME:PORT

    The host name and port where the Oracle Beehive Webmail client is running.

    workspaceUrlPrefix

    HOSTNAME:PORT

    The host name and port where the Oracle Beehive Team Collaboration client is running.

    conferenceUrlPrefix

    HOSTNAME:PORT

    The host name and port where the Oracle Beehive Conference client is running.

    hostname

    HOSTNAME

    Host name of the Oracle Beehive Portlets Service. This is the Beehive midtier where the portlet service is installed.

    port

    PORT

    The port number of the Oracle Beehive Portlets Service.

    sslport

    PORT

    If the Oracle Beehive Portlets Service is configured on SSL port, then this specifies the port number.

    secure

    true/false

    Set it to true if you want to use SSL communication between the Oracle Beehive Portlets Proxy Servlet and Oracle Beehive Portlets Service. False, otherwise.

    proxy_config_file_path

    Path of config directory

    The directory (full path) where the ProxyConfig.xml file is located. This is also the directory where the log files will be created. This should be set to a path of your choice outside of the container where you will create and/or keep the ProxyConfig.xml file.

  2. Copy the ProxyConfig.xml file to the directory specified in the proxy_config_file_path parameter. For information about how to create the ProxyConfig.xml file, refer to "Creating the Oracle Beehive Portlets Proxy Configuration File".

    Note:

    For security reasons, ensure that the ProxyConfig.xml file has read-only permissions for the owner and is not accessible by any other user on the system.

  3. Install the proxy servlet on the same host and port as your portal. For information about how to install a Web application, refer to your application server administration guide. Note that the context root of the proxy servlet must be /beehive20.

  4. Configure your application server to protect the proxy servlet URL /beehive20 with the same single-sign on mechanism that is used for the portal.

  5. It is recommended that you setup SSL between the proxy servlet and the Oracle Beehive Portlets Service. Set the parameters sslport to the port on which the Portlet Service is configured in SSL mode and secure to true.

Creating the Oracle Beehive Portlets Proxy Configuration File

The Oracle Beehive Portlets proxy servlet requires credentials to authenticate itself to the Portlet Service. After configuring the Portlet Service by following the steps described in "Configuring the Oracle Beehive Portlets Service", you must create a config file named ProxyConfig.xml that contains the Proxy-name and Proxy-key required for connecting to the Portlet Service on the portal server where the portal is to be deployed.

In addition to the Proxy_key, there is also the value of the PortletProxyKey parameter of the Portlet Service which is entered in the command as plain text. The command to create the ProxyConfig.xml will encrypt it accordingly.

To create the config file:

  1. Create a temporary directory and unjar the Proxy.war file in it.

  2. Go to the WEB-INF/classes directory.

  3. Run the following command:

    java com/oracle/beehive/utils/ProxyConfig  "--proxy_name=proxy_name" "--proxy
_key=proxy_key" "--config_file_path=file_path"

    where

    proxy_name is the value of the PortletProxyName parameter of the Portlet Service

    proxy_key is the value of the PortletProxyKey parameter of the Portlet Service

    file_path is the complete path of the directory where the ProxyConfig.xml should be created. Note that you must provide the complete path to the directory. For example, config_file_path=/tmp on Linux and config_file_path=\tmp on Windows.

Installing Oracle Beehive Portlets on IBM WebSphere Portal

This section includes the following topics:

Procedure to Install Oracle Beehive Portlets on IBM WebSphere Portal

You install Oracle Beehive Portlets on the IBM WebSphere Portal Administration page.

To install Oracle Beehive Portlets on IBM WebSphere Portal:

  1. On the Administration Welcome page, click Web Modules under Portlet management.

  2. On the Manage Web Modules page, click Install.

  3. Click Browse to select the location of the Oracle Beehive Portlets WAR file (portlets.war) to install, and click Next.

  4. Default values are displayed in the Enterprise Application display name and Context root fields. Accept the default values or enter new values in these fields.

  5. Click Finish.

  6. Install the Oracle Beehive Portlets servlet by following the steps described in "Procedure to Install Oracle Beehive Portlets Proxy Servlet on IBM WebSphere Portal".

Procedure to Install Oracle Beehive Portlets Proxy Servlet on IBM WebSphere Portal

You install the Oracle Beehive Portlets proxy servlet on the IBM WebSphere Application Server Administration page.

To install the Oracle Beehive Portlets proxy servlet on IBM WebSphere Portal:

  1. On the Welcome page, click Install New Application under Application.

  2. On the Preparing for the Application installation page, specify the path to the Beehive Proxy servlet WAR file (proxy.war) to upload and install.

  3. In the Context root field, enter /beehive20, and then click Next.

  4. On the Install New Application page, accept the default values and click Next.

  5. On the Map modules to servers page, select the server that contains the text WebSphere Portal under Clusters and Servers.

  6. Select the target Web server and then click Next.

    Note:

    You must have both the module and the target server selected and then click Apply for the module to be mapped to the server.

  7. On the Map virtual hosts for Web modules page, accept the default values, and click Next.

  8. On the Summary page, click Finish.

  9. Click Save to save the configurations.

  10. Configure the Oracle Beehive Portlets proxy servlet by following the steps described in "Procedure to Configure Oracle Beehive Portlets Proxy Servlet for IBM WebSphere Portal".

Procedure to Configure Oracle Beehive Portlets Proxy Servlet for IBM WebSphere Portal

You configure the Oracle Beehive Portlets proxy servlet on the IBM WebSphere Application Server Administration page.

To configure the Oracle Beehive Portlets proxy servlet on IBM WebSphere Portal:

  1. On the Welcome page, click Enterprise Applications under Application.

  2. On the Enterprise Applications page, click the proxy application that you want to configure.

  3. On the Enterprise Applications page, click Initialize parameters for servlets under Web Module Properties.

  4. In the web.xml file, set values for the parameters listed in Table 8-1 and then click OK.

  5. Click Save.

  6. Copy the ProxyConfig.xml file to the directory listed in the proxy_config_file_path parameter.

  7. Configure the single-sign on to protect the proxy servlet URL /beehive20.

  8. On the Enterprise Applications page, click the Oracle Beehive Portlets proxy servlet and then click Start.

Installing Oracle Beehive Portlets on Oracle WebLogic Portal

Before you begin the installation, ensure that there is a Web project to which you can import Oracle Beehive Portlets and the Oracle Beehive Portlets proxy servlet.

This section includes the following topics:

Procedure to Install Oracle Beehive Portlets on Oracle WebLogic Portal

To install Oracle Beehive Portlets on Oracle WebLogic Portal:

  1. Open the Portal - Oracle Workspace for WebLogic page.

  2. From the File menu, click Import.

  3. In the Import dialog box, select Portlet(s) from Archive as the import source under the Other folder, and click Next.

  4. In the Import Portlet Wizard dialog box, select a target project, and click Next.

  5. Click Browse and then select the archive containing the portlets.war file.

  6. Click Next.

  7. Select the portlets to import from the archive, and click Next.

  8. Select all the supporting portlet artifacts listed, and click Finish.

  9. Install and configure the Oracle Beehive Portlets proxy servlet by following the steps described in "Procedure to Install and Configure Oracle Beehive Portlets Proxy Servlet for Oracle WebLogic Portal".

Procedure to Install and Configure Oracle Beehive Portlets Proxy Servlet for Oracle WebLogic Portal

To install and configure the Oracle Beehive Portlets proxy servlet on Oracle WebLogic Portal:

  1. From the File menu, click Import.

  2. In the Import dialog box, select WAR file as the import source under the Web folder, and click Next.

  3. Click Browse to import the proxy.war file.

  4. Select Add project to an EAR to add the proxy.war file to your project, and click Next.

  5. Click Finish.

  6. In the web.xml file, set values for the parameters listed in Table 8-1 and then click Save.

  7. In the application.xml file of the project EAR file, replace the default value of the context-root parameter with /beehive20.

  8. After the new portal application has been installed make sure that the proxy servlet URL is protected by the same authentication mechanism (single sign-on) as the portal.

  9. Copy the ProxyConfig.xml to the directory listed in the proxy_config_file_path parameter in the web.xml file of the proxy servlet.

Installing Oracle Beehive Portlets on Oracle Portal

You install Oracle Beehive Portlets on the Oracle Enterprise Manager Application Server page.

This section includes the following topics:

Procedure to Install Oracle Beehive Portlets on Oracle Portal

To install Oracle Beehive Portlets on Oracle Portal:

  1. Log in to Oracle Enterprise Manager 10g.

  2. Select the Portal Application Tier (Portal mid-tier) to which you want to deploy the portlets.

    A list of the OC4J instances available on the Application Tier that you selected is displayed.

  3. Select the OC4J instance to which you want to deploy the portlets. When using Oracle Portal, the portal container created/used for the Beehive servlet must be WSRP compliant.

  4. Click the Applications tab to deploy the WAR file.

  5. Click Deploy WAR file.

  6. On the Deploy Web Application page, click Browse and then select the portlets.war file.

  7. In the Application Name field, enter a name for the application.

  8. In the Map to URL field, enter the URL to map the portlet application.

  9. Click Deploy.

  10. After the deployment is complete, click OK.

  11. Install the Oracle Beehive Portlets proxy servlet by following the steps described in "Procedure to Install Oracle Beehive Portlets Proxy Servlet on Oracle Portal".

Procedure to Install Oracle Beehive Portlets Proxy Servlet on Oracle Portal

To install the Oracle Beehive Portlets proxy servlet on Oracle Portal:

  1. Log in to Oracle Enterprise Manager 10g.

  2. Select the Beehive Application Tier to which you want to deploy the portlets.

    A list of the OC4J instances available on the Beehive Application Tier that you selected is displayed.

  3. Select the OC4J instance to which you want to deploy the portlets. When using Oracle Portal, the portal container created/used for the Beehive servlet must be WSRP compliant.

  4. On the Applications tab, click Deploy WAR file.

  5. On the Deploy Web Application page, click Browse and then select the proxy.war file.

  6. In the Application Name field, enter a name for the application.

  7. In the Map to URL field, enter /beehive20.

  8. Click Deploy.

  9. After the deployment is complete, click OK.

  10. Copy the ProxyConfig.xml file to the directory listed in the proxy_config_file_path parameter.

  11. Configure the single-sign on authentication mechanism to protect the proxy servlet URL /beehive20.

  12. Register Oracle Beehive Portlets with Oracle Portal by following the steps mentioned in "Procedure to Register Oracle Beehive Portlets with Oracle Portal".

Procedure to Register Oracle Beehive Portlets with Oracle Portal

You register Oracle Beehive Portlets on the Oracle Application Server Portal Administration page.

To register Oracle Beehive Portlets with Oracle Portal:

  1. Log in to Oracle Application Server Portal as the portal administrator.

  2. On the Oracle Application Server Portal Administration page, click the Administer tab.

  3. Click the Portlets tab.

  4. In the Remote Providers region, click Register a Provider.

  5. On the Provider Information page, enter information about the provider. Ensure that you select WSRP from the Implementation Style list.

  6. Click Next.

  7. In the WSDL URL field on the Provide Description page, enter the URL to the WSDL file that contains the description of the provider.

    The following is the format of the URL:

    http://<portal host name>:<portal port number>/<context root of portlet WAR file>/portlets?WSDL

  8. Click Next.

  9. On the Registration Properties page, click Finish.

  10. After the registration is complete, click OK.

  11. Configure the Oracle Beehive Portlets proxy servlet by following the steps described in "Procedure to Configure Oracle Beehive Portlets Proxy Servlet for Oracle Portal".

Procedure to Configure Oracle Beehive Portlets Proxy Servlet for Oracle Portal

To configure the parameters of the Oracle Beehive Portlets proxy servlet for Oracle Portal:

  1. Open the following file in a text editor:

    <Oracle Beehive Portlets home>/j2ee/<OC4J container>/applications/<application name>/proxy/WEB_INF/web.xml

    In this path, <Oracle Beehive Portlets home> is the directory in which Oracle Beehive Portlets is installed.

  2. In the web.xml file, set values for the parameters listed in Table 8-1.

  3. Open the Oracle Enterprise Manager Application Server Control home page, and click Restart.

Installing Oracle Beehive Portlets on Oracle WebCenter Portal

This section includes the following topics:

Procedure to Create the portlet.ear File

You must create the portlet.ear from the portlet.war file before you install Oracle Beehive Portlets.

To create the portlet.ear from the portlet.war file:

  1. Copy the portlets.war file to a temporary directory.

  2. Create the META-INF directory in the temporary directory.

  3. In the META-INF directory, create the application.xml file with the following lines:

    <?xml version = '1.0' encoding = 'windows-1252'?>
<!DOCTYPE application
  PUBLIC "-//Sun Microsystems, Inc.//DTD J2EE Application 1.3//EN"
  "http://java.sun.com/dtd/application_1_3.dtd">
<application>
  <display-name>bportlets</display-name>
    <module>
      <web>
        <web-uri>portlets.war</web-uri>
        <context-root>bportlets</context-root>
      </web>
  </module>
</application>

  4. In the META-INF directory, create the orion-application.xml file with the following lines:

    <?xml version="1.0"?>
<orion-application
  xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance
  xsi:noNamespaceSchemaLocation=
    "http://xmlns.oracle.com/oracleas/schema/orion-application-10_0.xsd"
  deployment-version="10.1.3.1.0"
  default-data-source="jdbc/OracleDS"
  schema-major-version="10"
  schema-minor-version="0" >
  <imported-shared-libraries>
    <import-shared-library name="oracle.wsrp" max-version="1.0"/>
  </imported-shared-libraries>
</orion-application>

  5. In the META-INF directory, create the weblogic-application.xml file with the following line:

    <weblogic-application
  xmlns="http://www.bea.com/ns/weblogic/weblogic-application"/>

  6. To create the portlets.ear file, in a command window, switch to the temporary directory that you created and then run the following command:

    jar cvf portlets.ear *

  7. After the portlets.ear file is created, run the following command so that portlets can be deployed as remote WSRP portlets:

    java -Dhttp.proxyHost=<proxy host name> -Dhttp.proxyPort=<proxy port> -jar <Oracle WebCenter home>/webcenter/modules/oracle.portlet.server_11.1.1/wsrp-predeploy.jar portlets.ear portletswsrp.ear

  8. Configure the Oracle Beehive Portlets proxy servlet by following the steps described in "Procedure to Configure Oracle Beehive Portlets Proxy Servlet for Oracle WebCenter Portal".

Procedure to Configure Oracle Beehive Portlets Proxy Servlet for Oracle WebCenter Portal

You must set values for the parameters of the proxy.war file before you install Oracle Beehive Portlets.

To set values for the parameters in the Oracle Beehive Portlets proxy servlet for Oracle WebCenter Portal:

  1. Extract the contents of the proxy.war. This file is located at:

    <Oracle Beehive home>/beehive/portlets

  2. In the web.xml file, set values for the parameters listed in Table 8-1.

  3. Re-create the proxy.war file.

  4. Install the Oracle Beehive Portlets by following the steps described in "Procedure to Install Oracle Beehive Portlets on Oracle WebCenter Portal".

Procedure to Install Oracle Beehive Portlets on Oracle WebCenter Portal

To install Oracle Beehive Portlets on Oracle WebCenter Portal:

  1. Log in to Oracle Fusion Middleware Control 11g.

  2. On the Fusion Middleware Control Administration page, select WLS_Portlet from the list of servers displayed.

  3. In the WebLogic Server list, click Application Deployment and then click Deploy.

  4. On the Select Archive page, click Browse and then select the portletwsrp.ear file.

  5. Click Next.

  6. On the Select Target page, ensure that WLS_Portlet is selected and then click Next.

  7. On the Application Attributes page, enter details of the new application or accept the default values.

  8. Click Next.

  9. On the Deployment Settings page, accept the default values and then click Deploy.

  10. After the deployment is complete, click Close.

  11. Install the Oracle Beehive Portlets proxy servlet by following the steps described in "Procedure to Install Oracle Beehive Portlets Proxy Servlet on Oracle WebCenter Portal".

Procedure to Install Oracle Beehive Portlets Proxy Servlet on Oracle WebCenter Portal

To install the Oracle Beehive Portlets proxy servlet on Oracle WebCenter Portal:

  1. Log in to Oracle Fusion Middleware Control 11g.

  2. On the Fusion Middleware Control Administration page, select WLS_Spaces from the list of servers displayed.

  3. In the WebLogic Server list, select Application Deployment, and then Deploy.

  4. On the Select Archive page, click Browse to specify the location of the proxy.war file.

  5. Click Next.

  6. On the Select Target page, ensure that WLS_Spaces is selected and then click Next.

  7. On the Application Attributes page, enter new application details or accept the default values.

    Ensure that the context root is beehive20.

  8. Click Next.

  9. On the Deployment Settings page, accept the default values and then click Deploy.

  10. Once the deployment is complete, click Close.

  11. Copy the ProxyConfig.xml file to the directory listed in the proxy_config_file_path parameter.

  12. Configure the single-sign on authentication mechanism to protect the proxy servlet URL /beehive20.

  13. Register the Oracle Beehive Portlets with Oracle WebCenter Portal by following the steps described in "Procedure to Register Oracle Beehive Portlets with Oracle WebCenter Portal".

Procedure to Register Oracle Beehive Portlets with Oracle WebCenter Portal

To register the Oracle Beehive Portlets with Oracle WebCenter Portal:

  1. On the Fusion Middleware Control Administration page, select Webcenter Spaces under WebCenter.

  2. Under Target on the WebCenter Spaces page, click Webcenter (WLS_Spaces).

  3. Select Register Producer from the WebCenter list.

  4. On the Add Portlet Producer Connection page, specify the following details:

    1. In the Connection Name field, enter a name for the connection.

    2. Select WSRP Producer as the producer type.

    3. In the WSDL URL field, enter the WSDL URL for the WSRP producer in the following format:

      http://<WLS portlet host name>:<WLS portlet port number>/<context root of portlet EAR file>/portlets/wsrp2?WSDL

  5. Click OK.

Uninstalling Oracle Beehive Portlets

For information about how to uninstall Oracle Beehive Portlets, refer to the portal administrator's guide of your portal server.

Go to previous page
Previous		 Go to next page
Next
Go to Documentation Home
Home		 Go to Book List
Book List		 Go to Table of Contents
Contents		 Go to Feedback page
Contact Us