Hinzufügen von Erweiterungen im Arbeitsaufgabenformular über xml-Definition des Arbeitselementtyps

Artikel
04/04/2024

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

Sie können einen Arbeitsaufgabentyp als XML mithilfe des witadmin Tools exportieren, das das Layout des Arbeitsaufgabenformulars enthält. Im Rahmen dieses Beispiels fügen wir dem Layout die Seiten-, Gruppen- und Steuerelement-Beiträge hinzu. Außerdem fügen wir das Steuerelement dem Arbeitsaufgabentyp "Agile User Story" hinzu.We also add the control to the Agile "User Story" work item type. Weitere Informationen finden Sie unter WebLayout xml reference.

Hinweis

Die Anpassung des Arbeitselementformulars über XML wird nur auf Azure DevOps Server und nicht auf Azure DevOps Services unterstützt.

Erweiterung im Arbeitsaufgabenformular hinzufügen

Installieren Sie Formularerweiterungen für Arbeitsaufgaben in Azure DevOps Server.
Öffnen Sie die Datei Developer Command Prompt. Exportieren Sie die XML-Datei mit dem folgenden Befehl auf Ihren Desktop.
```
witadmin exportwitd /collection:CollectionURL /p:Project /n:TypeName /f:FileName
```
Eine Datei wird im angegebenen Verzeichnis erstellt.

Wechseln Sie in dieser Datei zum WebLayout-Abschnitt . Innerhalb des WebLayout-Abschnitts gibt ein Kommentar-BLOB an, welche installierten Erweiterungen für Arbeitsaufgabenformulare für Ihre Sammlung vorgesehen sind. Für jede Erweiterung werden alle Formular-Beiträge mit ihren IDs und Eingaben aufgelistet (wenn es sich um einen Control-Beitrag handelt). Im folgenden Beispiel zeigt der Kommentar die in der Auflistung installierte Farbsteuerelement-Dev-Erweiterung an. Die Erweiterung hat einen Steuerbeitrag, der zwei Eingaben benötigt.

     <!--**********************************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

Suchen Sie Ihre Erweiterungs-ID im Abschnitt "Arbeitselementerweiterungen ":

     <!--**********************************Work Item Extensions*************************** 

 Extension:
     Name: color-control-dev
     Id: example.color-control-dev
     ...

Fügen Sie unterhalb des Abschnitts "Arbeitselementerweiterungen" ein Erweiterungstag hinzu, das wie folgt dargestellt wird, um Die Erweiterung für das Arbeitsaufgabenformular verfügbar zu machen. Um einen Beitrag innerhalb des Formulars zu platzieren, muss seine Erweiterung im Extensions Abschnitt angegeben werden.

     <!--**********************************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>

Wenn Sie die Erweiterungen im XML-Code angeben, werden sowohl die Seite als auch die Gruppe Beiträge, die in den Erweiterungen innerhalb des Formulars definiert sind, automatisch platziert. Sie können die Beiträge in den folgenden Beispielen verschieben.

Hinzufügen eines Seitenbeitrags

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

Gruppenbeitrag hinzufügen

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

Ein Seitenbeitrag und ein Gruppenbeitrag können keine anderen Layoutelemente annehmen.

Hinzufügen eines Steuerelementbeitrags

Im Gegensatz zu Seiten- und Gruppen-Beiträge werden die Erweiterungen in der XML-Datei nicht automatisch Beiträge platziert. Um diese Beiträge im Formular hinzuzufügen, fügen Sie sie mit einem Beitragstag innerhalb des Formulars hinzu. Im folgenden Beispiel wird der Planungsgruppe die ControlContribution hinzugefügt.

Wenn ein Steuerelementbeitrag eine erforderliche Eingabe definiert hat, müssen Benutzer einen Wert für diese Eingabe festlegen. Bei nicht erforderlichen Eingaben können Benutzer entscheiden, ob ein Wert auf die Eingabe festgelegt werden soll. Im folgenden Beispiel werden die und Colors die FieldName Eingaben festgelegt.

    <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" />

Importieren Sie diese XML-Datei mit witadmin.

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

Ihre Erweiterung wird über das Arbeitsaufgabenformular konfiguriert!

Freigeben über