clmutil

CMI administration tool

Applicability

Product

Command type

VersionVault

command

Platform

UNIX

Linux

Windows

Synopsis

  • Replace existing URI strings with new ones.
    clmutil replace [ -verbose | -silent ] [ -preview ]
    -old_string string -new_string string vob_tag [ . . . ]
  • List work items that match a URI string and display the versions that are associated with those work items.
    clmutil list [ -verbose ] [ -all | -string string ]
    vob_tag [ . . . ]
  • Migrate from the UCM-VersionVault/Compass integration to CMI.
    clmutil cmi_repair [ -verbose ] [ -preview ] [-migration_file pname ]
  • Repair broken links.
    clmutil cmi_repair [ -verbose ] [ -preview ] [ -repair_file pname ]
  • Display the help for all commands or for a single command.
    clmutil help [ command ]
  • End an interactive session.
    clmutil [ quit | exit ]

Description

Use the clmutil command to
  • Replace existing URIs with new URIs
  • Preview changes to URIs without making any changes
  • List work items that are attached to URIs
  • Migrate from the UCM-VersionVault/Compass integration to CMI
  • Repair broken links.
You can use clmutil in either of two modes:
  • Single-command mode:

    clmutil command options args

  • Interactive mode:

    clmutil


    clmutil> command options args
    .
    .
    .
    clmutil> quit

This utility is installed in the /bin directory and must be run from that directory:
  • On Windows: c:\Program Files\HCL\CCM\VersionVault\bin\clmutil
  • On UNIX systems and Linux:/opt/hcl/ccm/versionvault/bin/clmutil

Restrictions

To use clmutil cmi_repair ... [ -repair_file pname ], you must be root (on UNIX or Linux) or a member of the Administrator group and the VersionVault group on Windows (except when -preview is specified). You must run this command in a view.

Options and arguments

Messages

Default
The name of the task is listed with the number of activities that are attached to it.
-silent
Suppresses messages. This option is invalid with -preview.
-verbose
Enables verbose status messages.
-all
Lists all tasks.

Previewing changes

Default
No preview of changes.
-preview
Displays the changes that would be made if this option were not specified. This option is invalid with -silent.

Specifying the URI

Default
None.
-old_string string
Specifies an existing URI string.
-new_string string
Specifies a URI string that is to replace an existing string. When used with the -preview option, shows the changes that would be effected if -preview were not specified.
string
Specifies any part of a URI string, or the entire string.

Specifying the VOB

Default
None.
vob-tag [ . . . ]
Specifies one or more mounted VOBs.

Specifying the repair file

Occasionally, the process of establishing a link with the change management provider database may fail to complete, due to network instability, user error, or some other reason. When CMI encounters an error while creating a link to a change management provider, recovery information is written to the file cmi_repair_log (to enable repair logging, add the line cmiRepairLogEnabled=true to the CMI configuration file located in the config directory of the VersionVault installation.) The repair log file is used as input to clmutil cmi_repair.

Default
cmi_repair_log or cmi_repair_log.backup. If you do not specify a repair file, cmi_repair_log is renamed to cmi_repair_log.backup so that the original file can continue to collect errors. In this case, the backup file is used as the source of data for the repair operations.
-repair_file pname
Specifies a repair file: a copy of cmi_repair_log, possibly edited.

Specifying the migration file for migrating UCM-VersionVault/Compass integration to CMI

After running cmi_migrate.pl to generate a migration file that lists activities that require task associations, use clmutil cmi_repair ... -migration_file to create the task associations on the activities and to update the links tab on the Compass records.

Default
cmi_migration_activities.txt (generated by cmi_migrate.pl)
-migration_file pname
Specifies the migration file.

Displaying help

Default
Help is displayed for all commands.
command
Specifies a command for which the help is to be displayed.