Dodawanie rozszerzeń w formularzu elementu roboczego za pomocą pliku XML definicji typu elementu roboczego

Artykuł
04/04/2024

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

Typ elementu roboczego można wyeksportować jako xml przy użyciu witadmin narzędzia, które zawiera układ formularza elementu roboczego. W ramach tego przykładu dodamy do układu stronę, grupę i kontrolujemy współtworzenie. Dodamy również kontrolkę do typu elementu roboczego Agile "User Story". Aby uzyskać więcej informacji, zobacz WebLayout xml reference (Dokumentacja xml elementu WebLayout).

Uwaga

Dostosowywanie formularza elementu roboczego za pośrednictwem kodu XML jest obsługiwane tylko w usłudze Azure DevOps Server, a nie w usługach Azure DevOps Services.

Dodawanie rozszerzenia w formularzu elementu roboczego

Zainstaluj rozszerzenia formularza elementu roboczego w usłudze Azure DevOps Server.
Otwórz klasę Developer Command Prompt. Wyeksportuj plik XML na pulpit za pomocą następującego polecenia.
```
witadmin exportwitd /collection:CollectionURL /p:Project /n:TypeName /f:FileName
```
Plik zostanie utworzony w określonym katalogu.

W tym pliku przejdź do sekcji WebLayout . W sekcji WebLayout obiekt blob komentarza określa, które zainstalowane rozszerzenia dotyczą formularzy elementów roboczych dla kolekcji. Dla każdego rozszerzenia wszystkie jego udziały w formularzach są wyświetlane wraz z identyfikatorami i danymi wejściowymi (jeśli jest to udział w kontrolce). W poniższym przykładzie komentarz przedstawia rozszerzenie color-control-dev zainstalowane w kolekcji. Rozszerzenie ma jeden udział w kontrolce, który przyjmuje dwa dane wejściowe.

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

Znajdź swój identyfikator rozszerzenia w sekcji Rozszerzenia elementów roboczych :

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

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

Dodaj tag rozszerzenia poniżej sekcji Rozszerzenia elementów roboczych , jak pokazano poniżej, aby udostępnić rozszerzenie formularzowi elementu roboczego. Aby umieścić wkład w formularzu, należy określić jego rozszerzenie w Extensions sekcji .

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

Określenie rozszerzeń w pliku XML powoduje automatyczne umieszczenie zarówno strony , jak i składek grupy zdefiniowanych w rozszerzeniach w formularzu. Możesz przenieść współtworzenie w poniższych przykładach.

Dodawanie współtworzenia strony

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

Dodawanie udziału w grupie

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

Współtworzenie strony i współtworzenie grupy nie może przyjmować żadnych innych elementów układu.

Dodawanie udziału kontrolki

W przeciwieństwie do współtworzenia stron i grup , określanie rozszerzeń w pliku XML nie powoduje automatycznego umieszczania kontrybuacji kontroli . Aby dodać te współtworzenie w formularzu, dodaj je z tagiem współtworzenia w formularzu. W poniższym przykładzie dodano element ControlContribution do grupy Planowanie .

Jeśli element kontrolny ma zdefiniowane jakiekolwiek wymagane dane wejściowe, użytkownicy muszą podać wartość dla tych danych wejściowych. W przypadku danych wejściowych, które nie są wymagane, użytkownicy mogą zdecydować, czy ustawić wartość na dane wejściowe. W poniższym przykładzie dane FieldName wejściowe i Colors są ustawiane.

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

Zaimportuj ten plik XML przy użyciu polecenia witadmin.

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

Rozszerzenie jest konfigurowane za pośrednictwem formularza elementu roboczego!

Udostępnij za pośrednictwem