1. 概述
1.1 版本
FineBI版本 | 插件版本 |
---|---|
6.0 | V1.0.0 |
1.2 应用场景
1)在企业管理中,帆软相关的资源(文件、配置、数据)是分离的。在资源上线正式环境的过程中,由于没有预先按照实际的业务进行资源划分,不利于从业务视角对各业务模块资源进行统一管理;
2)在实际业务中,传统的资源转产和备份恢复的流程与方式,在可靠性和便捷性上无法完全满足客户需求;
3)客户有多个环境(如测试环境、生产环境等),有资源上线生产环境的规范性管理要求
版本管理插件提供“模块”的概念,对应客户的实际业务划分(如销售、生产、人事等)或者不同项目,协助客户建立业务资源管理体系;同时,提供模块资源新建—授权—创建—上传—审批—发布的全套流程,帮助客户规范化资源上线的流程。整个流程由开发人员和系统管理员合作完成,提升操作的便捷性与资源上线的效率
资源划分如下(举例):
整体操作流程如下图所示:
1.3 功能描述
功能 | 简介 |
---|---|
全局配置 | 分为默认授信、永久授信和在线迁移三种方式; 授信为系统管理员在正式环境中,为特定的开发人员发放凭证,使其拥有资源包创建的权限; 在线迁移方式,可实现在两个网络互通的环境,完成资源的迁移 |
模块管理 | 系统管理员在正式环境中,通过新增模块,选择开发人员可以进行更新的资源的方式,完成业务模块划分和资源权限记录 |
资源包创建 | 开发人员在开发环境中,通过提供的网址,选择需要更新的资源,进行打包 |
资源包上传 | 开发人员在开发环境中,通过提供的网址,将生成的压缩包,上传到正式环境 |
审批 | 系统管理员在正式环境中,对开发人员上传的资源,进行审核,确定是否通过 |
任务管理 | 系统管理员在正式环境中,通过新建任务的方式,进行资源更新 |
版本详情 | 系统管理员可在正式环境中,查看更新的模块版本信息 |
2. 插件介绍
2.1 插件安装
获取插件:扫码添加工作人员获取安装包
设计器插件安装方法参照:设计器插件管理
服务器安装插件方法参照:服务器插件管理
2.2 操作方法
插件安装成功后,管理员登录数据决策系统,点击「管理系统>版本管理」,即可进入功能界面,如下图所示:
3.全局配置
在全局配置中,提供3种迁移方式,如下表所示。资源包上传地址均为:http://ip:port/webName/decision/version/management/pack/upload/
page,标红部分需要根据正式环境环境的工程信息进行调整
迁移方式 | 说明 | 其他 | 资源包创建地址 |
---|---|---|---|
默认授信 | 通过系统生成的凭证(可设置有效期)和邮箱两个参数,进行鉴权,以保证后续做资源包上传的开发人员,是被授权的、可接收到邮件的人员 | 每次资源迁移,均需发送邮件,获取凭证,保障每次操作的安全性,才可进行后续的步骤 | http://ip:port/webName/decision/version/management/pack/page/create 标红部分需要根据具体开发环境的工程信息进行调整 |
永久授信 | 通过系统生成的永久凭证信息,进行鉴权 | 每次资源迁移,均使用该永久凭证,无需每次发送邮件 | http://ip:port/webName/decision/version/management/pack/page/create?creditType=permanentCredit |
在线迁移 | 通过系统生成的客户端Id和secret两个参数,进行鉴权 | 面向在两个网络互通的环境的场景,提供一种更便捷的方式,进行资源迁移 | http://ip:port/webName/decision/version/management/online/page/create |
4.默认授信
在全局配置中,选择默认授信后,配置页面如图所示,tab页中会出现“授信”标签
4.1 模块管理
管理员可以在模块管理中,实现模块的增删改,以及查看模块的详细信息
4.1.1 新增模块
管理员可根据企业实际的业务场景,进行模块的新增。新增模块可以设置模块名称和模块说明,模块名称不能为空,模块说明可以为空。此处新增一个“人事”模块
模块基本信息如图:
其中模块信息和模块说明可以进行修改,当前版本、最新版本和最新记录,在所有操作完成后,会显示具体信息。
当前支持的资源列表如下:
支持资源 | 模板、图表预定义样式、服务器数据集、平台目录、自定义函数、全局参数、服务器控件、 目录权限、用户管理、平台全局配置、数据连接、预定义样式、插件、FineBI仪表板(我的分析)、FineBI数据集(公共数据) |
支持对于资源的新增和删除。此处的资源,是正式环境下,工程现有的各类型所有资源。
比如此处新增一个FineBI数据集“FRDemo_销量”,意思是:在本次的操作中,管理员预先给定了限制,后续开发人员只能针对数据集“FRDemo_销量”进行更新。但此处并不是强制限制,开发人员仍可以针对其他资源进行更新,如在资源包创建步骤中,选择更新数据集“FRDemo_销售额”。只是在后续的审批阶段,管理员可以查看到开始时,自己给定限制的资源(数据集“FRDemo_销量”),来确定开发人员是否按照要求,只进行了限制资源的更新操作,从而来判断是否通过审批(这个场景下,开发人员就没有按照限制的要求,而是更新了模板数据集“FRDemo_销售额”)。此处可理解为记录初始设置,用于后续审批阶段的对照,但并非强制限制开发人员操作
4.1.2 删除模块
支持对于模块的删除操作
4.1.3 注意事项
一个资源只能属于一个模块,如果添加重复,会有报错提示
4.2 授信
管理员可以在授信中,通过为特定开发人员的邮箱中发送凭证的方式,授予其进行资源更新的权限。此处也可以管理历史授信记录(增、删、改、查)
4.2.1 新增授信
点击增加授信,进行编辑
需编辑信息的含义:
模块:选择要进行资源更新的模块,生成的凭证会包含该模块的相关信息。不能为空,此处选择之前新增的“人事”模块
邮箱:绑定接收授信凭证的开发人员邮箱,不能为空
开始IP&结束IP:限制后续资源包上传阶段,可进行上传操作的机器
截止时间:授信有效截止时间
是否可用:这条授信是否可用
4.2.2 编辑授信
对已有的授信记录进行更改、批量删除、单独删除等操作
4.2.3 发送授信
在可用并且在有效时间内的授信记录,可以点击发放凭证
点击发送之后,会将生成的凭证发送到绑定的开发人员邮箱中
开发人员可以通过访问获取凭证地址,获取对应的凭证(其中data后引号内的内容就是生成的凭证)
该地址只能访问一次,多次访问会失效,无需登录即可访问
4.2.4 查询授信
如果有多条授信记录,可以通过时间、模块、邮箱、是否可用等筛选信息,快速查询到所需的授信记录
4.3 资源包创建
开发人员收到版本管理凭证邮件后,即可以进行资源包的创建。开发环境的帆软工程也需要安装版本管理插件
4.3.1 登录验证
访问资源包创建地址:http://ip:port/webName/decision/version/management/pack/page/create。该地址需要登录才能访问,并且需要有版本管理节点权限的开发人员才可以创建成功
输入邮箱地址和收到的凭证
点击确定,会校验凭证和邮箱是否匹配;校验成功后,会跳转到资源包选择资源界面
左边的模块列表中,显示授信时选定的,绑定到凭证中的模块。此处为“人事”
选中左边模块列表中的模块,右边可编辑该资源包中所包含的模块信息,如版本号、更新说明、以及更新的资源
4.3.2 资源更新方式
资源更新方式有两种,分别是新增更新和删除更新:
新增更新:将开发环境中的新资源更新到正式环境;
删除更新:开发环境与正式环境中有相同名称的资源,通过此种方式,删除正式环境中的相应资源
此处选择的是新增更新
4.3.3 点击创建
资源选择完成后,此处选择新增“门店商品销售额”主题,点击右上角的创建,生成资源包
创建要求:
每个模块版本号必填
资源只能在一个模块里面进行一种更新
点击创建按钮后,如果不符合创建要求,会给出相应的提示;如果符合创建要求,则会自行下载一个.zip的压缩文件
4.4 资源包上传
生成资源包后,可以访问服务器资源包上传地址,进行上传
4.4.1 资源包上传
资源包上传访问地址为:http://ip:port/webName/decision/version/management/pack/upload/page
注:标红部分需要根据正式环境的工程信息进行调整(该地址可在版本管理凭证邮件中直接复制)该地址在不登录的情况下就能访问。
点击打开,解析成功后,会显示当前资源包包含的模块,以及模块包含的信息(版本号、更新说明、资源更新内容),页面和资源包创建页面样式一样,只是无法编辑。检查信息更新无误后,点击右上角的确定上传,自行输入资源包名称
点击确定后,会对资源包进行校验,校验内容如下:
资源包的名称必须唯一,且不能为空
资源包的凭证有效性
凭证只能用一次,只要上传成功一次,那么该凭证就会失效;用该凭证生成的其他资源包都无法上传
生成凭证的授信记录是否为可用状态
每个模块的版本号是否合理(必须要大于当前模块的最大版本号)
上传资源包机器的ip是否在对应授信的授权ip范围内
校验无误后,资源包上传成功,生成该资源包的凭证就会失效了
4.5 审批
开发人员上传的资源包,需经过管理员的审核后,才能进行后续的资源更新
4.5.1 审批页面信息
左侧显示资源包的列表,支持根据资源包状态和资源包的名称的模糊查询。
右侧显示资源包的详细信息,包括提交IP、提交邮箱、提交时间、状态、审批说明、资源包的更新信息等
4.5.2 检测模块资源变动
4.5.3 审核是否通过
管理员查看资源包的更新信息后,可以选择审核通过或者不通过。无论是通过还是不通过都需要填写审核说明
4.6 任务管理
资源包审核通过后,管理员可通过新建任务的方式,进行资源更新
4.6.1 新建任务
说明:
任务名称:必填,唯一不能重复
执行方式:立即执行、定时执行
执行时间:定时执行状态下,设置执行时间
通知人员:任务执行结果的通知人员
通知方式:通知执行结果的方式,当前支持系统消息通知、邮件通知、短信通知,3种通知方式
模块更新列表:用于添加当前任务需要更新资源的模块
可通过新增模块和选择资源包两种方式,选择想要进行更新的模块;
更新类型有发布和回滚两种方式:发布的话只可以选择比当前版本号大的版本,回滚的话只可以选择比当前版本号小的版本;
点击确定后,任务执行成功
4.6.2 查询任务
可以通过不同维度查询历史任务,点击详情按钮可以看到任务详情,支持对于任务进行复制操作
4.7 版本详情
管理员可在版本详情中查看,更新模块的版本信息
左边选择【模块,版本号】,右边展示具体信息:
该版本的来源资源包
具体的资源更新情况
4.8 更新效果
正式环境中,新增“门店商品销售额”主题
在模块管理中,更新了人事模块的当前版本、最新版本和更新记录信息
5.永久授信
在全局配置中,选择永久授信后,配置页面如图所示,tab页中会出现“永久授信”标签
永久授信与默认授信整体步骤基本相同,以下主要描述差异点
5.1 授信
与默认授信相比,增加授信后,配置时无需绑定邮箱。
系统会生成永久凭证,凭证可选择显示或隐藏,可直接复制使用
5.2 资源包创建
资源包创建地址为:http://ip:port/webName/decision/version/management/pack/page/create?creditType=permanentCredit。可以看到此处只需要凭证校验即可,相比于默认授信,不需要邮箱校验
5.3 审批页面
与默认授信相比,没有邮箱信息
其他步骤与默认授信完全相同
6.在线迁移
面向在两个网络互通的环境的场景,提供一种更便捷的方式,进行资源迁移。
在全局配置中,选择在线迁移后,配置页面如图所示,tab页中会出现“在线迁移配置”标签
在线迁移与授信模式下的流程类似,以下主要描述差异点
6.1 增加客户端
点击增加客户端,可自定义客户端名称,配置开始IP和结束IP
系统会生成客户端ID和secret,用于在后续的在线迁移页面填写信息,进行鉴权。secret可选择显示或隐藏,可直接复制使用
6.2 在线迁移页面
在线迁移页面在开发环境中打开,地址为:http://ip:port/webName/decision/version/management/online/page/create;
其中,地址为正式环境地址,格式为:http://ip:port/webName/decision。ClientID和secret填写上一步中生成的信息
6.3 在线推送页面
点击确定后,进入在线推送页面。该页面与授信模式下资源包上传页面的区别在于,在线迁移模式下,在线推送页面中的模块列表,会将正式环境中所有创建的模块全部展示出来。而授信模式下,模块列表中只展示授信步骤中,选择的模块
6.4 审批页面
与授信模式相比,增加了clientId信息