本地 XML 进程自定义

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

本地 XML 过程模型支持自定义项目的工作跟踪对象和敏捷工具。 使用此模型,可以更新工作项类型、流程配置、类别等的 XML 定义。 还可以更新字段的属性。

自定义工作跟踪体验以支持业务和报告需求。 最常见的自定义包括添加自定义字段、修改工作项窗体或添加自定义工作项类型。

注意

有关配置和自定义项目和团队以支持业务需求的指导,请查看配置和自定义Azure Boards

对于 Azure DevOps Server 2019 及更高版本,可以选择流程模型。 创建项目集合时,需要在本地 XML 进程模型和继承进程模型之间进行选择。 若要了解详细信息,请参阅 自定义工作跟踪、为项目集合选择流程模型

Team Foundation Server 使用本地 XML 进程模型来支持自定义。 此模型依赖于使用 witadmin 命令行工具更新和导入 XML 文件。

重要

若要自定义Azure DevOps Services项目,请参阅关于进程自定义和继承的进程。 本文仅适用于本地部署。

支持的自定义项

使用本地 XML 进程模型时,可以执行以下任务。

区域

自定义支持

字段

选取列表

工作项类型

积压工作和进程配置

过程模板

链接类型

自定义序列

管理本地部署时,可按以下顺序执行大多数自定义。 此序列支持更新 WIT、全局列表、进程配置和类别的 XML 定义。 此序列通过导入各自的修改后的 XML 定义文件支持单个更新。 建议在存储库中维护 XML 定义文件,以便进行版本控制。

导出 XML 定义文件编辑 XML 定义文件导入 WIT 定义文件刷新并验证更改

此外,可以使用 witadmin 工具列出对象、重命名 WIT、永久删除 WIT 等。

提示

使用 witadmin,可以 导入和导出定义文件。 可以使用的其他工具包括进程编辑器 (要求你已安装 Visual Studio) 版本。 从 Visual Studio 市场安装进程模板编辑器

提示

使用 witadmin,可以 导入和导出定义文件。 可以使用的其他工具包括进程编辑器 (要求你已安装 Visual Studio) 版本。 从 Visual Studio 市场安装 TFS 进程模板编辑器。 可以使用此版本的进程编辑器来修改旧式工作项表单。 不能使用它来编辑与 新 Web 窗体关联的表单

或者,可以使用 TFS 团队项目经理,这是 GitHub 提供的开源客户端。

维护和升级影响

在自定义之前,应了解升级应用程序层服务器时自定义项对项目的影响。

升级到本地部署可能会引入新功能,这些功能需要更新用于跟踪工作的对象。 这些对象包括工作项类型、类别和过程配置。 尽量减少对 WIT 或进程配置的工作流的更改,有助于最大程度地减少升级部署时必须完成的工作。

若要最大限度地减少升级后需要完成的手动工作量,请了解哪些自定义支持简单的更新路径,哪些不支持。

兼容快速更新

通过以下自定义项,可以使用“配置功能向导”自动对新功能所需的项目应用任何更改。

  • 字段:添加自定义字段、自定义选取列表、添加或修改区域和迭代路径、将规则添加到字段
  • WIT:添加自定义 WIT、更改窗体布局
  • 类别:添加自定义类别
  • 敏捷工具:自定义看板上的列,自定义快速添加面板
  • Office 集成:添加或更改将 Project 字段映射到 TFS 字段的方式

若要详细了解配置功能向导,请参阅 在升级后配置功能

兼容,但可能需要手动更新

配置功能向导要求项目中存在特定的工作项类型、工作流状态和字段。 进行以下自定义时,可能需要修改自定义过程才能运行向导,或者可能需要手动更新项目。

  • 字段:更改现有字段的属性,删除进程配置中引用的字段
  • WIT:更改工作流
  • 敏捷工具:更改为“要求类别”、“任务类别”或“功能类别”定义的 WIT。
  • 敏捷工具:更改进程配置中定义的元州映射。
  • 敏捷工具:更改进程配置中为 TypeField 指定的字段。

此外,对 WIT 或工作流所做的更改可能需要更新随流程提供的其他项目,例如 Excel 或SQL Server Reporting Services报表。

要避免的自定义

应避免进行以下自定义,因为它们可能会导致数据仓库中的架构冲突,或在 TFS 升级后更新项目时导致问题。

  • 字段:
    • (WIT 定义文件中指定的字段更改字段的友好名称)
    • 更改一个或多个报告属性,或属性以将人员姓名与默认字段的 Active Directory 同步
  • WIT:重命名或删除 WIT
  • 类别:更改默认类别的名称,或更改默认类别中指定的 WIT

若要了解有关报表属性的详细信息,请参阅 添加或修改工作项字段以支持报告

  • 标识用于自定义支持跟踪需求的 WIT 的最佳选项。 更改跟踪工作项的对象时,应确定这些更改将如何影响现有和未来项目。
  • 将进程和所有 XML 定义文件置于版本控制之下。 请勿部署已定义但尚未存储在储存库中的对象。
  • 像测试软件那样测试自定义对象。
  • 最大程度减少引入的自定义字段的数目。 最大程度地减少可报告的字段的数目。

将团队区域路径替换为团队字段

项目的默认配置将每个团队与一个区域路径相关联。 如果你的组织有几个团队通过共同的积压工作 (backlog) 进行工作并跨多个产品区域,则此配置可能不适合你希望组织执行工作的方式。 通过添加自定义字段来表示你组织中的团队,你可以重新配置敏捷计划工具和页面来支持你的团队并将工作分离到团队和区域路径。

使用团队字段而不是区域路径来支持团队 介绍了如何更改默认配置。