# Installation and Upgrade Guide

# Installation

This chapter describes the steps you take to install Analytics Services and components:

1. Ensure you have completed pre-installation steps. For details, see Installation Prerequisites
2. Install Analytics Services on the remote server host computer. For details, see Installing Analytics Services.
3. Configure the Analytics database. For details, see Configuring the Analytics Database.
4. Configure Analytics. For details, see Configuring Analytics.
5. Install the Interaction component of the installation package on all portal servers. For details, see Installing the Interaction Component
6. Install the Image Service component of the installation package on your Image Service host. For details, see Installing the Image Service Component.
7. Install the Automation Service component of the installation package on your Automation Service host and complete the Analytics Configurator pages for the Automation Service component. For details, see Installing the Automation Service Component.
8. Start Analytics and portal services. For details, see Starting Analytics and Portal Services.
9. Register the Analytics application, remote server, web services, and portlets with the portal. For details, see Registering Analytics with the Portal.
10. Add Analytics jobs to the Automation Service. For details, see Adding Analytics Jobs to the Automation Service.

## Installing Analytics Services

This section describes how to install the core application, which includes the Analytics service and the Analytics Collector service. The instructions are the same for installing on a Windows, UNIX, or Linux host, with slight exceptions as noted. To install Analytics Services:

1. Log in to the remote server host computer as the local administrator (on Windows) or a user with directory write privileges (on UNIX or Linux).
2. Copy the installer to the disk location from which you plan to launch it. The installer file is one of the following:

- Windows: ptanalytics_G5.exe (Corporate Portal 5.0) or ptanalytics_G6.exe (Foundation 6.0)
- UNIX: ptanalytics_G5 (Corporate Portal 5.0) or ptanalytics_G6 (Foundation 6.0)

3. Close all unnecessary applications.
4. Execute the installer file.
5. Complete the installation wizard pages as described in the following table and according to the settings you planned when you completed the Analytics Services Installation Worksheet, which is included in the Analytics Installation and Configuration Worksheets document.

   Table 4-1 Installation Wizard Pages - Analytics Services
   Wizard Page | Description
   --- | ---
   License Agreement | Read and accept the license agreement.
   Choose Components | Choose Analytics Services.
   Installation Directory | The default is: C:\bea\alui (Windows) /opt/bea/alui (UNIX and Linux)
   Application Port | Select http or https protocol. The default port is 11944. This is the port that the portal uses to query Analytics for the portlet UI.

6. On the final Wizard page, click Install to begin the installation.

Note: | After the installer has copied all files to the installation directory, click Done. The Analytics Configurator will launch; however, do not complete the configuration at this time. First, configure the Analytics Database, described in Configuring the Analytics Database. Note that the Analytics Configurator does not launch on UNIX and Linux systems if a default browser is not specified.

Note: | The installer writes a log file to the directory where it is installed (for example: C:\bea\alui). If you encounter problems during installation, examine the error messages in the log file.

Caution: | We recommend that you sync the clocks on the servers that run Analytics and the portal before proceeding with configuration. If the clocks are not aligned, some events and sync jobs behave incorrectly.

## Configuring the Analytics Database

This section describes how to set up the Analytics database. It contains the following sections:

- Creating and Setting Up a Microsoft SQL Server Database
- Creating and Setting Up an Oracle Database

### Creating and Setting Up a Microsoft SQL Server Database

To set up the Analytics database on Microsoft SQL Server:

1. Copy the scripts from <PT_HOME>\ptanalytics\2.0\sql\mssql to the database host computer.
2. Create the Analytics database user:

1. To open the Enterprise Manager: click Start | Programs | Microsoft SQL Server | Enterprise Manager.
2. In the navigation pane, expand the objects to display subfolders of the Security folder.
3. Right-click the Logins icon; then click New Login.
4. In the SQL Server Login Properties dialog box, enter the user name you provisioned when you completed the Analytics Configurator Worksheet, which is included in the Analytics Installation and Configuration Worksheets document.
5. In the Authentication area, choose SQL Server Authentication and enter the corresponding password.
6. Confirm the password to complete the process.

3. Create the Analytics database with the following properties:

- Create a database with the name you provisioned when you completed the Analytics Configurator Worksheet, which is included in the Analytics Installation and Configuration Worksheets document.
- Configure the size of the database. The growth of the database is directly correlated to the number of events present in the system. Events include such things as page views, portlet views, user logins, and discussion posts. Estimate 100 MB of growth per 1 million events. For example, if your portal receives roughly 1 million events per day, you should anticipate growth of 36.5 GB per year.

4. Assign database rights for the Analytics database user:

1. To open the Enterprise Manager: click Start | Programs | Microsoft SQL Server | Enterprise Manager.
2. In the navigation pane, expand the objects to select the Security folder.
3. In the objects pane, right-click the Analytics user and select Properties.
4. On the General tab, in the Defaults section, select the Analytics database.
5. Click the Database Access tab.
6. In the Specify which databases can be accessed by this login box, check the Analytics database.
7. In the Database roles for database_name box, check public and db_owner
8. Click OK.
9. In the navigation pane, expand the objects to display the Analytics database; right-click the Analytics database and select Properties.
10. Click the Permissions tab and grant all permissions to the Analytics database user.
11. Click OK.

5. Start the SQL Server Query Analyzer and use SQL Server Authentication to connect to the Analytics database as the Analytics database user.
6. Run the setup scripts for the database, located in the <PT_HOME>\ptanalytics\2.0\sql\mssql\ folder, in the following order (make sure that you are running the scripts on the Analytics database):

1. db_creation.sql
2. install_seeddata.sql

To run a script, display the Open Query File dialog box, choose File | Open. Then browse and select the database script file. Then click Query | Execute.

7. In SQL Service Query Analyzer, connect to the portal database as the portal database user.
8. Run the portal_security_service_install.sql setup script on the portal database, located in <PT_HOME>\ptanalytics\2.0\sql\mssql\
9. Close SQL Server Query Analyzer.

Next, configure the Analytics application, as described in Configuring Analytics.

### Creating and Setting Up an Oracle Database

To create and set up the Analytics Oracle database:

1. Copy the oracle directory from <PT_HOME>\ptanalytics\2.0\sql to the Analytics database's host computer. This folder contains the scripts that you will use to set up and configure the Analytics Oracle Database.
2. Log on to the host computer for the Analytics database as owner of the Oracle system files.
3. Execute the following steps as the system user in your Oracle database.

1. Determine the name of the SID that you will be using for this installation. If you changed the SID from the default when you installed the portal, you need to update create_analytics_tablespaces.sql to reflect the SID that you used, substituting all occurrences of the default SID name with your SID name. For Plumtree Corporate Portal 5.x, the default SID name is PLUM. For Plumtree Foundation 6.x, the default SID name is PLUM10.

If you are creating a new SID, configure AL32UTF8 as the database character set and AL16UTF16 as the national character set.

2. Run the script create_analytics_tablespaces.sql for your platform. This file is located in a platform specific subdirectory within the oracle directory that you copied in Step 1.
3. Run the script create_analytics_user.sql.

Note: | If you do not want the script to use the defaults when creating the Oracle database user and password, edit the script. The default user is analyticsdbuser; the default password is plumtree. The create_analytics_user.sql script is located in the oracle directory that you copied in Step 1.

4. Add the Oracle database user and password values into the Analytics Configurator Worksheet, which is included in the Analytics Installation and Configuration Worksheets document (you will enter these values into the Analytics Configurator during the procedure described in "Configuring Analytics").
5. Run the script create_analytics_user.sql.

4. Execute the following steps as the analytics user that you just created.

1. Run the script create_analytics_schema.sql. This script creates all of the tables and indexes that are necessary to run Analytics. The create_analytics_schema.sql script is located in the oracle directory that you copied in Step 1.
2. Run the script install_analytics_seeddata.sql. This script adds all of the initial seed data that are necessary to run the Analytics product. The install_analytics_seeddata.sql script is located in the oracle directory that you copied in Step 1.

5. As the ALI user that you created when you installed AquaLogic Interaction, run the script portal_security_service_install.sql on the portal schema. This script creates the tables and seed data that are necessary for Analytics to use the security service. The install_analytics_seeddata.sql script is located in the oracle directory that you copied in Step 1.
6. Run your database's analysis tool on the portal database to the efficiency of the database.

## Configuring Analytics

This section describes how to configure Analytics.

Note: | Different sets of component-specific configuration pages appear, depending on the components that you just installed.

To configure Analytics:

1. Return to the browser window that launched when you completed the installer. If you have closed the browser window, you can launch the Analytics Configurator on Windows by choosing Start | Programs | BEA | Analytics Configurator. On UNIX or Linux, open the following location in a web browser: http://localhost:11944/configurator/ui/start.jsf.

Caution: | On Windows 2003, IE Security settings might prevent the configurator from completing. If this is the case, configure IE to completely trust the Analytics host computer.

2. Click Continue to begin the sequence of configuration pages. Complete the following configuration pages using the values you decided on when you completed the Analytics Configurator Worksheet, which is included in the Analytics Installation and Configuration Worksheets document.

   Table 4-2 Analytics Configurator Pages
   Configuration Page | Settings | Comments
   --- | --- | ---
   Configure Analytics Database Information | Analytics DB |
   Analytics DB Server Name | Does not appear if you select Use JDBC URL
   Analytics DB Port | Does not appear if you select Use JDBC URL
   Analytics DB Name | Does not appear if you select Use JDBC URL
   Analytics DB JDBC URL | Appears if you select Use JDBC URL
   Analytics DB Username |
   Analytics DB Password |
   Use JDBC URL | We recommend that you only use a JDBC URL if the standard method of configuration does not work for your environment, for example if you use Oracle RAC or a SQL Server cluster.
   API Service Information | API Service URL | You can find the API Service URL in your portal by performing one of the following: In Plumtree Corporate Portal 5.0, you can find the API Service URL in Portal Administration by selecting Portal Server Settings from the Select Utility drop-down list. Then click Portal URL Manager. The API Service URL is displayed in the SOAP Server URL field. In Plumtree Foundation 6.0, you can find the API Service URL in Portal Administration by selecting Portal Settings from the Select Utility drop-down list. Then click Portal URL Manager. The API Service URL is displayed in the SOAP Server URL field.
   Portal Username | This user must be for a portal account that has Select rights to all communities, portlets, users, documents, and Collaboration projects. It is recommended that you enter a user that belongs to the Administrators group.
   Portal Password |
   Configure Portal Database Information | Portal DB |
   Portal DB Server Name | Does not appear if you select Use JDBC URL
   Portal DB Port | Does not appear if you select Use JDBC URL
   Portal DB Name | Does not appear if you select Use JDBC URL
   Portal DB JDBC URL | Appears if you select Use JDBC URL
   Portal DB Username | The Portal DB Username must be the same as the one you used to create the portal database.
   Portal DB Password |
   Portal Version 5.0.4J |
   Use JDBC URL | We recommend that you only use a JDBC URL if the standard method of configuration does not work for your environment, for example if you use Oracle RAC or a SQL Server cluster.
   Configure Collaboration Database Information (OPTIONAL) | BEA AquaLogic Interaction Collaboration is installed in my portal environment. | Select this option if Collaboration is installed in your portal environment.
   Collab DB |
   Collab DB Server Name | Does not appear if you select Use JDBC URL
   Collab DB Port | Does not appear if you select Use JDBC URL
   Collab DB Name | Does not appear if you select Use JDBC URL
   Collab DB JDBC URL | Appears if you select Use JDBC URL
   Collab DB Username |
   Collab DB Password |
   Use JDBC URL | We recommend that you only use a JDBC URL if the standard method of configuration does not work for your environment, for example if you use Oracle RAC or a SQL Server cluster.
   Configure Publisher Database Information (OPTIONAL) | BEA AquaLogic Interaction Publisher is installed in my portal environment. | Select this option if Collaboration is installed in your portal environment.
   Publisher DB |
   Publisher DB Server Name | Does not appear if you select Use JDBC URL
   Publisher DB Port | Does not appear if you select Use JDBC URL
   Publisher DB Name | Does not appear if you select Use JDBC URL
   Publisher DB JDBC URL | Appears if you select Use JDBC URL
   Publisher DB Username |
   Publisher DB Password |
   Use JDBC URL | We recommend that you only use a JDBC URL if the standard method of configuration does not work for your environment, for example if you use Oracle RAC or a SQL Server cluster.

3. An installer screen appears that summarizes your configuration. Review this screen and make changes, if necessary.
4. On the final page, click Update.

Note: | The Analytics Configurator verifies connectivity according to the configuration information you have entered and logs success or errors to the browser window. If you encounter errors, follow the instructions in the error message or see Troubleshooting

## Installing the Interaction Component

This section describes how to install the Interaction and Automation Service components.

The installation instructions are the same for Windows, UNIX, and Linux hosts, with slight exceptions as noted.

Note: | The Interaction component is also known as the Plumtree Analytics Portal Component, or Analytics plug-in.

Note: | You must reinstall the Interaction component after each time you upgrade AquaLogic Interaction.

To install the Interaction component:

1. Log in to the portal host computer as the same user that installed AquaLogic Interaction.
2. If you are running on Java, shut down the application server.
3. Copy the installer to the disk location from which you plan to launch it. The installer file is one of the following:

- Windows: ptanalytics_G5.exe (Corporate Portal 5.0) or ptanalytics_G6.exe (Foundation 6.0)
- UNIX: ptanalytics_G5 (Corporate Portal 5.0) or ptanalytics_G6 (Foundation 6.0)

4. Close all unnecessary applications and windows.
5. Perform one of the following:

- If you are installing on Windows, double-click the installer file.
- If you are installing on UNIX, run the installer file.

6. Complete the installation wizard pages as described in the following table and according to the settings you planned when you completed the Interaction Component Installation Worksheet, which is included in the Analytics Installation and Configuration Worksheets document.

   Table 4-3 Installation Wizard Pages - Interaction Component
   Wizard Page | Description
   --- | ---
   License Agreement | Read and accept the license agreement.
   Choose Components | Choose Interaction component.
   Portal Installation Directory | Browse and select the location of the portal server installation, for example: C:\Program Files\Plumtree\ptportal\6.0.
   Note: | The Interaction and Automation Service components require installation into the same directory. For this reason, you use the same wizard page for both installations.
   Analytics Services - Fully Qualified Domain Name | Specify the fully qualified domain name for the machine hosting Analytics Services (not the host computer(s) on which you installed AquaLogic Interaction).

7. On the final Wizard page, click Install to begin the installation.
8. Perform one of the following:

- If you are running on Java, restart the application server. Then redeploy your portal.war or portal.ear file to your portal application server.
- If you are running on IIS, restart the application server. For instructions, see your application server's documentation.

Note: | The installer writes a log file in the directory where it is installed (for example: C:\bea\alui). If you encounter problems during installation, examine the error messages in the log file.

## Installing the Image Service Component

This section describes how to install the Image Service component. The instructions are the same for installing on a Windows, UNIX, or Linux host, with minor differences as noted. To install the Image Service component:

1. Log in to the Image Service host computer as the local administrator or the ALI user created during installation of AquaLogic Interaction.
2. Copy the installer to the disk location from which you plan to launch it. The installer file is one of the following:

- Windows: ptanalytics_G5.exe (Corporate Portal 5.0) or ptanalytics_G6.exe (Foundation 6.0)
- UNIX: ptanalytics_G5 (Corporate Portal 5.0) or ptanalytics_G6 (Foundation 6.0)

3. Close all unnecessary applications and windows.
4. Double-click the installer file.
5. Complete the installation wizard pages as described in the following table and according to the settings you planned when you completed the Image Service Component Installation Worksheet, which is included in the Analytics Installation and Configuration Worksheets document

   Table 4-4 Installation Wizard Pages - Image Service Component
   Wizard Page | Description
   --- | ---
   License Agreement | Read and accept the license agreement.
   Choose Components | Choose Image Service component.
   Installation Directory | Browse and select the location where the Image Service files are installed, for example: C:\Program Files\Plumtree\ptimages.

   .
6. On the final Wizard page, click Install to begin the installation.

Note: | The installer writes a log file in the directory where it is installed (for example: C:\Program Files\Plumtree). If you encounter problems during installation, examine the error messages in the log file.

## Installing the Automation Service Component

This section describes how to install the Automation Service component. The instructions are the same for installing on a Windows, UNIX, or Linux host, with minor differences as noted.

To install the Automation Service component:

1. Log in to the Automation Service host computer as the local administrator or the ALI user created during the installation of AquaLogic Interaction.
2. Copy the installer to the disk location from which you plan to launch it. The installer file is one of the following:

- Windows: ptanalytics_G5.exe (Corporate Portal 5.0) or ptanalytics_G6.exe (Foundation 6.0)
- UNIX: ptanalytics_G5 (Corporate Portal 5.0) or ptanalytics_G6 (Foundation 6.0)

3. Close all unnecessary applications and windows.
4. Double-click the installer file.
5. Complete the installation wizard pages as described in the following table and according to the settings you planned when you completed the Automation Service Component Installation Worksheet, which is included in the Analytics Installation and Configuration Worksheets document.

   Table 4-5 Installation Wizard Pages - Automation Service Component
   Wizard Page | Description
   --- | ---
   License Agreement | Read and accept the license agreement.
   Choose Components | Choose Automation Service component.
   Portal Installation Directory | Browse and select the location of the portal server installation, for example: C:\Program Files\Plumtree\ptportal\6.0.
   Note: | The Automation Service and Interaction components require installation into the same directory. For this reason, you use the same wizard page for both installations.

6. On the final Wizard page, click Install to begin the installation.

Note: | The installer writes a log file in the directory where it is installed (for example: C:\Program Files\Plumtree). If you encounter problems during installation, examine the error messages in the log file.

7. When installation is complete, the Analytics Configurator launches for the machine on which you installed the Automation Service. Complete the configuration page that appears, as described in Configuring Analytics.

## Starting Analytics and Portal Services

This section provides information on starting Analytics and portal services. Perform the procedure that is appropriate to your operating system.

### Starting Analytics and Portal Services on Windows

After you have installed Analytics services and all Analytics components:

- Ensure the BEA AquaLogic Interaction Analytics service has been started. From the Windows Control Panel, click Administrative Tools | Services; if the Analytics service has not started, right-click it and choose Start.
- Ensure the BEA AquaLogic Interaction Analytics Collector service has been started. From the Windows Control Panel, click Administrative Tools | Services; if the Analytics Collector service has not started, right-click it and choose Start.

### Starting Analytics and Portal Services on UNIX and Linux

After you have installed Analytics services and all Analytics components:

- Ensure the BEA AquaLogic Interaction Analytics service has been started: <PT_HOME>/ptanalytics/2.0/bin/analyticsd.sh start
- Ensure the BEA AquaLogic Interaction Analytics Collector service has been started:
  <PT_HOME>/ptanalytics/2.0/bin/collectord.sh start

## Registering Analytics with the Portal

This section describes how to register the Analytics Console, remote server, web service, and portlet objects with a 6.x portal.

For details on importing the migration package on a 5.x portal, see Administrator Guide for Plumtree Corporate Portal. The filename of the 5.x migration package is analytics5.pte.

To register the Analytics objects with the portal:

1. Log into the Administrator Portal.
2. Click Administration.
3. From the Select Utility drop-down choose Migration - Import.
4. Browse to select the location of the migration package. If you accepted installation defaults, the location on the Analytics host is: <PT_HOME>\ptanalytics\2.0\serverpackages\analytics6.pte
5. Click Load Package.
6. Perform one of the following:

- If you are importing the migration package for the first time, keep the default selections under Import Settings. The default selections are Import ACLs and Remember Dependency Settings.
- If you have previously imported the migration package and you are importing it again, keep the default selections and check the box next to Overwrite Remote Servers.

7. Click Portal Resources on the left hand side of the Migration editor.
8. Select the objects that you want to import.
9. Click Finish.

## Adding Analytics Jobs to the Automation Service

This section describes how to add all Analytics jobs to the Automation Service. Once these jobs are added, the Automation Service runs them automatically. To add Analytics jobs to the Automation Service:

1. Log into the Administrator Portal.
2. Click Administration.
3. From the Select Utility drop-down, choose Automation Service.

The Automation Service Manager appears.

4. Ensure that the Automation Service is online.
5. Under Edit Automation Services, click the name of the computer on which Analytics Jobs are installed.

The Register Folders window appears.

6. Click Add Folder.

The Add Job Folder window appears.

7. Expand the Analytics folder.
8. Select the Analytics Jobs folder.
9. Click OK to close the Register Folders window.
10. Click Finish.

The Automation Service runs the Analytics jobs. If other Automation Service jobs were in queue or running when you added the Analytics jobs to the Automation Service, the Automation Service runs the Analytics jobs after these other jobs have completed.

11. At an appropriate time, ensure that the Analytics jobs have completed successfully. If any Analytics jobs failed, schedule these jobs to run again.