Fält och attribut för arbetsobjekt i Azure Boards
Azure DevOps Services | Azure DevOps Server 2022 – Azure DevOps Server 2019
Arbetsobjektfält används för att spåra information. Fält definieras för en organisation och delas mellan alla projekt som definierats för den organisationen. Du kan använda ett av två verktyg för att granska de fält som definierats för organisationen. Dessa verktyg är tillgängliga för både ärvda och värdbaserade XML-processmodeller.
Arbetsobjektfält används för att spåra information. Fält definieras för en samling och delas mellan alla projekt som definierats för samlingen. Du kan använda ett av två verktyg för att granska fälten som definierats för samlingen.
- Sidan Processfält>: Tillgänglig för ärvd processmodell
- Fältutforskaren för arbetsobjekt: Tillgänglig för ärvda och lokala XML-processmodeller.
En beskrivning av varje fält som definierats med en systemprocess finns i Index för arbetsobjektfält.
Förutsättningar
- Om du vill visa fälten som definierats för en organisation eller samling måste du vara medlem i programgruppen Giltiga användare för projektsamling eller ha behörigheten Visa information på instansnivå inställd på Tillåt för organisationen eller samlingen.
Lista eller granska fält
Om du vill visa eller granska fält kan du använda något av följande verktyg, beroende på processmodellen – arv, värdbaserad XML eller lokal XML – som du använder. Ett index över fält som definierats i standardprocesserna finns i Fältindex för arbetsobjekt.
Verktyg | Arv | Värdbaserad XML | Lokal XML |
---|---|---|---|
Webbportal: Lista ärvda och anpassade fält | ✔️ | ✔️1 | |
Fältutforskaren för arbetsobjekt | ✔️ | ✔️ | ✔️ |
kommandoradsverktyget witadmin listfields | ✔️ | ✔️ | ✔️ |
Kommentar
- Stöds endast för standardprocesser (Agile, CMMI, Scrum).
Fältdatatyper och namn
Varje typ av arbetsobjekt anger de fält som definierats för de arbetsobjekt som refererar till den typen. Varje fält är associerat med ett antal attribut, varav många anges av systemet och kan inte ändras.
Varje fält definieras av följande tre attribut.
- Datatyp: Anger vilken typ av data som kan anges i fältet, till exempel boolesk, dubbel, heltal, HTML och sträng. Beskrivningar av varje datatyp finns i Frågefält, operatorer och makron.
- Eget namn: Anger det namn som tilldelats fältet och som du väljer för ett fält i en frågesats. Det här namnet kan skilja sig från namnet som visas i arbetsobjektsformuläret.
- Referensnamn: Anger det namn som du använder när du skapar WIQL-fråga eller en improviserad arbetsobjektmall, använder REST API-kommandon eller definierar definitioner av XML-arbetsobjektstyp. När referensnamnet har definierats kan det inte ändras.
En beskrivning av varje fältattribut och hur du kan visa dem finns i Fältattribut och Listfältattribut senare i den här artikeln. En översikt över WIT och arbetsobjekt finns i Spåra arbete med användarberättelser, problem, buggar, funktioner och epos.
Vad är ett fält? Hur används fältnamn?
Varje typ av arbetsobjekt är associerad med 31 systemfält och flera fler typspecifika fält. Du använder arbetsobjekt för att planera och spåra projektet.
Varje fält stöder spårning av information om det arbete som ska utföras. Värden som du tilldelar ett fält lagras i datalagret för arbetsspårning som du kan skapa frågor för att fastställa status och trender.
Beskrivningar och användning av varje fält som definierats för kärnsystemprocesserna, Agile-, Basic-, Scrum- och CMMI-processer finns i Fältindex för arbetsobjekt.
Fält-namn:
Ett fältnamn för arbetsobjekt identifierar unikt varje arbetsobjektfält. Kontrollera att fältnamnen ligger inom dessa riktlinjer:
- Fältnamn måste vara unika i konto-/projektsamlingen
- Fältnamnen måste vara 128 eller färre Unicode-tecken
- Fältnamn får inte innehålla inledande eller avslutande blanksteg eller två eller flera blanksteg i följd
- Fältnamn måste innehålla minst ett alfabetiskt tecken
- Fältnamn får inte innehålla följande tecken:
.,;'`:~\/\*|?"&%$!+=()[]{}<>
.
Eftersom anpassade fält har definierats för en organisation eller samling kan du inte lägga till ett anpassat fält i en process med samma fältnamn som du lägger till i en annan process.
Mer information finns i Namngivningsbegränsningar och konventioner.
System- och fördefinierade fält
Alla systemdefinierade fält har referensnamn som börjar med System, till exempel System.AreaPath, System.AssignedTo och fortsätter i det mönstret.
Fördefinierade fält som definieras av standardprocessen börjar med Microsoft.VSTS och skiljer sig sedan ytterligare beroende på deras användning. Exempel på fördefinierade fält som används gemensamt, för schemaläggning och integrering med Office Project, för integrering med Team Foundation Build och integrering med testfallshantering (TCM) är följande:
- Microsoft.VSTS.Common.Priority
- Microsoft.VSTS.Scheduling.DueDate
- Microsoft.VSTS.Build.FoundIn
- Microsoft.VSTS.TCM.Steps
En översikt över alla system- och fördefinierade fält som har definierats för standardprocesser/processmallar finns i Fältindex för arbetsobjekt. Mer information om hur du anger fältnamn finns i Namngivningsbegränsningar.
Anpassade fält
Eftersom anpassade fält har definierats för en organisation eller projektsamling kan du inte lägga till ett anpassat fält i en process med samma fältnamn som du lägger till i en annan process.
Observera följande gränser när du lägger till anpassade fält:
- Högst 64 fält kan definieras för varje WIT
- Högst 512 fält kan definieras per process
Fältdatatypen avgör typ och storlek på data som du kan lagra i fältet. Ett fält kan bara ha en typ som definierats i en projektsamling. Den här begränsningen uppmuntrar organisationer att använda vanliga fält mellan projekt och arbetsobjektstyper.
När du lägger till ett anpassat fält i en ärvd process tilldelar Azure DevOps ett referensnamn med prefixet Custom och sedan namnet på fältet med borttagna blanksteg. Du kan till exempel lägga till ett fält med namnet DevOps Triage. Referensnamnet är Custom.DevOpsTriage. Inga blanksteg tillåts i referensnamnet.
Hur kan jag fastställa fältdatatypen?
Du kan visa datatypen för fält som definierats för din organisation genom att öppna sidan Processfält>.
När din projektsamling använder arvsprocessmodellen för att anpassa arbetsspårning kan du visa datatypen för fält genom att öppna sidan Processfält>.
Om den lokala XML-processmodellen används kan du söka efter datatypen via fältindexet Arbetsobjekt. Du kan också öppna Fältutforskaren för arbetsobjekt för att granska de fält som definierats och deras attributtilldelningar, eller använda kommandot witadmin listfields för att visa fältattributen. Mer information finns i Fältutforskaren för arbetsobjekt och fältattribut för lista senare i den här artikeln.
Sidan Processfält>
Om du vill granska listan över fält som har definierats för en organisation eller samling öppnar du Processfält> för organisationsinställningar>.
Välj Azure DevOps-logotypen för att öppna Projekt. Välj sedan Organisationsinställningar.
Välj sedan Process.
Kommentar
Om du inte ser Process arbetar du från TFS-2018 eller tidigare version. Sidan Process stöds inte. Du måste använda de funktioner som stöds för den lokala XML-processmodellen.
Välj sedan Fält.
Fälten som visas motsvarar alla fält som definierats för organisationen eller samlingen. Detta omfattar alla anpassade fält och de som definierats för systemprocesser.
Kommentar
Om du inte ser Fält använder samlingen den lokala XML-processen. Sidan Fält stöds inte för den processen.
För beskrivningar och användning av varje fält, samt referensnamnet för varje fält, kan du söka efter det från fältindexet Arbetsobjekt. Du kan också hämta referensnamnet för fält från fältet Arbetsobjekttyper – LISTA REST API.
Fältutforskaren för arbetsobjekt
Du kan söka efter tilldelningar av fältattribut med hjälp av verktyget Fältutforskaren för arbetsobjekt.
För att få åtkomst till Fältutforskaren för arbetsobjekt måste du installera verktyget Processredigeraren. Baserat på vilken version av Visual Studio du har installerat hämtar du verktyget Processredigeraren från något av följande tillägg.
- Visual Studio 2019 & 2022: Från och med nu finns det inget specifikt tillägg för processmallsredigeraren. Men du kan fortfarande anpassa processmallar med andra verktyg, till exempel valfri textredigerare eller XML-redigerare. Du kan också använda Azure DevOps-webbportalen för vissa anpassningar, särskilt för ärvda processer.
- Visual Studio 2017: TFS Process Template Editor. Du kan också använda den här versionen av processredigeraren för att ändra de gamla arbetsobjektsformulären. Du kan inte använda den för att redigera formulär som är associerade med de nya webbformulären.
- Visual Studio 2015: TFS Power Tools.
Fältattribut
Det finns många icke-ändringsbara och dolda attribut för varje arbetsobjektfält. I följande tabell beskrivs alla attribut. Attribut har olika namn baserat på om du får dem via verktyget Fält – HämtaREST API eller visa dem via verktyget Work Item Field Explorer (WIFE).
Attribut som tilldelats ett fält beror på vilken plattform och version du använder. Vissa attribut har till exempel inte stöd för arvsprocessen. Information om hur du letar upp referensnamnet för ett fält finns i Index för arbetsobjektfält.
Attribut
Attributtyp
Beskrivning
REST:
FRU: AllowedValues
samling
Hämtar samlingen med giltiga värden för ett fält som innehåller listlistevärden. Du kan ändra detta genom att ange en listruta eller global lista (lokalt).
Kan ändras?=Ja
REST: canSortBy
FRU: CanSortBy
boolean
Anger om du kan sortera frågeresultat med det här fältet.
Kan ändras?=Nej
REST: beskrivning
FRU: HelpText
sträng
Anger en beskrivning för fältet, som också definierar hjälptexten som visas när du hovrar över fältet i arbetsobjektsformuläret.
Kan ändras?=Ja
REST:
FRU: ID
Integer
Anger fältets interna ID.
Kan ändras?=Nej
REST:
FRU: IsCloneable
boolean
Anger om värdet som definierats för fältet kopieras när en användare väljer att kopiera ett arbetsobjekt. Till exempel kopieras fälten Rubrik, Taggar och Beskrivning , men fälten ID och Historik kopieras inte.
Kan ändras?=Nej
REST:
Fru: IsComputed
boolean
Anger om värdet som anges av det här fältet beräknas av systemet (Sant) eller inte (Falskt). Exempel på beräknade fält är de som anges av systemet, till exempel ID, Reviderat datum, Ändrat datum och Antal externa länkar.
Kan ändras?=Nej
REST:
Fru: IsCoreField
boolean
Anger om det här fältet har angetts för alla typer av arbetsobjekt.
Kan ändras?=Nej
REST:
FRU: ÄrRedigerbar
boolean
Anger om användarna kan ändra det här fältet (Sant) eller inte (falskt). Exempel på icke-redigerbara fält är de som anges av systemet, till exempel fälten ID, Revision, Skapad av och Ändrad av
Kan ändras?=Nej
REST: isIdentity
FRU: Isidentity
boolean
Anger om det här fältet är ett identitetsfält . Identitetsfält är strängfält som används för att lagra användaridentiteter.
Kan ändras?=Nej
REST:
FRU: IsIndexed1
boolean
Anger om det här fältet är indexerat för sökning.
Kan ändras?=Nej
REST:
FRU: IsLongText
boolean
Anger att fältet kan innehålla mer än 255 tecken, till exempel fält som tilldelats en datatyp av oformaterad text, HTML eller historik.
Kan ändras?=Nej
REST: isPicklist2 FRU:
boolean
Anger om fältet är associerat med en listruta. Värdet anges till Sant när ett anpassat fält har definierats för Azure DevOps- och Picklist-typ (sträng) eller listruta (heltal). Värdet är inställt på False för ärvda fält som definierar listrutor.
Kan ändras?=Nej
REST: isPicklistSuggested2 FRU:
boolean
Anger om fältet tillåter användare att ange sina egna värden för en listruta. Värdet är inställt på Sant när ett anpassat fält har definierats för Azure DevOps- eller Picklist-typen (Sträng) eller Picklist (Heltal), och kryssrutan Tillåt användare att ange sina egna värden är markerad.
Kan ändras?=Ja
REST: isQueryable
Fru: IsQueryable
boolean
Anger om fältet visas i uppsättningen med fält som du kan lägga till för att filtrera en arbetsobjektfråga (Sant) eller inte (Falskt). De flesta fält är frågebara.
Kan ändras?=Nej
REST:
FRU: IsReportable 3
boolean
Anger om det rapportbara attributet har definierats eller angetts till något annat än Inget. Det här attributet kan ändras för lokala miljöer.
Kan ändras?=Ja
REST:
FRU: IsUsedInGlobalWorkflow
boolean
Anger om fältet har definierats i ett globalt arbetsflöde.
Kan ändras?=Nej
REST:
FRU: IsUserNameField
boolean
Anger om fältet används för att visa ett identitetsfält.
Kan ändras?=Nej
REST: name
FRU: Namn
sträng
Eget namn som tilldelats fältet. Det egna namnet kan inte ändras för Azure DevOps, men kan ändras lokalt med hjälp av kommandot witadmin changefield .
Kan bara ändras?=Endast lokalt
REST: picklistId
FRU: HelpText
GUID
Om fältet är en listruta, identifieraren för den associerade listrutan, annars null. Ett unikt GUID-värde tilldelas när ett anpassat fält har definierats för Azure DevOps- och Picklist-typen (Sträng) eller Picklist (Heltal).
Kan ändras?=Nej
REST:
FRU: ProhibitedValues
samling
Hämtar samlingen med förbjudna värden för ett fält som anger sådana värden. Du kan bara definiera förbjudna värden för lokala distributioner.
Kan bara ändras?=Endast lokalt
REST: readOnly
HUSTRU:
boolean
Anger om fältet är skrivskyddat. För Azure DevOps Services kan endast anpassade fält ändras till skrivskyddade. Det går inte att ändra systemfält.
Kan ändras?=Ja
REST: referenceName
FRU: ReferenceName
sträng
Anger referensnamnet för ett fält.
Kan ändras?=Nej
REST:
FRU: ReportingAttributes3
Anger information, dimension eller mått, beroende på om och hur du vill att fältet ska inkluderas i rapporter. Data från fält som har ett annat värde än Ingen för det här attributet exporteras till informationslagret och kan tas med i SQL-rapporter.
Kan bara ändras?=Endast lokalt
REST:
FRU: ReportingName3
sträng
Anger etiketten för ett fält när data visas i SQL-rapporter. Om du inte anger något värde används fältets eget namn.
Kan bara ändras?=Lokalt
REST:
FRU: ReportingReferenceName3
sträng
Anger ett annat referensnamn än ett fält som används när data exporteras till relationsdatalagret. Om du inte anger något värde används fältreferensnamnet.
Kan bara ändras?=Lokalt
REST: supportedOperations
HUSTRU:
ställa
Den uppsättning frågeoperatorer som är giltiga för användning när du refererar till det här fältet. En snabbreferens för åtgärder som stöds baserat på datatyp finns i Snabbreferens för frågor, Operatorer och makron som stöds för varje datatyp.
Kan ändras?=Nej
REST:
FRU: SupportsTextQuery
boolean
Anger om fältet stöder textfrågor som Innehåller ord, Innehåller inte ord.
Kan ändras?=Nej
REST:
FRU: SystemType
sträng
Anger datatypen för fältet och refererar till systemnamnet, till exempel System.DateTime eller System.String.
Kan ändras?=Nej
REST: typ
FRU: FieldType
sträng
Anger datatypen för fältet, till exempel Booleskt värde, DateTime, Heltal, Sträng och så vidare. En fullständig lista och beskrivningar finns i Frågefält, operatorer och makron.
Kan ändras?=Nej
REST: användning
FRU: Användning
sträng
Anger om fältet är avsett att användas med arbetsobjekt (WorkItem) eller arbetsobjektlänkobjekt (WorkItemLink). Användningen för de flesta fält är WorkItem. En fullständig lista över användningsvärden finns i Hämta fält, FieldUsage.
Kan ändras?=Nej
Kommentar
- För lokala distributioner kan du aktivera indexering för ett fält för att förbättra frågesvarstiderna vid filtrering på fältet. Mer information finns i Indexerade fält senare i den här artikeln.
- Attributen isPicklist och isPicklistSuggested tilldelas endast till anpassade fält som definierats för en ärvd process. Den ärvda processmodellen stöds för Azure DevOps Server 2019 och senare versioner. Mer information finns i Ärvd processmodell.
- Alla rapportattribut är endast giltiga för lokala distributioner vars projekt har konfigurerats för att stödja SQL Server Reporting och SQL Server Analysis Services.
Rapportbara attribut
Alla rapportattribut är endast giltiga för lokala distributioner vars projekt har konfigurerats för att stödja SQL Server Reporting och SQL Server Analysis Services. Mer information finns i Lägga till rapporter i ett projekt.
En beskrivning av varje rapportbart attribut finns i [Lägg till eller ändra arbetsobjektfält som stöd för rapportering]((/previous-versions/azure/devops/reference/xml/add-or-modify-work-item-fields-to-support-reporting).
En lista över fält som har rapportbara attribut som definierats som standard finns i Referens för rapportbara fält .
Indexerade fält
Du kan aktivera eller inaktivera indexering för ett arbetsobjektfält med hjälp av kommandot witadmin indexfield . När du aktiverar indexering för ett fält kan du öka prestandan för att hitta arbetsobjekt vars frågor anger det fältet. Som standard indexeras följande fält: Tilldelad till, Skapat datum, Ändrat efter, Tillstånd, Orsak, Områdes-ID, Iterations-ID och Typ av arbetsobjekt.
Om du lägger till ett anpassat fält som du använder i många av dina arbetsobjektfrågor kanske du vill aktivera indexering för det fältet. Mer information finns i Hantera arbetsobjektfält (witadmin).
Lista fältattribut
Du kan visa en lista över de attribut som tilldelats ett fält med hjälp av Fält – Hämta REST API. Ange organisationsnamnet för OrganizationName.
https://dev.azure.com/OrganizationName/_apis/wit/fields/FieldReferenceName
Här listar vi till exempel attributen för iterationssökvägen och anger referensnamnet, System.IterationPath
, för fabrikam-organisationen.
https://dev.azure.com/fabrikam/_apis/wit/fields/System.IterationPath
Returnerade data:
{
"name": "Iteration Path",
"referenceName": "System.IterationPath",
"description": "The iteration within which this bug will be fixed",
"type": "treePath",
"usage": "workItem",
"readOnly": false,
"canSortBy": true,
"isQueryable": true,
"supportedOperations": [
{
"referenceName": "SupportedOperations.Under",
"name": "Under"
},
{
"referenceName": "SupportedOperations.NotUnder",
"name": "Not Under"
},
{
"referenceName": "SupportedOperations.Equals",
"name": "="
},
{
"referenceName": "SupportedOperations.NotEquals",
"name": "<>"
},
{
"referenceName": "SupportedOperations.In",
"name": "In"
},
{
"name": "Not In"
}
],
"isIdentity": false,
"isPicklist": false,
"isPicklistSuggested": false,
"url": "https://dev.azure.com/mseng/_apis/wit/fields/System.IterationPath"
}
Du kan visa en lista över de attribut som tilldelats ett fält med hjälp av Fält – Hämta REST API. Ange organisationsnamnet för OrganizationName. Information om hur du kommer igång med REST finns i REST API-referens för Azure DevOps Services
https://{ServerName:Port}/tfs/{Collection}/_apis/wit/fields/FieldReferenceName?api-version={version}
Här listar vi till exempel attributen för iterationssökvägen och anger referensnamnet, System.IterationPath
, för fabrikam-servern.
https://fabrikam:8080/tfs/DefaultCollection/_apis/wit/fields/System.IterationPath?api-version=4.1
Returnerade data:
{
"name": "Iteration Path",
"referenceName": "System.IterationPath",
"description": "The iteration within which this bug will be fixed",
"type": "treePath",
"usage": "workItem",
"readOnly": false,
"canSortBy": true,
"isQueryable": true,
"supportedOperations": [
{
"referenceName": "SupportedOperations.Under",
"name": "Under"
},
{
"referenceName": "SupportedOperations.NotUnder",
"name": "Not Under"
},
{
"referenceName": "SupportedOperations.Equals",
"name": "="
},
{
"referenceName": "SupportedOperations.NotEquals",
"name": "<>"
},
{
"referenceName": "SupportedOperations.In",
"name": "In"
},
{
"name": "Not In"
}
],
"isIdentity": false,
"isPicklist": false,
"isPicklistSuggested": false,
"url": "https://fabrikam:8080/tfs/DefaultCollection/_apis/wit/fields/System.IterationPath?api-version=4.1"
}
Lista attribut med kommandoradsverktyget witadmin
Du kan lista välj fältattribut, till exempel datatyp, rapportbara attribut och indexering, med hjälp av kommandot witadmin listfields.
Du kan till exempel ange följande kommando för att visa attributen som definierats för ett angivet fält, till exempel Microsoft.VSTS.Common.Issue.
witadmin listfields /collection:http://fabrikam:8080/tfs/DefaultCollection /n:Microsoft.VSTS.Common.Issue
Fält- och attributinformation visas för det namngivna fältet, som du ser i det här exemplet.
Field: Microsoft.VSTS.Common.Issue
Name: Issue
Type: String
Reportable As: dimension
Use: Adventure Works (Shared Steps), AW Future (Shared Steps), AW Current (Shared Steps)
Indexed: False
Parametern Använd anger namnet på varje projekt och arbetsobjekttypen där fältet används.
Lägga till och ändra fält
Om du vill lägga till fält i en process lägger du till dem i en eller flera typer av arbetsobjekt. Mer information finns i Anpassa en arvsprocess.
Du kan lägga till eller ändra fälten i en WIT eller lägga till en anpassad WIT. Mer information finns i:
- För projektsamlingar som använder arvsprocessmodellen: Anpassa en arvsprocess.
- För projektsamlingar som använder den lokala XML-processmodellen: Anpassa den lokala XML-processmodellen.
Du kan ändra fältnamnet, indexet och rapportattributen för alla fält utom systemfält med hjälp av kommandoradsverktyget witadmin . Mer information finns i Hantera arbetsobjektfält-witadmin.