Home
Administering
Learn how to administer the product.
Administering HCL Compass Multisite
Administering HCL Compass Multisite
Introduction
HCL VersionVault MultiSiteHCL Compass MultiSite adds a powerful capability to HCL VersionVaultHCL Compass. With MultiSite, developers at different locations can use the same HCL VersionVault versioned object base (VOB) HCL Compass database set (a schema repository and its associated user databases). For HCL VersionVault, each location (site) has its own copy (replica) of the VOB. For HCL Compass, each location has its own copies, or replicas, of the schema repository and user databases. At any time, changes made in one replica can be sent in update packets to other replicas. You can manage replicas by using the command-line tools.
Replicated database sets
A database set consists of a schema repository and its associated user databases. A user database cannot exist without its corresponding schema repository, so when you replicate a database set, both the schema repository and the user database are replicated. When you work with a database replica, you are working with two physical databases: a schema repository replica and a user database replica.
MultiSite terminology
MultiSite documentation uses the terms defined in this topic.

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.
- Administering HCL Compass Multisite
  Administering HCL Compass Multisite
  - Introduction
    HCL VersionVault MultiSiteHCL Compass MultiSite adds a powerful capability to HCL VersionVaultHCL Compass. With MultiSite, developers at different locations can use the same HCL VersionVault versioned object base (VOB) HCL Compass database set (a schema repository and its associated user databases). For HCL VersionVault, each location (site) has its own copy (replica) of the VOB. For HCL Compass, each location has its own copies, or replicas, of the schema repository and user databases. At any time, changes made in one replica can be sent in update packets to other replicas. You can manage replicas by using the command-line tools.
    - Replicated database sets
      A database set consists of a schema repository and its associated user databases. A user database cannot exist without its corresponding schema repository, so when you replicate a database set, both the schema repository and the user database are replicated. When you work with a database replica, you are working with two physical databases: a schema repository replica and a user database replica.
      - Clans, families, and sites
        The MultiSite environment consists of clans, families and sites, which are all distinct groupings of replicated databases.
      - Types of schema repositories
        Within a clan, one of the schema repository replicas is the working schema repository. At the working schema repository, you can change schemas and create additional user databases which can then be replicated.
      - MultiSite terminology
        MultiSite documentation uses the terms defined in this topic.
    - Replica synchronization in a family
      Because information in a replicated VOBHCL Compass database is modified concurrently at different replicas, the contents of each replica in a family tend to differ. The contents of a particular replica may never be identical to the contents of any other replica. To keep the replicas from differing too much, each replica sends updates to one or more other replicas. Updating a VOB replica changes both its database and its storage pools to reflect the development activity that has taken place in one or more other replicas.
    - Independent development: Mastership Modification management in multiple replicas: Mastership
      Because changes are made independently at multiple replicas, these changes may conflict. In a MultiSite environment, tracking changes and preventing data corruption are accomplished with an exclusive-right-to-modify scheme called Mastership. Mastership determines when a user of a replica is allowed to modify data.
    - Database object conflict resolution
      Mastership restrictions prevent most inconsistent changes in different replicas, but some are unavoidable. To avoid many naming conflicts, the administrators for a family must create and enforce naming rules for objects. A use model that is enforced consistently across sites reduces the potential for conflicts.
  - Implementation planning
    Before you install and use HCL VersionVaultHCL Compass MultiSite, you need to plan your implementation.
  - Packet transportation methods and configuration
    The method you choose for transporting packets between replicas depends on connectivity. If your replicas do not have IP connectivity, you must use a file-based transport method. If your replicas have connectivity, you can use the store-and-forward facility.
  - Database replica creation
    Creating your database replicas requires careful planning and consideration part of which involves making decisions about mastership and methods of packet delivery.
  - Replica synchronization
    Replica synchronization uses the same export-transport-import procedure that is used during replica creation.
  - Database replicas administration
    Sustaining a smoothly functioning MultiSite environment requires dedicated administration. Many administrative processes can drastically change your environment and require careful consideration and planning.
  - Mastership management
    The management of mastership affects how database objects are accessed and manipulated by users in your MultiSite environment. Mastership management is an ongoing process as new objects are entered into the database and users' requirements change.
  - Troubleshoot MultiSite operations
    There are common situations in which running a HCL Compass MultiSite command produces an unexpected result, sometimes accompanied by a warning or error message.
  - MultiSite command set
    This section summarizes the commands for HCL VersionVault MultiSite and HCL VersionVault that display HCL VersionVault MultiSite information. There are a series of MultiSite commands and API functions that display or modify MultiSite information.

MultiSite terminology

MultiSite documentation uses the terms defined in this topic.

Term: Definition
Replica: A copy of a user database or a schema repository. To refer to a replica, use the site name and family name.
Family: All the replicas of a specific user database or all the replicas of a specific schema repository. The family name of a user database replica is the database name of the originating database. The family name of a schema repository is always MASTR.
Site: A schema repository replica and its user database replicas.
Clan: All the replicas of a schema repository and all the replicas of the associated user databases.
Replicas originating from the same database set use the same clan name, which is specified when the database set is activated.
Host, or synchronization server: The LAN name or IP address of the network node that handles packets for a site. This host may have the HCL Shipping Server installed on it.