Rational Synchronization Server Help
Release 1.4.0.4
Part Number:
MN-SCH-IV-TSF12-08-06
Contents
Synchronization
Server Administration
Contacting IBM
Rational Software Support
The Rational Synchronization Server is an extensible framework which can host any number of synchronizer plug-ins written in a compatible way. The 1.4.0.4 version of the Synchronization Server comes with the following six synchronizers:
1. Rational Change for Change Interface
2. Rational Change for Focal Point Interface
3. Rational DOORS for Focal Point Interface
4. Rational Focal Point for Focal Point Interface
5. Rational Change for Rational Team Concert Interface
6. Rational Change for ClearQuest Interface
© Copyright IBM Corporation 2006, 2013
US 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 written license inquiries to:
IBM Director of Licensing
IBM Corporation
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 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 “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 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 this 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 which 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 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.
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.
If you are viewing this information softcopy, the photographs and color illustrations may not appear.
Licensee's use of this software temporarily consumes one license of each IBM Program identified in the Typical or Custom installation option, as applicable; Licensee agrees it may not have use of such affected IBM Programs until synchronization is completed.
See http://www.ibm.com/legal/copytrade.html.
The following products are required to run the Synchronization Server. See the help for each individual synchronizer for information on products that are supported.
To configure the Synchronization Server, you can use the web-based administration interface. You can access the admin interface by pointing your web browser at http://localhost:<port>/TlogicIntegration/admin/SyncFramework.html, where <port> is the port number your Tomcat server is running on. You will be required to login to access the admin interface. Any user that has “administrator” role in Tomcat is valid. Tomcat users are defined in CATALINA_HOME/conf/tomcat-users.xml.
You can obtain this document and help on the Synchronizers using the admin interface as well.
To start or stop synchronizers, click the Start/Stop link on the left side of the screen. All existing synchronizers and their respective statuses will be listed in the table as shown below:
If a synchronizer is not running, a Start button will be displayed in its row. Clicking Start will start the synchronizer thread, and it will automatically synchronize on the time and date specified in the Next Sync Time field. Clicking Stop will stop the thread from running.
Clicking Open will display the log file for that synchronizer (if it exists). The log can be manually refreshed by clicking Refresh. The Clear operation will permanently delete the contents of the log.
To configure a synchronizer, click the link for that synchronizer in the Installed Synchronizers section, and then click Configure. Detailed instructions for configuring each synchronizer are provided in the help for that synchronizer.
Email Notification allows Rational Synchronization Server to automatically send emails to specific email address(es) whenever an ERROR is written into the logs. This feature must be configured in order for Email Notification to work properly. You may also choose to disable Email Notification, which means that no emails will be sent when an ERROR occurs.
o Attribute Value Mapping allows users to map Rational Change attribute values to Adapter attribute values. The mappings will be specified by using a specific XML file.
· For each configuration of a Synchronizer, there can only be one Attribute Value Mapping XML defined.
· The XML file must be manually created by the user in one of the following directories depending on the Synchronizer used:
· CATALINA_HOME/webapps/TlogicIntegration/WEB-INF/conf/Mapping/changechangeadapter
· CATALINA_HOME/webapps/TlogicIntegration/WEB-INF/conf/Mapping/changertcadapter
· CATALINA_HOME/webapps/TlogicIntegration/WEB-INF/conf/Mapping/cqchangeadapter
o The XML file MUST have the exact same name as the Synchronizer’s Link File Name, which is located in the Links directory. (i.e. For a Rational Change for Rational Team Concert Interface synchronizer, the Attribute Value Mapping XML must have a name similar to rtcadapter_link_MMddyyyyHHmmss.xml)
o The attributes that should be defined in the Attribute Value Mapping XML should be attributes that have values that may be selected from a list box.
o Users must define the Attribute Value Mapping XML in the following format:
<?xml version="1.0" encoding="UTF-8"
standalone="yes"?>
<attrValueMap>
<valuePair>
<changeAttrId/>
<adapterAttrId/>
<changeAttrValue/>
<adapterAttrValue/>
</valuePair>
<valuePair>
<changeAttrId/>
<adapterAttrId/>
<changeAttrValue/>
<adapterAttrValu />
</valuePair>
.
.
.
</attrValueMap>
changeAttrId is the ID of the Rational Change attribute and not the display name.
adapterAttrId is the ID of the Adapter attribute and not the display name.
changeAttrValue is the Rational Change attribute value that will be mapped to a corresponding Adapter attribute value.
adapterAttrValue
is the Adapter attribute value that
will be mapped to a corresponding Rational
Change attribute value.
Example:
<?xml
version="1.0" encoding="UTF-8"
standalone="yes"?>
<attrValueMap>
<valuePair>
<changeAttrId>priority</changeAttrId>
<adapterAttrId>internalPriority</adapterAttrId>
<changeAttrValue>1</changeAttrValue>
<adapterAttrValue>High</adapterAttrValue>
</valuePair>
<valuePair>
<changeAttrId>priority</changeAttrId>
<adapterAttrId>internalPriority</adapterAttrId>
<changeAttrValue>2</changeAttrValue>
<adapterAttrValue>Medium</adapterAttrValue>
</valuePair>
</attrValueMap>
Logs for the Synchronization Server synchronizers are located at CATALINA_HOME/webapps/TlogicIntegration/WEB-INF/logs. These logs should be sent to IBM Support to help diagnose the cause of any errors.
If the self-help resources have not provided a
resolution to your problem, you can contact IBM® Rational® Software
Support for assistance in resolving product issues.
Note:
If you are a heritage Telelogic customer, a single reference site for
support resources is located at http://www.ibm.com/software/rational/support/telelogic/
To submit your problem to IBM Rational Software Support, you must
have an active Passport Advantage® software maintenance agreement. Passport Advantage is the IBM comprehensive
software licensing and software maintenance (product upgrades and technical
support) offering. You can enroll online
in Passport Advantage from http://www.ibm.com/software/lotus/passportadvantage/howtoenroll.html
To submit your problem online (from the IBM Web site) to IBM
Rational Software Support, you must additionally:
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 assess the business impact of the problem that you are
reporting.
Use the following table to determine the severity level.
Severity |
Description |
1 |
The problem has a critical business impact:
You are unable to use the program, resulting in a critical 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 information so that IBM Rational Software Support specialists can
help you solve the problem efficiently. To save time, know the answers to these
questions:
o
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 number.
o
Start your product,
and click Help > About to see the
offering name and version number.
3. Submit your problem to IBM Rational Software Support. You can
submit your problem to IBM Rational Software Support in the following ways:
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.