Cloud Configuration

Overview

This article describes how to configure Report Builder Cloud version.

Requirements

Only Jira Admin has access to perform Application configuration changes.

Accessing Report Builder Configuration Page

Option 1. From Manage Apps panel click on “Report Builder“ application, and then click Get started as shown below:

You will be prompted to application Welcome Page as follows:

image-20240326-204543.png

On the left panel of the app, you can see “Configuration” button presented in a form of gearwheel icon. This button will navigate you to app Configuration page.

Option 2. Alternatively, you may navigate to the App directly from Apps menu:

Clicking “Report Builder“ will navigate you to User home page. From that page a navigation to Configuration page is also possible:

Note: Configuration page button is only enabled for Admin accounts.

Configuration page

Overview

Configuration page is presented on a screenshot below

image-20240326-204651.png

Page contains following list of tabs:

Tab title

Description

Tab title

Description

General

Tab contains integration settings details for Actonic Timesheet Builder.

Dates

Tab contains week start and date format settings

Permissions

Tab control global permissions restrictions to create Scripted Reports

Issue Export Panel

Tab contains settings to control visibility over Issue Export feature

Export/Import

Tab controls App configuration Export functionality

General Settings

This tab defines how Report Builder processes data from Timesheet Builder.

image-20240326-204651.png

Settings details are given in the table below.

Setting

Default value

Description

Behaviour details

Setting

Default value

Description

Behaviour details

Teams Permissions Enabled

Enabled

This setting controls whether Report Builder is integrated with Timesheet Builder when building reports against Worklogs.

Integration is always enabled if you have a licensed version of Timesheet Builder.

Note: This setting will not be enabled until you install timesheet Builder App.

Dates

This tab defines date setting for the entire app globally.

Settings details are given in the table below.

Setting

Default value

Description

Behaviour details

Setting

Default value

Description

Behaviour details

Start Day (weekly)

Sunday

Defines what day will be considered as the first day of the week on the app level.

Available days to set as week start:

  • Sunday

  • Monday

Date Format

d/MMM/yy

Defines in what format reports will show date values.

Input field is a text field accepting most popular date formats (mm/dd/yyyy, dd/mm/yyyy etc.)

Note: Scripted reports may ignore these settings depending on the algorithms defined by their respective developers.

Permissions

This tab defines global permissions settings for the entire app.

image-20240326-204840.png

Settings details are given in the table below.

Setting

Default value

Description

Behaviour details

Setting

Default value

Description

Behaviour details

Scripted Reports Creator

Public: Any logged in user 

This setting defines what users or groups can create and clone Scripted Reports

Private: Nobody

User: Allow to add one or more users individually as creators

Groups: allows to define one or more groups

Projects: Allow to add one or more Projects

Public: Any user logged to the Jira Instance

Note: You may create flexible permissions model by adding users individually and within groups/projects at the same time.

Only grant permissions for creating scripted reports to users with substantial JavaScript knowledge. Improper work with JavaScript may result in data corruption or loss.

Be cautious: granting this permission without proper control can expose your system to XSS or other injection attacks. Ensure you trust the users you are providing this access to.

Issue Export Panel

This tab controls who can perform issues exports using Report Builder.

Settings details are given in the table below.

Setting

Default value

Description

Behaviour details

Setting

Default value

Description

Behaviour details

Issue Export Panel Visibility

Enabled for Everyone

Setting allows or disables a feature to export individual issues as XLSX or DOCX files from issue right panel:

 

Enabled For Everyone: Panel is enabled for every user

Disabled For Everyone: Panel is disabled for every user

Enabled Only For: Admin could set a list of users, projects, and groups who will have the panel enabled

Note: You may create flexible permissions model for Issue Export Panel by adding users individually and within groups/projects at the same time.

Data Collection

 

Export/Import

This tab allows admin to export App Configs as a JSON-file

Settings details are given in the table below.

Setting

Default value

Description

Behaviour details

Setting

Default value

Description

Behaviour details

Export Data

Action Button

Support Configuration Export into JSON file

When button is pressed, a JSON will be created, and presented for user through a pop-up window, allowing to copy-paste settings.