透過工作項目類型定義 xml 在工作項目表單中新增延伸模組

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

您可以使用工具將工作項目類型匯出為 xml witadmin ，其中包含工作項目表單的配置。 在此範例中，我們會將頁面、群組和控件參與新增至版面配置。 我們也將控件新增至敏捷式「用戶劇本」工作項目類型。 如需詳細資訊，請參閱 WebLayout xml 參考。

注意

只有 Azure DevOps Server 不支援透過 xml 自定義工作項目表單，而不是 Azure DevOps Services。

在工作項目表單中新增延伸模組

1. 在 Azure DevOps Server 中安裝工作專案表單延伸模組。

2. 開啟 Developer Command Prompt。 使用下列命令將 xml 檔案匯出至桌面。

   witadmin exportwitd /collection:CollectionURL /p:Project /n:TypeName /f:FileName
   

   檔案會在您指定的目錄中建立。

3. 在此檔案中，移至 [WebLayout ] 區段。 在 WebLayout 區段中，批注 Blob 會指定哪些已安裝的延伸模組會以集合的工作專案表單為目標。 針對每個延伸模組，其所有窗體貢獻都會以其標識符和輸入列出（如果是控件貢獻）。 在下列範例中，批注會顯示 集合上安裝的 color-control-dev 擴充功能。 延伸模組有一個控件貢獻，採用兩個輸入。

        <!--**********************************Work Item Extensions***************************
   
    Extension:
        Name: color-control-dev
        Id: example.color-control-dev
   
        Control contribution:
            Id: example.color-control-dev.color-control-contribution
            Description:
            Inputs:
                Id: FieldName
                Description: The field associated with the control.
                Type: Field
                IsRequired: true
   
                Id: Colors
                Descriptions: The colors that match the values in the control.
                Type: String
                IsRequired: false
   

4. 在 [ 工作專案延伸模組] 區段中尋找您的延伸模組 識別碼：

        <!--**********************************Work Item Extensions*************************** 
   
    Extension:
        Name: color-control-dev
        Id: example.color-control-dev
        ...
   

5. 在 [工作專案延伸模組] 區段下方新增延伸模組標籤，如下所示，讓您的延伸模組可供工作項目窗體使用。 若要在窗體內放置貢獻，必須在 區段中指定 Extensions 其延伸模組。

        <!--**********************************Work Item Extensions***************************
        ...
   
        Note: For more information on work item extensions use the following topic:
        https://go.microsoft.com/fwlink/?LinkId=816513
        -->
   
        <Extensions>
            <Extension Id="example.color-control-dev" />
        </Extensions>
   

6. 指定 xml 中的延伸模組會自動將窗體內延伸模組中定義的頁面和群組貢獻放在窗體內。 您可以在下列範例中移動貢獻。

新增頁面貢獻

    <Page Id="Details">
    <PageContribution Id="<page contribution id>" />
    ...       

新增群組貢獻

    <Page Id="Details">
    ...
        <Section>
        ...
            <GroupContribution Id="<group contribution id>" />
            ...

頁面投稿和群組貢獻無法接受任何其他版面配置元素。

新增控件貢獻

不同於 頁面 和 群組 貢獻，指定 xml 中的延伸模組不會自動放置 控件 貢獻。 若要在表單中新增這些貢獻，請在窗體內加上參與標記。 下列範例會將 ControlContribution 新增至 Planning 群組。

如果控件貢獻已定義任何必要的輸入，用戶就必須為該輸入提供值。 對於任何非必要輸入，用戶可以決定是否要將值設定為輸入。 在下列範例中， FieldName 會設定 和 Colors 輸入。

    <Page Id="Details">
    ...
        <Section>
        ...
            <Group Id="Planning">
            ...
                <ControlContribution Label="Priority" Id="example.color-control-dev.color-control-contribution">
                    <Inputs>
                        <Input Id="FieldName" Value="Microsoft.Azure DevOps Services.Common.Priority" />
                        <Input Id="Colors" Value="red;green" />
                    </Inputs>
                </ControlContribution>

                <Control Label="Risk" Type="FieldControl" FieldName="Microsoft.Azure DevOps Services.Common.Risk" />

7. 使用 匯入 witadmin這個 xml 檔案。

   witadmin importwitd /collection:CollectionURL /p:Project /f:FileName

您的延伸模組是透過工作項目表單設定的！