JasperReports Server allows administrators to import and export resources and users through the user interface:
Exporting from the Repository
Administrators can browse the repository and easily export folders and individual resources from the context menu.
|  | Catalogs may be very large and take a long time to generate and then download. During this time, the export operation may affect server performance. |
To export resources from the repository:
| 1. | Log in as an administrator that has access to the resources you want to export. |
| 2. | Select View > Repository. |
| 3. | Select one or more resources in the main panel, or select a folder in the left-panel. |
| 4. | Right-click the selected folder or resources and select Export from the context menu. The Export Resources dialog appears: |
| Export Resources Dialog in the Repository |
| |
| 5. | If desired, change the default name of the zip file for the exported catalog. |
| • | Use the Server Key if this is a backup that will be imported into the same server at a later time. |
| • | Use the Legacy Key if the catalog will be imported into a different server. |
| • | If you have added custom keys to the keystore on this server, select one from the list that appears: |
| 7. | Choose the export options: |
| • | Include report jobs – When checked, the export includes scheduled report jobs that are associated 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. When this option is cleared, the exported items will inherit the permissions of the repository where they are later imported. |
| • | Include dependencies – When checked, the export includes all dependencies for your resources, even if they are not included in your selected folders. For more information, see Import and Export Catalogs. |
| 8. | 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. |
Exporting from the Settings
For more export options, use the server settings page for administrators. The settings page lets you export the following resources:
| • | Everything – The entire repository, including all resources, as well as all users, roles, and other settings stored internally. With the proper options, this creates a backup of the server. |
| • | Any combination of users and roles – Lets you choose from lists of users and roles, with options to include users by role or roles by user. |
| • | All resources of a given type – For example all reports . |
To export resources from the settings page:
| 1. | Log in as administrator (jasperadmin by default). |
| 2. | Select Manage > Server Settings, then click Export in the left-hand panel. |
| User Interface for Export |
| |
| 3. | If desired, change the default name of the zip file for the exported catalog. |
| • | Use the Server Key if this is a backup that will be imported into the same server at a later time. |
| • | Use the Legacy Key if the catalog will be imported into a different server. |
| • | If you have added custom keys to the keystore on this server, select one from the list that appears: |
| 5. | Use the check boxes and radio buttons to choose the contents of your exported catalog file: |
Select Export Everything (default) to export the entire repository, including all users and roles, and all types of assets. Select the check boxes under Events to Export to include the different types of events in your export catalog.
| 6. | Clear Export Everything to select users and roles or resource types to export. |
| a. | To export users and roles, choose one of the radio buttons, then select individual users and roles from the lists. |
| • | Selected roles and users – Only the roles and users you select explicitly are exported. |
| • | Users with selected roles – Select one or more roles, and all users with those roles are exported, along with the selected roles. |
| • | Roles with selected users – Select one or more users, and all roles assigned to those users are exported, along with the selected users. |
| b. | If you only want users and roles, clear all check boxes under Resources to Export. |
| c. | Or if you only want resources, do not select any users and roles, then select the resource types you want to export. |
| d. | Select the check boxes under Assets to Export to include these various assets in your export catalog. |
| e. | Select the check box under Events to Export to include repository create and modify dates. |
| 7. | Click Export. The server generates the catalog zip file and your browser prompts you to save the file. |
| | Resources are exported along with any dependencies, even if they're not included in your repository selection. For more information, see Import and Export Catalogs. Depending on the size of your repository and the options you've selected, it may take several minutes to generate the catalog file. During this time, the export operation may affect server performance. |
Importing from the Settings
The Settings pages for 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, with no need to restart the server.
To import data from the Settings page:
| 1. | Log in as administrator (jasperadmin by default). |
| 2. | Select Manage > Server Settings and choose Import in the left-hand panel. |
| User Interface for Import |
| |
| 3. | Click Browse to choose the catalog zip file to import. |
| • | Use the Server Key if the catalog was exported from the same server with the server key. |
| • | Use the Legacy Key if the catalog was exported from any server with the legacy key, or if it was exported from any server prior to release 7.5. |
| • | If you have added custom keys to the keystore on this server, select one from the list that appears: |
| • | Use the Key Value and enter a key in hexadecimal notation if you exported with a one-time key (the command-line js-export --genkey option). |
| • | Use the Stored Key and specify its location if you saved the export key in the repository. |
| 5. | 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. |
| • | The Include server settings option determines whether the system configuration is updated from the catalog. There are two prerequisites in order for the catalog to contain configuration settings: |
| • | The catalog must be exported with the “everything” option or the specific Server Settings option. |
When server settings are imported, they take effect immediately and 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.
| | Theme files in catalogs exported from older JasperReports Server versions may not be compatible, and can cause HTML display errors. When you import certain catalogs created in older versions, you may need to uncheck the Include themes option so that the incompatible files aren't imported. If you have a custom theme to import, you can use the web UI to download it from the source server and upload it to the target server. You may need to edit the catalog manually. For example, if your theme contains the file pageSpecific.css, you must remove it from the ZIP file before uploading, and then redo your changes to the file based on the pageSpecific.css file in the target server. For more information, see Downloading and Uploading Theme ZIP Files. |
| | Resources are imported along with any dependencies, unless you do not have permission to write at the dependency's location. Broken dependencies may block the import operation. For more information, see Import and Export Catalogs. Catalogs may be very large and take a long time to upload and then process. During this time, the import operation may affect server performance. |
Recommended Comments
There are no comments to display.