CQ V7.1.2 + RTC 연계 설정

You can use Collaborative Lifecycle Management (CLM) integrations with products based on Jazz™ technology, including IBM? Rational Team Concert™ and IBM Rational? Quality Manager, to connect the work of all team members.

Collaborative Lifecycle Management integrations provide a common approach to artifact linking, dashboards, security, and user interface frameworks. Cross-product links support traceability, web-like navigation, commenting, and status tracking across project repositories.

Collaborative Lifecycle Management integrations provide the following capabilities:

• Link to existing artifacts across repositories in integrated products; for example, ClearQuest? records are linked to work items and test cases.
• Hover over links to quickly check that status of associated work; for example testers can monitor the status of a defect that they reported to the development team.
• Add a viewlet to a dashboard to report query results from associated projects; for example, you can display requirements that have not been assigned test plans.
• Add comments to any artifact in an integrated repository.

This technote describes how to configure Rational ClearQuest Web to use the Collaborative Lifecycle Management integrations.

I. Applying the OSLCLinks package

I.A. About the OSLCLinks package

With the OSLCLinks package, you can integrate with other Rational products by creating and viewing links between artifacts in the ClearQuest client. For example, you can create links between ClearQuest records, Rational Team Concert work items, and Rational Quality Manager test execution records.


http://www-01.ibm.com/support/docview.wss?&rs=939&uid=swg21433074

I.B. Schema changes after applying the OSLCLinks package

Applying the OSLCLinks package to your schema adds a new stateless record type, OSLCLink, and makes several updates to the selected ClearQuest record types.

The new stateless record type, OSLCLink, includes the following components:

• Three new fields
  o oslcl_link_type (Short String 250)
  o oslcl_label (Short String 250)
  o oslcl_URI (Multiline String)
• Two new type actions, Modify and Delete
• A new OSLCLink form with fields Label, Link Type, and URI

The following changes are made for each user-selected ClearQuest record type:

• New reference_list field oslc_links that references OSLCLink
• New value-changed hook for the oslc_links field that checks for and removes duplicate links
• New Links tab on the submit/modify form. The tab includes a parent-child control that is associated with the oslc_links field. The parent-children control does not include the Add, New, and Delete buttons, and linkType, label and URI are included in the columns of the list control.
• New base action Commit hook that changes the mastership of all associated links when mastership of the parent record changes
• New base action Commit hook that lets you customize the package to participate in a ClearQuest security context system

I.C. Applying the OSLCLinks package

This section describes how to apply the OSLCLinks package to your schema.

Procedure 

1. In the ClearQuest Designer, right-click on the version of the schema where you want to apply the package and select Packages > Apply Package. The Package Wizard opens.

2. Expand the OSLCLinks node in the list of packages and select version 1.0. Click Next.

3. Select the record types where you want to apply the package. Click Finish.

The OSLCLinks package is now applied to the schema you selected. To verify the package installation, look for a new OSLCLinkstateless record type in the schema. 
For more information about applying packages, see the Applying Packages topic (https://publib.boulder.ibm.com/infocenter/cqhelp/v7r1m2/topic/com.ibm.rational.clearquest.schema.ec.doc/topics/t_apply_package.htm) in the ClearQuest information center.

Client behavior

In version 7.1.2 of the ClearQuest Web client, you can add, view, and traverse links.

In version 7.1.2 of the ClearQuest clients for Eclipse and Windows, you can view and traverse links, but you cannot add new links. The same behavior applies to versions of the clients prior to 7.1.2, including the ClearQuest Web client version 7.1.1.n and earlier.

Security context

In some cases, you may want to set up the OSLCLinks package to participate in a ClearQuest security context system (to hide links from unauthorized users, for example). After you apply the OSLCLinks package to your schema, there are additional steps required to set up the new package to work with a security context system.

중략...

II. Configuring ClearQuest Web server for CLM integrations

You must perform several configuration tasks on the ClearQuest Web server and the Jazz server to enable the Collaborative Lifecycle Management (CLM) integrations with Rational Team Concert and Rational Quality Manager. You must perform the same OSLC configuration tasks on two ClearQuest Web servers to allow users to link records between the two servers. The following information is provided in this section:

• Overview of OAuth access
• Configuring the ClearQuest Web server for cross-server communication
• Configuring project relationships
• Approving consumer keys
• Registering an OAuth consumer key

II.A. Overview of OAuth access

The OAuth protocol enables web sites or applications (consumers) to access protected resources from a web service (service provider) through an API without requiring users to disclose their service provider credentials to the consumers. Consumers and service providers communicate with each other and share data by establishing OAuth keys to create friend relationships between the servers and to manage the list of cooperating servers. An approval process is required for approving consumer keys.

The ClearQuest Web server and Jazz server-based products can communicate with each other and share data by configuring OAuth access and establishing a friend relationship. Two ClearQuest Web servers can communicate with each other and share data by using the same mechanism. 

As an administrator, you can request a provisional OAuth consumer key for the ClearQuest Web server to communicate with a target server, store information for accessing other target servers in the ClearQuest Web server friends list, and manage entries in the server friends list.

For more information about the OAuth protocol, see http://oauth.net.

II.B. Configuring the ClearQuest Web server for cross-server communication

Use the Cross-Server Communication window of the Site Configuration utility to specify a target OSLC service provider with which you want to establish server-to-server communication. Enter the location information of the target server and a code phrase to use as the OAuth secret. Then request access to that server to create an OAuth consumer key and store the information in the friends list. Once the OAuth key is authorized by the other server, the ClearQuest Web server can interact with the target server.

Procedure 

1. Log on to ClearQuest Web as a user with Super User privileges. 

2. Click Site Administration > Cross-Server Communication on the ClearQuest Web toolbar. The Cross-Server Communication window opens.

3. Specify the requested information about the target server with which you want to establish communication: 

A. In the Title field, enter a title to identify a target server. For example:
• My RTC Server to identify a Rational Team Concert server
• My RQM Server to identify a Rational Quality Manager server
• My CQWeb Server2 to identify another ClearQuest Web server
B. In the Root Services URI field, enter the URI for the target root services of the application that you want to add as a friend by using the following format:

For Jazz server-based products: 

https://friend-server:port-number/context/rootservices

where the variables have the following meanings:

friend-server Host name of the friend server.
Attention: Be sure to specify the host name by using the public URL with a fully qualified domain name. Do not specify the IP address.


port-number Port number on which to access the server.

context Application context. For example, rtc for the
CLM integration with Rational Team Concert, rqm for the integration with Rational Quality Manager.

Here are several examples of Root Services URIs for Jazz server-based OSLC service providers:
https://jazz1.bldg1.india.mycompany.com:9443/rtc/rootservices

https://jazz4.bldg5.japan.mycompany.com:9443/rqm/rootservices

For ClearQuest Web server: 

https://hostname/context/oslc/repo/dbset/discovery

where the variables have the following meanings:

hostname Host name of the friend server.
Attention: Be sure to specify the host name by using the public URL with a fully qualified domain name. Do not specify the IP address.

context Application context. For example, cqweb for
ClearQuest Web server. 

dbset Repository (database set) name.
Note: The discovery node in the URI is ClearQuest Web server equivalent of the Jazz server rootservices node.

Here’s an example of a Root Services URI for ClearQuest Web server-based OSLC service provider:
https://cqweb4.bldg4.china.mycompany.com:9443/cqweb/oslc/repo/mydbset/discovery

C. In the OAuth Secret and Re-type Secret fields, enter an OAuth Secret code phrase to associate with the new OAuth consumer key. 

Attention: In this step, you do not enter the key itself; you enter a shorter phrase to associate with the key.

D. Optional: Select the Trusted check box. Trusted consumers can share authorization with other trusted consumers and do not require user approval to access data.

Attention: For external products or web sites, it is a best practice to clear the Trusted check box.

E. Click Request Access. A provisional key is requested on the target server and the access information is added to the Server Friends Listsection of the page. A new entry is added to the Authorize Provisional Key section.

F. Authorize the provisional OAuth consumer key.
At this point, the access request is not authorized on the target server. Use one of the following methods to approve the request:

i. Click Grant access for the provisional key if this link appears in the Authorize Provisional Key section and you have administrator privileges (member of the JazzAdmins group for Jazz-based servers) on the target server. If the target server is a Jazz-based server, see the Rational Team Concert help for instructions on authorizing a provisional key. If the target server is another ClearQuest Web server, see II.E. Approving consumer keys.
Note: The Grant access for the provisional key link does not appear if the OAuth provider does not provide an authorization URI. Rational ClearQuest and Rational Team Concert might provide this link; Rational Quality Manager does not. You must choose option ii below if the Grant access for the provisional key link does not appear in the Authorize Provisional Key section or you do not have administrator privileges on the target server.

ii. Record the provisional key value. If you have administrator privileges on the target server, you can log on to the target server and approve the request by yourself. Otherwise, you must ask a target server administrator to approve your request. You might need to provide the provisional key value to the target server administrator.

II.C. Configuring project relationships

After configuring the ClearQuest Web server for cross-server communication, configure project relationship links. These links represent relationships between projects and service providers such as projects on other servers. Link types reflect the nature of the service that a provider makes available to the project. Establishing a project link enables linking between artifacts in the project and artifacts that the service provider makes accessible.

Procedure 
1. Click Site Administration > Project Relationships on the ClearQuest Web toolbar. The Project Relationships window opens.
2. Select a server from the Server list to create a link with the ClearQuest Web application. An authentication window might open that prompts for credentials for the remote service. Enter the user name and password and then click OK.
3. Select a service provider from the Service Providers list.
4. Click Add to add the project relationship link. Project relationship links appear in the Project Relationship section of the page.

II.D. Configuring the target server for cross-server communication

You must configure the target OSLC service provider for cross-server communication back to the ClearQuest Web server to complete configuring ClearQuest Web for the Collaborative Lifecycle Management integration. If the target OSLC service provider is a Jazz-based server, see the Rational Team Concert help topics that discuss configuring cross-server communication. For example, for Rational Team Concert version 2.0.0.2, seehttp://publib.boulder.ibm.com/infocenter/rtc/v2r0m0/topic/com.ibm.jazz.repository.web.admin.doc/topics/tservertoserverconfig.html. If the target OSLC service provider is another ClearQuest Web server, repeat the instructions in sections II.B and II.C of this document.

II.E. Approving consumer keys

If an administrator on the Jazz server is configuring cross-server communication with the ClearQuest Web server and the administrator does not have Super User privileges on the ClearQuest Web server, the ClearQuest Web administrator can use the OAuth Consumer Management window to approve the provisional consumer key.

Procedure: 
1. Click Site Administration > OAuth Consumer Management on the ClearQuest Web toolbar. The OAuth Consumer Management window opens.
2. View the Provisional Keys section for new requests.
3. Select Approve or Reject for a request.

II.F. Registering an OAuth consumer key

You can register an OAuth consumer’s secret to create a new consumer key. Use this function when the OAuth consumer does not have an interface to request access to ClearQuest Web, for example, non-Jazz-based clients (consumers) that want to access OSLC links by using the OAuth protocol.

Procedure 
1. Click Site Administration > OAuth Consumer Management on the ClearQuest Web toolbar. The OAuth Consumer Management window opens.
2. In the Consumer Name field, enter the name of the consumer that uses the consumer key. For example, oslcapplication.bldg5.japan.companyA.com
3. In the Consumer Key field, enter the OAuth key value to be associated with the consumer.
4. In the Consumer Secret and Re-type Consumer Secret fields, enter the consumer secret provided by the Jazz server administrator. 

Attention: In this step, you do not enter the key itself; you enter a shorter phrase to associate with the key.

5. Optional: Select the Trusted check box. Trusted consumers can share authorization with other trusted consumers and do not require user approval to access data. 

Attention: For external products or web sites, it is a best practice to clear the Trusted check box.

6. Click Register. The new key appears in the Authorized Keys section of the page.

II.G. Creating, viewing, and traversing links between CLM applications

After you have completed the steps described in Section II of this document, you can create, view, and traverse OSLC links between Collaborative Lifecycle Management applications. See the end-user documentation for your application for information on creating, viewing, and traversing OSLC links.