Tasktop Sync logo

Tasktop Sync allows teams to synchronize tasks across different defect and task tracking repositories. The Tasktop Sync server application places itself in between repositories to synchronize changes made to the defects or tasks in either repository.

This user guide explains how to set up and maintain a Tasktop Sync installation, including details on how to configure and run the software.

User Guide Contents

  1. User Guide Contents
  2. Introduction
    1. Terminology
    2. Features
      1. Integration Visualizer
      2. Task Mapping Editor
      3. Automated Conflict Resolution
      4. Person Mappings
      5. No Local State Lock-in
      6. Copied Task Handling
      7. Automatic Proxy Link Repair
      8. Configuration Templates
      9. Task Relationship Management
      10. Synchronizing External Associations
      11. Synchronizing Attachments
      12. Synchronizing Comment and Attachment Authors
      13. Status Workflow Management
    3. Architecture
      1. Fundamentals
      2. Synchronization Conflict Handling
        1. Conflict Detection
        2. Conflict Resolution
        3. Conflict Notification
      3. Synchronization States
        1. Queued
        2. Processing
        3. Error
        4. Pending
        5. Done
  3. Installation
    1. Preparation
      1. System Requirements
      2. Accounts
      3. Required Files
      4. Backup Installation Customizations
      5. Vendor-specific Requirements
      6. Test Environment
    2. Installation on Windows
    3. Shared Master Key
    4. Installation on Linux
    5. Post-Installation Steps
    6. Starting Tasktop Sync
      1. Standard Installs
      2. Windows Service Installs
    7. Starting and Stopping the Service
    8. Initial Setup and License Activation
  4. The Tasktop Sync Interface
    1. The Tasktop Sync Toolbar
    2. The Tasktop Sync Dashboard
      1. Dashboard Statistics
      2. The Active and Error Queues
      3. Error Queue Filters
      4. Proxy Task Recreation
      5. Ignoring New Changes for Selected Errors
    3. The Diagnostic Views
    4. The Sync Tasks View
    5. The Services View
      1. The Services Toolbar
      2. The Services Filter
      3. The Services Menu
    6. Integration Visualizer
      1. Repository Node
      2. Task Mappings Node
    7. Starting the Synchronizer
    8. Marking for Synchronization
    9. Ignoring New Changes
    10. Synchronizing Attachments Again
    11. General Settings
      1. Instance Name
      2. Legacy Schema Refresh Task Limit
      3. Force Legacy Schema Refresh
  5. The Tasktop Sync Web UI
    1. Web UI Configuration
    2. Accessing the Web UI
    3. Reviewing Synchronizations in the Web UI
    4. Usage Metrics
  6. Task Synchronization Configuration
    1. Creating a Task Mapping
      1. Full Scope
      2. Limited Scope
    2. Editing a Task Mapping: The Task Mapping Editor
      1. Task Mapping Editor Layout
        1. Repositories
        2. Repository Scope
        3. Artifact Scope
      2. Mapping Preferences
        1. Repository Preferences
        2. Comment Synchronization
        3. Attachment Synchronization
        4. General Preferences
      3. Attribute Mappings Editor
        1. Mappings Table
        2. Mapping
        3. Caster
          1. No Caster
          2. Value Mapping
          3. External Value Mapping
          4. Date/Time Transformation
          5. Person Mapping
          6. Text Markup Transformation
          7. Literal Value
          8. Multi-value to CSV String
          9. Value to String
          10. Custom Script
          11. Task Link to Task Link
            1. Validate links before synchronizing
          12. Task Link to Task Link Group
          13. Task Link to Web Link
          14. Task Link to Web Link Group
          15. Task Link to String
          16. Task Link to OSLC Link
          17. Value to Task Link
          18. Web Link to Web Link
          19. Web Link to String
          20. Location to Web Link
          21. Status Transition
        4. Advanced
        5. Notes
        6. Transition Attribute Mappings Table
        7. Transition Attribute Mapping
        8. Attribute Handlers Table
        9. Attribute Handler
      4. Schema View
      5. Source Tab
    3. Global Settings
      1. Notifications
        1. General Notification Settings
        2. Error Notification Configuration
        3. Email Configuration
      2. Configuring Scheduled Jobs
    4. Configuration Templates
      1. Creating a New Template from an Existing Mapping
      2. Create a New Task Mapping from a Template
      3. Monitor Template Usage
      4. Making Changes to Task Mappings that Are Based on the Same Template
      5. Disconnecting a Task Mapping from its Template
      6. Making Changes to a Task Mapping Based on a Template (Advanced)
    5. Renaming a Task Mapping
  7. Web Container Configuration
  8. Task Linking Configuration
    1. IBM Rational Team Concert Change Configuration Management (Change and Configuration Management) Configuration
      1. Configure the Task Linking Server Relationship
      2. Configure the IBM Rational Team Concert Change and Configuration Management Project Area
      3. Linking a IBM Rational Team Concert Change and Configuration Management Task to a Remote Artifact
    2. IBM Rational Team Concert Requirements Management (Rational DOORS Next Gen) Configuration
      1. Configure the Task Linking Server Relationship
      2. Configure the IBM Rational Team Concert Rational DOORS Next Gen Project Area
  9. Maintenance and Inspection
    1. Upgrading an Existing Tasktop Sync Installation
      1. Generate Repository Schema
    2. Post Installation
      1. Configuration Updates
    3. Restoring a configuration without restarting Sync
    4. Synchronization Log Viewer
    5. Repository Configuration Changes
      1. Legacy Schema Refresh
      2. Periodically Refreshing the Repository Configuration
    6. Repository Users
    7. Service Outages
    8. Backup and Restore
      1. Archiving a Folder
      2. Creating the Backup
      3. Restoring a Backup
        1. Restoring a Backup on the Same Machine
        2. Restoring a Backup on a Secondary Machine
      4. Advanced Backup
    9. Logs and Logging Configuration
    10. Workspace, Configuration and Log File Paths
    11. Sync History Trimming Policy (Advanced)
    12. Repositories in Error
      1. Repository Authentication Errors
    13. Changing a Repository's URL (Advanced)
      1. Prerequisites
      2. Launching the Wizard
    14. Migrating a Project to Another Server (Advanced)
      1. Prerequisites
      2. Launching the Wizard
      3. After Completing the Wizard
  10. Manual Task Synchronization Configuration (Advanced)
    1. Repository Connections
      1. Custom Authentication
    2. Create Queries
      1. Initialization Query
      2. Changes Query
    3. synchronizer.xml
      1. Run Characteristics
      2. Person Mapping Definitions (Optional)
      3. Task Mapping Specification
      4. Repository Specification
        1. Scope Specification
        2. Source Specification
        3. Proxy Association Storage
          1. Attribute Proxy Store
          2. Database Proxy Store
          3. Task relations Proxy Store
          4. Changing Configured Proxy Store
        4. Property Specification
      5. Attachment Mapping Specification
        1. Attachment file size filter configuration
        2. Failed attachments filter configuration
      6. Comment Mapping
        1. Comment Visibility Configuration
        2. Oversized Comment Handing
      7. Attribute mapping
        1. Mapping Task Attributes with the Same Name and Type
        2. Mapping Task Attributes with different names
        3. Mapping Task Attributes by ID
        4. Mixing Names and IDs
        5. Attribute Mapping Strategy
        6. Attribute Mapping Conflict Resolution
        7. Transforming Task Attribute Values with Casters
          1. Date-Time Caster
          2. Value Mapping Caster
          3. External Value Mapping Caster
          4. Text
          5. Literal Values
          6. Task Link To Task Link Caster
          7. Task Link To Task Link Group Caster
          8. Task Link To Web Link Caster
          9. Task Link To Web Link Group Caster
          10. Task Link To String Caster
          11. Task Link To OSLC Link Caster
          12. Value to Task Link Caster
          13. Web Link To Web Link Caster
          14. Web Link To String Caster
          15. Location To Web Link Caster
          16. Status Transition Caster
          17. Caster Customization
        8. Using Person Mappings
        9. Advanced Concepts
          1. One-Way Mappings
          2. Synchronizing Subsets of Queried Incoming Tasks
          3. Scripted Attribute Handlers
          4. Multiple Submissions per Synchronization
            1. Ignoring Automated Changes
          5. Sparse Attributes
      8. Operation Attribute Mappings
      9. Jobs
        1. Refresh Repository Configuration Job
        2. Refresh Schema Job
        3. Check For Changes Job
        4. Disk Space Warning Job
        5. Error Notification Job
      10. Notifications
        1. Error Notification
    4. Person Mapping Files
      1. Attribute Based Person Mappings
      2. Scripted Person Mappings
      3. Person Mapping Priority Order
  11. Appendix: Advanced Scripting
    1. Scipting Overview
    2. The Script Context and Lifecyle
      1. Retaining a Groovy Script's Context between Executions
    3. Logging from Scripts
    4. Expanding the Groovy Classpath
  12. Appendix: Known Limitations
    1. Linux Installer Limitations
    2. Task Linking Limitations
    3. Tasktop Synchronization Limitations
  13. Appendix: Troubleshooting
    1. Inspecting the Error Log
    2. Generating an Error Report
      1. Tasktop Sync Studio
      2. Tasktop Sync Web UI
      3. Disclaimer
    3. Accessing and Understanding the Tasktop Sync Logs
      1. Reading Tasktop Sync Logs
  14. Appendix: Tasktop Sync Error Codes
    1. Tasktop Sync Installer for Windows
    2. Tasktop Sync Installer for Linux
    3. Additional Information
      1. TTSSL10002
  15. Appendix: Notices
    1. Copyright
    2. Patents
    3. Trademark Acknowledgements