Exporting report definitions in new user experience

Edit online

Administrators can export reports to a compressed (.zip) file so that they can be backed up or imported into another Report Builder data source. For example, you might export reports to copy them from a staging environment to a production environment.

Before you begin

  • Report Builder must be installed and registered as an application with the Jazz Team Server.
  • A default data source must be configured for Report Builder, and you must be connected to it.
  • You must have Jazz administrative privileges or be a report manager.

About this task

From the Reports tab listing, administrator can export a single (using row action) or multiple report definitions (using bulk action).

Procedure

  1. For exporting single report definition, click More actions icon corresponding to the report listed in the Reports tab, that you want to export definitions from. You can also opt to include the creator and report owners in the exported data.
  2. Click Export report definition (Admin) from the available options to download the report definitions in a compressed file format.
  3. Optional: Complete the following steps to export multiple report definitions at once:
    1. Select the checkbox for the corresponding items.
    2. Click Export report definition (Admin) in the toolbar over the Reports tab listing, with which you can perform bulk actions on selected items.

Results

Report Builder generates a compressed file with one of the following names, depending on the criteria-
ReportDefinition_encodedDataSourceName_timestamp.zip
If at least one report is included, and all the reports are for the same data source.
ReportDefinition_AnyDataSource_timestamp.zip
If the export contains only folders.
ReportDefinition_UnpackBeforeImporting_MultipleDataSources_timestamp.zip
If the export has multiple reports that are associated with multiple data sources.
When you import the reports into another Report Builder data source:
  • Import them into the same data source type that they were exported from. For example,
    • If exported from a data warehouse, you must import them into a data warehouse.
    • If exported from an Lifecycle Query Engine (LQE) scoped by a configuration source, you must import them into an LQE scoped by a configuration data source.
    • If exported from LQE, the export is limited to being imported into a Report Builder instance that is connected to the same LQE data source that the reports were exported from. The reports contain information that tightly ties them to the data and the resource shapes that they were generated from.
  • The report names, visibility (private or public), and tags are preserved.
  • The administrator who imports the reports becomes the owner. It is only owners or report managers who can edit the imported reports. If the reports are public, team members can duplicate them.
  • If the imported reports run on a data source that is different or has different data from where they were exported, you might have to modify the scope, conditions, and filters in the imported reports.
    Important:
    • When you build reports on a server that has different data than where they might be run, verify that the condition settings are unlocked and required.
    • Export report definition is only applicable to reports, not folders.