witAdmin: Customize and manage objects for tracking work

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019 | TFS 2018 - TFS 2013

You can change how you track your team's progress by creating and customizing objects that track work items. By using the witadmin command-line tool, you can create, delete, import, and export objects such as categories, global lists, global workflow, types of links, and types of work items. You can also delete, list, or change the attributes of work item fields.

In addition, for on-premises Azure DevOps Servers, you can manage the resolution types, bug, and failure types used with test case management with the tcm fieldmapping command.

As the following illustration shows, you manage categories and types of and work items for each project. You manage global lists, types of links, and fields in work item for each project collection. You can customize global workflow for a project or a collection.

For most commands, you must be a member of the Project Administrators or Project Collection Administrators groups. For more information, see Change project collection-level permissions.

How to run the witadmin command-line tool

To run the witadmin command-line tool, open a Command Prompt window where Visual Studio is installed. The witadmin command-line tool installs with any version of Visual Studio. You can access this tool by installing the free version of Visual Studio Community or Visual Studio Team Explorer.

Visual Studio 2015 client:

cd %programfiles(x86)%\Microsoft Visual Studio 14.0\Common7\IDE

On a 32-bit edition of Windows, replace %programfiles(x86)% with %programfiles%. You can install Visual Studio Community (which provides access to Team Explorer) or Visual Studio Team Explorer 2017 for free.

Global parameters

You can use the following parameters to display help text for witadmin.

XML definition files

You customize all work tracking objects—such as, work item types, process configuration, global lists—by updating their XML definitions. If you're new to work tracking customization, see Customize your work tracking experience.

You run witadmin commands against Azure DevOps Services or an on-premises Azure DevOps Server. As shown in the command lists below, only witadmin commands that list or export files are supported for the Azure DevOps Services.

Work item types

Work items are used to track anything you need to track. Each work item is based on a work item type. Each work item types defines the fields available in which to store information. The available work item types depend on the process you used when your project was created (Agile, Scrum, Basic, or CMMI). To learn more, see Track your work items in Azure Boards user stories, issues, bugs, features, and epics.

For the Inherited process model, you can add and delete work item types from the web portal. To learn how, see Add and manage work item types(Inheritance process).

Fields

Fields are used to track the status and information associated with work items. Fields are defined for an organization or collection. To learn more about fields, see Work item fields and attributes. To look up the description of a specific field, see Field descriptions for default and work item fields used in process templates.

For the Inherited process model, you can view and delete fields from the web portal. To learn how, see Add and manage fields (Inheritance process).

Categories

Categories associate one or more work item types as belonging to the same category. Azure Boards relies on default category definitions, many of which specify a single work item type per category. To learn about categories and how they are used, see Use categories to group work item types.

Link types

You use different link types to manage the various relationships between work items. For On-premises XML and Hosted XML process models, you can define custom link types. To learn more about default link types, see Manage dependencies, link work items and Reference guide for link types.

Global lists

Global lists are pick lists that you can include within one or more fields and work item type definitions. You can share list items among several work item types for a collection of projects by including the list items in one or more GLOBALLIST elements. To learn more, see GLOBALLIST XML element reference.

Global workflow

With global workflow, you can define and update fields and global lists that apply to all work item types in a project or collection. To learn more, see Global workflow XML element reference.

Process configuration

Process configuration defines the default configuration and functional capabilities that your teams can access using Azure Boards. The configuration determines the work item types that appear on the product backlog, sprint backlogs, Kanban board, and task board. To learn about process configuration and what you can customize, see ProcessConfiguration.

For the Inherited process model, you can customize backlogs from the web portal. To learn how, see Customize your backlogs or boards (Inheritance process).

Work items

The following witadmin command is only available for TFS 2018.1 and earlier versions. It has been deprecated for TFS 2018.2 and later versions. To learn more about how to permanently delete work items for later versions, see Remove, delete, or restore work items.

• destroywi: Permanently delete work items

Client cache

After certain maintenance operations, client computers require a cache refresh. After you move, restore, rename, or fail over a data-tier or application-tier server, you must refresh the cache for tracking work items and users must refresh the version control cache on client computers.

The following witadmin command is only available for Azure DevOps Server on-premises.

• rebuildcache: Rebuild the client cache

Test case management field mapping

To customize the resolution types, bug work item type, and failure types used when working with Azure Test Plans, you can use the following tcm command. This command is only available for Azure DevOps Server on-premises versions.

• tcm fieldmapping: Import or export a file that defines the resolution types, bug, or failure types to use with test case management.

Related articles

• Customize your work tracking experience
• On-premises XML process model
• What is Azure Test Plans?