Home
Integrating
Learn how to integrate HCL VersionVault with other products.
Integrating HCL VersionVault with other products
Learn how to integrate HCL VersionVault with other products.
HCL VersionVault integrations with vendor products
HCL VersionVault can be integrated with other vendor products.
The HCL VersionVault integration with Jenkins
Use the HCL VersionVault plug-in in Jenkins for the HCL VersionVault-Jenkins integration to enable continuous integration service between VersionVault and Jenkins.
Installing HCL VersionVault-Jenkins plug-ins in an existing Jenkins server
To add the HCL VersionVault-Jenkins integration to an existing Jenkins server, you must configure the search path and install the plug-ins.

Integrating
Learn how to integrate HCL VersionVault with other products.
- Integrating HCL VersionVault with other products
  Learn how to integrate HCL VersionVault with other products.
  - HCL VersionVault integrations with other HCL products
    The following integrations are available for HCL VersionVault with other HCL products.
  - HCL VersionVault integrations with vendor products
    HCL VersionVault can be integrated with other vendor products.
    - The HCL VersionVault integration with Jenkins
      Use the HCL VersionVault plug-in in Jenkins for the HCL VersionVault-Jenkins integration to enable continuous integration service between VersionVault and Jenkins.
      - About system requirements for the HCL VersionVault integration with Jenkins
        To be able to use the plug-in for the HCL VersionVault-Jenkins integration, certain system requirements are needed.
      - Installing Jenkins on Linux for the HCL VersionVault-Jenkins integration
        Learn how to install Jenkins on Linux so that it can be integrated with HCL VersionVault.
      - Installing Jenkins on Windows for the HCL VersionVault-Jenkins integration
        Learn how to install Jenkins on Windows so that it can be integrated with HCL VersionVault.
      - Installing HCL VersionVault-Jenkins plug-ins in an existing Jenkins server
        To add the HCL VersionVault-Jenkins integration to an existing Jenkins server, you must configure the search path and install the plug-ins.
      - Configuring the plug-in for a freestyle job for the HCL VersionVault-Jenkins integration
        Configure the plug‑in for a freestyle job.
      - Configuring the plug-in for a pipeline job for the HCL VersionVault-Jenkins integration
        Configure the plug-in for a pipeline job.
      - About build triggers for the HCL VersionVault integration with Jenkins
        Learn about the build triggers for the HCL VersionVault-Jenkins integration.
    - The HCL VersionVault Explorer integration with Beanbag Review Board
      VersionVault Explorer is integrated with Review Board to provide the interface to directly raise a review request or update an existing one.
    - The HCL VersionVault integration with the Apache NetBeans
      The HCL VersionVault integration with the Apache NetBeans integrated development environment (IDE) lets you use VersionVault operations from the NetBeans IDE.
    - The HCL VersionVault integration with Visual Studio
    - The HCL VersionVault integration with Visual Studio Code
      The HCL VersionVault integration with Visual Studio Code lets you execute basic VersionVault operations, such as checkin and checkout.
    - The HCL VersionVault integration with Cadence Virtuoso
      The HCL VersionVault-Cadence integration supports a number of commands (data management operations, such as check-in and check-out) and features (such as the Configuration Specification editor and the Work Area Manager).

Installing HCL VersionVault-Jenkins plug-ins in an existing Jenkins server

To add the HCL VersionVault-Jenkins integration to an existing Jenkins server, you must configure the search path and install the plug-ins.

Before you begin

Note: VersionVault supports Jenkins LTS 2.332.x when run in a 64-bit Java Runtime Environment (JRE).

You must install the HCL VersionVault Remote Client or HCL VersionVault.

On Windows, the system path is updated by the installation of HCL VersionVault Remote Client or HCL VersionVault. After the installation of VersionVault is completed, either reboot the system or restart the Jenkins server.
On Linux, after installing VersionVault, you must set the search path for your Jenkins server to include /opt/hcl/ccm/versionvault/bin.
Note: The procedure to set the search path and restart the Jenkins server depends on how your Jenkins server is installed. For more information, consult with your Jenkins administrator.

Procedure

Use the following procedure to install HCL VersionVault-Jenkins integration to an existing Jenkins server:

Copy files versionvault-jenkins.hpi and cmapi-jenkins.hpi from versionvault-home-dir/java/lib/versionvault-jenkins.hpi and versionvault-home-dir/java/lib/cmapi-jenkins.hpi.
Install the copied files versionvault-jenkins.hpi and cmapi-jenkins.hpi into the Jenkins server using the Jenkins management web pages as described in the next step.
Select Manage Jenkins > Manage Plugins > Advanced tab and add the following plug-ins:
- cmapi-jenkins.hpi
- versionvault-jenkins.hpi