Tokenreferentie voor Word-sjablonen

De volledige lijst met gegevenspaden (koppelingen) die u in een Word-sjabloon kunt gebruiken. Dit weerspiegelt het tokenreferentiepaneel in het product en de koppelingscatalogus die de validator afdwingt: staat een pad hier niet, dan markeert de editor het. Voor grammatica en formatters, zie Word-sjabloonmodus.

Hoe u deze pagina leest

Een scalaire koppeling gebruikt u in een waardetoken: ${issue.summary}.
Een collectie-koppeling gebruikt u in een lus: ${#each issue.subtasks as sub}…${/each}. Binnen de lus bereikt u een veld via de lusvariabele: ${sub.key}.
Tiers — A is algemeen beschikbaar; B wordt alleen meegeleverd omdat de issuebundel de gegevens toch al bevat; C is zichtbaar maar niet koppelbaar, en staat vermeld zodat het bereik eerlijk blijft.
Welke hoofdelementen beschikbaar zijn, hangt af van de exportcontext.

Exportcontexten en hun hoofdelementen

Een Word-sjabloon draait in een van zeven contexten, elk met een andere set hoofdelementen.

Context	Beschikbare hoofdelementen
`single-issue`	`issue`, `generatedAt`
`automation` (Jira Automation-actie)	`issue`, `generatedAt`
`multi-issue` (JQL / bord)	`issues`, `issueGroups`, `generatedAt`
`scheduled`	`issues`, `issueGroups`, `generatedAt`
`sprint`	`issues`, `issueGroups`, `sprint`, `generatedAt`
`release`	`issues`, `issueGroups`, `release`, `generatedAt`
`backlog`	`issues`, `issueGroups`, `backlog`, `generatedAt`

generatedAt (datum en tijd) is in elke context beschikbaar.

Tier A — het issueoppervlak (`issue.*`)

Beschikbaar in single-issue en automation. Dezelfde velden vormen de vorm per item van de collectie issues: gebruik binnen ${#each issues as it} bijvoorbeeld ${it.key} en ${it.summary}.

Scalairen

Pad	Type
`issue.key`	tekenreeks
`issue.summary`	tekenreeks
`issue.description`	opgemaakte tekst (ADF)
`issue.status`	status
`issue.status.category`	tekenreeks
`issue.priority`	prioriteit
`issue.assignee`	gebruiker
`issue.assignee.displayName`	tekenreeks
`issue.reporter`	gebruiker
`issue.reporter.displayName`	tekenreeks
`issue.created`	datum en tijd
`issue.updated`	datum en tijd
`issue.dueDate`	datum
`issue.parent.key`	tekenreeks
`issue.parent.summary`	tekenreeks
`issue.parent.status`	tekenreeks

Een waarde van het type gebruiker toont standaard de weergavenaam; met de formatter user kiest u een onderdeel, bijv. ${issue.assignee | user("displayName")}. Een waarde met opgemaakte tekst wordt opgemaakt weergegeven; | plain() verwijdert de opmaak.

Collecties

Collectie	Velden van het item (relatief aan de lusvariabele)
`issue.labels`	primitieve lijst — de lusvariabele is het label
`issue.components`	`name`
`issue.fixVersions`	`name`, `released` (booleaans)
`issue.affectsVersions`	`name`
`issue.subtasks`	`key`, `summary`, `status`, `priority`, `assignee`, `dueDate`
`issue.comments`	`author` (gebruiker), `author.displayName`, `body` (ADF), `created`, `updated`
`issue.attachments`	`filename`, `mimeType`, `size`, `isImage`, `created`, `author.displayName` — alleen metadata, geen binaire gegevens en geen URL
`issue.issueLinks`	`typeName`, `direction`, `linkedIssue.key`, `linkedIssue.summary`, `linkedIssue.status`
`issue.worklogs`	`author.displayName`, `timeSpent`, `timeSpentSeconds`, `created`, `started`

Voorbeeld:

${#each issue.worklogs as wl}
${wl.author.displayName}: ${wl.timeSpentSeconds | duration("hm")} op ${wl.started | date("yyyy-MM-dd")}
${/each}

Tier A — hoofdelementen voor meerdere issues

Beschikbaar in multi-issue, scheduled, sprint, release en backlog.

Pad	Soort	Velden van het item
`issues`	collectie	het volledige issueoppervlak, relatief aan de lusvariabele
`issueGroups.fixVersions`	collectie	`key`, `title`, `issues`
`issueGroups.sprints`	collectie	`key`, `title`, `issues`
`issueGroups.assignees`	collectie	`key`, `title`, `issues`
`issueGroups.worklogAssignees`	collectie	`key`, `title`, `issues`

Voorbeeld — eerst groeperen, dan de issues per groep doorlopen:

${#each issueGroups.assignees as group}
## ${group.title}
${#each group.issues as it}
- ${it.key}: ${it.summary}
${/each}
${/each}

Tier A — contexthoofdelementen

Alleen beschikbaar in hun eigen context.

`sprint`

Pad	Type
`sprint.sprint.name`	tekenreeks
`sprint.sprint.goal`	tekenreeks
`sprint.sprint.state`	optie
`sprint.stats.issueCount`	getal
`sprint.stats.percentDone`	getal

`release`

Pad	Type
`release.release.name`	tekenreeks
`release.release.releaseDate`	datum
`release.release.released`	booleaans
`release.stats.issueCount`	getal
`release.stats.percentDone`	getal

`backlog`

Pad	Type / velden van het item
`backlog.board.boardName`	tekenreeks
`backlog.board.boardType`	optie
`backlog.stats.totalIssueCount`	getal
`backlog.groups`	collectie — `kind`, `name`, `issueCount`, `issues`

Tier A — metadata

Pad	Type	Contexten
`generatedAt`	datum en tijd	alle

Tier B — wijzigingslogboek

Pad	Soort	Velden van het item
`issue.changeHistory`	collectie	`author.displayName`, `created`, `items`

Tier C — zichtbaar maar niet koppelbaar

Deze bestaan conceptueel maar zijn niet oplosbaar; ze staan vermeld zodat editor en validatie het bereik eerlijk weergeven.

Mogelijkheid	Opmerking
`issue.jsm`	Aanvraag-, SLA- en goedkeuringsoppervlak van Jira Service Management — uitgesteld.
JQL in het sjabloon	Wordt door de migratiescanner gedetecteerd en gediagnosticeerd, nooit uitgevoerd.
Tempo	Een Tempo-spiegel kan op een werkregistratie voorkomen, maar is niet gekoppeld.
Xray / Zephyr	Velden voor testbeheer vereisen een app van derden.
Assets / Insight	Objectvelden zijn uitgesteld.

Aangepaste velden

Aangepaste velden zijn koppelbaar onder één naamruimte:

${ issue.customFields.<veld-id>.<…> }

Onbekende veld-id's zijn soepel: de editor toont een waarschuwing en de waarde kan leeg blijven, maar blokkeert nooit hard — een sjabloon kan dus verwijzen naar een veld dat deze site toevallig niet heeft zonder te mislukken.
Het kale pad issue.customFields (de volledige toewijzing) is nooit koppelbaar.
Alleen veilige identifiertekens zijn toegestaan; de segmenten __proto__, prototype en constructor worden geweigerd.

Aandachtspunten bij migratie vanaf Xporter

De migratiescanner stelt Exportelier-paden voor bij gangbare Xporter-veldnamen. Twee dingen om te weten zodat een voorstel ook echt oplost:

Automatische conversie repareert de syntaxis, niet het bestaan van een pad. De herschrijving heeft de juiste vorm, maar het doel moet nog steeds een echte koppeling op deze pagina zijn, anders volgt een unknown-binding-waarschuwing:
- Niet in de catalogus: Creator → issue.creator, Resolution → issue.resolution, Project → issue.project, IssueType/Type → issue.issuetype.
- Verschil in hoofdletters: DueDate wordt voorgesteld als issue.duedate, terwijl de koppeling issue.dueDate is.
- Verkeerd soort: Labels wordt als scalair voorgesteld, maar issue.labels is een collectie — gebruik een lus.
Issuekoppelingen. De alias Links wordt voorgesteld als links, maar de echte koppeling is issue.issueLinks.

Zie Xporter-syntaxis: wat werkt voor het volledige migratieoverzicht.

Paden die nooit zijn toegestaan

Om veiligheidsredenen worden sommige paden ongeacht de context geweigerd met een unsafe-template-fout — interne velden, velden met inloggegevens of met URL's. Denk aan hoofdelementen als auth, context, forge, internal, secrets, storage en token, en aan elk pad dat eindigt op accountId, apiToken, avatarUrl, baseUrl, contentUrl, thumbnailUrl, cookie, session, headers, private of storageRef. Houdt u zich aan de koppelingen op deze pagina, dan loopt u hier niet tegenaan.

Hoe u deze pagina leest​

Exportcontexten en hun hoofdelementen​

Tier A — het issueoppervlak (issue.*)​

Scalairen​

Collecties​

Tier A — hoofdelementen voor meerdere issues​

Tier A — contexthoofdelementen​

sprint​

release​

backlog​

Tier A — metadata​

Tier B — wijzigingslogboek​

Tier C — zichtbaar maar niet koppelbaar​

Aangepaste velden​

Aandachtspunten bij migratie vanaf Xporter​

Paden die nooit zijn toegestaan​