Report Builder Cloud: Setup and Administration guide
Overview
This guide is useful for all Jira administrators and lets you easily configure Report Builder in your Jira. Find out how to manage all Report Builder modules and what settings you can make.
Required modules selection
Find the Report Builder section in your Jira — navigate to the App tab and choose any Report Builder module in the dropdown menu. Click on the logo in the left top corner (it's circled in red in the image below), and view the Global settings for Admins page.
On this page, you can read short descriptions of the modules and documentations. After that, activate or deactivate Timesheets, Reports, and Teams modules according to your very own needs.
Once you’ve selected the modules, you can choose to see more details. There, you can start with the configuration.
In this guide, we will show you how to easily configure Report Builder.
App configuration
General
Navigate to the General tab of the Configuration section. Here, you can enable or disable the Report Builder modules. If you change something, click the Save button after that.
Dates
Navigate to the Dates tab of the Configuration section and find the fields for the Start day and the Date Format.
Let’s take a look at the Dates tab’s parameters in detail:
Parameter Name | Default Value | Description |
---|---|---|
Start day | Sunday | The Start day option defines which day (Sunday or Monday) the week starts in Report Builder. Choose the one you like. |
Date Format | d/MMM/yy | The Date Format option defines how the date will look like in the following tables, reports, and modules:
Use JDF (Java Date Format) to configure the date on this tab. |
Click the Save button after edited everything.
Periods
Next go to the Periods tab of the Configuration section. At this tab, you can configure the view of calendar periods for users.
Here is an overview of the Periods tab parameters which you can set:
Parameter Name | Default Value | Description |
---|---|---|
Use periods and work log approvals | Disabled | Enable this option if you want to display time periods for approvals in users' timesheets. |
Periods Configuration | Monthly | Choose the type of time periods you want to display — Monthly or Weekly. |
Periods Start Date | Current date | Set the date from which you need time periods to be displayed. |
Click the Save button to save your settings.
Permissions
Navigate to the Permissions tab of the Configuration section and find tools for managing permissions for users.
Here is an overview of the Permissions tab parameters which you can set:
Permission Name | Default Value | Description |
---|---|---|
Team managers (can create and manage their own team) | Private | This permission allows users to create and manage their own team. Select the user type in the drop-down menu (Project, Group, User, Public, Private) and then find a suitable name for the project, group, or user in the drop-down selection list next to it. Click the Add button and see which users you are assigning this permission to in the row below. Public: means that all users will have this permission. Private: means that nobody has this permission except you. |
Team global administrators (can manage ANY team) | Private | Users can manage teams with this permission. Select the user type from the dropdown menu (Project, Group, User, Public, Private) and then find a suitable name for the project, group, or user in the dropdown selection list next to it. Click the Add button and see which users you are assigning this permission to in the row below. Public: means that all users will have this permission. Private: means that nobody has this permission except you. |
Scripted Report Creator (can create and clone Scripted Reports) | Private | With this permission, users can create and clone Scripted Reports. Select the user type from the dropdown menu (Project, Group, User, Public, Private) and then find a suitable name for the project, group, or user in the dropdown selection list next to it. Click the Add button and see which users you are assigning this permission to in the row below. Public: means that all users will have this permission. Private: means that nobody has this permission except you. |
You can delete all added permissions using the Delete button with a bucket image:
Click the Save button at the bottom of the page when all parameters are set.
Issue Export Panel
Navigate to the Issue Export Panel tab of the Configuration section. Here, you can manage the visibility of the Report Builder Export panel for users in Jira tickets.
Define who will be able to view the Issue Export Panel in tickets:
Parameter Name | Default Value | Description |
---|---|---|
Issue Export Panel Visibility | Enabled For Everyone | Set Enabled For Everyone if you want to display this panel for all users. Set Disabled For Everyone if you want to hide this panel for all users. Set Enabled Only For if you want to display this panel for groups of users or individual users, and choose a Project, Group, or User. After that, find an appropriate name in the dropdown selection list beside. Click the Add button and see which users you added to this feature in the line below. |
Click the Save button to save your settings.
Project Timesheet
Navigate to the Project Timesheet tab of the Configuration section. At this tab, you can manage the visibility of the Project Timesheet tab for users in the sidebar of Jira projects.
Define who will be able to view the Project Timesheet tab in Jira projects:
Parameter Name | Default Value | Description |
---|---|---|
Project Timesheet Visibility | Enabled For Everyone | Set Enabled For Everyone if you want to display this tab for all users. Set Disabled For Everyone if you want to hide this tab for all users. Set Enabled Only For if you want to display this tab for groups of users or individual users, and choose Project, Group, or User. After that, find an appropriate name in the dropdown selection list beside. Click the Add button and see which users you add this feature in the line below. |
Click the Save button to save your settings.
Now, Report Builder is configured, and you are ready to go!