模板版本管理

1.1 版本

1.2 应用场景

• 使用版本控制插件创建不同的版本有利于 IT 部门记录工作成果，保存关键节点，方便验收迭代等等，符合快速迭代的敏捷开发原则。

• 多种风格的快速切换，同一份报表在不同时间段对于不同的部门而言，可能需求类似，但是具体的细节不尽相同。重复使用的报表时，仅需要对企业特殊标志进行修改即可以快速上线。

• 版本管理支持 FineReport 特色的远程设计功能，远程设计保存版本时将会记录下操作人的账户名称和保存的时间，管理人员通过制定版本保存的原则，可以快速找到出错点和对应的责任人。

• 单个模板单独备份，相对于工程级别的备份更加灵活快速，用户可以快速使用版本管理功能，将报表还原到任意状态。

注1：模板版本控制功能不支持集群环境。

注2：模板版本控制功能支持 FVS 插件 V1.15.1 及之后版本，但要求设计器版本为 11.0.17 及之后版本。

注3：用户连接服务器远程设计时，若此时正在修改或保存模板，请勿通过操作系统直接关闭远程服务器进程，否则会导致版本库文件损坏，无法正常保存模板版本。

1.3 功能介绍

• 版本管理：用户在设计、修改报表模板时需要控制模板的版本，进行版本的回退，控制模板的上线迭代。

• 历史版本：支持对任意模板文件保存任意多个历史版本，每个版本均支持填写备注说明。在远程设计时，还支持记录此历史版本的所属用户。

• 版本还原：支持对从任意历史版本还原。当模板文件出现意外损坏或者其他非必要修改时，可以通过还原功能还原到指定的历史版本。

效果如下图所示：

1.4 使用说明

11.0.19 及之后版本的新工程，默认使用新模板版本管理，详情请参考：新模板版本管理 。

从11.0.19 之前版本升级至11.0.19 及之后版本的工程：

• 若工程%FR_HOME%\webapps\webroot\WEB-INF\assets路径下不存在vcs文件夹或历史版本信息，则使用新模板版本管理。

• 若工程%FR_HOME%\webapps\webroot\WEB-INF\assets文件夹下存在vcs文件夹或历史版本信息，则使用旧模板版本管理，且出现弹窗提示：版本管理存在更新，如下图所示：
  注：支持从旧模板版本管理更新、并迁移历史版本数据至新模板版本管理，操作步骤请参考：新模板版本管理 

点击菜单栏「文件>选项>版本管理」，进入「版本管理」界面，初始设置如下图所示：

2.1 保存自动生成版本

默认勾选：保存自动生成版本

1）勾选「保存自动生成版本」时，设计器可保存自动生成的版本，同时可以进行版本的相关操作，如下图所示：

2）不勾选「保存自动生成版本」时，则关闭版本功能，版本选项灰化不可操作，如下图所示：

2.2 每［ ］分钟每个用户同个模板最多保留一个版本

默认勾选每［ ］分钟每个用户同个模板最多保留一个版本，设定时间周期为 60 分钟

1）勾选「每［ ］分钟每个用户同个模板最多保留一个版本」时，在规定周期内自动删除前一个版本，只保留当前版本，如下图所示：

2）不勾选「每［ ］分钟每个用户同个模板最多保留一个版本」，则每个版本都会保留，如下图所示：

2.3 设置了备注的版本不会被自动清理

默认勾选设置备注的版本不会被自动清理，在勾选「每［ ］分钟每个用户同个模板最多保留一个版本」的前提下：

1）勾选「设置备注的版本不会被自动清理」，则设置备注的版本不会被删除，其余不变，如下图所示：

2）不勾选「设置备注的版本不会被自动清理」，则设置备注的版本与无备注的版本一致。详细请参见本文 2.2 节。

2.4 模板版本控制存储优化

2.4.1 功能概述

1. 不勾选模板版本控制存储优化时，设计器不可定期对模板版本控制存储进行优化，「立即清理」选项灰化不可操作，如下图所示：

2. 勾选模板版本控制存储优化时，设计器有两种情况下可进行模板版本控制存储优化。

• 设计器启动时，运行一次对模板版本控制存储的优化。

• 点击「立即清理」按钮，点击后立即进行模板版本控制存储优化，并弹出正在优化进度提示框，优化完成后提示已减小版本文件大小xxxKB。如下图所示：

 注：如果减小版本文件大小大于 1024KB，则单位为 MB；

        如果减小版本文件大小大于 1024*1024KB，则单位为 GB，最多显示两位小数；

        如果减小版本文件大小为 0KB 或者为负数，则显示无可优化文件。

2.4.2 注意事项

1）远程连接，多人可以同时进行模板版本控制存储优化

如果有 n 个人同时执行模板版本控制存储优化，那么一共执行了 1～n 次优化，属于正常现象。

2）优化后减小版本文件大小可能为负数

当历史版本很少的时候，即可优化空间很少的时候，减小版本文件大小可能为负数，属于正常现象。

3）远程连接，JAR 包保持一致

远程连接时，设计器 JAR 包应尽量与远程环境保持一致，否则有可能触发需要更新远程服务器 JAR 包的提示，无法成功进行模板版本控制存储优化。

4）中断清理

手动点击立即清理后，如果立即关闭清理进度弹窗，优化任务尚未执行便被取消，优化将直接中断。

5）版本升级

历史模板版本存储在%FR_HOME%\webapps\webroot\WEB-INF\assets\vcs目录下。

在版本里选择「筛选」，筛选的结果取时间和备注关键词的交集，如下图所示：

此处指定时间为「2019-5-17」，备注关键词为「测试」。

选中某个模板的其中一个版本，点击右上角「编辑」按钮，可以给当前选中的版本添加备注信息。

选中某个模板的其中一个版本，点击右上角「还原」按钮，会出现弹窗提示：是否还原此版本，选择是可将当前模板还原到此版本，如下图所示：

注：还原版本的时候，会将目前没保存的模板自动生成一个版本，所以无需担心未保存模板意外丢失的问题。

选中某个模板的其中一个版本，点击右上角「删除」按钮，会出现弹窗提示：确定删除所选版本，选择是可删除当前选中的这个历史版本。如下图所示：

若设计器安装了版本控制插件，则不允许进行版本控制设置，需删除此插件，如下图所示：

注：删除插件详情请参见  设计器插件管理