Create and manage report configurations

If you find you generate the same report on a routine basis, consider saving the report's settings as a report configuration. Doing so allows you to quickly generate the same report without having to configure the report's settings each time. Add a schedule to a report configuration to automatically generate the report on a daily, weekly, or monthly basis.

Create a report configuration

To create a report configuration, follow these steps:

Go to Reporting > Saved Configurations.
Select + Create Configuration.
The Create Configuration page is displayed.
Select a Report Type.
Enter a Report Name.
Report configuration names must be unique, are limited to 240 characters, and can include special characters.
(Optional) Select Append date to report name: to add a date suffix to the report name each time you run the report configuration.
To create a report configuration for all applications and projects in your organization, leave the All applications and projects (default branches/profiles only) option selected.
Adjust the scope of the report:
- All applications and projects (default branches only) (default): Include data from all the applications and projects in your portfolio that you have access to. Only includes issues from default branches.
- Applications, projects and branches/profiles matching specific filters (non-IDE branches only): Set up a filter to select the applications, projects, and branches (not IDE) to include in the report. After you select this option, select Manage Scope. Use the options in the Manage Scope window to set up your filter, and preview the applications, projects, and branches the filter selects on the right. If using branch labels, you can use the checkboxes under Labels to refine your selection. Click Save.
  Note: If you want to include IDE branches in your filter, select the next option.
- Specific project branches/profiles: Select specific applications, projects, and branches to include in the report. After you select this option, select Manage Scope. Use the options in the Manage Scope window to select the branches to include in the report. If using branch labels, you can use the checkboxes under Labels to refine your selection. After you adjust a filter, use the checkboxes in the Branch/Profile column to select branches to include in the report. Click Save.
Select at least one testing tool from the Tools options.
(Optional) Under Report Modules, select which modules to include in the report:
- Use the checkboxes to include or exclude modules from the report. All modules are enabled by default, except Tool checker information, which is disabled by default. Enable it to include a list of checkers used during the latest tests (of projects and branches in the report's scope).
- For modules with an Edit button, select Edit to customize the module's content. Some modules reveal editable text fields; others reveal checkboxes to include or exclude specific information, such as charts and table columns.
Tip: Module selections and content customizations are saved as part of the report configuration, so the same customized report structure is reused each time the configuration runs.
(Optional) Schedule the report configuration to run automatically:
1. Select Edit Schedule.
2. Use the options on the Schedule window to specify when the report configuration will run (Daily, Weekly, or Monthly), the time report generation will start, and the day(s) of the week/month when the report configuration will run.
  
  Note: Remember, it can take up to 60 minutes for data from a test to be available to create a report. Scheduling report configurations to run outside of your organization's active hours (and after automated tests run) may improve results.
3. Select Save.
Select Save > Save.

Tip: You can run the report configuration when you save your changes (Save > Save and Run) or run the report (using the options on screen) without saving a report configuration (Save > Run).

Create a report configuration using a completed report

After you run a report, you can save the completed report's configuration as a report configuration. To create a report configuration based on a completed report, follow these steps:

Go to Reporting > Latest Reports.
Click the options icon at the end of a completed report's row and select Save Configuration.

Run a report configuration

To create a report using a report configuration, follow these steps:

Go to Reporting > Saved Configurations.
Click the options icon at the end of the report configuration's row and select Run.
The Latest Reports tab opens.

Duplicate a report configuration

To duplicate a report configuration, follow these steps:

Go to Reporting > Saved Configurations.
Click the options icon at the end of the report configuration's row and select Duplicate.
The Duplicate Configuration page opens.
(Optional) Adjust the report configuration's Report Type, Report Name, Scope, or other options.
Select Save > Save.

Tip: You can run the report configuration when you save your changes (Save > Save and Run) or run the report configuration and discard your changes (Save > Run).

Edit a report configuration

To edit a report configuration, follow these steps:

Go to Reporting > Saved Configurations.
Select the report configuration you wish to modify.
Adjust the report configuration's Report Type, Report Name, Scope, or other options. Select Edit Schedule to add or modify the report configuration's schedule.
Select Save > Save.

Tip: You can run the report configuration when you save your changes (Save > Save and Run) or run the report configuration and discard your changes (Save > Run).

Share a copy of a report configuration

To send a copy of a report configuration (without associated schedules) to one or more users or groups in your organization, follow these steps:

Go to Reporting > Saved Configurations.
Click the options icon at the end of the report configuration's row and select Share a Copy.
The Send a Copy of Configuration dialog opens.
Select the Select Users or Groups field.
The Users and Groups tabs appear.

Note: You must select at least one user or group to share the report configuration with.

Important: Unless you're an admin for your organization, you can only select users or groups who have access to all applications mentioned in the saved configuration. If you are an organization admin, sharing with people who can't already access the relevant applications will allow recipients to see the configuration values, so you'll be warned of this before confirming the share action.
To add users, select the Users tab and use the Search field to locate them based on their name or email address, then select them.
To add groups, select the Groups tab and use the Search field to locate them based on their name, then select them.

Note: Changes made to a group after sharing a configuration with it won't affect who has access to the configuration; people added to the group won't automatically receive a copy of the configuration, and people removed from the group won't lose their copy.
Select Send.

Add or modify a report configuration schedule

To add or modify a schedule, follow these steps:

Go to Reporting > Saved Configurations.
Click the options icon at the end of the report configuration's row and select Schedule.
Use the options on the Schedule window to specify when the report configuration will run (Daily, Weekly, or Monthly), the time report generation will start, and the day(s) of the week/month when the report configuration will run.

Note: Remember, it can take up to 60 minutes for data from a test to be available to create a report. Scheduling report configurations to run outside of your organization's active hours (and after automated tests run) may improve results.
Select Save.

Changes to the report scope

The report scope determines what data is included in a report configuration. If an application, project, branch, or label in the report scope is deleted, the report configuration becomes invalid. If you try to re-run the report configuration, the report status changes to Failed and the report does not run. Any scheduled runs of the report configuration will also fail. You get the following error: “Report failed due to an invalid scope. Update your configuration and run the report again”.

The Latest Reports tab showing a report with a status of Failed and an invalid scope error message on hovering over.

The same error is shown if an application, project, or branch in the report scope was renamed.

To resolve an invalid scope error, follow these steps:

Go to Reporting > Saved Configurations.
Select the report configuration for the report that failed to run.
Click Manage Scope.
In the Manage Scope window, edit the filter criteria to remove the object that was deleted.

Tip: For example, if label-a was deleted but is still included in the report scope, deselect the label-a checkbox in the Labels section of the filter.
Click Save to save your updates to the report scope.
Click Save > Save and Run to re-run the report configuration.

Delete a report configuration

To delete a report configuration, follow these steps:

Go to Reporting > Saved Configurations.
Click the options icon at the end of the report configuration's row and select Delete.
A confirmation appears.
Select DELETE.

Note: If you delete a report configuration while it's being used to create a report, the report may fail.