What are Scripted Reports

What are Scripted Reports

We build customized reports for you. Check out our Report Building Service.

Scripted Reports are Report Builder's escape hatch. When the visual builder cannot express what you need, you write the HTML and the JavaScript yourself, and the app hands your code the Jira data it has already fetched. Your code renders whatever it likes — a branded invoice, a diagram, a custom export, a layout no pivot table can produce — for Jira Software, Jira Service Management and Jira Core alike.

Scripted Reports require working knowledge of HTML and JavaScript. Improper code can corrupt data or expose your instance to XSS. Grant the creation permission only to users you trust — see Report Builder Configuration

Where to find them

Open Report Builder and click New report. The Templates tab lists everything you can start from, and the first two entries decide which engine you get:

  • Blank (universal visual builder) — the no-code pivot builder. Layout, fields, groupings and calculations are configured visually.

  • Blank (custom code) — a Scripted Report. It ships preloaded with a working tutorial report, so you can read real code before writing your own.

Everything below those two is a ready-made template. Templates that are built as scripted reports (Custom Invoice, Support Dashboard, Mermaid Charts & Diagrams, Burnup / Burndown Chart and others) open in the same Scripted Report editor, so any of them is a starting point for your own code.

Templates tab in Report Builder with Blank (custom code) in the list
New report → Templates. "Blank (custom code)" is the starting point for a Scripted Report.

What working with one looks like

  1. Pick Blank (custom code), or open any gallery template you like.

  2. Fill the input parameters in the floating Configure panel and press Refresh to run the report.

  3. Switch to the Template, Script or Split editor tab to change the layout and the logic.

  4. Click Add to My Reports to save your own copy. It then appears in the My tab of the report list.

  5. Share it from the Permissions tab. Export the rendered result to PDF, or the report definition itself to JSON, from the … menu next to the report title.

A Scripted Report rendered in Report Builder
A Scripted Report after it has been run: summary cards and two tables produced entirely by the report's own HTML and JavaScript.

Step-by-step tutorial: Create your first Scripted Report