Adicionar extensões no formulário de item de trabalho por meio da definição XML do tipo de item de trabalho

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

Você pode exportar um tipo de item de trabalho como xml usando a witadmin ferramenta, que inclui o layout do formulário do item de trabalho. Como parte deste exemplo, adicionamos as contribuições de página, grupo e controle ao layout. Também adicionamos o controle ao tipo de item de trabalho Agile "User Story". Para obter mais informações, consulte a referência xml do WebLayout.

Adicionar extensão no formulário do item de trabalho

1. Instale extensões de formulário de item de trabalho no Servidor do Azure DevOps.

2. Abra o Developer Command Prompt. Exporte o arquivo xml para sua área de trabalho com o comando a seguir.

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

   Um arquivo é criado no diretório especificado.

3. Dentro desse arquivo, vá para a seção WebLayout . Dentro da seção WebLayout, um bloco de comentários especifica quais extensões instaladas têm como alvo os formulários de item de trabalho para sua coleção. Para cada extensão, todas as suas contribuições de formulário são listadas com suas IDs e entradas (se for uma contribuição de controle). No exemplo a seguir, o comentário mostra a extensão color-control-dev instalada na coleção. A extensão tem uma contribuição de controle que usa duas entradas.

        <!--**********************************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. Localize sua ID de extensão na seção Extensões do Item de Trabalho :

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

5. Adicione uma marca de extensão abaixo da seção Extensões do Item de Trabalho , mostrada da seguinte maneira, para disponibilizar sua extensão para o formulário do item de trabalho. Para colocar uma contribuição dentro do formulário, sua extensão deve ser especificada na Extensions seção.

        <!--**********************************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. Especificar as extensões no xml coloca automaticamente dentro do formulário tanto as contribuições de página quanto as de grupo que são definidas nas extensões. Você pode mover as contribuições nos exemplos a seguir.

Adicionar contribuição de página

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

Adicionar contribuição de grupo

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

Uma contribuição de página e uma contribuição de grupo não podem usar outros elementos de layout.

Adicionar contribuição de controle

Ao contrário das contribuições de página e grupo, ao especificar as extensões no xml, não se adicionam automaticamente as contribuições de controle. Para adicionar essas contribuições no formulário, adicione-as com uma etiqueta de contribuição dentro do formulário. O exemplo a seguir adiciona o ControlContribution ao grupo Planejamento .

Se uma contribuição de controle tiver qualquer entrada necessária definida, os usuários deverão fornecer um valor para essa entrada. Para qualquer entrada não necessária, os usuários podem decidir se devem definir um valor para a entrada. No exemplo a seguir, as entradas FieldName e Colors são configuradas.

    <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. Importe este arquivo xml usando witadmin.

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

Sua extensão é configurada por meio do formulário de item de trabalho!