Migrating TIBCO JasperReports® Server Repository Content Between Two 7.5 Version Server Deployments

General Discussion

TIBCO JasperReports^® Server has an export/import utility to permit seamless migration of its repository contents between different deployments. Those JasperReports^® Server  repositories can be in different release versions and different databases as long as they are on the supported platform list and meet the backward compatibility requirement (for example, 7.2 migrate to 7.5 is OK, but 7.5 to 7.2 migration is not OK). The other hidden requirement is as long as users are using the same default keystore, the migration will work for password encryption in the repository databases.

JasperReports® Server 7.5 deployment impacting reposiotry migration policy

Starting in JasperReports® Server 7.5.0, a server specific keystore is implemented to encrypt the passwords to strengthen repository content security. As a result, users will no longer be able to migrate repository content without an encryption key between two JasperReports® Server 7.5 repositories.

There are several ways to migrate JasperReports® Server 7.5 repository content. One of which is detailed in the following wiki article.

https://community.jaspersoft.com/wiki/encryption-jasperreports-server-75

The information is in the Export/Import section of the article.

The other way for the migration is detailed in TIBCO JasperReports® Server Security Guide Software Release 7.5 document, section 3.2 "Managing Keys for Import and Export".

https://community.jaspersoft.com/documentation/tibco-jasperreports-server-security-guide/v7/managing-keys-import-and-export

Unless users desire to use their own keystore encryption, we recommend to use the second simple approach to meet their migration needs.

Example

To be specific, suppose our users need to import a report unit from their user's development system to a QA system, users will need to run the export from the command line under their JasperReports® Server development deployment buildomatic directory. For a WAR deployment, this is the place where users ran the js-install script to deploy the application, something like

..jasperreports-server-pro-7.5.1-binbuildomatic

Run Export from development server

User will need to point to the repository where the report unit is situated in their development to run the export script with the --uris option. To find the report unit repository location, users can log into JasperReports® Server as a root user (such as superuser) and go to the repository view web flow, locate the report unit, right click on it and get the properties information. The report path is the one users need to use in the export command. To get the development server encryption key, users need to use --genkey option to run the export command. The command line export should look something like:

js-export --uris /organizations/organization_1/myfolder/myreport --output-zip myreport.zip --genkey

Users will get the encryption key from the export output when export is completed successfully, such as:

Secret Key: 0x88 0xba 0x3e 0xba 0xc9 0x40 0x9a 0x9f 0xa0 0xce 0x14 0xaa 0x42 0xaf 0x30 0x9a 

Users need to provide both the exported zip file and this secret key to run import from QA server instance. If users ever need to mail the exported file and the key to someone else and run import at their deployment site, they should preferably send them in two seperate emails.

Run Import from QA server

Users need to use the secret key to run import to get the report unit migrated to their QA system in one of the following two ways:

- From JasperReports® Server Import web UI, users can choose the "Use Key Value" option and simply copy and paste the secret key into the text box and run the import.

- From the command line, users can run import with --input-key option to use the secret key, such as

js-import --input-zip myreport.zip --secret-key 0x88 0xba 0x3e 0xba 0xc9 0x40 0x9a 0x9f 0xa0 0xce 0x14 0xaa 0x42 0xaf 0x30 0x9a

This concludes the discussion on a simple procedure to get your JasperReports® Server repository content  migration between 7.5 and later versions completed successfully.

TTC-20200625-1874894