Telelogic Synchronization Framework Help
Telelogic Synchronization Framework Help
Release 1.2
Part Number: MN-SCH-IV-TSF12-08-06
This document contains confidential and proprietary information that belongs to Telelogic AB. Using any of
the information contained herein or copying or imaging all or part of this document by any means is strictly
forbidden without express written consent of Telelogic AB
Telelogic Synchronization Framework 1.2
TABLE OF CONTENTS
Introduction................................................................................................................................3
About the Integration...........................................................................................................3
Product Requirements..............................................................................................................3
Installation Instructions............................................................................................................3
Uninstalling the Integration......................................................................................................6
Synchronization Framework Administration..........................................................................6
Troubleshooting ........................................................................................................................8
Telelogic Support ......................................................................................................................8
Page 2 of 8
Copyright © 2006-2008 Telelogic AB
Telelogic Synchronization Framework 1.2
Introduction
About the Integration
The Telelogic Synchronization Framework is an extensible framework which can host any number of
synchronizer plug-ins that are written in a compatible way. The 1.2 version of the framework comes with the
following three synchronizers:
1. Change – Change Synchronizer
2. Focal Point – DOORS Synchronizer
3. Change – Change Synchronizer.
Product Requirements
The following products are required to run the Synchronization Framework. See the help for each individual
synchronizer for information on products that are supported.
•
Apache Tomcat 5.5.x server
•
Sun Java 5 Runtime or JDK
Installation Instructions
Prior to installation, ensure that you have the following environment variables set correctly:
•
JAVA_HOME – path to a Sun Java 5 JDK
OR
•
JRE_HOME – path to a Sun Java 5 Runtime Environment
•
CATALINA_HOME – path to your Tomcat installation
•
DOORS_HOME – path to a DOORS client installation. This variable is only required if you will
be installing the DOORS – Focal Point synchronizer.
After you have verified your environment, run the correct binary for your platform. For windows, run
setupwin32.exe. For Linux, run setuplinux.bin. For Solaris, run setupsolarisSparc.bin.
Note: When installing on Windows, Telelogic recommends that you do not install the Synchronization
Framework on the same Tomcat installation where Focal Point is installed. When installing on Linux
and Solaris, you must install the Synchronization Framework on a separate Tomcat installation from
Focal Point.
After the installation program initializes, you will be presented with a welcome screen. Click Next to
continue.
Page 3 of 8
Copyright © 2006-2008 Telelogic AB
Telelogic Synchronization Framework 1.2
Next you will be asked to choose the type of installation you’d like. Choosing Typical will install the
Synchronization Framework along with both the Focal Point – Change synchronizer, the Focal Point –
DOORS synchronizer, and the Change – Change synchronizer. Choosing Custom will al ow you to
determine which components you’d like to install. Click Next when you’ve made your selection.
Page 4 of 8
Copyright © 2006-2008 Telelogic AB
Telelogic Synchronization Framework 1.2
You will be presented with the list of components that will be installed. You may change the components
you want installed by clicking in the box next to the name. Click Next when you are satisfied with the
components that will be installed.
Next, you will see a summary of what will be installed. Click Install to continue the installation.
Page 5 of 8
Copyright © 2006-2008 Telelogic AB
Telelogic Synchronization Framework 1.2
When the installation is complete, you will the following summary dialog. Click Finish.
Uninstalling the Integration
Before uninstalling the integration, you should stop your Tomcat server to ensure that all synchronizers are
stopped.
On Windows, open Add/Remove Programs from the Control Panel. Find Telelogic Synchronization
Framework and click Remove. On Linux and Solaris, run the uninstall program located at
$CATALINA_HOME/webapps/Telelogic/_uninst/uninstaller.bin.
Synchronization Framework Administration
To configure the Synchronization Framework, 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:
Page 6 of 8
Copyright © 2006-2008 Telelogic AB
Telelogic Synchronization Framework 1.2
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 automatical y 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 Synchronizer Configuration section.
Detailed instructions for configuring each synchronizer are provided in the help for that synchronizer.
Page 7 of 8
Copyright © 2006-2008 Telelogic AB
Telelogic Synchronization Framework 1.2
Troubleshooting
Logs for the Synchronization Framework synchronizers are located at
CATALINA_HOME/webapps/TlogicIntegration/WEB-INF/logs. These logs should be sent to
Telelogic Support to help diagnose the cause of any errors.
Telelogic Support
For further assistance please contact our support team. Contact details may be found at
http://support.telelogic.com
This document contains confidential and proprietary information that belongs to Telelogic AB. Using any of
the information contained herein or copying or imaging all or part of this document by any means is strictly
forbidden without express written consent of Telelogic AB
Page 8 of 8
Copyright © 2006-2008 Telelogic AB
