witfields

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Important

The witfields command is obsolete. Use the witadmin command instead. For more information, see witAdmin: Administrating Work Item Tracking Objects.

Use the witfields command to administer work item type fields for Team Foundation Server.

Note

Team Project Administrators may not be able to administer all the fields for Team Foundation Server.

The witfields command-line utility is located in DriveLetter:\Program Files\Visual Studio 10.0\Common7\IDE on Team Explorer client computer.

Required Permissions

To use the witfields command, you must be a member of the Team Foundation Administrators security group or the Project Administrators security group. For more information, see Team Foundation Server Permissions and Team Foundation Server Default Groups, Permissions, and Roles.

Note

Even if you are logged on with administrative permissions, you must open an elevated Command Prompt to perform this function on a server that is running Windows Server 2008. To open an elevated Command Prompt, click Start, right-click Command Prompt, and then click Run as Administrator. For more information, see the Microsoft Web site.

witfields view /s:tfs [refname | /unused]

witfields rename /s:tfs refname newname

witfields report /s:tfs refname type [:formula]

witfields delete /s:tfs refname

witfields rebuildcache /s:tfs

witfields help

Parameters

Parameter

Description

/s:tfs

The computer name of the Team Foundation Server on which you want to view or edit fields, or a fully specified URL for a Team Foundation Server.

refname

The reference name of the field for which you want to perform the command.

/unused

Displays all fields that are not used by a work item type on Team Foundation Server.

newname

The new friendly name of the field.

type

Reportability type. Allowed values are:

  • dimension used for the Integer, String, or DateTime fields.

  • detail used for the Integer, Double, String, or DateTime fields.

  • measure used for the Integer and Double fields. The default aggregation type is sum. You can specify another aggregation type by using the formula parameter.

  • disable used to disable reportability on the field.

formula

The aggregation formula that you use when the reportability type is measure: sum, count, distinctcount, avg, min, and max. The default aggregation type is sum.

help

Displays the witfields context help.

/?

Displays the witfields context help.

Examples

The following command displays field information for all the fields on the Team Foundation Server AdventureWorksServer:

>witfields view /s:AdventureWorksServer

The following command displays the field information for the specified field AdventureWorks.Field:

>witfields view /s:AdventureWorksServer AdventureWorks.Field

The following command displays all fields that are not being used on the Adventure Works Team Foundation Server:

>witfields view /s:AdventureWorksServer /unused

This following command changes the friendly name of the referenced field AdventureWorks.Field to NewFieldName:

>witfields rename /s:AdventureWorksServer AdventureWorks.Field NewFieldName

The following command specifies the reportability type of the DateTime field AdventureWorks.CreatedOn to dimension. This field's data enters the warehouse and cube so that it can be used to filter reports.

>witfields report /s:AdventureWorksServer AdventureWorks.CreatedOn dimension

The following command specifies the reportability type of the Double field AdventureWorks.Field to measure. All measures are aggregated by sum.

>witfields report /s:AdventureWorksServer AdventureWorks.Field measure

The following command deletes the field AdventureWorks.Field from the Team Foundation Server AdventureWorksServer:

>witfields delete /s:AdventureWorksServer AdventureWorks.Field

The following command invalidates the metadata cache for all clients on the Team Foundation Server AdventureWorksServer. The client caches are updated the next time they connect to the server.

>witfields rebuildcache /s:AdventureWorksServer

The following commands display the context help for the witfields command-line utility:

>witfields help
>witfields /?
>witfields view /?

See Also

Concepts

Working with Work Item Fields

Other Resources

witAdmin: Administrating Work Item Tracking Objects