Configuring the plug-in for a Multibranch pipeline job for the DevOps Code ClearCase-Jenkins integration

Configure the plug‑in for a Multibranch pipeline job.

Configuring the plug-in for a Multibranch pipeline job

Tip: For information and to get more hints for a section or field, click ? in Jenkins where available.

In the Branch Sources section, select DevOps Code ClearCase® option.
Note: The DevOps Code ClearCase-Jenkins plugin only supports one branch source from DevOps Code ClearCase.
From the Choose ClearCase flavor drop-down list, select the ClearCase UCM option.
Enter value of the stream selector in the format stream:{streamname}@{vobtag}.
Enter the value of the component selector in the format component:{componentname}@{vobtag}.
Choose view type from the options Automatic View or Web View or Dynamic View or Snapshot View
- For automatic views:
  - Enter the VOB tag to be mounted. For example, /username_testvobnewvob. If there are multiple VOBs to mount, click the Add button to enter each VOB tag.
    Note: Use the UNIX-style VOB tag format (/), even on Windows systems.
  - Connect to the ClearCase server:
    1. Disable SSL Verification: If you do not have a trusted Secure Sockets Layer (SSL) certificate installed on your CCRC WAN server, select this check box to disable SSL validation of its certificate. This setting must be set the same for all jobs as defined on the Jenkins server, even if the jobs use different WAN servers.
      If your CCRC WAN server has a signed certificate from a private certificate authority (CA), you can install that CA into the truststore of your Java Runtime Environment (JRE). Check the documentation of your Java supplier for instructions to update the truststore. Once you install the private CA, clear the Disable SSL Verification check box.
      Note: The Disable SSL Verification option disables any security provided by TLS/SSL and is not recommended.
    2. Wan server URL: Enter the ClearCase WAN server URL where the project is located.
    3. Credentials: Click Add and select the Jenkins option and then, enter the credentials of a user who has access to the required VOBs by selecting one from the drop-down list for the Credentials field.
      Important: Remember to update the password in the truststore of Jenkins when the ClearCase credentials are updated for builders.
- For Dynamic Views:
  - Enter the VOB tag to mount. For example /username_testvobnewvob. If there are multiple VOBs to mount, click the Add button to enter each VOB tag.
    Note: Use the UNIX-style VOB tag format (/), even on Windows systems.
  - Enter the View storage location name.
- For Snapshot Views:
  - Enter the load scopes to be applied. It could be any subpath inside the VOB. If there are multiple load scopes, click the Add button to enter each of them.
  - Enter the View storage location name.
  - About the Create view directly in the workspace root section.
    - If you select Erase the Jenkins workspace and load the view in its place, each SCM operation to load a view will replace the Jenkins workspace directory with the view contents.
      
      Note: This option is ignored for pipeline library SCM operations, which use temporary views.
- For Web Views:
  - Enter the load scopes to be applied. It could be any subpath inside the VOB. If there are multiple load scopes, click the Add button to enter each to them.
  - See About the Create view directly in workspace root section.
  - See Connect to the ClearCase server.
About the Baseline template filter section
Provide a regular expression so that baselines whose names match the regex will result in a new build.
If it is left empty (.*) it will be assumed as no filter.
About the Enable build attributes on baseline section
If the option is selected, then two build attributes will be attached to the baseline.
1. BUILD_STATUS : This attribute will reflect the status of the build. cleartool command: cleartool mkattype -vtype string -default '"NOT_STARTED"' -enum '"NOT_STARTED","IN_PROGRESS","COMPLETED_SUCCESS","COMPLETED_FAILURE"' -nc BUILD_STATUS@vobtag
2. BUILD_REF: It has the build url of the job build. cleartool command: cleartool mkattype -vtype string -nc BUILD_REF@vobtag.
About the Paths to copy into workspace section

Enter view-relative pathnames (including the VOB tag) to be copied (recursively) from the view into the Jenkins workspace.

This section is only needed for Jenkins pipeline libraries. For more information, see Jenkins pipeline library configurations.

Note: Pathnames must use UNIX-style path separators (/). Example: vobs/component/my/library.
About the Auto Deliver if build successful section

If you select the Auto Deliver if build successful check box, then there would be an attempt to deliver the child stream’s baseline to the integration stream configured in the Multibranch pipeline.

Note: The delivery can fail if the baseline has no changes to be delivered or there are merge conflicts, in which case the baseline should be delivered manually after resolving the conflicts.
About the Destroy views on job completion section

If you select the Destroy views on job completion check box, all the views that are created as part of a build are destroyed automatically.

If you do not select the Destroy views on job completion check box, the views are then active beyond the scope of a build and can be accessed later.

Tip: The views for each checkout can accumulate quickly. The build engineer must clean up the views periodically.
To add a Build Configuration
1. In the Build Configuration section, select By Jenkinsfile from the Mode drop-down list.
2. In the Script Path section, enter the full VOB path relative to the view.
Note: The Jenkins file can be located anywhere in the sub-path of the VOB directory.

Webhooks

Make Baseline webhook

A child stream in the Jenkins job is triggered by ClearCase automatically through the multibranch webhook receiver. This action occurs whenever a make baseline operation is completed on the affected child stream of the parent stream configured in the Multibranch pipeline job.

For more information, see Configuring webhook triggers in Jenkins for a Multibranch pipeline job.

MultiSite baseline polling webhook

Users can set up a script in a MultiSite environment to scan for new baselines imported from other replicas. When new baselines are created in a replication packet, the Multibranch pipeline job is triggered to scan for new baselines after the packet's import.

For more information, see Configuring webhook triggers in Jenkins for a Multibranch pipeline job.