统一WEB框架需求说明书.docx
- 文档编号:26438926
- 上传时间:2023-06-19
- 格式:DOCX
- 页数:73
- 大小:517.10KB
统一WEB框架需求说明书.docx
《统一WEB框架需求说明书.docx》由会员分享,可在线阅读,更多相关《统一WEB框架需求说明书.docx(73页珍藏版)》请在冰豆网上搜索。
统一WEB框架需求说明书
WEB框架系统
需求规格说明书
文件编号:
生效日期:
版本号:
V0.1
修改状态:
0
密级:
编制:
李晓海
日期:
2012/06/13
审核:
日期:
批准:
日期:
北京联动优势科技有限公司
版本控制信息
版本
日期
描述
作者
V0.1
2012-06-13
创建
李晓海
本文档中的所有内容为北京联动优势科技有限公司的机密和专属所有。
未经北京联动优势科技有限公司的明确书面许可,任何组织或个人不得以任何目的、任何形式及任何手段复制或传播本文档部分或全部内容。
本规范解释权属北京联动优势科技有限公司所有。
目录
1前言8
1.1文档目的8
1.2阅读对象8
1.3名词解释8
2需求概述9
2.1系统结构9
2.2角色分析9
2.3总体用例9
3URP用例分析11
3.1用例描述11
3.2资源管理12
3.2.1用例描述12
3.2.2设计资源模型12
3.2.2.1用例说明12
3.2.2.2用例分析12
3.2.3注册资源13
3.2.3.1用例说明13
3.2.3.2用例分析13
3.2.4查询资源13
3.2.4.1用例说明13
3.2.4.2用例分析13
3.3组织机构管理14
3.3.1用例描述14
3.3.2组织管理16
3.3.2.1用例描述16
3.3.2.2注册组织17
3.3.2.2.1用例说明17
3.3.2.2.2用例描述17
3.3.2.3分配组织管理员17
3.3.2.3.1用例说明17
3.3.2.3.2用例描述17
3.3.2.4分配组织领导18
3.3.2.4.1用例说明18
3.3.2.4.2用例描述18
3.3.2.5注销组织18
3.3.2.5.1用例说明18
3.3.2.5.2用例描述19
3.3.2.6查询组织19
3.3.2.6.1用例说明19
3.3.2.6.2用例描述19
3.3.3部门管理20
3.3.3.1用例描述20
3.3.3.2管理部门信息20
3.3.3.2.1用例说明20
3.3.3.2.2用例描述20
3.3.3.3迁移部门21
3.3.3.3.1用例说明21
3.3.3.3.2用例描述21
3.3.3.4分配部门领导21
3.3.3.4.1用例说明21
3.3.3.4.2用例描述22
3.3.3.5查询部门22
3.3.3.5.1用例说明22
3.3.3.5.2用例描述22
3.3.3.6部门排序23
3.3.3.6.1用例说明23
3.3.3.6.2用例描述23
3.3.4角色管理23
3.3.4.1用例描述23
3.3.4.2管理角色24
3.3.4.2.1用例说明24
3.3.4.2.2用例描述24
3.3.4.3分配人员24
3.3.4.3.1用例说明24
3.3.4.3.2用例描述24
3.3.4.4分配所属用户组25
3.3.4.4.1用例说明25
3.3.4.4.2用例描述25
3.3.4.5查询角色25
3.3.4.5.1用例说明25
3.3.4.5.2用例描述26
3.3.5岗位管理26
3.3.5.1用例描述26
3.3.5.2管理岗位27
3.3.5.2.1用例说明27
3.3.5.2.2用例描述27
3.3.5.3分配人员27
3.3.5.3.1用例说明27
3.3.5.3.2用例描述27
3.3.5.4查询岗位28
3.3.5.4.1用例说明28
3.3.5.4.2用例描述28
3.3.6用户组管理29
3.3.6.1用例描述29
3.3.6.2管理用户组29
3.3.6.2.1用例说明29
3.3.6.2.2用例描述29
3.3.6.3分配人员30
3.3.6.3.1用例说明30
3.3.6.3.2用例描述30
3.3.6.4分配角色30
3.3.6.4.1用例说明30
3.3.6.4.2用例描述31
3.3.6.5查询用户组31
3.3.6.5.1用例说明31
3.3.6.5.2用例描述31
3.3.7人员管理32
3.3.7.1用例描述32
3.3.7.2管理人员32
3.3.7.2.1用例说明32
3.3.7.2.2用例描述32
3.3.7.3注销人员33
3.3.7.3.1用例说明33
3.3.7.3.2用例描述33
3.3.7.4重设密码33
3.3.7.4.1用例说明33
3.3.7.4.2用例描述34
3.3.7.5人员排序34
3.3.7.5.1用例说明34
3.3.7.5.2用例描述34
3.3.7.6迁移部门35
3.3.7.6.1用例说明35
3.3.7.6.2用例描述35
3.3.7.7查询人员35
3.3.7.7.1用例说明35
3.3.7.7.2用例描述35
3.4权限管理36
3.4.1用例描述36
3.4.2分配权限36
3.4.2.1用例说明36
3.4.2.2用例分析37
3.4.3过滤权限37
3.4.3.1用例说明37
3.4.3.2用例分析37
3.4.4查询权限38
3.4.4.1用例说明38
3.4.4.2用例分析38
3.5统一门户38
3.5.1用例描述38
3.5.2管理子系统39
3.5.2.1用例说明39
3.5.2.2用例描述40
3.5.3管理服务40
3.5.3.1用例说明40
3.5.3.2用例描述40
3.5.4管理portlet41
3.5.4.1用例说明41
3.5.4.2用例描述41
3.5.5管理样式41
3.5.5.1用例说明41
3.5.5.2用例描述42
3.5.6管理布局42
3.5.6.1用例说明42
3.5.6.2用例描述42
3.5.7配置风格43
3.5.7.1用例说明43
3.5.7.2用例描述43
3.5.8访问门户43
3.5.8.1用例说明43
3.5.8.2用例描述43
3.5.9SSO44
3.5.9.1用例说明44
3.5.9.2用例描述44
3.6日志管理45
3.6.1用例描述45
3.6.2系统日志45
3.6.2.1用例说明45
3.6.2.2用例描述46
3.6.3业务日志46
3.6.3.1用例说明46
3.6.3.2用例描述46
3.6.4查询日志47
3.6.4.1用例说明47
3.6.4.2用例描述47
3.6.5分析日志47
3.6.5.1用例说明47
3.6.5.2用例描述47
4快速开发平台用例分析48
4.1用例描述48
4.2导入数据模型49
4.2.1用例说明49
4.2.2用例描述49
4.3定制代码模板49
4.3.1用例说明49
4.3.2用例描述49
4.4生成业务代码50
4.4.1用例说明50
4.4.2用例描述50
4.5运行引擎51
4.5.1用例描述51
4.5.1管理模型51
4.5.1.1用例说明51
4.5.1.2用例描述51
4.5.2运行界面52
4.5.2.1用例说明52
4.5.2.2用例描述52
4.5.3调度监听器52
4.5.3.1用例说明52
4.5.3.2用例描述53
5工作流平台用例分析53
6任务调度平台用例分析53
6.1用例描述53
6.2管理工作54
6.2.1用例说明54
6.2.2用例描述54
6.3管理任务54
6.3.1用例说明54
6.3.2用例描述55
6.4配置调度规则55
6.4.1用例说明55
6.4.2用例描述55
6.5调度任务56
6.5.1用例说明56
6.5.2用例描述56
6.6任务授权56
6.6.1用例说明56
6.6.2用例描述56
6.7监控任务57
6.7.1用例说明57
6.7.2用例描述57
6.8查看任务57
6.8.1用例说明57
6.8.2用例描述58
1前言
1.1文档目的
该文档主要对公司内部统一WEB框架平台(UMPAY-FRAME)的相关需求进行了分析,为之后概要设计和详细设计提供依据。
1.2阅读对象
参与统一WEB框架的设计人员
参与统一WEB框架的产品负责人和业务人员。
参与统一WEB框架的开发人员。
参与统一WEB框架的测试人员。
1.3名词解释
⏹UMPAY-FRAME:
统一WEB框架。
为公司内部管理类系统研发提供统一框架和基础设施。
⏹URP:
统一资源管理平台。
抽象软件系统涉及的各种资源进行注册和管理。
⏹SSO:
单点登录,用户只要记忆一套用户名和密码即可访问多个应用系统。
⏹统一门户:
用户登录后访问的统一展示平台,负责统一展示信息,注册管理应用系统,统一授权等。
⏹布局、样式:
布局指的是操作界面的整体功能点的分布,样式指的是显示的形式,一套布局和样式形成一个系统的总体展示方式。
一个布局可以对应多套样式,反之也是如此。
⏹任务调度平台:
针对需要在后台异步执行的任务,本平台提供工作注册,任务配置,任务运行监控等完整生命周期的管理。
⏹快速开发平台:
针对简单应用,提供代码生成或者同一运行的方式,快速生成系统骨架,提高开发效率。
⏹系统监控平台:
对核心应用提供运行情况的监控和日志查看。
⏹业务组件:
针对某具体的业务功能封装的可以重用的、可以插拔的组件,包括UI组件和服务组件。
⏹入口权限:
系统访问的入口的权限,常见的如菜单权限,url权限等。
⏹功能权限:
针对具体业务功能的权限,如新增、删除、修改、审批等。
⏹数据权限:
针对某类信息指定用户可以访问那些信息的权限,如分公司经理可以查看本公司内部的订单信息,总公司经理可以查看全部的订单信息。
⏹权限授予:
针对授权目标,将此subject授予给指定的用户、角色、部门等。
⏹权限过滤:
针对授权目标,设置此目标的过滤操作,相当于给此目标加锁,权限授予和权限过滤组合起来形成完整的授权体系。
⏹分级授权:
按照总公司和分公司级别,将系统管理的工作分别授予总公司和分公司的管理员,总公司管理员负责系统全局的管理,分公司管理员只负责本公司内部的系统管理工作。
⏹流程平台:
包括工作流引擎和配置和运行平台,为使用流程审批的系统提供完成的流程定义,流程配置,流程运行监控等完整生命周期管理。
⏹表达式引擎:
将可读的字符形式的表达式,转换成可以执行的代码,为流程运转提供快速配置,快速变更的重要保障。
2需求概述
2.1
系统结构
2.2角色分析
角色名称
说明
总公司系统管理员
负责全局的系统配置管理工作、管理分公司管理的信息以及系统监控
分公司系统管理员
负责本公司内部系统管理
业务人员
访问系统,进行业务操作
开发人员
使用系统框架,快速开发平台进行系统开发
2.3总体用例
3URP用例分析
3.1用例描述
3.2资源管理
资源是抽象系统中需要统一注册,统一发现以及统一授权的元素,比如组织机构,人员、子系统、模块等。
功能类似于LDAP或者windows系统的注册表。
系统需要提供:
●统一的资源元数据的注册功能,统一注册资源的类型,属性,扩展属性,持久化策略等信息。
●统一的资源注册接口和服务,根据注册的资源元数据信息将将资源信息注册保存。
●统一的资源发现接口:
提供统一接口查询资源信息。
●统一授权和权限发现:
系统统一对注册的资源进行授权,支持多种授权主体和客体模型,参见权限管理。
并且提供统一的权限查询接口供用户或者第三方系统使用。
●统一的审计:
针对资源的操作,提供统一的审计功能,记录资源操作的轨迹。
3.2.1用例描述
3.2.2设计资源模型
3.2.2.1用例说明
开发人员注册资源的元数据信息,系统将资源元数据信息保存至xml或者数据库中。
3.2.2.2用例分析
用例编号
01-01
用例名称
设计资源模型
用例描述
设计资源模型
参与者
开发人员
前置条件
后置条件
基本流程
开发人员
系统
1,注册资源配置信息
2,保存资源注册信息
说明
3.2.3注册资源
3.2.3.1用例说明
第三方系统通过接口,将资源信息注册到平台中。
3.2.3.2用例分析
用例编号
01-02
用例名称
注册资源
用例描述
注册资源
参与者
第三方系统
前置条件
组织资源类型注册完毕
后置条件
基本流程
第三方系统
系统
1,输入资源信息
2,保存资源信息
3,提示处理结果信息
说明
3.2.4查询资源
3.2.4.1用例说明
第三方系统通过资源查询接口获得资源信息。
3.2.4.2用例分析
用例编号
01-03
用例名称
查询资源
用例描述
查询资源
参与者
第三方系统
前置条件
组织资源类型注册完毕
后置条件
基本流程
第三方系统
系统
1输入资源查询关键字
2,查询资源信息
3,返回资源信息
说明
3.3组织机构管理
3.3.1用例描述
包括组织结构模型、细粒度授权分布式部署和多种安全模型支持等。
传统的授权模型只是简单的将组织机构认为是一颗简单的树形结构。
从管理学角度,也就是通常所说的“事业部制组织机构”。
然后增加岗位或者职务(有的甚至干脆以角色或者用户组代替)的概念进行授权:
但是上面的模型很难表述用户的级别问题,如某个用户是XXX处长,并且树型的层次化结构基本可以满足绝大多数的组织模型,但是却无法解决矩阵式组织结构的问题:
把按职能划分的部门和按项目划分的小组结合起来,组成矩阵,同一名管理人员在与原职能保持组织和业务联系的同时可以参加产品或项目组的工作。
所以我们从职责、能力、权利、目标和任务的角度进行组织结构模型建设:
通过合并树形结构和矩阵关系,我们已经搭建了满足大部分用户需求的组织模型,并在此基础之上进行更加细粒度的授权。
统一认证和授权中心可以独立部署,主要应用场景可以作为单点登录的认证授权服务器来使用。
系统支持集中部署和分布式部署,支持集中式办公和总公司/分公司模型。
灵活的授权方式:
支持集中授权和分级授权,即部门管理员可以对本部门进行独立授权或者子节点管理员可以对本节点进行独立授权。
多种安全模型支持,支持传统的密码认证和证书认证。
3.3.2组织管理
3.3.2.1用例描述
3.3.2.2注册组织
3.3.2.2.1用例说明
系统管理员将组织信息注册到系统中。
系统保存组织信息,可以处理组织的新增和修改。
3.3.2.2.2用例描述
用例编号
02-01
用例名称
注册组织
用例描述
注册组织
参与者
系统管理员
前置条件
组织资源类型注册完毕
后置条件
基本流程
系统管理员
系统
1输入组织信息
2,保存组织信息
3,返回处理结果信息
说明
3.3.2.3分配组织管理员
3.3.2.3.1用例说明
系统管理员针对指定的组织分配此组织的系统管理员,某个组织的系统管理员只能维护本组织内部的资源等信息,以达到分级授权的目的。
3.3.2.3.2用例描述
用例编号
02-02
用例名称
分配组织管理员
用例描述
分配组织管理员
参与者
系统管理员
前置条件
组织注册完毕
后置条件
基本流程
系统管理员
系统
1选择组织和人员信息
2,保存组织管理员信息
3,返回处理结果信息
说明
3.3.2.4分配组织领导
3.3.2.4.1用例说明
系统管理员针对指定的组织分配此组织的领导。
3.3.2.4.2用例描述
用例编号
02-03
用例名称
分配组织领导
用例描述
分配组织领导
参与者
系统管理员
前置条件
组织注册完毕
后置条件
基本流程
系统管理员
系统
1选择组织和人员信息
2,保存组织领导信息
3,返回处理结果信息
说明
3.3.2.5注销组织
3.3.2.5.1用例说明
系统管理员将某个组织尽心注销,同时注销此组织下的部门,人员以及子系统信息。
3.3.2.5.2用例描述
用例编号
02-04
用例名称
注销组织
用例描述
分配组织领导
参与者
系统管理员
前置条件
组织注册完毕
后置条件
基本流程
系统管理员
系统
1选择组织
2,注销组织信息
3,返回处理结果信息
说明
3.3.2.6查询组织
3.3.2.6.1用例说明
系统管理员查询组织信息。
3.3.2.6.2用例描述
用例编号
02-05
用例名称
查询组织
用例描述
查询领导
参与者
系统管理员
前置条件
组织注册完毕
后置条件
基本流程
系统管理员
系统
1选择组织查询关键字
2,查询组织信息
3,返回组织信息
说明
3.3.3部门管理
3.3.3.1用例描述
3.3.3.2管理部门信息
3.3.3.2.1用例说明
系统管理员新增,修改部门信息,需要根据当前用户判断是否为本组织的管理员,只有组织管理员才能维护管理本组织的部门信息,超级管理员可以管理所有的部门信息。
3.3.3.2.2用例描述
用例编号
02-06
用例名称
管理部门信息
用例描述
管理部门信息
参与者
系统管理员
前置条件
组织注册完毕
后置条件
基本流程
系统管理员
系统
1输入部门信息
2,查询管理员权限信息
3,保存部门信息
4,返回操作信息
说明
3.3.3.3迁移部门
3.3.3.3.1用例说明
系统管理员将指定的的部门迁移到其他部门下方,只能在本组织内部进行迁移,需要判断是否是组织管理员。
3.3.3.3.2用例描述
用例编号
02-07
用例名称
迁移部门
用例描述
迁移部门
参与者
系统管理员
前置条件
部门注册完毕
后置条件
基本流程
系统管理员
系统
1选择部门和待迁移的目的部门
2,查询管理员权限信息
3,保存部门层级关系
4,返回操作信息
说明
3.3.3.4分配部门领导
3.3.3.4.1用例说明
系统管理员分配部门领导信息,可以讲部门领导指定到用户或者岗位,如果为岗位,则本岗位下的人员自动成为此部门的领导。
查询部门领导信息的时候,如果某个部门没有设置领导,则递归查询上级部门(一直到组织级别)的领导信息。
3.3.3.4.2用例描述
用例编号
02-08
用例名称
分配部门领导
用例描述
分配部门领导
参与者
系统管理员
前置条件
部门、人员、岗位注册完毕
后置条件
基本流程
系统管理员
系统
1输入部门和人员或者岗位信息
2,查询管理员权限信息
3,查询组织信息
4,返回组织信息
说明
3.3.3.5查询部门
3.3.3.5.1用例说明
系统管理员查询部门信息。
3.3.3.5.2用例描述
用例编号
02-09
用例名称
查询部门
用例描述
查询部门
参与者
系统管理员
前置条件
部门注册完毕
后置条件
基本流程
系统管理员
系统
1选择组织查询关键字
2,查询当前用户权限信息
3,查询部门信息
4,返回部门信息
说明
3.3.3.6部门排序
3.3.3.6.1用例说明
系统管理员对指定部门下面直接部门的先后顺序进行设定。
3.3.3.6.2用例描述
用例编号
02-10
用例名称
部门排序
用例描述
部门排序
参与者
系统管理员
前置条件
部门注册完毕
后置条件
基本流程
系统管理员
系统
1输入部门和部门的顺序信息
2,查询当前用户权限信息
3,查询组织信息
4,返回操作信息
说明
3.3.4角色管理
3.3.4.1用例描述
3.3.4.2管理角色
3.3.4.2.1用例说明
系统管理员新增、修改角色信息。
需要判断组织管理员权限。
3.3.4.2.2用例描述
用例编号
03-01
用例名称
管理角色
用例描述
管理角色
参与者
系统管理员
前置条件
组织注册完毕
后置条件
基本流程
系统管理员
系统
1输入角色信息
2,判断权限
3,保存角色信息
4,返回处理信息
说明
3.3.4.3分配人员
3.3.4.3.1用例说明
系统管理员为指定角色分配人员。
需要判断组织管理员权限。
3.3.4.3.2用例描述
用例编号
03-02
用例名称
分配人员
用例描述
分配人员
参与者
系统管理员
前置条件
角色注册完毕
后置条件
基本流程
系统管理员
系统
1,输入角色和人员信息
2,判断权限
3,保存角色信息
3,返回处理结果信息
说明
3.3.4.4分配所属用户组
3.3.4.4.1用例说明
系统管理员分配指定角色所属的用户组。
需要判断组织管理员权限。
3.3.4.4.2用例描述
用例编号
03-03
用例名称
分配所属用户组
用例描述
分配所属用户组
参与者
系统管理员
前置条件
角色、用户组注册完毕
后置条件
基本流程
系统管理员
系统
1输入角色和用户组信息
2,判断权限
2,保存对应信息
3,返回操作结果信息
说明
3.3.4.5查询角色
3.3.4.5.1用例
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 统一 WEB 框架 需求 说明书