Document toolboxDocument toolbox

Integrating Work Item Links into Roadmunk

Owned by Jaramy Conners
Jun 27, 2024
3 min read

Available on the following plans:

  • Business

  • Professional

  • Enterprise

Terms to Know

  • Linked Work Items - In Azure DevOps, users are able to generate relationship-based connections between only Work Items in their projects (outside of the hierarchical links made by task types like Epics & Work Items). These can have a variety of different labels on their relationship with no variation in behaviour based on the label used. 

  • Azure DevOps Item Links - When displayed in Roadmunk, we refer to any relationships created on Linked Work Items as "Item Links" throughout the roadmap, including the Item Card, ADO Settings, and Publication Menu.

 When building roadmaps that help to show data from integrated sources like Azure DevOps, users have the ability to synchronize the relationships between Work Items you create in Azure DevOps with your roadmap items and visualize them in the same way you would visualize Linked Items on your roadmap.

Including Azure DevOps Item Links in Integrated Roadmaps

image-20240515-185711.png

In order to include Azure DevOps Work Item Links in your roadmap, you would first need to toggle them on from your roadmap's settings. Users have the option to either Include or Exclude Item Links in their roadmaps.

For New Roadmaps:

To enable Azure DevOps Item Links on New Roadmaps:

  1. Once the roadmap is created, navigate to the Integrations tool in the Roadmapping Toolbar.

  2. In the menu that appears on click, select the Setup Azure DevOps Integration option.

  3. Follow the prompts through until you reach Step 6 - Item Links.

  4. On the toggle that appears, ensure that Include Item Links is selected before continuing the setup.

  5. Once completing your setup, your Azure DevOps Item Links will be visible on your roadmap (in-app and published) and your Item Card.

For Existing Integrated Roadmaps:

To enable Azure DevOps Item Links on New Roadmaps:

  1. Once the roadmap is created, navigate to the Integrations tool in the Roadmapping Toolbar.

  2. In the menu that appears on click, select the Modify Setup option.

  3. Navigate to the last tab, labelled Item Links.

  4. On the toggle that appears, ensure that Include Item Links is selected and press Save.

  5. Once saved, your Item Links will sync in from Azure DevOps be visible on your roadmap (in-app and published) and your Item Card.

Creating & Managing Azure DevOps Item Links

image-20240515-185722.png

Users are able to create, manage, & remove Azure DevOps Work Item Links from inside the Item Card on their roadmap. Unlike other changes which are made with Azure DevOps, these are updated automatically and are pushed to Azure DevOps for real-time parity with Roadmunk. Links can only be created with items that exist within the roadmap and can only exist on items that are synchronized with Azure DevOps - Roadmunk-based items cannot have Azure DevOps Item Links on them without first being pushed to Azure DevOps.

Unlike other Linked Item types within Roadmunk, Azure DevOps Item Links cannot be created with items across roadmaps at this time and can only be used with items which exist in the roadmap. If certain items fall outside of the sync criteria defined in your integration setup, you will be unable to view existing links to those items in your item card (as there is no item in Roadmunk for this feature to link to).

Â