1. 概述编辑
1.1 版本
报表服务器版本 | JAR包版本 |
---|---|
10.0 | 2019-12-05 |
1.2 应用场景
企业职工人数是相当多的,并且由于人员的流动性,用户信息一直在变化,如果每次都通过手动添加修改,工作量将会非常大。FineReport 用户同步数据集功能可以实现动态更新平台中的用户信息,使之随着数据库中的用户信息一起变化。
1.3 功能介绍
平台提供了
功能将已有的用户信息直接导入到决策系统中,并且与数据库中数据保持一致。注:不同于 手动添加用户 的方式,开启了数据集同步后,用户信息将跟随数据集同步,动态改变、实时更新,即若数据库信息改变后,决策系统中的用户信息也会随之改变。
2. 操作步骤编辑
2.1 定义用户服务器数据集
设计器菜单栏点击服务器>服务器数据集,可以通过数据库查询语句定义用户信息的服务器数据集。新建服务器数据集详情参见:服务器数据集
设计器默认有一个服务器数据集「用户信息表」,该表中包含了用户名、部门、职务、邮箱等信息。下面的步骤我们将以这个服务器数据集为例进行说明。
2.2 开启数据集同步
1)进入决策系统,选择管理系统>用户管理>所有用户,点击同步用户按钮。
注:「同步用户」功能点旁边的两个选项,「添加用户」和「导入用户」都是手动添加用户信息的方式,详情参见文档:手动添加用户。
2)弹出用户更新提示框。
选择仅更新现有用户基本信息,不改变权限等设置。
如果现有用户不在数据集中,该用户会被删除。
如果现有用户也在数据集中(用户名相同),该用户对应的 ID 不变,权限也都保留。
与数据集中不相同的「部门-职位」信息会被全部删除。
选择清空现有用户信息,重新写入
现有用户、用户权限、部门职位、等都会被删除。
然后重新添加新用户。
注:这两种方式在切换同步数据集时,都不会删除角色信息。
2.3 配置同步数据集
以上述第一种用户更新设置的方式为例,点击确定后,打开同步用户对话框,如下图所示配置同步数据集信息。
同步频率:同步服务器数据集的间隔时间,默认为43200秒。
注:同步频率不宜过高,否则会导致后台日志不断刷新,日志体积无限膨胀。
服务器数据集:选择用户信息对应的服务器数据集。
用户\部门\职务\角色重复验证字段:有两种字段信息重复验证方式,第一种根据名称验证是否重复,第二种根据 ID (数据库中会自动生成 ID)验证是否重复。
注:配置 ID 项后会直接使用客户提供的 ID 项作为我们的 FineDB 中的 ID,如果下次同步时用户名称发生改变,那么他的权限等还会保留。部门职位,角色同理。
用户名、姓名、密码、部门名称、职务名称、角色名称、手机、邮箱:对应数据集中的字段名称。
加密方式:有两种加密方式,内置 SHA 加密和自定义密码加密。
自定义密码加密,即自定义一个密码加密类,加密方式在类中描述,并保存在%FR_Home%\webapps\webroot\WEB-INF\classes文件夹中。自定义加密示例详情参见:简单权限之密码加密。
注1:自定义加密算法,不管该算法的具体方式是什么,都必须继承 FineReport 的 AbstractPasswordEncode 类,并加上返回判断明文密码和密文密码是否一致结果方法才可行。
注2:FineReport10.0 之前版本 MD5 加密算法生成的密码强度不够,容易被攻破,故 FineReport10.0 在 MD5 加密算法的基础上采用 SHA256 二次加密。用户从旧版本升级到 FineReport10.0 时升级工具会自动把旧密码再经过一次 SHA256 加密,以保证密码安全,如果有用户通过接口自定义修改密码,则同样需要在 MD5 加密基础上,再进行一次 SHA256 加密。
2.4 同步结果面板
同步用户对话框设置完毕后,点击确定,会显示同步结果面板。
1)同步用户个数:同步 n 个用户。
2)平台用户总人数:xxx 。
3)已删除的「其他来源数据」:
如若现有用户不在数据集中,则会被删除,此面板中依据用户,部门职位,角色三个纬度以表格形式显示被删除的异源数据。
4)同步失败的出错数据
配置了ID列后会进行一些ID校验以防入库时冲突。此时出错的数据也会列在结果面板中。下面罗列报错情况。
ID 为空
报错信息如下图所示:
勾选了 id 后,不允许出现 name 不为空,但是 id 为空的情况。
与原有 ID 冲突
报错信息如下图所示:
勾选 ID 之后更改用户名,但是不允许更改 ID,否则会报 ID 冲突的错误,比如原本 Alice 的 id 为3,现在变动成2。
ID 与其他对象重复
如上图,多个用户名使用了一个id时报错。
4.对应多个 ID
报错信息如下图所示:
如上图,当一个用户名却有多个 id 时报此错。
2.5 同步效果
同步完成后,同步用户管理按钮处,会新增两个下拉选项,如下图所示。
立即同步:点击后立即进行一次用户数据集同步。
编辑:打开同步用户对话框,可以对同步数据集进行设置。
3. 错误码解释 编辑
1)名词解释
部门标记:构建树数据集时选择的原始标记字段。
父部门标记:构建树数据集时选择的父标记字段。
2)树数据集构建失败
当同步数据集为树数据集时,往往会因为树数据集构建问题导致同步失败,下面列举各种情况:
错误码:21300055
树数据集下,多个部门都用了一个部门标记,比如上图中 DEC 交互,报表的 did 都为 a12。
错误码:21300056
一个部门有多个父部门标记,比如上图中报表的 pid 有 a1,a2。
错误码:21300057
如果父部门标记为空,那么此部门就是根部门,如果不为空,且父部门标记找不到对应的部门,则报错。如上图中决策平台的 pid 为 a3,但是没有任何部门的 did 为 a3,也即没有该父部门。
错误码:21300058
如果部门名相同,且父部门标记相同,那么说明这就是同一个部门,如果他们的部门标记不同,则报错,如上图中报表的 did 有两个:a13,a12。
错误码:21300059
如果部门111的父标记指向部门11,部门11的父标记指向部门1,部门1的父标记又指向部门111,构成了环,则报错。
如上图中帆软软件的父标记为a111,指向 DEC 研发,决策平台的 pid 为 a1,指向帆软软件,DEC 研发的 pid 为 a11,指向决策平台。
3)ID校验失败
树数据集情况下,如果还勾选了部门 id,且部门 id 列并非部门标记列,还会做 id 校验工作,会导致全局失败。以下所有示例中部门标记列为 did,父部门标记列为 pid,部门 id 列为 depId。
错误码:21300054
如果部门标记为纯数字,比如11,111,会直接作为 id 项插入到 finedb 的部门表中,此时如果平台又勾选了其他列作为部门 id,且部门标记值和勾选的部门 id 不一样,则报错。建议当数据源当部门标记为纯数字时,使用 sql 语句的字符串拼接一个英文字母。
错误码:21300053
树数据集情况下,勾选部门 id 后如果部门 id 为空,则直接全局报错。
错误码:21300051
帆软软件-报表,与帆软软件-决策平台使用了相同的部门 id。
错误码:21300050
当部门存在多个部门 id 时会报此错,如上图中帆软软件-报表有 a12,a15 两个部门 id。
错误码:21300052
部门 id 发生改变了,会报错与原有部门 id 冲突。