> Installation and Upgrade Guide > Installation

Installation and Upgrade Guide

     Previous  Next    Open TOC in new window  Open Index in new window  View as PDF - New Window  Get Adobe Reader - New Window
Content starts here

Installation

This chapter describes how to install Collaboration. If you are upgrading from an earlier version, refer first to Upgrade.

To install Collaboration:

  1. Ensure that you have met the prerequisites for installation. For details, see Installation Prerequisites.
  2. Create the Collaboration database. For details, see Creating the Collaboration Database.
  3. Install the Collaboration components. For details, see Installing the Collaboration Components.
  4. (Optional) Deploy Collaboration on WebLogic Server. By default, Collaboration is deployed on the Embedded Servlet Engine. You only need to perform this step if you want to deploy Collaboration on WebLogic Server instead of the Embedded Servlet Engine. For details, see Deploying Collaboration on WebLogic Server.
  5. Script the portal and Collaboration databases. For details, see Scripting the Collaboration and Portal Databases.
  6. Import the Collaboration migration package. For details, see Importing the Collaboration Migration Package.
  7. (Image Service on IIS only) Configure the Image Service to work properly with the AquaLogic Notification Service. For details, see Starting and Verifying the Installation.
  8. Start Collaboration and verify operation. For details, see Starting and Verifying the Installation.

 

Creating the Collaboration Database

This section describes how to create and configure the database used by Collaboration. It is expected that the person setting up the Collaboration database has a strong understanding of database system administration.

Note: The Collaboration and portal databases must be the same vendor and version and they must reside on the same physical machine.

To set up the Collaboration database, follow the steps in the subsection appropriate to your environment:

Creating and Configuring the Collaboration Database on Microsoft SQL Server

This section describes how to create and configure the Collaboration database on Microsoft SQL Server.

To set up the Collaboration database on Microsoft SQL Server:

  1. Configure the SQL Server instance to use SQL Server and Windows Authentication mode.
  2. Create the Collaboration database:
    1. Set the Collaboration database name to the name you specified for the Collaboration database when you completed the worksheets provided in the Installation and Configuration Worksheets for BEA AquaLogic Collaboration 4.5.
    2. Verify that the initial size of the Collaboration database is sufficient for your Collaboration deployment. For a relatively small installation, configure a database that is at least 100 MB. For a large enterprise with as many as 20,000 users, configure a database that is as large as 1 GB.
  3. Create the Collaboration database user login:
    1. Create the Collaboration database user login with the login name you designated when you completed the worksheet provided in the Installation and Configuration Worksheets for BEA AquaLogic Collaboration 4.5.
    2. Configure the Collaboration database user login to use SQL Server Authentication.
    3. Set the Collaboration database user login password to the password you designated when you completed the worksheet provided in the Installation and Configuration Worksheets for BEA AquaLogic Collaboration 4.5.
    4. Set the Collaboration database user login’s default database to the Collaboration database.
    5. Grant the Collaboration database user login the db_owner role for the Collaboration database.
  4. Create a schema for the Collaboration database with the schema name you designated when you completed the worksheets provided in the Installation and Configuration Worksheets for BEA AquaLogic Collaboration 4.5. This name must be the same as the Collaboration database user name.
  5. In the Collaboration database user’s login properties, navigate to the User Mapping page.
  6. Set the default schema of the Collaboration database user login to the new schema of the same name.

Configuring an Oracle Database for Collaboration

Collaboration does not use its own Oracle database. Instead, the Collaboration schema is added to the existing Oracle database that contains the portal schema.

Before installing Collaboration verify that you have a correctly installed and configured the Oracle portal database. Confirm that the open_cursors parameter in the Oracle initialization file is set to greater than 1000. This parameter should have been set correctly during the portal database set up.

 

Installing the Collaboration Components

This section describes how to install the Collaboration components.

The Collaboration components are:

  1. Collaboration Web UI: This is the core Collaboration application. It is required.
  2. Image Service Files: This required component installs the necessary images, styles, user interface controls, Java applets, and online help for Collaboration. Install these files on the same machine on which the portal’s Image Service is installed.
  3. Search Service: This required component enables Collaboration items to be indexed and searched for in the portal. One instance of the Search Service should be installed per instance of Collaboration, however a single instance can be reused in low traffic deployments. For more information on improving Search Service performance, see the Deployment Guide for BEA AquaLogic User Interaction.
    4. Note: (Windows Only) When installing the Search Service component, the Collaboration installer checks if a necessary Visual Studio 2005 patch is installed on your server. If the patch is not installed, you must choose to either allow the Collaboration installer to install the patch immediately, or manually install the patch at the time of your choosing.

When performing a clean install, you can install the Collaboration components in any order; however, you should not start any of the components until all components are installed.

Note: The Notification Service that was previously included in the Collaboration installer has been replaced by the AquaLogic Notification Service. Collaboration uses the AquaLogic Notification Service to send emails from Collaboration to end users and to serve RSS feeds if that feature is enabled. The AquaLogic Notification Service is included with the AquaLogic Interaction installer and is a required component of AquaLogic Interaction. The AquaLogic Notification Service should be installed and configured as part of your AquaLogic Interaction installation.

Launching the Collaboration Installer

This section describes how to launch the Collaboration installer.

To install Collaboration, you must have administrator rights on the machine where you are running the installer.

Note: If you have previously run the installer and a properties file has been created, you may run the installer silently based on the values in the file. Refer to Silent Properties File, for information on how to run a silent install.

To install Collaboration:

  1. Launch the Collaboration installer by performing the following:
    • UNIX/Linux:
      • Log in to the Collaboration host machine as the local administrator.
      • Copy the ALICollaboration_v4-5 installer to a temporary location and run it as follows: $ ./ALICollaboration_v4-5
    • Windows:
      • Log in to the Collaboration host machine as the local administrator.
      • Copy the ALICollaboration_v4-5.exe installer to a temporary location.
      • Close all unnecessary windows and applications.
      • Double-click ALICollaboration_v4-5.exe to launch the installer.
  2. Complete the installation wizard pages according to the settings you planned when you completed the installation worksheets provided in Installation and Configuration Worksheets for BEA AquaLogic Collaboration 4.5.

The following tables describe the Collaboration installer wizard pages. The installer wizard pages that appear vary according to your configuration and the selections you choose.

Table 4-1 Collaboration Installer Wizard Pages
Wizard Page
Description
Introduction
Provides general information on using the installer.
License Agreement
Read and accept the license agreement.
Choose Components
Select Custom or Complete.
If you select Complete, a full set of Collaboration components are installed. If you select Custom, you can select individual components to install according to your deployment plan.
License Directory
Enter the path to the location where you want to store the license.bea file. This location must be in %BEA_HOME%.
Default:
  • UNIX/Linux: /opt/bea
  • Windows: C:\bea
Existing License Update
This page is displayed if you have an existing license. Perform one of the following:
  • Select Merge License to merge an Evaluation license with the existing license.
  • Select Overwrite License to overwrite the existing license with an Evaluation license. The installer will place a backup of the existing license in BEA_HOME.
  • Select Leave Alone to leave the existing license. If you already have a production license for Collaboration, choose Leave Alone.

Note: If no license.bea file is found, this wizard page is not displayed.

For more complete details on license types and combining license keys, see Appendix C, “Licensing.”
Choose Install Folder
Accept the default installation folder or select a different folder in which to install Collaboration.
Default:
  • UNIX/Linux: /opt/bea/alui
  • Windows: C:\bea\alui
In the rest of this guide, the default installation folder will be referred to as install_dir.
Database Settings
Enter the database user login name and database name for the Collaboration database.
Portal Settings: Portal Database
Enter the type of database used by the portal. Collaboration must use the same database type as the portal.
Configuration Manager - Update
This page is displayed if an existing installation of Configuration Manager 1.0 is detected. Select if you want to update the password or port information for Configuration Manager or use the existing settings.
Configuration Manager - Port and Password
Type the port number on which you want Configuration Manager to service Collaboration requests.
By default, the port number is 12345. After running the installer, you will be able to access Configuration Manager by using the following URL: https://localhost:port_number.
Also type and confirm the Administrator password that you will use to log into Configuration Manager. The password is case-sensitive.
Path to Image Service Files
Install Image Service files on the computer on which the Image Service is installed. The path should lead to the directory where the Image Service is installed.
  • C:\bea\alui\ptimages (Windows)
  • /opt/bea/alui/ptimages (UNIX)
Before clicking Next, verify that security for the Image Service directory is appropriately configured to allow for installation of the Image Service files.
  • After you have entered the required information, click Next.
Pre-Installation
Summary
Review the list of components to be installed.
Click Install.
Launch Configuration Manager
Launch Configuration Manager.
Log in to Configuration Manager using the user name Administrator and the password you specified. Follow the instructions in Configuration Manager to complete all configurations with missing or incorrect settings.
When you have completed all Configuration Manager tasks, return to the installer and click Next.
Application Settings Confirmation
Select Yes if you have completed configuration of the Collaboration settings.
Select No, configure later to complete the installer without configuring the Collaboration settings. You must run Configuration Manager and configure your Collaboration settings before starting Collaboration.
Install Complete
(Windows Only) Choose to restart the system now or restart it manually. The system must be restarted to complete the installation.
Click Done.

 

Deploying Collaboration on WebLogic Server

The Collaboration installer automatically deploys Collaboration on the Embedded Servlet Engine. You can choose to deploy Collaboration on WebLogic Server instead of the Embedded Servlet Engine.

Important: If you choose to deploy Collaboration on WebLogic Server, you should disable the BEA ALI Collaboration Service that is installed by the installer on Windows machines. You will not be able to start and stop Collaboration using Configuration Manager.

To deploy Collaboration on WebLogic Server:

  1. Identify a domain on which to deploy Collaboration, or create a new domain. Refer to your WebLogic Server documentation for details on creating a new domain.
  2. In the portal’s config.xml file for the domain on which the portal is deployed, add the following line at the end of the <security-configuration> tag:

    3. <enforce-valid-basic-auth-credentials>false</enforce-valid-basic-auth-credentials>

    This disables basic authentication for the domain, and is necessary for WebDAV to work properly.

    Note: The <enforce-valid-basic-auth-credentials> line must be the last entry in the <security-configuration> tag for the setting to take effect.
  3. Add the following text to the setDomainEnv.sh or setDomainEnv.cmd file of the domain:
    • On UNIX/Linux, add the following to setDomainEnv.sh. You must add this as one line of code:
      • JAVA_OPTIONS="${SAVE_JAVA_OPTIONS}
      -Dbid.application.config=PT_HOME/settings
      -Dplumtree.application.config=PT_HOME/settings
      -Dbid.application=PT_HOME/ptcollab/4.5
      -Dplumtree.application=PT_HOME
    • On Windows, add the following to setDomainEnv.cmd. You must add this as one line of code:
      • set JAVA_OPTIONS=%SAVE_JAVA_OPTIONS%
      -Dbid.application.config=PT_HOME\settings
      -Dplumtree.application.config=PT_HOME\settings
      -Dbid.application=PT_HOME\ptcollab\4.5
      -Dplumtree.application=PT_HOME

      Enter the actual value of PT_HOME in the file. PT_HOME is the same value as install_dir. By default, the value for install_dir is /opt/bea/alui on UNIX/Linux and C:\bea\alui on Windows.

  4. Start the WebLogic domain.
  5. Deploy collab.ear, located in the following location, as an application in the Weblogic domain:

    6. UNIX/Linux: install_dir/ptcollab/4.5/webapp/

    Windows: install_dir\ptcollab\4.5\webapp\

    Refer to your WebLogic Server documentation for details on how to deploy an application.

  6. Update the Collaboration application settings in Configuration Manager to reflect the correct port numbers for the Collaboration UI:
    1. Launch Configuration Manager.
    2. In the application list on the left, under Collaboration, click Application Settings.
    3. Update the values of HTTP port and HTTPS port with the port numbers used by the Collaboration domain in WebLogic.
    4. Click SAVE.
  7. Update the URL of the Collaboration remote server:
    1. Log in to the portal.
    2. Navigate to the Collaboration remote server object in the Admin Object Directory and open it for editing.
    3. On the Main Settings page, set the port number of the Base URL to the port number of the Collaboration application in WebLogic.
    4. Click Finish.
  8. In Collaboration’s config.xml file for the domain on which Collaboration is deployed, add the following line at the end of the <security-configuration> tag:
    9. <enforce-valid-basic-auth-credentials>false</enforce-valid-basic-auth-credentials>

    This disables basic authentication for the domain, and is necessary for WebDAV and Collaboration RSS Feeds to work properly.

    Note: The <enforce-valid-basic-auth-credentials> line must be the last entry in the <security-configuration> tag for the setting to take effect.

 

Scripting the Collaboration and Portal Databases

After the Collaboration installer has completed installation, you must script the Collaboration and portal databases. You must have administrator privileges for the portal database. Perform the procedure that is appropriate to your database vendor.

Scripting the Databases on Microsoft SQL Server

This section describes how to create and configure the Collaboration database schema, as well as configure the portal database schema for Collaboration. The following table describes the scripts that you use to perform this task:

Table 4-2 Scripts for Creating and Configuring SQL Server Database Schemas for Collaboration
Script Function
Name
Database / ID
Configure Collaboration database schema
collaboration-server-create-tables.sql
collaboration-server-data.sql
collaboration-server-portal-role-grant.sql
Collaboration database /
Collaboration database ID
Configure portal database schema
portal-collaboration-server-role-grant.sql
portal-collaboration-server-data.sql
portal database /
portal database user ID

To script the databases on Microsoft SQL Server:

Scripting the Collaboration Database on Microsoft SQL Server

Run the following database scripts as the Collaboration database user on the Collaboration database:

  1. To delete previous tables (if they exist) and create the tables required for Collaboration, run the install_dir\ptcollab\4.5\sql\mssql\collaboration-server-create-tables.sql script.
  2. To create the objects required by Collaboration, run the
    install_dir\ptcollab\4.5\sql\mssql\collaboration-server-data.sql script.
  3. To grant the portal database user Read access to tables in the Collaboration database, run the install_dir\ptcollab\4.5\sql\mssql\collaboration-server-portal-role-grant.sql script.

Scripting the Portal Database on Microsoft SQL Server

Run the following database scripts on the portal database as the sa user:

  1. To create Collaboration objects in the portal database, run the install_dir\ptcollab\4.5\sql\mssql\portal-collaboration-server-data.sql script.
  2. To grant the Collaboration database user Read access to tables in the portal database, run the install_dir\ptcollab\4.5\sql\mssql\portal-collaboration-server-role-grant.sql script.

Scripting the Database on Oracle

This section describes how to create and configure the Collaboration database schema, as well as configure the portal database schema for Collaboration. The following table describes the scripts that you use to perform this task:

Table 4-3 Scripts for Creating and Configuring Oracle Database Schemas for Collaboration
Script Function
Name
Database / ID
Create Collaboration database schema
collaboration-server-create-table-space.sql
collaboration-server-create-user.sql
Collaboration database /
Collaboration database ID
Configure Collaboration database schema
collaboration-server-create-tables.sql
collaboration-server-data.sql
collaboration-server-portal-role-grant.sql
Collaboration database /
Collaboration database ID
Configure portal database schema
portal-collaboration-server-role-grant.sql
portal-collaboration-server-data.sql
portal database /
portal database user ID

These SQL scripts create the Collaboration schema and add specific tables and information. They also grant SELECT access to the Collaboration schema owner.

Note: If you are running the scripts on a local machine you do not need to include the command line @<Oracle_SID>, however you do need to ensure that the environment variables are set.

Perform the following procedure to run the scripts:

  1. Perform the following on the portal database server:
    1. Create the directory %ORACLE_HOME%/ptcollabscripts.
    2. Copy the Collaboration database scripts from the installation location into this folder.
  2. Update any required database patches.
  3. If you are installing in a production environment, set up the database to archive log files. Using the default configuration, you must shut down the Oracle database to get a read-consistent backup.
  4. If you want, you can change the names and locations of the COLLAB_TEMP and COLLAB_DATA tablespaces by modifying the collaboration-server-create-table-space.sql script. Put each tablespace on its own hard drive.
  5. By default, the Collaboration schema user name is collab, and the password is collab. You can change the schema user name and password by modifying the collaboration-server-create-user.sql script.
  6. Use sql*plus to execute collaboration-server-create-table-space.sql. This script creates the Collaboration schema default tablespaces.

    7. You must log in as the system user to execute this script. Substitute the correct system password in the following command: 

    sqlplus system/<system_pwd>@<ORACLE_SID>
    @collaboration-server-create-table-space.sql
  7. As the system user, execute collaboration-server-create-user.sql. This script creates the user and password you specified during Collaboration installation. The script prompts you to enter the password again; be sure to enter the correct password. 
    8. sqlplus system/<system_pwd>@<ORACLE_SID>
    @collaboration-server-create-user.sql
  8. As the Collaboration user, execute collaboration-server-create-tables.sql to create Collaboration tables. Substitute the correct Oracle user name and password; this is the user name and password you specified during Collaboration installation:
    9. sqlplus <collab_user_name>/<user_pwd>@<ORACLE_SID> 
    @collaboration-server-create-tables.sql
    Note: This script stops immediately on a SQL error. If this happens, resolve the problem and rerun the script.
  9. As the Collaboration user, execute collaboration-server-data.sql to populate the Collaboration tables. Substitute the correct Oracle user name and password; this is the user name and password you specified during Collaboration installation:
    10. sqlplus <collab_user_name>/<user_pwd>@<ORACLE_SID> 
    @collaboration-server-data.sql
  10. As the Collaboration user, execute collaboration-server-portal-role-grant.sql. This script grants the portal schema user SELECT access to required tables in the Collaboration schema. Substitute the correct Oracle user name and password; this is the user name and password you specified during Collaboration installation. The script prompts for other required passwords.
    11. sqlplus <collab_user_name>/<user_pwd>@<ORACLE_SID> 
    @collaboration-server-portal-role-grant.sql
  11. As the ALI user, execute portal-collaboration-server-role-grant.sql. This script grants the Collaboration schema user SELECT access to required tables in the portal schema. Substitute the correct portal database user name and password in the following command. The script prompts for other required passwords.
    12. sqlplus <portal_user_name>/<portal_pwd>@<ORACLE_SID> 
    @portal-collaboration-server-role-grant.sql
  12. As the ALI user, execute portal-collaboration-server-data.sql. This script creates views in the portal schema that allow it to see Collaboration tables. Substitute the correct portal database user name and password in the command:
    13. sqlplus <portal_user_name>/<portal_pwd>@<ORACLE_SID> @portal-collaboration-server-data.sql
  13. Restart the portal.

Scripting a DB2 Database on UNIX for Collaboration

This topic describes how to script a DB2 database on UNIX for use with Collaboration.

Note: For this release, BEA does not support scripting a DB2 database on Windows for Collaboration.

Before scripting a DB2 database for Collaboration:

Note: The Collaboration SQL scripts for DB2 include hard-coded schema names for the Collaboration and portal databases. In the collaboration-server-create-tables.sql, collaboration-server-data.sql, and collaboration-server-portal-role-grant.sql scripts, the hard-coded name for the Collaboration schema is COLLAB. If you updated the Collaboration schema name to anything other than COLLAB, you must navigate to Configuration Manager, Collaboration application, Collaboration Database component, and update the Schema Name setting to match the updated Collaboration schema name.
Note: In the portal-collaboration-server-role-grant.sql and portal-collaboration-server-data.sql scripts, the hard-coded name for the portal schema is ALUI. If you updated the portal schema name to anything other than ALUI, you must update these scripts to match the updated portal schema name. Additionally, you must navigate to Configuration Manager, Collaboration application, Collaboration Settings component, and update the Linked database alias setting to match the updated portal schema name. Make sure to add .dbo. to the end of the portal schema name. For example, if the portal schema name is alidbuser, the value that you type into the Linked database alias setting should be alidbuser.dbo.

Use the DB2 command line processor to run the SQL scripts against your DB2 database. Comments in the header of each SQL file contain recommended syntax for the DB2 command line processor.

To script a DB2 database for Collaboration:

  1. Copy SQL scripts from the Collaboration installation directory to your DB2 database server.

    2. The scripts are located in: install_dir/ptcollab/4.5/sql/db2

  2. As a user with administrative privileges, run the these scripts in the following order:
    1. create_collab_schema.sql
    2. create_collab_tablespace_unix.sql
    3. grant_collab_user.sql
    4. collaboration-server-create-tables.sql
    5. collaboration-server-data.sql
    6. collaboration-server-portal-role-grant.sql
    7. portal-collaboration-server-role-grant.sql
    8. portal-collaboration-server-data.sql

 

Configuring the Image Service for Notification Emails

If your Image Service is deployed on IIS, you must register two new MIME types in IIS so that email notifications will work properly.

To configure IIS for notification emails:

  1. On the machine hosting the Image Service, open the Internet Information Services (IIS) Manager, right-click the local computer name, and click Properties.
  2. Click MIME Types.
  3. Click New. This opens the MIME Type dialogue box.
  4. Type .nst in the Extension box.
  5. Type text/plain in the MIME type box.
  6. Click OK in the MIME Type dialogue box.
  7. Repeat steps 3-6, entering inc in the Extension box.
  8. Click OK to save the new settings.
  9. Click OK in the Properties dialogue box.
  10. Restart the World Wide Web Publishing Service so that the changes take effect.

 

Importing the Collaboration Migration Package

This section describes how to import the Collaboration migration package.

To import the Collaboration migration package:

  1. Verify that the Search Server is running.
  2. Log on to the portal as a user who has administrative rights.
  3. From the Administration Select Utility drop-down list, use the Migration - Import utility to import the collaboration.pte file, which is located in the following location on the Collaboration host machine:
    • UNIX/Linux: install_dir/ptcollab/4.5/serverpackages/
    • Windows: install_dir\ptcollab\4.5\serverpackages\

      • Select Overwrite Remote Servers. If necessary, adjust other import settings.

For details on using the Migration - Import utility, see Administrator Guide for BEA AquaLogic Interaction.

 

Starting and Verifying the Installation

This section describes how to start Collaboration and verify the installation.

Verifying AquaLogic Interaction Services

Verify that the following AquaLogic Interaction services are running:

For details on starting AquaLogic Interaction services, see Installation Guide for BEA AquaLogic Interaction.

Starting the Collaboration Services

This section describes how to start the Collaboration services. Follow the procedure appropriate to your environment. Depending on your configuration, all services may not be installed on the same host machine. In this case, perform each step on the host machine where the service is installed.

Starting the Collaboration Services on UNIX/Linux

To start the Collaboration services on UNIX/Linux:

  1. Start the Search Service used by Collaboration:
    1. cd to /opt/bea/alui/searchservice/1.1/bin
    2. run ./searchserviced.sh start
  2. Start Collaboration:
    1. Verify that the AquaLogic Notification Service is started.
    2. cd to /opt/bea/alui/ptcollab/4.5/bin
    3. run ./ptcollaborationd.sh start
      4. Note: If Collaboration is deployed on WebLogic Server, start the WebLogic domain on which Collaboration is deployed. Do not start the Collaboration daemon.

You can also start and stop the Collaboration services using Configuration Manager. Log in to Configuration Manager using the user name Administrator and the password you specified during installation. Follow the instructions in Configuration Manager to start each service. If Collaboration is deployed on WebLogic Server, you cannot start it from Configuration Manager.

Starting the Collaboration Services on Windows

To start the Collaboration services on Windows:

  1. Click Start > Control Panel > Administrative Tools > Services.
  2. Start BEA ALI Search Service.
  3. Verify that the AquaLogic Notification Service is started.
  4. Start BEA ALI Collaboration.
    5. Note: If Collaboration is deployed on WebLogic Server, start the WebLogic domain on which Collaboration is deployed. Do not start the BEA ALI Collaboration service.

You can also start and stop the Collaboration services using Configuration Manager. Log in to Configuration Manager using the user name Administrator and the password you specified during installation. Follow the instructions in Configuration Manager to start each service. If Collaboration is deployed on WebLogic Server, you cannot start it from Configuration Manager.

Running the Diagnostics Utility

To verify that Collaboration is functioning correctly, access and analyze the Collaboration Diagnostics page: 

http://<mycollabserver>:<mycollabport>/collab/admin/diagnostic

For more information on using the Collaboration Diagnostics page, see Administrator Guide for BEA AquaLogic Interaction Collaboration.

Check the collaboration.log file for any errors. This file is found in the /opt/bea/alui/ptcollab/4.5/settings/logs directory.


  Back to Top       Previous  Next