Installing the Documentation Files for All Releases

 

This chapter explains how to install the documentation files for BEA WebLogic Portal. The documentation describes the portal, campaign, commerce, and personalization features in WebLogic Portal. The documentation kit also include a copy of the online Help that is integrated in the E-Business Control Center for WebLogic Portal.

This topic includes the following sections:

• Documentation Kit Name and Target Locations

• Documentation File Size

• What Does the Documentation Kit Contain?

• Documentation Installation Steps

• Uninstalling the Documentation Files

 

---

Documentation Kit Name and Target Locations

The documentation kit name is wlportal400_doc_with_sp3.zip. It can be extracted onto any platform supported by WebLogic Portal.

You can unzip the documentation files standalone, to be placed in a directory of your choice, or integrated with the WebLogic Portal software directories, starting in the following subdirectory:

PORTAL_HOME\applications\wlpDocsApp\wlpDocs\...  (Windows)

PORTAL_HOME/applications/wlpDocsApp/wlpDocs/...  (UNIX)

Note: Although the integrated documentation files are unzipped into the wlpDocsApp enterprise application's directories, you can still open the documentation home page (index.htm) in a browser, without having to start the server. The wlpDocsApp enterprise application simply allows hyperlinks from other WebLogic Portal applications to find the local, integrated documentation files (if present), no matter which server startup script was used.

 

---

Documentation File Size

The documentation unzip operation requires about 270 MB of temporary, free disk space. On Windows, the program you use to unzip the files will use your %TEMP% directory; and on UNIX, the jar command uses /tmp. When the unzip operation completes, the documentation files comprise approximately 90 MB of disk space (including all the Javadoc).

 

---

What Does the Documentation Kit Contain?

The documentation kit for WebLogic Portal 4.0 includes static copies of the following documents. The BEA e-docs Web site for these product packages, starting at http://download.oracle.com/docs/cd/E13218_01/wlp/docs40/index.htm, may contain more recent versions of these documents.

• Release Notes

• Installation Guide (this document)

• Strategies for Developing E-Business Web Sites

• Architectural Overview

• Guide to Developing and Managing Portals

• Guide to Using the E-Business Control Center (a copy of the online Help that is part of the client tool)

• Migration Guide

• Deployment Guide

• Performance Tuning Guide

• Guide to Building Personalized Applications

• Glossary

• JSP Commerce and Campaign Tour

• Guide to Developing Campaign Infrastructure

• Guide to Events and Behavior Tracking

• Guide to Managing Presentation and Business Logic: Using Webflow and Pipeline

• Guide to Building a Product Catalog

• Guide to Managing Purchases and Processing Orders

• Guide to Registering Customers and Managing Customer Services

• API Javadoc for the WebLogic Portal 4.0 packages

 

---

Documentation Installation Steps

This section explains how to install the documentation files. You have two options with the wlportal400_doc_with_sp3.zip file:

• Standalone documentation option

  You can unzip the documentation files into a directory of your choice on your system. If you (optionally) have the product software installed on the target system, online Help calls from the product's Administration Tools screens will not find the local copy of the documentation files.

• Manually integrated documentation option

  You can unzip the documentation files into a specific WebLogic Portal subdirectory. If the documentation files are unzipped into the correct subdirectory, this manual option will enable Help calls from Administration Tools screens to find the local copy of the documentation files.

Regardless of whether you use the standalone or integrated option, if the documentation files are not found in a specific PORTAL_HOME/... directory, the Administration Tools Help calls will automatically attempt to find the documentation files on the WebLogic Portal 4.0 area of the BEA "E-docs" Web site.

Standalone Documentation Option Instructions

If you have not already done so, download the wlportal400_doc_with_sp3.zip file from the BEA Download Web site (recommended). Or use the static copy of wlportal400_doc.zip (October 2001) on the product CD that came in the BEA red box for WebLogic Portal.

On the target system, create a directory that will contain the WebLogic Portal 4.0 documentation files. For example, from a command prompt:

> mkdir myWLP40docs

Unzip the files from wlportal400_doc_with_sp3.zip to your target directory. Before you proceed, make sure you are pointing to the correct directory. The documentation kit contains thousands of files!

Warning: To retain the hierarchy of the documentation directories, remember to enable the "Use Folder Names" option (or equivalent) in the program that you use to unzip the files. For example, Winzip offers this option.

If you want to use the jar command to unzip the files, copy the wlportal400_doc_with_sp3.zip file to the target directory. Navigate to that directory, confirm that you are in the correct location, and then enter:

> jar -xvf wlportal400_doc_with_sp3.zip

During the unzip operations you can overwrite the temporary index.html file that is in the PORTAL_HOME\applications\wlpDocsApp\wlpDocs directory.

After the unzip operation completes, use a browser to open the index.htm file that is in your target directory. The server does not have to be running to view the standalone documentation files in a supported browser.

Manually Integrated Documentation Option Instructions

If you have not already done so, download the latest wlportal400_doc_with_sp3.zip file from the BEA Download Web site (recommended). Or use the static copy of wlportal400_doc.zip on the product CD (October 2001) that came in the WebLogic Portal red box.

In the directory where you installed the WebLogic Portal 4.0 software, navigate to the following subdirectory:

PORTAL_HOME\applications\wlpDocsApp\wlpDocs

Starting in the PORTAL_HOME\applications\wlpDocsApp\wlpDocs\* subdirectory, unzip the files from wlportal400_doc_with_sp3.zip. You can overwrite the temporary index.html file that is already in the directory.

Notes: To retain the hierarchy of the documentation directories, remember to enable the "Use Folder Names" option (or equivalent) in the program that you use to unzip the files.

Although the integrated documentation files are unzipped into a wlpDocsApp enterprise application's directories, you can still open the documentation home page (index.htm) in a browser, without having to start the server. The wlpDocsApp enterprise application simply allows hyperlinks from other WebLogic Portal applications to find the local, integrated documentation files (if present), no matter which server startup script was used.

If you want to use the jar command to unzip the files, copy the wlportal400_doc_with_sp3.zip file to the target PORTAL_HOME\applications\wlpDocsApp\wlpDocs directory. Navigate to that directory, confirm that you are in the correct location, and then enter at a command prompt:

> jar -xvf wlportal400_doc_with_sp3.zip

Again, during the unzip operation you can overwrite the temporary index.html file that is in the PORTAL_HOME\applications\wlpDocsApp\wlpDocs directory.

About the DocumentMapping.properties File

The unzip operation copies a related DocumentMapping.properties file to:

PORTAL_HOME\applications\wlpDocsApp\wlpDocs\WEB-INF\classes\*

Where PORTAL_HOME represents the directory in which you installed the product software.

The property values in DocumentMapping.properties, along with a DocumentMappingSI.properties file, are used to map calls from the product's Administration Tools screens to the documentation files. The WebLogic Portal software kit provided the DocumentMappingSI.properties file.

If the WebLogic Portal Administration Tools code finds the DocumentMapping.properties file in the PORTAL_HOME\applications\wlpDocsApp\wlpDocs\WEB-INF\classes\* directory, the local documentation files are used when you click a Help icon on an Administration screen. The integrated documentation directories and book files have the following format:

PORTAL_HOME\applications\wlpDocsApp\wlpDocs\<book-directory>\<chapter-file>.htm

If the DocumentMapping.properties file is not found, the DocumentMappingSI.properties file is used to find the corresponding documentation files on the BEA E-docs Web site. That is, in:

http://download.oracle.com/docs/cd/E13218_01/wlp/docs40/<book-directory>/
<chapter-file>.htm

After the unzip operation completes, use a browser to open the index.htm file that is in:

PORTAL_HOME\applications\wlpDocsApp\wlpDocs\index.htm 

The server does not have to be running to open the index.htm file directly in a supported browser.

 

---

Uninstalling the Documentation Files

To uninstall the documentation files, simply navigate to the directory where you unzipped the files, and delete the files there.

Important: if you are removing the documentation files in PORTAL_HOME\applications\wlpDocsApp\wlpDocs\*..., you should also remove the DocumentMapping.properties file in:

PORTAL_HOME\applications\wlpDocsApp\wlpDocs\WEB-INF\classes\*

Do not confuse the DocumentMapping.properties file that you should remove (provided by the documentation kit) with the DocumentMappingSI.properties file provided by the software kit. The DocumentMappingSI.properties file enables the mapping of Help calls from the Administration Tools screens to the WebLogic Portal 4.0 documentation files on the BEA E-docs Web site.