软件需求说明书实例

1、；. XX 平台需求说明书平台需求说明书 XX 信息技术有限公司信息技术有限公司 2010-07 . ；. 版本变更版本变更 版本版本完成时间完成时间修订动作修订动作完成人完成人 V1.02010-07-07 初稿XXX V1.12010-07-19 修改验证服务XXX 摘要摘要 略 关键字关键字 模型、WebService 服务、需求说明 . ；. 目录目录 1 引言引言.6 1.1 编写目的.6 1.2 背景.6 1.3 定义.6 1.4 参考资料.7 2 任务概述任务概述.7 2.1 目标.7 2.2 用户的特点.7 3 需求规定需求规定.8 3.1 需求边界.8 3.2 功能划分.9

2、3.3 业务需求.10 3.3.1 组织机构服务.10 3.3.1.1 机构维护.11 3.3.1.1.1 新增机构.11 3.3.1.1.2 修改机构.13 3.3.1.1.3 删除机构.14 3.3.1.1.4 查找机构.16 3.3.1.2 部门维护.17 3.3.1.2.1 新增部门.17 3.3.1.2.2 修改部门.19 3.3.1.2.3 删除部门.21 3.3.1.2.4 查找部门.22 3.3.1.3 岗位维护.23 3.3.1.3.1 新增岗位.23 3.3.1.1.2 修改岗位.25 3.3.1.1.3 删除岗位.26 3.3.1.1.4 查找岗位.28 3.3.1.4

3、人员维护.29 3.3.1.4.1 新增人员.29 3.3.1.4.2 修改人员.33 3.3.1.4.3 删除人员.34 3.3.1.4.4 查找人员.35 3.3.1.5 工作组维护.37 3.3.1.6 组织机构建模.37 3.3.1.6.1 分配.37 3.3.1.6.2 移除.39 . ；. 3.3.1.6.3 属性.39 3.3.2 功能权限服务.40 3.3.2.1 系统注册.41 3.3.2.2 系统功能注册.42 3.3.2.3 查询系统功能.44 3.3.2.4 权限分配.45 3.3.2.5 权限移除.47 3.3.2.6 二级授权.47 3.3.2.7 权限继承.48

4、3.3.2.8 权限继承中止.48 3.3.3 数据权限服务.49 3.3.3.1 权限分配.51 3.3.3.2 权限移除.51 3.3.4 代理服务.52 3.3.4.1 代理.53 3.3.4.2 取消代理.54 3.3.5 服务接口.55 3.3.5.1 组织机构服务接口.56 3.3.5.1.1 组织机构模型信息接口.56 3.3.5.1.2 机构信息维护接口.57 3.3.5.1.2.1 新增机构信息.57 3.3.5.1.2.2 修改机构信息.58 3.3.5.1.2.3 删除机构信息.60 3.3.5.1.2.4 查询机构信息.61 3.3.5.1.3 部门/工作组信息维护接口

5、 .62 3.3.5.1.3.1 新增部门信息.62 3.3.5.1.3.2 修改部门信息.64 3.3.5.1.3.3 删除部门信息.65 3.3.5.1.3.4 查询部门信息.66 3.3.5.1.4 岗位信息维护接口.68 3.3.5.1.4.1 新增岗位信息.68 3.3.5.1.4.2 修改岗位信息.69 3.3.5.1.4.3 删除岗位信息.70 3.3.5.1.4.4 查询岗位信息.71 3.3.5.1.5 人员信息维护接口.73 3.3.5.1.5.1 新增人员信息.73 3.3.5.1.5.2 修改人员信息.74 3.3.5.1.5.3 删除人员信息.76 3.3.5.1.5

6、.4 查询人员信息.77 3.3.5.1.6 组织机构建模接口.79 3.3.5.1.6.1 分配节点.79 3.3.5.1.6.2 移除节点.80 3.3.5.2 功能权限服务接口.81 3.3.5.2. 1 业务系统查询.81 . ；. 3.3.5.2. 2 分配功能权限.83 3.3.5.2. 3 移除功能权限.84 3.3.5.4 数据权限服务接口.85 3.3.5.5 代理服务接口.87 3.3.5.5.1 分配代理.87 3.3.5.5.2 取消代理.88 3.3.6 验证服务.89 3.3.6.1 登录验证服务.90 3.3.6.2 更换用户服务.91 4 运行环境规定运行环境规

7、定.92 . ；. 1 引言引言 1.1 编写目的编写目的 本系统主要为解决各个信息化系统之间的组织机构模型与组织机构数据（包括依托于 组织机构模型上的其它数据如功能权限等）相互不兼容的问题，是用户单位对信息化项目 进行标准化整改，同时作为以后信息化建设标准化的一个关键性步骤。本文就本系统的需 求范围做出描述。 本文档的预期读者为：信息化分管领导、项目经理、系统架构师、系统管理员、程序 员。 1.2 背景背景 说明： a 项目名称：组织机构服务平台； b 相互关系：本平台做为服务平台，依照本平台提出的相关数据交互标准，与其它第三 方系统进行交互，提供服务。 1.3 定义定义 机构：机构是对一个

8、经营实体的统称，处于组织机构的最高层。 部门对应于机构的静态结构划分，由机构的实际部门设置情况来决定，是以传统的面 向职能或者现在流行的面向过程与客户方式对机构进行的划分，是机构的主要组成部分。 岗位：是一种以职责或技能作为前提，具有相同的目标，能够进行某种决策或完成某 项功能的人员的总称。 人员：是指一个独立的、具有一定行为能力和一定业务技能的人的实体，它对应于机 构中的每一个自然人。 岗位成员：将岗位分配到部门下，形成一个新的组织单元，即岗位成员。岗位成员不 是新建出来的，是由岗位分配到部门下而得到，它具有岗位所有的职责和权限。 . ；. 人员成员：将人员分配到组织机构中岗位成员，形成一个

9、新的组织单元，即人员成员。 代理：由一个组织机构单元所具有的权限（功能权限与数据权限）临时性的被别一个 组织机构所具有，在取消代理之前，自己将不再能够使用自己的权限。 1.4 参考资料参考资料 略 2 任务概述任务概述 2.1 目标目标 本项目目标分为三部分，组织机构服务平台、组织机构服务规范以及现有系统改造。 首先是对组织机构数据进行规范，并建立一个标准的、开放式的、可维护的组织机构 模型，并将其封装成基础服务，为新建信息化系统提供组织机构数据服务，包括组织机构 的维护、数据权限维护、功能权限维护。新建的信息化系统原则上将不再自行建立维护独 立的组织机构模型及组织数据，所有涉及到组织机构操作

10、的内容，均通过与基础服务进行 交互的方式进行。 同时制定出组织机构相关标准，为新建的涉及到使用组织机构数据的系统提供相关的 开发标准。 最后，为使已有系统能够尽可能的统一化，本平台将会考虑在对原有系统进行一定改 造的前提下，为其提供组织机构（主要是人员信息）的数据同步功能。 2.2 用户的特点用户的特点 本平台是一个后台服务平台，具体用到此平台的均为专业技术人员，具有较强的技术 能力，所以其业务能力应该都可以满足平台的要求。但同时，由于本平台是一个基础的后 台服务平台，需要与多个软件进行交互，响应频率相对较高。 . ；. 3 需求规定需求规定 3.1 需求边界需求边界 本平台主要内容包括：组织

11、机构服务、功能权限服务、数据权限服务、代理服务、验 证服务五个部分。 组织机构服务包括：组织机构维护、组织机构维护接口、组织机构信息服务、验证服 务，分别用于维护管理组织机构模型、依据本平台制定的标准向其它第三方系统提供组织 机构维护接口、依据本平台制定的标准向其它第三方系统提供组织机构数据。 功能权限服务包括：系统功能注册、操作员功能权限维护、功能权限信息服务，分别 用于注册新系统及新系统的功能列表、维护操作员对每个系统所具有的权限以及依据本平 台制定的标准向其它系统提供功能权限数据。 数据权限服务与功能权限服务相类似，其主要功能是依据本平台的规范，提供操作员 的数据权限服务及相关管理。 代

12、理服务：主要包括代理分配与代理取消。用于在某个组织机构单元因故不能履行职 责时，为保证工作的连续性，而临时将该组织机构单元的权限（功能权限与数据权限）赋 与另一组织机构单元，并在能够继续履行职责时将权限收回。 验证服务：用于验证其它第三方业务系统通过统一登录接口提交的用户登录信息。此 服务原则上只为第三方业务系统开放。同时，在此验证服务通过后，才可能向申请验证的 第三方业务系统继续提供后续的服务功能。 3.2 功能划分功能划分 图略 3.3 业务需求业务需求 3.3.1 组织机构服务组织机构服务 业务描述：业务描述： 组织机构服务，分为本地控制台与接口两部分。系统管理员可直接通过控 . ；.

13、制台进行组织机构元素的维护，并利用各元素进行组织机构模型的建立。同时 在提供组织机构接口的服务，为其它系统提供相应的组织机构维护支持。 组织机构的基本元素包括人员、岗位、部门、机构，在一个机构中，这些 元素基本是稳定的。同时还有临时的工作组，是在有临时任务发生时，由各个 基本元素根据需要组成。 组织机构建模则利用维护好的基本元素，根据机构实际的情况，依据计算 机数字建模的规则，构建为一个树型组织机构模型。在模型中，将反应出机构 的实际组织情况，其上下层次关系将作为功能权限及数据权限的基础。 业务用例：业务用例： 基本元素维护 系统管理员 组组织织机机构构平平台台其其它它业业务务系系统统 各级具

14、有权限的管理者 组织机构建模 基基本本元元素素维维护护接接口口 建建模模维维护护接接口口 开发人员或操作人员 验验证证服服务务接接口口 验证服务 业务流程：业务流程： 组织机构平台是基础性的服务平台，不存在直观的业务流程，只需要维护 好所需要的组织机构元素数据，即可按照组织机构平台制定的标准规范进行组 织机构建模。 组织机构元素维护组织机构建模 3.3.1.1 机构维护机构维护 业务描述：业务描述： 根据机构变更的实际情况，维护机构的基础数据。机构维护包括新增、修 改、删除、查询四种操作。 . ；. 业务用例：业务用例： 新增机构 系统管理员 修改机构 删除机构 查询机构 3.3.1.1.1

15、新增机构新增机构 简要描述：简要描述： 通过机构信息窗口中的新增按钮或组织机构建模界面中机构选择弹出窗口 中的新增机构弹出菜单，进行新增机构的操作。 使用角色：使用角色： 平台管理员 触发条件：触发条件： 机构信息窗口中点击新增按钮或组织机构建模界面中机构选择弹出窗口中 点击新增机构弹出菜单。 约束条件：约束条件： 机构编号、机构名称。 操作流程：操作流程： . ；. 开始 点击新增按钮 或选择新增机 构弹出菜单 进入机构信息维护 窗口 录入机构信息 是否存在相同的编号或是 相同的名称 保存机构信息 结束 否 是 输入描述：输入描述： 上层机构：下拉选择； 机构编号：输入，必输项； 显示名称：

16、输入，必输项； 类型：下拉选择，必输项； 顺序号：输入 主要业务：输入 负责人：输入 电话：输入 地址：输入 邮编：输入 公共邮箱：输入 . ；. 描述：输入 输出描述：输出描述： 编号重复提示编号重复； 名称重复相应提示； 保存成功则提示保存成功； 保存失败则提示保存失败。 主要数据项：主要数据项： 序号序号显示名称显示名称类型类型大小大小是否必须是否必须备注备注 1GUIDVarchar232Y 平台自动产生 2 上层机构 Varchar232 3 机构编号 Varchar264Y 4 显示名称 Varchar280Y 5 类型 Varchar264Y 组织(.GRP)/机构 (.OGN)

17、 6 顺序号 Integer 7 主要业务 Varchar264 8 负责人 Varchar232 9 电话 Varchar216 10 地址 Varchar2128 11 邮编 Varchar210 12 公共邮箱 Varchar232 13 描述 Varchar2128 14 有效标志 IntegerY 默认为 1：有效 15 修改时间 Date 平台自动产生 16 操作员 GUID Varchar232 3.3.1.1.2 修改机构修改机构 简要描述：简要描述： 通过机构信息窗口中的修改按钮进行修改机构的操作。 使用角色：使用角色： 平台管理员 触发条件：触发条件： 机构信息窗口中选择机

18、构后点击修改按钮。 约束条件：约束条件： . ；. 必须要有机构信息且有机构信息被选中。数据约束同机构新增。 操作流程：操作流程： 开始 点击修改按钮 进入机构信息维护窗口 录入机构信息 是否存在相同的编号或是相同的名称 保存机构信息 结束 否 是 机构信息窗口中选择将修改的 机构 输入描述：输入描述： 数据项新增功能。 机构编号：不可修改； 输出描述：输出描述： 同机构新增。 主要数据项：主要数据项： 同机构新增。 3.3.1.1.3 删除机构删除机构 简要描述：简要描述： 通过机构信息窗口中的删除按钮进行删除机构的操作。 使用角色：使用角色： . ；. 平台管理员 触发条件：触发条件： 机构信息窗口中选择机构后点击删除按钮。 约束条件：约束条件： 必须要有机构信息且有机构信息被选中。必须先在组织机构模型中移除该 机构。 操作流程：操作流程： 开始 点击删除按钮 提示是否确认删除？ 保存机构信息 结束 是 机构信息窗口中选择将修改的 机构 修改有效标志值为4：无效 输入描述：输入描述： 无 输出描述：输出描述： 删除成功，提示。 删除失败，提示。 主要数据项：主要数据项： 同机构新增。 . ；. 3.3.1.1.4 查找机构查找机构 简要描述：简要描述： 通过机构信息窗口中的查找或输入全部或部分条件后进行机构查找。 使用角色：使用角色： 平台管理