1. 概述
1.1 版本
报表服务器版本 | 功能变动 |
---|---|
11.0 | - |
11.0.18 | 注册失败提示优化,提供具体失败原因,帮助用户排查问题 |
1.2 应用场景
客户的报表服务器是部署在虚拟机上或者云平台上的,报表服务器的物理信息不固定,这样就没有办法绑定固定的机器信息,所以本地机器信息认证不再适用。
这时,需要找一台物理信息固定的服务器作为授权服务器,然后把授权服务器的机器信息 rif 文件发给商务,生成私有云认证服务器文件FanruanLicenseServer,里面包含一个server.exe文件。
1.3 功能简介
报表服务器物理信息不固定无法进行本地机器认证时,若有一台物理信息固定的服务器,可进行私有云认证。
授权服务器(license Server 端)将这个授权的功能点、授权访问域名、授权访问端口、授权访问应用名、授权访问截止日期等信息返回给报表服务器(Report Server 端)。
报表服务器(Report Server 端)做校验,如果校验通过,就进入正常的访问程序,如果不通过,则作为未授权服务器。如下图所示:
授权服务器程序是指的是提供授权功能的那个服务器程序(需提供物理信息),报表服务器是指运行 FineReport 报表的某台服务器(无需提供物理信息)。
1.4 注意事项
1)私有云认证的授权服务器,需要是一台固定物理信息的机器。报表工程服务器所在机器不需要有固定不变的物理信息。
例如虚拟机环境下物理信息可能变化,造成注册失败,不适合被用作授权服务器。
2)报表服务器即需注册的报表工程所在服务器,需要跟授权服务器网络互通。
3)一个授权服务器不允许运行两个私有云认证程序。
4)认证服务器卸载后,如需再次采用此机器作为授权服务器,需重新生成 MachineInfo.rif 文件发送给商务重新注册。
5)在授权个数允许的范围内,一个授权服务器可以给多个报表服务器授权。
6)集群情况下使用私有云认证,无需每个节点都发送注册信息到商务。
7)报表服务器迁移时,不需要重新申请授权文件。
申请授权时,可指定报表服务器IP范围,而非指定IP。
迁移后,只需保证报表服务器所在的机器和授权服务器的网络可以连通,且新报表服务器IP在申请授权的报表服务器IP范围内即可。
8)Linux 情况下支持 i386、arm 和 amd64 位系统 。
9)不支持通过nat访问私有云。
10)授权服务器运行的认证程序不可关闭超过 24 小时。
若关闭时长小于 24 小时,报表服务器显示注册失败,在 2 小时内将自动重新连接上授权服务器,注册不失效。
若关闭时长超过 24 小时,需重新运行认证程序,报表服务器需要重新进行注册操作。
11)报表服务器会每 2 小时向授权服务器发送一次请求,授权服务器收到请求后以后会反馈给报表服务器。
若连续 12 次(即 24 小时内)收不到反馈,或者授权服务器连续 24 小时没有收到请求,则报表服务器显示注册失败,需重新进行注册操作。
11.0.18 及之后版本,将在「管理系统>注册管理」页面内以列表形式显示每次认证的失败时间和失败原因,帮助用户排查问题,如下图所示:注:集群环境下,每个节点的失败原因可能不同,将显示每个节点的失败原因。
2. 授权服务器为 Windows 系统
2.1 下载 machine 工具
点击下载 machine 工具,用于获取授权服务器信息文件:Windows.zip
将压缩包上传至授权服务器,并解压。
2.2 导出授权服务器信息
以管理员权限运行解压生成的 machine.exe 文件,在同目录下自动生成 require 文件夹。
require 文件夹下的 MachineInfo.rif 文件,即为导出的授权服务器信息文件。如下图所示:
2.3 获取授权文件
支持两种获取方式:
1)自助注册(推荐):通过在线自助注册平台,无需等待,自动即刻生成授权文件进行使用,但不支持FineReport&FineBI集成的工程。
2)商务协助:发送邮件给帆软商务,协助生成授权文件,支持任意帆软工程,但需要耐心等待。
2.3.1 自助注册(推荐)
详情请参见:产品正式注册
1)请提前联系帆软销售,确认相关事项并签署合同,并达成回款要求。
2)请使用指定账号登录帆软通行证,并完成企业认证。
3)请在「服务平台-产品注册」页面,选择对应合同,确认注册功能点,进行自助注册,并获取授权文件FanruanLicenseServer.zip
说明 | |
---|---|
0 准备步骤 | 达成自助注册前提: 1)请提前联系帆软销售,确认相关事项并签署合同 2)请确保达成合同约定的回款要求 3)请使用合同约定的指定账号登录帆软通行证 4)请完成企业认证 |
1 自助注册入口 | 访问「产品注册」页面 |
2 选择合同 | 选择合同,点击「立即注册」 如已注册数达到注册总数,将无法进行在线注册 |
3 功能点确认 | 确认已授权功能点与帆软产品合同中注明的功能点一致 |
4 进行自助注册 | 1)选择注册方式:私有云注册 2)输入项目名称:为便于贵司授权有问题时查询、维护,请输入项目名称,例如:XX公司XX项目、XX地区XX项目 3)上传注册信息:上传上一节获取的MachineInfo.rif文件 4)输入报表服务器IP:即允许被注册的报表服务器的内网IP 支持输入 IP 和 IP 区段,区段中间用英文"-"分隔, IP 网段范围为:1.0.0.0-255.255.255.255 例如:192.168.100.25-192.168.100.26、192.168.0.1 5)输入注册工程数:即集群工程节点个数,单机输入1,不可大于剩余可注册工程数 |
5 完成注册 | 点击「立即注册」,可获取授权文件FanruanLicenseServer.zip,点击下载到本地 |
2.3.2 商务协助
请使用合同中指定的邮箱发送注册信息给 FineReport 商务business@fanruan.com,邮件格式如下:
商务收到邮件,核实无误后会为用户生成FanruanLicenseServer.zip文件,以邮件方式发送给用户。
注:若有任何特殊情况,请在邮件中注明。
清单 | 内容 | 注意事项 | |
---|---|---|---|
优先联系 | 请提前联系帆软销售,确认相关事项并签署合同 | - | |
发件人 | 请使用合同中指定的邮箱 | 如发送注册信息的邮箱,非合同中指定的邮箱,则不予注册 | |
收件人 | business@fanruan.com | - | |
标题 | XXX 公司注册 FineReport 正式授权文件 | 如发送注册信息时,未注明公司名称,则不予注册 | |
正文 | 基础信息 | 公司名称:XXX 公司 项目名称:XXX 项目 合同签定日期:XXXX年XX月XX日 | - |
注册方式 | 私有云认证 | - | |
报表服务器版本 | FineReport11.0 | 如发送注册信息时,未注明版本,则不予注册 | |
报表服务器IP | 哪些报表服务器的 IP允许被注册,为报表服务器的内网 IP 例如:192.168.100.25-192.168.100.26、192.168.0.1 | 如发送注册信息时,未注明报表服务器IP,则不予注册 「报表服务器 IP 网段」范围为:1.0.0.0-255.255.255.255 | |
报表工程名 | 允许授权的工程名,例如:report1、report2 | 若不提供,表示对此项不进行限制 | |
授权服务器域名 | 为授权服务器的域名 不提供则要保证报表服务器可以通过 IP 访问授权服务器 格式:www.baidu.com、www.google.com | - | |
授权服务器公网 IP | 若报表服务器需要通过授权服务器的公网 IP 访问,还需提供授权服务器公网 IP | - | |
授权个数 | 一个授权服务器可以同时给多个报表服务器授权 这里是限制同时注册的报表服务器的个数 | - | |
附件 | MachineInfo.rif | - |
2.4 启动授权服务器
在授权服务器上,解压商务发送的授权文件压缩包 FanruanLicenseServer.zip。
以管理员权限运行 bin 目录下的 server.exe 文件。如下图所示:
注:若启动失败,报错的原因是端口被占用,那么使用命令行启动程序的时候,后面加参数-port 端口指定另外端口。
示例:.server.exe -port 8088
注2:2021-10-13 及之后获取的 server.exe 文件,支持启动认证服务器的时候指定语言,默认简体中文,额外提供英文。
启动命令示例:.server.exe -port 8088 -language en
2.5 设置服务开机自启动
授权服务器上的运行的可执行文件不能关闭,即 Windows下server.exe不能关闭。如果 Server 关掉,重新打开是未注册的,需要重新执行 2.4 节操作。
请用户自行配置\FanruanLicenseServer\bin\server.exe文件开机自启动。
注:设置成功后,服务会开机自启,若需要更换私有云,需要先把之前的停止。
2.6 报表服务器验证授权
报表工程部署在报表服务器上,管理员登录数据决策系统,点击「管理系统>注册信息>版本信息」,点击「立即注册」。
认证方式选择「私有云认证」,服务器地址填写上面授权服务器显示的 IP 和监听端口,例如https://172.16.63.131:8081,点击「提交认证」,如下图所示:
注1:若提供了授权服务器域名,则填写授权服务器域名,若未提供授权服务器域名,则填写 IP 。
注2:请确保报表服务器可以访问授权服务器。
认证成功后,如下图所示:
注1:这里的最大连接数表示同时能有几个工程向授权服务器申请授权注册。
注2:若认证失败,检查防火墙设置,开放对应端口或者关闭防火墙。
3. 授权服务器为 Linux 系统
3.1 下载 machine 工具
点击下载 machine 工具,用于获取授权服务器信息文件:
注:一般情况下,64 位的 Linux 用 amd64,32 位的 Linux 用 i386。
极少情况下(当物理机器使用的是 RISC 精简指令集,低功耗 CPU)才使用 arm,具体跟使用硬件有关。
系统 | 获取服务器信息文件 |
---|---|
Linux_amd64 | |
Linux_arm32 | |
Linux_i386 | |
Linux_arm64 |
3.2 导出授权服务器信息
注:本节操作必须要使用管理员账号进行,否则会导致启动授权程序报错,机器码不匹配。
以 Linux_amd64 为例:
将压缩包上传至授权服务器,解压生成 machine.file 文件:
unzip linux_amd64.zip
为 machine.file 文件添加权限:
chmod 777 machine
运行 machine.file 文件,自动生成授权服务器信息文件,即 require 目录下的 MachineInfo.rif 文件:
./machine
3.3 获取授权文件
支持两种获取方式:
1)自助注册(推荐):通过在线自助注册平台,无需等待,自动即刻生成授权文件进行使用,但不支持FineReport&FineBI集成的工程。
2)商务协助:发送邮件给帆软商务,协助生成授权文件,支持任意帆软工程,但需要耐心等待。
3.3.1 自助注册(推荐)
详情请参见:产品正式注册
1)请提前联系帆软销售,确认相关事项并签署合同,并达成回款要求。
2)请使用指定账号登录帆软通行证,并完成企业认证。
3)请在「服务平台-产品注册」页面,选择对应合同,确认注册功能点,进行自助注册,并获取授权文件FanruanLicenseServer.zip
说明 | |
---|---|
0 准备步骤 | 达成自助注册前提: 1)请提前联系帆软销售,确认相关事项并签署合同 2)请确保达成合同约定的回款要求 3)请使用合同约定的指定账号登录帆软通行证 4)请完成企业认证 |
1 自助注册入口 | 访问「产品注册」页面 |
2 选择合同 | 选择合同,点击「立即注册」 如已注册数达到注册总数,将无法进行在线注册 |
3 功能点确认 | 确认已授权功能点与帆软产品合同中注明的功能点一致 |
4 进行自助注册 | 1)选择注册方式:私有云注册 2)输入项目名称:为便于贵司授权有问题时查询、维护,请输入项目名称,例如:XX公司XX项目、XX地区XX项目 3)上传注册信息:上传上一节获取的MachineInfo.rif文件 4)输入报表服务器IP:即允许被注册的报表服务器的内网IP 支持输入 IP 和 IP 区段,区段中间用英文"-"分隔, IP 网段范围为:1.0.0.0-255.255.255.255 例如:192.168.100.25-192.168.100.26、192.168.0.1 5)输入注册工程数:即集群工程节点个数,单机输入1,不可大于剩余可注册工程数 |
5 完成注册 | 点击「立即注册」,可获取授权文件FanruanLicenseServer.zip,点击下载到本地 |
3.3.2 商务协助
请使用合同中指定的邮箱发送注册信息给 FineReport 商务business@fanruan.com,邮件格式如下:
商务收到邮件,核实无误后会为用户生成FanruanLicenseServer.zip文件,以邮件方式发送给用户。
注:若有任何特殊情况,请在邮件中注明。
清单 | 内容 | 注意事项 | |
---|---|---|---|
优先联系 | 请提前联系帆软销售,确认相关事项并签署合同 | - | |
发件人 | 请使用合同中指定的邮箱 | 如发送注册信息的邮箱,非合同中指定的邮箱,则不予注册 | |
收件人 | business@fanruan.com | - | |
标题 | XXX 公司注册 FineReport 正式授权文件 | 如发送注册信息时,未注明公司名称,则不予注册 | |
正文 | 基础信息 | 公司名称:XXX 公司 项目名称:XXX 项目 合同签定日期:XXXX年XX月XX日 | - |
注册方式 | 私有云认证 | - | |
报表服务器版本 | FineReport11.0 | 如发送注册信息时,未注明版本,则不予注册 | |
报表服务器IP | 哪些报表服务器的 IP允许被注册,为报表服务器的内网 IP 例如:192.168.100.25-192.168.100.26、192.168.0.1 | 如发送注册信息时,未注明报表服务器IP,则不予注册 「报表服务器 IP 网段」范围为:1.0.0.0-255.255.255.255 | |
报表工程名 | 允许授权的工程名,例如:report1、report2 | 若不提供,表示对此项不进行限制 | |
授权服务器域名 | 为授权服务器的域名 不提供则要保证报表服务器可以通过 IP 访问授权服务器 格式:www.baidu.com、www.google.com | - | |
授权服务器公网 IP | 若报表服务器需要通过授权服务器的公网 IP 访问,还需提供授权服务器公网 IP | - | |
授权个数 | 一个授权服务器可以同时给多个报表服务器授权 这里是限制同时注册的报表服务器的个数 | - | |
附件 | MachineInfo.rif | - |
3.4 启动授权服务器
注:如果是工具连接,在使用 nohup ./bin/server &命令行后,使用 exit 退出登录。
重新登录后可使用 ps -ef|grep server 命令查看是否运行在后台,若成功运行则表示私有云后台启动成功,只要服务器不关机则会一直运行 。
1)在授权服务器上,解压商务发送的授权文件压缩包 FanruanLicenseServer.zip
unzip FanruanLicenseServer.zip
2)解压完成后,以管理员权限运行 bin 目录下的 server
nohup ./server &
注:支持启动认证服务器的时候指定语言,默认简体中文,额外提供英文。
启动命令示例:./server -language en
3)启动认证服务器成功,如下图所示:
3.5 报表服务器验证授权
报表工程部署在报表服务器上,管理员登录数据决策系统,点击「管理系统>注册信息>版本信息」,点击「立即注册」。
认证方式选择「私有云认证」,服务器地址填写上面授权服务器显示的 IP 和监听端口,例如https://172.16.63.131:8081,点击「提交认证」,如下图所示:
注1:若提供了授权服务器域名,则填写授权服务器域名,若未提供授权服务器域名,则填写 IP 。
注2:请确保报表服务器可以访问授权服务器。
认证成功后,如下图所示:
注1:这里的最大连接数表示同时能有几个工程向授权服务器申请授权注册。
注2:若认证失败,检查防火墙设置,开放对应端口或者关闭防火墙。
4. 授权服务器为 Mac 系统
4.1 下载 machine 工具
点击下载 machine 工具,用于获取授权服务器信息文件:Mac.zip
4.2 导出授权服务器信息
将压缩包上传至授权服务器,解压生成 machine.file 文件:
unzip Mac.zip
为 machine.file 文件添加权限:
chmod 777 machine
运行 machine.file 文件,自动生成授权服务器信息文件,即 require 目录下的 MachineInfo.rif 文件:
./machine
4.3 获取授权文件
支持两种获取方式:
1)自助注册(推荐):通过在线自助注册平台,无需等待,自动即刻生成授权文件进行使用,但不支持FineReport&FineBI集成的工程。
2)商务协助:发送邮件给帆软商务,协助生成授权文件,支持任意帆软工程,但需要耐心等待。
4.3.1 自助注册(推荐)
详情请参见:产品正式注册
1)请提前联系帆软销售,确认相关事项并签署合同,并达成回款要求。
2)请使用指定账号登录帆软通行证,并完成企业认证。
3)请在「服务平台-产品注册」页面,选择对应合同,确认注册功能点,进行自助注册,并获取授权文件FanruanLicenseServer.zip
说明 | |
---|---|
0 准备步骤 | 达成自助注册前提: 1)请提前联系帆软销售,确认相关事项并签署合同 2)请确保达成合同约定的回款要求 3)请使用合同约定的指定账号登录帆软通行证 4)请完成企业认证 |
1 自助注册入口 | 访问「产品注册」页面 |
2 选择合同 | 选择合同,点击「立即注册」 如已注册数达到注册总数,将无法进行在线注册 |
3 功能点确认 | 确认已授权功能点与帆软产品合同中注明的功能点一致 |
4 进行自助注册 | 1)选择注册方式:私有云注册 2)输入项目名称:为便于贵司授权有问题时查询、维护,请输入项目名称,例如:XX公司XX项目、XX地区XX项目 3)上传注册信息:上传上一节获取的MachineInfo.rif文件 4)输入报表服务器IP:即允许被注册的报表服务器的内网IP 支持输入 IP 和 IP 区段,区段中间用英文"-"分隔, IP 网段范围为:1.0.0.0-255.255.255.255 例如:192.168.100.25-192.168.100.26、192.168.0.1 5)输入注册工程数:即集群工程节点个数,单机输入1,不可大于剩余可注册工程数 |
5 完成注册 | 点击「立即注册」,可获取授权文件FanruanLicenseServer.zip,点击下载到本地 |
4.3.2 商务协助
请使用合同中指定的邮箱发送注册信息给 FineReport 商务business@fanruan.com,邮件格式如下:
商务收到邮件,核实无误后会为用户生成FanruanLicenseServer.zip文件,以邮件方式发送给用户。
注:若有任何特殊情况,请在邮件中注明。
清单 | 内容 | 注意事项 | |
---|---|---|---|
优先联系 | 请提前联系帆软销售,确认相关事项并签署合同 | - | |
发件人 | 请使用合同中指定的邮箱 | 如发送注册信息的邮箱,非合同中指定的邮箱,则不予注册 | |
收件人 | business@fanruan.com | - | |
标题 | XXX 公司注册 FineReport 正式授权文件 | 如发送注册信息时,未注明公司名称,则不予注册 | |
正文 | 基础信息 | 公司名称:XXX 公司 项目名称:XXX 项目 合同签定日期:XXXX年XX月XX日 | - |
注册方式 | 私有云认证 | - | |
报表服务器版本 | FineReport11.0 | 如发送注册信息时,未注明版本,则不予注册 | |
报表服务器IP | 哪些报表服务器的 IP允许被注册,为报表服务器的内网 IP 例如:192.168.100.25-192.168.100.26、192.168.0.1 | 如发送注册信息时,未注明报表服务器IP,则不予注册 「报表服务器 IP 网段」范围为:1.0.0.0-255.255.255.255 | |
报表工程名 | 允许授权的工程名,例如:report1、report2 | 若不提供,表示对此项不进行限制 | |
授权服务器域名 | 为授权服务器的域名 不提供则要保证报表服务器可以通过 IP 访问授权服务器 格式:www.baidu.com、www.google.com | - | |
授权服务器公网 IP | 若报表服务器需要通过授权服务器的公网 IP 访问,还需提供授权服务器公网 IP | - | |
授权个数 | 一个授权服务器可以同时给多个报表服务器授权 这里是限制同时注册的报表服务器的个数 | - | |
附件 | MachineInfo.rif | - |
4.4 启动授权服务器
注:授权服务器上运行的可执行文件不要关闭,即 Mac 下 server 不能关闭。
在授权服务器上,解压商务发送的授权文件压缩包 FanruanLicenseServer.zip。
以管理员权限运行 bin 目录下的 server ,如下图所示:
注:支持启动认证服务器的时候指定语言,默认简体中文,额外提供英文。
启动命令示例:./server -language en
4.5 报表服务器验证授权
报表工程部署在报表服务器上,管理员登录数据决策系统,点击「管理系统>注册信息>版本信息」,点击「立即注册」。
认证方式选择「私有云认证」,服务器地址填写上面授权服务器显示的 IP 和监听端口,例如https://172.16.63.131:8081,点击「提交认证」,如下图所示:
注1:若提供了授权服务器域名,则填写授权服务器域名,若未提供授权服务器域名,则填写 IP 。
注2:请确保报表服务器可以访问授权服务器。
认证成功后,如下图所示:
注1:这里的最大连接数表示同时能有几个工程向授权服务器申请授权注册。
注2:若认证失败,检查防火墙设置,开放对应端口或者关闭防火墙。
5. 注册失败
11.0.18 之前版本,若注册失败,页面将出现提示弹窗:认证失败,请重新认证。
11.0.18 及之后版本,注册失败提示信息优化,若注册失败,页面将弹窗提示具体失败原因,用户可根据提示信息进行排查。
5.1 单机环境注册失败
若注册失败,页面将弹窗提示具体失败原因,点击「详细信息」按钮,即可查看具体失败原因或问题排查方案,如下图所示:
点击「返回」回到注册管理页面,「注册信息」处会显示注册失败和失败原因,点击「查看错误详情」即可查看具体失败原因或问题排查方案,如下图所示:
5.2 集群环境注册失败
若注册失败,不同节点的注册失败原因可能不同,页面将弹窗提示每个节点的具体失败原因,点击「详细信息」按钮,即可查看具体失败原因或问题排查方案,如下图所示:
点击「返回」回到注册管理页面,「注册信息」处会以列表形式显示每个节点的失败原因,点击「查看错误详情」即可查看对应的失败原因或问题排查方案,如下图所示:
5.3 失败原因
注册失败原因汇总如下,用户可根据具体失败原因或错误详情中提示的排查方案进行排查。
注1:除以下外失败原因外,其他统一报错:证书内容不正确。
注2:一次注册过程中有多个失败原因时,仅展示第一次失败的原因。
错误码 | 错误名 | 含义 |
---|---|---|
10000 | JSON_PARSER_ERROR | 数据格式不正确 |
10001 | PARAM_INPUT_ERROR | 您输入的参数有误 |
20000 | DO_NOT_NEED_DEACTIVATE | 该机器未授权无需解除绑定 |
30000 | LICENSE_EXPIRED | 证书已过期 |
30001 | REPORT_VERSION_ERROR | 版本不匹配 |
30002 | ACCOUNT_STATUS_ERROR | 账户状态不正常(解除绑定的时候出现该提示,说明这台机器因未授权无需解除绑定) |
30003 | LICENSE_IP_ERROR | IP 不在允许的范围之内 |
30004 | LICENSE_DOMAIN_ERROR | 域名不在允许的范围之内 |
30005 | LICENSE_APPNAME_ERROR | 应用名不在允许的范围之内 |
30007 | REGISTER_OUT_OF_LIMIT | 已达可授权数量上限 |
- | 工程服务器与云注册服务器连接失败 | - |
6. 迁移授权服务器
6.1 销毁授权
首先,销毁当前认证服务器。以管理员身份进入 bin 目录,再运行。
6.1.1 Windows
在 Windows 中,打开 cmd,切换到 bin 目录下,运行命令如下所示:
.\server.exe -destroy
如下图所示:
6.1.2 Mac 和 Linux
在 Mac 和 Linux中,运行命令如下所示:
./server -destroy
如下图所示:
6.2 获得销毁证据文件
执行销毁命令后,会销毁当前的服务器认证许可,并生成一个销毁信息的证据文件,如下图所示:
注:在 Windows 中,有时候会报错,得在与 bin 同级目录建一个叫 uninstall 的文件夹,卸载文件会在这个文件夹里面出现。
6.3 重新注册
客户通过邮件发送给商务下面两个文件:
receipt.fr 文件和按照申请认证服务器的步骤,重新生成MachineInfo.rif文件。
商务收到receipt.fr文件,验证完成确认销毁后,再给客户发送新的认证服务器文件。
注:销毁授权服务器后,若重启报表服务器则立即注册失败;若未重启报表服务器则在约 24 小时后注册失败。