IBM Rational Syner= gy for Rational Team Concert Interface 1.2.0.0 iFix001 – Installation = and User’s Guide

IBM Corporation
September 21st, 2015

© Copyright IBM Corporation 2009, 2015
U.S. Government Users Restricted Rights - Use, duplication, or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

= This file contains product information and updates to the IBM® = Rational® Synergy for Rational® Team Concert = Interface 1.2.0.0 iFix001

TABLE OF CONTENTS

1 Introduction.. 1

2 System Requirements & Installation Instructions. 1

3 How the Integration Works. 1

3.1 Rational Syn= ergy. 1

3.2 Rational Team Concert.. 1

3.3 Using Synergy with RTC and Rational Change.. 1

3.3.1 Change Requests from Rational Change. 1

3.3.2 Change Requests from Rational T= eam Concert. 1

3.4 Proxy Object= s. 1

3.5 Queries. 1

3.6 Policies. 1

3.6.1 Work Item Completion requires L= inked Tasks to be Complete. 1

3.6.2 Task Completion requires Linked= Work Item.. 1

4 CLI Commands. 1

4.1 ccm crtool –init.. 1

4.2 ccm crtool –modify. 1

4.3 ccm crtool –list.. 1

4.4 ccm crtool –show... 1

4.5 ccm crtool –default.. 1

5 Administration.. 1

5.1 Restrict which work item types can link to tasks. 1

5.2 Restrict which work item states can link to tasks. 1

5.3 Configure cached attributes for proxy work items. 1

5.4 Server Rename.. 1

5.5 Change Request Tool Admin Object.. 1

5.6 Server Authentication.. 1

6 Client Features. 1

6.1 User Configurable Change Request Tool. 1

6.2 Synergy CLI Client support for RTC. 1

6.3 Synergy Developer Client support for RTC. 1

7 References. 1

8 Limitations and Known Problems. 1

9 Contacting IBM Rational Software Support.. 1

9.1 Prerequisites. 1

9.2 Submitting problems. 1

10 Notices. <= /span>1

10.1 Trademarks. 1

1 Introduction

This document describes integration between Rational Synergy and Rational Team Concert (RTC) where Synergy tasks can be linked directly to RTC work items, work items can be displayed, queried and linked from inside Rational Synergy client.

Enabling the integration requires two steps:

· Install Rational Synergy 7.2.1.4

· Install Rational Synergy for RTC Interface 1.2.0.0 iFix001, which has several components that must be installed individually.

2 System Requirements & Installati= on Instructions

Refer to the document “IBM Rational Synergy for Team Concert Interface 1= .2.0.0 iFix001 Readme” for system requirements and installation instructions.

3 How the Integration Works

3.1 Rational Synergy

Once this integration is enabled on the Synergy client, RTC work items will be reflected in place of Rational Change change-requests. For example:

· Change Requests Explorer Pane

· Change Request Tab on Task Properties Dialog=

· Query Dialog (Find Change Requests)

The appearance of the Rational Synergy client was not changed at all for this integration. Because Rational Synergy tasks can be linked with both Rational Change change-requests and R= TC work items, no labels were modified. “Change Request” is considered as a generic term that can refer to either a CR or a work item.

To distinguish RTC work items from Rational Change change-requests, an attribu= te (pseudo-attribute) called cr_tool= _displayname can be displayed, which will display “Change” or “IBM Rational Team Conce= rt (<projectarea_name>)”. Since a single Synergy task can be linked to both work items and Rational Change change-requests, it is useful= to add this attribute as a column in views such as, Change Request Tab on Task Properties Dialog.

3.2 Rational Team Concert<= /a>

RTC work items stores OSLC URLs of linked Synergy tasks. If the link is followed, post the authentication, a web dialog showing Synergy task properties and associated objects with the task is displayed. From the task properties page, user can open Rational Synergy rich client by clicking the “Show Properties Dialog” button. To brin= g up the task properties dialog from the web dialog, the user must have the Rati= onal Synergy client installed locally.

Example -RTC work item displaying linked Synergy tasks:

Example - Task properties web page:

= 3.3 Using Synergy with RTC and Rational Change<= /span>

There is a notion of a single “a= ctive change request tool”; this is the tool where queries will be run.

However, Rational Synergy database can contain both Rational Change change-requests and RTC work items. Rational Synergy distinguishes Rational Change change-requests and RTC work items and provides all normal operations on them.&nb= sp; For example, opening a work item will open RTC and opening a CR will open Rational Change. Synergy= tasks can be associated to change requests from both RTC and Rational Change, so under the “Change Requests” tab of task properties, all associa= ted change requests are displayed together and the user can still operate on th= em.

3.3.1 Change Requests from Rational Change=

The change requests managed by Rational Change are unaffected by RTC integration. Rational Change change-requests continue to have a cvtype=3D’problem’<= /span> and all objects with that cvtype are managed by Rational C= hange.

3.3.2 Change Requests from Rational Team Con= cert

Change Requests for RTC use reference = (pr= oxy) objects. Those proxy objects shall have “_cr_”= as the cvtype. The change requests that belongs to Rational Change or RTC (multiple project-areas) can be distinguished, by the attribu= te “cr_tool_displayname”.

3.4 Proxy Objec= ts

In order to support nested queries, work items that are related to tasks are represented by proxy objects (or “ghost work items”) inside the Synergy database. A proxy obj= ect has the following attributes by default:

· rtc”)

· Note: If the RTC server is moved, the URLs stored in this field needs to be updated to reflect the new server location.

· version (string), type (string), <= span class=3DCode>subsystem(string) – these four attributes comprise a Synergy object’s unique four-part name.

<= ![if !supportLists]><= span style=3D'mso-list:Ignore'>o&nb= sp; Change requests are not versioned, so the va= lue of version is always “1”.

<= ![if !supportLists]><= span style=3D'mso-list:Ignore'>o&nb= sp; The type is “_cr_”.

<= ![if !supportLists]><= span style=3D'mso-list:Ignore'>o&nb= sp; The subsystem (instance) is the name of the change request tool. (e.g., “<= ![if !supportLists]><= span style=3D'mso-list:Ignore'>o&nb= sp; The name is chosen to be unique for the specified change request tool. For RTC, this is “<= span style=3D'mso-ansi-font-size:11.0pt;mso-bidi-font-size:11.0pt;line-height:11= 5%; font-family:"Courier New"'><tool-name>_<work item number>”, for example, rtc_123000.

For example, the four-part name of a referen= ce to an RTC work item would be “rtc/= _cr_/rtc_123000/1”).

The following additional attributes are defined for work items:

· · · · · owner (string) – The person responsible for the change request.

· · planned_for”= ;.

· · · release”.

· · · These values are copies of the data maintained in RTC and serve as cached values which can be used in Synergy queries. More work item properties can be mapp= ed to attributes in the reference objects. Refer to section “Configure cached attributes for proxy work = items” for configuring the cached attribu= tes.

By using reference objects, the existing logic that Synergy uses for Rational Change change-requests can be leveraged. A task is associated with an RTC w= ork item by creating a relationship from the RTC work item’s reference ob= ject to the task with the name “associated_t= ask” relationship functions normally.

3.5 Quer= ies

New query functions are available to invoke a query remotely in RTC.

crquery(“<query string>”)

This function takes one string argument which is the name of a shared query in R= TC, for example, “Open assigned= to me”. The query is run remotely on RTC, = and the returned results are displayed in Synergy.

Users can create saved queries in Rational Synergy for the RTC shared queries and= add those saved queries to the Change Request Explorer pane on the main view. When the query is executed, all the work-items returned from RTC shall be displayed in Synergy, where as Synergy CLI client shall display only the work-items which has the respective proxy objects available. Queries performed in the GUI are not limited to work items with an existing referen= ce object; this allows users to link tasks with work items not yet referenced = from the Synergy database.

Note: The query name must be RTC shared query name. User-defined RTC queries cannot be referenced.

3.6 Poli= cies

3.6.1 Wo= rk Item Completion requires Linked Tasks to be Complete

RTC work-it= em completion mandates all the linked (that is, associated) Synergy tasks to be completed before the work-item can be marked as complete.

3.6.2 Task Completion requires Linked Work I= tem

Rational Synergy can be configured to allow task completion, only for tasks that hav= e an associated work item (change request) by creating an attribute named “= ;required_attributes” of ty= pe text on the task cvtype with the value “change_request”.

The keyword “change_request” is called as “pseudo attribute”; the attribute does not physica= lly exist. When checking for requ= ired attributes, Synergy interprets the “change_request” keyword by asking “is this task referenced by any has_associated_task relationships?”

4 CLI Commands

The followi= ng commands has been introduced in Synergy 7.2.1.4 release and shall not be available in prior releases.

4.1 ccm crtool –init

This comman= d can be used to configure a new change-request tool for the database. This command = must be run in single user admin mode and requires the current role to be set as “ccm_admin”.

More than o= ne RTC project-area can be integrated with the same Synergy database. This feature= is available in Synergy 7.2.1.4 release onwards. For each RTC project-area integration, the “<= span style=3D'font-family:"Courier New"'>ccm crtool –init” co= mmand needs to be executed.

Command Syntax:

ccm crtool -init tool_name

-url|-rtc_server_url url

-pa|-rtc_project_area_name project_area_name

-admin|-rtc_admin username

([-pw|-rtc_admin_password password] | [-pwprompt])

[-tool_displayname displayname]

[(/types|/allowed_wi_types_to_link types,...)...]

[(/states|/allowed_wi_states_to_link states,...)...]

[(/cache|/cache_attributes attr_names,...)...]

[-default] ([/active] | [/inactive])

-init tool_name

Specifies the change-request tool name= to be used for the integration. The name should be unique across the databases in= the DCM cluster and should follow Synergy naming conventions. The maximum allow= ed characters for the tool name is 16 characters and it cannot contain non-ASC= II characters. By default, the tool-name is converted to lower case. Prior to 7.2.1.4 release, the Synergy database configured with RTC has the default t= ool name as “rtc”. Since Synergy supports to configure more than one RTC project-area to a sin= gle Synergy database, this option can be used to specify the tool-name while configuring the database. The proxy objects created for this integration, s= hall have the instance as this tool-name.

-url|-rtc_server_url url

Specifies the RTC server url where the project-area to be configured with the Synergy database resides.

-pa|-rtc_project_area_name project_area= _name

Specifies the RTC project-area name wh= ich needs to be configured with Synergy database.

-admin|-rtc_admin username

Specifies the RTC user name who has the administrative privileges in the project-area. Synergy uses this account to query and modify the work-items.

([-pw|-rtc_admin_password password] | [= -pwprompt])

Specifies the RTC user’s passwor= d.

[-tool_displayname displayname]<= /b>

Specifies the display-name for the change-request tool. This name shall be used in user display messages where ever applicable. If not specified, then it defaults to “IBM Rational = Team Concert (<project_area_name&= gt;)”.

[(/types|/allowed_wi_types_to_link types,...)...]

Specifies the allowed RTC work-item ty= pes which shall be allowed to associate Synergy tasks. More than one type can be specified by comma separated values. If not specified then all the types ar= e allowed.

[(/states|/allowed_wi_states_to_link states,...)...]

Specifies the allowed RTC work-item st= ates which shall be allowed to associate Synergy tasks. More than one state can = be specified by comma separated values. If not specified then all the states a= re allowed.

[(/cache|/cache_attributes attr_names,...)...]

Specifies th= e list of attributes to be cached as part of the proxy objects apart from the defa= ult list of mapped attributes. More than one attribute can be specified by comma separated values. If not specified then only the default set of attributes shall be cached. Refer to the section Proxy Objects for t= he default set of attributes created on Synergy proxy objects.

The option value should be in the following format: = <r= tc_attribute_id>[:<synergy_attribute_name>]

<rtc_attribute_id><= /span>, is the attribute identifier on RTC work item.

<synergy_attribute_name>, is the attribute name which gets created on Synergy proxy object. Providing Synergy attribute name is optional and if omitted then RTC work item attribute identifier shall = be used as Synergy attribute name for the proxy object.

[-default]

Specifies whether the tool needs to be= set as database default tool or not. By default, the tool shall not be set as database default tool.

([-active] | [-inactive])

Specifies whether the tool needs to be enabled/disabled for the users. By default the tool shall be enabled and us= ers can integrate with the tool.

Example:

ccm crtool –init demo1 –url https://rtcserver.com:9443/ccm -pa “First PA” –admin admin1 –pwprompt<= /span>

Configures a new change-re= quest tool with name “demo1” for the project-area “First PAR= 21;. The tool shall be set as active by default, but not as database default.

ccm crtool –init demo2 –url https://rtcserver.com:9443/ccm -pa “Second PA” –admin admin2 –pwprompt –def= ault –active

Configures a new change-re= quest tool with name “demo2” for the project-area “Second PA”. The tool shall be set as active and database default.

ccm crtool –init demo3 –url https://another_rtcserver.com:9443= /ccm -pa “Third PA” –admin admin3 –pwprompt -inacti= ve

Configures a new change-re= quest tool with name “demo3” for the project-area “Third PAR= 21;. The tool shall be set as inactive. No users can integrate with this tool un= til it is marked as active.

4.2 ccm crtool –modify

Command to = modify the existing change-request tool configurations. This command must be run in single user admin mode and requires the current role to be set as “ccm_admin”.

The tool na= me for Rational Change integration is “cs”. Only “–default, –active and<= span style=3D'font-family:"Courier New"'> –inactive” options = are allowed for modifying Rational Change tool configurations.

Command Syntax:

ccm crtool -m|-modify tool_name

[-url|-rtc_server_url url]

[-pa|-rtc_project_area_name project_area_name]

[-admin|-rtc_admin username]

([-pw|-rtc_admin_password password] | [-pwprompt])

[-tool_displayname displayname]

[(/types|/allowed_wi_types_to_link types,...)...]

[(/states|/allowed_wi_states_to_link states,...)...]

[(/cache|/cache_attributes attr_names,...)...]

[-default] ([/active] | [/inactive])

-m|-modify tool_name

Specifies the change-request tool, whi= ch needs to be modified. The specified tool-name should be one of the existing tools configured in the database.

[-url|-rtc_server_url url]

Specifies the new RTC server url where= the project-area to be configured with the Synergy database resides. This option shall update the RTC server URL stored in the admin object only and shall n= ot update the URLs stored in the proxy objects. If the URL in the proxy objects needs to be updated then follow the section Server Rename.

-pa|-rtc_project_area_name project_area= _name

Specifies the new RTC project-area name which needs to be configured with Synergy database.

[-admin|-rtc_admin username]=

Specifies the new RTC user name who ha= s the administrative privileges in the project-area. Synergy uses this account to query and modify the work-items.

Note: The RTC admin user information s= hall be stored in the $CCM_HOME/etc/ccm.crtool.<tool_name&= gt;.properties file. If the file does not exist, then using this option shall recreate the properties file.

([-pw|-rtc_admin_password password] | [= -pwprompt])

Specifies the RTC user’s passwor= d.

[-tool_displayname displayname]<= /b>

Specifies the new display-name for the change-request tool.

[(/types|/allowed_wi_types_to_link types,...)...]

Specifies a new list of RTC work-item = types which shall be allowed to associate Synergy tasks. More than one type can be specified by comma separated values. Note, the existing values shall be ove= rwritten.

[(/states|/allowed_wi_states_to_link states,...)...]

Specifies a new list of RTC work-item = states which shall be allowed to associate Synergy tasks. More than one state can = be specified by comma separated values. Note, the existing values shall be overwritten.

[(/cache|/cache_attributes attr_names,...)...]

Specifies a new set of attributes to be cached as part of the proxy objects apart from the default set of attributes created on Synergy Proxy Objects. More= than one attribute can be specified by comma separated values. Note, the existing values shall be overwritten.

The option value should be in the following format: = <r= tc_attribute_id>[:<synergy_attribute_name>]

<rtc_attribute_id><= /span>, is the attribute identifier on RTC work item.

<synergy_attribute_name>, is the attribute name which gets created on Synergy proxy object. Providing Synergy attribute name is optional and if omitted then RTC work item attribute identifier shall = be used as Synergy attribute name for the proxy object.

[-default]

Specifies whether the tool needs to be= set as database default tool or not.

([-active] | [-inactive])

Specifies whether the tool needs to be enabled/disabled for the users.

=

4.3 ccm crtool –list=

Command to = list the installed change-request tools in the database. The output of this command would have the following format: %name %displayname %rtc_projectarea %ur= l %active %default

Here,

%name, is the change-reques= t tool name

%displayname, is the change= -request tool’s displayname

%rtc_projectarea, is the RTC project area name used by this tool

%url, is the RTC server url= used by this tool

%active, mentions whether t= he integration is active, that is the tool is enabled to integrate or not=

%default, mentions whether = the change-request tool is database default tool

=

Command Syntax:=

ccm crtool -l|-list ([-active] | [-inac= tive])

-l|-list

Lists all t= he change-request tools configured in the database. By default both the active= and inactive (that is, integration enabled and disabled) change-request tools s= hall be listed.

[-active]

If specifie= d only the active change-request tools shall be listed.

[-inactive]

If specifie= d only the inactive change-request tools shall be listed.

Example:

Ø ccm crtool –list

Name Displayname        =                   RTC Project-area Url        =             &nb= sp;            =    Active Default

cs    IBM Rational Change        =           N/A        =       N/A        =             &nb= sp;            =    FALSE   FALSE=

demo1 IBM Rational Team Concert (First PA) First PA         https://rtcserver.com:9443/ccm         = TRUE    TRUE=

demo2 RTC - Second PA        =             &nb= sp; Second PA    &n= bsp;   https://rtcserver.com:9443/ccm         = TRUE    FALSE

Ø ccm crtool –list –active

Name Displayname        =             &nb= sp;     RTC Project-area Url               =             &nb= sp;        Active Default

demo1 IBM Rational Team Concert (First PA) First PA         https://rtcserver.com:9443/ccm         = TRUE    TRUE=

demo2 RTC - Second PA        =             &nb= sp; Second PA    &n= bsp;   https://rtcserver.com:9443/ccm         = TRUE    FALSE

Ø ccm crtool –list –inactive

Name Displayname        =             &nb= sp;     RTC Project-area Url        =             &nb= sp;            =    Active Default

cs    IBM Rational Change        =          N/A        =       N/A        =             &nb= sp;            =    FALSE   FALSE=

4.4 ccm crtool –show=

Command to = show the change-request tool’s properties.

Command Syntax:=

ccm crtool –s|-sh|-show tool_name=

Example:

Ø ccm crtool –show demo1

Change Request Tool Information:

        Name:        =              demo1

        Displayname:        =       IBM Rational Team Concert (First PA)

        Active:        =            Yes

        Database Default:=          Yes

        Tool Server Url:        = https://rtcserver.com:9443/ccm

        Project-area Name:        First PA

        Allowed Work-item Types:

        =             &nb= sp;     Enhancement

        =             &nb= sp;     Defect

        Allowed Work-item States:

        =             &nb= sp;     In Progress        =             &nb= sp;

        =             &nb= sp;     Reopened

        Custom Mapped Attributes:

        =             &nb= sp;     rtcattr1

        =             &nb= sp;     rtcattr2

&= nbsp;

4.5 ccm crtool –default

Command to = show the change-request tool used by the current Synergy session.

Command Syntax:=

ccm crtool –default

Example:

Ø ccm crtool –default

demo1 IBM Rational Team Concert (First PA)

5 Adminis= tration

5.1 Rest= rict which work item types can link to tasks

Users can configure which work item types can be linked to Synergy tasks. By default, all the work item type= s can be linked to Synergy tasks. This can be changed to allow only certain work = item types to be linked to Synergy tasks by specifying the option “-types|-allowed_wi_types_to_link types<= /span>”, while configuring the database for RTC or after configuring the database for RTC.

For example, if Synergy tasks need to be linked only to work items of type "Story" or "Enhancement" or "Defect", then the value of this option should be as follows:

ccm crtool –init demo1 –url htt= ps://rtcserver.com:9443/ccm -pa “First PA” –admin admin1 –pwprompt –types Story,Enhancement &= #8211;types Defect

ccm crtool –modify d= emo1 –types Story,Enhancement –types Defect

5.2 Rest= rict which work item states can link to tasks

Users can configure which work item states can be linked to Synergy tasks. By default, all the work item stat= es can be linked to Synergy tasks. This can be changed to allow only certain work = item states to be linked to Synergy tasks by specifying the option “-states|-allowed_wi_states_to_link stat= es”, while configuring the database for RTC or after configuring the database for RTC.

For example, if Synergy tasks need to be linked only to work items in the states "In Progress" or "Reopened", then the value of this opt= ion should be as follows:

ccm crtool –init demo1 –url htt= ps://rtcserver.com:9443/ccm -pa “First PA” –admin admin1 –pwprompt –states “In Progress= , Reopened”

ccm crtool –modify d= emo1 –states “In Progr= ess” –states Reopened

5.3 Configure cached attributes for proxy work items

Users can configure a list of attributes that needs to be synchronized from RTC w= ork item to Synergy proxy objects, when the proxy object gets created in Synerg= y. This can be achieved by specifying the option “-cache|-cache_attributes attr_names” while configuring the database for RTC or after configuring the database for RTC.= For example,

ccm crtool –init demo1 –url htt= ps://rtcserver.com:9443/ccm -pa “First PA” –admin admin1 –pwprompt –cache “rtcattr1, rtcattr2:synattr” –cache rtcattr3

ccm crtool –modify demo1 –cache “rtcattr1, rtcattr2:synattr” –cache rtcattr3

= 5.4 Server Rename

If the RTC server is relocated to a different location, t= hen all the references to this URL on the proxy objects in Synergy should be updated. This can be achieved by executing ”ccm update_urls” CLI command= . Synergy CLI should be started in single user admin mode and the role should be set = to ccm_admin to execute this command.

Command Syntax:<= o:p>

    ccm update_urls /rtc [/tool_name tool_name]

        /old_url old_server_url /new_url new_server_url

        attribute_name...

[–tool_name tool_name]

Specifies which tool’s proxy objects needs to be considered. If not specified then all the proxy objects shall be considered, that is all the objects with type “_cr_” shall be considered.

-old_url old_server_ur= l

Specifies= the old server url, which needs to be corrected.

-new_url new_server_ur= l

Specifies the new server url to be set on the proxy objects.

attribute_name...

Specifies the set of attribute names that needs to be considered to be updated.

Example:<= /o:p>

ccm update_urls= –rtc –tool_name demo1 -old_url https://rtcserver.com:9443/ccm -new_url https://new_rtcserver.com:9443/ccm urlattr1 urlattr2

5.5 Change Request Tool Admin Object

Once the database is configured for RTC, there shall be a change request tool ad= min objects created to hold the configuration details of the integration. By de= fault the admin object for Rational Change tool shall be present in the database.= The admin object for Rational Change has the four-part name = cs:1:admin:1. The admin object for= RTC has the four-part name <toolname>:1:admin:1. Here the <toolname>, shall be the c= hange request tool name used while configuring the database for RTC. Prior to 7.2= .1.4 release, the tool name defaults to “rtc”. The following attributes are common to all change request tool admin object= s:

·         Tools -> Start IBM Rational Change or Tools -> Start IBM Rational Team Concert” menu it= em is selected.
Note: If the RTC or Change server is moved, this URL would need to be updated. Check Server Rename section fo= r more information.

·         integration_enable= d (boolean) – Existing attribute from Change. TRUE when the integration= is available in the Synergy GUI. When FALSE, the change request features are hidden.

·         cr_tool_displayname on reference objects for this tool. This attribute is new and does not exist for Change’s admin object. Prior to 7.2.1.4 release, the value defaults to the string “RTC̶= 1;. As multiple project-area configuration is supported from 7.2.1.4 release onwar= ds, the attribute shall have the default value as “Rational Team Concert (<rtc_project_area_name>)= ” and is configurable.

The admin object for RTC has a tool-specific attribute:

·         rt= c_project_area (string) – The name of the RTC project area this connection will acce= ss. Work items and saved queries that Synergy accesses belongs to this project area.

The admin object for Rational Change also has several attributes for managing a= ll change request tools:

·         ·
5.6 Serv= er Authentication

To support Rational Synergy server’s requirement to update RTC work items when the associated tasks are modified, the server needs authentication credentials for RTC. These credentials are stored in the properties file $<= span style=3D'font-family:"Courier New"'>CCM_HOME/etc/ccm.crtool.<tool_name&g= t;.properties. There are two user-editable keys in the properties file, crtool.<tool_name>.server.user and crtool.<tool_name>.serv= er.password, which shall hold the user name and password respectively, of an RTC user who has sufficient privileges to modify Synergy task links on work items.

When the server reads the password property, it will replace with an encrypted password as a security measure. To provide additional security, you can protect the file so that only ccm_root can read (and write) it= .

From 7.2.1.4 release onwards, the CLI command “ccm crtool –modify” can be used to update the RTC username a= nd password for the change-request tool. Also the property “crtool.<tool_name>.synergy.user”, shall take the current synergy user who executes the “ccm crtool –init” co= mmand as value in WINDOWS platform.

6 Client Features

6.1 User Configurable Change Request Tool

By default the users shall= be allowed to integrate with the change-request tool which is configured as the default tool in the database. Users can override this behavior by configuri= ng the tool that they want to integrate for their Synergy session. The property “crtool.user.tool.<db_na= me>=3D<tool_name>” in the properties file “$CC= M_HOME/ccm.user.properties”, can be used to specify the user defined change-request tool. For example, t= he property “crtool.user.tool.= demo_db=3Ddemo” shall integrate the change-request tool “demo” for all the Synergy sessions started for the database “demo_db” in that client ma= chine.

6.2 Syne= rgy CLI Client support for RTC

Rational Synergy CLI client shall support RTC work-items in the same way as Rational Change change-requests for all the supported commands. Only pre-requisite i= s, there should be a proxy object available in the database to perform the required operation.

6.3 Syne= rgy Developer Client support for RTC

Synergy developer client provides a new Change Request option dialog in which the users can configure the RTC user credentials, user defi= ned change-request tool and so on.

To open the Change Request tools option, Select Tools -> Options and choose Change Request tab

In the Default Tool section, it s= hows the default Database Defined t= ool. A user can override this value by specifying a User Defined tool. To set a user defined tool, select the tool = name form that Available Tools list= and click on Set as default button. Using the Properties section, = the user can store the username and password for each tool in the available too= ls list.

User can also set to prompt for a user defined tool each time on Synergy client startup. If Prompt for Change Requ= est tool on Synergy client startup option is enabled, during the Synergy cl= ient startup it will bring up an additional dialog from which user can select the change request tool.

By clicking on the Cancel button, Synergy will use the default tool configured.

7 References

Upgrade RTC = client libraries bundled with Synergy

8 Limitations and Known Problems

Change-request tool name should be unique across databases in the DCM cluster. = If not, the same server side properties file shall be shared between those connections.

In client machine, if the RTC user information is configured for the curr= ent OS user. Any Synergy users starting a session for the database shall a= lso use the configured RTC user credentials.

If a database is moved (packed & unpacked) from one server to another, = then all the configured change-request tool’s properties file needs t= o be copied to the new server. ($= CCM_HOME/etc/ccm.crtool.<tool_name>.properties) Alternatively, the ccm crtool –modify command = can be used to recreate the properties file.

Rational Synergy server needs to be restarted once the database is configured f= or RTC.

Only RTC shared queries can be used from Rational Synergy, user queries are= not supported.

The integration_enabled attribu= te on the cs admin object g= ets set to TRUE, when the Rational Change server is restarted.

DCM for RTC change-requests is not supported.

Baseline compare operation for RTC change-requests is not supported.

Synergy client integrated with RTC, throws URE when the Synergy server is restarted.

Synergy uses RTC 4.0 client libraries to integrate with RTC. As RTC servers al= low the clients to be N-1 version, this integration would work with RTC 4.x and 5.x (verified with 5.0.2) server versions only. The RTC client libraries can be upgraded to later versions by following the tech-note “Upgrade RTC client libraries bundled with Synergy”. Upgra= ding the libraries would require thorough testing before using it in the production environment.

9 Contacting IBM Rational Software Sup= port

If the self-help resources have not provided a resolut= ion to your problem, contact IBM® Rational® Software Support for assistanc= e in resolving product issues.

Note: If = you are a heritage Telelogic customer, a single reference site for all support resources is located at http://www.ibm.com/sof= tware/rational/support/telelogic/

9.1 Prer= equisites

To submit your problem to IBM Rational Software Support, you must have an active Passport Advantage® software maintenance agreem= ent. Passport Advantage is the IBM comprehensive software licensing and software maintenance (product upgrades and technical support) offering. You can enro= ll online in Passport Advantage from http://www.ibm.com/sof= tware/lotus/passportadvantage/howtoenroll.html=

·      =    To learn more about Passport Advantage, visit the Passport Advantage FAQs at http://www.ibm.com/software/lotus/passp= ortadvantage/brochures_faqs_quickguides.html.<= /p>
·      =    For further assistance, contact your IBM representative.

To submit your problem online (from the IBM Web site) to IBM Rational Software Support, you must additionally:

·      =    Be a registered user on the IBM Rational Software Support Web site. For details about registering, go to <= span style=3D'mso-bidi-font-size:11.0pt'>http://www.ibm.com/software/support/.

·      =    Be listed as an authorized caller in the service request tool.

9.2 Subm= itting problems

To submit your problem to IBM Rational Software Support= :

1.     Determine the business impact of your problem. When you report a problem to IBM, you = are asked to supply a severity level. Therefore, you need to understand and ass= ess the business impact of the problem that you are reporting.

Use the following table to determine the severity level.<= /p>

Severity=

Description

1

The problem has a critical business impact: You are unable to use the program, resulting in a critic= al impact on operations. This condition requires an immediate solution.

2

This problem has a significant business impact: The program is usable, but it is severely limited.

3

The problem has some business impact: The program is usable, but less significant features (not critical to operations) are unavailable.=

4

The problem has minimal business impact: The problem causes little impact on operations or a reasonable circumvention to the problem was implemented.

2.     Describe your problem and gather background information. When describing a problem to IBM, be as specific as possible. Include all relevant background informatio= n so that IBM Rational Software Support specialists can help you solve the probl= em efficiently. To save time, know the answers to these questions:<= /span>

·      =    What software versions were you running when the problem occurred?
To determine the exact product name and version, use the option applicable = to you:

o&nb= sp;   Start the IBM Installation Manager and select File > View Installed Packages. = Expand a package group and select a package to see the package name and version nu= mber.

o&nb= sp;   Start your product, and click Help &= gt; About to see the offering name and version number.

·      =    What is your operating system and version number (including any service packs or patches)?

·      =    Do you have logs, traces, and messages that are related to the problem symptom= s?

·      =    Can you recreate the problem? If so, what steps do you perform to recreate the problem?

·      =    Did you make any changes to the system? For example, did you make changes to the hardware, operating system, networking software, or other system components= ?

·      =    Are you currently using a workaround for the problem? If so, be prepared to describe the workaround when you report the problem.

3.     Submit your problem to IBM Rational Software Support. You can submit your problem = to IBM Rational Software Support in the following ways:

·      =    Online<= span style=3D'font-size:9.0pt;font-family:"Arial",sans-serif'>: Go to the IBM Ra= tional Software Support Web site at https://www.ibm.com/software/rational/support/ and in the Rational support task navigator, click Open Service Request. Select the electronic problem reporting tool, and open= a Problem Management Record (PMR), describing the problem accurately in your = own words.

·      =    For more information about opening a service request, go to http://www.ibm.com/software/support/help.html
you can also open an online service request using the IBM Support Assistant. For more information, go to http://www.ibm.com/software/support/isa/faq.html.

·      =    By phone: For the phone num= ber to call in your country or region, go to the IBM directory of worldwide contac= ts at http://www.ibm.com/planetwide/ and click the name of your country or geographic region.

·      =    Through your IBM Representative: If you cannot access IBM Rational Software Support online or by phone, cont= act your IBM Representative. If necessary, your IBM Representative can open a service request for you. You can find complete contact information for each country at http://www.ibm.com/planetwide/.

10 Notices

= This information was developed for products and services offered in the U.S.A. I= BM may not offer the products, services, or features discussed in this documen= t in other countries. Consult your local IBM representative for information on t= he products and services currently available in your area. Any reference to an= IBM product, program, or service is not intended to state or imply that only th= at IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibilit= y to evaluate and verify the operation of any non-IBM product, program, or servi= ce.

IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant = you any license to these patents. You can send written license inquiries to:

IBM Director of Licensing
IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.
For license inquiries regarding double-byte character set (DBCS) informatio= n, contact the IBM Intellectual Property Department in your country or send written inquiries to:

IBM World Trade Asia Corporation
Licensing
2-31 Roppongi 3-chome, Minato-ku
Tokyo 106-0032, Japan

The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law:
INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION ̶= 0;AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDIN= G, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABI= LITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions. Therefore, this statement may not apply to you.

This information could include technical inaccuracies or typographical erro= rs. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice.

Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those = Web sites. The materials at those Web sites are not part of the materials for t= his IBM product and use of those Web sites is at your own risk.

IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Licensees of = this program who wish to have information about it for the purpose of enabling: = (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information wh= ich has been exchanged, should contact:

Intellectual Property Dept. for Rational Software
IBM Corporation
1 Rogers Street
Cambridge, Massachusetts 02142
U.S.A.

Such information may be available, subject to appropriate terms and conditi= ons, including in some cases, payment of a fee.

The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreem= ent, IBM International Program License Agreement or any equivalent agreement bet= ween us.

Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurem= ents may have been estimated through extrapolation. Actual results may vary. Use= rs of this document should verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy = of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products.

This information contains examples of data and reports used in daily busine= ss operations. To illustrate them as completely as possible, the examples incl= ude the names of individuals, companies, brands, and products. All of these nam= es are fictitious and any similarity to the names and addresses used by an act= ual business enterprise is entirely coincidental.

If you are viewing this information softcopy, the photographs and color illustrations may not appear.=

10.1 Tra= demarks

= IBM, the IBM logo, ibm.com, Telelogic, Telelogic Synergy, Telelogic Focal Point, Telelogic DOORS, and Telelogic Change are trademarks or registered trademar= ks of International Business Machines Corporation in the United States, other countrie= s, or both. These and other IBM trademarked terms are marked on their first occurrence in this information with the appropriate symbol (® or ™= ;), indicating US registered or common law trademarks owned by IBM at the time = this information was published. Such trademarks may also be registered or common= law trademarks in other countries. A current list of IBM trademarks is availabl= e on the Web at www.ibm.c= om/legal/copytrade.html.

See copyright notices on the Web at http://www.ibm.com/legal/c= opytrade.html= .

= Microsoft, Windows, and/or other Microsoft products referenced herein are either trade= marks or registered trademarks of Microsoft Corporation.

= UNIX is a registered trademark of The Open Group in the <= st1:country-region w:st=3D"on">United States and other count= ries.

Other company, product or service names may be trademar= ks or service marks of others.

Severity=	Description
1	The problem has a critical business impact: You are unable to use the program, resulting in a critic= al impact on operations. This condition requires an immediate solution.
2	This problem has a significant business impact: The program is usable, but it is severely limited.
3	The problem has some business impact: The program is usable, but less significant features (not critical to operations) are unavailable.=
4	The problem has minimal business impact: The problem causes little impact on operations or a reasonable circumvention to the problem was implemented.