Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Azure DevOps Services | Azure DevOps Server | Azure DevOps Server 2022
Important
For the On-premises XML process model, you can use witadmin to list, import, export, and modify a process for a project. For the Inherited and Hosted XML process models, you can only use witadmin to list and export process information. For an overview of process models and what is supported, see Customize your work tracking experience.
The witadmin command-line tool lets you customize work tracking by creating, deleting, importing, and exporting objects such as work item types, categories, global lists, global workflow, and link types. You can also manage work item field attributes.
For on-premises Azure DevOps Server, you can also manage the resolution types, bug type, and failure types used with test case management by using the tcm fieldmapping command.
The following diagram shows the scope of work tracking objects. Categories and work item types are managed at the project level. Global lists, link types, and work item fields are managed at the project collection level. Global workflow can be customized for either a project or collection.
To run most witadmin commands, you must be a member of the Project Administrators or Project Collection Administrators group. For more information, see Change project collection-level permissions.
Run the witadmin command-line tool
The witadmin command-line tool installs with Visual Studio. Open a Command Prompt window and navigate to the directory where Visual Studio is installed. You can also install the free Visual Studio Community edition.
Note
For Azure DevOps Services, use the latest version of Visual Studio.
Note
For on-premises Azure DevOps Server, use the same or later version of Visual Studio. For example, use Visual Studio 2019 or later to connect to Azure DevOps Server 2019.
%programfiles(x86)%\Microsoft Visual Studio\2022\Community\Common7\IDE\CommonExtensions\Microsoft\TeamFoundation\Team Explorer
Replace Community with Professional or Enterprise, depending on the version you installed.
On a 32-bit edition of Windows, replace %programfiles(x86)% with %programfiles%.
Global parameters
The following parameters display help text for witadmin commands.
| Parameter | Description |
|---|---|
/? or help |
Displays syntax and parameters for the witadmin command-line tool. |
command /help or command /? |
Displays syntax and parameters for the specified witadmin command. |
XML definition files
Work tracking objects are customized by updating their XML definitions. Objects include work item types, process configuration, global lists, and link types. For an overview of customization options, see Customize your work tracking experience.
You can run witadmin commands against Azure DevOps Services or Azure DevOps Server. However, Azure DevOps Services only supports commands that list or export definitions. Import and modify operations are available only for Azure DevOps Server.
Work item types
Work item types define the fields and workflow for tracking work. The available types depend on your project's process (Agile, Scrum, Basic, or CMMI). For more information, see About work items.
For the Inherited process model, manage work item types from the web portal. For more information, see Add and manage work item types.
Command
Azure DevOps Services
Azure DevOps Server
destroywitd: Delete a work item type
✔️
exportwitd: Export a work item type file
✔️
✔️
importwitd: Import a work item type file
✔️
listwitd: List work item types
✔️
✔️
renamewitd: Change the display name for a work item type
✔️
Fields
Fields store status and information in work items. You define fields at the organization or collection level. For more information, see Work item fields and attributes and Work item field index.
For the Inherited process model, manage fields from the web portal. For more information, see Add and manage fields.
Command
Azure DevOps Services
Azure DevOps Server
deletefield: Delete a field
✔️
listfields: List field attributes
✔️
✔️
changefield: Change a field attribute
✔️
renamewitd: Change a WIT display name
✔️
Categories
Categories group one or more work item types together. Azure Boards uses category definitions to determine which work item types appear on backlogs and boards. For more information, see Use categories to group work item types.
Command
Azure DevOps Services
Azure DevOps Server
exportcategories: Export the Categories file
✔️
✔️
importcategories: Import the Categories file
✔️
Link types
Link types define the relationships between work items, such as parent-child or related. You can define custom link types for on-premises XML and Hosted XML process models. For more information, see Link work items and Link type reference.
Command
Azure DevOps Services
Azure DevOps Server
deletelinktype: Delete a link type
✔️
exportlinktype: Export a link type file
✔️
✔️
importlinktype: Import a link type file
✔️
listlinktypes: List the defined link types
✔️
✔️
reactivatelinktype: Reactivate or rename a link type
✔️
Global lists
Global lists are reusable pick lists that you can reference in multiple fields and work item type definitions across a project collection. Define global lists using the GLOBALLIST XML element. For more information, see GLOBALLIST XML element reference.
Command
Azure DevOps Services
Azure DevOps Server
destroygloballist: Delete a global list
✔️
exportgloballist: Export the global list
✔️
✔️
importgloballist: Import the global list
✔️
listgloballist: List all global list names
✔️
✔️
Global workflow
Global workflow defines fields and global lists that apply to all work item types in a project or collection. For more information, see Global workflow XML element reference.
Command
Azure DevOps Services
Azure DevOps Server
exportglobalworkflow: Export the global workflow file
✔️
importglobalworkflow: Import the global workflow file
✔️
Process configuration
Process configuration defines which work item types appear on backlogs, boards, sprint backlogs, and Taskboards. It also controls default columns and other team capabilities. For more information, see ProcessConfiguration XML element reference.
For the Inherited process model, customize backlogs from the web portal. For more information, see Customize backlogs and boards.
Command
Azure DevOps Services
Azure DevOps Server
exportprocessconfig: Export the ProcessConfiguration file
✔️
✔️
importprocessconfig: Import the ProcessConfiguration file
✔️
Client cache
After server maintenance operations like moving, restoring, renaming, or failing over servers, you must refresh the client cache. This command is only available for Azure DevOps Server.
rebuildcache: Rebuilds the client cache for work item tracking
Test case management field mapping
Customize the resolution types, bug work item type, and failure types used with Azure Test Plans. This command is only available for Azure DevOps Server.
tcm fieldmapping: Imports or exports the file that defines resolution types, bug type, or failure types for test case management