Saltar al contenido principal

Referencia de tokens de plantillas Word

La lista completa de rutas de datos (vinculaciones) que puede usar en una plantilla Word. Refleja el panel de referencia de tokens del producto y el catálogo de vinculaciones que aplica el validador: si una ruta no aparece aquí, el editor la marca. Para la gramática y los formateadores, consulte Modo de plantilla Word.

Cómo leer esta página

  • Una vinculación escalar se usa en un token de valor: ${issue.summary}.
  • Una vinculación de colección se usa en un bucle: ${#each issue.subtasks as sub}…${/each}. Dentro del bucle, acceda a un campo mediante la variable del bucle: ${sub.key}.
  • Niveles: A está disponible con carácter general; B se incluye solo porque el paquete de incidencia ya contiene los datos; C es visible pero no vinculable, y se enumera para que el alcance quede claro.
  • Qué raíces están disponibles depende del contexto de exportación.

Contextos de exportación y sus raíces

Una plantilla Word se ejecuta en uno de siete contextos, cada uno con un conjunto distinto de raíces.

ContextoRaíces disponibles
single-issueissue, generatedAt
automation (acción de Jira Automation)issue, generatedAt
multi-issue (JQL / tablero)issues, issueGroups, generatedAt
scheduledissues, issueGroups, generatedAt
sprintissues, issueGroups, sprint, generatedAt
releaseissues, issueGroups, release, generatedAt
backlogissues, issueGroups, backlog, generatedAt

generatedAt (fecha y hora) está disponible en todos los contextos.

Nivel A: la superficie de incidencia (issue.*)

Disponible en single-issue y automation. Estos mismos campos son la forma por elemento de la colección issues: dentro de ${#each issues as it} use ${it.key}, ${it.summary}, etc.

Escalares

RutaTipo
issue.keycadena
issue.summarycadena
issue.descriptiontexto enriquecido (ADF)
issue.statusestado
issue.status.categorycadena
issue.priorityprioridad
issue.assigneeusuario
issue.assignee.displayNamecadena
issue.reporterusuario
issue.reporter.displayNamecadena
issue.createdfecha y hora
issue.updatedfecha y hora
issue.dueDatefecha
issue.parent.keycadena
issue.parent.summarycadena
issue.parent.statuscadena

Un valor de tipo usuario muestra el nombre para mostrar de forma predeterminada; use el formateador user para elegir una parte, p. ej. ${issue.assignee | user("displayName")}. Un valor de texto enriquecido se muestra con formato; use | plain() para eliminarlo.

Colecciones

ColecciónCampos del elemento (relativos a la variable del bucle)
issue.labelslista primitiva: la variable del bucle es la etiqueta
issue.componentsname
issue.fixVersionsname, released (booleano)
issue.affectsVersionsname
issue.subtaskskey, summary, status, priority, assignee, dueDate
issue.commentsauthor (usuario), author.displayName, body (ADF), created, updated
issue.attachmentsfilename, mimeType, size, isImage, created, author.displayNamesolo metadatos, sin binarios ni URL
issue.issueLinkstypeName, direction, linkedIssue.key, linkedIssue.summary, linkedIssue.status
issue.worklogsauthor.displayName, timeSpent, timeSpentSeconds, created, started

Ejemplo:

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

Nivel A: raíces para varias incidencias

Disponibles en multi-issue, scheduled, sprint, release y backlog.

RutaTipoCampos del elemento
issuescolecciónla superficie de incidencia completa, relativa a la variable del bucle
issueGroups.fixVersionscolecciónkey, title, issues
issueGroups.sprintscolecciónkey, title, issues
issueGroups.assigneescolecciónkey, title, issues
issueGroups.worklogAssigneescolecciónkey, title, issues

Ejemplo: agrupar y luego recorrer las incidencias de cada grupo.

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

Nivel A: raíces de contexto

Disponibles solo en su propio contexto.

sprint

RutaTipo
sprint.sprint.namecadena
sprint.sprint.goalcadena
sprint.sprint.stateopción
sprint.stats.issueCountnúmero
sprint.stats.percentDonenúmero

release

RutaTipo
release.release.namecadena
release.release.releaseDatefecha
release.release.releasedbooleano
release.stats.issueCountnúmero
release.stats.percentDonenúmero

backlog

RutaTipo / campos del elemento
backlog.board.boardNamecadena
backlog.board.boardTypeopción
backlog.stats.totalIssueCountnúmero
backlog.groupscolección: kind, name, issueCount, issues

Nivel A: metadatos

RutaTipoContextos
generatedAtfecha y horatodos

Nivel B: registro de cambios

RutaTipoCampos del elemento
issue.changeHistorycolecciónauthor.displayName, created, items

Nivel C: visible pero no vinculable

Existen conceptualmente pero no se pueden resolver; se enumeran para que el editor y la validación reflejen el alcance con honestidad.

CapacidadNota
issue.jsmSuperficie de solicitud, SLA y aprobación de Jira Service Management: aplazada.
JQL en la plantillaEl analizador de migración lo detecta y lo diagnostica, nunca lo ejecuta.
TempoPuede existir un reflejo de Tempo en un registro de trabajo, pero no está vinculado.
Xray / ZephyrLos campos de gestión de pruebas requieren una aplicación de terceros.
Assets / InsightLos campos de objeto están aplazados.

Campos personalizados

Los campos personalizados se vinculan bajo un único espacio de nombres:

${ issue.customFields.<idDeCampo>.<…> }
  • Los identificadores desconocidos son flexibles: el editor muestra una advertencia y el valor puede quedar vacío, pero nunca bloquea de forma dura, de modo que una plantilla puede referirse a un campo que este sitio no tenga sin fallar.
  • La ruta desnuda issue.customFields (el mapa completo) nunca es vinculable.
  • Solo se permiten caracteres de identificador seguros; se rechazan los segmentos __proto__, prototype y constructor.

Advertencias al migrar desde Xporter

El analizador de migración sugiere rutas de Exportelier para los nombres de campo habituales de Xporter. Dos cosas que conviene saber para que una sugerencia se resuelva de verdad:

  1. La conversión automática corrige la sintaxis, no la existencia de una ruta. La reescritura tiene la forma correcta, pero el destino debe seguir siendo una vinculación real de esta página, o se genera una advertencia unknown-binding:
    • No están en el catálogo: Creatorissue.creator, Resolutionissue.resolution, Projectissue.project, IssueType/Typeissue.issuetype.
    • Diferencia de mayúsculas: DueDate se sugiere como issue.duedate, pero la vinculación es issue.dueDate.
    • Tipo incorrecto: Labels se sugiere como escalar, pero issue.labels es una colección: use un bucle.
  2. Vínculos de incidencia. El alias Links se sugiere como links, pero la vinculación real es issue.issueLinks.

Consulte Sintaxis de Xporter: qué funciona para el mapa completo de migración.

Rutas nunca permitidas

Por seguridad, algunas rutas se rechazan con un error unsafe-template independientemente del contexto: campos internos, de credenciales o que contienen URL. Incluyen raíces como auth, context, forge, internal, secrets, storage y token, y cualquier ruta terminada en accountId, apiToken, avatarUrl, baseUrl, contentUrl, thumbnailUrl, cookie, session, headers, private o storageRef. Si se ciñe a las vinculaciones de esta página, no llegará a toparse con ellas.