Jump to content
JasperReports Library 7.0 is now available ×
  • This documentation is an older version of JasperReports Server Community Project Administrator Guide. View the latest documentation.

    JasperReports Server allows administrators to import and export resources and users through the user interface:

    Section Actions
    Exporting From the Repository Export entire folders
    Export selected resources
    Exporting From the Settings Export everything
    Export selected users or roles
    Export resources by type
    Importing From the Settings Import any catalog into the server

    Exporting From the Repository

    note-icon-ns_28x28.png.0c01dc1fefc2ecab50d74c404dbd23d7.png

    If you're exporting to a different server, you must configure an encryption key on both servers, as described in Setting the Import-Export Encryption Key.

    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 (non-organization) 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 non-Organization resources in the main panel, or when viewing the repository, 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

    js-Repository-ExportResources.png.af3de033f48925cbad85b0ace78e8c89.png

    5. If desired, change the default name of the zip file for the exported catalog. This dialog allows only the zip archive format.
    6. Choose one or both of the export 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 destination repository.
         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 Dependencies During Import and Export.
    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.

    To export organization resources from the repository:

    1. Log in as an administrator that has access to the organization resources you want to export.
    2. Select View > Repository.
    3. Select a folder under Organization in the left-panel or one or more Organization resources in the main 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

    js-Repository-ExportOrgResources.png.e6b9c23b194182a3ec3c15abcfd2e78a.png

    5. If desired, change the default name of the zip file for the exported catalog. This dialog allows only the zip archive format.
    6. Choose one or both of the export 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 destination repository.
         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 Dependencies During Import and Export.
         Include full resource path – When checked, the export includes the full file structure, starting with the Organizations root folder, for the resource in the ZIP file. If you want to import the resource into another organization, uncheck this box and the export includes only the folders within the parent organization's branch in the ZIP file.
    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.

    Exporting From the Settings

    For more export options, use the server settings page. 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 or all dashboards.

    note-icon-ns_28x28.png.e7fd9ffc6ddf82cbc99af3e7a48579d2.png

    If you're exporting to a different server, you must configure an encryption key on both servers, as described in Setting the Import-Export Encryption Key.

    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

    js-Settings-Export-CP.png.8c12ccdb1927d057fe1d72df84ba3d37.png
    3. If desired, change the default name of the zip file for the exported catalog. This dialog allows only the zip archive format.
    4. 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.

    5. 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 boxes under Events to Export to include the different types of events in your export catalog.
    6. 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.

    note-icon-ns_28x28.png.5bcdabae6c5cfd8578cc240a42113e86.png

    Resources are exported along with any dependencies, even if they're not included in your repository selection. For more information, see Dependencies During Import and Export.

    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.

    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.

    note-icon-ns_28x28.png.e6a85f4b6723bbb8804d7c6fd9b67f5d.png

    If you're importing from a different server, you must configure an encryption key on both servers, as described in Setting the Import-Export Encryption Key. . You'll need to enter the keystore password when prompted by the import operation.

     

    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

    js-Settings-Import-CP.png.def16aa583eb3406336c8470ece411ba.png
    3. Click Browse to choose the catalog zip file to import. The dialog allows only the zip archive format.
    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.
         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 originating server settings must be modified through the UI. Thus, only Log Settings, OLAP Settings, and Cloud Settings are affected. For more information, see Configuration Settings in the User Interface
    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.

    5. Click Import.

    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.

    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 Dependencies During Import and Export.

    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.

    Open topic with navigation


    User Feedback

    Recommended Comments

    There are no comments to display.



    Guest
    This is now closed for further comments

×
×
  • Create New...