Preparing the System 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.
This must be downloaded from the Microsoft Web site (http://www.microsoft.com/).
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 that is hosting Microsoft Exchange.
Installing Collaboration
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.
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.
Ensure that the SQL Server Service Manager is running.
Perform one of the following
(SQL Server 2000) Open the SQL Server Enterprise Manager.
(SQL Server 2005) Open SQL Server Management Studio.
(SQL Server 2005) Configure the SQL Server instance to use SQL Server and Windows Authentication mode.
Create the Collaboration database:
Select the database server where you want to create the Collaboration database.
Right-click the database folder.
Choose New Database.
Enter a database name.
Collaboration does not support case-sensitive database names.
(SQL Server 2005) Configure the Collaboration database to use SQL Server 2000 (80) compatibility level.
Click OK.
Create the Collaboration database user:
Open the Security folder.
Right-click the Logins folder and choose New Login.
Specify a user ID for the new user. This is the same user ID you will specify during the Collaboration installation.
In the Authentication area of this dialog box, choose SQL Server Authentication and type a password. You must specify this password during Collaboration installation.
In the Defaults area, set the default database to be the Collaboration database that you just created.
Perform one of the following:
(SQL Server 2000) Click the Database Access tab. In the Specify which databases can be accessed by this login box, select the Collaboration database. In the Database roles for <Collaboration database> box, select db_owner (public is already selected) and click OK.
(SQL Server 2005) Grant the Collaboration database user the sysadmin server role.
(SQL Server 2005) Perform the following:
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:
Note: 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.
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.
Click OK to close the Database User dialog box.
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 are added to the existing Oracle database that contains the portal schema.
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.
Running the Installer
This section describes how to install Collaboration.
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, 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:
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
Complete the installation wizard pages as described in the following table.
Table 4-1 Collaboration Installer Screens
Installer Screen
Description
Introduction
Provides general information on using the installer. Click Next to begin the installation.
Choose Components
You can choose the Collaboration components you want to install. Each component can be installed on a separate server depending on your configuration.
The Collaboration components are:
Collaboration: This is the core Collaboration application. It is required.
Notification: This optional component sends e-mails from Collaboration to end-users. By subscribing to objects within Collaboration, you can receive notification when the object is updated.
Note:
The Notification component is not required for users to employ the E-mail a Project and Groupware Integration features. However the E-mail a Project feature is less useful if the Notification Service is not running.
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.
After you have chosen the components you want to install, click Install.
Installation Folder
The default installation folder is
C:\bea\alui (Windows)
/opt/bea/alui (UNIX/Linux)
After you have entered the required information or accepted the default, click Next.
AquaLogic Interaction Collaboration - Application Port
Select either http or https and enter the port number.
The default port number is 11930.
After you have entered the required information, click Next.
Portal Settings: Collaboration URL
Collaboration URL: The URL that the portal and Notification Service use to communicate with Collaboration. You must specify a fully-qualified domain name, including the port number and path.
Note:
Do not change /collab/ in the URL.
After you have entered the required information, click Next.
Portal Settings: Portal Database
Perform one of the following operating system-specific procedures:
Windows: Collaboration makes connections and retrieves information from the portal database. Select the appropriate vendor for your portal and Collaboration database.
UNIX/Linux: Collaboration uses the following information to establish connections with the portal database:
Portal Database Host: This is the hostname of the portal database server. You must specify a fully-qualified domain name.
Portal Database Port: The port the portal database uses to handle requests.
Portal Database SID: The Oracle Service ID of the portal database.
Portal Database Schema User: The user_id who is granted ownership of the portal schema and its tables.
After you have entered the required information, click Next.
(Windows/SQL Server Only)
Portal Settings: Portal Database
Collaboration uses the following information to establish connections with the portal database:
Portal Host Computer: This is the hostname of the portal database server. You must specify a fully-qualified domain name.
Portal Database Port: The port the portal database uses to handle requests.
Portal Database Name: The name of the database configured to work with your portal.
Portal Database Login: The user name of the portal database owner.
After you have entered the required information, click Next.
(Windows/Oracle Only)
Portal Settings: Portal Database
Collaboration uses the following information to establish connections with the portal database:
Portal Database Host: This is the hostname of the portal database server. You must specify a fully-qualified domain name.
Portal Database Port: The port the portal database uses to handle requests.
Portal Database SID: The Windows service name of the portal database.
Portal Database Schema User: The user_id who is granted ownership of the portal schema and its tables.
After you have entered the required information, click Next.
Portal Settings: Authentication ID
To establish secure communication between the portal and Collaboration, you must specify an authentication ID and password:
Authentication ID: The portal uses the authentication ID to access resources on the machine which Collaboration is installed.
Authentication Password: This is the authentication password. This field cannot be left blank.
After you have entered the required information, click Next.
Portal Settings: Document Repository Service
The Document Repository Service is a portal component that manages storage and retrieval of documents for Collaboration and other AquaLogic Interaction products.
Document Repository Service Host: The hostname of the Document Repository Service. You must specify a fully-qualified domain name.
Document Repository Service Port: The port the Document Repository Service uses to handle requests. The default port is 8020.
After you have entered the required information, click Next.
Portal Settings: Search
The Search Service is a component of the portal that provides search functionality to the portal and Collaboration. You must use the same hostname and port used by the portal.
Search Host Computer: The hostname of Search Service. You must specify a fully-qualified domain name.
Search Port: The port that the Search Service uses to handle requests. The default value is 15250.
After you have entered the required information, click Next.
Image Service URL
Image Service URL: (This screen only appears if you chose to install the Image Service Files component) The URL of the Image Service. You must enter the full URL, including the domain name, port number, and path.
The Notification Service uses this URL to communicate with the Image Service.
After you have entered the required information, click Next.
Portal Settings: Image Service Directory
Image Service Directory: This is the directory of the portal server where the Image Service files are installed.
UNIX/Linux example: /opt/bea/alui/ptimages
Windows example: C:\bea\alui\ptimages
Note:
Before clicking Next, ensure 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.
(UNIX/Linux Only)
Collaboration: Database Connection
Enter the following configuration information for the Collaboration database:
Collaboration Schema User: The user ID who is granted ownership of the Collaboration schema and its tables.
Collaboration Schema Password: The password of the Collaboration database schema user.
After you have entered the required information, click Next.
(Windows/SQL Server Only)
Collaboration: Database Connection
Enter the following configuration information for the Collaboration database:
Collaboration Database Name: The database name for the Collaboration database.
Collaboration Database Login: The Collaboration database owner ID.
Collaboration Database Password: The Collaboration database password.
After you have entered the required information, click Next.
(Windows/Oracle Only)
Collaboration: Database Connection
Enter the following configuration information for the Collaboration database:
Collaboration Schema User: The user ID who is granted ownership of the portal schema and its tables.
Collaboration Schema Password: The password of the Collaboration database schema user.
After you have entered the required information, click Next.
Collaboration: Advanced Features
This screen lets you install the following optional advanced features of Collaboration:
Bulk Upload: This feature allows you to simultaneously upload multiple files and folders to Collaboration.
This feature uses a Java applet installed on the client’s computer which requires the Java Runtime Environment. To use this feature, you must configure certain client browser security. See Administrator Guide for BEA AquaLogic Interaction Collaboration for more information on client changes that you must perform after installing Collaboration.
WebDAV Service: The Web-based Document Authoring and Versioning (WebDAV) protocol is an extension to the HTTP protocol that allows for easier document management.
You must install WebDAV to use the WebEdit and Map a Web Folder features. For more information on these features, see Administrator Guide for BEA AquaLogic Interaction Collaboration.
Microsoft Exchange Integration:
(Windows Only)
This option allows users to synchronize personal Collaboration calendars with their Microsoft Exchange calendar to use Groupware Integration features. To integrate Microsoft Exchange with Collaboration, you must also install the Exchange Remote API. For details, see Installing the Exchange Remote API to Enable Groupware Integration.
The Collaboration installer configures Groupware Integration-specific settings in config.xml. In order to do this:
Microsoft Internet Information Server (IIS) must be running
Microsoft .NET Framework must be installed
Microsoft Web Server Enhancement (WSE) must be installed
Note:
Groupware Integration is not required for users to employ the E-mail a Project feature. For details on the E-mail a Project feature, see Administrator Guide for BEA AquaLogic Interaction Collaboration.
Lotus Notes Integration: This option allows users to synchronize personal Collaboration calendars with their Lotus notes calendar to use Groupware Integration features. The Collaboration installer configures Groupware Integration-specific settings in config.xml.
If you install this feature, you must perform several configuration steps after Collaboration has been installed. For more information, see Administrator Guide for BEA AquaLogic Interaction Collaboration.
No Groupware Integration: Choose this option if you do not want to configure Groupware Integration at this time. If you decide to configure Groupware Integration at a later point, change the config.xml file settings for Groupware Integration appropriately at the desired time. For details on settings Groupware Integration-specific settings in config.xml, see Administrator Guide for BEA AquaLogic Interaction Collaboration.
Note:
Groupware Integration is not required for users to employ the E-mail a Project feature. For more details on the E-mail a Project feature, see Administrator Guide for BEA AquaLogic Interaction Collaboration.
After you have chosen the features that you want to install, click Next.
(Windows Only)
Collaboration: Exchange Remote API URL
The URL that the Exchange Remote API uses to communicate with Collaboration.
After you have entered the required information or accepted the default, click Next.
Notification: Connection Settings
Notification Host: The hostname of the Notification Service.
Notification Port: The port where the Notification Service listens for requests. The default value is 9887.
After you have entered the required information, click Next.
Notification: e-mail Server Settings
To configure the Notification Service, enter the following:
Mail Server Host: The location of the mail server for your site.
Notification E-mail Address: The e-mail address used to send Collaboration notifications.
Notification E-mail Name: The notification e-mail name that appears in the “From” field of notification e-mails.
Note:
The e-mail address specified here will receive a copy of every e-mail notification sent. You may want to create an e-mail account to receive these notifications.
SMTP Server supports e-mail relaying: Select this check box if your SMTP server supports e-mail relaying.
SMTP Domain List: If your SMTP server does not support relaying, clear the SMTP Server supports e-mail relaying check box, and list valid e-mail domains in a comma-delimited list.
After you have entered the required information, click Next.
Collaboration: e-mail a Project
Specify whether or not you want to enable e-mailing a project. If you enable this feature, enter the following:
e-mail Domain: The e-mail domain for Collaboration to use to receive e-mail messages.
e-mail Port: The port for Collaboration to receive e-mail messages. The default port number is 25.
After you have entered the required information, click Next.
Note:
For instructions on how to configure the E-mail a Project feature, see Administrator Guide for BEA AquaLogic Interaction Collaboration.
Pre-Installation Summary
This screen provides a summary of the installation information you have provided in the installer. After you have reviewed this information and are satisfied with the values you have provided, click Install.
Install Complete
This screen appears after the installer has finished. You must reboot the system before continuing to the post-installation procedures.
After you have made a selection, click Finish.
(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. You must have administrator privileges for the portal database. Perform the procedure that is appropriate to your database platform.
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. Perform the procedure that is appropriate to your version of MS SQL Server.
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
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.
These scripts create the Collaboration-specific tables and information in the Collaboration database. They also grant rights to access necessary tables in the portal database to the Collaboration database owner.
Configuring MS SQL Server 2000
To configure MS SQL Server 2000:
Run Query Analyzer.
Connect to SQL Server and log in as the Collaboration database user.
Select the Collaboration database.
Open and run collaboration-server-create-tables.sql.
This script attempts to drop tables from the database before adding new ones.
Open and run collaboration-server-data.sql.
This script adds configuration information for the Collaboration database.
Open and run collaboration-server-portal-role-grant.sql.
This script grants the portal database user SELECT access to the Collaboration tables.
Connect to the portal database as the portal database user.
Note:
Pay careful attention to this step. You must connect to the portal database (in previous steps of this procedure, you were running scripts on the Collaboration database).
Open and run portal-collaboration-server-role-grant.sql.
This script grants the Collaboration database user SELECT access to the portal database tables.
Open and run portal-collaboration-server-data.sql.
This script adds configuration information for the portal database.
Close Query Analyzer.
Restart the portal.
Configuring MS SQL 2005
To configure MS SQL Server 2005:
Run SQL Server Management Studio.
Open, then run the following script files on the Collaboration database as the Collaboration database user:
collaboration-server-create-tables.sql.
collaboration-server-data.sql.
collaboration-server-portal-role-grant.sql.
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.
Run the script files that you opened.
Configuring 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
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:
Perform the following on the portal database server:
Create the directory %ORACLE_HOME%/ptcollabscripts.
Copy the Collaboration database scripts from the installation location into this folder.
Update any required database patches.
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.
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. We recommend having at least two SCSI hard drives. Put each tablespace on its own hard drive.
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.
Use sql*plus to execute collaboration-server-create-table-space.sql. This script creates the Collaboration schema default tablespaces.
You must log in as the system user to execute this script. Substitute the correct system password in the following command:
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.
As the Collaboration Server 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:
This script stops immediately on a SQL error. If this happens, resolve the problem and rerun the script.
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:
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 Server installation. The script prompts for other required passwords.
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.
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:
This section describes the procedures you must perform after scripting the portal and Collaboration databases. You should perform the procedures in this order:
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 on Windows:
Log on to the portal as a user who has administrative rights.
Click the Administration tab.
In the Select Utility drop-down, select Migration-Import and accept the defaults.
In the Migration Package area, go to File Path.
Click Browse to find the .pte file: Collaboration6.pte
Click Open.
Click Load Package.
If you are upgrading from an earlier version of Collaboration and have changed the port number that Collaboration runs on, check Overwrite Remote Servers.
Click Finish.
A pop up dialog displays asking if you want to import. Click Yes.
The Collaboration folder is viewable in the Admin Objects Directory.
Click the Collaboration folder to check for the following objects:
Content Source
Group
Portlet
Property
Remote Server
Web Service
Importing the Migration Package (UNIX/Linux)
To import the migration package on UNIX/Linux.
To import the migration package:
Log on to the portal as a user who has administrative rights.
Click the Administration tab.
In the Select Utility drop-down, select Migration-Import and accept the defaults.
In the Migration Package area, go to File Path.
Click Browse to find the Collaboration6.pte file, located in:
<PT_HOME>/ptcollab/4.2/serverpackages/6.1
Click Open.
Click Load Package.
If you are upgrading from an earlier version of Collaboration and have changed the port number that Collaboration runs on, check Overwrite Remote Servers.
Click Finish.
A pop up dialog displays asking if you want to import. Click OK.
The Collaboration folder is viewable in the Admin Objects Directory.
Click the Collaboration folder to check for the following objects: Content Source; Group; Portlet; Remote Server; Property; Web Service.
Starting the Notification Service
This section describes how to start the Notification Service on Windows and UNIX/Linux.
Starting the Notification Service on Windows
To start the Notification service on Windows:
Start | Programs | AdministrativeTools | Services
Locate and then right-click the BEA ALI Notification service and select Start.
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.
To run the script use ptnotificationserverd.sh start and to stop the script use ptnotificationserverd.sh stop
This script executes the Notification Service in the background and can be incorporated into the Linux environment startup scripts if necessary.
Check the notification.log file for errors. This file is found in the /opt/bea/alui/ptnotification/4.2/settings/logs directory.
Starting Collaboration
This section describes how to start Collaboration on Windows and UNIX/Linux.
Starting Collaboration on Windows
To start Collaboration on Windows:
Reboot the computer where Collaboration is installed if you have not done so since running the installer.
Start the Windows service named BEA ALI Collaboration.
Verify that Collaboration is functioning correctly by accessing and analyzing the Collaboration Diagnostics page:
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.2/settings/logs directory.
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.