Home
Administering
Learn how to administer the product.
Administering HCL VersionVault
Learn about performing administrative tasks for an HCL VersionVault community including managing software licenses, user and group accounts, VersionVault server and client hosts, shared data, and the network that connects them.
VOB datatypes and administrative VOB hierarchies
There are many types of VOB metadata. Some are unique to a particular VOB, but many must be managed consistently across a group of VOBs that store related artifacts (components of a UCM project, for example). These topics introduce VOB metadata and describe how to use administrative VOB hierarchies to simplify sharing of type objects among related VOBs.
Working with global types
In general, all operations on a global type or a local copy of a global type apply to the global type and all its local copies.
Describing global types
The cleartool describe command can show properties of global types or their local copies.

Administering
Learn how to administer the product.
- Administering HCL VersionVault
  Learn about performing administrative tasks for an HCL VersionVault community including managing software licenses, user and group accounts, VersionVault server and client hosts, shared data, and the network that connects them.
  - HCL VersionVault network planning and administration
  - License servers and license administration
    Most HCL VersionVault applications and commands (cleartool commands, for example, or GUIs such as the VersionVault Explorer) require a license to run.
  - Reconfiguring VersionVault to use a different JRE
    When you change the Java Runtime Environment (JRE) for HCL VersionVault, you must reconfigure the product to make it work with the new JRE.
  - Administering the HCL VersionVault registry
    The HCL VersionVault registry is a central repository of information about shared resources such as VOBs and views.
  - HCL VersionVault network administration in mixed environments
    An HCL VersionVault environment that includes hosts that run Windows and hosts that run the UNIX system or Linux is said to be a mixed environment.
  - Overview of security considerations
    As an administrator, you are responsible for the security of your HCL VersionVault deployment.
  - VOB and view access control
    HCL VersionVault supports a rich set of access controls on versioned objects.
  - VOB administration
    Because VOBs are the principal repository for artifacts under HCL VersionVault control, VOB administration is one of the HCL VersionVault administrator’s most important tasks.
  - VOB datatypes and administrative VOB hierarchies
    There are many types of VOB metadata. Some are unique to a particular VOB, but many must be managed consistently across a group of VOBs that store related artifacts (components of a UCM project, for example). These topics introduce VOB metadata and describe how to use administrative VOB hierarchies to simplify sharing of type objects among related VOBs.
    - VOB datatypes
      A general understanding of VOB datatypes can place many administrative tasks in context.
    - Administrative VOB hierarchies and global types
      Managing type objects that are used in a group of related VOBs is greatly simplified by creating administrative VOB hierarchies that can share globally defined type objects.
    - Working with global types
      In general, all operations on a global type or a local copy of a global type apply to the global type and all its local copies.
      - Creating a global type
        When administrative VOBs are in use, most type-creation operations create global types.
      - Describing global types
        The cleartool describe command can show properties of global types or their local copies.
      - Listing global types
        By default, the lstype command lists global types associated with local copies.
      - Listing the history of a global type
        By default, the lshistory command lists the history of the global type for the object selector you specify, even if there is no local copy of the type in the specified VOB.
      - Changing the protection of a global type
        Changing the protection of a global type or a local copy of a global type changes the protection of the global type and all its local copies.
      - Locking or unlocking a global type
        Locking or unlocking a global type or one of its local copies locks or unlocks all local copies.
      - Copying a global type
        When you copy a global type, the copy can be created as a global type or a local type.
      - Renaming a global type
        Renaming a global type renames all local copies of the type. Renaming a local copy of a global type renames all other local copies and the global type itself.
      - Changing the scope of a type
        You can change the scope of a type from local to global, or from global to local.
      - Removing a global type
        Removing a global type or any of its copies removes all local copies and the global type itself.
      - Cleaning up global types
        Use checkvob with the –global option to check for (and optionally fix) global types that are in an inconsistent state.
    - Replicated administrative VOB hierarchies
      When you use administrative VOB hierarchies (including those created by UCM) in an HCL VersionVault MultiSite environment, special considerations apply to replication.
  - Moving VOBs and relocating VOB data
    HCL VersionVault includes tools for moving data and metadata to another VOB and for moving entire VOBs to another disk or host. You may need to use these tools to reorganize VOB directories, redistribute data storage, or rebalance server loads.
  - Views and view administration
    A view provides a workspace where users access versions of file and directory elements that are under HCL VersionVault control. Views can also contain view-private file system objects (such as ordinary files and directories) that are not under HCL VersionVault control.
  - Backing up critical HCL VersionVault data
    Like all databases, VOBs, views, and the HCL VersionVault registry have special backup and restore requirements.
  - Restoring critical HCL VersionVault data
    If you have implemented a sound backup strategy for HCL VersionVault data, it should be easy to restore that data, if necessary.
  - Periodic maintenance
    Periodic attention to storage management and repository integrity is an important administrative function. These topics describe VOB and view storage management tasks, the checkvob utility, and the HCL VersionVault scheduler, which you can use to automate many periodic maintenance chores.
  - Importing data
    HCL VersionVault includes several utilities for importing data from other configuration management systems or directly from the file system itself.
  - Troubleshooting
    These topics cover a variety of procedures that administrators might need to follow to find and fix problems.
  - Improving client host performance
  - Improving VOB host performance
  - Configuring cross-platform file-system access
  - HCL VersionVault and Windows® domains
  - Configuring non-VersionVault access on Linux® or the UNIX system
    You can configure an HCL VersionVault host running Linux® or the UNIX system to support access to VOBs and dynamic views from computers that do not run HCL VersionVault.
  - Configuring HCL VersionVault for high availability
  - Estimating VOB size
    If you can estimate the number of elements, versions, and derived objects that a VOB will ultimately contain, you can compute a very rough estimate of the size of a VOB that can accommodate them. VOB storage includes a database and pools. On Windows®, the database and pools must reside on a single disk partition. On Linux® or the UNIX system, the pools can be located on a different partition or host, using symbolic links.
  - Administering the VersionVault WAN server
  - About VersionVault WAN server parallel view loading
  - Administering and using CMI task-provider integrations
    HCL VersionVault supports integrations with task providers such as HCL Compass through the Change Management Interface (CMI). The integrations require some configuration tasks, after which you can work with UCM activities or base VersionVault branches that are associated with the tasks.
- Administering platforms for HCL VersionVault
  Learn how to perform HCL VersionVault administrative tasks on supported platforms.
- Administering HCL VersionVault MultiSite
  Learn to configure and manage the HCL VersionVault MultiSite environment to support development activities at different locations.

Describing global types

The cleartool describe command can show properties of global types or their local copies.

About this task

By default, the cleartool describe command shows the description of the global type for the object selector you specify. You can enter the command in the context of a VOB that does not contain a local copy of the type. To describe the local copy, use the –local option.

Example

The following command describes the global label type REL6:

cleartool describe –long lbtype:REL6@\dev
label type "REL6" created 28-Jul-99.14:00:26 by Suzanne Gets (smg.user@neon) "final label for REL6" owner: smg group: user scope: global constraint: one version per element Hyperlinks: GlobalDefinition@47@\dev <- lbtype:REL6@\dev

The following command describes the local copy of the global label type REL6:

cleartool describe –local –long lbtype:REL6@\dev
label type "REL6" created 28-Jul-99.14:23:45 by Suzanne Gets (smg.user@neon) "Automatically created label type from global definition in VOB "\admin"." owner: smg group: user scope: this VOB (local copy of global type) constraint: one version per element Hyperlinks: GlobalDefinition@47@\dev -> lbtype:REL6@\admin

If you specify –local and no local copy exists, describe prints an error:

cleartool describe –local lbtype:NOLOCAL@\dev
cleartool: Error: Not a vob object: "lbtype:NOLOCAL@\dev".

Have feedback?
Google Analytics is used to store comments and ratings. To provide a comment or rating for a topic, click Accept All Cookies or Allow All in Cookie Preferences in the footer of this page.