Lägga till tillägg i arbetsobjektsformulär via definitions-xml för arbetsobjekttyp

Artikel
04/04/2024

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

Du kan exportera en typ av arbetsobjekt som xml med hjälp av witadmin verktyget, som innehåller layouten för arbetsobjektsformuläret. Som en del av det här exemplet lägger vi till sidan, gruppen och styr bidrag till layouten. Vi lägger också till kontrollen till arbetsobjekttypen Agile "User Story". Mer information finns i WebLayout xml-referens.

Kommentar

Anpassning av arbetsobjektsformulär via XML stöds endast på Azure DevOps Server, inte Azure DevOps Services.

Lägga till tillägg i arbetsobjektsformulär

Installera formulärtillägg för arbetsobjekt i Azure DevOps Server.
Öppna Developer Command Prompt. Exportera XML-filen till skrivbordet med följande kommando.
```
witadmin exportwitd /collection:CollectionURL /p:Project /n:TypeName /f:FileName
```
En fil skapas i den katalog som du har angett.

I den här filen går du till avsnittet WebLayout . I avsnittet WebLayout anger en kommentarsblob vilka installerade tillägg som är målformulär för arbetsobjekt för samlingen. För varje tillägg visas alla dess formulärbidrag med sina ID:n och indata (om det är ett kontrollbidrag). I följande exempel visar kommentaren tillägget color-control-dev installerat på samlingen. Tillägget har ett kontrollbidrag som tar två indata.

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

Hitta ditt tilläggs-ID i avsnittet Arbetsobjekttillägg :

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

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

Lägg till en tilläggstagg under avsnittet Arbetsobjekttillägg , som visas på följande sätt, för att göra tillägget tillgängligt för arbetsobjektsformuläret. Om du vill placera ett bidrag i formuläret måste dess tillägg anges i avsnittet 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>

Om du anger tilläggen i xml-koden placeras automatiskt både sidan och gruppbidragen som definierats i tilläggen i formuläret. Du kan flytta bidragen i följande exempel.

Lägg till sidbidrag

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

Lägg till gruppbidrag

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

Ett sidbidrag och ett gruppbidrag kan inte ta andra layoutelement.

Lägg till kontrollbidrag

Till skillnad från sid- och gruppbidrag placerar du inte automatiskt kontrollbidrag när du anger tilläggen i xml. Lägg till de här bidragen i formuläret genom att lägga till dem med en bidragstagg i formuläret. I följande exempel läggs ControlContribution till i gruppen Planering .

Om ett kontrollbidrag har definierat nödvändiga indata måste användarna ange ett värde för dessa indata. För indata som inte krävs kan användarna bestämma om ett värde ska anges till indata. I följande exempel FieldName anges indata och 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" />

Importera den här XML-filen med hjälp av witadmin.

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

Ditt tillägg konfigureras via arbetsobjektsformuläret!

Dela via