Admin Only: Editing a Built-In Report inside Confluence

You can modify any of the built-in reports as an administrator. We've include all the source code to make it easier to customize the report for your organization.

First, navigate to the admin interface of VisualScript.

To access the admin interface of VisualScript in Confluence, click on "Settings". You should see VisualScript with the option to "Create/Edit Reports".

The report browser consists of two main areas: custom reports you've created under "My Reports" and built-in reports under "Built-in Reports".

If you haven't created any reports yet, you will see the list of built-in reports by default.

Click on any built-in report to modify it.

By default, a built-in report will open with no name selected to it to prevent you accidentally overriding the built-in code. Before you can save a copy of a built-in report you'll have to give it a new name.

Name your new report and click on "Create." Now you can customize it to your liking.

Using the Code Editor to Modify the Report

The Code Editor is a feature-rich JavaScript editor in which you will create and modify the script's code. It provides many convenient and familiar features of lightweight modern code editors such as syntax highlighting (primarily via color), bracket-matching, auto-complete of brackets, parenthesis and quotation marks. The Code Editor also alerts you to syntactical errors.

You can learn how basic scripts are built by browsing our documentation:

• The VisualScript SDK
• Read the VisualScript Cookbook

Creating Parameters for User Input

When you create a report, you may want to allow users to specify values to key parameters to pull data specific to their request. This might be the name of a project, the name of a sprint or a list of sprints, a date range, or a boolean. 

The built-in scripts already have some parameters set up, but you can easily change this. For example, you may want to create a drop-down of relevant spaces or pages instead of asking users to type in the name of the space freehand.

The Script Parameter section of the Editor allows you to format and type variables that are passed to a JavaScript function with field tokens that are replaced by their values. Learn more about setting up user input parameters here: Admin Only: Setting Up User Input Parameters