IBM Rational Synchronization
Server 1.4.0.6 – Help |
IBM Corporation |
© Copyright IBM Corporation 2006, 2016
U.S. Government Users Restricted Rights - Use, duplication, or disclosure
restricted by GSA ADP Schedule Contract with IBM Corp.
Synchronization
Server Administration
The Rational Synchronization Server is an extensible framework which can host any number of synchronizer plug-ins written in a compatible way. The Rational Synchronization Server comes with the following synchronizers:
1. Rational Change for Change Interface
2. Rational Change for Rational Team Concert Interface
3. Rational Change for ClearQuest Interface
The following products are required to run the Synchronization Server. See the help for each individual synchronizer for information on products that are supported.
o
IBM JAVA 6 (32-bit)
o Apache Tomcat™ 6.0.x (32-bit)
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.
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.
By checking Log
Debug Messages checkbox, Rational Synchronization Server will automatically
log DEBUG messages into 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.
In the Email Notification section, you can specify the properties needed to enable or disable Email Notification for Synchronization Server. If you choose to enable Email Notification, you must make sure the checkbox Enable Email Notification is enabled. Specify the SMTP Server, From Email Address, and To Email Address(es) to use for email sending. If you choose to disable Email Notification, you must make sure the checkbox Enable Email Notification is disabled and the rest of the properties can be left empty.
Email Notification allows Rational Synchronization Server to automatically send emails to
specific email address(es)
whenever an ERROR is written into the logs.
Attribute value mapping has also been added to Rational Synchronization Server. This feature is only enabled for the following Synchronizers: Rational Change for Change Interface, Rational Change for Rational Team Concert Interface, and Rational Change for ClearQuest Interface.
This feature 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:
o CATALINA_HOME/webapps/TlogicIntegration/WEB-INF/conf/Mapping/changechangeadapter
o CATALINA_HOME/webapps/TlogicIntegration/WEB-INF/conf/Mapping/changertcadapter
o CATALINA_HOME/webapps/TlogicIntegration/WEB-INF/conf/Mapping/cqchangeadapter
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)
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. 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/>
<adapterAttrValue/>
</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.
Please
visit our Telelogic support overview site at: http://www.ibm.com/software/rational/support/telelogic/
You
will find a one-sheet reference guide about how to best contact support in you
geography.
©
Copyright IBM Corporation 2006, 2016.
Programming
interfaces: Intended programming interfaces allow the customer to write
programs to obtain the services of Rational Synchronization Server.
This
information was developed for products and services offered in the
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 (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
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 is for planning purposes only. The information herein is subject to
change before the products described become available.
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.
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.
Each
copy or any portion of these sample programs or any derivative work, must
include a copyright notice as follows:
©
(your company name) (year). Portions of this code are derived from IBM Corp.
Sample Programs. © Copyright IBM Corp. 2006, 2016.
If
you are viewing this information in softcopy, the photographs and color
illustrations may not appear.
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, or 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 each user’s name for purposes of session management. These
cookies can be disabled, but disabling them will also 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”.
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 http://www.ibm.com/legal/copytrade.shtml.