Report Builder: "How to export and import a Scripted Report" guide

Report Builder: "How to export and import a Scripted Report" guide

Overview

With JSON export and import you can move a Scripted Report from one Jira site to another (for example, from a test site to production), share it with a colleague, or add a report that the Actonic team built for you.

The JSON file contains the report itself: its HTML template, script and input fields. It does not contain any data from your Jira.

JSON export and import is available for Scripted Reports only. Reports made with the Universal Visual Builder have no Export JSON option. To copy one of those, use ⋯ → Save as…. To take its data elsewhere, use ⋯ → Export to CSV or Export to XLS.

Required permissions

To import a Scripted Report you need the Scripted Reports Creator permission. A Report Builder administrator grants it in the Report Builder settings.

Export a Scripted Report

Step 1. Open Report Builder in Jira. In the report list on the left, open the Scripted Report you want to export. You can find it on the All, My or Shared tab.

Step 2. Click ⋯ (More actions) in the top-right corner of the report and choose Export JSON.

The More actions menu of a scripted report with Export JSON highlighted
The ⋯ menu of a Scripted Report

Step 3. The JSON Export window shows the report code. Click Copy to copy it to the clipboard, then click Close. To keep the report or send it to someone, paste the code into a text file and save it with the .json extension.

The JSON Export window with the Copy button highlighted
The JSON Export window

Import a Scripted Report

Step 1. In Report Builder, click + New above the report list. The Templates tab opens.

Step 2. Scroll to the bottom of the template list and click Import Scripted Report. You can also find it by choosing the Other category.

The Templates tab with the New button and the Import Scripted Report item highlighted
Import Scripted Report is the last item on the Templates tab

Step 3. The JSON Import window opens with an empty field. Paste the report code into the field and click Import. The code can come from Export JSON, or from a .json file you received from Actonic or a colleague. In that case, open the file in a text editor and copy all of its content.

The JSON Import window with report code pasted and the Import button highlighted
The JSON Import window

Done! You will see the message Success! Report has been imported!. The report opens right away and appears at the top of your My tab.

The imported report open, highlighted at the top of the My tab
The imported report at the top of the My tab

Good to know

  • The imported report keeps the name from the JSON. If you import a report into the site it came from, you will have two reports with the same name. The new one is at the top of the list, so rename it to tell them apart.

  • An imported report is Private. To share it, use ⋯ → Permissions and share.

  • The Import button stays disabled until the field contains code. If the import fails, check that you pasted the complete JSON, from the first { to the last }.

  • If the report script refers to custom fields by ID (for example, customfield_10010), check those IDs after you move the report to another Jira site. The same field usually has a different ID on another site.