Zum Hauptinhalt springen

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}.
  • StufenA 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.

KontextVerfügbare Wurzeln
single-issueissue, generatedAt
automation (Jira-Automation-Aktion)issue, generatedAt
multi-issue (JQL / Board)issues, issueGroups, generatedAt
scheduledissues, issueGroups, generatedAt
sprintissues, issueGroups, sprint, generatedAt
releaseissues, issueGroups, release, generatedAt
backlogissues, 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

PfadTyp
issue.keyZeichenkette
issue.summaryZeichenkette
issue.descriptionRich Text (ADF)
issue.statusStatus
issue.status.categoryZeichenkette
issue.priorityPriorität
issue.assigneeBenutzer
issue.assignee.displayNameZeichenkette
issue.reporterBenutzer
issue.reporter.displayNameZeichenkette
issue.createdZeitstempel
issue.updatedZeitstempel
issue.dueDateDatum
issue.parent.keyZeichenkette
issue.parent.summaryZeichenkette
issue.parent.statusZeichenkette

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

SammlungElementfelder (relativ zur Schleifenvariablen)
issue.labelsprimitive Liste — die Schleifenvariable ist die Beschriftung
issue.componentsname
issue.fixVersionsname, released (Boolean)
issue.affectsVersionsname
issue.subtaskskey, summary, status, priority, assignee, dueDate
issue.commentsauthor (Benutzer), author.displayName, body (ADF), created, updated
issue.attachmentsfilename, mimeType, size, isImage, created, author.displayNamenur Metadaten, keine Binärdaten und keine URL
issue.issueLinkstypeName, direction, linkedIssue.key, linkedIssue.summary, linkedIssue.status
issue.worklogsauthor.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.

PfadArtElementfelder
issuesSammlungdie vollständige Vorgangsebene, relativ zur Schleifenvariablen
issueGroups.fixVersionsSammlungkey, title, issues
issueGroups.sprintsSammlungkey, title, issues
issueGroups.assigneesSammlungkey, title, issues
issueGroups.worklogAssigneesSammlungkey, 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

PfadTyp
sprint.sprint.nameZeichenkette
sprint.sprint.goalZeichenkette
sprint.sprint.stateOption
sprint.stats.issueCountZahl
sprint.stats.percentDoneZahl

release

PfadTyp
release.release.nameZeichenkette
release.release.releaseDateDatum
release.release.releasedBoolean
release.stats.issueCountZahl
release.stats.percentDoneZahl

backlog

PfadTyp / Elementfelder
backlog.board.boardNameZeichenkette
backlog.board.boardTypeOption
backlog.stats.totalIssueCountZahl
backlog.groupsSammlung — kind, name, issueCount, issues

Stufe A — Metadaten

PfadTypKontexte
generatedAtZeitstempelalle

Stufe B — Änderungsprotokoll

PfadArtElementfelder
issue.changeHistorySammlungauthor.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ähigkeitHinweis
issue.jsmJira-Service-Management: Anfrage-, SLA- und Genehmigungsebene — zurückgestellt.
JQL in der VorlageWird vom Migrationsscanner erkannt und gemeldet, nie ausgeführt.
TempoEine Tempo-Spiegelung kann an einem Arbeitsprotokoll hängen, ist aber nicht gebunden.
Xray / ZephyrTestmanagement-Felder erfordern eine Drittanbieter-App.
Assets / InsightObjektfelder 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__, prototype und constructor werden 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:

  1. 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: Creatorissue.creator, Resolutionissue.resolution, Projectissue.project, IssueType/Typeissue.issuetype.
    • Groß-/Kleinschreibung: DueDate wird als issue.duedate vorgeschlagen, die Bindung heißt issue.dueDate.
    • Falsche Art: Labels wird als Skalar vorgeschlagen, issue.labels ist aber eine Sammlung — nutzen Sie eine Schleife.
  2. Vorgangsverknüpfungen. Der Alias Links wird als links vorgeschlagen, die echte Bindung ist issue.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.