# Installation and Upgrade Guide

# QuickStart Overview

This chapter provides brief, high level instructions for the installation and upgrade of Collaboration, and is intended to quickly guide experienced administrators through the installation or upgrade procedure.

This chapter is divided into two major sections:

- Installation. This section covers installing the Collaboration components, scripting the database, and starting and verifying the installation. The organization of this section maps directly to detailed instructions in Chapter 4, “Installation”.
- Upgrade. This section covers upgrading version of Collaboration to the latest version. The organization of this section maps directly to detailed instructions in Chapter 5, “Upgrade”.

## Installation

Before installing Collaboration, verify that your portal is working correctly including the Search Service, Image Service, Document Repository Service, API Service, Automation Service, and ALI Logging Utilities. For more information on installing and configuring AquaLogic Interaction, see Installation and Upgrade Guide for BEA AquaLogic Interaction.

### Creating the Collaboration Database

This section describes creating the Collaboration database. Perform the procedure that is appropriate to your database platform. For more complete details on performing this task, see Creating the Collaboration Database.

Note: | Collaboration for UNIX/Linux only supports Oracle.

#### Creating the Collaboration Database (SQL Server)

Before performing these steps, ensure that you have a SQL Server portal database that is working correctly. To complete these steps, you must be the database administrator for the portal database.

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

1. Ensure that the SQL Server Service Manager is running.
2. Perform one of the following:

- (SQL Server 2000) Open the SQL Server Enterprise Manager.
- (SQL Server 2005) Open SQL Server Management Studio.

3. (SQL Server 2005) Configure the SQL Server instance to use SQL Server and Windows Authentication mode.
4. Create the Collaboration database.

(SQL Server 2005) Configure the Collaboration database to use SQL Server 2000 (80) compatibility level.

5. Create the Collaboration database user:

1. Add a login ID and password for the Collaboration database, using SQL Server Authentication.
2. Set the default database as the Collaboration database.
3. Perform one of the following:

- (SQL Server 2000) Grant the Collaboration user access to and ownership of the Collaboration database.
- (SQL Server 2005) Grant the Collaboration database user the sysadmin server role.

6. (SQL Server 2005) In the Object Explorer, expand the Collaboration database and right-click on the Security folder. Select New, Schema. In the Schema Name field, type the name of the Collaboration database user. Note that the schema name must exactly match the name of the Collaboration database user. Click the Search button and browse for the name of the Collaboration database user. Then click OK. In the Object Explorer, expand the Users folder, which is under the Security folder. Right-click on the Collaboration database user and select Properties. In the Database User window, User Mapping page, click the ... button to the right of the Default Schema name to launch the Select Schema dialog box. Browse for the schema that you created; this name should match the Collaboration database user name. Click OK to close the Select Schema dialog box, then click OK to close the Database User dialog box.
7. Perform one of the following:

- (SQL Server 2000) Close the Enterprise Manager.
- (SQL Server 2005) Close SQL Server Management Studio.

#### Creating the Collaboration Database (Oracle)

Before installing Collaboration ensure that you have a correctly installed and configured Oracle portal database.

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

Collaboration does not use its own Oracle database. Instead, the Collaboration schema is added to the existing Oracle tablespace that contains the portal schema. The Collaboration schema will be scripted after the installer is run.

Before proceeding with the Collaboration installation, 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.

### Preparing for Microsoft Exchange Integration (Windows Only)

If you are going to integrate Collaboration with Microsoft Exchange, you must prepare the system before running the Exchange Remote API installer. For details on running the Exchange Remote API installer, see Installing the Exchange Remote API to Enable Groupware Integration.

To prepare for Microsoft Exchange integration:

1. Configure IIS. For details, see Configuring and Verifying IIS.
2. Install the Microsoft .NET 1.1 Framework.

This must be downloaded from the Microsoft Web site (http://www.microsoft.com/).

3. Install Microsoft Web Services Enhancement 2.0.

This must be downloaded from the Microsoft Web site (http://www.microsoft.com/).

The .NET Framework and the Web Services Enhancement must be installed on the same machine running the groupware integration for Collaboration.

### Running the Installer

For more complete details on performing this task, see Running the Installer.

To install Collaboration, you must have administrator rights on the machine where you are running the installer. Additionally, you must have administrator privileges for the portal database.

To install Collaboration:

1. Launch the Collaboration installer by performing the following:

- (Windows) Locate and double-click the installation file: ALICollaboration_v4-2_MP1.exe
- (UNIX/Linux) Enter the following command lines to locate and launch the installer:

cd <installer_file_path>

./ALICollaboration_v4-2_MP1

2. (Windows Only) Restart the computer.

### Scripting the Portal and Collaboration Databases

After the Collaboration installer has completed the installation, you must script the portal and Collaboration databases. Perform the procedure that is appropriate to your database platform. For more complete details on performing this task, see Scripting the Portal and Collaboration Databases.

#### Configuring MS SQL Server (Windows Only)

This section describes how to create and configure the Collaboration database schema, as well as configure the portal database schema for Collaboration. For more complete details on performing this task, see Configuring MS SQL Server (Windows Only).

The following table describes the scripts that you use to perform this task:

Table 3-1 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

The scripts are located in:

<PT_HOME>\ptcollab\4.2\sql\6.1\MSSQLServer

By default, the PT_HOME directory is: C:\bea\alui. However, if you upgraded to Collaboration 4.2, PT_HOME is the same as in the previously installed version of Collaboration.

To run the scripts for configuring the Collaboration database schema, connect to SQL Server and log in as the Collaboration database user. Run the scripts on the Collaboration database in the order listed in Table 3-1.

To run the scripts for configuring the portal database schema, connect to the portal database as the portal database user. Run the scripts on the portal database in the order listed in Table 3-1.

#### Configuring Oracle

This section describes how to create and configure the Collaboration database schema, as well as configure the portal database schema for Collaboration. For more complete details on performing this task, see Configuring Oracle.

The following table describes the scripts that you use to perform this task:

Table 3-2 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

### Performing Post-Installation Procedures

For more complete details on performing these tasks, see Performing Post-Installation Procedures.

This section describes the procedures you must perform after scripting the portal and Collaboration databases. You should perform the procedures in this order:

1. Importing the Collaboration Migration Package
2. Starting the Notification Service
3. Starting Collaboration
4. Configuring Optional Collaboration Features
5. Setting Up Collaboration Logging

#### Importing the Collaboration Migration Package

This section describes how to import the Collaboration migration package. Perform the procedure that is appropriate to your operating system.

##### Importing the Migration Package (Windows)

To import the migration package in Windows, log on to the portal and import the Collaboration migration package using the Migration Wizard. The filename of the migration package is Collaboration6.pte.

##### Importing the Migration Package (UNIX/Linux)

To import the migration package in UNIX/Linux, log on to the portal and import the Collaboration6.pte file, located in:

<PT_HOME>/ptcollab/4.2/serverpackages/6.1

#### Starting the Notification Service

This section describes how to start the Notification Service. Perform the procedure that is appropriate to your operating system. For more complete details on performing this task, see Starting the Notification Service.

##### Starting the Notification Service on Windows

To start the Notification service on Windows, locate and start the BEA ALI Notification service.

##### Starting the Notification Service on UNIX/Linux

To start the Notification Service on UNIX/Linux, run the ptnotificationserverd.sh script with the start argument. This script is located in the /opt/bea/alui/ptnotification/4.2/bin directory.

#### Starting Collaboration

This section describes how to start Collaboration on Windows and UNIX/Linux.

##### Starting Collaboration on Windows

To start Collaboration on Windows:

1. Reboot the computer where Collaboration is installed if you have not done so since running the installer.
2. Start the Windows service named BEA ALI Collaboration.
3. Verify that Collaboration is functioning correctly by accessing and analyzing the Collaboration Diagnostics page:

http://<your-collab-URL>:<your-collab-port>/collab/admin/diagnostic

##### Starting Collaboration on UNIX/Linux

To start Collaboration on UNIX/Linux:

1. Run the ptcollaborationserverd.sh script with the start argument. This script is found in the /opt/bea/alui/ptcollab/4.2/bin directory.
2. Verify that Collaboration is functioning correctly by accessing and analyzing the Collaboration Diagnostics page:

http://<your-collab-URL>:<your-collab-port>/collab/admin/diagnostic

#### Configuring Optional Collaboration Features

The following optional features require additional configuration and setup after you have run the installer:

- Personal Projects
- Bulk Upload
- Groupware Integration
- Publish to Knowledge Directory

For more information on configuring these features, see Administrator Guide for BEA AquaLogic Interaction Collaboration.

#### Setting Up Collaboration Logging

For AquaLogic Interaction 6.x, you have the option to set up Collaboration Logging. This includes setting up Logging Utilities and configuring ALI Logging Spy to display Collaboration messages. For more information on setting up Collaboration Logging, refer to the Administrator Guide for BEA AquaLogic Interaction Collaboration.

## Upgrade

For more complete details on upgrading Collaboration, see Upgrade.

Note: | If you are upgrading Oracle from 10.1.x to 10.2.x or SQL Server from 2000 to 2005, you should perform the Oracle or SQL Server upgrade before upgrading Collaboration.

### Running the Installer During Upgrade

For more complete details on performing this task, see Running the Installer During Upgrade.

To run the installer during upgrade:

1. Backup the portal and Collaboration databases and the Document Repository Service.
2. Stop the BEA ALI Collaboration service, Notification Service, Search Service, Automation Service, and Document Repository Service.
3. Clear the embedded application server’s work directory. By default, this directory is located in:

- (Windows) C:\bea\alui\common\container\tomcat\<version>\work
- (UNIX/Linux) /opt/bea/alui/common/container/tomcat/<version>/work

4. Copy the installer files to the directory where you have installed the old versions of the Collaboration files.
5. On the machine hosting the previous version of Collaboration, run the installer and choose the following components:

- Collaboration
- Notification Service

6. Run the Collaboration installer on the machine on which you installed the portal’s Image Service. Choose the Image Service Files component.
7. (Windows only) Reboot the machine on which Collaboration is installed.

### Upgrading the Portal and Collaboration Databases

This section describes updating the portal and Collaboration databases. Perform the procedure that is appropriate to your database platform.

Note: | You must upgrade both the portal and Collaboration databases. Additionally, both databases must reside on the same computer.

#### Upgrading Oracle Databases

Assuming that you installed the Collaboration files in the default location, the Oracle upgrade script files are located on the Collaboration computer.

To upgrade Oracle databases:

1. Copy the Collaboration database upgrade scripts from the default installation location to an Oracle folder or subdirectory on the computer where the database resides. The scripts are located in one of the following paths:

- (Windows) <PT_HOME>\ptcollab\4.2\sql\6.1\Oracle\OracleNT9.2 OR
  <PT_HOME>\ptcollab\4.2\sql\6.1\Oracle\OracleNT10
- (UNIX/Linux) <PT_HOME>\ptcollab\4.2\sql\6.1\Oracle\OracleUnix9.2 OR
  <PT_HOME>/ptcollab/4.2/sql/6.1/Oracle/OracleUnix10

2. Ensure that you have installed the latest Oracle patches.
3. Configure the database to archive log files if you are upgrading in a production environment.
4. Shut down the database to get a read-consistent backup.
5. Using SQLPlus and the Collaboration database server schema user ID and password, run the upgrade script that is appropriate to your upgrade path:

- collaboration-server-4-0-2-to-4-1-0-upgrade.sql
- collaboration-server-4.1.1-to-4.1.2-upgrade.sql
- collaboration-server-4.1.2-to-4.2.1-upgrade.sql

Note: | If you are performing multiple upgrades, run the upgrade scripts in the order listed in Upgrade Paths.

6. Run the collaboration-server-portal-role-grant.sql script.
7. Using SQLPlus and the portal database server schema user ID and password, run the following:

- portal-collaboration-server-data.sql
- portal-collaboration-server-role-grant.sql
- portal-collaboration-server-upgrade.sql

#### Upgrading SQL Server Databases (Windows Only)

Assuming that you installed the Collaboration files in the default location, the MS SQL Server 2000 upgrade script files are located on the Collaboration computer. These scripts are located in:

<PT_HOME>\ptcollab\4.2\sql\6.1\MSSQLServer

To upgrade SQL Server databases:

1. Run Query Analyzer.
2. Open, then run the following script files on the Collaboration database as the Collaboration database user:

- collaboration-server-4-0-2-to-4-1-0-upgrade.sql
- collaboration-server-4.1.1-to-4.1.2-upgrade.sql
- collaboration-server-4.1.2-to-4.2.1-upgrade.sql
- collaboration-server-portal-role-grant.sql

Note: | If you are performing multiple upgrades, run the upgrade scripts in the order listed in Upgrade Paths.

3. Open, then run the following script files on the portal database as the portal database user:

- portal-collaboration-server-role-grant.sql
- portal-collaboration-server-data.sql
- portal-collaboration-server-upgrade.sql

4. Close Query Analyzer.

### Post-Upgrade Procedures

This section lists, in order, additional procedures that you must perform after upgrading the portal and Collaboration databases.

For more complete details on performing this task, see Post-Upgrade Procedures.

1. Import the migration package.
2. If you have set Collaboration to manually capture portal gateway values you must change the Web Service ID being used. It must be set to the WebService ID of the Notification Gateway Entry, which can be found in Collaboration Administration’s Portal Access page.
3. Start the Notification Service.
4. Start Collaboration.
5. If desired, configure the following advanced Collaboration features:

- Personal Projects
- Bulk Upload
- Groupware Integration
- Publish to Knowledge Directory

6. For more information on configuring these features, see Administrator Guide for BEA AquaLogic Interaction Collaboration.
7. Verify that Collaboration is functioning correctly by accessing and analyzing the Collaboration Diagnostics page:

http://<your-collab-URL>:<your-collab-port>/collab/admin/diagnostic

8. Rebuild the Search Collection.