Plug-in Documentation

ClearCase UCM

Overview

IBM ClearCase allows you to manage source file and software build history for your organization. The unified change management (UCM) feature supports change management practices described by the IBM Rational Unified Process.

The ClearCase UCM plug-in integrates IBM UrbanCode Build with IBM ClearCase allowing source to be pulled from the ClearCase repository for builds.

Compatibility

This plug-in requires IBM UrbanCode Build version 6.1 and later.

The plug-in runs on any agents that the IBM UrbanCode Build server supports.

Installation

No special steps are required for installation. See Installing plug-ins in UrbanCode products.

Settings

The following settings are available when you import component versions by using the ClearCase UCM plug-in.

ClearCase UCM Snapshot Repository

A placeholder for using the scm system. The repository is configured on a per workflow
basis.

Properties for the ClearCase UCM Snapshot Repository role
Name Type Description
Command Path String The fully-qualified path of the cleartool executable file. If specified on the PATH statement, this property is not required.

ClearCase UCM Snapshot Source Config

Properties for the ClearCase UCM Snapshot Source Config role
Name Type Description
Alternate View String The alternate view to be used for the baseline. This property is only used with the Label step.
Components String A comma separated list of the components to be baseline. This property is only used with the Label step.
Exclude Filters String A list of user names to exclude.
File Filters String Restrict the changelog to the files matching the specified patterns. Specify each pattern on a new line. Start each line with a plus sign (+) to include or a minus sign (-) to exclude files matching the patterns. You can use asterick (*), double-asterick (**), and question mark (?) as wildcards in the pattern.
Force Label Boolean Create a baseline even if there are no changes. This property is only used with the Label step.
Global Storage Path (gpath) String The value for the -gpath parameter to be used in the mkview command. The viewname is not appended to the value. This property is required, if a value for the Hostname property is specified.
Host Storage Path (hpath) String The value for the -hpath parameter to be used in the mkview command command. The viewname is not appended to this value. This property is required, if a value for the Hostname property is specified.
Hostname String The value for the -host parameter to be used in the mkview command command.
Label Behavior Enumeration:

    Select the labeling behavior of the mkbl command. This property is only used with the Label step.
    Paths String A list of all the paths in the view. Specify each path on a separate line in the format: VOB\path\to\files. This information is used to detect changes, cleanup, and populate the snapshot.
    Populate Using All Components Boolean Indicates where the Update command searches for files. If enabled, the Populate step runs the Update command using only the VOB name, which pulls files from all components within the VOB. If disabled, the Update command uses each of the listed paths as the source to pull from instead of the entire VOB.
    Project VOB Name String The name of the versioned object base (VOB) repository to use when creating a view. The specified value must begin with a forward (\) or backward (/) slash. For example: \pvob.
    Repository The ClearCase repository.
    Stream Name String The name of the stream used by the view.
    Use VOB Time Boolean Sets the time stamp of a file element to the time at which the version was checked in to the VOB.
    Tmode Enumeration:

      The Tmode to use. This is required if you are using a Populate step.
      Use Tags Boolean If enabled, the view is globally created. Specifying this option can cause problems with creating and dropping snapshots when have the same snapshot is on multiple agents.
      View Creation Strategy Enumeration:

        The view strategy to use. Specify one of the following:
        Create Once to create a new view only if one does not exist
        Always Create to create a new view with every build
        Use Existing value indicate to use the existing view every time
        View Location String The location of the view. If View Creation Strategy property value is Use Existing, the location of the view is on the local machine. Otherwise, the location of the view storage directory is on the ClearCase server where the views are stored. For Windows operating systems this should always be a UNC path.
        View Name String The name of the view.

        Usage

        The IBM UrbanCode Build ClearCase UCM plug-in plug-in, provides integration properties that define the connection between the UrbanCode Build server and Rational ClearCase Unified Change Management (UCM) server. For details, see Repositories.

        The repository is configured based on a workflow.