Document toolboxDocument toolbox

Jira FAQ

General

Can I integrate more than one Jira project?

No, you can only integrate one Jira project per roadmap. This applies even if you try to use JQL to pull in multiple projects. However, the solution to this is to integrate each project into separate roadmaps then create a Portfolio Roadmap that rolls up each of the project roadmaps. You can read more on Portfolio Roadmaps here.

Does Roadmunk honour my hierarchy from Jira?

Sadly, Roadmunk does not honour your Jira project hierarchies at this moment. Here are a few common ones you can expect won't be reflected once integrated with Roadmunk:

Issue Types: Roadmunk has the ability to sync two-levels of issue types. This is typically Epic -> Story/Task/Bug. At the moment any sub-tasks or third level issue types won't be synced into Roadmunk. This includes any hierarchy types that may sit above your Epics (Jira Initiatives).

Sub-items: Roadmunk will not keep your sub-item/nested hierarchy when your project is integrated. These items will be synced as individual items with their Epic designation identified using the Epic Link field. Roadmunk does have a native sub-item feature where you can re-create these within your Roadmap. For more information, you can view our help article on syncing Jira sub-items here.       

Dependencies: Users now have the ability to synchronize the relationships between issues you create in Jira with your roadmap items and visualize them in the same way you would visualize Linked Items on your roadmap. You can find more information on working with linked items here

What's the value of JQL?

With JQL, you can write your own query. This means being very specific with the data you're pulling from Jira.

Example:

Basic = Bugs, Stories and Tasks with Open, Closed or Backlog status. This means you'll sync all items associated even if you don't need them. You can of course filter out issues within Roadmunk once imported.

JQL = Open Bugs assigned to Mike from January 1, 2018 to January 1, 2019. With this example you can get as precise as you need outside of just standard Issue Types and Statuses.

If you're interested, you can read more about JQL and building your own query using the links provided.

Can I integrate Next-Gen Projects to Roadmunk?

Yes, you absolutely can. Roadmunk does support team-managed (or next-gen) projects to be synced with your roadmaps. The structure of team-managed projects do differ from your classic (or company-managed roadmaps) so please consult with your Jira admins for any data-specific questions. Atlasssian covers the differences between the two in detail here.

Does Roadmunk Support Jira On-Premise or Data Center Servers?

Roadmunk does support data center deployments of Jira Software (v7+). Please note the server must be accessible to the web (either direct or by proxy) and whitelisted appropriately for Roadmunk.

What conditions are used to calculate items synced when selecting a time frame under the Import Issue History?

These items are calculated based on when they've been created. For example should you use "Last 30 Days", the integration will any items in the project created within the last 30 days.

Syncing

Do you offer Real Time syncing?

You can manually Sync at any time to push/pull changes to your roadmap, or set your sync to every hour. 

If your sync is set to run every hour, the last change to occur prior to the sync running will be prioritized. If you want to make an update that updates both systems immediately - make the change then select Synchronize Now.

Why are my updates being written over? How can I avoid this from happening?

If you have a two-way sync set up and someone is making changes in Jira while your roadmapping, the most recently updated tool, so Jira in this case, will always win. Don’t wait for the scheduled sync. You should always manually push and sync your roadmap while making changes. Think of saving a document as you go - it’s good practice to not lose your work in a worst-case scenario.

Additionally if changes have occurred on both systems within your sync schedule, the most recent update occurs. For example, if a link item has been changed in this order, Roadmunk, Jira, Roadmunk, then you can expect the Roadmunk change to be prioritized.

Why can’t I update some Jira fields in Roadmunk?

The more complex and automated a field is, the more likely it can only be integrated as read-only. Read-only and mandatory fields will be greyed out. Fields already checked will be mandatory and can't be removed. You can see a full list of all the Jira fields we support and how they come through the Roadmunk integration here.

Why isn’t the field I want showing up on the fields to sync screen?

Either the field is not on the Create Issues screen in your Jira project or it isn’t supported at this time.

Why am I seeing field values from another project?

Most Jira fields are treated like account-level fields in Roadmunk. Because of this, their values are shown within most synced Jira fields. For example, you may see more than one “Epic” field under your Issue Types. The big payoff is that you can use them as common pivots on a Portfolio Roadmap (Issue Type, Epic link, Component, Label, Assignee).

Why am I getting an error when I try to push an item to Jira?

You'll want to ensure you're selecting the correct field. For example, Issue Type is similar to an Account Level field and it contains issue types from all integrated projects on their Jira server. Since there are some standard-issue types (Epic, Story, Task) they may appear multiple times. Selecting the correct one will get your item pushed to Jira.

Are there any requirements for pushing items to Jira?

Very small ones. Outside of making sure your project is integrated (with a Two-Way sync) and you have permission to create items, here's a quick guide on the minimum field requirements for items to be pushed to Jira.

Epic Requirements: Roadmunk Item Name*, Issue Type -> Epic, Epic Name
Other Issue Types: Roadmunk Item Name, Issue Type (Story, Task, Bug, etc*)

*first column on your roadmap item table.

*Roadmunk does support custom Issue Types

Quick and easy to get items into Jira for current and future planning. For more information on syncing and pushing your items, visit our help article here.

I've deleted my epics in Jira. Will Roadmunk automatically remove them the next time I sync?

No, Roadmunk will not automatically remove any items or epics during the next sync. Roadmunk will however flag your items and epics as it can no longer find it within the integration. At this point, you're free to leave the items in your data table for reference or you can simply delete them from Roadmunk. Roadmunk will never delete an item from your project. If you'd like to remove an item in full, you'll need to remove it from both Jira and Roadmunk.

If you're looking to have your items/epics auto-deleted, you can reach out to support@roadmunk for more details.

My new Epic isn't as a value under my Epic Link field, why is that?

Newly created Epics will need to have items linked to it in Jira and synced prior to having the value available in Roadmunk. Epic Link should be viewed as a field in Roadmunk that regularly needs to be updated. In this instance, as there has been no link to the new Epic created yet, you need to complete the above in order for it to be available.

Roadmapping

I've synced my project with Roadmunk. What can I do now?

Now that your data is in Roadmunk, you can start building your visualizations. Roadmunk allows you to build informative views using both your fields created in Roadmunk and those brought in from Jira. If you're looking for ideas to get started, you can view our article on Jira specific views.

Why is Roadmunk forcing a filter on me? How do I get around this?

Roadmunk has a default header capacity of 25 values. This helps with the general performance while using the tool. As Jira fields work similar to Roadmunk Account Fields, you're likely to see a lot. If you're looking to increase your header range, please reach out to our Support team.

Can I transfer my integrated roadmap to another user on my account?

Roadmaps can absolutely be transferred to another user within your Roadmunk instance. It's important to note that the integration will be suspended once the Roadmap is transferred. The new owner at this point will have the opportunity to use their own Jira credentials to initiate the connection and resume syncing.

Items synced and pushed by our collaborators on a shared roadmap are still being reported as the roadmap owner, why is that?

Only the roadmap owner has the ability to sync their credentials. Because of this any new changes that are synced or items that are pushed will belong to the original owner of the roadmap. For example, if the Collaborator A pushes through a new item to Jira, it'll still be listed under Owner A when viewing the item log within Jira. While inviting new members to your roadmap is fine, it's always best practice to ensure each user has their own Jira integrated roadmap. This ensures optimal workflow and reporting from both systems.

We've removed a user who owned some of our Jira roadmaps. What will happen to those roadmaps?

The roadmap items will remain intact but the integration will be suspended. This means items will no longer be synced to and from Jira. An admin can now assign this roadmap to a new user or simply archive it if it's no longer needed. The new user will need to use their own credentials to use the Jira integration again.

How can I remove the Jira integration from my Roadmap?

While there is no native way to remove the integration from a roadmap, we do have a few workarounds that will achieve the same result depending on your use case:

  1. Archive your roadmap. Any Jira integrated roadmap that's been archived automatically suspends the integration. While the items are still available on the roadmap, no other syncing will occur while archived. If you'd like to remove it completely, proceed to delete the archived roadmap.

  2. If you'd like to re-create your current roadmap but would like to remove the integration we'd recommend exporting a CSV of your current roadmap. Once you've completed the steps above, simply import your CSV into your new roadmap. Find out more about exporting and importing using the links provided.

  3. Filters. For a quick and easy to to remove any unwanted items from your roadmaps, simply make use of our roadmap filter functionality. More details can be found here.

How can I delete already synced Jira items on my roadmap?

Linked integrated items that match your integration filter settings can't be removed from the roadmap. Here are a few suggestions to work around that:

Change your integration settings: If you're only looking to sync a particular Status and Issue type, you can de-select all other options in your integration settings. Once saved, you'll noticed a small *yellow key indicating the items no longer match the filter. At this point, you're free to go ahead and remove them from Roadmunk. Two things to note:

  1. Removing them from Roadmunk will not* remove these items from Jira. This action will need to be completed on Jiras end.

  2. The items are still eligible to be synced back to Roadmunk if they exist in Jira. For example, re-adding issue types from the example above will result in these items syncing back to Roadmunk on your next successful sync.

Use JQL: If you aren't looking to sync your full project into Roadmunk, we highly recommend filtering your sync via a JQL query. This will limit any unwanted items on your potential roadmaps. If you haven't use JQL in Roadmunk yet, you can read more about it here. If you'd like to learn how to build your own, you can read more here.

Filter your Roadmap: A great way to get the data you want without having to remove items is making use of filters. Roadmunk allows you to filter items in your roadmap by their respective fields. This extends to Jira items and their fields as well. For more information on filters, you can read our help article here.

Can I duplicate a Jira integrated Roadmap?

Yes, you do have the ability to duplicate a Jira integrated roadmap. The process is a bit different than duplicate a non-integrated roadmap. A few things to watch out for:

  • The duplicate roadmap will only have the items that were synced from your Jira project. This means that all fields will need to be re-synced into the duplicate to work.

  • Any views will also be duplicated but will need to be re-built as fields won't be synced automatically.

  • The integration itself will be suspended. The original owner will need to re-authenticate themselves or pass ownership to the new user where they can provide their credentials. At this point you can re-sync fields and have the integration working again.

Can collaborators utilize the Jira integration on a shared roadmap?

Yes, if you add a team member to your integration roadmap as a collaborator, there are a few features they can utilize:

  • Collaborators are able to sync changes to and from Jira. This means they can push new items to Jira and sync any changes between the platforms

  • important to note that collaborators are working as an extension of the current credentials. For example, if collaborator(a) pushes through an item to Jira, it will be listed as created by owner(a).

It's always recommended that users integrate their own roadmaps with their own credentials when using Jira. This is to help avoid any confusion while planning in Jira.

Connections/Credentials

What connections does Roadmunk use for the Jira integration?

Here's a quick breakdown of the types of connections you can expect within your integration:

Main integration: HTTPS (Hypertext Transfer Protocol Secure)

Authentication: OAuth, API Tokens (cloud servers), Username/Password (self-hosted servers)

Can I have more than one person connected to Jira on my roadmap?

Unfortunately, no. The owner of the integrated roadmap is the only user able to use their credentials and thus are the only ones able to control/modify the integration settings. With that, users that have edit access to the roadmap do have the ability to synchronize and push new items to Jira.

Why can't I connect to my hosted Jira Server?

Here are a few examples of why some on-premise solutions may have difficulty connecting to Roadmunk:

  1. Your server may not have valid SSL/TLS certificates - test the URL here 

  2. Your company may be blocking outside access to your Jira server, you may need to whitelist Roadmunk's IP addresses to allow access. You can find more information here

  3. Your Jira server may not be hosted at the root of the URL. For example: https://jira.mycompany.com will work, but https://mycompany.com/jira will not work

  4. If you are still unable to connect to your Jira server and have verified the above does not apply, please ask your IT department to look for Roadmunk's ip addresses (see link above) in your network logs and try to determine why access may be getting blocked.

Errors

I’m getting a “Failed to Connect” error. What does this mean?

Roadmunk will timeout if it takes more than 10 minutes to sync your Roadmap. Timeouts can be remedied by manually tasking your Roadmap to sync again. Rule of thumb, if you’re bringing in more than 1000 items or a field with 150+ values, try adjusting your settings to bring in a smaller item count.

My integration has an error code but there's no additional messaging. What should I do?

Jira error messages generate codes for a variety of reasons. If you do receive a code without an associated message, please reach out to our support team with your specific code for further troubleshooting steps.