Installing and Registering the WebFOCUS Portlets

How to:

To install the WebFOCUS Portlets on the IBM WebSphere Portal Server, an administrator must have Manage permissions. If Manage permissions on the portal exists, the administrator selects a .war file. Each .war file includes descriptive information about the portlet, which is placed in a database that can be queried by other portal components. During installation, the application server unpacks the .war file and places the portlet classes and resources into a file system.

During installation, the portlet state is set to active, and a new rule is automatically added to Access Control that defines the user who installed the portlet as the owner, granting management access for that portlet. The user must assign portlet access rights to other groups and users to make that portlet usable. See IBM Access Control for information about authorization rights on assigning access permissions.

Create .war files for each component using the deploy.bat script, located in your ibi\WebFOCUS77\worp\components\IBMPortlets4 directory. Running deploy.bat file will create a new directory called war_files, which will contain all the war files necessary to install on WebSphere Portal. After the WAR file is created, it can be installed to WebSphere Portal.

Note: You cannot install a portlet more than once. If you want two instances of a portlet application or portlet, use the copy command to create a second instance. For more information, see How to Copy a WebFOCUS Portlet.

The following table lists the WebFOCUS Portlets you can install on the WebSphere Portal Server with their corresponding file names:

Title

File name

WebFOCUS Deferred Status

WOAS_Deferstatus.war

WebFOCUS Domain List

WOAS_Domain.war

WebFOCUS Favorites

WOAS_Favorites.war

WebFOCUS QuickLinks

WOAS_Qlinks.war

WebFOCUS Report

WOAS_Report.war

x
Procedure: How to Install the WebFOCUS Portlets

The install process uploads the .WAR file to the server, installs the portlet, adds it to the portlet catalogue and activates the portlet.

To install the WebFOCUS Portlets.

  1. Log on to the IBM WebSphere Portal Server as the Administrator.

    Note: Make sure you have Manage permissions.

  2. Click Administration.

    The Administration page opens.

  3. Click the Portlet Management link in the left pane.

    The portlet management page opens.

  4. Click Web Modules from the list of available configuration options.

    The Manage Web Modules pane opens.

  5. Click Install.

    The Installing a Web module pane opens.

  6. In the Directory field, enter the location of the .WAR file that pertains to the WebFOCUS portlet you want to install.

    You can also click the Browse button to navigate to this location.

    The .WAR file resides on the machine where WebFOCUS is installed. For example: 

    drive:\ibi\Webfocusxxx\worp\components\IBMPortlets4\war_files

    where:

    drive

    Is the location where WebFOCUS is installed.

    xxx

    Is the version and release number of WebFOCUS.

  7. Click Next.

    The following pane opens.

  8. Click Finish to begin the installation process.

    When installation is complete, you are returned to the Install Portlets window, and a message confirming success or failure appears. A successful installation indicates that the portlet has been added to the portlet catalogue and activated. To allow others to use this portlet, you must set the access rights for it.

Top of page
x
Procedure: How to Modify WebFOCUS Portlet Parameters and Values

To modify WebFOCUS Portlet parameters and values:

  1. Click Portlets from the list of available configuration options in the Portlet Management pane.

  2. Click the right arrow icon to navigate to the last page.

  3. Click the tool icon next to the portlet name to configure the portlet you installed.

  4. Click the I want to set titles and descriptions link to provide a title for the portlet.

    The Set Locale specific titles and descriptions page opens.

  5. Click the pencil icon next to English to configure the title of this portlet.

    The Set title and description for English page opens.

  6. Enter a title and a brief description for the portlet and click OK.

    You are returned to the Manage Portlets page.

  7. Click the pencil icon to edit the portlet.hostname parameter.

    The Edit parameter portlet.hostname page displays.

  8. In the Value field, enter a fully qualified domain name of the machine where the WebFOCUS client is installed.
  9. Click OK.

    You are returned to the main Portlets page.

Top of page
x
Procedure: How to Copy a WebFOCUS Portlet

To copy a WebFOCUS Portlet:

  1. Click Portlets from the list of available configuration options in the Portlet Management pane.

  2. Click the Copy icon from the list of options on the right.

    The Copy portlet page opens.

  3. Specify a name for the WebFOCUS Portlet you want to copy.
  4. Click OK.

    A copy of the WebFOCUS Portlet is now included in the portlets list.

WebFOCUS