历史版本3 :模板缺失插件检测 返回文档
编辑时间: 内容长度:图片数:目录数: 修改原因:

目录:

1. 概述编辑

1.1 版本

报表服务器版本功能变动
10.0.17新增「插件缺失提示」功能

1.2 应用场景

模板开发中,会出现同一个模板在不同设计器或者工程上打开和预览的情况,如用户在本地设计器上设计好模板后挂载在服务器上、用户在测试工程上设计好模板后挂载在正式工程上、不同用户之间分享模板等。

当打开和预览模板的工程环境发生变化时,经常会出现模板中由插件设计的效果没了的情况。原因为插件依赖工程,不会跟随模板变动,模板移动后,如果新的工程环境下没有安装对应的插件,则对应的插件效果就不会呈现。

10.0.17 及之后的版本,增加了插件缺失提醒的功能,当模板更换工程时,若模板中用到的插件在新的工程下未安装或者启用,则会提醒用户安装或启用,节省用户的排查时间。

1.3 功能介绍

缺失插件提醒功能,会在设计器打开模板时提醒用户;用户预览模板时,也会将提醒信息记录在平台日志中。

  • 设计器打开模板时,确认模板是否有使用当前工程环境未安装的插件,若存在则弹窗提醒用户处理。

  • 数据决策系统中使用模板或者预览模板时,确认模板是否有使用当前工程环境未安装的插件,若存在则报错提示,提示内容显示在数据决策系统「智能运维>平台日志>出错日志」中。

注:9.0 版本的插件、报表块刷新插件、自适应插件、扩展图表、新计算引擎、云端运维、抽数缓存插件不做检测提示,即工程中未安装以上插件,模板中使用了也不会弹窗提示和记录在日志中。

2. 打开模板时提示编辑

2.1 提示功能

2.1.1 本地工程

用户用设计器打开一个模板时,若模板中使用的插件设计器本地工程未安装,则会弹窗提示用户:插件加载失败,模板保存和预览时可能会出错,请安装并启用缺失插件。如下图所示:

弹窗中详细展示了当前工程缺失的插件,用户可点击「忽略」按钮关闭弹窗,自行打开「插件管理」做对应处理或者修改模板;也可点击「一键处理」按钮让设计器自动处理。

点击一键处理」按钮后,设计器会自动安装或者启用缺失的插件并弹窗回执消息。如下图所示:

注:点击「一键处理」按钮后,设计器自动处理的插件仅为模板商城中有的插件。

2.1.2 远程连接

用户远程连接服务器时,用设计器打开模板,若模板中使用的插件当前连接的工程未安装,则会弹窗提示用户:插件加载失败,模板保存和预览时可能会出错,请联系管理员安装并启动缺失插件。如下图所示:

:使用此功能,建议用户将设计器和服务器版本都升级至 10.0.17 。若设计器版本不符合,则不会有此功能;若服务器版本不符合,在决策系统中使用或者预览模板时日志中不会记录。

用户可联系服务器管理员登录数据决策系统,在「管理系统>插件管理」处安装或者启用缺失的插件。

2.2 关闭提示功能

设计器中模板缺失插件提示功能是可以关闭的,用户点击设计器菜单栏「文件>选项>常用」,在「功能设置」处,取消勾选「打开模板提示缺少插件」即可关闭。如下图所示:

3. 报错记录在日志中编辑

注:此功能默认关闭,如需开启,用户可参考 3.1 节开启。

当用户在数据决策系统中使用到模板或者预览模板时,若模板中使用的插件当前工程环境未安装,后台则会报错,报错内容会记录在日志中,管理员登录数据决策系统即可查看。

3.1 开启日志提醒

插件缺失报错记录在日志中的功能默认是关闭的,如需开启,用户可自行配置参数开启。配置方法如下:

用户可通过「fine_conf_entity可视化配置插件」,在平台配置信息 FineDB 的 fine_conf_entity 表中,添加一个参数TemplateIOErrorContextConfig.showTemplateMissingPlugin,参数值 true 为开启, false 为关闭。

如何配置参数详细内容可参考:「fine_conf_entity可视化配置插件」

注:配置此参数,「fine_conf_entity可视化配置插件」需升级至 V1.5 版本。

如下图所示,在「管理系统>系统工具」中添加参数 TemplateIOErrorContextConfig.showTemplateMissingPlugin ,参数值为 true,点击保存后重启工程即开启了日志提醒功能。

3.2 查看报错日志

当用户开启日志提醒功能后,在数据决策系统中使用到模板或者预览模板时,若模板中使用的插件当前工程环境未安装,则会后台报错,记录在 fanruan.log 里,通过平台日志也可查看。平台提示内容为:模板使用插件状态异常,异常插件列表见右侧详情,点击详情即可查看异常插件。

如下图所示,管理员登录「数据决策系统」后,在工程「智能运维>平台日志>出错日志」中查看,显示未安装图片轮播控件插件。