Template Encryption

Version

Function Description

Admins integrate FineReport reports into their products and provide them to end users who can preview FineReport reports but cannot open the templates for designing or modifying.

FineReport offers a report DES encryption function to meet this need. The function is to encrypt templates before they are integrated into the system. If other users want to open the templates for designing or modifying, they need to enter the password. This document introduces how to use the template encryption function.

Note:

For the FineVis Data Visualization plugin of 2.7.0 and later versions, FVS templates can be decrypted and opened normally. For versions earlier than 2.7.0, encrypted FVS templates will appear as blank templates (.cpt) after being opened.

Password Setting

Log in to the decision-making platform as the admin and enter the link http://localhost:8075/webroot/decision/view/report?op=ecp into the browser address bar to navigate to the template encryption page.

Set an encryption password (6-16 characters, supporting letters and numbers).

Template Backup

If you select Template Backup Before Encryption, a path selection box for storing backup files will appear on the homepage, as shown in the following figure.

Note:

1. You must back up templates before encryption.

2. The backed-up templates can only be saved to the report project directory %FR_HOME%\webapps\webroot.

3. All reports within a project will be encrypted together. You cannot encrypt only one template at a time.

Template Encryption

Click OK to encrypt all templates in the project. The message "Encrypted Successfully." will pop up after the encryption is finished.

After the encryption is finished, an encryption.key file will be generated in %FR_Home%\webroot\WEB-INF\resources.

Encryption information is stored in the encryption.key file which cannot be deleted. If you delete the file, all templates in the project will become unusable.

Project Restart

After confirming that the encryption is successful, you need to restart the report project for the encryption to take effect.

Effect Display

When you open a template in the designer, a dialog box for password entering will appear.

Note:

After you enter the correct password, all templates in the project on the local computer will not require you to enter the password again.

Password Modification

If you need to modify the password, you can log in to the decision-making platform as the admin and enter the link http://localhost:8075/webroot/decision/view/report?op=ecp into the browser address bar.

FineReport will read the first template in the reportlets folder of the current project to determine if it is encrypted.

1. If the template is not encrypted, you will be redirected to the template encryption page. For details, see section "Encryption Procedure."

2. If the template is encrypted, you will be redirected to the template re-encryption page. The password setting procedure is consistent with that described in section "Encryption Procedure."

Template Decryption

If you need decryption, you can log in to the decision-making platform as the admin and enter the link http://localhost:8075/webroot/decision/view/report?op=ecp into the browser address bar.

After entering the old password, you need to set the new password to decode and click Start Encryption. Then the message "Template Decryption Success" will pop up after the decryption is finished.

You can access templates without restarting the project.