新模板版本管理

1.1 版本

1.2 功能简介

11.0.19 及之后版本，新增「新模板版本管理」模式，对版本管理的功能及交互进行了全面优化。本文将对「新模板版本管理」的使用进行介绍。

• 单模板版本管理：支持查看模板的所有历史版本信息，并进行版本管理操作，包括：添加注释、还原、删除/批量删除、预览版本。
  

• 版本中心：展示所有模板版本信息，支持用户查看特定模板的所有版本，以及删除多个模板的所有历史版本，便于管理员全面掌握模板变化并清理旧版本数据。

• 回收站：删除的模板文件会进入回收站内，管理员可查看已删除的模板信息，并支持还原已删除模板的历史版本或彻底删除模板操作。

效果如下图所示：

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 新旧模板版本管理功能对比

新模板版本管理与旧模板版本管理的功能对比如下表所示：

2.2 如何更新至新模板版本管理

1）点击菜单栏中「文件>选项>版本管理」，若用户使用了旧模板版本管理，则会出现版本管理存在更新提示，如下图所示：

2）点击「更新」按钮，在弹窗页面内选择历史版本数据迁移方式，点击「确定」，会出现弹窗提示是否立即进行数据迁移，点击「是」，则立即迁移历史数据至新模板版本管理，如下图所示：

注1：为节省磁盘空间和数据迁移时间，建议选择「保留部分版本」。

注2：迁移会占用服务器资源，且迁移过程中不支持取消迁移，建议在用户使用较少的时间段内进行迁移。

注3：迁移过程为后端运行，管理员可在迁移过程中关闭版本管理界面进行其他工作，同时迁移继续，不受影响。

设置项说明如下：

3）数据迁移完成后，会出现提示数据迁移成功，版本管理已开启新版本，点击「进入新版本」即可，如下图所示：

2.3 注意事项

问题描述：

在数据迁移过程中，因数据迁移失败，导致版本管理更新失败，报错：数据迁移失败原因：磁盘问题

如下图所示：

排查方案：

1）检查报表工程的启动用户是否拥有以下文件夹的读写权限：

• %FR_HOME%\webapps\webroot\WEB-INF

• %FR_HOME%\webapps\webroot\WEB-INF\assets

• %FR_HOME%\webapps\webroot\WEB-INF\reportlets_versions

若未开放读写权限，Linux 系统用户请参考 Linux文件权限配置 配置文件夹权限。

Windows 系统用户请参考以下步骤配置配置文件夹权限。

• 找到对应文件夹，单击鼠标右键，选择「属性>安全>高级」，点击「添加」，如下图所示：
  

• 选择主体后，修改文件夹的基本权限，点击「确定」即可，如下图所示：

2）检查磁盘空间并清理不必要的文件，如工程中是否有过大的日志文件，备份文件等。

磁盘清理请参考：磁盘清理

磁盘扩容请参考：磁盘扩容

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

3.1 版本中心

注1：「版本中心」功能仅超级管理员可见、可用。

注2：「版本中心」界面仅展示有历史版本的模板信息。

管理员可在版本中心内查看模板版本信息，包括：模板路径、最近一次修改日期、版本占用内存。

同时，支持「搜索」、「查看模板版本」、「打开模板」、「删除/批量删除历史版本」操作，如下图所示：

3.1.1 查看版本

点击某模板后的「查看版本」按钮，即可查看该模板的所有历史版本信息，进行版本管理操作，详情请参考本文第四节。

3.1.2 打开模板

点击某模板后的「打开模板」按钮，即可打开该模板，如下图所示：

3.1.3 删除历史版本

点击「删除」按钮，会出现弹窗提示：确定删除XXX的历史版本，点击「确定」即可删除当前模板的所有历史版本，如下图所示：

同时，支持批量删除操作，勾选需要删除历史版本的模板，点击「删除」按钮，会出现弹窗提示：确定删除所选模板的历史版本，点击「确定」即可删除。如下图所示：

3.2 保存自动生成版本

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

1）勾选「保存自动生成版本」时，在设计器中对模板进行「保存」操作时，会自动对模板生成一个新版本。

同时可以进行版本管理操作，如添加注释、还原、删除、预览版本等，如下图所示：

注：每个模板，基于保存操作，生成的版本，最多为5个（不包含老模板管理迁移保留的版本、填写了备注的版本）

      当超过5个时，自动删除最老版本。

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

3.3 每［ ］分钟自动生成一个版本

默认勾选每［ ］分钟自动生成一个版本，时间周期为15分钟

勾选了「每［ ］分钟自动生成一个版本」选项后，当打开并编辑某张模板时，会在设定的时间周期内自动为该模板生成一个新版本，且在下一时间周期内，会删除前一个自动生成的版本，只保留一个最新自动生成的版本。

例如，V20 为上一时间周期内自动生成的新版本，则下一时间周期内，删除了 V20 版本，只保留了最新的自动生成版本 V22，如下图所示：

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

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

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

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

3.5 每隔［ ］自动清理一次，保留最近［ ］的数据

默认勾选该选项，且默认设置为每隔 3 个月自动清理一次，保留最近 3 个月的数据。

若勾选「每隔［ ］自动清理一次，保留最近［ ］的数据」时，在规定周期内自动清理修改日期在保留日期以外的所有模板版本数据。

选中某个模板，点击「版本管理」按钮，即可进入版本管理界面，查看模板的所有历史版本信息，如最近修改日期、用户、注释。

同时，可进行版本管理操作，包括：添加注释、还原、删除/批量删除、预览版本。如下图所示：

4.1 版本编辑

双击某版本后的「注释」栏，即可给该版本添加备注信息，点击「确定」，注释添加完成，如下图所示：

4.2 版本还原

如需将当前模板还原至某个历史版本，点击该版本后的「还原」按钮，会出现弹窗提示：确定还原此版本，点击「确定」即可，如下图所示：

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

4.3 版本删除

如需删除某个历史版本，点击该版本后的「删除」按钮，会出现弹窗提示：确定删除该版本，点击「确定」即可删除该历史版本。如下图所示：

同时，支持批量删除历史版本操作，勾选需要删除的版本，点击「删除」按钮，会出现弹窗提示：确定删除所选的XXX个版本，点击「确定」即可删除。如下图所示：

4.4 版本预览

如需查看某个历史版本效果，点击该版本后的「预览」按钮，即可查看，如下图所示：

注：「回收站」功能仅超级管理员可见、可用。

5.1 回收站内容

删除的模板会进入回收站内，超级管理员可进入「回收站内容」界面，可查看已删除的模板文件信息，包括：模板路径、大小、删除日期、修改日期。

同时，可对回收站内的模板进行还原、彻底删除操作。

5.1.1 还原模板

勾选需要还原的模板，点击「还原」按钮，会出现弹窗提示：确定还原所选的XXX个文件，点击「确定」，如下图所示：

弹窗提示「所选版本还原成功」后，所选模板以及模板的历史版本已被成功还原至原路径下。

注1：删除模板时，会自动为模板生成一个版本，所以还原模板后，可以在版本管理中看到新增了一个版本。

注2：还原成功后，需点击报表管理面板内的「刷新」按钮，才可在原路径下看到被还原的模板。如下图所示：

5.1.2 永久删除模板

勾选需要删除的模板，点击「删除」按钮，会出现弹窗提示：确定删除所选的XXX个文件，点击「确定」，即可永久删除模板文件，如下图所示：

5.2 通用设置

点击「回收站>通用设置」，可设置回收站内模板文件的保存时间，默认30天。如下图所示：

当系统日期 - 某模板删除日期 > 设置的保存天数时，该模板会被彻底删除。