IBM Rational® Synergy for Team Concert Interface 1.2 Readme

IBM Corporation
September 3rd, 2013

 

 

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

It is divided into the following sections:

To access the latest news and information on the Rational Synergy for Team Concert Interface Web site, go to www.ibm.com/software/rational/support/.


System requirements

  • One of the following operating systems installed on your computer:
    • Windows® 7 Enterprise
    • Windows® Server 2003 or 2008
    • Red Hat® Enterprise Linux® 6
    • SUSE Linux Enterprise Server 11
  • IBM Rational Team Concert: Server
    • 3.0.1 or Higher
    • 4.0.3
  • IBM Rational Team Concert: Client (32 bit)
    • 3.0.1
    • 4.0.3
  • One of the following versions of IBM Rational Synergy:
    • 7.2.1
  • IBM JDK 6, 32-bit

For additional information about system requirements, including recommended configurations, visit the Rational Synergy Change Support Web site at http://www-01.ibm.com/software/awdtools/synergy/support/

Available features in version

This version of the interface contains the following components:

o    Rational Synergy for Eclipse Interface. This component can be used to perform version control operations using Rational Synergy from inside the RTC Eclipse client.

o    Rational Synergy and RTC Bridge. This component can be used to link RTC Work Items to Synergy tasks from within the Rational Synergy client.

o    Rational Synergy and RTC Synchronizer. This component can be used to export Synergy Repository Projects  to RTC Repository

Installing Rational Synergy for Team Concert Interface

1.    Install and configure Rational Synergy (per server)

Install the supported version of Rational Synergy or upgrade an existing installation. Please refer to the Rational Synergy Information Center for installation instructions.

You must configure each Rational Synergy database that will use the Rational Synergy and RTC Bridge, as described below.

·         Rational Synergy bundles Rational Team Concert 4.0 compatible jar files. If you need to use the interface with version 3.0.x, perform the following steps:

o   Download Plain Java Client libraries for Rational Team Concert 3.0.x

o   Unzip the jar files to a location on your system.

o   Edit the file CCM_HOME/etc/ccm.crtool.rtc.properties and modify the value of crtool.jardir.rtc to point to RTC 3.0.x jar files. For example:

crtool.jardir.rtc=D:\\PlainJava301

·         Run the script setup_rtc present in CCM_HOME/bin. You will need to pass the Synergy database path, your Rational Team Concert server URL, Project Area, User Id and Password. For example:

setup_rtc \\<Synergy_Server>\ccmdb\base71_rtc https://<RTC_Server>:9443/ccm Sync <RTC_Admin_Id> <RTC_Admin_Password>

Where RTC_Admin_Id and RTC_Admin_Password are user id and password for an Admin user in RTC. Rational Synergy uses this account to communicate with RTC and modify work items.

2.    Install and configure Rational Team Concert Server (per server)

Download and install a supported version of the Rational Team Concert server and configure the Server and CCM application.

The RTC Server Public URI should be a fully qualified name. For example, use https://<RTC_SERVER_NAME>.<RTC_SERVER_DOMAIN>:9443/ccm. Do not use https://localhost:9443/ccm.

3.    Install Rational Synergy client (per user)

Install a supported version of the Rational Synergy client on the same system where you will be running this interface.

Edit the file ccm.user.properties and specify the following properties, if not present already:

crtool.user.tool.<db name>=rtc

crtool.rtc.user.name=<RTC_User_Id>

crtool.rtc.user.password =<RTC_ User_Password>

where RTC_User_Id and RTC_User_Password are the user id and password for this end user in RTC. Rational Synergy uses this account to retrieve the user's list of assigned work items.

Note: From 7.2.1.2 release onwards, setting the client side RTC user name and password shall be done through executing the script $CCM_HOME/bin/setup_client_rtc_user. This script shall create a file with name .ccmrtcuser under the user’s home directory, which stores the RTC user name and password. The password shall be stored in encrypted format.

If the user details are updated in the ccm.user.properties file prior to 7.2.1.2 release, then the setup_client_rtc_user script needs to be run again to set the user details in .ccmrtcuser file.

4.    Install and configure Rational Team Concert Client (per user)

Install a supported version of the Rational Team Concert client on the same machine where you will be running this interface.

After you have installed Rational Team Concert client, configure it use JRE 1.6 from Rational Synergy installation.

Modify the eclipse.ini in <RTC_INSTALL_DIR>\jazz\client\eclipse, where RTC_INSTALL_DIR is the directory containing Rational Team Concert.

o    Change the -vm argument to the location of the IBM JRE 1.6.

o    Set the -Dosgi.requiredJavaVersion= argument to 1.6.

Note: You do not need to modify eclipse.ini for JRE if you are using Rational Team Concert 4.0.

5.    Installing the interface - Rational Team Concert client side

·         The installer is located under CCM_HOME's integrations\teamconcert folder.

·         Locate the update site \client\synergyrtcbridge

·         Use  Rational Team Concert menu Help->Install New Software… to install the update site from \client\synergyrtcbridge.

The installer for this interface contains two client side components.

IBM Rational Synergy for Eclipse Interface

Rational Synergy for Team Concert Interface

 

Both of these components need to be installed in the Rational Team Concert Eclipse Client.

6.    Installing the interface - Rational Team Concert server side

The installer for the interface contains two server side components.

<CCM_HOME>\integrations\teamconcert\server\ synergylinktype

<CCM_HOME>\integrations\teamconcert\server\SynergyParticipantUpdatesite

 

Both of these components need to be installed in the Rational Team Concert server.

1.    The "synergylinktype" component is an update site with the directory structure as shown below.

                synergylinktype

                               |____features

                               |              |____com.ibm.rational.synergy.integration.rtcbridge.synergylinktypefeature_2.0.0.jar

                               |____plugins

                               |              |____com.ibm.rational.synergy.integration.rtcbridge.synergylinktypeplugin_2.0.0.jar

                               |____site.xml

 

2.    The “SynergyParticipantUpdatesite” component is an update site with the directory structure as shown below.

            SynergyParticipantUpdatesite

                           |___features

                           |         |____ com.ibm.rational.synergy.integration.rtcbridge.synergyparticipantFeature_1.0.0.<buildnum>.jar

                           |___plugins

                                     |___ com.ibm.rational.synergy.integration.rtcbridge.synergyparticipant_1.0.0.<buildnum>.jar 

       |___ com.ibm.rational.synergy.integration.rtcbridge.synergyqueue_1.0.0.<buildnum>.jar

       |___com.ibm.rational.synergy.integration.rtcbridge.synergywiadvisor_1.0.0.<buildnum>.jar

                    |___site.xml                 

                 

                  Follow the steps below to install these server side components -

·         Start Rational Team Concert Server.

·         Using a web browser go to the URL http://<RTCServer>:<Port>/ccm/admin/cmd/requestReset. Where RTCServer is the fully qualified name your Rational Team Concert Server and Port is the port. For example https://bob-rtcserver.mydomain.ibm.com:9443/ccm/admin/cmd/requestReset. Login to the server and you will get a message saying "The Jazz Server has been flagged to reset and reload from the configured update-site when it is next restarted".

·         Close the browser and shut down the RTC server.

·         Place the update sites synergylinktype  and SynergyParticipantUpdatesite into RTC server installation directory <RTCinstallDir>\server\conf\ccm\sites

·         Go to <RTCinstallDir>\server\conf\ccm\provision_profiles

·         Copy profile.ini and paste it in the same directory, then rename the file to synergylinktype-profile.ini

·         Open the synergylinktype-profile.ini and edit the url and featureid as shown below:

o    url=file:ccm/sites/synergylinktype

o    featureid=com.ibm.rational.synergy.integration.rtcbridge.synergylinktypefeature

·         Copy profile.ini and paste it in the same directory, then rename the file to SynergyParticipantUpdatesite-profile.ini

·         Open the SynergyParticipantUpdatesite-profile.ini and edit the url and featureid as shown below:

o    url=file:ccm/sites/SynergyParticipantUpdatesite

o    featureid=com.ibm.rational.synergy.integration.rtcbridge.synergyparticipantFeature

·         Start RTC server.

7.    Project Area Process Configuration

Select the Project Area for which you want to enable this interface and configure it as described below -  

Using RTC Eclipse client connect to the RTC Server. You must have Admin role for to perform this process configuration.

·         In the Team Artifact View, select the Project Area that will be used by this integration

·         Right Click and select Open

·         Select Operation Behavior  in Team Configuration

·         Click Process Configuration Tab

·         In the list of Operations scroll to the bottom where you should see Save Work Item (server) listed

·         Click the column everyone (default) in the Save Work Item (server) row.

·         Preconditions actions (xx available) --- Click Add button to select precondition WorkitemProhibitSave and press OK

·         Follow-up actions (xx available) -- Click Add button to select follow-up action SynergySaveParticipant and then press OK

·         The above precondition and follow-up actions will not be available to configure, if the Server-side Plug-ins are not installed correctly.

 

8.    Installing Synchronizer (Optional)

This interface contains Rational Synergy and Rational Team Concert source code synchronizer component. You need to install on the machine which is used by the build manager and running RTC client.

You typically need only one installation of the Synchronizer.

 

To install this component, follow the steps below –

 

·         The installer assumes that you have already installed the bridge part of this interface which would have also installed the help. The bridge component is available as update site which you can find at <CCM_HOME>\integrations\teamconcert\client\ synergyrtcbridge.

·         Install the client side of the Synchronizer. Locate the update site at <CCM_HOME>\integrations\teamconcert\client\SynergyExportUpdateSite. Use RTC menu Help->Install New Software… to install the update site.

·         This component requires JDK 1.6 32-bit. Please install JDK 1.6 before installing the synchronizer.

Note: You do not need to install JDK 1.6 if you are using RTC 4.0.

·         This component also needs Rational Team Concert Build System. Please install the right version of Build System for your installation of RTC.

·         Navigate to the directory <CCM_HOME>\ integrations\teamconcert\synchronizer and choose the installer for your platform.

·         Follow the installation wizard to install the Synchronizer.

·         Refer to help on the Synchronizer help for configuration and further details.

Uninstalling the Interface

Use the standard Eclipse un-installation mechanism to uninstall the features that you installed using update site. The Synchronizer can be uninstalled using “Add or Remove Programs” or “Programs and Features” from the control panel on Windows 

On Linux, run the uninstaller for Synergy_RTC_Interface_1_2 created during installation. 

References

·         IBM Rational Synergy for Rational Team Concert Bridge Connector

o    Part-1: https://jazz.net/library/article/1402

o    Part-2: https://jazz.net/library/article/1403

Limitations and Known Problems

This version of the interface has following known problems or the limited support:

Rational Synergy and RTC Bridge:

  • Drag Drop of Synergy Task to RTC Workitem doesn't associate the tasks to the Workitem.
  • If a RTC Workitem has tasks of old format (prior to Synergy 7.1.0.7), refreshing the views would not update the tasks to have OSLC format. Using the context menu option 'Update Synergy Tasks Links' would resolve the issue.
  • If the Synergy client is integrated with RTC and when the Synergy server is restarted, an error is thrown in the client. Synergy client needs to be restarted to resolve the problem. This issue is not seen in RTC Eclipse client.

Rational Synergy and RTC Synchronizer:

  • The RTC-Synergy Synchronizer does not work with 64-bit JDK.
  • Once a synchronization stream has been created in RTC for a Synergy project, do not modify the project name in Synergy or viceversa.
  • Synchronization might not work when reverted to older snapshots.
  • Synergy restricted characters cannot be used in file names within RTC . For a list of restricted characters in Synergy, refer to http://www.ibm.com/support/docview.wss?uid=swg21326060
  • If you modify any of the synchronization stream properties, restart the build system for it to take effect.
  • To avoid synchronization process virtual memory limitations, it is best to initially select synchronization roots such that each root has no more than 50,000 files below it. Once these roots have been successfully imported, then you can select a parent synchronization root that is located above all of the initial synchronization roots. Once that parent has been imported, the children synchronization roots can be removed from the list of synchronization roots for that synchronized stream.
  • Rational Team Concert does not have the ability to re-use the same file in multiple components. If you have used a file in more than one Synergy project and you synchronize that project to Team Concert, the re-used file will be treated as separate and distinct files in Team Concert.
  • The Synergy Synchronized Streams view can sometimes report a synchronization success or a blocked synchronization before the Build Results have been updated. To work around this problem, right-click the stream and click Latest Synchronization Details. Refresh the build Summary page to update the synchronization status.
  • Most synchronization failures or blocks occur because process controls in one repository reject a change made in the other repository. The message in the log from Rational® Synergy ( if Rational Synergy rejected the change) or Rational Team Concert™ process (if Rational Team Concert rejected the change) tells you what went wrong. Fix the problem, and run the synchronize operation again.
  • Synchronization blocks can also be caused by network errors (failure to contact one repository or another), permissions errors (the synchronization process Jazz™ account does not have sufficient rights in the Jazz repository, or the synchronization process itself is running with credentials that do not allow access to the specified Rational Synergy stream), or both. The details of the error messages are different for different cases. Fix the problem, and then run the synchronize operation again.
  • When you change the Jazz Provider Properties of a Synergy Synchronized Stream, you might see a Save workspace failed message in the Team Advisor view. You can ignore the message.

Contacting IBM Rational Software Support

If the self-help resources have not provided a resolution to your problem, you can contact IBM® Software Support. IBM Software Support provides assistance in resolving product issues.

For more details about enrolling in Passport Advantage and submitting problems, see the “Contacting IBM Software Support” topic in the Rational Synergy information center at http://pic.dhe.ibm.com/infocenter/synhelp/v7m2r0/topic/com.ibm.help.common.rational.doc/topics/t_contactingibmsoftwaresupport.html.

 

Notices

 

© Copyright IBM Corporation 2009, 2013.

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

This information was developed for products and services offered in the U.S.A.

IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the 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 that 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 responsibility to evaluate and verify the operation of any non-IBM product, program, or service.

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 license inquiries, in writing, 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) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to:

Intellectual Property Licensing

Legal and Intellectual Property Law

IBM Japan, Ltd.

19-21, Nihonbashi-Hakozakicho, Chuo-ku

Tokyo 103-8510, 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 "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY 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 errors. 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 websites are provided for convenience only and do not in any manner serve as an endorsement of those websites. The materials at those websites are not part of the materials for this IBM product and use of those websites 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 which has been exchanged, should contact:

Intellectual Property Dept. for Rational Software

IBM Corporation

5 Technology Park Drive

Westford, MA  01886

U.S.A.

 

Such information may be available, subject to appropriate terms and conditions, 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 Agreement, IBM International Program License Agreement or any equivalent agreement between 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 measurements may have been estimated through extrapolation. Actual results may vary. Users 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.

All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only.

This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental.

Copyright license

This information contains sample application programs in source language, which illustrate programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs. The sample programs are provided "AS IS", without warranty of any kind. IBM shall not be liable for any damages arising out of your use of the sample programs.

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

Privacy policy considerations

IBM Software products, including software as a service solutions, (“Software Offerings”) may use cookies or other technologies to collect product usage information, to help improve the end user experience, to tailor interactions with the end user or for other purposes. In many cases no personally identifiable information is collected by the Software Offerings. Some of our Software Offerings can help enable you to collect personally identifiable information. If this Software Offering uses cookies to collect personally identifiable information, specific information about this offering’s use of cookies is set forth below.

Depending upon the configurations deployed, this Software Offering may use session cookies that collect personally identifiable information for purposes of session management, authentication, and enhanced user usability. These cookies can be disabled, but disabling them will also likely eliminate the functionality they enable.

If the configurations deployed for this Software Offering provide you as customer the ability to collect personally identifiable information from end users via cookies and other technologies, you should seek your own legal advice about any laws applicable to such data collection, including any requirements for notice and consent.

For more information about the use of various technologies, including cookies, for these purposes, See IBM’s Privacy Policy at http://www.ibm.com/privacy and IBM’s Online Privacy Statement at http://www.ibm.com/privacy/details/us/en sections entitled “Cookies, Web Beacons and Other Technologies” and “Software Products and Software-as-a Service”.

Trademark acknowledgments

IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the web at www.ibm.com/legal/copytrade.shtml.