Installation and configuration of VersionVault Remote Client CLI

You can use the IBM Installation Manager to install the VersionVault Remote Client command-line interface (CLI) that is part of VersionVault Explorer package.

Before you begin

The VersionVault Remote Client CLI is installed with the VersionVault Explorer package. The package is available for install through the Installation Manager.

Note: HCL VersionVault provides two clients for software developers: local and remote. Each client supports different mechanisms for accessing source-controlled filesystem objects. Both clients provide graphical and command-line interfaces.
The following table summarizes some important characteristics of the two clients.
Table 1. Characteristics of VersionVault clients for software developers
Client Network connection type Connection to repository of source-controlled objects View types User interfaces
VersionVault Local Client LAN only RPC connection to a Versioned Object Base (VOB)
  • Dynamic
  • Snapshot
  • GUI: VersionVault Explorer
  • CLI: cleartool
VersionVault Remote Client WAN and LAN http(s) connection to a VOB through a VersionVault WAN server
  • Automatic
  • Web
  • GUI: VersionVault Explorer
  • CLI: rcleartool

The term view, as used in this table, refers to the mechanism for accessing versions in a VOB. For example, snapshot, automatic and web views provide copy-based mechanisms, whereas the dynamic view provides a mechanism to directly access versions in real time.

Another use of the term view refers to the configuration management model that governs the development of software. The two models are called Base VersionVault and Unified Change Management (UCM):
  • In a Base VersionVault view, you specify the configuration explicitly by rules for version selection, branching, and so on.
  • In a UCM view, the configuration is generated by VersionVault operations such as creating a development stream.
For more information, see the "Developing software with HCL VersionVault Explorer" topic.

HCL VersionVault or HCL VersionVault Remote Client

Installing either HCL VersionVault or HCL VersionVault Remote Client, installs VersionVault Remote Client CLI. These are sample paths to the installation:
  • Windows:
    • C:\Program Files\HCL\CCM\VersionVault\RemoteClient\rcleartool.bat
    • C:\Program Files\HCL\CCM\VersionVault\RemoteClient\rcleartool.conf
  • UNIX/Linux:
    • /opt/hcl/ccm/versionvault/RemoteClient/rcleartool
    • /opt/hcl/ccm/versionvault/RemoteClient/rcleartool.conf

Procedure

If you are installing VersionVault Explorer from the Eclipse update site, 'rcleartool.bat' / 'rcleartool' scripts must be configured manually. Take the following steps to manually configure the rcleartool scripts.

In the following example, <ECLIPSE_HOME> refers to the location of your eclipse installation, the same directory eclipse.exe would reside.

  1. On Windows:
    1. Copy 'rcleartool.bat' from (your path version number may be slightly different, choose the latest version of the VersionVault Remote Client CLI directory)<ECLIPSE_HOME>\plugins\com.hcl.ccm.ccrc.cli_2.0.0.v20200614_0216\rcleartool.bat to <ECLIPSE_HOME>\rcleartool.bat
    2. Open 'rcleartool.bat' to edit the following line replacing <JAVA_EXE_PATH> with the full path to your installed version of Java 6 (or greater) JRE:from: if not defined _JAVACMD set _JAVACMD=_JAVA_CMD_PATH_to: if not defined _JAVACMD set _JAVACMD=<JAVA_EXE_PATH>

      This is an example of a valid input for this line: if not defined _JAVACMD set _JAVACMD=C:\Program Files\HCL\Java60\jre\bin\java.exe.

    3. Run the 'rcleartool.bat' file once to configure the remaining paths automatically.
      Note: An automatic configuration of the remaining paths will only work if the current directory is the directory containing the rcleartool.
    4. You can now add <ECLIPSE_HOME> to your system PATH variable to run rcleartool from any directory in your command window.
  2. UNIX/Linux:
    1. Copy 'rcleartool.bat' from (your path version number can be slightly different, choose the latest version of the VersionVault Remote Client CLI directory) <ECLIPSE_HOME>\plugins\com.hcl.ccm.ccrc.cli_2.0.0.v20200614_0216\rcleartool to <ECLIPSE_HOME>\rcleartool
    2. Open 'rcleartool' to edit the following line replacing <JAVA_EXE_PATH> with the full path to your installed version of Java 6, or greater, JRE: from: _JAVACMD=${_JAVACMD:-_JAVA_CMD_PATH_} to: _JAVACMD=${_JAVACMD:-<JAVA_EXE_PATH>}
      This is an example of a valid input for this line: 
      _JAVACMD=${_JAVACMD:-/opt/HCL/Java60/jre/bin/java}
    3. Run 'rcleartool' once to configure the remaining paths automatically.

      Note: An automatic configuration of the remaining paths will only work if the current directory must be the directory containing rcleartool.

    4. You can now add <ECLIPSE_HOME> to your system PATH variable.