Upload or download a process template

Last Update: 4/14/2017

Team Services | TFS 2017 | TFS 2015 | TFS 2013

NOTE

Feature availability: From an on-premises Team Foundation Server (TFS), you can upload, download, and delete process templates. From Team Services, you can download process templates. For the Hosted XML and On-premises XML process models, you work with process templates to customize a process template to either update a team project or create a team project. To learn more, see Customize your work tracking experience.

When you choose to create a team project, the Project Creation Wizard (PCW) reads the process template to configure initial settings and upload artifacts and template files. Each process template defines the building blocks of the work item tracking system as well as other sub-systems you access through Team Services or an on-premises TFS. It supports Hosted XML and On-premises XMl process models which support customization of team projects through the modification and import of XML definition files.

IMPORTANT

When you create a team project from the web portal, several process template files are ignored. Specifically, the files that would create a Report Manager site and a SharePoint project portal aren't supported. These features aren't supported for Team Services.

If you want these features to be created for a team project on your on-premises TFS, then create your team project from Visual Studio or Team Explorer. For details, see Process template and plug-in files, Client support for project creation.

For a comparison of the default process templates—Agile, CMMI, and Scrum—see Choose a process.

You can upload, download, and delete process templates for a team project collection. Also, you can mark a template to appear as the default when you add team projects.

TIP

To access the latest versions of the default processes/process templates:

  • For the Inheritance process model (Team Services) or the On-premises XML process model (on-premises TFS):
  • For Hosted XML process model: Open the Process page from the account settings admin context, and choose the Export option from the actions menu of a default process. To learn more, see Manage processes.

To manage a process template

  1. Open the same version of Visual Studio, Visual Studio Community, or Team Explorer as the on-premises TFS that you connect to. For example, if you connect to a TFS 2015 instance, you must connect from Visual Studio 2015 or Visual Studio Community 2015. If you connect to Team Services, choose the latest version supported.

    You can always download a free version of Visual Studio Community from the Visual Studio download site.

    If you aren't a member of the Project Collection Administrators group, get added as one.

  2. From, Visual Studio, open the Process Template Manager from the Team, Team Project Collection Settings menu.

    Open Process Template Manager

    You'll see a list of each process template that has been uploaded to the team project collection.

    Select process template to work with

    The Upload, Download, Make Default, and Delete buttons are disabled when you don't have the necessary permissions to manage process templates.

  3. Select the process template that you want to work with and then choose from the following actions.

    Upload To upload a process template.

    In the Upload Process Template dialog box, choose the 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.

    Download To download the process template to a local computer.

    In the Download Process Template dialog box, select a folder where the process template will be downloaded.

    If you're downloading a process template to use to configure new features, manually add new features or update a custom process template to enable new features--choose the process that corresponds to the one you used previously to create your team project. For example, if you're updating a team project based on the Scrum process template, then select Scrum. Note that all version numbers have been removed from the process templates. If you don't see Agile, CMMI, or Scrum, then you need to update TFS.

    You can determine which process template to select based on the work item types defined for your existing team project.

    Make Default To cause the selected process template to appear as the default selection in the New Team Project Wizard.
    Delete To permanently remove the selected process template from the collection.

Process template correlation with an existing team project

To determine the type of process template that was used to create your team 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 shown listed, then a custom process template might have been used.

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

Process template restrictions and validation checks

Uploading a process template requires that it pass the following validation checks:

  • Process template names must be unique and 256 Unicode characters or less. Same-named templates will overwrite existing templates.
    Also, names cannot contain the following characters: . , ; ' ` : / \ * | ? " & % $ ! + = ( ) [ ] { } < >
    For additional restrictions, see Naming restrictions.
  • Process template folders can't contain any .exe files. If they do, the process template may upload successfully, however project creation will fail.
  • Process template total size should be 2 GB or less, or project creation will fail.
  • The upload process performs a partial verification check to make sure that the XML of each process template XML file is valid. If you receive any errors when you try to upload the process template, review the XML to determine the cause of the error. Note that duplicate tags in an XML file can cause errors. If there is no error in the XML, check to make sure all the appropriate files are included in your process template in the correct folder locations.
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. Also, the case structure of opening and closing tags must match according to the rules for XML syntax.

See Process template plug-ins: Index to XML element definitions.

Periodically, updates are made to the process templates to support new features. For details, see Changes made to process templates.

Update a process template to enable new features

When you upgrade your on-premises TFS to a later version, new features may become available. To gain access to these new features, you may need to update a customized process template.

Add another team project

You can add a team project from the web portal or Visual Studio/Team Explorer. Some process template files are ignored when you create a team project from the web portal. For details, see Process template and plug-in files, Client support for project creation.