Token-Referenz für Word-Vorlagen
Die vollständige Liste der Datenpfade (Bindungen), die Sie in einer Word-Vorlage verwenden können. Sie entspricht dem Token-Referenzbereich im Produkt und dem Bindungskatalog, den der Validator durchsetzt — steht ein Pfad nicht hier, markiert ihn der Editor. Grammatik und Formatierer finden Sie im Word-Vorlagenmodus.
Wie diese Seite zu lesen ist
- Eine skalare Bindung steht in einem Werttoken:
${issue.summary}. - Eine Sammlungs-Bindung steht in einer Schleife:
${#each issue.subtasks as sub}…${/each}. Innerhalb der Schleife erreichen Sie ein Feld über die Schleifenvariable:${sub.key}. - Stufen — A ist allgemein verfügbar; B liefert nur mit, weil der Vorgangsdatensatz die Daten ohnehin trägt; C ist sichtbar, aber nicht bindbar — aufgeführt, damit der Funktionsumfang ehrlich bleibt.
- Welche Wurzeln verfügbar sind, hängt vom Exportkontext ab.
Exportkontexte und ihre Wurzeln
Eine Word-Vorlage läuft in einem von sieben Kontexten, jeder stellt andere Wurzeln bereit.
| Kontext | Verfügbare Wurzeln |
|---|---|
single-issue | issue, generatedAt |
automation (Jira-Automation-Aktion) | issue, generatedAt |
multi-issue (JQL / Board) | issues, issueGroups, generatedAt |
scheduled | issues, issueGroups, generatedAt |
sprint | issues, issueGroups, sprint, generatedAt |
release | issues, issueGroups, release, generatedAt |
backlog | issues, issueGroups, backlog, generatedAt |
generatedAt (ein Zeitstempel) ist in jedem Kontext verfügbar.
Stufe A — die Vorgangsebene (issue.*)
Verfügbar in single-issue und automation. Dieselben Felder bilden die Elementform der Sammlung issues — innerhalb von ${#each issues as it} verwenden Sie ${it.key}, ${it.summary} und so weiter.
Skalare
| Pfad | Typ |
|---|---|
issue.key | Zeichenkette |
issue.summary | Zeichenkette |
issue.description | Rich Text (ADF) |
issue.status | Status |
issue.status.category | Zeichenkette |
issue.priority | Priorität |
issue.assignee | Benutzer |
issue.assignee.displayName | Zeichenkette |
issue.reporter | Benutzer |
issue.reporter.displayName | Zeichenkette |
issue.created | Zeitstempel |
issue.updated | Zeitstempel |
issue.dueDate | Datum |
issue.parent.key | Zeichenkette |
issue.parent.summary | Zeichenkette |
issue.parent.status | Zeichenkette |
Ein Wert vom Typ Benutzer rendert standardmäßig den Anzeigenamen; mit dem Formatierer user wählen Sie einen Teil, z. B. ${issue.assignee | user("displayName")}. Ein Rich-Text-Wert wird formatiert gerendert; | plain() entfernt die Formatierung.
Sammlungen
| Sammlung | Elementfelder (relativ zur Schleifenvariablen) |
|---|---|
issue.labels | primitive Liste — die Schleifenvariable ist die Beschriftung |
issue.components | name |
issue.fixVersions | name, released (Boolean) |
issue.affectsVersions | name |
issue.subtasks | key, summary, status, priority, assignee, dueDate |
issue.comments | author (Benutzer), author.displayName, body (ADF), created, updated |
issue.attachments | filename, mimeType, size, isImage, created, author.displayName — nur Metadaten, keine Binärdaten und keine URL |
issue.issueLinks | typeName, direction, linkedIssue.key, linkedIssue.summary, linkedIssue.status |
issue.worklogs | author.displayName, timeSpent, timeSpentSeconds, created, started |
Beispiel:
${#each issue.worklogs as wl}
${wl.author.displayName}: ${wl.timeSpentSeconds | duration("hm")} am ${wl.started | date("yyyy-MM-dd")}
${/each}
Stufe A — Wurzeln für mehrere Vorgänge
Verfügbar in multi-issue, scheduled, sprint, release und backlog.
| Pfad | Art | Elementfelder |
|---|---|---|
issues | Sammlung | die vollständige Vorgangsebene, relativ zur Schleifenvariablen |
issueGroups.fixVersions | Sammlung | key, title, issues |
issueGroups.sprints | Sammlung | key, title, issues |
issueGroups.assignees | Sammlung | key, title, issues |
issueGroups.worklogAssignees | Sammlung | key, title, issues |
Beispiel — erst gruppieren, dann die Vorgänge je Gruppe:
${#each issueGroups.assignees as group}
## ${group.title}
${#each group.issues as it}
- ${it.key}: ${it.summary}
${/each}
${/each}
Stufe A — Kontext-Wurzeln
Nur im jeweils eigenen Kontext verfügbar.
sprint
| Pfad | Typ |
|---|---|
sprint.sprint.name | Zeichenkette |
sprint.sprint.goal | Zeichenkette |
sprint.sprint.state | Option |
sprint.stats.issueCount | Zahl |
sprint.stats.percentDone | Zahl |
release
| Pfad | Typ |
|---|---|
release.release.name | Zeichenkette |
release.release.releaseDate | Datum |
release.release.released | Boolean |
release.stats.issueCount | Zahl |
release.stats.percentDone | Zahl |
backlog
| Pfad | Typ / Elementfelder |
|---|---|
backlog.board.boardName | Zeichenkette |
backlog.board.boardType | Option |
backlog.stats.totalIssueCount | Zahl |
backlog.groups | Sammlung — kind, name, issueCount, issues |
Stufe A — Metadaten
| Pfad | Typ | Kontexte |
|---|---|---|
generatedAt | Zeitstempel | alle |
Stufe B — Änderungsprotokoll
| Pfad | Art | Elementfelder |
|---|---|---|
issue.changeHistory | Sammlung | author.displayName, created, items |
Stufe C — sichtbar, aber nicht bindbar
Diese existieren konzeptionell, sind aber nicht auflösbar; sie sind aufgeführt, damit Editor und Validierung den Funktionsumfang ehrlich abbilden.
| Fähigkeit | Hinweis |
|---|---|
issue.jsm | Jira-Service-Management: Anfrage-, SLA- und Genehmigungsebene — zurückgestellt. |
| JQL in der Vorlage | Wird vom Migrationsscanner erkannt und gemeldet, nie ausgeführt. |
| Tempo | Eine Tempo-Spiegelung kann an einem Arbeitsprotokoll hängen, ist aber nicht gebunden. |
| Xray / Zephyr | Testmanagement-Felder erfordern eine Drittanbieter-App. |
| Assets / Insight | Objektfelder sind zurückgestellt. |
Benutzerdefinierte Felder
Benutzerdefinierte Felder sind unter einem einzigen Namensraum bindbar:
${ issue.customFields.<feldId>.<…> }
- Unbekannte Feld-IDs sind weich: Der Editor zeigt eine Warnung und der Wert kann leer bleiben, blockiert aber nie hart — so kann eine Vorlage ein Feld referenzieren, das diese Site zufällig nicht hat, ohne zu scheitern.
- Der blanke Pfad
issue.customFields(die gesamte Zuordnung) ist nie bindbar. - Nur sichere Bezeichnerzeichen sind erlaubt; die Segmente
__proto__,prototypeundconstructorwerden abgewiesen.
Vorbehalte bei der Migration von Xporter
Der Migrationsscanner schlägt für verbreitete Xporter-Feldnamen Exportelier-Pfade vor. Zweierlei sollten Sie wissen, damit ein Vorschlag auch wirklich auflöst:
- Die automatische Umwandlung korrigiert die Syntax, nicht die Existenz eines Pfades. Die Umschreibung hat die richtige Form, das Ziel muss aber weiterhin eine echte Bindung auf dieser Seite sein, sonst entsteht eine
unknown-binding-Warnung:- Gar nicht im Katalog:
Creator→issue.creator,Resolution→issue.resolution,Project→issue.project,IssueType/Type→issue.issuetype. - Groß-/Kleinschreibung:
DueDatewird alsissue.duedatevorgeschlagen, die Bindung heißtissue.dueDate. - Falsche Art:
Labelswird als Skalar vorgeschlagen,issue.labelsist aber eine Sammlung — nutzen Sie eine Schleife.
- Gar nicht im Katalog:
- Vorgangsverknüpfungen. Der Alias
Linkswird alslinksvorgeschlagen, die echte Bindung istissue.issueLinks.
Die vollständige Migrationsübersicht steht unter Xporter-Syntax: Was funktioniert.
Niemals erlaubte Pfade
Aus Sicherheitsgründen werden manche Pfade unabhängig vom Kontext mit einem unsafe-template-Fehler abgewiesen — interne, Zugangsdaten- oder URL-tragende Felder. Dazu gehören Wurzeln wie auth, context, forge, internal, secrets, storage und token sowie jeder Pfad, der auf accountId, apiToken, avatarUrl, baseUrl, contentUrl, thumbnailUrl, cookie, session, headers, private oder storageRef endet. Wenn Sie bei den Bindungen dieser Seite bleiben, stoßen Sie nicht daran.