Home
Administering
Learn how to administer the product.
Administering HCL Compass Web
This section discusses how to administer HCL Compass Web.
About HCL Compass Web server
HCL Compass Web server provides server-side support for WAN interfaces to HCL Compass.
Configuring HCL Compass Web server
Configure HCL Compass Web server by performing the tasks described in this section.
Backing up, modifying, and restoring the MBean configuration
Learn how to back up, customize, and restore the HCL Compass Web server MBean configuration.
Backing up and restoring the MBean configuration
Back up and restore the HCL Compass Web server MBean configuration by using the WebSphere® command-line interface, wsadmin, with the HCL Compass Web server export and import convenience commands.

Administering
Learn how to administer the product.
- Administering HCL Compass
  Learn how to administer the HCL Compass.
- Administering HCL Compass Web
  This section discusses how to administer HCL Compass Web.
  - About HCL Compass Web server
    HCL Compass Web server provides server-side support for WAN interfaces to HCL Compass.
    - HCL Compass Web server architecture
      HCL Compass Web server is implemented as a J2EE application hosted on WebSphere® Application Server.
    - Configuring HCL Compass Web server
      Configure HCL Compass Web server by performing the tasks described in this section.
      - Default profile names, locations, port numbers, server names, and URLs
        As you configure HCL Compass Web server, refer to the default values for IBM® WebSphere® Application Server, IBM HTTP Server, and HCL Compass Web server.
      - Configuring administrative security
        WebSphere® Application Server security settings that you configure for HCL Compass Web are disabled until you enable WebSphere administrative security.
      - Configuring secure connections
        You can configure secure connections between a HCL Compass Web server and a HCL Compass Web client by using Secure Socket Layer (SSL) in IBM® HTTP Server (IHS) for WebSphere® Application Server.
      - Configuring proxy servers
        Configure a reverse proxy server for HCL Compass Web server to improve performance and security.
      - Configuring port settings
        Use the WebSphere® Application Server updatePorts.ant script to configure port settings for HCL Compass Web server.
      - Configuring the HCL Compass Web server service account
        Modify the Log on as account for a WebSphere® Application Server profile where HCL Compass Web server is deployed.
      - Configuring the HCL Compass Web properties files
        Configure the HCL Compass Web properties file CqServerConn.properties and the HCL Compass OSLC API properties file cqrest.properties to customize various features.
      - Backing up, modifying, and restoring the MBean configuration
        Learn how to back up, customize, and restore the HCL Compass Web server MBean configuration.
        Backing up and restoring the MBean configuration
        Back up and restore the HCL Compass Web server MBean configuration by using the WebSphere® command-line interface, wsadmin, with the HCL Compass Web server export and import convenience commands.
        Exporting MBean configuration settings
        Export the HCL Compass Web MBean configuration before you modify the MBean attributes. This practice is important in case you make MBean configuration changes that produce undesirable results and you must roll back to a known working configuration.
        Importing MBean configuration settings
        You can restore previous MBean settings by using a saved configuration.
        Modifying MBean attributes with the wsadmin tool
        You can customize HCL Compass Web server by setting available MBean attributes with the WebSphere® Application Server command-line interface, wsadmin.
        Modifying MBean attributes in the Site Configuration window
        You can modify some MBean attributes for HCL Compass Web server by using the Web Server Options page of the Site Configuration window.
      - Configuring load balancing
        Use load balancing for distributing service requests from HCL Compass Web clients across multiple WebSphere® Application Server instances that are running HCL Compass Web server.
    - Monitoring HCL Compass Web server
      There are several ways to determine whether HCL Compass Web server is working correctly and troubleshoot issues.
  - Configuring HCL Compass Web with the Site Configuration window
    You customize many HCL Compass Web server and application settings by using the Site Configuration window.
  - Customizing security
    HCL Compass Web provides security that affects only the behavior of the HCL Compass Web application.
  - HCL Compass and single sign-on
    You can configure HCL Compass for single sign-on with Lightweight Third-Party Authentication (LTPA), OpenID Connect, and Security Assertion Markup Language 2.0 (SAML2).
  - Configuring strong authentication with smart cards
    Smart card authentication is appropriate for deployments where security requirements dictate stronger authentication than using a HCL Compass user name and password.
  - HCL Compass Search for administrators
    Administrators can use Compass Search feature to improve the existing full-text search capability.
  - Configuring and maintaining full-text search
    Some administrative tasks are required to configure and maintain the HCL Compass full-text search feature.
  - Configuring and customizing the type-ahead feature
    The type-ahead feature enables users to use a choice-list drop-down as a search field to find and select items in the choice-list. This feature must be configured before it can be used. It can also be customized.
  - Configuring e-mail transports
    You can configure HCL Compass Web to use either the SMTP (Simple Mail Transfer Protocol) or MAPI (Messaging Application Programming Interface) mail transport protocol.
  - Using HCL Compass to prefill OSLC 2.0-linked records
    You can configure HCL Compass to prefill field values when opening the creation dialogs for associated OSLC 2.0 projects. When a creation dialog displays, values for designated fields in the new record are initialized using content from configured fields of the initiating HCL Compass record.
- Administering HCL Compass Multisite
  Administering HCL Compass Multisite

Backing up and restoring the MBean configuration

Back up and restore the HCL Compass Web server MBean configuration by using the WebSphere® command-line interface, wsadmin, with the HCL Compass Web server export and import convenience commands.