Foliowell documentation

Foliowell turns Jira work items into Word documents from your own templates, PDF reports and Excel workbooks, on demand or on a schedule. It runs entirely on Atlassian.

Where to find it

Export in three steps

1. Enter a title and the JQL (add ORDER BY to choose the order in the document).
2. Pick a format: Word (pick a template), PDF (full details per item, or a table), or Excel (pick columns).
3. Choose what to include: comments, subtasks, linked work items, the attachment list, the work log, change history, and any custom fields. Click Export.

Foliowell checks the size first, then reads the work items page by page (the progress bar shows how many) and builds the file in your browser. It downloads straight away. To keep it in Jira, type a work item key under Attach to a work item.

Limits

Per work item: the first 500 comments, the first 1,000 worklogs and the latest 1,000 history entries (PDFs say when a work item has more comments than were exported; in templates use {{commentsTruncated}}). Word templates can be up to 2 MB. If a query matches more than the limit, Foliowell tells you before it starts; narrow the JQL or split the export (for example by project or by month).

Word templates

A template is a normal .docx. Write placeholders in double braces where values go:

{{key}}  {{summary}}
Status: {{status}}   Assignee: {{assignee}}   Due: {{due}}
{{description}}

Repeat for every work item with {{#issues}} ... {{/issues}}. Put the opening tag in the first cell of a table row and the closing tag in the last cell to repeat the row (a list with a header row). Put them in their own paragraphs to repeat whole sections (one page per item: give the first heading "Page break before" in Word).

Lists inside a work item work the same way: {{#comments}}{{author}}, {{created}}: {{body}}{{/comments}}. Also subtasks, links, worklogs, history, attachments and labelList.

Show something only when a list is empty: {{^comments}}No comments{{/comments}}. Show a heading only when a list has entries: {{#hasComments}}Comments{{/hasComments}} (also hasSubtasks, hasLinks, hasWorklogs, hasHistory, hasAttachments).

One-item templates (a form for a single work item) can skip the loop: {{key}} and the other item fields at the top level are the first work item. Exporting several items with a one-item template fills it from the first item; wrap it in {{#issues}} to repeat it.

Custom fields: tick them under Custom fields, then use {{cf.story_points}}: the field name in lower case, with anything other than letters and digits replaced by _. Two fields with the same name get their id appended ({{cf.team_10050}}). {{customfield_10016}} works too.

Filters change a value: {{summary | upper}}, {{status | lower}}, {{createdIso | date:'D MMM YYYY'}}, {{assignee | default:'Nobody yet'}}, {{description | truncate:300}}, {{comments | count}}.

The Templates tab lists every placeholder. When you upload a template, Foliowell checks it and lists any names it does not recognise (they would print blank), so typos show up before anyone exports.

Placeholder reference

Document: title, jql, generatedAt, generatedBy, company, site, count, totalLoggedHours, loops issues, byStatus (status, count), byAssignee (assignee, count).

Each work item: n, key, url, summary, description, environment, status, statusCategory, type, priority, resolution, project, projectKey, assignee, reporter, creator, created, updated, resolved, due, labels, components, fixVersions, affectsVersions, parentKey, parentSummary, originalEstimate, remainingEstimate, timeSpent, logged, loggedHours, commentCount, raw dates createdIso, updatedIso, resolvedIso, dueIso, and cf.<field>.

Loops: comments (n, author, created, body), worklogs (n, author, started, timeSpent, hours, comment), subtasks (n, key, summary, status, type), links (n, relation, type, key, summary, status), attachments (n, filename, size, author, created), history (n, author, created, field, from, to), labelList (name).

Dates print in your Jira time zone (scheduled exports: the schedule's time zone) using the export's date format. Descriptions and comments print as text: lists keep their bullets and numbers, tables become one line per row, and pictures print as their file name.

PDF reports

• Full details per work item: a field table, then the description, subtasks, linked work items, comments, work log, history and attachment list (whatever you include). Optionally a new page for each work item.
• Table: landscape, one row per work item: key, summary, type, status, assignee, priority, due and updated.

Both have the title, company and query at the top and page numbers at the bottom. PDFs use the standard PDF fonts, which cover Western European languages; characters outside them print as "?". For other scripts, export to Word.

Excel workbooks

The Work items sheet has the columns you pick (standard fields and custom fields), with real dates and numbers, a frozen header row with filters, and keys that link to Jira. Extra sheets appear for what you include: Comments, Work log, Subtasks and links, History.

Scheduled exports

Jira admins and template managers can schedule exports (Schedules tab, or Schedule this export on the Export tab).

• When: every day, Monday to Friday, a day of the week, or a day of the month (1-28), at a whole hour in the time zone you choose. Runs start within the hour.
• Where the file goes: attached to the work item you pick (for example a "Weekly reports" task), so everyone who can see that work item can open it. Pick a work item whose audience should see the exported data.
• Whose view: a schedule belongs to the person who last saved it. It only exports work items that person can browse in Jira, checked on every run, and currentUser() in the JQL means them. Functions that depend on who is searching, such as watchedIssues(), cannot be used in schedules.
• Run now starts a run immediately. Each schedule keeps its last 20 runs with the result: the file name, how many work items, how many were left out because the owner cannot see them, or why the run failed.
• Up to 200 schedules per site.

Who can do what

Template managers are members of the groups a Jira admin picks in Foliowell settings.

Subscription

Foliowell is a paid app billed by Atlassian with a 30-day free trial. If the subscription ends, exports and schedules pause; templates, schedules and their history are kept and work again when the subscription is renewed.

Privacy

Foliowell runs on Atlassian's Forge platform. Downloads are built in your browser; scheduled files are built in Forge and attached to Jira. Nothing is sent to Great Work or anyone else. Details: https://greatwork.company/apps/foliowell/privacy

Help

hello@greatwork.company or the Great Work help desk. Include the JQL, the format, the template name and what you expected to see.