Document Generation for Jira gives tools for customizing documents templates to match your specific needs.
To manage templates, open 'Templates' page accessible from App configuration section, or select 'Templates' menu from Jira side menu if the feature was made available by administrator.
IMPORTANT! for non-admin users, 'Templates' page will only show:
In the opened window, you can browse and edit existing templates or create new ones.
The actions menu allows to delete a template, or to disable it. Disabled templates are only visible in 'Templates' menu, and are excluded from the list of templates available to Jira users while exporting / generating documents.
Templates can be filtered either by the name, user who created or edited a template, or context the template can be used for.
Create/update author filter | Context filter |
To create a new template, click 'Add' button at the top right corner of the screen.
To edit template, find it in the list and click either its name or its thumbnail. Alternatively, you can select Edit from right-hand actions menu () which opens the template editor. You can edit template, by updating its name, description, content, default format, context, export and access options.
You can view, create and quickly modify templates by using a template editor. Templates have HTML format. For the convenience of users, we provide two ways of working with the templates:
You can switch between two modes at any time, by clicking 'Code view' button located in the upper tool panel.
You can insert a special text tag, which when generating the document will be replaced by data from Jira, like issue key, assignee, or comments.
For example, issue summary can be inserted the next way:
{{[issue.summary]}} |
---|
In editor, fields can be easily inserted by clicking on 'Field' button. All available fields will appear in the drop-down menu as shown below.
See Template syntax to learn more.
Document generation supports two types of templates:
You can specify file formats that users will be allowed to export to. Also, the default format for current template is specified.
At the moment, following formats are available:
There are three available contexts:
Once a template is saved, Edit Access button becomes enabled for the template permissions setup.