Datacenter Configuration
- Rustem Shiriiazdanov
Overview
This article describes how to configure Report Builder Data Center 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 Configure as shown below:
You will be prompted to the application Configuration Page as follows:
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 every time you click it.
Option 2. Alternatively, you may navigate to the App directly from Apps menu:
Clicking “Report Builder“ will allow you to navigate to “My Reports“ 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
Page contains following list of tabs:
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 |
Issue Export Panel | Tab contains settings to control visibility over Issue Export feature |
Visibility | Tab controls whether the app menu is visible for users |
Export/Import | Tab controls App configuration Export functionality |
General Settings
This tab defines of Report Builder processes data from Timesheet Builder, and if a custom name for Report Builder is defined.
Settings details are given in the table below.
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. |
Report Builder user visible name | Report Builder | String that defines what users will see as the Application name in Jira navbar on the top of the screen. | You may change the name of the applications, and save it. Edit text input is limited to 64 symbols in length. |
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 |
|---|---|---|---|
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:
|
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.
Settings details are given in the table below.
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 |
|---|---|---|---|
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.
Visibility
This tab controls who can see Report Builder app menu.
Settings details are given in the table below.
Setting | Default value | Description | Behaviour details |
|---|---|---|---|
Visibility Groups |
| Groups who will be able to see Report Builder: Timesheets and Data Analysis menu link. | When specifics groups selected, only users from these groups will see Report Builder menu link:
|
Note: Please notice this setting is only controlled on groups level, you cannot adjust it to specific users.
Data Collection
Export/Import
This tab allows admin to export App Configs as a JSON-file to perform migration from old version of the app to Timesheet Builder.
Settings details are given in the table below.
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. |