Skip to content

Microsoft TFS Work Items - Process Steps

Add Comment

Use this step to add comments from the current changelog to matching Microsoft TFS defects.

NameTypeDescriptionRequired
Additional CommentStringInformation to add to the TFS work item comment field in addition to the commit comment. You can include HTML.No
TFS PasswordPasswordThe password to connect to the server with. If no value is specified, the default password is the ${p:resource/tfsPassword} value.No
TFS Server URLStringThe URL of the TFS server.It must include the port number and end in /tfs, for example, http://tfs.example.com:8080/tfs.Yes
TFS UsernameStringThe user ID to connect with the TFS server.No
TFS VersionEnumerationThe version of the TFS server. Specify one of these versions: 2012 2010 2008 2005No
Work Item IDStringThe ID of the work item to change.Yes

Change Work Item State

Use this step to change the state of a Microsoft TFS work item.

NameTypeDescriptionRequired
New StateStringThe state to change the work item to. The value must match a valid choice in TFS. For example, specify Active or Resolved.Yes
Reason for new stateStringThe reason for the state change. The reason must match a choice in TFS, for example, Cannot Reproduce, Duplicate, Fixed, or Obsolete.Yes
TFS PasswordPasswordThe password to connect to the server. If no value is specified, the default password is the ${p:resource/tfsPassword} value.No
TFS Server URLStringThe URL to the TFS server.It must include the port number and end in /tfs. For example: http://tfs.example.com:8080/tfsYes
TFS UsernameStringThe user ID to connect with the TFS server.No
TFS VersionEnumerationThe version of the TFS server. Specify one of these versions: 2012 2010 2008 2005No
Work Item IDStringThe ID of the work item to change.Yes

Create Work Item

Use this step to create a new Microsoft TFS work item.

NameTypeDescriptionRequired
Assigned ToStringThe user to assign the new work item to.No
DescriptionStringThe description for the new work item.No
ProjectStringThe name of the TFS project to associate the work item with.Yes
TFS PasswordPasswordThe password to connect to the server. If no value is specified, the default password is the ${p:resource/tfsPassword} value.No
TFS Server URLStringThe URL to the TFS server.It must include the port number and end in /tfs, for example, http://tfs.example.com:8080/tfsYes
TFS UsernameStringThe user ID to connect with the TFS server.No
TFS VersionEnumerationThe version of the TFS server. Specify one of these versions: 2012 2010 2008 2005No
TitleStringThe title of the new work item.Yes
TypeStringThe type of the new work item, for example, Bug, Issue, Task, User Story, or Test Case.Yes

Display Work Item Status

Use this step to show the summary of a work item or list of work items.

NameTypeDescriptionRequired
TFS PasswordPasswordThe password to connect to the server. If no value is specified, the default password is the ${p:resource/tfsPassword} value.No
TFS Server URLStringThe URL to the TFS server.It must include the port number and end in /tfs, for example, http://tfs.example.com:8080/tfs.Yes
TFS UsernameStringThe user ID to connect with the TFS server.No
TFS VersionEnumerationThe version of the TFS server. Specify one of these versions: 2012 2010 2008 2005No
Work Item IDsStringA comma-separated list of work item IDs.Yes

Update Work Item

Use this step to update fields in a Microsoft TFS work item.

NameTypeDescriptionRequired
Add URL To This FieldStringThe URL of the deployment process to be added to the field name that is specified here.No
Field Reference Names and ValuesStringOn each line, specify the field reference name (not necessarily the name that is displayed in TFS), the new value, and whether to replace the old value or append the old value. Examples in include these strings: System.Title:My New Title APPEND:System.Title:Append This TextYes
TFS PasswordPasswordThe password to connect to the server. If no value is specified, the default password is the ${p:resource/tfsPassword} value.No
TFS Server URLStringThe URL to the TFS server.It must include the port number and end in /tfs, for example, http://tfs.example.com:8080/tfsYes
TFS UsernameStringThe user ID to connect with the TFS server.No
TFS VersionEnumerationThe version of the TFS server. Specify one of these versions: 2012 2010 2008 2005No
Work Item IDStringThe ID of the work item to change.Yes