Configuring a TopTeam-Jira Project Mapping for Synchronization

Overview

You can create TopTeam – Jira Project Mappings that will be used to perform data synchronization between TopTeam and Jira. Data will be synchronized based on the Synchronization Scheme selected in that Project Mapping.

Once the Project Mapping is created, it will start synchronizing data based on the schedule set in the Project Mapping.

In this topic, you will learn how to create TopTeam – Jira Project Mapping and run this mapping to synchronize data between TopTeam and Jira.

Prerequisites

You must be System Administrator or have the Manage Jira Project Mappings permission to configure Project Mappings and synchronize records. For more information see TopTeam Jira Connector Configuration Required Permissions.

Step 1. Go to the Administration area

Step 2. Click Configure Integrations

Step 3. Click TopTeam Connector for Jira

Step 4. Click Configure Project Mapping

Configure Project Mapping screen opens

Let’s understand the user interface.

C:\Users\admin\AppData\Local\Temp\SNAGHTML29fe3577.PNG

The Gear icon actions of a Project Mapping are explained below:

  • Edit: This action lets you Edit an existing Project Mapping.
  • Delete: This action lets you Delete an existing Project Mapping.
  • Enable/Disable: This action lets you Enable/Disable a Project Mapping.
  • Enable: Enabling a Project Mapping will start syncing data after 5 minutes.
  • Disable: Disabling a Project Mapping will stop syncing data thereafter until and unless you enable it.
  • Run Now: This action lets you Run the Project Mapping on an adhoc basis in a short interval of time, independent of a predefined schedule. 
  • Download Last Run Report: This action lets you Download the last run synchronization report.
  • View Synchronization History: This action lets you view synchronization history.

Step 5. Create a new Project Mapping

C:\Users\admin\AppData\Local\Temp\SNAGHTML2a05171f.PNG

Step 6. Enter TopTeam and Jira connection details

Logon As: TopTeam Jira Connector will use this user account to connect to TopTeam Server while synchronization.

Only System Administrators or users with Manage Jira Project Mappings permission are available for selection.

C:\Users\admin\AppData\Local\Temp\SNAGHTML83df95.PNG

  • REST URL: Append ”rest/api/latest” to the URL used on the browser for Jira.
  • Password/Token: Specify Password if Jira Server is on-premise. Specify Token if Jira server is on cloud.

How to generate Jira API token:

  • Log in to https://id.atlassian.com/manage/api-tokens.
  • Click Create API token.
  • From the pop-up screen that appears, enter a memorable and concise Label for your token and click Create.
  • Use Copy to clipboard and paste the token into the Password/Token field.
  • Keep the token so that you can use it multiple times.

This connection information is not stored, instead, it is utilized for fetching issue types, fields, and link types to assist in mapping.

Step 7. Enter TopTeam credentials for the author you are using for Logon As

NOTE

note_48.png

This pop-up screen will open only when you select Logon As another Author (other than you).

Step 8. Enter TopTeam – Jira project mapping details

C:\Users\admin\AppData\Local\Temp\SNAGHTML25ebc2f3.PNG

NOTE

note_48.png

  • Select the Generate Detailed Log of Synchronization checkbox on request from TechnoSolutions Support to generate detailed logs.
  • This is the last page if connected to a cloud environment.

Step 9. Specify Synchronization Schedule

There are two types of triggers available to synchronize the data, namely Continuous Synchronization and Once Daily.

  • Continuous Synchronization: Select this trigger to synchronize data continuously in a specified interval.
  • Once Daily: Select this trigger if you want to synchronize data at a specific time daily.

NOTE

note_48.png

For TopTeam Cloud, by default, the trigger is set to Continuous Synchronization mode. The connector will run at a time interval of 30 minutes.

Step 9.1. Select the Continuous Synchronization trigger

Step 9.2. Or, Select the trigger Once Daily

Newly created Project Mapping displays

The Project Mapping will be processed according to the schedule specified in the Windows Task Scheduler for connectors. After synchronization, you can view the status in Synchronization History Screen.

Step 10. View Synchronization History to check status, summary, and download reports/logs generated on synchronization

Related Articles

Defining a TopTeam-Jira Synchronization Scheme

Defining a TopTeam-Jira Synchronization Profile

Revised: March 13th, 2024