Link

Export-TfsProcessTemplate

Exports a XML-based process template definition to disk.


Table of Contents

  1. Syntax
  2. Description
  3. Examples
  4. Parameters
  5. Inputs
  6. Related Links

Syntax

Export-TfsProcessTemplate
    [-ProcessTemplate <object>]
    [-Collection <object>]
    [-DestinationPath <string>]
    [-Force]
    [-NewDescription <string>]
    [-NewName <string>]

[Go to top]

Description

This cmdlet offers a functional replacement to the “Export Process Template” feature found in Team Explorer. All files pertaining to the specified process template (work item defininitons, reports, saved queries, process configuration and so on) are downloaded from the given Team Project Collection and saved in a local directory, preserving the directory structure required to later re-import it. This is specially handy to do small changes to a process template or to create a new process template based on an existing one.

[Go to top]

Examples

Example 1

Exports the Scrum process template from the DefaultCollection project collection in the VSALM server, saving the template files to the C:\PT\Scrum directory in the local computer.

PS> Export-TfsProcessTemplate -Process "Scrum" -DestinationPath C:\PT -Collection http://vsalm:8080/tfs/DefaultCollection

Example 2

Exports the Scrum process template from the DefaultCollection project collection in the VSALM server, saving the template files to the C:\PT\MyScrum directory in the local computer. Notice that the process template is being renamed from Scrum to MyScrum, so that it can be later reimported as a new process template instead of overwriting the original one.

PS> Export-TfsProcessTemplate -Process "Scrum" -DestinationPath C:\PT -Collection http://vsalm:8080/tfs/DefaultCollection -NewName "MyScrum" -NewDescription "A customized version of the Scrum process template"

Parameters

-Collection

Specifies the URL to the Team Project Collection or Azure DevOps Organization to connect to, a TfsTeamProjectCollection object (Windows PowerShell only), or a VssConnection object. You can also connect to an Azure DevOps Services organizations by simply providing its name instead of the full URL. For more details, see the Get-TfsTeamProjectCollection cmdlet. When omitted, it defaults to the connection set by Connect-TfsTeamProjectCollection (if any).

Type object
Position (Named)
Default Value (N/A)
Accept pipeline input True (byvalue)
Accept wildcard characters False

-DestinationPath

Path to the target directory where the exported process template (and related files) will be saved. A folder with the process template name will be created under this path. When omitted, templates are exported in the current directory.

Type string
Position (Named)
Default Value (N/A)
Accept pipeline input False
Accept wildcard characters False

-Force

Allows the cmdlet to overwrite an existing destination folder.

Type SwitchParameter
Position (Named)
Default Value (N/A)
Accept pipeline input False
Accept wildcard characters False

-NewDescription

Saves the exported process template with a new description. Useful when exporting a base template which will be used as a basis for a new process template. When omitted, the original description is used.

Type string
Position (Named)
Default Value (N/A)
Accept pipeline input False
Accept wildcard characters False

-NewName

Saves the exported process template with a new name. Useful when exporting a base template which will be used as a basis for a new process template. When omitted, the original name is used.

Type string
Position (Named)
Default Value (N/A)
Accept pipeline input False
Accept wildcard characters False

-ProcessTemplate

Specifies the name of the process template(s) to be exported. Wildcards are supported. When omitted, all process templates in the given project collection are exported.

Type object
Position 0
Default Value *
Accept pipeline input False
Accept wildcard characters False

Inputs

System.Object

Specifies the URL to the Team Project Collection or Azure DevOps Organization to connect to, a TfsTeamProjectCollection object (Windows PowerShell only), or a VssConnection object. You can also connect to an Azure DevOps Services organizations by simply providing its name instead of the full URL. For more details, see the Get-TfsTeamProjectCollection cmdlet. When omitted, it defaults to the connection set by Connect-TfsTeamProjectCollection (if any).