Migrate (Export and Import) Jaspersoft Advanced Reporting Content

As a Jaspersoft administrator, you can export and import the Jaspersoft Advanced Reporting content. This content includes organizations, Ad Hoc views, Ad Hoc reports, custom domains, dashboards, and their dependencies. You can also migrate tenant level data, folders, reports, jobs, domains, input controls, roles, and users. These migration options are helpful when moving custom advanced reporting content between test and production environments.
ccppmod143
As a Jaspersoft administrator, you can export and import the Jaspersoft Advanced Reporting content. This content includes organizations, Ad Hoc views, Ad Hoc reports, custom domains, dashboards, and their dependencies. You can also migrate tenant level data, folders, reports, jobs, domains, input controls, roles, and users. These migration options are helpful when moving custom advanced reporting content between test and production environments.
To use these migration features and to update domain schema, on-premise customers apply Jaspersoft server cumulative patch 6.2.1_5.2.1.2.6. SaaS customers can contact CA Support to request patch installation.
The exported set of folders and files include resources in the repository, such as reports and their dependencies. The exported content is compressed in a single zip archive file.
The content of the zip file is not intended for external access. The zip file contains files in several private formats. The XML syntax is not publicly available and the data files are not meant to be accessed.  
2
 
Dependencies
Jaspersoft Studio reports and views often have dependencies on other resources. These dependencies can include data sources, domains, input controls, queries, and language bundles. For example, a report might depend on images, input data types, and a data source.
  • An exported report includes all dependencies even if they are stored in folders that were not selected during the export.
  • The migration of content with dependencies also creates the same folder structure on the target server. The imported content replaces any existing resources on the target server.
Prerequisites
This functionality is available only to users with the 
Advanced Reporting – Administer
access right. Migration does not require access to the system where the server is installed.
 
Export Content
You can export individual resources or an entire folder of the repository. 
  1. Log in as CA PPM user with ‘Advanced Reporting – Administer’ access right to the source environment.
  2. Click Home, Personal, Advanced Reporting.
  3. Select View, Repository.
    You can also export resources such as reports, Ad Hoc views, from the Library page.
  4. To select more than one resource, press the Ctrl key. When viewing the repository, you can select an entire folder in the left-panel.
  5. Right-click the selected folder or resources and select Export from the context menu.
    The Export Resources dialog appears:
    The image shows the Export Resources options
  6. (Optional) You can change the default name of the zip file. This dialog allows only the zip archive format.
  7. The export provides the following options:
    Include report jobs
    : When checked, the export includes scheduled report jobs with any reports in your repository selection.
    Include repository permissions
    : When checked, the export includes any explicit permissions on all items in your repository selection. Clear this check box if you want the exported items to inherit the permissions of the target repository.
  8. Click Export. The server generates the zip file and your browser prompts you to save the file. Depending on the size of your repository and the selected options, it might take several minutes to generate the file.
! Resources are exported with their dependencies, even if the dependencies are not included in your selection. The export can be large and might take a long time to generate and then download. During this time, the export operation can affect server performance. For this reason we do not recommend exporting large amounts of data.
 
Import Content
After you export, you can import the exported zip file.
  1. Log in as CA PPM user with the
    Advanced Reporting – Administer
    access right to the target environment.
  2. Click Home, Personal, Advanced Reporting.
  3. Select Manage > Organizations to display the organization.
  4. In the left panel, right-click the target organization to receive the imported content and select Import.
    The Import dialog appears:
    The image shows the Import to Org options
  5. Click Browse to select the zip file to import.
    The dialog allows only the zip archive format. You can import only files created by the export.
  6. The import provides the following options:
    • Update: When checked, the Update option imports only resources that are new to the current organization (different URI).
    • Skip user updates: This option allows you to keep the current definition of any users that also exist in the imported organization, in case the exported zip file includes users.
    • Include themes: When checked, the Include themes option imports any themes that exist in the imported organization.
  7. Click Import. The server uploads the zip file and imports its contents into the organization. If there are any broken dependencies in the catalog, the server displays a message with three choices:
    • Skip: This option does not import the resource with the broken dependency, but continues to import other resources.
    • Include: Attempts to import the resource with the broken dependency. The import succeeds if there is already a resource in the destination that satisfies the dependency. If the dependency is not satisfied in the destination, the resource is skipped and the import continues.
    • Cancel: Stops the import operation.
  8. (Optional) You can import into a different organization. If the source organization has a different ID than the target organization, the import merges the content of the export into the selected organization.
    The following message appears:
    The file being imported contains a top-level organization name that does not match the currently selected organization
    Import file: <source organization ID>
    Selected organizations: <target organization ID>
    Content is merged into <target organization ID>
  9. Click Continue Import to start the import. When merging organizations with the update option, the contents of the import override the target organization for any resource with the same name and location.
Important Note! The import might take a long time to upload and then process. During this time, the import operation can affect server performance. For this reason we do not recommend importing large amount of data.
 
  
View Database Schema Differences
Organization IDs and database schema names in the source environment are typically different from the target environment. You can view information about the organization ID and database schema names.
  1. Log in to 
    Clarity Project and Portfolio Management (PPM)
    .
  2. Navigate to Administration, General Settings, System Options.
  3. View the Advanced Reporting section. 
Update Domain Schema
When resources are imported to a target server where the database schema names are different from the source server, the resources do not work as expected. This behavior occurs when domains are imported, or are included in the import as a dependency. Domains keep references to the database schema from the source server. We recommend you to update the target server domain schema to eliminate any schema mismatch.
Follow these steps:
  1. Log in to CA PPM.
  2. Click Home, Personal, Advanced Reporting.
  3. Select Manage, Update Domain Schema.
  4. Select the Domain Name from the target server that requires an update.
  5. Select the Domain Schema corresponding to the database accessed by the domain:
    • CA PPM Database Schema: Select this option for domains accessing the PPM transactional database.
    • Data Warehouse Database Schema: Select this option for domains accessing the Data Warehouse database. Select this option for all out-of-the-box domains included in the Advanced Reporting Content.
  6. Click Update.
The following animated image shows how to navigate to the Update Domain Schema page and select the Domain Schema:
This illustration shows how to Update Domain Schema.