Udostępnij za pośrednictwem

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

  • Artykuł

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 dodajemy do układu wkłady w zakresie strony, grupy i kontroli. Dodajemy również kontrolę do typu elementu roboczego Agile "Opowieść użytkownika". Aby uzyskać więcej informacji, zobacz Dokumentacja XML 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

  1. Zainstaluj rozszerzenia formularza elementu roboczego w usłudze Azure DevOps Server.

  2. Otwórz 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.

  3. W tym pliku przejdź do sekcji WebLayout . W sekcji WebLayout blok komentarza określa, które zainstalowane rozszerzenia dotyczą formularzy elementów roboczych w Twojej kolekcji. Dla każdego rozszerzenia wszystkie jego elementy formularza zostają wymienione wraz z identyfikatorami i danymi wejściowymi (jeśli jest to element kontrolny). W poniższym przykładzie komentarz przedstawia rozszerzenie color-control-dev zainstalowane w kolekcji. Rozszerzenie ma jeden element sterujący, który przyjmuje dwa wejścia.

         <!--**********************************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. Znajdź swój identyfikator rozszerzenia w sekcji Rozszerzenia elementów roboczych :

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

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

  5. 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>

  6. 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ść wkłady w poniższych przykładach.

Dodaj wkład na stronę

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

Dodaj wkład grupy

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

Wkład strony i wkład grupy nie mogą przyjmować żadnych innych elementów układu.

Dodaj wkład kontrolki

W przeciwieństwie do wkładów stron i grup, określanie rozszerzeń w pliku XML nie powoduje automatycznego umieszczania wkładów kontrolnych. Aby dodać te wkłady w formularzu, dodaj je z tagiem wkładu 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 wejściowe FieldName i Colors zostają ustawione.

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

  1. Zaimportuj ten plik XML przy użyciu polecenia witadmin.

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

Twoje rozszerzenie jest konfigurowane poprzez formularz elementu roboczego!