Template version management

1. Version

2. Application scenarios

• Using the version widget plug-in to create different versions is conducive to the IT department to record work results, save key nodes, facilitate acceptance and iteration, etc., in line with the rapid iteration of agile development principles.

• Multiple styles of fast switching, the same report may have similar requirements for different departments at different time periods, but the specific details are not the same. When reusing the report, you only need to modify the company's special logo to quickly go online.

• Version management supports FineReport's unique remote design function. When the version is saved in the remote design, the operator's account name and the saved time will be recorded. By formulating the principle of version saving, the manager can quickly find the error point and the corresponding responsible person.

• A single template is backed up separately, which is more flexible and faster than engineering-level backup. Users can quickly use the version management function to restore reports to any state.

Note 1: The template version control function does not support the cluster environment.

Note 2: When the user connects to the server for remote design, if the template is being modified or saved at this time, do not directly close the remote server process through the operating system, otherwise the version library file will be damaged and the template version cannot be saved normally.

3. Function introduction

• Version management: When designing and modifying report templates, users need to control the version of the template, perform version rollback, and control the online iteration of the template.

• Historical version: Support to save any number of historical versions for any template file, and each version supports filling in remarks. In remote design, it also supports recording the user who belongs to this historical version.

• Version restore: support for restoring from any historical version. When the template file is accidentally damaged or other unnecessary modifications, it can be restored to the specified historical version through the restore function.

Results as shown below:

In "File>Options>Common", the initial settings of VCS are as shown in the figure below:

1. Save Automatically

Checked by default:  Save Automatically

• When "Save Automatically" is checked, the designer can save the auto-generated version, and at the same time, perform version-related operations, as shown in the following figure:

• If you don't check "Save Automatically", the version function will be turned off, and the version option will be grayed out and inoperable, as shown in the figure below:

2. Every [  ] minutes,every user can save only one file per template

Checked by default:Every [  ] minutes,every user can save only one file per template，Set the time period to 60minutes

• If you check "Every [  ] minutes,every user can save only one file per template", the previous version will be automatically deleted within the specified period, and only the current version will be retained, as shown in the following figure:
  

• If you don’t check the "Every [  ] minutes,every user can save only one file per template", each version will be retained, as shown in the following figure:
  

3. Versions with comment will not be deleted automaticly

Checked by default:Versions with comment will not be deleted automaticly,Under the premise of checking "Every [  ] minutes,every user can save only one file per template":

• Check "Versions with comment will not be deleted automaticly", the version of the setting note will not be deleted, and the rest will remain unchanged, as shown in the following figure:

• Do not check "Versions with comment will not be deleted automaticly", the version of the set remarks will be the same as the version without remarks. For details, please refer to section II-2 of this article.

4. Template versioning storage optimization

1) Functional Overview

Users of JAR packages after 2019-12-05 can use this function, and template version control storage optimization is not checked by default.

• When theTemplate versioning storage optimizationis not checked, the designer cannot periodically optimize the template version control storage, and the "Clean" option is grayed out and cannot be operated, as shown in the following figure:

• When the Template versioning storage optimization is checked, the designer can perform template version control storage optimization in two cases.
  

When the designer starts, it runs once to optimize the template version control storage.

Click the "Clean"button, the template version control storage optimization will be performed immediately after clicking, and the Cleaning prompt box will pop up. After the optimization is completed, it will prompt that the Version file size has been reduced by xxxKB. As shown below:

Note: If the size of the reduced version file is greater than 1024KB, the unit is MB;

          If the size of the reduced version file is greater than 1024*1024KB, the unit is GB, and up to two decimal places are displayed;

          If the file size of the reduced version is 0KB or a negative number, it shows that there is no file to optimize.

2) Precautions

• Remote connection, multiple people can perform template version control and storage optimization at the same time.

  If there are n people performing template version control storage optimization at the same time, then a total of 1 to n optimizations have been performed, which is a normal phenomenon.

• After optimization, the reduced version file size may be a negative number.

  When there are few historical versions, when there is little space for optimization, the reduced version file size may be a negative number, which is a normal phenomenon.

• Remote connection, the JAR package is consistent.

  When connecting remotely, the designer JAR package should be consistent with the remote environment as much as possible, otherwise it may trigger a prompt that the remote server JAR package needs to be updated, and the template version control storage optimization cannot be successfully performed.

• Interrupt cleanup

  After manually clicking Cleanup now, if you close the cleanup progress pop-up window immediately, the optimization task will be cancelled before it is executed, and the optimization will be interrupted directly

• Version upgrade

  For designers whose JAR package time is before 2019-12-05, the historical template version is stored in the %FR_HOME%\webapps\webroot\WEB-INF\vcs directory

  For designers whose JAR package time is after 2019-12-05, the historical template version is stored in the %FR_HOME%\webapps\webroot\WEB-INF\assets\vcs directory

Select "Filter" in the version, and the result of the filter is the intersection of time and remark keywords, as shown in the following figure:

The specified time here is "2020-09-30", and the remark keyword is "test".

Select one of the versions of a template and click the "Edit" button in the upper right corner to add remarks to the currently selected version.

Note: When restoring the version, the currently unsaved template will automatically generate a version, so there is no need to worry about accidental loss of unsaved templates.

Select one of the versions of a template and click the "Delete" button in the upper right corner to delete the currently selected historical version.

If the designer has installed a version control plug-in, version control settings are not allowed, and this plug-in needs to be deleted.

Note: For details on deleting plug-ins, please refer to Designer Plugin management