Installing HCL Compass Web server

Use IBM Rational® Installation Manager to install the HCL Compass Web server.

Before you begin

  • HCL Compass Web server must be installed and deployed on a server that has a stand-alone implementation of WebSphere® Application Server and IBM® HTTP Server installed and configured. You cannot install HCL Compass Web server without these components. For more information, see Preparing the WebSphere Application Server environment.
  • When you prepare the WebSphere Application Server environment, configure the IBM WebSphere Application Server web server plug-in to enable automatic configuration of the IBM HTTP Server during the HCL Compass Web server installation process.
  • During the HCL Compass Web Server installation, you can install the HCL Compass server in a new WebSphere Application Server profile or in an existing profile. For information about selecting the profile during installation, see WebSphere Application Server profiles for web feature deployment.
  • You must have installed the AdoptOpenJDK\jre- for the packages configuration.

About this task

HCL Compass Web Server provides server-side support for WAN interfaces to HCL Compass. These instructions are for installing the server by using the IBM Installation Manager wizard. For information, see Prerequisite planning for installing HCL Compass.
During the installation process, you can install the following optional HCL Compass Web Server packages that provide more functionality to HCL Compass users.
  • Full-Text Search Server
  • Report Launcher for HCL Compass
Although you can install all features at the same time, it might be easier to install, verify, and configure the main HCL Compass Web Server before you add more packages. You can add additional packages to the HCL Compass Web Server environment later by using the IBM Installation Manager Modify operation. Before you install, review the Administration and Reporting documentation to learn more about these features.
Installation repositories


  1. Disable Anti-virus software and stop any of the following services that are running: WebSphere Application Server, IBM HTTP Server, Atria Location Broker, IBM WebSphere Application Server vx.x – cqwebprofile, HCL Compass Mail Service.
  2. Start IBM Installation Manager.
  3. Click Install to start the installation process.
  4. If the repository location for HCL Compass product installation files is not configured, update the IBM Installation Manager file preferences:
    1. Select File > Preferences and add the installation repository for HCL Compass in the Repositories panel.
    2. If it is not selected, select Search service repositories during installation and updates so that any package updates in the product service repositories are available for selection during the installation process.
  5. Select the packages and versions to install.
    1. Select HCL Compass.
    2. If you want to install fix packs, select Show all versions. Then, click Check for Other Versions and Extensions.
      The fix pack versions are displayed in the list of packages. If the fix pack versions are not listed, check whether the IBM Installation Manager Preferences are configured to search service repositories during install and update operations. You can also add the repository location for the fix pack installation files to the Installation Manager repositories list.
    3. Select the versions to install. Click Next.
  6. Review the validation results to determine whether your installation environment meets the prerequisites for installing the package.
    Correct any problems before you continue.
  7. On the Licenses page, review the license terms. If they are acceptable, click I accept the terms in the license agreement.
  8. Create a package group or use an existing package group for the product package.
    A package group represents a directory in which packages share resources with other packages in the same group. You can specify only the package group during the first installation. To change the package group, you must remove the product and install it again. For more information about package groups, see the Installation Manager Information Center for about package groups.
    • Create a package group:
      1. Click Create a new package group.
      2. Type the path for the Installation directory for the package group or use the default path. The name for the package group is created automatically.
        Note: For Linux® and UNIX® systems, the directory path cannot include spaces.
    • Click Use the existing package group to install into an existing package group. Then, select a package from the list of existing groups.

      Only groups that include compatible packages are available for selection.

  9. Select the translations to install. Click Next.
    English is always selected.
  10. On the Features page, select the features to install.
    To display a description of a feature in the Details section, click the feature name.
    1. Click HCL Compass Web Server .
    2. Click Next to configure the HCL CompassWeb Server installation settings.
  11. For the Help System, accept the default Access help from the web.
    This option provides remote help that enables HCL Compass to dynamically retrieve the latest product documentation from the web. After installation, follow the instructions in the HCL Compass Web administration guide to change the configuration to download and access help from your local system, if required.
  12. Specify licensing information for the product by providing the host name and TCP/IP port of the HCL Compass license server. Click Next.
    Obtain this information from your license administrator.
  13. Specify the installation settings for the IBM HTTP Server.
    1. In the IBM HTTP Server page, make sure Automatically configure IBM HTTP Server is selected.
    2. Specify path to the IBM HTTP Server configuration file, httpd.conf.
      If the default path is not correct or if it is blank, an error message is displayed. Click Browse to select the correct path. Click Next.
  14. Click Next to skip E-mail Notification configuration.
    You can configure email notifications after you install the HCL Compass Web server. See HCL Compass email
  15. Specify the installation settings for the WebSphere Application Server.
    The installation settings determine whether to deploy HCL Compass Web in a new or existing WebSphere Application Server profile. The default is to deploy the server to a new profile created during the HCL Compass Web server installation process.
    1. Select the Profile Deployment Type option from the drop-down list, or accept the default selection.
      • Create a new Web Application Server profile
        1. Type or select the location of the WebSphere Application Server home directory. The default path is C:\Program Files\IBM\WebSphere\AppServer.
        2. Accept the default path for New application server profile location or type or browse to a different location.
        3. The value of WebSphere Application Server version is set automatically.
      • Use an existing Web Application Server profile
        1. Type or select the path for the Application server profile location.
        2. The value of the WebSphere Application Server version is set automatically based on the WebSphere Application Server version when the profile was created.
        3. Start the WebSphere Application Server for the profile:
          Go to Start > Programs > IBM WebSphere > Application Server V8.x > Profiles > Start the server or run this command:was_profile/profile_name/bin/startServer.bat server1
          Run this command: was_profile\profile_name\bin\ server1
        4. Click Get List From Server.

          Wait for the installer to finish fetching the list of servers and clusters.

        5. Select a server from the list of available servers.
        6. After the installation is complete, restart your computer when prompted by Installation Manager.
    2. Click Next.
  16. Review the summary information to verify the packages you are installing. Click Install.


After the installation completes, verify that the HCL Compass Web application is installed and that the IBM HTTP Server routing is configured correctly:
  1. To verify the WebSphere Application Server installation, open a browser and go to http://server_name:profile_http_transport_port/cqweb.
    Where profile_http_transport_port is the port where the HCL Compass Web Server was deployed. If you deployed to a new profile, the port number is 12080. You can find the port value in the profile information file HTTP Transport port property that is located in one of the following locations:
    • For new profile deployments, go to cq_profile_dir/logs/AboutThisProfile.txt
    • For existing profile deployments, go to was_profiles_dir/profile_name/logs/AboutThisProfile.txt
  2. To verify that automatic configuration of the IBM HTTP Server succeeded, open a browser and go to http://server_name/cqweb.

    The automatic configuration enables HCL Compass client requests to be routed through the IBM HTTP Server to the WebSphere Application Server. If you cannot access the HCL Compass Web Server, you must manually configure the routing in the IBM HTTP Server configuration file http.conf.

What to do next

After you install HCL Compass Web Server and any optional components, complete any post-installation configuration tasks for the HCL Compass Web Server, and test the environment.

See Configuring HCL Compass Web server.

See these links for information about the other HCL Compass Web server packages that can be added to your HCL Compass Web environment: