Page History
...
Table of Contents maxLevel 1
Issue
...
Activity
Changes to issues are registered in the Issue Activity, but it is not known in advance how many changes are going to be made.
...
You can iterate a section over all the
...
activities of an issue. This allows you to create a table that dynamically grows according to the number of
...
existing activities. The notation is:
Activity Fields |
---|
...
Exportable Data
Description |
---|
Field | Description |
---|---|
Field | Returns the name of the field which the value was changed. |
From | Returns the old value. |
To | Returns the new value. |
The notation is:
Title | The title of the issue |
Summary | The summary of the activity |
Content | When an activity involves a change in the Issue contents, this field displays the new contents |
Author | The author of the activity |
AuthorEmail | The email of the author of the activity |
Published | The time the issue was published |
Updated | The time the issue was updated |
Categories | When an activity regards an Issue Status change, this field displays the new Issue Status |
Code Blockcode | ||||
---|---|---|---|---|
| ||||
#{for historyEntriesactivityEntries} ${fullname:HistoryEntriesActivityEntries[n].AuthorTitle} made changes ${dateformat("dd-MM-yyyy HH:mm:ss"):HistoryEntriesActivityEntries[n].CreatedSummary} #{for ch=HistoryEntries ${ActivityEntries[n].ChangedItemsCountContent} Field Name: ${HistoryEntriesActivityEntries[n].ChangedItems[ch].FieldAuthor} Old Value: ${HistoryEntriesActivityEntries[n].ChangedItems[ch].From} New Value: ${HistoryEntries[n].ChangedItems[ch].To} #{end} AuthorEmail} ${dateformat("dd-MM-yyyy HH:mm:ss"):ActivityEntries[n].Published} ${dateformat("dd-MM-yyyy HH:mm:ss"):ActivityEntries[n].Updated} ${ActivityEntries[n].Categories} #{end} or #{for h<VariableName>=HistoryEntriesCountActivityEntriesCount} ${fullname:HistoryEntries[h].Author} made changes ${dateformat("dd-MM-yyyy HH:mm:ss"):HistoryEntries[h].Created} #{for ch=HistoryEntries[h].ChangedItemsCount} Field Name: ${HistoryEntries[h].ChangedItems[ch].Field} Old Value: ${HistoryEntries[h].ChangedItems[ch].From} New Value: ${HistoryEntries[h].ChangedItems[ch].To} #{end} #{end} |
Issue Links
Content and Issue Mappings. Example: ${ActivityEntries[VariableName].Field}
#{end} |
Info |
---|
We suggest that you use the html function to render the data because almost all content is HTML, e.g., ${html:ActivityEntries[n].Title} |
Below is an example of using the Activity iteration in a Word template:
or
Below is an example of using the Activity iteration in an Excel template:
or
Issue History
You Because it is not known in advance how many linked issues exist for an issue, you can iterate a section over all the linked issues history entries of an issue. This allows you to create a table that dynamically grows according to the number of existing linked issueschanges done.
Exportable Data
Field | Description |
---|
HistoryEntriesCount | Returns the |
Application Value | Description |
---|---|
JIRA | Link from the same Jira Instance |
External Jira | Link from the another Jira Instance |
Confluence | Link from a Confluence page |
External | External link |
...
number of changes made. | |||||||||
Author | Returns the user who made the change. | ||||||||
Created | Date of the change | ||||||||
ChangedItemsCout | Returns the number of fields changed in the current change. | ||||||||
ChangedItem |
|
The notation is:
Code Block | ||||
---|---|---|---|---|
| ||||
#{for linkshistoryEntries} ${Linksfullname:HistoryEntries[n].AppTypeAuthor} made changes ${Linksdateformat("dd-MM-yyyy HH:mm:ss"):HistoryEntries[n].LinkTypeCreated} ${Links#{for ch=HistoryEntries[n].KeyChangedItemsCount} Field Name: ${LinksHistoryEntries[n].Summary} ChangedItems[ch].Field} Old Value: ${HistoryEntries[n].ChangedItems[ch].From} New Value: ${LinksHistoryEntries[n].ChangedItems[ch].URL}To} #{end} #{end} or #{for <VariableName>h=LinksCountHistoryEntriesCount} Content and Linked Issue Mappings. Example: ${Links[VariableName].Field} #{end} |
The image below demonstrates an example of a Word template that iterates over linked issues.
or
The image below demonstrates an example of an Excel template that iterates over linked issues.
or
...
${fullname:HistoryEntries[h].Author} made changes ${dateformat("dd-MM-yyyy HH:mm:ss"):HistoryEntries[h].Created}
#{for ch=HistoryEntries[h].ChangedItemsCount}
Field Name: ${HistoryEntries[h].ChangedItems[ch].Field}
Old Value: ${HistoryEntries[h].ChangedItems[ch].From}
New Value: ${HistoryEntries[h].ChangedItems[ch].To}
#{end}
#{end} |
Issue Links
Because it is not known in advance how many comments linked issues exist for an issue, you can iterate a section over all the comments on linked issues of an issue. This allows you to create a table that dynamically grows according to the number of existing comments. The notation is:linked issues.
Exportable Data
Field | Comments FieldsDescription | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
AppType | The author of the comment | |||||||||
AuthorFullName | The full name of the author of the comment | |||||||||
Body | The comment | |||||||||
Created | The date the comment was posted | |||||||||
GroupLevel | The group level of the comment | |||||||||
Returns the Application Type. The values can be:
| ||||||||||
LinkType | Returns the Link Type. |
Note: When the link you are iterating is of AppTypes External Jira or Confluence, the name is obtained using the Summary property.
The notation is:
Code Block | ||||
---|---|---|---|---|
| ||||
Code Block | ||||
| ||||
#{for commentslinks} ${CommentsLinks[n].AuthorAppType} ${CommentsLinks[n].AuthorFullNameLinkType} ${CommentsLinks[n].BodyKey} ${dateformat("dd-MM-yyyy HH:mm:ss"):Comments[n].CreatedLinks[n].Summary} ${CommentsLinks[n].GroupLevelURL} #{end} or #{for <VariableName>=CommentsCountLinksCount} Content and Linked Issue Mappings. Example: ${CommentsLinks[VariableName].Field} #{end} |
The image below demonstrates an example of a Word template that iterates over
...
linked issues.
...
or
...
The image below demonstrates an example of an Excel template that iterates over
...
linked issues.
...
or
...
Issue
...
Comments
Because it is not known in advance how many worklogs comments exist for an issue, you can iterate a section over all the worklogs of comments on an issue. This allow allows you to create a table that dynamically grows according to the number of existing worklogscomments. The notation is:
Comments Fields | Description | ||
---|---|---|---|
Author | The author of the | ||
comment | |||
AuthorFullName | The full name of the author of the | worklogcomment | |
Body | The comment | of the worklog||
Created | The date the | worklogcomment was | createdposted |
Date StartedGroupLevel | The date the worklog was started | ||
Time Spent | The time spent in seconds | ||
TimeSpentFormatted | The time spent as displayed on Jira | ||
BilledHours | The billed hours in seconds (Belongs to Tempo Timesheets plugin) | ||
BilledHoursFormatted | The billed hours as displayed on Jira (Belongs to Tempo Timesheets plugin) | ||
group level of the comment |
Code Block | ||||
---|---|---|---|---|
| ||||
#{for worklogscomments} ${WorklogsComments[n].Author} ${WorklogsComments[n].AuthorFullName} ${WorklogsComments[n].CommentBody} ${dateformat("dd-MM-yyyy HH:mm:ss"):WorklogsComments[n].Created} ${dateformat("dd-MM-yyyy HH:mm:ss"):Worklogs[n].Date Started} ${Worklogs[n].Time Spent} ${Worklogs[n].TimeSpentFormatted} Comments[n].GroupLevel} #{end} or #{for <VariableName>=WorklogsCountCommentsCount} Content and WorklogIssue Mappings. Example: ${WorklogsComments[VariableName].Field} #{end} |
Issue Sub-Tasks
The image below demonstrates an example of a Word template that iterates over issue comments.
or
The image below demonstrates an example of an Excel template that iterates over issue comments.
or
Issue Worklogs
Because it is not Because it is not known in advance how many subtasks worklogs exist for an issue, you can iterate a section over all the subtasks worklogs of an issue. This allows allow you to create a table that dynamically grows according to the number of existing subtasksworklogs. The notation is:
Subtasks Worklogs Fields | Description |
---|---|
Key Author | The keyauthor of the subtasksworklog |
Summary AuthorFullName | The summaryfull name of the author of the subtasksworklog |
AssigneeUserDisplayName Comment | The assignee usercomment of the subtasksworklog |
Created | The date the worklog was created |
Date Started | The date the worklog was started |
Time Spent | The time spent in seconds |
TimeSpentFormatted | The time spent as displayed on Jira |
BilledHours | The billed hours in seconds (Belongs to Tempo Timesheets plugin) |
BilledHoursFormatted | The billed hours as displayed on Jira (Belongs to Tempo Timesheets plugin) |
Code Block | ||||
---|---|---|---|---|
| ||||
Code Block | ||||
| ||||
#{for subtasksworklogs} ${SubtasksWorklogs[n].KeyAuthor} ${SubtasksWorklogs[n].SummaryAuthorFullName} ${SubtasksWorklogs[n].AssigneeUserDisplayName} #{end} or #{for <VariableName>=SubtasksCount} Content and Issue Mappings. Example: ${Subtasks[VariableName].Field} #{end} |
The image below demonstrates an example of a Word template that iterates over issue subtasks.
or
The image below demonstrates an example of an Excel template that iterates over issue subtasks.
or
For an example of how to iterate the details of a subtask Parent issue, please check the Iterating JQL Queries area below.
Issue Components
Comment}
${dateformat("dd-MM-yyyy HH:mm:ss"):Worklogs[n].Created}
${dateformat("dd-MM-yyyy HH:mm:ss"):Worklogs[n].Date Started}
${Worklogs[n].Time Spent}
${Worklogs[n].TimeSpentFormatted}
#{end}
or
#{for <VariableName>=WorklogsCount}
Content and Worklog Mappings. Example: ${Worklogs[VariableName].Field}
#{end} |
Issue Sub-Tasks
Because it is not known in advance how many subtasks exist for an Because it is not known in advance how many components exist for an issue, you can iterate a section over all the components subtasks of an issue. This allows you to create a table that dynamically grows according to the number of existing componentssubtasks. The notation is:
Components Subtasks Fields | Description |
---|---|
NameKey | The name key of the componentsubtasks |
DescriptionSummary | The description summary of the componentsubtasks |
LeadAssigneeUserDisplayName | The name assignee user of the component lead |
Id | The ID of the component |
ProjectId | The project ID of the component |
AssigneeType | The assignee type of the component |
subtasks |
Code Block | ||||
---|---|---|---|---|
| ||||
Code Block | ||||
| ||||
#{for componentssubtasks} ${ComponentsSubtasks[n].NameKey} ${ComponentsSubtasks[n].DescriptionSummary} ${fullname:ComponentsSubtasks[n].LeadAssigneeUserDisplayName} ${Components[n].Id} ${Components[n].ProjectId#{end} or #{for <VariableName>=SubtasksCount} ${Components[n].AssigneeTypeContent and Issue Mappings. Example: ${Subtasks[VariableName].Field} #{end} |
...
The image below demonstrates an example of a Word template that iterates over issue
...
subtasks.
or
The image The image below demonstrates an example of an Excel template that iterates over issue componentssubtasks.
or
...
For an example of how to iterate the details of a subtask Parent issue, please check the Iterating JQL Queries area below.
Issue Components
Because it is not known in advance how many Status Transitions components exist for an issue, you can iterate a section over all the Status Transitions components of an issue. This allows you to create a table that dynamically grows according to the number of existing status transitionscomponents. The notation is:
Status Transitions Components Fields | Description | ||
---|---|---|---|
AuthorName | The author of the status transition | ||
Created | The date the status transition was performed | ||
OldStatus | The old status of the status transition | ||
name of the component | |||
Description | The description of the component | ||
Lead | The name of the component lead | ||
Id | The ID of the component | ||
ProjectId | The project ID of the component | ||
AssigneeType | The assignee type of the component | NewStatus | The new status of the status transition |
Code Block | ||||
---|---|---|---|---|
| ||||
#{for statusTransitionscomponents} ${StatusTransitionsComponents[n].AuthorName} ${dateformat("dd-MM-yyyy HH:mm:ss"):StatusTransitionsComponents[n].CreatedDescription} ${StatusTransitionsfullname:Components[n].OldStatusLead} ${StatusTransitionsComponents[n].NewStatusId} #{end} or #{for <VariableName>=StatusTransitionsCount} Content and StatusTransitions Mappings. Example: ${StatusTransitions[VariableName].Field ${Components[n].ProjectId} ${Components[n].AssigneeType} #{end} |
...
The image below demonstrates an example of a Word template that iterates over
...
issue components.
or
...
The image below demonstrates an example of an Excel template that iterates over
...
issue components.
...
...
Issue
...
Status Transitions
Because it is not known in advance how many Images can Status Transitions exist for an issue (as an attachment), you can iterate a section over all the attached images Status Transitions of an issue to get some metadata about them. This allows you to create a table that dynamically grows according to the number of existing imagesstatus transitions. The notation is:
Attachments Images Status Transitions Fields | Description | ID||
---|---|---|---|
Author | The | IDauthor of the | attached imagestatus transition |
ImageCreated | The image of the attached image | ||
Name | The name of the attached image | ||
Size | The size of the attached image | ||
HumanReadableSize | The size of the attached image | ||
Author | The author of the attached image | ||
Created | The date the attached image was created | ||
MimeType | The type of the attached image | ||
ThumbnailURL | The URL to the thumbnail of the image | ||
date the status transition was performed | |||
OldStatus | The old status of the status transition | ||
NewStatus | The new status of the status transition |
Code Block | ||||
---|---|---|---|---|
| ||||
Code Block | ||||
| ||||
#{for imagesstatusTransitions} ${ImagesStatusTransitions[n].Image|maxwidth=150|maxheight=150Author} ${Images[n].Name} ${Images[n].ID} ${Images[n].Size} ${Images[n].HumanReadableSize} ${Images[n].Author} ${dateformat("dd-MM-yyyy dateformat("dd-MM-yyyy HH:mm:ss"):ImagesStatusTransitions[n].Created} ${ImagesStatusTransitions[n].MimeTypeOldStatus} ${ImagesStatusTransitions[n].ThumbnailURLNewStatus} ##{end} or #{for <VariableName>=ImagesCountStatusTransitionsCount} Content and ImagesStatusTransitions Mappings. Example: ${ImagesStatusTransitions[VariableName].Field} #{end} |
The image below demonstrates an example of a Word template that iterates over
...
status transitions.
...
...
or
Info |
---|
Doc. Generator will automatically read the EXIF orientation property of an image and rotate it to its correct orientation. You can turn this off by adding this property to your template. |
Code Block | ||||
---|---|---|---|---|
| ||||
#{for images}
${Images[n].Image|width=150|height=150}
#{end} |
These values are in pixels and if you only define one of them the image will be rescaled.
Info |
---|
Note that, if you use both maxWidth and width mappings, only the max value will be read. The same behavior happens with height and maxHeight. |
The image below demonstrates an example of an Excel template that iterates over attached images.
or
Issue Attachments
Because it is not known in advance how many attachments exist in an issue, you can iterate a section over all the attachments of an issue. This allows you to create a table that dynamically grows according to the number of existing attachments. The notation is:
The image below demonstrates an example of an Excel template that iterates over status transitions.
or
Issue Attached Images
Because it is not known in advance how many Images can exist for an issue (as an attachment), you can iterate a section over all the attached images of an issue to get some metadata about them. This allows you to create a table that dynamically grows according to the number of existing images. The notation is:
Attachments Images Fields | Description | |||
---|---|---|---|---|
ID | The ID of the attached image | |||
Image | The image of the attached image | |||
Attachments Fields | Description | |||
ID | The ID of the attachment | |||
Name | The name of the attachmentattached image | |||
AuthorSize | The author size of the attachmentattached image | |||
AuthorFullNameHumanReadableSize | The full name size of the author of the attachmentattached image | |||
Author | The author of the attached image | |||
Created | The date the attachment attached image was created | |||
SizeMimeType | The size type of the attachmentattached imageHumanReadableSize | |||
ThumbnailURL | The | formatted size of the attachmentMimeType | The typeURL to the thumbnail of the | attachmentimage |
Code Block | ||||
---|---|---|---|---|
| ||||
#{for attachmentsimages} ${AttachmentsImages[n].IDImage|maxwidth=150|maxheight=150} ${AttachmentsImages[n].Name} ${AttachmentsImages[n].AuthorID} ${AttachmentsImages[n].AuthorFullNameSize} ${dateformat("dd-MM-yyyy HH:mm:ss"):AttachmentsImages[n].CreatedHumanReadableSize} ${AttachmentsImages[n].SizeAuthor} ${Attachmentsdateformat("dd-MM-yyyy HH:mm:ss"):Images[n].HumanReadableSizeCreated} ${AttachmentsImages[n].MimeType} # ${Images[n].ThumbnailURL} #{end} or #{for <VariableName>=AttachmentsCountImagesCount} Content and IssueImages Mappings. Example: ${AttachmentsImages[VariableName].Field} #{end} |
The image below demonstrates an example of a Word template that iterates over
...
attached images.
...
or
The image below demonstrates an example of an Excel template that iterates over attachments.
...
Info |
---|
Doc. Generator will automatically read the EXIF orientation property of an image and rotate it to its correct orientation. You can turn this off by adding this property to your template. |
Code Block | ||||
---|---|---|---|---|
| ||||
#{for images |
or
Issue Labels
Because it is not known in advance how many labels exist in an issue, you can iterate a section over all the labels of an issue. The notation is:
...
Code Block |
---|
#{for labels} ${LabelsImages[n].Name} #{end} or #{for <VariableName>=LabelsCount} ${Labels[VariableName].Name} #{end} |
The image below demonstrates an example of a Word template that iterates over labels.
or
Image|width=150|height=150}
#{end} |
These values are in pixels and if you only define one of them the image will be rescaled.
Info |
---|
Note that, if you use both maxWidth and width mappings, only the max value will be read. The same behavior happens with height and maxHeight. |
The image below demonstrates an example of an Excel template that iterates over labelsattached images.
or
Issue Activity
...
Issue Attachments
Because it is not known in advance how many
...
attachments exist in an issue, you can iterate a section over all the
...
attachments of an issue. This allows you to create a table that dynamically grows according to the number of existing
...
attachments. The notation is:
Attachments Fields | Description |
---|
ID | The |
ID of the |
attachment |
Name | The |
name of the |
attachment | |
Author | The author of the |
attachment |
AuthorFullName | The |
full name of the author |
of the |
attachment |
Created | The |
date the |
attachment was |
created |
Size | The |
size of the attachment | |
HumanReadableSize | The formatted size of the attachment |
MimeType | The type of the attachment |
Code Block | ||||
---|---|---|---|---|
| ||||
#{for activityEntriesattachments} ${ActivityEntriesAttachments[n].TitleID} ${ActivityEntriesAttachments[n].SummaryName} ${ActivityEntriesAttachments[n].Content} ${ActivityEntries[n].Author} ${ActivityEntriesAttachments[n].AuthorEmailAuthorFullName} ${dateformat("dd-MM-yyyy HH:mm:ss"):ActivityEntriesAttachments[n].PublishedCreated} ${dateformat("dd-MM-yyyy HH:mm:ss"):ActivityEntriesAttachments[n].UpdatedSize} ${ActivityEntriesAttachments[n].Categories} #{end} or #{for <VariableName>=ActivityEntriesCount} Content and Issue Mappings. Example: ${ActivityEntries[VariableName].Field} #{end} |
Info |
---|
We suggest that you use the html function to render the data because almost all content is HTML, e.g., ${html:ActivityEntries[n].Title} |
Below is an example of using the Activity iteration in a Word template:
or
Below is an example of using the Activity iteration in an Excel template:
or
...
HumanReadableSize}
${Attachments[n].MimeType}
#{end}
or
#{for <VariableName>=AttachmentsCount}
Content and Issue Mappings. Example: ${Attachments[VariableName].Field}
#{end} |
The image below demonstrates an example of a Word template that iterates over attachments.
or
The image below demonstrates an example of an Excel template that iterates over attachments.
or
Issue Labels
Because it is not known in advance how many labels exist in an issue, you can iterate a section over all the labels of an issue. The notation is:
Attachments Fields | Description |
---|---|
Name | The name of the label |
Code Block |
---|
#{for labels}
${Labels[n].Name}
#{end}
or
#{for <VariableName>=LabelsCount}
${Labels[VariableName].Name}
#{end} |
The image below demonstrates an example of a Word template that iterates over labels.
or
The image below demonstrates an example of an Excel template that iterates over labels.
or
Project Versions
You can iterate over all project versions to which the issue belong to. The notation is:
...