New Template Version Management

Version

Function Description

Added the Version Management module and comprehensively optimized its functions and interaction in FineReport V11.0.19 and later. This document introduces how to use the new template version management function.

• Template version management: allows you to view all historical version information and perform version management operations including adding remarks, restoring, deleting/batch deleting, and previewing versions.

• Version center: displays all template version information and allows users to view all versions of a template and delete all historical versions of multiple templates, making it easier for admins to fully grasp template changes and clean up old version data.

• Recycle bin: includes deleted template files. Admins can view deleted template information and restore the historical versions of deleted templates or permanently deleted templates.

The effect is shown as follows.

New projects from V11.0.19 use the new template version management function by default.

For projects upgraded from versions before 11.0.19 to V11.0.19 and later versions:

• If the vcs folder or historical version information does not exist under the path %FR_HOME%\webapps\webroot\WEB-INF\assets, the new template version management function is used.

• If the vcs folder or historical version information exists under the path %FR_HOME%\webapps\webroot\WEB-INF\assets, the old template version management function is used. You can update and migrate historical version data to the new template version management function.

Comparison of New and Old Template Version Management Functions

The comparison of the new and old template version management functions is shown in the following table.

How to Update to The New Template Version Management Function

1. Choose File > Options > Version Management in the FineReport menu bar. If you use the old template version management function, a prompt appears: Update is available for version management.

2. Click Update, select the historical version data migration method on the pop-up page, and click OK in the pop-up window to migrate the historical data to the new template version management, as shown in the following figure.

Note:

1. To save disk space and data migration time, it is recommended to tick Reserve Part.

2. Migration occupies server resources, and it cannot be canceled during the migration process. It is recommended to perform migration during periods of low user activity.

3. The migration runs in the background. Admins can perform other tasks during the migration (not being affected).

The settings are described as follows.

3. After migration, a prompt appears indicating that the data migration was successful. The new version management has been enabled. Click Enter New Version.

Notes

Problem:

During the migration, the version management update fails because of the data migration failure, with an error prompting that Data Migration Failure Cause: Disk Fault.

Solution:

1. Check if the report project startup user has read and write permissions for the following folders:

• the WEB-INF folder under the path %FR_HOME%\webapps\webroot

• the assets folder under the path %FR_HOME%\webapps\webroot\WEB-INF

• the reportlets_versions folder under the path %FR_HOME%\webapps\webroot\WEB-INF

Windows users can configure folder permissions in following these steps:

• Find the corresponding folder, right-click it, choose Properties > Security > Advanced, and click Add.

• Click Select a principal, modify the basic folder permissions, and click OK.

2. Check the disk space and clean up unnecessary files, such as large log files and backup files in the project.

Choose File > Options > Version Management to go to the version management page. The initial settings are shown in the following figure.

Version Center

Note:

1. The Version Center function is only visible and available to the super admin.

2. Only template information with historical versions is displayed in Version Center.

Admins can view template version information in the version center, including the template path, last modification date, and version memory usage.

Meanwhile, admins can search and view template versions, open templates, and delete/batch delete historical versions.

Viewing Version

Click the view version icon behind a template to view all the historical version information of the template. For details about version management operations, see section "Single Template Version Management".

Opening a Template

Click the open template icon behind a template.

Deleting Historical Version

Click the deletion icon. A prompt window pops up: Sure to delete the historical version of GettingStarted.cpt?. Click OK to delete all historical versions of the current template.

Meanwhile, you can batch delete versions. Select the needed template and click the deletion icon. A prompt window pops up: Sure to delete the historical version of the selected template?. Click OK. 

Save Automatically Generated Version

Save Automatically Generated Version is selected by default.

1. The designer can save automatically generated versions when you select the function. You can also add comments to a template, restore and delete template versions, and preview versions.

2. The version management function is disabled and the version management option is grayed out if you unselect this function.

Every N Minute(s) Auto-Generate One Version

This function is selected by default, with a time interval of 15 minutes.

When you open and edit a template, a new version of the template can be automatically generated within the set time period, if this function is selected. In the next time period, the previous automatically generated version will be deleted, leaving only the latest automatically generated version.

For example, if V20 is a newly generated version in the previous time period, in the next time period, the V20 version is deleted and only the latest automatically generated version V22 is retained.

Every N Minutes, Reserve At Most One Version Per Template for Each User

This function is selected by default, with a time interval of 15 minutes.

1. The previous version will be automatically deleted within the set time period, and only the current version will be retained, if this function is selected.

2. Each version will be kept, if this function is unselected.

Every N Auto-Clear Once, Reserve Latest N Data

This function is selected by default and set to automatically clean every 3 months and retain data from the past 3 months.

All template version data with modification dates outside the retention date will be automatically cleaned within the set period, if this function is selected.

Select a template, click the version management icon to go to the version management page, and view all historical version information of the template, such as the most recent modification date, user, and comments.

Meanwhile, you can add comments and restore, delete/batch delete, and preview versions.

Editing Version

Double-click the Note column behind a version to add comments for the version. Click OK after completion.

Restoring Version

To restore the current template to a historical version, click the restoration icon behind the version. A prompt window pops up: Sure to restore this version?. Click OK, as shown in the following figure.

Note:

When you restore a version, a new version of the currently unsaved template will be automatically generated. There is no need to worry about accidentally losing unsaved templates.

Deleting Version

To delete a version, click the deletion icon behind the version. A prompt window pops up: Sure to delete this version?. Click OK.

Meanwhile, you can batch delete historical versions. Select the needed versions and click the deletion icon. A prompt window pops up: Sure to delete the selected 2 version(s)?. Click OK.

Previewing Version

To view the effect of a historical version, click the preview icon behind the version.

Note:

The Recycle Bin function is only visible and available to the super admin.

Recycle Bin Contents

Deleted templates will be moved to the recycle bin. The super admin can go to the recycle bin page to view information about deleted template files, including template path, size, deletion date, and modification date.

Meanwhile, the super admin can restore and permanently delete templates in the recycle bin.

Restoring a Template

Select the needed templates and click the restoration icon. A prompt window pops up: Sure to restore the selected 2 file(s)?. Click OK.

The selected template and its historical versions are successfully restored to the original path, with a prompt The selected version is restored successfully.

Note:

1. When you delete a template, a version will be automatically generated for the template. Therefore, a new version is added in the version management after you restore the template.

2. After successful restoration, you need to click the refresh icon in the report management panel to view the restored template under its original path.

Permanently Deleting a Template

Select the needed templates and click the deletion icon. A prompt window pops up: Sure to delete the selected 2 file(s)?. Click OK.

Common Setting

Choose Recycle Bin > General Settings to set the default retention time (default value as 30 days) for template files in the recycle bin.

If the system date minus the template deletion date is greater than the number of set saved days, the template will be permanently deleted.