Installation Guide
Installation
Overview
This guide is intended for portal developers and administrators who need to install WebLogic Portlets for Groupware Integration. This product can be installed either with an installer or manually. The following sections explain the necessary procedures to successfully install this product on the various supported platforms:
Documentation Syntax Conventions
The Windows convention of "\
" as a path separator is used wherever necessary. UNIX users and users of other operating systems should translate these paths and variables accordingly.
Also, because system software and configurations can vary from one system to another, portions of the command syntax displayed in this document may include sample parameters or variables that represent the actual command syntax you would need to enter. These entries are indicated by parameters in uppercase placed between percent signs (%PARAMETER%
), and include the following:
Parameter
|
Definition
|
%COMPOZE_HOME%
|
The complete directory specification for the product. For example: c:\Program Files\compoze
|
%BEA_HOME%
|
The complete directory specification for the installation directory of the BEA WebLogic Platform 8.1. For example: d:\bea
|
%APP_HOME%
|
The complete directory specification for a BEA WebLogic Platform 8.1 Portal Application. This directory contains subdirectories such as APP-INF/lib and META-INF. For example: d:\bea\user_projects\applications\groupwareApp
|
%PROJECT_HOME%
|
The complete directory specification for a BEA WebLogic Platform 8.1 Portal Web Project. This directory is a subdirectory of the %APP_HOME% directory and contains subdirectories such as WEB-INF and framework. For example: d:\bea\user_projects\applications\groupwareApp\groupwareProject
|
Prerequisites
Installing on Windows
- Obtain the Windows installer for WebLogic Portlets for Groupware Integration (
groupware_portlets_bea81-win-25.zip
).
- Uncompress and extract the downloaded file into a temporary directory; for example:
c:\groupware_portlets_install
. You will extract three files:
- From the temporary directory, start the installer by double-clicking on
setup.exe
file. The InstallAnywhere screen opens and begins preparing the installation.
- Read through the introduction, and click Next. You will be able to exit the installation at anytime by clicking Cancel. You will also be able to go back a screen by clicking Previous when available.
- Read through the license agreement, and select an option:
- Select I accept the terms of the License Agreement to continue with the installation.
- Select I do NOT accept the terms of the License Agreement to terminate the installation.
- Select the directory where WebLogic Portlets for Groupware Integration will be installed. By default, c:\Program Files\compoze is chosen. You may change this by entering in the directory or by clicking Choose and selecting a different directory. This directory will be known as %COMPOZE_HOME%.
- Select the directory where the BEA WebLogic Platform 8.1 is installed. By default, the home directory of the latest installation of the BEA WebLogic Platform 8.1 is chosen. You may change this by entering in the directory or by clicking Choose and selecting a different directory. This directory will be known as %BEA_HOME%.
- Select the BEA WebLogic Platform 8.1 portal type into which WebLogic Portlets for Groupware Integration will be installed into. By default, a sample portal application is installed along with the BEA WebLogic Platform 8.1. You may choose to install WebLogic Portlets for Groupware Integration into the sample portal application or into a custom portal application which has been created in addition to the default BEA WebLogic Platform 8.1 installation. By default, Custom Portal Application is selected. You may change this by clicking on the Sample Portal Application radio button.
- Selecting Custom Portal Application allows you to select the location of the portal application and the portal web project.
- Selecting Sample Portal Application defaults the location of the portal application and portal web project to the location of the sample portal application and sampleportal portal web project.
- If you have selected Sample Portal Application, skip to step 16.
- Select the directory where a custom portal application exists. The portal application directory contains directories such as APP-INF\lib and META-INF. By default, the %BEA_HOME%\user_projects directory is chosen. You may change this by entering in the directory or by clicking Choose and selecting a different directory. This directory will be known as %APP_HOME%.
- Choose the product features to install. You have two options:
- Typical (default) — This option installs the full product (portlets, API, documentation, etc.).
- Custom — This option allows you to customize the features to be installed.
- If you have selected Sample Portal Application, skip to step 22.
- Select the directory where a custom portal web project exists. The portal web project directory contains directories such as WEB-INF and framework. This directory must be a subdirectory of the portal application that you have chosen in step 14 in Documentation Syntax Conventions. You may change this by entering in the directory or by clicking Choose and selecting a different directory. This directory will be known as %PROJECT_HOME%.
- Choose the option to create the Program Group in the Programs group of the Start Menu.
- Read the installation summary information before continuing. This summary contains information such as the installation directory, features chosen, the amount of disk space required, and so on.
- Click Install to begin the installation of the product.
- Once the installation is complete, click Next.
- Choose whether the Start here!, Read Me, or Change Log pages will be displayed in the default web browser after the installer exits. This option is only presented if you have chosen to install the Documentation feature during step 16 in Documentation Syntax Conventions.
- The Start here! page found at
%COMPOZE_HOME%\groupware_portlets_bea-2.5\8.1\docs\index.html
. This page provides a summary of the API and links to the included documentation. - The Read Me page found at
%COMPOZE_HOME%\groupware_portlets_bea-2.5\8.1\readme.html
. This page contains system requirements and pre-installation considerations. - The Change Log page found at
%COMPOZE_HOME%\groupware_portlets_bea-2.5\8.1\docs\changelog\changelog.html
. This page lists the changes made between versions.
- Read the Installation Complete information, and click Done to quit the installer.
- Deploy the portlet(s) in the portal by adding them to the
.portal
file.
Note: If a problem occurs during the installation, hold down the control key while starting the installer until a console appears. You will see output that explains the problem in more detail. If you are still having problems with the installer, send this output along with a description of the problem to support.
Installing on UNIX
- Obtain the UNIX installer of WebLogic Portlets for Groupware Integration (
groupware_portlets_bea81-unix-25.zip
).
- Uncompress and extract the downloaded file into a temporary directory, for example, /
groupware_portlets_install
. You will extract three files:
- The installer can be triggered in two modes:
- Graphical Mode — The Graphical Installer is can be triggered by double-clicking on the
setup.bin
executable from a window manager or by running the sh setup.bin
command from a command prompt (see Using the Graphical Installer Mode). - Console Mode — The Console Installer can be triggered by running the
"sh setup.bin -i console"
command from a command prompt (see Using the Console Installer Mode).
Note: You may have to change execute permissions on setup.bin
by executing chmod 755 setup.bin
.
The InstallAnywhere screen opens and begins preparing the installation.
Using the Graphical Installer Mode
- Read through the introduction and click Next. You will be able to exit the installation at anytime by clicking on Cancel. You will also be able to go back a screen by clicking Previous when available.
- Read through the license agreement and select an option:
- Select I accept the terms of the License Agreement to continue with the installation.
- Select I do NOT accept the terms of the License Agreement to terminate the installation.
- Select the directory where WebLogic Portlets for Groupware Integration will be installed. By default, /compoze is chosen. You may change this by entering in the directory or by clicking Choose and selecting the directory. This directory will be known as %COMPOZE_HOME%.
- Select the directory where the BEA WebLogic Platform 8.1 is installed. By default, the home directory of the latest installation of the BEA WebLogic Platform 8.1 is chosen. You may change this by entering in the directory or by clicking Choose and selecting a different directory. This directory will be known as %BEA_HOME%.
- Select the BEA WebLogic Platform 8.1 portal type into which WebLogic Portlets for Groupware Integration will be installed into. By default, a sample portal application is installed along with the BEA WebLogic Platform 8.1. You may choose to install WebLogic Portlets for Groupware Integration into the sample portal application or into a custom portal application which has been created in addition to the default BEA WebLogic Platform 8.1 installation. By default, Custom Portal Application is selected. You may change this by clicking on the Sample Portal Application radio button.
- Selecting Custom Portal Application will allow you to select the location of the portal application and the portal web project.
- Selecting Sample Portal Application defaults the location of the portal application and portal web project to the location of the sample portal application and sampleportal portal web project.
- Select the directory where a custom portal application exists. The portal application directory contains directories such as APP-INF/lib and META-INF. By default, the %BEA_HOME%/user_projects directory is chosen. You may change this by entering in the directory or by clicking Choose and selecting a different directory. This directory will be known as %APP_HOME%.
- Choose the product features to install. You have two options:
- Typical (default) — This option installs the full product (portlets, API, documentation, etc.).
- Custom — This option allows you to customize the components to be installed.
- Select the directory where a custom portal web project exists. The portal web project directory contains directories such as WEB-INF and framework. This directory must be a subdirectory of the portal application that you have chosen in step 11 in Using the Graphical Installer Mode. You may change this by entering in the directory or by clicking Choose and selecting a different directory. This directory will be known as %PROJECT_HOME%.
- Read the installation summary information before continuing. This summary contains information such as the installation directory, features chosen, the amount of disk space required, etc.
- Click Install to begin the installation of the product.
- Once the installation is complete, click Next.
- Choose whether the Start here!, Read Me, or Change Log pages will be displayed in the default web browser after the installer exits. This option is only presented if you have chosen to install the Documentation feature during step 13.
- The Start here! page found at
%COMPOZE_HOME%/groupware_portlets_bea-2.5/8.1/docs/index.html
. This page provides a summary of the API and links to the included documentation - The Read Me page found at
%COMPOZE_HOME%/groupware_portlets_bea-2.5/8.1/readme.html
.This page contains system requirements and pre-installation considerations. - The Change Log page found at
%COMPOZE_HOME%/groupware_portlets_bea-2.5/8.1/docs/changelog/changelog.html
. This page lists the changes made between versions.
- Read the Installation Complete information and click Done to quit the installer.
- Deploy the portlet(s) in the portal by adding them to the
.portal
file.
Note: If a problem occurs during the installation, hold down the control key while starting the installer until a console appears. You will see some output that explains the problem in more detail. If you are still having problems with the installer, send this output along with a description of the problem to support.
Using the Console Installer Mode
- Read through the introduction and press the Enter key. You will be able to exit the installation at anytime by typing Quit. You will also be able to go back a screen by typing Previous at any screen of the installer.
- Read through the license agreement and select an option:
- Typing Y will allow you to continue with the installation.
- Typing N will terminate the installation.
- Enter the directory WebLogic Portlets for Groupware Integration will be installed to. By default, /compoze is chosen. You may change this by typing the name of another directory. This directory will be known as %COMPOZE_HOME%.
- Enter the path to directory where the BEA WebLogic Platform 8.1 is installed. This directory will be known as %BEA_HOME%.
- Select the BEA WebLogic Platform 8.1 portal type into which WebLogic Portlets for Groupware Integration will be installed into. By default, a sample portal application is installed along with the BEA WebLogic Platform 8.1. You may choose to install WebLogic Portlets for Groupware Integration into the sample portal application or into a custom portal application which has been created in addition to the default BEA WebLogic Platform 8.1 installation. By default, Custom Portal Application is selected. You may change this by clicking on the Sample Portal Application radio button.
- Selecting Custom Portal Application will allow you to select the location of the portal application and the portal web project.
- Selecting Sample Portal Application will default the location of the portal application and portal web project to the location of the sample portal application and sampleportal portal web project.
- Enter the directory where a custom portal application exists. The portal application directory contains directories such as APP-INF/lib and META-INF. By default, the %BEA_HOME%/user_projects directory is chosen. You may change this by entering in another directory. This directory will be known as %APP_HOME%.
- Choose the product features to install. You have two options:
- Typical (default) — This option installs the full product (API, documentation, examples, and so on.).
- Custom — This option allows you to customize the components to be installed.
- Enter the directory where a custom portal web project exists. The portal web project directory contains directories such as WEB-INF and framework. This directory must be a subdirectory of the portal application that you have chosen in step 11 in Using the Console Installer Mode. You may change this by entering in another directory. This directory will be known as %PROJECT_HOME%.
- Read the installation summary information before clicking Install. This summary will contain information such as the installation directory, features chosen, the amount of disk space required, etc.
- Press the Enter key to begin the installation of the product.
- Once the installation is complete, press the Enter key.
- Choose whether the Start here!, Read Me, or Change Log pages will be displayed in the default web browser after the installer exits. This option is only presented if you have chosen to install the Documentation feature during step 13 in Using the Console Installer Mode.
- The Start here! page found at
%COMPOZE_HOME%/groupware_portlets_bea-2.5/8.1/docs/index.html
. This page provides a summary of the API and links to the included documentation - The Read Me page found at
%COMPOZE_HOME%/groupware_portlets_bea-2.5/8.1/readme.html
. This page contains system requirements and pre-installation considerations. - The Change Log page found at
%COMPOZE_HOME%/groupware_portlets_bea-2.5/8.1/docs/changelog/changelog.html
. This page lists the changes made between versions.
- Read the Installation Complete information and press the Enter key to quit the installer.
- Deploy the portlet(s) in the portal by adding them to the
.portal
file.
Installing Manually
- Obtain the noinstall version of WebLogic Portlets for Groupware Integration. (
groupware_portlets_bea81-noinstall-25.zip
).
- Extract the contents of the ZIP bundle into a directory; for example, extract into
c:\compoze
. This is the %COMPOZE_HOME%
directory. The directory groupware_portlets_bea-2.5\8.1
under COMPOZE_HOME
is COMPOZE_PORTLETS_HOME
.
- Copy
%COMPOZE_PORTLETS_HOME%\lib\harmony_portets.jar
into the following directories:
%BEA_HOME%\weblogic81\portal\lib\thirdparty\collaboration
%APP_HOME%\APP-INF\lib
- Copy the contents of the
%COMPOZE_PORTLETS_HOME%\portlets
folder into the following %PROJECT_HOME%\portlets
directory.
- Add the
CompozeGroupwareAttachmentServlet
servlet definition and mapping to the %PROJECT_HOME%\WEB-INF\web.xml file. The sample servlet definition and mapping stub can be found in the COMPOZE_PORTLETS_HOME\config\web.xml
file.
- Add the
CompozeGroupwareEmbeddedImageServlet
servlet definition and mapping to the %PROJECT_HOME%\WEB-INF\web.xml file. The sample servlet definition and mapping stub can be found in the COMPOZE_PORTLETS_HOME\config\web.xml
file.
- Copy the
compoze-portlets-im.tld
tag library descriptor file into the %PROJECT_HOME%\WEB-INF\ directory. This file can be found in the COMPOZE_PORTLETS_HOME\web directory.
- Add the
compoze-portlets-im.tld
tag library definition entry to the %PROJECT_HOME%\WEB-INF\web.xml file. The TLD definition stub can be found in the COMPOZE_PORTLETS_HOME\config\web.xml
file.
- Navigate to the
%COMPOZE_PORTLETS_HOME%\skins
directory. Select which skins you wish to install into the portal web project. Each skin directory contains a css and an images directory. The default WebLogic Portlets for Groupware Integration skins provided in the install bundle with the portal are:
%COMPOZE_PORTLETS_HOME%\skins\Avitek
%COMPOZE_PORTLETS_HOME%\skins\Classic
%COMPOZE_PORTLETS_HOME%\skins\Default
- Copy the contents of the css folder of each skin that you have chosen to install into the appropriate
%PROJECT_HOME%\framework\skins\%SKIN_NAME%\css
directories.
- Copy the contents of the images folder of each skin that you have chosen to install into the appropriate
%PROJECT_HOME%\framework\skins\%SKIN_NAME%\images
directories.
- Deploy the portlet(s) in the portal by adding them to the
.portal
file.