Link controls, restrictions, and field reference
Work item forms contain these tabs for linking: Implementation, Links, All Links and Test Cases. This topic describes the controls and data fields that are associated with creating links and hyperlinks.
For more information about how to use links, see Link work items. To add link types, see Manage link types [witadmin]. To customize the link controls and restrictions, you modify the definition of the LinksControlOptions for a work item type, see Define link controls to restrict link relationships.
Link toolbar buttons
Each tab has a toolbar with buttons. The links control toolbar for Team Web Access, shown here, has a subset of these controls:
Links control toolbar (Team Explorer)
These buttons become available only after you perform a specific action:
The button to create a work item that is linked to the open work item () becomes available only after you save the open work item.
The buttons to open the list of work items in a query () and Open in Microsoft Office become available only when at least one work item is listed in the links control tab.
The buttons to open a work item (), edit a link (), and delete a link () become available only after you click one or more work items listed in the links control tab.
The Storyboards links control restricts users to add links only to storyboards or network shared files. With this control, you can add a new link, open a linked item, and delete a link. Also, only the Team Web Access version displays the Start Storyboarding link within the toolbar.
Storyboards links control (Team Web Access)
Link controls and restrictions
All tabs that support creating links between work items are implemented by using the LinksControl element on the work item form. This element controls filtering and restricting the types of work items to which you can link, the types of links that you can create, and whether you can link to work items in another team project. For more information about how to restrict links, see LinksControlOptions Elements.
Scrum process template
The Scrum process template defines the link control restrictions shown here. For descriptions of the work item types, see Visual Studio Scrum process template for Visual Studio ALM.
Tab name |
Work item type |
Link restrictions |
---|---|---|
All Links |
Feedback Request Feedback Response |
|
Links |
Product Backlog Item Bug Impediment Shared steps Task Test Case |
|
Links |
Code Review Request |
|
Stories |
Feedback Response |
|
Storyboards |
Product Backlog Item |
|
Tasks |
Product Backlog Item |
|
Test Cases |
Product Backlog Item Bug |
|
Tested Backlog Items |
Test case |
|
Agile process template
The Agile process template defines the link control restrictions shown here. For descriptions of the work item types, see Agile process template work item types and workflow.
Tab name |
Work item type |
Link restrictions |
---|---|---|
All Links |
User story Bug Feedback Request Task Test Case |
|
Implementation |
User story Task |
|
Links |
Issue Shared steps |
|
Links |
Code Review Request |
|
Stories |
Feedback Response |
|
Storyboards |
User Story |
|
Test Cases |
User story Bug |
|
Tested User Stories |
Test case |
|
CMMI process template
The CMMI process template defines the link control restrictions shown her . For descriptions of the work item types, see CMMI process template work item types and workflow.
Tab name |
Work item type |
Link restrictions |
---|---|---|
All Links |
Requirement Bug Change Request Feedback Request Issue Review Risk Shared Steps Task Test Case |
|
Implementation |
Task |
|
Links |
Code Review Request |
|
Requirements |
Change Request |
|
Stories |
Feedback Response |
|
Storyboards |
Requirement |
|
Test Cases |
Requirement Bug |
|
Tested Requirements |
Test case |
|
Default data fields in lists of links
All lists of links display these data fields:
Work item ID
Work Item Type
Title
Assigned to
State
[Link Comment]
You can add or remove columns from the list of links, and you can customize the default columns and the column order. For more information, see LinksControlOptions Elements.
For more information about these fields, see Titles, IDs, Descriptions, and History field reference and Assignments and workflow field reference.
The following table describes the [Link Comment] data field. For information about data types and default field values, see Define and modify work item fields.
Field Name |
Description |
Reference Name |
Data Type |
Default Value for the Reportable Type Attribute |
Default Value for the Index Attribute |
---|---|---|---|---|---|
Link Comment |
Contains comments from the team member who created the link. You can configure this attribute field to appear as a column in a list of links on a work item form. |
System.Links.Comment |
PlainText |
None |
False |
Additional fields that support query and reporting
Some fields do not appear on the work item forms but are tracked for each type of work item when you link them. You can use these fields to filter queries and create reports.
Field Name |
Description |
Reference Name |
Data Type |
Default Value for the Reportable Type Attribute |
Default Value for the Index Attribute |
---|---|---|---|---|---|
External Link Count |
The number of links from the work item to artifacts that are not work items and that are registered through the Team Foundation Linking Service. For more information, see this topic on the Microsoft Web site: Linking Service. |
System.ExternalLinkCount |
Integer |
None |
False |
Hyperlink Count |
The number of hyperlinks that are defined for the work item. |
System.HyperLinkCount |
Integer |
None |
False |
Related Link Count |
The number of links from the work item to other work items. |
System.RelatedLinkCount |
Integer |
None |
False |
Link Description |
Contains the work item type, ID, and title of the work item that is the target of the link. You can configure this link attribute field to appear as a column in a list of links on a work item form. |
System.Links.Description |
PlainText |
None |
False |
Reports that require links between work items
The default process templates in TFS provide reports that require you to create links between specific work items.
Process template |
Report |
Link requirements |
---|---|---|
Scrum |
Link PBIs and tasks (Parent-Child) and PBIs and test cases (Tested by-Tests). |
|
Agile |
Link user stories and tasks (Parent-Child) and user stories and test cases (Tested by-Tests). Link each bug to the test case that identified the code defect (Tested By) or link it to the user story (Related). |
|
CMMI |
Link requirements and tasks (Parent-Child) and requirements and test cases(Tested by-Tests). Link each bug to the test case that identified the code defect (Tested By) or link it to the requirement (Related). |