Skip to content

Latest commit

 

History

History
171 lines (115 loc) · 9.53 KB

File metadata and controls

171 lines (115 loc) · 9.53 KB
title Upload, download, or delete a process template
titleSuffix Azure DevOps
description Learn how to upload, download, delete, or make default a process template for a project collection in Azure Boards.
ms.custom work-items, engagement-fy23
ms.service azure-devops-boards
ms.assetid 5D5AF176-B3C6-47AD-87FF-5FAFE1BA4AAE
ms.topic how-to
ms.author chcomley
author chcomley
monikerRange <= azure-devops
ms.date 03/24/2026
ai-usage ai-assisted

Upload or download a process template

[!INCLUDE version-lt-eq-azure-devops]

When you create a project, a process template defines the work item types and other settings for Azure Boards. For the Hosted XML and On-premises XML process models, you upload a process template to create or update a project. For the Inheritance process model, you customize work tracking through the web portal. For more information, see Customize your work tracking experience.

::: moniker range="< azure-devops" You can upload and export process templates only for project collections configured to use On-premises XML processes. You can also set a template as the default for new projects.

::: moniker-end

[!INCLUDE temp]

Prerequisites

Category Requirements
Permissions Member of the Project Collection Administrators group. To get added, see Change project collection-level permissions.

::: moniker range="<=azure-devops"

Important

Uploading and downloading inherited processes isn't supported. To manage inherited processes, see About process customization and inherited processes.

[!INCLUDE temp] ::: moniker-end

::: moniker range="azure-devops"

Import a process template (Hosted XML process)

  1. From the Processes tab, select Import process, and then drag and drop or browse to the .zip file of the process you customized.

    [!div class="mx-imgBorder"]
    Screenshot of Import Process link.

    [!NOTE]
    If the Import process link doesn't appear, your organization isn't set up to support the Hosted XML process model. Use the Inheritance process model for your customization needs. The Hosted XML process model is only supported if your account was created through the Data Import Service.

  2. Select the file to upload. Your custom process must meet specific constraints to pass validation checks during import.

    [!div class="mx-imgBorder"]
    Import process dialog for selecting a process file.

    Select Replace existing template if you're updating an existing template. The import overwrites any template with the same name and requires you to confirm the replacement.

    [!IMPORTANT]
    You can't update the locked processes: Agile, Basic, CMMI, and Scrum.

  3. After a successful import, a confirmation message appears.

    [!div class="mx-imgBorder"]
    Screenshot shows Import process success confirmation dialog.

    If the process doesn't pass validation checks, a list of error messages appears. Correct each error and retry the import.

  4. You can immediately create a project using the newly imported process.

    [!div class="mx-imgBorder"]
    Screenshot of Import process actions menu, Create new team project from imported process.

  5. Complete the form that appears. For more information, see Create a project.

    [!div class="mx-imgBorder"]
    Screenshot showing new project dialog.

For other Hosted XML process management tasks, see Import and export a Hosted XML process.

::: moniker-end

::: moniker range="<azure-devops"

Manage a process template (On-premises XML process)

  1. To upload a process template, select the :::image type="icon" source="../../../media/icons/blue-add-icon.png" border="false":::Upload Process Template option.

    [!div class="mx-imgBorder"] Screenshot of web portal, All processes, Upload process template.

    In the Upload process template dialog, choose the .zip folder that contains the root file, ProcessTemplate.xml, for the process template that you want to upload. See also Process template restrictions and validation checks.

    [!div class="mx-imgBorder"] Screenshot of web portal, Upload process template dialog.

  2. To download or export a process template, select the :::image type="icon" source="../../media/icons/actions-icon.png" border="false"::: actions icon, and choose the Export option.

    [!div class="mx-imgBorder"] Screenshot of web portal, process context menu, Export Process.

  3. To set a process as the default when adding new projects or to disable a process from being used, select the :::image type="icon" source="../../media/icons/actions-icon.png" border="false"::: actions icon for the process, and select either the Set as default process or Disable process options.

    [!div class="mx-imgBorder"] Screenshot of web portal, process context menu, Disable or Delete a Process.

::: moniker-end

Correlate a process template with an existing project

To determine the type of process template that you used to create your project, review the work item types that appear in the New Work Item menu for Team Explorer and then compare them with the work item types in the following chart. If your work item types differ from those items, your project might use a custom process template.

::: moniker range="<=azure-devops"

Agile Basic CMMI Scrum
Agile work item types Basic work item types CMMI work item types Scrum work item types

::: moniker-end

Process template restrictions and validation checks

When you upload a process template through the web portal, validation errors might appear.

[!div class="mx-imgBorder"] Screenshot of Upload process template errors.

Resolve each error and retry the upload. For more information, see Resolve validation errors for process import.

The following validation checks must pass when you upload a process template:

  • Process template names must be unique and 256 Unicode characters or less. Same-named templates overwrite existing templates. Names can't contain the following characters: . , ; ' ` : / \ * | ? " & % $ ! + = ( ) [ ] { } < >. For more restrictions, see Naming restrictions.
  • Process template folders can't contain .exe files. If they do, the template might upload successfully, but project creation fails.
  • Process template total size must be 2 GB or less, or project creation fails.
  • The upload process runs a partial verification check to validate the XML in each process template file. If you receive errors, review the XML to determine the cause. Duplicate tags in an XML file can cause errors. If no XML errors exist, verify that all required files are included in the correct folder locations.
  • If XML definition files reference an extension, the extension must be installed and enabled in the collection.

Important

The schema definition for process templates uses a mix of camel case and all capitalized elements. If you encounter errors when validating your type definition files, check the case structure of your elements. Opening and closing tag casing must match according to XML syntax rules. For more information, see Process template plug-ins: Index to XML element definitions.

Related content