IBM Support

Rational ClearQuest RequirementsChangeRequest Package version 1.0

Download


Abstract

Use the IBM Rational ClearQuest RequirementsChangeRequest package v1.0 and the OSLCLinks package v1.1 to support the Rational DOORS integration with ClearQuest.

Download Description


NOTICE: This download is for ClearQuest version 7.1.2 only. Starting in ClearQuest 7.1.2.1, these packages are included as part of the ClearQuest product installation. Additionally, the packages included with the product will have support for different locale and languages.

If you are on version 7.1.2.1 or later, see technote 1456993 for information on installing these packages and enabling the integration.


A new Rational DOORS integration with Rational ClearQuest is available. The integration supports DOORS version 9.3 and ClearQuest version 7.1.2. The integration is based on the Open Services for Lifecycle Collaboration (OSLC) APIs for Change Management. The DOORS integration with ClearQuest provides a scalable and consistent approach for managing and tracking requirements change by leveraging Rational ClearQuest as a flexible change management tool.

The integration supports three major use cases:
  • Requirements Implementation brings comprehensive round-trip traceability from business requirements to change requests to code. This interface reduces scope creep (uncontrolled changes in a project's scope), streamlines development and provides real-time visibility relationships between requirements and development activities.
  • Requirements Gathering automates the start of the product definition phase so that requirements suggestions and proposals can be gathered by using a change management (CM) tool and reviewed through configurable workflows. Once approved, CM records are pulled into a DOORS module for further analysis and propagation.
  • Requirements Change Management provides flexibility to implement any process for managing, tracking and reporting on all proposed changes against critical requirements, links, requirements structures, specifications, test plans, and other information maintained in the CM database.


Requirements Implementation feature

You must apply the Rational ClearQuest OSLCLinks v1.0 package to your ClearQuest schema and enable the package for at least one record type to use the Requirements Implementation feature. The Rational ClearQuest OSLCLinks v1.0 package is included with Rational ClearQuest v7.1.2. See the following technote for instructions on how to apply the ClearQuest OSLCLinks package: http://www.ibm.com/support/docview.wss?uid=swg21433074


Requirements Gathering feature

You do not have to make any changes to your ClearQuest schema to use the Requirements Gathering feature.


Requirements Change Management feature
You must apply the ClearQuest RequirementsChangeRequest v1.0 package to your schema to use the Requirements Change Management feature.

The RequirementsChangeRequest package provides a record type named RequirementsChangeRequest (RCR) to use with the Requirements Change Management feature. This is a stateful record type that defines the following states: Created, Assigned, Review, Approved, Rejected and Applied. These states correspond to the states defined in the DOORS requirements module. You change these states by applying the following actions: Submit, Assign, Review, Approve, Reject, Apply and Reassigned.

The RCR record type maps a reference list to a ReviewApproval (RA) stateless record type. You use the RA record type to specify one or more mandatory or optional reviewers or approvers for its parent RCR record. A designated reviewer can approve or reject a ReviewApproval request only when its parent RCR record is in the Review state. A RCR record can be approved only when all its mandatory ReviewApproval requests have a status of Approved. The optional ReviewApproval requests are not taken into account.

You can customize the permission for these actions on the RCR record type by adding the RCR_Action_Permission global script.

The Requirements Change Management package has an internal dependency on the OSLCLinks package v1.1, which adds support for OSLC state predicates. OSLC state predicate support is required to use the Rational DOORS integration with Rational ClearQuest.

Known limitations

The following limitations apply to the Rational DOORS v9.3 integration with Rational ClearQuest v7.1.2:
  • You must use the RCR record type for the Requirements Change Management use case.
  • You cannot rename the RCR record type.
  • You are discouraged from editing the RequirementsChangeRequest and OSLCLinks packages. Customizing these packages might break the integration. Also, some customizations might need to be re-implemented when you upgrade to a future version of the packages.
  • If you must customize the RCR record type, do not add any required fields when moving from the Assigned state to the Review state, or from the Approved state to the Applied state.

Prerequisites

Prerequisites

  • You must have Rational DOORS v9.3 and Rational ClearQuest v7.1.2 installed and configured to use the DOORS integration with ClearQuest.
  • You must have Rational ClearQuest v7.1.2 installed on a Windows computer and have access to the ClearQuest administration tools to apply the ClearQuest RequirementsChangeRequest package to your schema.

Installation Instructions


Follow these steps to download and register the ClearQuest RequirementsChangeRequest v1.0 package and the ClearQuest OSLCLinks v1.1 package, to apply the packages to your schema, and to configure the DOORS integration with ClearQuest to support the Requirements Change Management feature.


Step 1: Download the package zip files

  • Download the RequirementsChangeRequest v1.0 package, RCR1.0.zip, and save it in a temporary directory, for example, c:\temp
    • Unzip the RCR1.0.zip file in a separate directory, for example, c:\temp\packages. In our example, the following directory structure is created:
      c:\temp\packages\RequirementsChangeRequest\1.0
  • Download the OSLCLinks v1.1 package, OSLCLinks1.1.zip, and save it in a temporary directory, for example, c:\temp
    • Unzip the OSLCLinks1.1.zip file in a separate directory, for example, c:\temp\packages. In our example, the following directory structure is created:
      C:\temp\packages\OSLCLinks\1.1


Step 2: Register the packages

Run the following commands to register each package:

packageutil registerpackage RequirementsChangeRequest 1.0 c:\temp\packages\RequirementsChangeRequest\1.0

packageutil registerpackage OSLCLinks 1.1 c:\temp\packages\OSLCLinks\1.1


Step 3: Apply the RequirementsChangeRequest package to your schema

Use the ClearQuest Designer to apply the RequirementsChangeRequest package to your schema. The OSLCLinks package is automatically applied to your schema when you apply the RequirementsChangeRequest package. Two new record types are added to the schema: RequirementsChangeManagement and ReviewApproved

Check in your schema and upgrade the user database.


Step 4: Configure the DOORS integration with ClearQuest by defining a configuration template
    Use the following values when performing the steps to define a configuration template:
    • In Step 4, use the following format to specify the ClearQuest Change Management Server URL:

    • http://cqwebserver:port/cqweb/oslc
    • In Step 5, after you click Connect, a list of ClearQuest repositories appears.
      • Select a repository. You are prompted for your ClearQuest user name and password.

      • Attention: You must specify a non-blank password. The password field cannot be empty.
      • Select a user database for the integration.
    • In Step 8, perform the following steps:
      • Enter the following states in the Values section:
        Assign, Review, Approved, Applied
      • Select the For ClearQuest option.
      • Enter Apply in the Apply Action Attribute field.
      • Enter Review in the Review Action Attribute field.
    • In Step 9, select RequirementsChangeRequest in the RCR Submit Form section.
  • Use the SampleRCMWorkFlow.doc file included in the Readme.zip file as a reference when you configure the DOORS integration with ClearQuest.

Step 5: Configure the DOORS modules to use with the change management feature

See Chapter 3, Configuring the Change Management Feature, the "Configuring modules for use with the change management feature" section in the Rational DOORS Change Management User's Guide: http://publib.boulder.ibm.com/infocenter/doorshlp/v9/topic/com.ibm.doors.install.doc/topics/doors_int_admin_user.pdf

Accept all the default options.

Step 6: Managing change requirements

See Chapter 5, Managing Change Requirements in the Rational DOORS Change Management User's Guide: http://publib.boulder.ibm.com/infocenter/doorshlp/v9/topic/com.ibm.doors.install.doc/topics/doors_int_admin_user.pdf

Download Package

You can download the ClearQuest RequirmentsChangeRequest v1.0 package and the dependent ClearQuest OSLCLinks v1.1 package by using FTP.

The package downloads contain the English version of the packages only.

Off
[{"DNLabel":"RequirementsChangeRequest.zip","DNDate":"11/9/2010","DNLang":"English","DNSize":"24258","DNPlat":{"label":"Windows","code":"PF033"},"DNURL":"ftp://public.dhe.ibm.com/software/rational/clearquest/7.1.2/RequirementsChangeRequest/RequirementsChangeRequest_1.0.zip","DNURL_FTP":" ","DDURL":null},{"DNLabel":"OSLCLinks.zip","DNDate":"11/9/2010","DNLang":"English","DNSize":"24258","DNPlat":{"label":"Windows","code":"PF033"},"DNURL":"ftp://public.dhe.ibm.com/software/rational/clearquest/7.1.2/RequirementsChangeRequest/OSLCLinks_1.1.zip","DNURL_FTP":" ","DDURL":null}]
[{"Product":{"code":"SSSH5A","label":"Rational ClearQuest"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Component":"Application Lifecycle Management","Platform":[{"code":"PF033","label":"Windows"}],"Version":"7.1.2","Edition":"","Line of Business":{"code":"LOB45","label":"Automation"}}]

Document Information

Modified date:
15 June 2018

UID

swg24028401