Docs → Prefab
Prefab docs
Prefab is a Jira Cloud app for reusable issue templates. Templates pre-fill Jira's native Create screen and scaffold whole epic → story → sub-task hierarchies in one click. You manage templates under Project settings → Prefab Templates and in the Prefab page in Jira's Apps menu, and apply them with Create from Prefab template in the issue view's actions menu.
Getting started
Before you install
- Jira Cloud. Prefab is built on Forge and runs on Atlassian, with no external servers.
- A Jira admin to install the app and approve its scopes.
- Project admin rights to manage a project's templates and defaults. Jira admin (global admin permission) to manage global templates, import from a templates project, or generate a template from a description.
- Anyone who can see an issue can apply a template, unless template permissions (Standard plan) limit who can use it.
- Optional: Jira Service Management for customer-portal pre-fill, and a project with Jira's Rank field to keep created issues in template order.
Install and first use
- Open the project's Prefab settingsIn a project, go to Project settings and choose Prefab Templates in the sidebar. The page lists the project's templates with their defaults and actions.
- Create a templateUnder New template, give it a name and pick a root issue type. Prefab loads an input for each field on that issue type's create screen (text, paragraph, number, dates, priority, selects, labels, components, versions, users). Fill the values you want, add an optional Checklist, and use Add sub-issue to build the hierarchy.
- Save it: the Create screen pre-fillsIn a project with no default yet, Apply this template automatically on the Create screen for this issue type starts ticked, so saving your first template turns pre-fill on (untick it if you don't want that). A Default lozenge appears next to the template, and Jira's main Create dialog pre-fills those fields for that project and issue type. Templates you import or copy in get a one-click Make default button, and the Prefab page in the Apps menu lists every project with templates under Set up Create-screen pre-fill, with Enable pre-fill for any project where it is off.
- Scaffold a hierarchy from an issueOpen any issue, open the issue actions menu and choose Create from Prefab template. Pick a template (and a target project if needed), then click Create issues. To add the template's sub-issues under the current issue instead of creating a new top-level issue, tick the Add the template's sub-issues under … option.
- Optional: share templates across every projectOpen Apps → Prefab to manage Prefab global templates. Choose a Reference project (its issue types and fields drive the form); global templates are then available in every project.
- Ask RovoIf your site has Rovo, open the Prefab Template Generator agent and describe the work, for example Create a template for a release checklist. It builds a Prefab template with a root issue and its child issues, asks for the project if it needs one, and only reports templates it actually created.
Configuration
Project defaults and pre-fill surfaces
Each project can have one default template per issue type. Use Clear default to remove it. Deleting a template also removes any default that pointed at it.
Below the template list, Transition screens lets you pick a template per target status: when someone opens a transition screen moving an issue into that status, Prefab fills the screen's empty fields. Values already on the issue are never overwritten.
In service projects, Customer portal lets you pick a template per request type to pre-fill the portal request form. This uses Atlassian's customer-portal UI modifications, which are still in Preview. Fields only fill if they are on that request type's form; the embedded widget and anonymous portals aren't supported yet.
Under Required on the Create screen you can mark fields required when the template is a default. This is UI-level only and is not enforced for REST or automation.
Template actions
- Edit and Delete a template in place.
- Copy to… copies a template to another project.
- Make recurring exports the template in the format Datum's Encore app imports. Prefab itself doesn't schedule anything.
- History (Standard plan) lists earlier versions; Restore brings one back.
- Permissions (Standard plan) sets who can view, use or edit a template or folder, by group or project role. Admins always keep full rights.
Template health check
When Jira changes under a template (a field, option or issue type is deleted, or a user is deactivated), Prefab shows a warning listing what broke, with a one-click fix. For project templates the fix removes the dead values and keeps the prior version in history. Global templates are checked against the reference project you picked; only deactivated users are removed automatically, and the rest is listed for you to edit.
The Create from Prefab template dialog also warns when a template no longer matches the project. You can still create; Jira rejects or drops the broken values.
Import, export and migration
- Import / export on the project page: Export templates gives JSON you can copy; paste exported JSON into Import templates from exported JSON to restore or move templates. Imports are validated and entries that fail are listed.
- Import from a templates project (global page, Jira admin): turns each top-level issue of a template-repository project, such as the one Deviniti's Issue Templates uses, into a global template with its child issues. Summary, description, labels and priority are copied; custom fields, components, assignees and the other app's settings are not.
- Import from another app (global page, Standard plan): bulk-imports templates from JSON.
- Generate from a description (global page, Jira admin): write one
IssueType: summaryper line, indenting to nest, and Prefab builds a global template. In Rovo, the Prefab Template Generator agent does the same from plain English.
Standard plan: automation, REST API and audit log
These sections are on the Apps → Prefab page and need an active Standard licence.
- Automation rules scaffold a template under a top-level issue when it is created, or when it moves into a status you pick. Each rule runs once per issue, and no workflow edits are needed.
- REST API: click Generate token to get a bearer token and the endpoint URL, then POST JSON with
templateIdandprojectId(optionallyparentKey,variablesand your ownjobId). Responses carry no data; the status endpoint reports queued, running, done, partial or failed, and created issues can be found with JQLprefabJob = "<jobId>". Replace token rotates it and Turn off API disables it. - Audit log shows who changed and applied templates, and when.
- Variables in the template editor add placeholders people fill in when applying a template, with default values and a Required at apply time option.
Language
Available in English, German, French and Spanish. The app follows each person's Jira language setting; Rovo answers, exports and comments the app posts stay in English.
Free vs Standard
Plans and prices below are read from the same pricing file the app uses. Atlassian bills per user per month on your site's user tier, and the price per user steps down at larger tiers. See all pricing.
Free
Free
- Unlimited templates with sub-task & epic hierarchy, created in template order
- Full field pre-fill incl. required custom fields, on the native Create screen
- Per-issue-type / per-project default templates
- Pre-fill JSM customer-portal requests and transition screens (Atlassian Preview features)
- Apply into any project, or add a template's sub-issues under an existing issue
- Cross-project template copy
- Checklists in templates (Jira checkboxes in the description)
- Make recurring: one-click hand-off to Encore
- Template health check: flags deleted fields, options, issue types and inactive users, with one-click repair
- One-click import from a templates project (e.g. Deviniti Issue Templates)
- Import & export templates
Standard
$0.75 / user / month
Free for sites up to 10 users. 30-day free trial.
- Variables & forms with a dedicated admin UI (default values + required fields)
- Automation-triggered templates (on create or on transition)
- Template version history + restore
- Bulk template importer (JSON)
- REST API to apply templates from scripts and CI, with job ids and status
- Template & folder permissions (who can see, use, edit — by group or role)
- Audit log + priority support
Limits
- Free plan: unlimited templates. The plan-only features above (variables, automation, version history, bulk JSON import, REST API, permissions, audit log) need an active Standard licence; if it lapses, automation rules stop firing and the REST API answers 403.
- A template can create up to 500 issues in one apply. Templates with more than 40 issues are created in the background so the dialog doesn't time out.
- Children are ordered with Jira's Rank field. In projects without it every issue is still created, with an Order not applied note.
- Create-screen pre-fill works in Jira's main Create dialog (the Create button or the
cshortcut). Board quick-create starts blank, an Atlassian limitation. - Field types the editor can't handle are hidden in the form; they stay editable through JSON import.
- Version history keeps the last 20 versions per template. The audit log keeps the newest 200 entries.
- Import from a templates project reads up to 500 issues per run.
- Automation rules only fire for top-level issues (issues without a parent).
- REST API job ids must be 8–64 characters of letters, digits,
_or-, and each job id can be used only once.
Data & privacy
What Prefab stores
- Everything is kept in Forge hosted storage inside your Atlassian site, isolated per install. The manifest declares no external egress, so nothing is sent to Datum or other servers.
- Templates: name, scope (project or global), issue types, field values, checklists, sub-issues and variables, plus lookup indexes.
- Defaults: per-project default templates by issue type, transition-screen defaults by status, and portal defaults by request type.
- Version history (last 20 per template), the audit log (newest 200 entries), automation rules, and template and folder permissions.
- Progress records for background applies and REST API jobs. The REST API token is stored only as a SHA-256 hash.
- On Jira issues: a
prefab-scaffoldedissue property (which automation rules already ran) and aprefab-jobissue property (the REST job id, searchable asprefabJob). Prefab also registers one Jira UI modification, "Prefab default templates", to switch on pre-fill. - Templates and the audit log can contain Atlassian account IDs (user-field values and who made a change). Prefab reports these weekly to Atlassian's personal data reporting API and erases closed accounts.
Prefab runs on Atlassian Forge. Data it stores sits in Forge hosted storage for your site, which Atlassian pins to your product's region. See Trust & security, the Privacy Policy and the DPA.
Permissions (scopes)
| Scope | Why Prefab needs it |
|---|---|
read:jira-work | Read projects, issue types, create-screen fields and issues, and manage the UI modification used for pre-fill. |
write:jira-work | Create issues from templates and write the app's issue properties. |
manage:jira-configuration | Part of the scope set Jira's UI modifications need for Create-screen, transition and portal pre-fill. |
read:jira-user | User fields in templates, permission checks, and required by Jira's UI modifications runtime. |
manage:jira-project | Part of the scope set Jira's UI modifications need for pre-fill. |
storage:app | Store templates, defaults, history, rules and the audit log in Forge hosted storage. |
report:personal-data | Weekly report of stored account IDs to Atlassian, so closed accounts can be erased. |
read:servicedesk-request | List a service project's request types and portal for customer-portal pre-fill. |
write:issue:jira-software | Rank created issues in template order (Jira Software rank API). |
FAQ & troubleshooting
The Create screen isn't pre-filled. What should I check?
Pre-fill only runs when the project has a default template for the selected issue type: look for the Default lozenge under Project settings → Prefab Templates, or check the project's status under Set up Create-screen pre-fill on the Prefab page (Apps menu), where Enable pre-fill or Retry fixes it in one click. It works in Jira's main Create dialog (Create button or c); board quick-create starts blank. Prefab registers pre-fill when you set a default and re-checks it daily, so re-saving the default is a quick way to repair it.
Where is "Create from Prefab template"?
Open an issue and use the issue view's actions menu. If the dialog says No templates yet, create one under Project settings → Prefab Templates or as a global template in Apps → Prefab.
The created issues aren't in template order.
Prefab orders children with Jira's Rank field. If the project doesn't have it, all issues are still created and the dialog shows Order not applied.
The apply dialog says the template no longer matches this project.
A field, option, issue type or user in the template has changed in Jira. Use the health warning on the Prefab settings page to fix it; you can still create, but Jira rejects or drops the broken values.
Why can't I save a global template or run an import?
Global templates, Import from a templates project and Generate from a description need the Jira global admin permission. Project templates need project admin rights on that project.
Can I move my templates from Deviniti's Issue Templates?
Yes, if they are stored as issues in a templates project. On Apps → Prefab, pick a reference project, then use Import from a templates project. Each top-level issue becomes a global template with its children (up to 500 issues; summary, description, labels and priority). Review each one afterwards.
What happens to automation rules and the REST API if our Standard licence ends?
Your rules and settings stay stored, but rules stop firing on unlicensed sites and the REST API answers that it needs an active Standard licence. Free features keep working.
Does Prefab send data outside Atlassian?
No. It runs on Atlassian's Forge platform with no external egress. The REST API's responses are fixed messages, so even they carry no data out.
Changelog
Every release and what changed: Prefab changelog.
Getting help
Email support@datadir.co with your site URL and what you saw. Our target is a first response within 1 business day. See Support for what to include, and Status for known issues.