Home
Administering
Learn how to administer the product.
Administering HCL Compass
Learn how to administer the HCL Compass.
Managing user accounts
Use the User Administration tool to set up and administer users and user groups. HCL Compass stores information about users and user groups in the user database and schema repository.
Working with users
Upgrading user databases
After you check in a schema, you can upgrade the user databases to use the newer schema version. The changes to the schema are available only after you upgrade the user databases.

Administering
Learn how to administer the product.
- Administering HCL Compass
  Learn how to administer the HCL Compass.
  - Reconfiguring Compass to use a different JRE
    When you change the Java Runtime Environment (JRE) for HCL Compass, you must reconfigure the product to make it work with the new JRE.
  - Managing databases
    Describes the different types of databases that the administrator can create and manage
  - Managing user accounts
    Use the User Administration tool to set up and administer users and user groups. HCL Compass stores information about users and user groups in the user database and schema repository.
    - Viewing database subscriptions
      You can determine which users and user groups have been granted access to a specific database.
    - User privileges
    - Working with users
      - Adding a user
        You can add users to the HCL Compass environment.
      - Assigning user access privileges
        Assign access privileges when you create user accounts.
      - Adding or modifying user access privileges
        You can add or modify user privileges.
      - Specifying user authentication
      - Subscribing users and groups to databases
        This topic describes how to subscribe users and user groups to a database.
      - Unsubscribing users and groups from databases
        You can deny a user or user group access to a database by removing their subscription to that database. This involves both removing their individual user subscription and removing the user from all groups that are subscribed to the database.
      - Upgrading user databases
        After you check in a schema, you can upgrade the user databases to use the newer schema version. The changes to the schema are available only after you upgrade the user databases.
      - Editing user profiles
        Edit the user profile to change information about a HCL Compass user.
      - Editing a user profile from the HCL Compass client
        Active users can change their names, email addresses, passwords, and telephone numbers. They cannot change their user login or privileges.
      - Disabling and re-enabling the remember-password feature for a database set
        Use the installutil setmasterproperty subcommand to disable and re-enable the remember-password feature for a database set.
      - Protecting deployments from brute-force password attacks
        You can protect deployments from brute-force password attacks by locking out users after a specified number of failed log-in attempts.
      - Making users and groups inactive
        You can make users and user groups inactive.
      - Making users and groups active
        You can make users and user groups active.
    - Working with user groups
    - User access to actions
    - Exporting and importing users and user groups
    - Administering users in a MultiSite environment
  - Configuring query limits on result sets
    You can configure query limits on the size of result sets to improve system performance, availability, and scalability.
  - Using LDAP with HCL Compass
    Overview of user authentication methods available with HCL Compass.
  - Workspace folder permissions overview
    HCL Compass uses a role-based access control (RBAC) model for enforcing workspace folder permissions. The workspace folder permissions feature requires that your schema repository and user databases are at feature level 6 or later.
  - Optimistic and pessimistic record locking
    Overview of optimistic and pessimistic locking implementations in HCL Compass.
  - Configuring Compass core logging and tracing
    This section describes how to configure logging and tracing for Compass core.
- Administering HCL Compass Web
  This section discusses how to administer HCL Compass Web.
- Administering HCL Compass Multisite
  Administering HCL Compass Multisite

Upgrading user databases

After you check in a schema, you can upgrade the user databases to use the newer schema version. The changes to the schema are available only after you upgrade the user databases.

Before you begin

Upgrading a user database is an irreversible process, so it is wise to back up the user database before applying schema changes. While it is not a requirement that users be logged off before you perform a schema upgrade, it is a best practice for the following reasons:

When you perform a database backup, it is best to back up a stable version of the database, meaning that the database has no activity in progress.
Failure of a schema upgrade while users are logged on can be more disruptive than a planned outage.

About this task

When a user database is associated with a specific schema version, you can apply only newer versions of the same schema to the database. You cannot apply earlier versions or a different schema.

Procedure

To apply schema changes to a user database:

Start the Designer.
In the HCL Compass Schema Repository Explorer view, select the schema repository that contains the updated schema.
Click View > HCL Compass Database Admin.
The HCL Compass Database Admin view opens and a list of all the user databases appears.
Right-click the user database that you want to upgrade and click Upgrade Database.
The Upgrade User Database window opens.
Select a schema version from the Versions list and click OK.