Plug-in Documentation

IBM Rational ClearCase


The ClearCase plug-in automates importing versions from a ClearCase repository.

This plugin includes one or more steps, click Steps for step details and properties.


This plug-in requires version 6.0 or later of IBM UrbanCode Deploy.

This plug-in runs on all operating systems that are supported by both the IBM UrbanCode Deploy agent (except for z/OS) and the cleartool.

For UrbanCode Deploy 6.0, both the agent and the server must be installed on Microsoft Windows. For UrbanCode Deploy 6.0.1 or later, only the agent is required to be on a system running Microsoft Windows.

This plug-in runs against all supported versions of ClearCase leveraging cleartool.


This plug-in is installed when installing IBM UrbanCode Deploy. When new plug-in versions are available, see Installing plug-ins in UrbanCode Products to update the plug-in.


Version 11

  • Allow specifying custom java opts
  • Version 10

    • Fixing CVE:CVE-2019-4233

    Version 9

    • Updates property descriptions.

    Version 8

    • APAR PI89045: add support for setting isFinished flag flag when importing versions.

    Version 7

    • Fixes APAR PI87707, a regression where the user who requested a manual version import was not being tracked.

    Version 6

    • Support property file encryption.

    Version 5

    • Fixes APAR PI57417. Plug-in now checks the agent settings for acceptance of self signed certificates.

    Version 4

    • Fixes APAR PI32513 where the plugin would only update the whole snapshot instead of the current view.

    Version 3

    • Fixes multiple issues around the plugin, and renames plugin from ClearCaseUCM to ClearCase.

    Version 2

    • Fixes running a process after creating a version.

    Version 1

    • Initial release of the ClearCaseUCM source configuration plugin.
  • Usage

    To use this plug-in, create a component to define the source and processes for the Rational ClearCase Unified Change Management (UCM) repository. The component contains the information for importing the artifacts and any processes to perform on the artifacts.

    Create a component

    To create a component, complete the following steps. For more information, see Creating components
    topic in the product documentation.

    1. In the HCL user interface, click Components and then click Create Component.
    2. In the Create Component window, specify a name and description for the component.
    3. In the Teams fields, specify the access information for the new component.
    4. To use a template for the new component, select a template from the Template list. In this case, the component inherits source configuration, properties, and processes from the template.
    5. In the Source Config Type list, select ClearCase.

    6. Specify the properties for the component. See the Setting tab for descriptions.
    7. Click Save.

    Import a version

    When the artifacts are imported, a component version is created using the version of the package. You can specify to import a specific package version or import all versions. If importing all versions, a component version is created for each version.

    1. Click the Versions tab for the component.
    2. Click Import New Versions.
    3. Specify a specific version of the package to import, or leave blank to import the latest version of the package available in the repository. Additionally, enable Import All Versions to import all versions of a package.
    4. Click Save.

    Step palette

    To access this plug-in in the palette, click Source and Repositories > ClearCase.

    Steps and Roles

    Process steps in the ClearCase plug-in

    Import Version

    Import a new version from ClearCase

    This step has no input properties.

    Roles in the ClearCase plug-in

    The plug-in adds these roles automatically to resources. You cannot add these roles manually.


    Properties for the ClearCaseUCMComponentProperties role
    Name Type Description
    Clear Tool Path String The location of the Clear Tool executable file. Use this property if the executable file is not included on the PATH statement.
    Excludes String A list of file patterns to exclude in the component. Place each pattern on a separate line.
    Extensions of files to Convert String A list of file extensions to convert into another character set. Separate each file extension with a comma. Specify this property if you have text-type files that must be converted into another character set. Matching file types are converted into the default character set of the system where the agent is located.
    Includes String A list of file patterns to include in the component. Place each pattern on a separate line.
    Path to location inside the View String The base directory from which files are imported. For a Snapshot View, this is the portion of the Snapshot View that is updated before importing the files.
    Preserve Execute Permissions Boolean For Linux and UNIX operating systems, retain the execute permissions for each file.
    Snapshot View Boolean The connection is to a Snapshot View.


    Properties for the ClearCaseUCMImportProperties role
    Name Type Description
    Name String The name for the version being created.