Skip to main content
Skip table of contents

Synchronize the roadmap and dates with Jira

You can choose to automatically synchronize your Roadmap with Jira: Changes you make to items on the Roadmap will be saved to Jira as you make them. This includes:

  • Which items are included on the roadmap

  • Changes to the date fields

  • The parent/child relationship between items

Version markers are always synchronized with Jira.

Create Roadmap Sync with Jira configured.png

Alternatively, disable syncing to manually publish changes to items by opening the Sync menu.

Roadmaps Sync button.png
Synchronise your work disabled Publish 2 changes.png

You can toggle syncing on or off at any time in the Sync menu.

Configure date fields to sync

Easy Agile Roadmaps can only update date fields in Jira when the selected date fields are editable/writable on the items in Jira.

To enable date field synchronisation, a Jira Administrator will need to:

  1. Select start and due date fields to use with Easy Agile Roadmaps.

  2. Add the date fields to the Work item screens for relevant Jira projects.

When this is configured, you can then sync the date field changes as well as other changes:

  • Automatically when “Synchronise your roadmap with Jira” is toggled on, or

  • Manually using “Publish changes” in the Synchronise menu.

1. Select date fields

The Easy Agile Roadmaps uses one pair of date fields for start/due dates for all Roadmaps on the Jira Cloud site.

When creating a new Roadmap, the currently-selected date fields will be displayed.

  • If you have Jira Administrator permission, you’ll be able to change the selected date fields here.

Changing the date field selection will change it for all Roadmaps on the Jira site.

Create Roadmap Sync with Jira date fields admin.png
Alternative path through Manage apps settings

Easy Agile Roadmaps global Configuration page

Alternatively, open Jira’s “Manage apps” settings to find the Easy Agile Roadmaps Configuration page. Here, Jira Administrators can view and edit the configured date fields for the app on this Jira Cloud site.

Jira Cloud Manage Apps Roadmaps Configuration highlighted.png

From this page, you can also use the “Click Here” under each dropdown to go directly to the “Associate field to screens” page. This lets you select existing Work item screens for company-managed projects to add the field to.

2. Add date fields to Work item screens

When creating a new Roadmap, Easy Agile Roadmaps will check if the selected date fields are available on the Work item screens.

  • This will check all work types for all projects in the selected Jira boards, based on the Work type screen scheme for each project.

If you have Jira Administrator permission, the app will provide a link directly to the Jira configuration page for any Screens where the field is missing.

Create Roadmap fields to screens admin highlighted.png

For company-managed projects, this will open the “Associate field to screens”. This lets you select multiple existing Work item screens to quickly add the field to.

  • By default, Work item screens are named with the Project key.

Jira Cloud Associate field Start date to screens search PLAT.png.png

For team-managed projects, the link will go to the work type configuration page in project settings.

Non-Jira Administrators creating a new Roadmap will be provided with a copy of this link to send to a Jira Administrator.

Create Roadmap fields to screens non-admin copy link highlighted.png

This is also available after a Roadmap is created from the Edit Roadmap menu.

Edit Roadmap date fields Jira admin.png

Troubleshooting sync with Jira

If synchronization fails for specific items, first check if you can make the same change to the item in Jira. This can fail if:

  • The applicable field (date field or parent field) is not visible and editable on the item’s Screen.

  • You do not have permission to edit that field in Jira, based on the project’s Permission scheme.

Almost ready to publish your issues

Synchronization will only work when the selected date fields are available on the items in Jira.

If automatic synchronization is enabled but some changed items do not have date fields available, you will not be able to publish those changes. In this situation, you’ll see a message:

Some of your fields need to be configured in order to be published. Head to Edit Roadmap and complete your date sync configuration by selecting the appropriate Jira fields.

Synchronise roadmap enabled field configuration.png

To resolve this, a Jira Administrator must add the selected date fields to the applicable Work item screens. See Add date fields to Work item screens above.

Almost ready to sync

Easy Agile Roadmaps will not sync any changes if the global configuration for the app has no date fields set. In this situation, you’ll see a warning message:

To enable synchronisation, head to Roadmaps configuration and complete your date sync configuration by selecting the appropriate Jira fields.

Synchronise roadmap disabled no date fields.png

To resolve this, a Jira Administrator must select date fields for the app:

  1. Open Jira’s “Manage apps” settings (or use the “Roadmaps configuration” link in the warning pictured above).

  2. Open the Easy Agile Roadmaps' global Configuration page.

  3. Remove “Disable synchronizing this field” for both fields by selecting a date field from Jira.

  4. Refresh the Easy Agile Roadmaps app page.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.