WebSphere Everyplace Access V5.0 Reporting Portlets README

Last updated: November 30, 2004

The WebSphere Everyplace Access Reporting portlets help you create custom reports that are generated from information stored in an SQL-compliant database. Administrators can create reports based on SQL statements. Then, users or other administrators can view the reports. This document describes how to install and configure the Reporting portlets.

This Readme includes the following information:

• What's included
• Prerequisites
• Installing WebSphere Everyplace Access V5.0 Reporting Portlets
• Configuring WebSphere Everyplace Access V5.0 Reporting Portlets
• Verifying the Reporting portlets were configured successfully
• Next Steps
• Removing WebSphere Everyplace Access V5.0 Reporting Portlets
• Trademarks

What's included

This package includes two portlets, Manage My Query Reports and My Query Reports. Administrators use Manage My Query Reports to create custom reports from SQL statements. Users and administrators use My Query Reports to view the generated reports that are created by the Manage My Query Reports portlet.

Return to top

Prerequisites

This Reporting portlets requires the following software and disk space:

• WebSphere Everyplace Access Version 5.0
• 12 MB disk space
  This is the total space needed for the ZIP file and the extracted files. However, additional temporary space is needed during the installation and configuration process.

Return to top

Installing WebSphere Everyplace Access V5.0 Reporting Portlets

Unzip the WEA50Reports.zip file into an installation directory, such as /usr/WebSphere/WEAReports or C:\Program Files\WebSphere\WEAReports, on the machine where WebSphere Portal is installed. NOTE: If WebSphere Portal has been clustered, only extract the zip file on the machine containing the original member of the cluster. The installation directory will be referred to as report_home. If the database server and Websphere Portal are installed on different machines, the zip file should also be extracted on the database server machine.

Return to top

Configuring WebSphere Everyplace Access V5.0 Reporting Portlets

After you have unzip the contents of the zip file, you need to configure the Reporting portlets.

1. Start the application servers.
   1. Open a command prompt and change to the Application Server bin directory, was_home /bin.
   2. Run the start server command as a root user on AIX.
      Windows:
      startServer.bat server1
      startServer.bat WebSphere_Portal
      
      AIX:
      ./startServer.sh server1
      ./startServer.sh WebSphere_Portal
      
2. From the was_home/bin directory, run the following command:
   Windows:
   setupcmdline.bat
   
   AIX:
   ./setupcmdline.sh
   

    

3. Change to the report_home/config directory.

4. Before invoking the configuration task, edit the configuration properties file, report_home/config/RPinstallconfig.properties. This properties file contains all the information required during the configuration of the Reporting portlets.

   • To configure the database:
     1. Set the property instDatabaseConfig to true. This should only be set to true on the host where the database server is running.
     2. Fill in all properties in the "Reporting Portlet Database Properties" section of the configuration properties file.
     3. If the WebSphere Everyplace Access V4.3 version of the Reporting Portlet is installed and you wish to migrate the configuration to a WebSphere Everyplace Access V5.0 database, fill in all properties in the "Reporting Portlet 1.0 Database Migration Properties" section of the configuration properties file. For migration, the properties in the "Reporting Portlet Database Properties" section refer to the WebSphere Everyplace Access V5.0 database and the properties in the "Reporting Portlet 1.0 Database Migration Properties" section refer to the WebSphere Everyplace Access V4.3 database. The WebSphere Everyplace Access V5.0 database and WebSphere Everyplace Access V4.3 database must reside on different database servers.
   • To configure the portlets:
     1. Set the property instPortletsConfig to true. This should only be set to true on the host where WebSphere Portal is installed.
     2. Fill in all properties in the "WebSphere Portal Server Properties" section of the configuration properties file.

   Note: Before executing the configuration task, pay attention to the following issues for the database server:

   • Verify the current user ID can access the DB2 environment. On Windows, the environment should already be ready for the user. For AIX, below is the example on how to setup DB2 environment. Note that the following procedure is also included in the WebSphere Everyplace Access V5.0 InfoCenter.

     1. Under your home directory, open the .profile file and add the following three lines into it.
        if [ -f /home//sqllib/db2profile ]; then
        . /home/db2admin/sqllib/db2profile;
        fi
        where db2admin denotes your database instance name.
     2. Save the file above and reopen all the shells.
     3. Verify DB2 profile environment variables are successfully setup, such as DB2INSTANCE=db2admin, where db2admin denotes your database instance name run by the environment commands.
   • Verify the database server's listening port is opened. For example, run command "db2jstrt "
5. Make sure all properties have correct values before executing the configuration tasks. Run the following commands to configure the database and portlets.
   • If the WebSphere Everyplace Access V4.3 version of the Reporting Portlet is installed and you wish to migrate the configuration to a WebSphere Everyplace Access V5.0 database, run the following command on the WebSphere Everyplace Access V4.3 database server:

     Windows:
     RPDBconfig.bat rp-db-migrate
     
     AIX:
     RPDBconfig.sh rp-db-migrate

      

   • If you are not migrating from WebSphere Everyplace Access V4.3, run the following command on the database server to create the database:

     Windows:
     RPDBconfig.bat rp-db-config
     
     AIX:
     RPDBconfig.sh rp-db-config

      

   • To configure the portlets, run the following command on the machine where WebSphere Portal is installed:

     NOTE: If WebSphere Portal has been clustered, only run this task on the original member of the cluster.

     Windows:
     RPWASconfig.bat rp-wps-config
     
     AIX:
     RPWASconfig.sh rp-wps-config

      

   • If the portlets are installed in a distributed environment (that is, WebSphere Everyplace Access components are installed on multiple computers and managed by Network Deployment), you need to reactivate the portlets. To reactivate the portlets:
     1. Logon to WebSphere Portal as an administrator.
     2. Under Administration, click Portlets, then click Manage Applications.
     3. Under Web Modules, scroll down and select WEAReports.war and select Query Reports Application under Portlet applications belonging to the selected web module.
     4. Click the Activate/Deactivate button. The status will change to inactive. Click the Activate/Deactivate button again. The status will change to active.

Return to top

Verifying the Reporting Portlets were configured successfully

After you have configured the Reporting portlets you can verify the portlets were deployed correctly.

1. Login the WebSphere Portal as an administrator.
2. Select the My Query Reports tab and you will see the My Query Reports portlet. Note: You may need to scroll the page tabs to see My Query Reports.
3. Under Administration, click WebSphere Everyplace and then click Manage My Query Reports. You will see the Manage My Query Reports portlet.

Return to top

Next Steps

By default, the My Query Reports portlet is only viewable by an administrator. To allow non-administrators to view the portlet, update the portlet's access permissions using the Resource Permissions portlet. See the WebSphere Portal V5 Infocenter for more information on the Resource Permissions portlet.

Documentation for using the WebSphere Everyplace Access Reporting portlets is provided in the portlet help files. To view help for one of the portlets, select the portlet's help button.

Return to top

Removing WebSphere Everyplace Access V5.0 Reporting Portlets

To remove WebSphere Everyplace Access V5.0 Reporting Portlets follow the instructions below:

1. Open a command prompt and change to the was_home/bin directory, run the following command:
   Windows:
   setupcmdline.bat
   
   AIX:
   ./setupcmdline.sh
   

    

2. Change to the report_home/config directory.
3. Ensure the WebSphere Application Server (server1) and WebSphere Portal Server (WebSphere_Portal) are operational.
4. Run the following commands to remove the database and portlets. NOTE: If WebSphere Portal has been clustered, only run this task on the original member of the cluster.
   • To remove the portlets, run the following command on the machine where WebSphere Portal is installed:

     Windows:
     RPWASconfig.bat rp-wps-remove
     
     AIX:
     ./RPWPSconfig.sh rp-wps-remove

      

   • To remove the database, run the following command on the database server machine:

     Windows:
     RPDBconfig.bat rp-db-remove
     
     AIX:
     ./RPDBconfig.sh rp-db-remove

      

5. Delete the report_home directory.

Return to top

Trademarks

IBM, WebSphere, and Everyplace are registered trademarks of the IBM Corporation in the United States, other countries, or both.

Microsoft, Active Directory, Exchange, Pocket PC, Internet Explorer, Windows, Windows 2003, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.

Other company, product, and service names may be trademarks or service marks of others.