Libretto: Document Export for Jira

Export any filter to PDF or Word, with a template builder, live preview and scheduled delivery.

Libretto turns Jira work into documents people can send, print and file. Choose the issues with a saved filter, a few dropdowns or JQL, shape the document with a block template, and export to PDF or Word. There is no artificial limit on export size: exports run as background jobs on Atlassian's infrastructure and continue across invocations, so a filter with thousands of issues produces one document.

Getting started

Open Apps › Libretto: Document Export from the Jira navigation.
Under Issues, pick a saved filter, use the Pick tab (project, issue types, status, people, activity window) or write JQL. Count issues shows roughly how many match.
Choose PDF or Word, and optionally an issue to attach the file to.
Select Load 10 sample issues to see a preview, adjust the template, then Start export job.
When the job shows done, select Download. Large exports keep running while you do something else; come back to the page to collect them.

Choosing issues

Jira requires at least one restriction in a query, so order by created on its own is rejected; add a project, filter, assignee or date clause. Saved filters are listed from your own and starred filters, and picking one uses filter = <id>, which keeps the filter's sharing and sort order. The Pick tab lists the issue types configured on the chosen project, and its people picker searches people assignable in that project, or everyone you can see when no project is chosen.

Templates

A template is an ordered list of blocks: heading, paragraph, issue table, issue section and page break. Headings and paragraphs accept placeholders for the document title, issue count, query and date; an issue section repeats once per issue and its heading can use any issue field. Tables and sections have field pickers with ordering. The Builder tab edits the template visually and the JSON tab shows the same template as text for sharing or versioning; errors in the JSON are flagged on the block they belong to. The preview redraws from ten sample issues as you edit.

Word output

Word files are produced directly as WordprocessingML with fixed column widths, so they open in Word, Pages, LibreOffice and Google Docs. Descriptions are exported as plain text with line breaks preserved.

Exports and delivery

Each export is listed with its timings, file size and, if you asked for one, the attachment it created. Files are downloaded straight to your browser and kept for the retention period your administrator sets (seven days by default); a file attached to an issue stays on the issue. Remove deletes the export and its file.

Schedules

A schedule saves the current query, format and template and runs it daily or weekly at the hour you choose, in your own timezone. It must deliver to an issue: the file is attached there and a comment is posted, so the people watching that issue are notified by Jira. Before each run the app re-checks that the schedule's owner can still see the issues and attach to the delivery issue; if not, the schedule is paused with a message. Run now runs it immediately as you, and every run appears in the exports list.

Administrator settings

Site administrators can set the default format, an optional maximum number of issues per export, how many days finished files are kept, and the accent color used for buttons and highlights.

Permissions and data

Libretto reads Jira work items to build documents and writes attachments and comments only when you ask it to deliver a file to an issue. Every manual export runs as you, so you only ever export what you can see. Job records (query, template, timings, the account ID of the requester) and schedules live in Atlassian Forge hosted storage; issue data fetched for an export and the finished files are held in the Atlassian Forge Object Store inside your site's context and removed after delivery or after the retention period. The app declares zero external network egress; no data leaves Atlassian's infrastructure.

Support

Questions or problems: support@helzbrand.com