Plug-in Documentation

Rational Team Concert v3-5

Overview

Use the Rational Team Concert plug-in to connect IBM Rational Team Concert queries to IBM UrbanCode Release and to automatically convert work items from Rational Team Concert to change items in IBM UrbanCode Release. The plug-in imports work items from Rational Team Concert and creates matching change items. The integration is not bidirectional. You cannot use the plug-in to export from IBM UrbanCode Release to Rational Team Concert.

Compatibility

The IBM UrbanCode Release plug-in for Rational Team Concert works with Rational Team Concert Version 4.0 and later.

This plug-in requires version 6.1.1.2 or later of IBM UrbanCode Release.

Installation

No special steps are required for installation. See Installing plug-ins in the IBM UrbanCode Release help.

History

Version 3

Version 3 includes a fix for SSL communication when using self signed certificates.

Version 2.1

Version 2.1 includes a fix that resolves errors in the Rational Team Concert Client and Rational Team Concert Client Auto Mapping steps.

Version 1

Version 1 is the initial release of the plug-in.

Usage

Importing work items

After you configure the integration provider, you can import work items as changes or initiatives.

If you import work items as initiatives, all child work items of the type that you specify are imported as changes that are related to the parent initiative.When you import work items as initiatives, all child work items are imported but only one level of hierarchy is preserved. Child work items that are of the type that you specify are imported as separate initiatives.

  1. In Rational Team Concert, create a query for the project area.
  2. In IBM UrbanCode Release, click Integrations, and then click the integration with the Rational Team Concert server.
  3. In the Mapping section, select a project area, and then select a query.
  4. Map the fields. To import work items as initiatives, select all the work item types under Initiatives to convert into initiatives. The work item types that are displayed in the Initiatives list are read dynamically from the project area in Rational Team Concert.
  5. Click Run Integration.

When you run the integration, work items of the type that you specify and all child work items are imported into IBM UrbanCode Release as changes or initiatives.

Configuring an integration provider

  1. In IBM UrbanCode Release, click Integrations > Add New. The New Integration Provider window opens.
  2. Type a name for the integration provider in the Name field.
  3. Under Integration Type, select RTC Plugin. If you have installed multiple versions of the plug-in, select the version to use from the list.
  4. Select OSLC Integration, RTC Client Integration, or RTC Client Integration Auto Mapping from the list.
    • OSLC Integration: Select to use Open Services for Lifecycle Collaboration (OSLC) to import the work items. A maximum of 1,000 work items are returned by an OSLC query.
    • RTC Client Integration: Select to use the Rational Team Concert client API to import the work items. There is no limit to the number of work items imported.
    • RTC Client Integration Auto Mapping: Select to use the Rational Team Concert client API to import the work items. There is no limit to the number of work items imported. Additionally, you can automatically map applications and releases in IBM UrbanCode Release to a specified field in Rational Team Concert.
  5. In the Frequency list, select a frequency. The frequency determines how often Rational Team Concert is polled for changes to import. Also, you can manually update changes any time.
  6. In RTC server URL, type the root URL of the Rational Team Concert server. For example, enter http://jazz_server.example.com:port_number/ccm/. The default port number is 9443.
  7. In the Consumer Key and Consumer Secret fields, type a consumer key and secret. You set up consumer keys on the Rational Team Concert server. To learn more about configuring OAuth in Rational Team Concert, see Configuring OAuth consumers. The functional user ID that you set up in Rational Team Concert must have access to the project area that you want to access. If the functional user ID in Rational Team Concert does not have access to the project area, an error message is displayed when you attempt to connect.
  8. Click Ping the RTC Server, and then click Check Authentication. If the connection is completed, the status icon is displayed in green, and a list of project areas is displayed.
  9. Map the values from Rational Team Concert to values in IBM UrbanCode Release. Each work item that is retrieved from Rational Team Concert is associated with a release and an application or an initiative in IBM UrbanCode Release based on the mappings.
    1. Under Mapping, select a Rational Team Concert project area from the list, and then select a query. To learn more about queries in Rational Team Concert, see Finding work items in the web client.
    2. Under Releases Mapping, select a release in IBM UrbanCode Release and select a Rational Team Concert Planned For value to map to the release.
    3. Under Applications, select an application in IBM UrbanCode Release and select a Rational Team Concert Filed Against value to map to the application.
    4. Under Statuses, for each status in the selected Rational Team Concert project area, select a corresponding status in IBM UrbanCode Release.
    5. Under Types, for each work item type in the selected Rational Team Concert project area, select a corresponding type in IBM UrbanCode Release. If you map Rational Team Concert types to types in IBM UrbanCode Release, do not also map Rational Team Concert types to initiatives. If you map work item types to both types and to initiatives, the work items are imported as initiatives.
    6. Under Initiatives, select the work item types in Rational Team Concert to be converted into initiatives in IBM UrbanCode Release. To learn more, see Importing work items as initiatives.
    7. Under Severities, for each severity level in the selected Rational Team Concert project area, select a corresponding severity level in IBM UrbanCode Release.

After you configure the integration provider, the Rational Team Concert server is polled based on the specified frequency. The results of the query are stored as change items in IBM UrbanCode Release. You can see items that are imported from Rational Team Concert on the Releases page and Changes page in IBM UrbanCode Release.

Settings

The following integration settings are available when you install the Rational Team Concert plug-in.

Integration properties for the OSLC
Name Type Description Required
Check Authentication Button to check if the connection can be established with the RTC Server No
Configuring an integration provider for Rational Team Concert Importing many work items from Rational Team Concert can take a significant amount
of time. When IBM UrbanCode Release polls Rational Team Concert to import work items,
only items that are modified are imported. For this reason, the first time the import
process runs, it can take a long time if there are many work items to import. Subsequent
import processes can take less time. By default, a maximum of 1,000 work items are
returned by a Rational Team Concert query.
No
Consumer Key Password Consumer Key No
Consumer Secret Password Consumer Secret No
Initiatives Check all work item types that you want to convert into Initiatives in UrbanCode Release. No
Ping the RTC Server Button to check if the connection can be established with the RTC Server No
RTC Project Area Project Area No
RTC Query Query No
RTC server URL String The RTC server URL No
Remove all items imported Button to delete all items retrieved from that integration No
Integration properties for the RTC Client
Name Type Description Required
Check Authentication Button to check if the connection can be established with the RTC Server No
Configuring an Integration Provider for Rational Team Concert using the RTC Client
Plain API
Importing many work items from Rational Team Concert can take a significant amount
of time. Nevertheless performances are better than the OSLC Integration. When IBM
UrbanCode Release polls Rational Team Concert to import work items, only items that
are modified are imported. For this reason, the first time the import process runs,
it can take a long time if there are many work items to import. Subsequent import
processes can take less time. There is no limit in the number of workitems to import
for the RTC Client Integration, while the OSLC Integration is limited to 1000 items
per query.
No
Initiatives Check all work item types that you want to convert into Initiatives in UrbanCode Release. No
Ping the RTC Server Button to check if the connection can be established with the RTC Server No
RTC Project Area Project Area No
RTC Query Query No
RTC server URL String The RTC server URL No
Remove all items imported Button to delete all items retrieved from that integration No
User Login String User Login No
User Password Password User Password No
Integration properties for the RTC Client Auto Mapping
Name Type Description Required
Application Mapping Map Applications to the selected RTC Concept No
Associate applications to the release automatically Boolean If a change imported is mapped to an application and a release and that application
has not been added to the release yet, it will add that application to the list of
participating applications for that release.
No
Check Authentication Button to check if the connection can be established with the RTC Server No
Configuring an Integration Provider for Rational Team Concert using the RTC Client
Plain API
Importing many work items from Rational Team Concert can take a significant amount
of time. Nevertheless performances are better than the OSLC Integration. When IBM
UrbanCode Release polls Rational Team Concert to import work items, only items that
are modified are imported. For this reason, the first time the import process runs,
it can take a long time if there are many work items to import. Subsequent import
processes can take less time. There is no limit in the number of workitems to import
for the RTC Client Integration, while the OSLC Integration is limited to 1000 items
per query.
No
Import if Unassigned Boolean Import if Unassigned No
Import if Unassigned Boolean Import if Unassigned No
Initiatives Check all work item types that you want to convert into Initiatives in UrbanCode Release. No
Mapping IBM UrbanCode Release Concepts to Rational Team Concert Concepts Releases and Applications can be mapped automatically by name to any custom field
defined in RTC.
No
Ping the RTC Server Button to check if the connection can be established with the RTC Server No
RTC Project Area Project Area No
RTC Query Query No
RTC server URL String The RTC server URL No
Release Mapping Map Releases to the selected RTC Concept No
Remove all items imported Button to delete all items retrieved from that integration No
User Login String User Login No
User Password Password User Password No