Aggiungere estensioni nel modulo dell'elemento di lavoro tramite xml definizione del tipo di elemento di lavoro

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

È possibile esportare un tipo di elemento di lavoro come xml usando lo witadmin strumento , che include il layout del modulo dell'elemento di lavoro. Come parte di questo esempio, si aggiungono i contributi di pagina, gruppo e controllo al layout. Aggiungiamo anche il controllo al tipo di elemento di lavoro Agile "User Story". Per altre informazioni, vedere Informazioni di riferimento su Xml WebLayout.

Aggiungere l'estensione nel modulo dell'elemento di lavoro

1. Installare le estensioni del modulo degli elementi di lavoro in Azure DevOps Server.

2. Aprire il file Developer Command Prompt. Esportare il file XML sul desktop con il comando seguente.

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

   Un file viene creato nella directory specificata.

3. All'interno di questo file passare alla sezione WebLayout . All'interno della sezione WebLayout, un BLOB di commenti specifica quali estensioni installate hanno come destinazione i moduli dell'elemento di lavoro per la raccolta. Per ogni estensione, tutti i contributi del modulo sono elencati con gli ID e gli input (se si tratta di un contributo di controllo). Nell'esempio seguente il commento mostra l'estensione color-control-dev installata nella raccolta. L'estensione ha un contributo di controllo che accetta due input.

        <!--**********************************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. Trovare l'ID estensione nella sezione Estensioni elemento di lavoro:

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

5. Aggiungere un tag di estensione sotto la sezione Estensioni elemento di lavoro, come illustrato di seguito, per rendere l'estensione disponibile per il modulo dell'elemento di lavoro. Per inserire un contributo all'interno del modulo, è necessario specificarne l'estensione nella Extensions sezione .

        <!--**********************************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. Se si specificano le estensioni nel file xml, i contributi di pagina e gruppo definiti nelle estensioni all'interno del modulo vengono inseriti automaticamente. È possibile spostare i contributi negli esempi seguenti.

Aggiungere un contributo alla pagina

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

Aggiungere un contributo al gruppo

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

Un contributo di pagina e un contributo di gruppo non possono accettare altri elementi di layout.

Aggiungere un contributo di controllo

A differenza dei contributi di pagina e gruppo , specificando le estensioni nel codice xml non inserisce automaticamente i contributi del controllo . Per aggiungere questi contributi nel modulo, aggiungerli con un tag di contributo all'interno del modulo. Nell'esempio seguente viene aggiunto controlContribution al gruppo Planning.

Se un contributo di controllo ha un input necessario definito, gli utenti devono assegnare un valore per tale input. Per qualsiasi input non richiesto, gli utenti possono decidere se impostare un valore sull'input. Nell'esempio seguente vengono impostati gli FieldName input e 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" />

7. Importare questo file XML usando witadmin.

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

L'estensione viene configurata tramite il modulo dell'elemento di lavoro.