JasperReports Server provide functionality to import and export resources and users through the user interface:
When importing and exporting through the web interface, remember the following:
|
•
|
If you are importing to a different server, you must configure an encryption key on both servers, as described in Setting the Import-Export Encryption Key. Then you must enter the keystore password when prompted by the import operation. |
|
•
|
Make sure the output location specified for an export is writable to the local user running the app server containing JasperReports Server. |
Exporting From the Repository UI
To export individual resources or an entire folder of the repository:
|
1.
|
Log in as system administrator (superuser by default). |
|
2.
|
Select View > Repository. You can also export reports, Ad Hoc views, dashboards, and OLAP views from the Library page. |
|
3.
|
Locate the resource you want to export. Select one or more resources (using Control- and Shift-click) in the main panel, or when viewing the repository, select a folder in the left-hand panel. |
|
4.
|
Right-click the selected folder or the selected resources and select Export from the context menu. |
The Export Resources dialog appears:
|
5.
|
Specify the name of the zip file for the exported catalog. In order to download the catalog, the dialog supports only the zip archive format. |
|
6.
|
Specify the following options if desired: |
|
•
|
Clear the Include repository permissions box to export resources and folders without permissions. Upon import, the folders and resources will inherit the permissions of the destination repository. By default, this box is checked. |
|
•
|
Check Include report jobs if you want to include scheduled report jobs with any reports included in the selection. |
|
7.
|
Click Export. The server generates the catalog zip file and your browser prompts you to save the file. Depending on the size of your repository and the options you’ve selected, it may take several minutes to generate the catalog file. |
|
|
Resources are exported along with any dependencies, even if they are not located in the selected folders. For more information, see Import and Export Catalogs.
|
Exporting From the Settings UI
To export users and roles in addition to, or instead of, repository contents, use the server settings pages for system administrators. This page offers more options than the contextual export from the repository UI.
To export data through the web UI:
|
1.
|
Log in as system administrator (superuser by default). |
|
2.
|
Select Manage > Server Settings and choose Export in the left-hand panel. |
|
3.
|
Specify the name of the zip file for the exported catalog. |
The web UI supports only the zip archive format.
|
4.
|
Use the check boxes and multi-select lists to choose the contents of your exported catalog file: |
|
a.
|
Check Export Everything to export the entire repository, including permissions and report jobs, as well as all organizations, users, and roles. Check the box for Include access events if you want to include resource modification times. |
|
b.
|
Clear the box for Export Everything and select only users and roles to export. |
If you cleared the box for Export Everything, you must specify users and roles to export.
The User and Role Selection radio buttons control the way you select the users and roles to export. You can directly select users and roles to export, or you can select them indirectly. For example, if you click the Export users with selected roles radio button, you can select users to export; the server also exports the roles assigned to the users you selected.
|
5.
|
To select specific users and roles: |
|
a.
|
Select Export individually selected roles and users. |
The Select users and Select roles lists become active.
|
b.
|
Select the users and roles to export. |
|
a.
|
Select Export users with selected roles. |
|
b.
|
Select the roles to export. The server will also export the users that are assigned those roles. |
The users assigned the roles you selected are highlighted.
|
a.
|
Select Export roles assigned to selected users. |
|
b.
|
Select the users to export. Their roles will also be exported. |
The roles assigned the users you selected are highlighted.
|
8.
|
In commercial editions of JasperReports Server, you can check Include audit events and Include monitoring events as needed. |
|
9.
|
Click Export. The server generates the catalog zip file and your browser prompts you to save the file. Depending on the size of your repository and the options you’ve selected, it may take several minutes to generate the catalog file. |
|
|
User passwords are encrypted in the server’s internal database, but not in exported catalogs. Take appropriate measures to secure the catalog file from unauthorized access if you export users.
|
Importing From the Settings UI
The Settings pages for system administrators include a user interface to simplify the import procedure.
This import operates on a running instance of the server, and all imported resources are visible immediately. In addition, any configuration or security settings in the imported catalog take effect immediately, without requiring you to restart the server.
As of JasperReports Server 5.5, all exports contain encrypted passwords and if you are importing to a different server, you must configure an encryption key on both servers. See Setting the Import-Export Encryption Key for details.
To import data through the web UI:
|
1.
|
Log in as system administrator (superuser by default). |
|
2.
|
Select Manage > Server Settings and choose Import in the left-hand panel. |
|
3.
|
Click Browse to choose the catalog zip file to import. The web UI supports only the zip archive format. You can import any catalog zip file created by the export UI or the command-line export utility. |
|
4.
|
Use the check boxes to change the behavior of the import operation: |
|
•
|
When checked, the Update option will import only resources that are newer than ones with the same URI in the current repository. The Skip user updates option allows you to keep the current definition of any users that also exist in the imported catalog. |
|
•
|
When checked, the Include access events option imports the modification times of resources from the catalog. When cleared, resources keep their existing access times if they already exist. |
|
•
|
In commercial editions of JasperReports Library, the Include audit events and Include monitoring events determine whether access and monitoring events from the catalog, if any, are imported. |
|
•
|
The Include server settings option determines whether the system configuration is updated from the catalog. There are two pre-requisites in order for the catalog to contain configuration settings: |
|
•
|
The originating server settings must be modified through the UI. Thus, only Log Settings, Ad Hoc Settings, AWS Settings, and OLAP Settings are affected. For more information, see Configuration Settings in the User Interface |
|
•
|
The catalog must be exported with the “everything” option from the user interface or the command-line utility. |
When server settings are imported, they take effect immediately and they appear in the Settings UI.
The server uploads the catalog zip file and imports its contents into the repository. Depending on the size of the catalog and the options you’ve selected, it may take several minutes to perform the import.
