Running a VisualScript Report

Introduction

VisualScript includes a set of pre-built scripts that allow you to obtain reports on a variety of useful information. They are also meant to simply whet your appetite and show you what's possible to query and build. We will be adding new scripts regularly. You can use these reports without writing any code yourself. It's a good way to see the power of VisualScript and maybe inspire you to create your own reports.

In general terms, to run one of the built-in VisualScript reports:

  1. Add the desired gadget or macro to your dashboard or page
  2. Enter the parameters for the information you wish to see reported

Start with a Dashboard in Jira

VisualScript can be used on both Confluence and Jira. They generally work similarly to each other. The only difference is that in Jira, VisualScript gets accessed through gadgets on dashboards while in Confluence, you access the reports via macros on page blueprints.

We'll take a look at the Jira implementation in depth.

To use VisualScript with Jira, you add one of the VisualScript gadgets to a Jira dashboard.

To begin, go to the dashboard you wish to use. If you don't already have a dashboard set up, you can create one using the "Manage Dashboards" option in Jira's "Dashboards" menu item.

Jira dashboard dropdown

On the dashboard, click the "add a new gadget" link to open the gadget browser.

Add new gadget

Add a VisualScript Gadget

The "Add a gadget" dialog contains a list of gadgets that have already been loaded, since we're assuming this is the first time you're going to use VisualScript, you'll have to click the "Load All Gadgets" link in the "More Gadgets Available" box.

Gadget dialog

Next, scroll down to the list of all the VisualScript gadgets or simply type "VisualScript" into the search/filter box in the top left area of the list.

Gadgets list

There are two types of VisualScript gadgets you'll find on this list:

  1. One type lets you create your own custom visual in some form whether by writing code into a Script Editor or by pointing to a REST endpoint you've created elsewhere
  2. The second type are fully-functional built-in example scripts you may find useful without any extra code

Choose one of the VisualScript gadgets on the list and click its "Add Gadget" button. This adds the gadget to your dashboard. For this tutorial, let's add the Project Hierarchy gadget that will build a visual of all your interconnected epics, stories, and subtasks.

Run the Report

Run report

The last thing you have to do before you can view your report is provide the script with the parameters that it requires. In this case, it only needs the key of the project that you wish to report on. Enter that name, then click the update button. The update button stores this project name and then displays the report.

Finished dashboard

Now that this gadget is added to your dashboard and configured with its parameter, any time you view this dashboard it will re-run the script and update the data with the latest information from Jira.