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.
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.
The HCL VersionVault scheduler
The HCL VersionVault scheduler provides a way to automate periodic maintenance on hosts that are configured with support for local VOBs and views.
Editing a task
You might need to edit an existing task definition in the scheduler’s task registry. For example, if you move the task’s executable program to another directory, you must change the pathname in the task definition in the task registry.

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.
  - 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.
    - The HCL VersionVault scheduler
      The HCL VersionVault scheduler provides a way to automate periodic maintenance on hosts that are configured with support for local VOBs and views.
      - Managing the scheduler access control list
        The schedule command uses a single access control list (ACL) that determines who is allowed access to the scheduler’s task and job registries and to the scheduler ACL itself.
      - Creating a task
        A set of standard tasks and a schedule for running them is installed on every host that supports local VOBs and views. Although you cannot create, change, or delete any standard tasks, you can define new tasks. You can also customize two predefined tasks, one of which runs daily and the other weekly in the default schedule, to add your own procedures to them and change their schedules.
      - Editing a task
        You might need to edit an existing task definition in the scheduler’s task registry. For example, if you move the task’s executable program to another directory, you must change the pathname in the task definition in the task registry.
      - Deleting a custom task
        Before you delete a task definition that you have created, you must remove references to the task from all scheduled jobs. You cannot delete any of the standard tasks.
      - Managing jobs
        You can create, delete, or edit jobs run by the scheduler. You can also run a scheduled job immediately.
      - Creating a job
        You can create a job to run standard or custom tasks.
      - Specifying a job’s schedule
        A job can run under two kinds of schedules: sequential, which runs the job immediately after another job finishes, or periodic, which runs the job on specified days at specified times.
      - Specifying job notifications
        The scheduler can send e-mail notifications to recipients you specify. You can also determine particular events that trigger notifications, such as the start of a job or the end of a job that fails.
      - Viewing job properties
        Scheduled job properties include schedule information and execution results.
      - Editing job properties
      - Running a job immediately
      - Deleting a job
    - Scrubbing to control VOB storage growth
      Scrubber utilities remove unneeded data from VOB databases. You can control how often they run and what data they remove.
    - About checkvob
      VOBs have complex internal and external relationships that can sometimes be disrupted by system or network failures or when a VOB is restored from backup. checkvob is a cleartool subcommand that can find, and in many cases fix, a variety of problems in these relationships.
    - View storage maintenance for dynamic views
      Encourage users to review, remove, and clean up their own views regularly. In addition, you should periodically remove unneeded shared dynamic views and clean up the private storage areas of those that are still in use.
  - 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.

Editing a task

You might need to edit an existing task definition in the scheduler’s task registry. For example, if you move the task’s executable program to another directory, you must change the pathname in the task definition in the task registry.

About this task

To change a task definition, use a text editor to edit the file task_registry in the scheduler’s tasks directory. When you edit a task, you must use the task-definition syntax documented on the schedule reference page.

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.