Creating a ClearCase Synchronized Stream and merge workspace

Use the New ClearCase-Synchronized Stream wizard to create a IBM® Engineering Workflow Management (EWM) stream and associate it with an existing Rational® ClearCase® stream. You can resolve conflicts that occur during synchronization in a merge workspace, which is a repository workspace that is created with the stream.

About this task

A merge workspace is a repository workspace where you accept changes from a ClearCase Synchronized Stream. The Rational ClearCase stream is defined by a UCM stream name or a branch type and (optional) label type. A synchronized stream can be treated like other EWM streams, even though it contains changes that were imported from Rational ClearCase.

After you create a ClearCase Synchronized Stream, you specify files and folders to synchronize between the two systems.

Procedure

To create a ClearCase Synchronized Stream:

  1. Log on to the synchronization host as the Rational ClearCase account for the synchronization process (see Configuring a synchronization host for more information about the account requirements).
  2. Use the EWM client to log in to the EWM repository where you want to create the synchronized stream. Log in with a EWM user account that is not assigned to the synchronization process.
    Important: Do not connect by using the EWM account for the synchronization process.
    The credentials with which you connect in this step become the synchronized stream creator account that is associated with the synchronized stream and that owns the merge workspace. You can change the synchronized stream creator account credentials any time after this task is completed.
  3. In the EWM main menu, click File > New > Other, then expand Jazz Source Control, and click ClearCase Synchronized Stream to start the New ClearCase Synchronized Stream wizard.
    Note:
    • The wizard creates a Rational ClearCase dynamic view that is owned by the Rational ClearCase account for the synchronization process. Use the Rational ClearCase Administration Console to display available VOBs. Verify that VOBs you want to synchronize with are mounted and accessible on the synchronization host.
    • Another way to start the wizard is to click File > Import, expand Jazz Source Control, and select ClearCase Stream or Branch.
  4. In the ClearCase Stream Information page, specify a configuration for the Rational ClearCase dynamic view that the wizard creates to support synchronization:
    • To configure the view from a UCM stream, select Import from a UCM stream and enter the name of an existing stream in the form stream-name@PVOB-tag. For example, to specify a stream named my_stream in a PVOB with the tag \projects, enter my_stream@\projects. Use the cleartool lsstream command or the Rational ClearCase Project Explorer to search for stream names.
    • To configure the view from a branch type and label type, select Import from a Base ClearCase branch and enter the selector for an existing branch type in the form branch-type-name@VOB-tag and the label type selector in the form label-type-name@VOB-tag, for example, to specify a branch type named my_branch in a VOB with the tag \sources, type my_branch@\sources.
    Tip: Use the cleartool lsstream command to search for stream names.
    Important:
    • If you configure the view by using a UCM stream, the stream is locked for the duration of each synchronization. If you configure the view by using a branch type and (optional) label type, the label type is permanently locked, and the branch type is locked for the duration of each synchronization. It is generally impractical to use the MAIN branch type, except for initial experimenting, because the synchronization process locks it regularly, often for an extended period. You cannot use the LATEST pseudo-label, because it cannot be locked. For more information, see Configuration specification details for base Rational ClearCase.
    • Do not select Import with history from ClearCase unless you do not need to synchronize changes made in EWM source control back to Rational ClearCase. Bidirectional synchronization is not possible when importing with version history.
  5. The wizard validates the syntax (but not the existence) of the stream name or branch type and label type, and then enables the Next button. Click Next.
  6. In the ClearCase Storage Information page, specify the network path to a directory where the wizard can create view storage for a Rational ClearCase dynamic view to enable synchronization between EWM and Rational ClearCase. The wizard seeds this entry with a network path that consists of the local host name and the string \VIEWSTORAGE. If this directory exists on the local host and is a valid location for view storage (it must be shared on Windows or exported on the UNIX system or Linux), you can use it. Otherwise, specify the network path to another local or remote directory where the view storage can be created. The wizard creates a dynamic view with storage in this directory and a distinctive view tag (it has the prefix DO_NOT_USE). This view is reserved for use by the synchronization process and must not be modified by Rational ClearCase users.

    If applicable, check Enter additional option set information for creating ClearCase views and enter the appropriate values for the host name, host-local path, and global storage path of the Rational ClearCase server storage location.

  7. Choose the line ending type of text files that are stored in the Rational ClearCase VOB. Doing so ensures that the line ending type of text files is preserved when importing to the EWM repository. Click Next. The wizard validates the view storage path and, if provided, the global storage path.
  8. On the Select Project or Team Area page, expand the repository entry and select the project or team area to which you added the synchronization process EWM account (see Adding the Jazz administrative user to your team).
    Tip: If there are no entries under the repository, verify that you are connected to the project area, then try again.
    Click Next.
  9. The Jazz Source Control Information page displays the name of a merge workspace that the wizard can create. You can choose another name. If the repository contains a workspace with the name you chose, the wizard extends it with a string that makes it unique. (A merge workspace is a repository workspace where someone who is logged in as the synchronized stream creator account resolves conflicts that occur when a file or folder has been modified in parallel in Rational ClearCase and EWM).
  10. Optional: Check Specify a snapshot to be used as initial content of Jazz synchronized stream, and then click Browse to select a snapshot as the initial content of the EWM synchronization stream. The synchronization or import operation creates EWM SCM change-sets, in addition to the existing content of the selected snapshot.
  11. Optional: Choose a work item template to associate with the synchronized stream. Enter the work item id in the Work Item Template field or click Browse to display a Work Item Selection window. For more information, see Creating a synchronized stream work item template.
    Note: Although this step is optional, your team process might require the work item template. The work item template is required when the project area in which the synchronization stream is created requires that change sets must be associated with a work item.
  12. A default Synchronization user ID is displayed in this field. (The default ID is ccsync.) If your synchronization process EWM account uses an ID other than the default, replace the ID with the correct value. Enter the password for the synchronization process EWM account. For more information, see Creating a Jazz administrative user for the synchronization process.
  13. In the Connector install location field, type the path name where the ClearCase Synchronizer is installed on this host or click Browse to browse for it. The ClearCase Synchronizer is typically installed in the EWM installation directory.
  14. By default, the synchronization process checks the repository for new synchronization requests every 2 minutes. If you want, you can change this interval by editing the Sleep time interval (seconds) field.
  15. Click Finish to create the ClearCase Synchronized Stream. Unless you have cleared the Start a Jazz Synchronization engine process after the wizard finishes check box, the wizard starts the synchronization engine process. If you decide not to start the synchronization engine process now, you can start it later, as described in Starting the synchronization engine process. You can monitor the status of this process in the ClearCase Synchronized Streams view.

    Unless you clear the Start the Select Files wizard after this wizard finishes check box, the Select Files wizard opens after the ClearCase Synchronized Stream has been created. Use the Select Files wizard to specify files and folders to synchronize.

Results

When the new ClearCase Synchronized Stream has been created, the wizard opens the ClearCase Synchronized Streams view, which lists the new stream.

What to do next

Note: When you create a ClearCase Synchronized Stream, the wizard creates a text file named synchronization process EWM account ID.cred.txt (for example, ccsync.cred.txt) that contains the user ID and an obfuscated password for that account. The file is created in the ClearCaseSynchronizer (ClearCaseConnector in releases prior to 3.0.1) subdirectory of your home directory. It must be protected so that it cannot be read by unauthorized users.

video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki