Configuring ClearQuest Web server for cross-server communication

Use the Cross-Server Communication window of the Site Configuration interface to specify a target OSLC service provider with which you want to establish server-to-server communication.

About this task

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

Log on to ClearQuest Web as a user with Super User privileges.
Click Site Administration > Cross-Server Communication on the ClearQuest Web toolbar. The Cross-Server Communication window opens.
Specify the requested information about the target server with which you want to establish communication:
1. 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 RNDG Server to identify a Rational DOORS Next Generation server
  - My CQWeb Server2 to identify another ClearQuest Web server
2. 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. This is a configurable parameter. Following are the default values:
  Rational Team Concert
  Attention: The application context for Rational Team Concert has changed from version 2.0.0.x to version 3.0 and later. You must update the Root Services URI in the Site Administration > Cross-Server Communication window if you previously configured cross-server communication with Rational Team Concert 2.0.0.x and you now want to configure communication with Rational Team Concert 3.0 and later.
  In Rational Team Concert 2.0.0.x: jazz
  
  In Rational Team Concert 3.0 and later: ccm
  
  Rational Quality Manager:
  Attention: The application context for Rational Quality Manager has changed in version 3.0.1 and later. You must update the Root Services URI in the Site Administration > Cross-Server Communication window if you previously configured cross-server communication with an earlier version of Rational Quality Manager.
  In Rational Quality Manager 3.0: jazz
  
  In Rational Quality Manager 3.0.1: qm
  
  Specific versions of Rational Requirements Composer:
  In Rational Requirements Composer 3.0.1: rm
  
  Attention: If a Rational Requirements Composer 2.x project is upgraded to 3.0.1, you must retain the rdm application context instead of using the rm context. See the following topics for details:
  
  http://publib.boulder.ibm.com/infocenter/clmhelp/v3r0m1/topic/com.ibm.jazz.install.doc/topics/c_rrc_limitations.html
  
  http://publib.boulder.ibm.com/infocenter/clmhelp/v3r0m1/topic/com.ibm.jazz.install.doc/topics/c_upgrade_clm_overview.html
  Examples
  
  Here are several examples of Root Services URIs for Jazz server-based OSLC service providers:
  
  https://jazz1.bldg1.india.mycompany.com:9443/ccm/rootservices
  
  https://jazz4.bldg5.japan.mycompany.com:9443/qm/rootservices
  
  https://jazz4.bldg5.spain.mycompany.com:9443/rm/rootservices
  For ClearQuest Web server:
  Attention: The application context for ClearQuest Web server has changed from Rational ClearQuest version 7.1.1 (oslc/cqrest) to version 7.1.2 (cqweb/oslc). You must update any code that uses the ClearQuest OSLC Change Management URI to use the new base URI, as described next. See the ClearQuest OSLC Change Management API Specification at https://jazz.net/wiki/bin/view/Main/RcmRestCmApi for details.
  
  Attention: Configuring ClearQuest Web server communication to use SSL is highly recommended because a user's password is sent in unencrypted text format when the user logs on.
  For ClearQuest versions 7.1.2 and 7.1.2.1:
  Attention: For ClearQuest versions 7.1.2 and 7.1.2.1, SSL is only supported on port 12443. Rich hover does not function when port 12443 is used.
  
  If SSL is configured:
  https://hostname:12443/context/oslc/repo/dbset/discovery
  
  If SSL is not configured:
  http://hostname/context/oslc/repo/dbset/discovery
  
  For ClearQuest version 7.1.2.2:
  If SSL is configured:
  https://hostname/context/oslc/repo/dbset/discovery
  
  If SSL is not configured:
  http://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.
  
  The discovery node in the URI is the ClearQuest Web server equivalent of the Jazz server rootservices URI.
  Example
  
  For ClearQuest version 7.1.2.2, here is an example of a Root Services URI for a ClearQuest Web server-based OSLC service provider configured to use SSL communication:
  
  https://cqweb4.bldg4.china.mycompany.com/cqweb/oslc/repo/mydbset/discovery
3. . 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.
4. 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.
5. Click Request Access. A provisional key is requested on the target server and the access information is added to the Server Friends List section of the page. A new entry is added to the Authorize Provisional Key section.
6. 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:
  1. 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 Approving an OAuth consumer key.
    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.
  2. 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.

Feedback