Define a custom link type

Last Update: 3/14/2017

TFS 2017 | TFS 2015

IMPORTANT

This topic applies to team project customization for On-premises XML process models. Custom link types are not supported for Hosted XML or Inheritance process models. For an overview of process models, see Customize your work tracking experience.

You can customize an existing link type or create a link type to meet your project tracking requirements. You use a link type to define the link labels, topology type, and restrictions that are used when creating relationships between work items. You can customize an existing link type or create a link type to meet your project tracking requirements.

Before you start to add or modify a link type, you should assess the link types available and how they are used in your team project. See Manage dependencies, link work items.

NOTE

You cannot customize the system-defined link types that correspond to the Related, Parent-Child, and Successor-Predecessor links.

You may want to modify or create a link type for one of the following reasons:

  • Change the link labels that are used to match your team's naming conventions.
  • Add a link type to track a particular relationship that is unique to your team's process.

The link type is specified in a type definition XML file that you import to a team project collection. See LinkTypes.

With the witadmin command-line utility, you can deactivate, delete, export, import, list, and reactivate link types. See Manage link types.

Links are added through the work item form, which contains the links control. See Link controls, restrictions, and fields.

In addition to defining link types, you can customize the work item type definition to accept or prohibit specific links based on link type. You use the LinksControlOptions element to define the options that control what links can be added to a work item and to which work item types. Also, you can specify the default columns that you want to appear for the list of links in a work item. For more information, see Define link controls to restrict link relationships.