Apps documentation
Issue Sync Pro
Issue Sync Pro
Documentation
FAQ
Release notes
Last updated Sep 25, 2024

Mapping

This section provides information about mapping your fields to fields in the partner’s Jira instance, or on your local instance.

Creating a new mapping

To create a new mapping:

Steps

  1. Click Apps on the Jira top navigation bar, and select Manage your apps.

  2. Go to Synchronizations under the Issue Sync section.

    Issue Sync Pro
    Issue Sync Pro

  3. Click Next on an already existing synchronization.

    Issue Sync Pro
    Issue Sync Pro

  4. On the Mapping tab, click + New mapping

    Issue Sync Pro
    Issue Sync Pro

  5. Provide details of your mapping:

    5a. Input the name of your mapping

    5b. Select projects, between which the mapping takes place. Software, Service Desk, Team and Company-managed projects are supported.

    Tip

    If you are unable to find desired project or issue type in the selector, verify whether it has been selected in the Synchronization scope or not.

    5c. Select issue types you want to be mapped. You can detail your synchronization by including an additional JQL query.

    Note

    Sub-tasks are supported and can be chosen as an issue type. Since sub-tasks cannot exist as standalone issues without a parent, Issue Sync Pro verifies if the parent of given sub-task is also subject to synchronization, which is a necessary condition for sub-task to be synchronized.

    5d. Select proper custom fields you want to be mapped, and choose the synchronization direction. Make sure to include all required fields. Click +Add to include additional custom fields

    Note

    Keep in mind, that not every direction of synchronization is supported for particular fields. To find out what direction is supported for selected fields, see Field mapping.

    5e. Click the toggle to enable comments synchronization. Then select type of comments and the synchronization direction. This option is enabled by default.
    Note

    Comments from Jira Software and Service Desk projects are supported. Edition of comments is supported as well.

    Mentions are working, when both users are existing on both Jira instances.

    Proper comment synchronization is followed by “Synchronized to partner Jira” information.

    You can check the corresponding checkbox to show the original comment author display name to the partner’s Jira. For example:
    Issue Sync Pro
    Issue Sync Pro

    5f. Click the toggle to enable attachments synchronization. Then select the synchronization direction. This option is enabled by default.

    Info

    Attachments can be included in multiple ways, such as via comments in Software projects, or Wiki-style renderer fields (e.g Description). Additional information regarding adding the attachments can be found here.

    Note

    Keep in mind, that currently Attachment synchronization overrides the mapping of individual elements, such as a comments or fields.

    For example: if an attachment is added to an internal comment that is excluded from mapping, the attached file will appear in partner’s Jira without the text value of internal comment.

    5g. Click the toggle to enable the status transitions. For more information see Status transitions. This option is enabled by default.

  6. Click Create to save the mapping.

    Issue Sync Pro
    Issue Sync Pro

Results

Your mapping has been created properly.

Issue Sync Pro
Issue Sync Pro

Changing the project

During mapping creation, or edition (but, when the mapping form is already filled) if you change one of the selected projects, your configuration form may remain unchanged, or be cleared:

  • If the configured issue type exists on the selected project, it will remain intact in the form
  • If any of the existing field mappings are compatible with the newly selected project and issue type, such mappings will be kept. If not, these mappings will be cleared
  • Attachments sync configuration remains intact
  • If the type of the newly selected project matches the type of the original project, comments sync configuration will remain intact. Otherwise, it will be cleared

Changing the issue type

During mapping creation, or edition (but, when the mapping form is already filled) if you change one of the selected issue types, your configuration form may remain unchanged, or be cleared:

  • If any of the existing field mappings are compatible with the newly selected project and issue type, such mappings will be kept. If not, these mappings will be cleared
  • Comments sync configuration remains intact
  • Attachments sync configuration remains intact

Disabling mapping

To disable mapping, click on a toggle next to the mapping you wish to disable.

Issues created while the mapping is disabled won’t be synchronized.

Issue Sync Pro
Issue Sync Pro

Editing mapping

To edit an already existing mapping, click on Edit and provide changes of your liking.

Issue Sync Pro
Issue Sync Pro

Removing mapping

To remove an already existing mapping, click on Bin.

Issue Sync Pro
Issue Sync Pro

Need help?

If you can’t find the answer you need in our documentation, raise a support request.