# Installation and Upgrade Guide

# Installation

This chapter describes how to install the components necessary for your HiPer for Retail deployment. If you are upgrading from a previous version, refer to Upgrade.

To install AquaLogic HiPer Workspace for Retail:

1. Ensure that you have met the prerequisites for installation. For details, see Installation Prerequisites.
2. Install the HiPer for Retail components. For details, see Installing the HiPer for Retail Components.
3. Install the HiPer BAM (Business Activity Manager) System. For details, see Installing the ALI HiPer BAM System.

## Installing the HiPer for Retail Components

This section describes how to install the following HiPer for Retail components:

- HiPer for Retail files - includes the HiPer for Retail application.
- Portal files - includes custom navigation files and files that create the portal objects needed for HiPer for Retail as well as data for Publisher.
- Image Service files - includes static files (such as images and help files).
- Automation Service files - includes automated tasks.

The HiPer for Retail components can be installed on different hosts. For details on provisioning hosts for the various components, see the Deployment Guide for BEA AquaLogic User Interaction.

### Launching the HiPer for Retail Installer

#### Launching the HiPer for Retail Installer on Windows

To launch the HiPer for Retail installer on a Windows host:

1. Log into the Windows host as the local Administrator.
2. Copy the installer to a temporary location:

- If you are running Plumtree Corporate Portal 5.0.5, use AquaLogicInteractionHiPer.exe.
- If you are running Plumtree Foundation 6.0 SP1, use AquaLogicInteractionHiPer_G6.exe.

3. Close all unnecessary windows and applications.
4. Double-click the installer.

Complete the installation wizard panels as described in Completing the Installer Wizard Pages, and according to the settings you planned when you completed the configuration worksheets provided in the Installation and Planning Worksheets for HiPer for Retail.

#### Launching the HiPer for Retail Installer on Linux

The HiPer for Retail installer is a graphical, X-Windows client when run in interactive mode. If you are running the installer on a remote terminal, make sure your DISPLAY is set appropriately.

To launch the HiPer for Retail installer on a Linux host:

1. Log into the Linux host as the local user you created, as described in Installation Prerequisites..
2. Copy the installer to a temporary location and run it as follows:

    $ ./AquaLogicInteractionHiPer_G6

Complete the installation wizard panels as described in Completing the Installer Wizard Pages, according to the settings you planned when you completed the configuration worksheets provided in the Installation and Planning Worksheets for HiPer for Retail.

### Completing the Installer Wizard Pages

The following table describes the HiPer for Retail installer wizard pages for Linux and Windows platforms.

Note: | If the installer setting does not apply to the components you are installing, the installer does not display the wizard page.
Table 3-1 HiPer for Retail Installer Wizard Pages for Linux and Windows
Wizard Page | Description
--- | ---
Introduction | Click Next.
License Agreement | Read and accept the agreement.
Choose Components | In the Install Set drop-down list, select either Complete or Custom. If you select Complete, a full set of HiPer for Retail components is installed. If you select Custom, you can choose individual components to install according to your deployment plan.
Installation Folder | Specify where you want HiPer for Retail installed. The default is C:\Program Files\plumtree. If you want to install in another folder, type the path in the box, or click Choose. If you change your mind and want to install in the default folder, click Restore Default Folder.
Choose Portal Server Folder | Specify where the portal is installed. The default installation folder for Plumtree Corporate Portal 5.0.5 is C:\Program Files\plumtree\ptportal\5.0; the default installation folder for Plumtree Foundation 6.0 SP1 is C:\Program Files\plumtree\ptportal\6.0. If the portal is installed in another location, type the path in the box, or click Choose. To restore the default folder path, click Restore Default Folder.
Choose Automation Server Folder | Specify where the Automation Service is installed. The default installation folder for Plumtree Corporate Portal 5.0.5 is C:\Program Files\plumtree\ptportal\5.0; the default installation folder for Plumtree Foundation 6.0 SP1 is C:\Program Files\plumtree\ptportal\6.0. If the Automation Service is installed in another location, type the path in the box, or click Choose. To restore the default folder path, click Restore Default Folder.
AquaLogic HiPer Workspace for Retail - Application Port | Specify the port through which HiPer for Retail should handle requests (for example, http://<hiperportal>:<port>). The default port is 11970.
Document Repository Service | Specify the following connection information for your Document Repository Service: Document Repository Service Host - enter the fully qualified domain name Document Repository Service Port - enter the port through which the Document Repository Service handles requests This page only displays if you are running Plumtree Foundation 6.0 SP1.
HiPer Database | Choose your database server—SQL Server or Oracle.
HiPer Database Connection Information | Enter the following values: HiPer Database Host Computer HiPer Database Port HiPer Database Name (for Oracle, this is the database SID) HiPer Database Login (for Oracle, this is the database schema user) HiPer Database Password (for Oracle, this is the database schema password) HiPer Database Password Confirmation
Portal Database Connection Information | Enter the following values: Portal Database Host Computer Portal Database Port Portal Database Name (for Oracle, this is the database SID) Portal Database Login (for Oracle, this is the database schema user) Portal Database Password (for Oracle, this is the database schema password) Portal Database Password Confirmation
Choose Image Server Folder | Specify where you the Image Service files are installed. The default is C:\Program Files\plumtree\ptimages. If the Image Service files are installed in another location, type the path in the box, or click Choose. To restore the default folder path, click Restore Default Folder.
Pre-Installation Summary | Confirm the installer settings (install folder, components to install, and space needed for install), and click Install.

## Installing the ALI HiPer BAM System

The ALI HiPer BAM System (also referred to as Celequest) connects to your back-end systems and triggers alerts by monitoring rule templates. The rule templates are created within Celequest and connected to HiPer for Retail via rules that are defined in HiPer for Retail.

Caution: | The machine that hosts Celequest must include Java JDK 1.4.x to run JBoss. The Java JDK is available from http://java.sun.com. Once installed, set the JAVA_HOME environment variable to point to the installed location of the JDK.

If you have not already installed Celequest, perform the appropriate steps on the machine that you want to host the ALI HiPer BAM System (Celequest):

- For Windows, refer to Installing the ALI HiPer BAM System on Windows.
- For Linux, refer to Installing the ALI HiPer BAM System on Linux.

If you have already installed Celequest, refer to Upgrading Celequest to Version 3.7.2.0.326.

### Installing the ALI HiPer BAM System on Windows

1. Copy the HiPer_1.1_BAM_Service.zip file (available in the AquaLogic User Interaction Product Center) to the host computer and unzip the files.
2. Create a new database. If you are running SQL Server, name the database cq3_7_metadata.
3. In cqinitmetadata_cmd.bat (located in <BAM_Install_Folder>\CQInitMetadata\), replace the database machine name, user name, and password; and comment out/uncomment lines based on your database type:

- For SQL Server, change the following lines:

    java -cp cqinitmetadata.jar;msutil.jar;msbase.jar;mssqlserver.jar
    com.celequest.metadata.upgrade.Upgrade SQLSERVER
    "jdbc:microsoft:sqlserver://[INSERT SERVER NAME
    HERE]:1433;SelectMethod=cursor;databaseName=cq3_7_metadata;user=[INS
    ERT USER NAME HERE];password=[INSERT PASSWORD HERE]

- For Oracle, change the following lines:

    java -cp cqinitmetadata.jar;ojdbc14.jar
    com.celequest.metadata.upgrade.Upgrade ORACLE
    jdbc:oracle:thin:<user>/<password>@<server>:<port...usually
    1521>:<SID...e.g. PLUM10>

4. In celequest_metadata-ds.xml (located in <BAM_Install_Folder>\jboss-3.2.6\server\default\deploy\), replace the database machine name, user name, and password; and comment out/uncomment lines based on your database type:

- For SQL Server, change the following lines:

    <connection-url>jdbc:microsoft:sqlserver://[INSERT SERVER NAME
    HERE]:1433;SelectMethod=cursor;databaseName=cq3_7_metadata;user=[INS
    ERT USER NAME HERE];password=[INSERT PASSWORD HERE]</connection-url>

and

    <!-- The login and password -->
         <user-name>[INSERT USER NAME HERE]</user-name>
         <password>[INSERT PASSWORD HERE]</password>

- For Oracle, change the following lines:

    <connection-url>jdbc:oracle:thin:celequest372/welcome@localhost:1521
    :PLUM10</connection-url>

and

    <!-- The login and password -->
         <user-name>[INSERT USER NAME HERE]</user-name>
         <password>[INSERT PASSWORD HERE]</password>

5. In wrapper.conf (located in <BAM_Install_Folder>\jboss-3.2.6\conf\), replace the class path token for <BAM_system home> with the path to the BAM install folder.
6. Run cqinitmetadata_cmd.bat (located in <BAM_Install_Folder>\jboss-3.2.6\CQInitMetadata\) from the command line to create the metadata for the database:
7. Run InstallApp-NT.bat (located in <BAM_Install_Folder>\jboss-3.2.6\bin\)to install it as a Windows service.
8. Start the Windows service named BEA ALI HiPer BAM System 3.7.2.
9. Check the following logs:

- server.log (located in <BAM_Install_Folder>\jboss-3.2.6\server\default\log\)
- wrapper.log (located in <BAM_Install_Folder>\jboss-3.2.6\logs\)

If wrapper.log shows a port conflict exception, you must change the ports in jboss-service.xml (located in <BAM_Install_Folder>\jboss-3.2.6\server\default\conf\).

10. Check to make sure the application can start by browsing to the following URL:
    http://localhost:8049/celequest/login/workbench.htm. You will be asked to enter two paths for logging, as well as information for an SMTP server. Because you will later delete the E-mail delivery profile, you can enter inaccurate information for the SMTP server.

### Installing the ALI HiPer BAM System on Linux

1. Copy the HiPer_1.1_BAM_Service.zip file (available in the AquaLogic User Interaction Product Center) to the host computer and unzip the files.
2. Create a new database. If you are running SQL Server, name the database cq3_7_metadata.
3. In cqinitmetadata_cmd.sh (located in <BAM_Install_Folder>/CQInitMetadata/), supply the appropriate variables and comment out/uncomment lines based on your database type. Here are the contents of the file:

    #!/bin/sh
    ### =============================================================== ###
    ##                                                                          ##
    ##  Celequest initialization script
    ##                                                                          ##
    ### =============================================================== ###

    # Setup the JVM - make sure JAVA_HOME is properly set
    if [ "x$JAVA_HOME" != "x" ]; then
         JAVA="$JAVA_HOME/bin/java"
    else
         JAVA="java"
    fi

    # Setup the classpath
    CQINIT_CLASSPATH="cqinitmetadata.jar"
    SQLSERVER_CLASSPATH="$CQINIT_CLASSPATH:msutil.jar:msbase.jar:mssqlserve
    r.jar"
    ORACLE_CLASSPATH="$CQINIT_CLASSPATH:ojdbc14.jar"

    # Connection string
    SQLSERVER_CONNECTION_STRING="jdbc:microsoft:sqlserver://<server>:1433;S
    electMethod=cursor;databaseName=cq3_7_metadata;user=<user>;password=<pa
    ssword>"
    ORACLE_CONNECTION_STRING="jdbc:oracle:thin:<user>/<password>@<server>:<
    port...usually 1521>:<SID...e.g. PLUM10>"

    # Execute the JVM
    # Uncomment the exec statement depending on which database type you are
    updating
    # SQL Server
    exec $JAVA -classpath "$SQLSERVER_CLASSPATH"
    com.celequest.metadata.upgrade.Upgrade SQLSERVER
    "$SQLSERVER_CONNECTION_STRING"
    # Oracle
    #exec $JAVA -classpath "$ORACLE_CLASSPATH"
    com.celequest.metadata.upgrade.Upgrade ORACLE
    "$ORACLE_CONNECTION_STRING"

4. In celequest_metadata-ds.xml (located in <BAM_Install_Folder>/jboss-3.2.6/server/default/deploy\), replace the database machine name, user name, and password; and comment out/uncomment lines based on your database type:

- For SQL Server, change the following lines:

    <connection-url>jdbc:microsoft:sqlserver://[INSERT SERVER NAME
    HERE]:1433;SelectMethod=cursor;databaseName=cq3_7_metadata;user=[INS
    ERT USER NAME HERE];password=[INSERT PASSWORD HERE]</connection-url>

and

    <!-- The login and password -->
         <user-name>[INSERT USER NAME HERE]</user-name>
         <password>[INSERT PASSWORD HERE]</password>

- For Oracle, change the following lines:

    <connection-url>jdbc:oracle:thin:celequest372/welcome@localhost:1521
    :PLUM10</connection-url>

and

    <!-- The login and password -->
         <user-name>[INSERT USER NAME HERE]</user-name>
         <password>[INSERT PASSWORD HERE]</password>

5. In wrapper.conf (located in <BAM_Install_Folder>/jboss-3.2.6/conf/), replace the class path token for <BAM_system home> with the path to the BAM install folder.
6. Run cqinitmetada_cmd.bat (located in <BAM_Install_Folder>/jboss-3.2.6/CQInitMetadata/) from the command line to create the metadata for the database:
7. Check the following logs:

- server.log (located in <BAM_Install_Folder>/jboss-3.2.6/server/default/log/)
- wrapper.log (located in <BAM_Install_Folder>/jboss-3.2.6/logs/)

If wrapper.log shows a port conflict exception, you must change the ports in jboss-service.xml (located in <BAM_Install_Folder>/jboss-3.2.6/server/default/conf/).

8. Check to make sure the application can start by browsing to the following URL:
   http://localhost:8049/celequest/login/workbench.htm. You will be asked to enter two paths for logging, as well as information for an SMTP server. Because you will later delete the E-mail delivery profile, you can enter inaccurate information for the SMTP server.

### Upgrading Celequest to Version 3.7.2.0.326

You must use Celequest 3.7.2.0.326 with HiPer for Retail 1.1. If you already have an earlier version of Celequest installed, you must upgrade. You cannot upgrade a Celequest instance in-place. Instead, you must export from the existing Celequest environment and import into the 3.7.2.0.326 environment by performing the following steps in Celequest:

1. Export the existing Celequest database, without exporting data.
2. Uninstall the existing Celequest EAR file from the application server.
3. Drop the metadata database schema from the metadata database.
4. Create a new metadata database schema.
5. Run cqinitmetadata.jar to initialize the new metadata database.
6. Install the CAS_jboss3.2.x.ear file (located in <BAM_system_home>\jboss-3.2.6\server\default\deploy), and bring up the 3.7.2.0.326 version of Celequest.
7. Import into the Celequest 3.7.2.0.326 instance the export file from the previous Celequest instance.