1工作流管理系统--需求规格说明书.doc

西北工业大学软件与微电子学院需求规格说明版本：1.0编写：年月日校对：年月日审核：年月日批准：年月日西北工业大学 需求规格说明书目 录1引言11.1编写目的11.2背景11.3定义11.4参考资料22任务概述22.1目标22.2用户特点23需求详述33.1关键信息33.1.1名词解释33.2过程描述53.2.1系统管理53.2.2流程设计83.2.3业务管理143.2.4用户操作184说明18I西北工业大学软件与微电子学院 需求规格说明书1 引言1.1 编写目的本需求规格说明书对系统所要实现的功能分模块进行了详细说明，它是一份描述系统整体结构及工作流程的文档。本需求规格说明书主要向客户方及与本项目相关的人员发放，使他们了解该软件的功能结构详细情况。1.2 背景待开发系统是由631所提出的，针对该所的业务要求及外协任务说明。该系统包括四个子系统： 系统管理； 流程设计； 业务管理； 用户系统。本系统由西北工业大学软件与微电子学院负责开发，系统的开发环境为：WindowsJ2EE。1.3 定义 WfMC（Workflow Management Coalition）：工作流管理联盟。 流程设计：创建工作流模型，根据实际的业务流程创建可视的流程模型。 业务管理：是对工作流模型和实例进行监控和管理。 活动：是一项工作的原子单元。有时会使用节点代替活动。 流程：是活动的集合，有时会使用工程代替流程。 角色：指工作流模型的参与者和任务承担者，和权限相关联。 用户：指工作流系统的使用者。 连接：是两个活动之间顺序依赖的根据，有时会使用边代替连接。 变量：是工作流的数据单元，被称做工作流相关数据。 触发器：是用户定义的逻辑，向活动/节点和工作流过程增加自动的或具体的动作。 映射：是在工作流初始化时允许动态角色解决的一个工作单元。 实例：代表一个工作流模型具体执行的工作流过程。1.4 参考资料GB856T-88计算机软件开发规范；民机优化设计系统部分软件模块开发合同书及外协技术协议书，中航集团631研究所与西北工业大学，2007年1月。2 任务概述2.1 目标工作流管理系统就是通过管理一序列的工作活动以及相关人员、资源、信息技术资料来提供业务处理程序上的自动控制，该系统通过计算机软件来定义、管理和执行工作流程。在工作流管理系统中计算机运用程序的执行顺序是由工作流逻辑的计算机描述来驱动的。它的主要目标是对业务过程中各步骤（或称活动、环节）发生的先后次序，以及同各个步骤相关的人力、资源、信息资料的调用等进行管理，从而实现业务过程的自动化。工作流管理系统将人员、组织结构、设备资源、信息源（如数据库、文件系统、电子邮件、计算机辅助设计工具等）整合成一个整体。这样，工作流管理系统就成为了一个理想的用来收容业务逻辑的业务知识仓库，并给予业务逻辑一个易操作易控制的界面。2.2 用户特点本系统的用户为企事业单位的员工，对常用应用软件操作熟练，流程设计人员和业务管理人员对实际工作流程熟悉和理解。3 需求详述3.1 关键信息3.1.1 名词解释3.1.1.1 Package（包）属性属性名组成约束注释Id由26个大小写的英文字母与数字组成包的标识Name同上名称Description同上描述XPDL Version同上XPDL版本Source Vendor ID同上Creation Date同上创建日期Version同上10位数字版本号Author同上作者Codepage同上Country Key同上Publication Status同上发布状态Conformance Class同上Priority Unit同上3.1.1.2 Workflow（流程）属性属性名组成约束注释Id由26个大小写的英文字母与数字组成流程标识Name同上名称Description同上描述Creation Date同上创建日期Version同上XPDL版本Author 同上作者Codepage同上Country Key同上Publication Status同上Priority同上Limit同上Valid From Date同上Valid To Date同上3.1.1.3 Activity（活动）属性属性名组成约束注Id由26个大小写的英文字母与数字组成活动标识Name同上名称Description同上描述Automation Mode同上自动模式Split同上分支Join同上合并Priority同上优先级Limit同上限制Start Mode同上开始模式Finish Mode同上结束模式Deadline同上终止期限3.1.1.4 Transition（转移）属性属性名组成约束注Id由26个大小写的英文字母与数字组成转移标识Name同上名称Description同上描述3.1.1.5 Application（应用程序）属性属性名组成约束注Id由26个大小写的英文字母与数字组成应用程序标识Name同上名称Description同上描述3.1.1.6 Data Field(WorkflowRelevant Data)属性属性名组成约束注Id由26个大小写的英文字母与数字组成数据标识Name同上名称Description同上描述Data Type同上数据类型3.1.1.7 Participant（参与者）属性属性名组成约束注Id由26个大小写的英文字母与数字组成参与者标识Name同上名称Description同上描述Participant Typ同上参与者类型3.1.1.8 User(用户)属性属性名组成约束注Id由26个大小写的英文字母与数字组成用户标识Name同上名称Email同上描述Role同上角色Password同上用户密码3.1.1.9 Role（角色）属性属性名组成约束注Id由26个大小写的英文字母与数字组成角色标识Description同上名称3.2 过程描述3.2.1 系统管理3.2.1.1 新建用户（1）概述:管理员通过本功能添加该软件系统的用户，并为用户分配角色。（2）过程详述：管理员登入系统，进入新建用户界面，点选新建用户。填写用户信息，分配角色，提交之后，检查用户输入的信息是否符合要求。若不符合要求，则弹出信息提示框；符合要求，则提示创建新用户成功。新建的用户信息存入数据库，用户名出现在用户列表。（3）输入/输出数据：输入/输出名称内容输入用户登录名用户姓名邮箱密码确认密码角色（选择添加）输出用户名空必须输入用户名用户名重复用户名已存在姓名空必须输入姓名邮箱空必须输入邮箱密码空必须输入密码密码不一致输入确认密码必须相同成功信息创建用户成功3.2.1.2 删除用户（1）概述：将一个系统用户删除。（2）过程详述：管理员登入系统，进入用户界面，展开用户列表。选择要删除的用户名，提交后转到确认界面确认删除，提示删除成功，用户数据从数据库中删除，不再出现在用户列表。（3）输入/输出数据：输入/输出名称内容输入用户名（勾选）输出成功信息删除成功3.2.1.3 新建角色（1）概述：管理员为系统新建角色。（2）过程详述：管理员登入系统，进入新建角色界面，选择新建角色。填写角色信息，提交之后，检查输入的信息是否符合要求。若不符合要求，则弹出信息提示框；符合要求，则提示创建角色成功。新建的角色信息存入数据库，角色名出现在角色列表。（3）输入/输出数据：输入/输出名称内容输入角色名称描述输出成功提示创建角色成功角色名空必须输入角色名称3.2.1.4 删除角色（1）概述：将一个角色删除。（2）过程详述：管理员登入系统，进入用户界面，展开角色列表。选择要删除的角色，提交后转到确认界面确认删除，提示删除成功，角色数据从数据库中删除，不再出现在角色列表。（3）输入/输出数据：输入/输出名称内容输入角色名（勾选）输出提示信息删除成功3.2.1.5 查看和修改用户信息（1）概述：管理员对用户信息进行修改。（2）详述：管理员登入系统，进入用户管理界面，展开用户列表。点击要查看的用户名，页面显示用户信息，管理员可以对用户信息进行修改并更新数据库。（3）输入输出数据：输入/输出名称内容输入要修改的用户信息查看的输出用户登录名用户姓名邮箱密码确认密码角色信息修改的输出用户登录名用户姓名邮箱密码确认密码角色用户登录名3.2.1.6 查看角色的用户（1）概述：查看某个角色的所有用户。（2）详述：管理员登入系统，进入角色管理界面，展开角色列表。点选一个角色名称，显示该角色的所有用户。（3）输入/输出数据：输入/输出名称内容输入无输出用户列表该角色的所有用户名3.2.2 流程设计3.2.2.1 新建流程模型（1）概述：创建一个空的流程模型文件。（2）详述：用户登录后，选择新建流程模型，系统会弹出对话框让用户输入新建流程模型文件的名称，然后系统会以用户输入的文件名创建一个空的流程模型。（3）输入/输出数据：输入/输出名称内容输入流程模型文件的名字输入新建流程模型文件的名字输出成功提示视图区会打开一个空的视图编辑文件错误提示新建流程模型文件的名字不能为空3.2.2.2 图形化显示xpdl文件（1）概述：把一个xpdl文件进行图形化显示。（2）详述：用户选择一个xpdl文件后，系统会把此xpdl文件在视图区中进行图形化显示。（3）输入/输出数据：输入/输出名称内容输入文件名XPDL文件的名字输出文件的视图显示在视图区中图形化显示XPDL文件错误提示没有选择XPDL文件3.2.2.3 保存XPDL文件（1）概述：把已经编辑好的流程模型以XPDL文件的形式保存。（2）详述：用户登录后，选择保存文件，系统会把视图区中的视图元素转化成XPDL的形式并弹出对话框让用户选择保存的路径和文件名，系统会把此流程模型按用户输入的路径和文件名进行保存。（3）输入/输出数据：输入/输出名称内容输入文件名保存的XPDL文件的文件名输出成功提示你已成功保存此流程模型文件错误提示没有输入保存文件的文件名错误提示此文件名已经存在3.2.2.4 导出流程模型（1）概述：把已经编辑好的流程模型以图片的形式导出。（2）详述：用户登录后，选择导出流程模型，系统会弹出对话框让用户输入导出图片的格式、图片的名字、保存图片的路径，然后系统会按照用户输入的名字和格式把流程模型导出并在用户选择的路径中保存。（3）输入/输出数据：输入/输出名称内容输入图片的名字输入导出流程模型后保存的图片的名字图片的格式输入导出流程模型后保存的图片的格式输出成功提示你已经成功导出此流程模型错误提示图片名字不能为空3.2.2.5 流程模型打印预览（1）概述：打印预览已经编辑好的流程模型。（2）详述：用户登录后，选择打印流程模型的预览，系统会把此流程模型以图片的形式显示给用户并通过打印机把图片打印。（3）输入/输出数据：输入/输出名称内容输入无无输出成功提示你已经成功地打印了此流程模型的预览错误提示此电脑没有安装打印机3.2.2.6 关闭流程模型文件（1）概述：关闭选择的流程模型文件。（2）详述：用户登录后，选择要关闭的流程模型提交后，系统会弹出对话框确定用户是否确实要关闭流程模型，用户确认后系统会自动关闭流程模型。（3）输入/输出数据：输入/输出名称内容输入无无输出无无加工关闭了选择的流程模型3.2.2.7 缩放视图（1）概述：对视图区中的视图元素进行缩放。（2）详述：用户登录后，可以对视图区中的活动、路由活动、块型活动等视图元素进行大小进行放大和缩小。（3）输入/输出数据：输入/输出名称内容输入点击缩小按钮输出无无加工视图区中的元素会缩小一倍输入/输出名称内容输入点击放大按钮输出无无加工视图区中的元素会放大一倍3.2.2.8 排列视图区元素（1）概述：对视图区中的元素进行排列。（2）详述：用户登录后，可以对视图区中的活动，路由活动等视图元素进行水平排列和垂直排列等操作。（3）输入/输出数据：输入/输出名称内容输入点击垂直排列按钮输出无无加工视图元素会按照垂直排列的方式重新进行排列输入/输出名称内容输入点击水平排列按钮输出无无加工视图元素会按照水平排列的方式重新进行排列3.2.2.9 编辑视图区中的元素（1）概述：对视图元素进行编辑。（2）详述：用户登录后，可以对当前流程模型中的视图元素进行添加、删除、修改元素属性值等操作。（3）输入/输出数据：输入/输出名称内容输入选择视图元素类型选择添加视图元素的位置输出无无加工在视图区选择的位置添加一个选择的视图元素输入/输出名称内容输入用户选择视图元素点击删除按钮输出无无加工把选择的视图元素删除输入/输出名称内容输入双击路由活动输出名称路由活动的名称类型路由活动的类型开始模式路由活动的开始方式加入类型路由活动的加入类型描述路由活动的描述输入/输出名称内容输入双击活动输出名称活动的名称类型活动的类型开始模式活动的开始方式加入类型活动的加入类型描述活动的描述执行者执行活动的参与者输入/输出名称内容输入双击转换转换的名称输出源活动转换的源活动目的活动转换的目的活动描述转换的描述类型转换的判断条件3.2.2.10 视图区的设计功能（1）概述：对视图区进行设计。（2）详述：用户登录后，可以对当前流程模型中的视图元素进行设计，例如拖拽视图区中的元素，双击或者右键单击视图区中的视图元素等操作。3.2.2.11 查看使用说明帮助（1）概述：给出此软件的使用说明书。（2）详述：用户登录后，选择查看帮助文档后，系统会弹出一个新窗体并在此新窗体中显示此软件的帮助文档。（3）输入/输出数据：输入/输出名称内容输入点击帮助按钮输出弹出一个新窗体来显示此系统的帮助文档3.2.3 业务管理3.2.3.1 流程模型（1）概述：具有业务管理员角色的用户通过该模块查看、启动、部署、解除部署该用户所管理的流程模型。（2）过程详述：用户进入流程模型模块，显示该用户所管理的流程模式的简要信息：名称、版本、状态、创建者及操作按钮。若该流程当前未部署，则显示部署按钮；若当前已部署，则显示开始按钮和解除部署按钮。用户通过点击流程模型名称，显示该流程的详细信息：名称、版本、状态、创建者、创建日期、用户、角色及操作按钮，操作按钮的显示同上；同时可显示对流程用户的修改和角色映射关系的修改。流程用户的修改，可选择或删除流程用户，其中流程创建者不可更改，提交后保存修改。角色映射关系的修改，显示该流程角色、映射关系、映射类型及改变映射的操作链接，点击角色名，显示所有系统用户名，可选择或删除当前角色所对应的用户名，提交后保存修改；点击改变映射关系链接，显示所选角色名称、映射类型、映射名称，其中映射类型可选为LDAP、属性、定制、无；映射名称由用户命名，点击更新按钮更新设置，点击删除按钮删除该映射。（3）输入/输出数据：输入/输出名称内容输入无输出名称流程名称版本流程版本号状态流程状态创建者流程创建者用户名操作开始按钮/解除部署按钮或部署按钮无流程模型没有发现相关流程模型错误信息具体异常信息页面输入/输出名称内容输入点击开始按钮输出初始化流程流程初始化页面启动成功流程XXX启动成功错误信息具体异常信息页面输入/输出名称内容输入点击解除部署按钮输出解除部署成功显示部署按钮错误信息具体异常信息页面输入/输出名称内容输入点击部署按钮输出部署成功显示开始/解除部署按钮错误信息具体异常信息页面输入/输出名称内容输入添加、删除流程用户点击应用按钮输出修改成功错误信息具体异常信息页面输入/输出名称内容输入选择、删除角色用户点击应用按钮输出修改成功错误信息具体异常信息页面输入/输出名称内容输入点击改变映射链接输出名称流程名称版本流程版本号角色名称角色名映射类型映射类型选择列表映射名称映射名称文本输入框错误信息具体异常信息页面输入/输出名称内容输入映射类型选择列表：LDAP、属性、定制、无映射名称点击更新按钮输出修改成功错误信息具体异常信息页面输入/输出名称内容输入点击删除按钮输出删除成功错误信息具体异常信息页面3.2.3.2 流程监控3.2.3.2.1 显示用户流程模型列表（1）概述：显示当前登录用户的所有的流程模型。（2）详述：用户登录后，系统会自动把此登录用户所拥有的流程模型以及每个流程模型的实例等相关信息列举出来。（3）输入/输出数据：输入/输出名称内容输入无无输出显示所有的流程模型以及每个模型的所有实例3.2.3.2.2 查看流程模型实例中元素的状态（1）概述：显示当前流程模型实例中元素的状态。（2）详述：用户登录后，选择一个流程模型实例，系统会在视图区中以不同的颜色来显示此流程模型实例中元素（比如活动）的状态信息。（3）输入/输出数据：输入/输出名称内容输入双击流程模型实例输出显示元素的运行状态3.2.3.2.3 查看流程模型实例中元素的详细信息（1）概述：显示选择的流程模型实例中元素的详细信息。（2）详述：用户登录后，选择一个流程模型实例，再选择其中的一个元素，系统会弹出一个新的对话框显示元素的各个属性的信息。（3）输入/输出数据：输入/输出名称内容输入双击路由活动输出名称路由活动的名称类型路由活动的类型开始模式路由活动的开始方式加入类型路由活动的加入类型描述路由活动的描述输入/输出名称内容输入双击活动输出名称活动的名称类型活动的类型开始模式活动的开始方式加入类型活动的加入类型输出描述活动的描述输出执行者执行活动的参与者输入/输出名称内容输入双击转换转换的名称输出源活动转换的源活动目的活动转换的目的活动描述转换的描述类型转换的判断条件3.2.3.3 当前实例（1）概述：用户通过本模块查看、终止、删除流程实例。（2）过程详述：用户进入该模块后，显示该用户所管理的流程模型对应的流程实例信息列表：实例名称、版本、创建日期、创建者及终止/删除操作按钮。用户通过点击实例名称链接，可查看该流程实例的具体信息：实例名称、版本、状态、创建者、创建日期、用户、角色、实例变量初始化的修改。用户点击终止按钮可终止所选实例。用户点击删除按钮可删除所选实例。实例过滤，用户可根据实例状态、创建者、用户、角色、初始变量等信息对实例进行过滤。（3）输入/输出数据：输入/输出名称内容输入实例名称链接无输出实例名称实例名版本流程模型版本号状态实例状态创建者实例创建者用户名创建日期实例创建日期用户实例用户角色实例角色错误信息具体异常信息页面输入/输出名称内容输入初始变量值无点击修改按钮输出修改成功错误信息具体异常信息页面输入/输出名称内容输入状态选择列表流程状态列表创建者选择列表用户选择列表角色选择列表变量选择列表输出所过滤实例错误信息具体异常信息页面3.2.3.4 任务（1）概述：用户通过该模块查看，操作该用户所管理的流程实例模型所开启实例的任务。（2）过程详述：用户进入该模块后，显示任务信息列表：任务名称、流程名称、版本、状态，以及根据其状态显示可执行的操作。若状态为TERMINATED，显示移除操作按钮，点击该按钮可移除已终止的任务；若状态为READY，显示开始操作按钮，点击该按钮可启动已经就绪的任务。点击任务名称链接，显示该任务的详细信息：任务名称、流程名称、版本、状态、描述、开始日期、最终期限、完成日期、执行者，以及根据其状态显示可执行的操作，同上。在点击具体任务后，可根据其状态指定该任务的承担者。活动过滤，根据活动状态、执行者、承担者、流程信息过滤出用户所需活动。（3）输入/输出数据：输入/输出名称内容输入任务名称链接输出任务名称流程名称版本状态描述开始日期最终期限完成日期执行者指定承担者任务名称当前承担者选择承担者错误信息具体异常信息页面输入/输出名称内容输入状态选择列表任务状态列表执行者选择列表承担者选择列表流程选择列表输出所过滤活动错误信息具体异常信息页面3.2.3.5 日志设置（1）概述：日志、跟踪、历史记录设置。（2）过程详述：用户通过该模块可开打或关闭JMS，设置跟踪等级（info, Debug, Error）、日志等级（info, Debug, Error）、历史记录属性（临时或归档）。（3）输入/输出数据：输入/输出名称内容输入JMS打开或关闭跟踪Info, Debug, Error日志Info, Debug, Error历史临时或归档输出设置成功更新成功错误信息具体异常信息页面3.2.3.6 查看日志（1）概述：业务管理员用户通过该模块查看流程操作的日志信息。（2）过程详述：业务管理员进入该模块后显示日志信息列表，选择某一具体日志记录可查看详细信息：日期时间、日志记录者、日志等级、操作、和日志消息。（3）输入/输出数据：输入/输出名称内容输入点击功能按钮输出跟踪日志列表所有操作的跟踪信息。错误信息具体异常信息页面输入/输出名称内容输入点击功能按钮输出跟踪日志详细信息详细信息包括：日期时间、日志记录者、日志等级、操作、和日志消息。错误信息具体异常信息页面3.2.3.7 查看跟踪日志（1）概述：业务管理员用户通过该模块查看流程操作的跟踪信息。（2）过程详述：业务管理员进入该模块后显示跟踪日志信息列表，选择某一具体跟踪日志记录可查看详细信息：日期时间、日志记录者、日志等级、操作、调用的方法、文件和方法在文件中的行数。（3）输入/输出数据输入/输出名称内容输入点击功能按钮输出日志列表所有操作的日志信息。错误信息具体异常信息页面输入/输出名称内容输入点击功能按钮输出跟踪日志详细信息详细信息包括：日期时间、日志记录者、日志等级、操作、调用的方法、文件和方法在文件中的行数。错误信息具体异常信息页面3.2.3.8 查看历史信息（1）概述：业务管理员用户通过该模块查看执行完成的流程相关历史信息。（2）过程详述：业务管理员进入该模块后显示历史信息列表，选择某一具体历史记录可查看某实例及实例中所有任务的详细信息。实例信息包括：实例的名称、版本、创建日期、完成日趋、创建者和该流程实例中的变量。任务信息包括：任务名称、状态、角色、执行者、类型、是否可预测、任务描述、任务开始日期、完成日期和该任务中包含的所有变量信息。（3）输入/输出数据：输入/输出名称内容输入点击功能按钮输出流程模型列表所有操作完成的流程模型错误信息具体异常信息页面输入/输出名称内容输入点击功能按钮输出流程实例列表某个流程模型的所有的实例及完成时间。错误信息具体异常信息页面输入/输出名称内容输入点击功能按钮输出流程实例详细信息包括该实例的名称、版本、创建日期、完成日趋、创建者和该流程实例中的变量。另外还有该实例所包含的所有任务信息：任务列表，每项任务的执行者及开始日期。错误信息具体异常信息页面输入/输出名称内容输入点击功能按钮输出任务详细信息任务信息包括：任务名称、状态、角色、执行者、类型、是否可预测、任务描述、任务开始日期、完成日期和该任务中包含的所有变量信息。错误信息具体异常信息页面3.2.4 用户操作本模块供流程参与人员，即流程任务执行用户使用。3.2.4.1 查看可启动的流程（1）概述：查看当前登录用户可以启动的流程。（2）过程详述：用户进入该模块后，点击该模块导航按钮会列出该用户可以启动的流程列表。（3）输入/输出数据：输入/输出名称内容输入无输出流程名称流程版本流程状态流程创建者流程创建日期流程当前用户流程当前角色启动流程操作3.2.4.2 启动流程模型（1）概述：该模块实现登录用户启动流程模型。（2）过程详述：用户在查看可启动的流程时，点击具体流程，可以查看流程的详细信息及启动操作。用户通过启动操作启动该流程。如果流程没有需要输入的相关变量，操作成功则提示某流程的一个实例提交成功；如果流程需要输入相关流程变量，则进入流程变量输入页面，根据提示操作直到流程启动成功。如果流程启动失败，则进入异常页面，提示具体的操作失败信息。（3）输入/输出数据：输入/输出名称内容输入点击开始按钮输出成功信息该模型的某个实例提交成功。失败信息具体异常信息页面3.2.4.3 查看运行中的流程实例（1）概述：查看本用户参与的正在运行中的流程实例。（2）过程详述：用户进入该模块后，点击该模块导航按钮会列出该用户参与的正在运行中的流程实例。用户可以查看某流程实例的详细信息：流程实例名称、版本、状态、当前运行的活动、角色、承担者。（3）输入/输出数据：输入/输出名称内容输入无输出流程实例名称流程实例的版本流程实例的状态流程实例当前运行的活动流程实例的角色流程实例的承担者3.2.4.4 执行流程任务（1）概述：查看当前当前登录用户所承担的流程任务列表。（2）过程详述：用户进入该模块后，点击该模块导航按钮会列出该用户需要执行的流程任务列表。选择某一具体任务，进入任务执行页面，按提示操作直至任务结束。（3）输入/输出数据：输入/输出名称内容输入工作列表输出流程任务列表具体需要执行的流程任务输入/输出名称内容输入流程任务相关输入输出成功信息任务执行成功错误信息具体异常信息页面3.2.4.5 查看已完成的任务（1）概述