APOMS流程管理概要设计手册模板.doc

AP OMS步骤管理概要设计说明书 Prepared by 拟制Date日期Reviewed by 评审人Date日期Approved by同意Date日期修订统计日期修订版本CR号修改章节修改描述作者 目 录1介绍131.1目标131.2范围131.2.1软件名称131.2.2软件功效131.2.3软件应用132第0层设计描述132.1软件系统上下文定义133第一层设计描述143.1系统结构143.1.1系统结构描述153.1.2业务步骤说明163.2分解描述203.2.1资源导入管理模块描述203.2.2资源导出管理模块描述223.2.3地域管理模块描述223.2.4设备管理模块描述233.2.5端口管理模块描述243.2.6PVC资源管理模块描述243.2.7用户管理模块描述25数据异常显示管理模块描述263.2.9系统配置模块描述263.2.10数据库管理策略设置模块273.2.11系统管理模块273.2.12Radius失败原因管理模块描述273.2.13守护进程模块描述283.2.14Syslog采集器通信模块283.2.15Syslog采集器解释模块293.2.16Syslog采集器缓冲数据处理模块323.3依靠性描述343.4接口描述353.4.1资源管理模块接口描述353.4.2用户管理模块接口描述353.4.3安全管理模块接口描述353.4.4数据库管理模块接口描述353.4.5系统配置模块接口描述353.4.6系统管理模块363.4.7Radius失败原因管理模块接口描述363.4.8守护进程模块接口描述363.4.9Syslog采集器通信模块接口描述373.4.10Syslog采集器解释模块接口描述373.4.11Syslog采集器缓冲数据处理模块接口描述384第二层设计描述384.1资源导入管理模块394.1.1设计描述394.1.2功效实现说明414.2资源导出管理模块414.2.1资源导出管理模块设计描述424.2.2功效实现说明424.3地域管理模块434.3.1地域管理模块设计描述434.3.2功效实现说明444.4设备管理模块454.4.1设备管理模块设计描述454.4.2功效实现说明474.5端口管理模块474.5.1端口管理模块设计描述474.5.2功效实现说明494.6PVC资源管理模块504.6.1PVC资源管理模块设计描述504.6.2功效实现说明534.7用户管理模块534.7.1用户管理模块设计描述534.7.2功效实现说明55数据异常显示管理模块56数据异常显示管理模块设计描述564.8.2功效实现说明574.9系统配置管理模块584.9.1系统配置管理模块设计描述584.9.2功效实现说明584.10数据库管理策略设置模块594.10.1数据库管理策略设置模块设计描述594.10.2功效实现说明60运行管理模块60运行管理模块设计描述604.12Radius错误原因管理模块664.12.1Radius错误原因管理模块设计描述664.12.2功效实现说明674.13守护进程模块684.13.1守护进程模块设计描述684.13.2功效实现说明754.14Syslog采集器通信模块774.14.1模块设计描述774.14.2功效实现说明794.15Syslog采集器解释模块794.15.1模块设计描述794.15.2功效实现说明934.16Syslog采集器缓冲数据处理模块934.16.1模块设计描述934.16.2功效实现说明975数据库设计975.1实体定义975.1.1分解描述975.1.2内部依靠性描述1075.2行为定义1095.2.1分解描述1095.2.2外部依靠性描述1105.2.3内部依靠性描述1106组件视图1116.1系统运行组件1117进程视图1118需求追踪视图112表目录表1 需求追踪图1113表2 需求追踪图2113图目录图1 NetParser和外围系统之间关系14图2 NetParser系统结构图15图3 SyslogParser系统结构图16图4 NetPaser后台业务步骤图17图5 辅Syslog Parser 业务步骤图18图6 主 Syslog Parser 业务步骤图19图7 Syslog采集器解释模块步骤图30图8 Syslog采集器输入检验步骤图31图9 Syslog失败原因计数31图10 Syslog采集器数据缓冲处理模块步骤图33图11 Syslog采集器登出失败原因为端口down等处理步骤34图12 资源输入模块Sequence图41图13 资源导出管理模块Sequence图43图14 地域管理模块Sequence图45图15 设备管理模块Sequence图47图16 设备端口管理模块Sequence图50图17 PVC资源管理模块Sequence图53图18 用户管理模块Sequence图55图19 告警设置模块Sequence图57图20 系统配置模块Sequence图59图21 数据库管理策略设置模块Sequence图60图22 系统管理模块Sequence图66图23 Radius错误原因管理模块Sequence图68图24 进程守护模块Sequence图77图25 Syslog采集器通信模块Sequence图79图26 NetParser资源实体和性能E-R图109图27 Syslog采集器组件视图111图28 NetParser后台进程视图112 NetParser管理工具及Syslog Parser概要设计说明书关键词：NetParser, Admin Tools, syslog 数据采集器，守护程序摘 要：NetParser后台程序由守护程序开启，并接收守护程序监控。后台程序包含Syslog数据采集器和报表生成器。后台程序和守护程序之间通信采取Socket通信。缩略语清单：Abbreviations缩略语Full spelling 英文全名Chinese explanation 汉字解释NPNetParser华为宽带性能管理系统阿Admin ToolsAdmin Tools管理工具：对用户、配置和资源进行管理HBHeart Beater守护程序，监视着后台两个进程:Syslog数据采集器和报表生成器，若有进程不处于运行状态，守护程序则对其进行重启。1 介绍1.1 目标本文是AP OMS步骤管理功效模块概要设计说明书。AP OMS中步骤定义注册、注销和步骤监控、步骤实例操作全部是经过本模块来进行处理。采取Web GUI方法提供用户入口。本概要设计是软件开发人员进行具体设计和编码实现指南。1.2 范围1.2.1 软件名称APSoft Order Manager System 步骤管理模块1.2.2 软件功效要实现软件功效包含： 步骤注册模块 步骤注销模块 步骤监控模块 开启工单模块 暂停工单模块 恢复工单模块 终止工单模块 完成工单模块 人工干预模块1.2.3 软件应用本模块为AP OMS中一部分，关键包含步骤注册、注销、监控和工单开启、暂停、恢复、终止、完成等功效。2 第0层设计描述2.1 软件系统上下文定义图1 步骤管理功效模块上下文定义图 3 第一层设计描述3.1 系统结构3.1.1 系统结构描述红色框图部分为本文所包含模块图2 AP OMS步骤管理系统结构图3.1.2 业务步骤说明图3 NetPaser后台业务步骤图图5是主服务器和从服务器全部含有功效。Parse 文件将数据写入数据库中原始数据表、用户上网统计表，月用户上网统计表、上线失败原因统计表，下线失败原因统计表。图3功效模块只在主服务器含有，用来统计5分钟间隔数据中需要原始表和临时表产生数据。 图4 辅Syslog Parser 业务步骤图图5 主 Syslog Parser 业务步骤图3.2 分解描述本文包含模块有：注册步骤、注销步骤、步骤监控、开启工单、暂停工单、恢复工单、终止工单、完成工单及人工干预九个模块。3.2.1 注册步骤模块描述1. 介绍注册步骤模块用于将设计完成步骤定义注册到AP OMS中。2. 功效列表1) 查询步骤定义信息2) 注册步骤3数据设计1) 步骤名称信息描述 标识：ProcessName 类型： 目标：用于统计步骤定义名字2) 步骤版本信息描述标识：ProcessVersion类型：目标： 用于统计注册步骤版本.3) 步骤注册标志信息描述标识：RegisterFlag类型：目标： 用于统计步骤定义是否已经注册到AP OMS标志信息3.2.2 注销步骤模块描述1. 介绍注销步骤模块用于从AP OMS中移除已注册步骤定义。2. 功效列表1) 查询已注册步骤2) 注销步骤3. 数据设计1) 步骤名称信息描述 标识：ProcessName 类型： 目标：用于统计步骤定义名字2) 步骤版本信息描述标识：ProcessVersion类型：目标： 用于统计注册步骤版本.3) 步骤注册标志信息描述标识：RegisterFlag类型：目标： 用于统计步骤定义是否已经注册到AP OMS标志信息。3.2.3 步骤监控模块描述1. 介绍步骤监控模块用于实时监控步骤实施实例实施状态，包含查看步骤定义、步骤实施实例和任务相关信息。2. 功效列表1) 查询步骤定义数据信息。2) 查询步骤实施实例数据信息。3) 查询任务数据信息。3. 数据设计1) 步骤名称信息描述 标识：ProcessName 类型： 目标：用于统计步骤定义名字2) 步骤实例名称信息描述标识：ProcessInstanceName类型：目标： 用于统计步骤实施实例名称.3) 步骤状态信息描述标识：ProcessStatus类型：目标： 用于统计步骤实施实例状态3.2.4 开启工单模块描述1. 介绍开启工单模块用于开启工单对应步骤实例2. 功效列表1) 开启工单。3. 数据设计4) 步骤名称信息描述 标识：ProcessName 类型： 目标：用于统计步骤定义名字5) 步骤实例名称信息描述标识：ProcessInstanceName类型：目标： 用于统计步骤实施实例名称.6) 步骤状态信息描述标识：ProcessStatus类型：目标： 用于统计步骤实施实例状态3.2.5 暂停工单模块描述1. 介绍暂停工单模块用于暂停工单步骤实例。2. 功效列表1) 查询出步骤状态为开启状态工单信息，并将信息列出给用户浏览。2) 暂停工单3. 数据设计7) 步骤名称信息描述 标识：ProcessName 类型： 目标：用于统计步骤定义名字8) 步骤实例名称信息描述标识：ProcessInstanceName类型：目标： 用于统计步骤实施实例名称.9) 步骤状态信息描述标识：ProcessStatus类型：目标： 用于统计步骤实施实例状态3.2.6 恢复工单模块描述1. 介绍恢复工单模块用于恢复处于暂停状态工单，使之处于正常运行状态。2. 功效列表1) 查询出步骤状态为暂停状态工单信息，并将信息列出给用户浏览。2) 恢复工单。3. 数据设计1) 步骤名称信息描述 标识：ProcessName 类型： 目标：用于统计步骤定义名字2) 步骤实例名称信息描述标识：ProcessInstanceName类型：目标： 用于统计步骤实施实例名称.3) 步骤状态信息描述标识：ProcessStatus类型：目标： 用于统计步骤实施实例状态3.2.7 终止工单模块描述1. 介绍终止工单模板用于终止工单步骤2. 功效列表1) 查询出步骤状态为未完成或未终止状态工单信息，并将信息列出给用户浏览。2) 终止工单。3. 数据设计1) 步骤名称信息描述 标识：ProcessName 类型： 目标：用于统计步骤定义名字2) 步骤实例名称信息描述标识：ProcessInstanceName类型：目标： 用于统计步骤实施实例名称.3) 步骤状态信息描述标识：ProcessStatus类型：目标： 用于统计步骤实施实例状态3.2.8 完成工单模块描述1. 介绍完成工单模块用于完成工单步骤实例。2. 功效列表1) 查询出步骤状态为未完成或未终止状态工单信息，并将信息列出给用户浏览。2) 完成工单。3. 数据设计1) 步骤名称信息描述 标识：ProcessName 类型： 目标：用于统计步骤定义名字2) 步骤实例名称信息描述标识：ProcessInstanceName类型：目标： 用于统计步骤实施实例名称.3) 步骤状态信息描述标识：ProcessStatus类型：目标： 用于统计步骤实施实例状态3.2.9 人工干预模块描述1. 介绍人工干预模块用于步骤实施过程中出现异常情况，由人工进行干预处理。2. 功效列表1) 查询出需要进行干预工单信息，并将信息列出给用户浏览。2) 人工干预处理。3. 数据设计1) 步骤名称信息描述 标识：ProcessName 类型： 目标：用于统计步骤定义名字2) 步骤实例名称信息描述标识：ProcessInstanceName类型：目标： 用于统计步骤实施实例名称.3) 步骤状态信息描述标识：ProcessStatus类型：目标： 用于统计步骤实施实例状态。3.3 依靠性描述用户登录AP OMS成功而且用户含有步骤管理功效权限。3.4 界面描述3.4.1 注册步骤模块接口描述名称：注册步骤接口说明：封装exFlow注册步骤接口，供web端调用定义： 3.4.2 注销步骤模块接口描述名称：注销步骤接口说明：此接口为封装exFlow注销步骤接口，供web端调用定义： 3.4.3 查询步骤模块接口描述名称：查询步骤定义接口说明：此接口为封装exFlow查询步骤定义接口，供web端调用定义：名称：查询步骤实例接口说明：此接口为封装exFlow查询步骤实例信息接口，供web端调用定义：名称：查询任务接口说明：此接口为封装exFlow查询步骤实例任务信息接口，供web端调用定义：3.4.4 开启工单模块接口描述名称：开启工单接口说明：此接口为封装exFlow开启步骤实例接口，供web端调用定义： 3.4.5 暂停工单模块接口描述名称：暂停工单界面说明：此接口为封装exFlow暂停步骤实例接口，供web端调用 定义：3.4.6 恢复工单模块接口描述名称：恢复工单界面说明：此接口为封装exFlow恢复步骤实例接口，供web端调用定义： 3.4.7 终止工单模块接口描述名称：终止工单接口说明：此接口为封装exFlow终止步骤实例接口，供web端调用定义：3.4.8 完成工单模块接口描述名称：完成工单接口说明：此接口为封装exFlow完成步骤实例接口，供web端调用定义： 3.4.9 人工干预模块接口描述名称：说明：定义： 4 第二层设计描述步骤管理功效关键包含注册步骤、注销步骤、步骤监控、开启工单、暂停工单、恢复工单、终止工单、完成工单和人工干预共九个模块。4.1 注册步骤模块4.1.1 设计描述注册步骤模块实现功效：将设计完成步骤定义注册到AP OMS 中。1. ProcessDefinitionAgent1) 标识 AP OMS - ProcessManager - ProcessDefinitionAgent2) 介绍实现步骤定义注册，注册步骤定义到AP OMS中，假如步骤定义已经注册到AP OMS，则提醒已经注册。3) 类定义class ProcessDefinitionAgentprotected:String definitionName;public:ProcessDefinitionAgent ();ProcessDefinitionAgent (String definitionName);public:bool register();bool unRegister();4.1.2 功效实现说明图6 资源输入模块Sequence图4.2 注销步骤模块4.2.1 设计描述注销步骤模块用于将已注册步骤定义从AP OMS中移除。1. ProcessDefinitionAgent1） 标识 AP OMS - ProcessManager - ProcessDefinitionAgent2） 介绍 用于将已注册步骤定义从AP OMS中移除，注销后步骤定义在 AP OMS中不可用3） 类定义class ProcessDefinitionAgentprotected:String definitionName;public:ProcessDefinitionAgent ();ProcessDefinitionAgent (String definitionName);public:bool register();bool unRegister();4.2.2 功效实现说明图7 资源导出管理模块Sequence图4.3 步骤监控模块4.3.1 设计描述步骤监控模块用于实时监控步骤实施实例实施状态，包含查看步骤定义、步骤实施实例和任务相关信息。1. ProcessDefinitionQuery1） 标识 AP OMS - ProcessManager - ProcessDefinitionQuery2） 介绍 用于查询步骤定义相关信息数据，包含步骤名称、步骤定义任务名称、步骤相关参数。3） 类定义class ProcessDefinitionQuery:public:ProcessDefinitionQuery ();protected:String definitionName;String definitionId;Map relevantData;Map taskpublic:ProcessDefinitionContextCollection listProcessDefinitions ();ProcessRelevantDataDefinitionCollection getProcessRelevantDataDefinition (String definitionId);ProcessDefinitionContext findProcessDefinitionById (String definitionId);ProcessDefinitionContext findProcessDefinitionByName(String definitionName);2. ProcessInstanceQuery1） 标识 AP OMS - Resource - ProcessInstanceQuery2） 介绍 用于查询步骤实例相关信息数据，包含步骤名称、步骤实例名称、步骤实例状态、步骤实例相关参数、已实施任务名称、已实施任务状态、未实施任务名称、未实施任务状态。3） 类定义class ProcessInstanceQuery:public:ProcessInstanceQuery ();virtual ProcessInstanceQuery ();protected:String definitionName;String definitionId;String instanceId;public:ProcessInstanceContext findProcessInstance(String instanceId);ProcessInstanceContextCollection listProcessInstances();ProcessInstanceContextCollection listProcessInstancesByStatus(String status);ProcessInstanceContextCollection findProcessInstanceByTaskId(String taskId);ProcessInstanceContextCollection findPIByStatusNoSubFlow(String status);ProcessRelevantDataCollection getProcessRelevantData(String sInstanceId);String findProcessInstanceIDByTaskId(String taskId);String findMainFlowInstanceId(String subInstanceId);Vector listPINamesByStatus(String sStatus)；3. ProcessTaskQuery1） 标识 AP OMS - Resource - ProcessTaskQuery2） 介绍 用于查询步骤实例中任务信息数据，包含任务名称、任务相关参数、任务状态、任务完成状态、任务开始时间、任务结束时间、任务实施角色、任务实施用户。3） 定义class ProcessTaskQuery : public:ProcessTaskQuery ();protected:String sTaskId;String sInstanceId;TaskContext taskContext;public:Collection listTasks(String sInstanceID);Collection listTasksByStatus(String sInstanceID, String sStatus);Collection listTasksByStatus(String sStatus);TaskContext findTask(String sTaskId)Collection listTasksByRoleID(String sRoleID);Collection listTasksByUserID(String sUserID);TaskRelevantDataCollection getTaskRelevantData(String sTaskId)4.3.2 功效实现说明图8 地域管理模块Sequence图4.4 开启工单模块4.4.1 设计描述开启工单模块用于开启工单对应步骤实例。1. ProcessInstanceMgr1） 标识 AP OMS - ProcessManager - ProcessInstanceMgr2） 介绍用于开启工单对应步骤实例,包含创建工单实例、开启工单实例。3） 类定义class ProcessInstanceMgr:public:ProcessInstanceMgr ();protected:static String sDefinitionID;static String sDefinitionName;static String sInstanceName;static String sInstanceDescription;static TimeLimit aTimeLimit;ProcessRelevantDataCollection processRelevantDataCollection;ProcessInstanceContext processInstanceContext;public:ProcessInstanceContext createProcessInstanceByName(String sDefinitionName,String sInstanceName,String sInstanceDescription);ProcessInstanceContext createProcessInstance(String sDefinitionID,String sInstanceName,String sInstanceDescription);ProcessRelevantDataCollection getProcessRelevantData();void setProcessRelevantData(ProcessRelevantDataCollection aProcessRelevantDataCollection);bool startProcessInstance();TimeLimit getTimeLimit();Void setTimeLimit(TimeLimit aTimeLimit);4.4.2 功效实现说明图9 设备管理模块Sequence图4.5 暂停工单模块4.5.1 设计描述暂停工单模块用于暂停工单步骤实例。1. ProcessInstanceMgr1） 标识 AP OMS - ProcessManager - ProcessInstanceMgr2） 介绍用于暂停工单步骤实例，暂停步骤实例将不继续实施步骤，直到步骤实例被恢复。3） 类定义class ProcessInstanceMgr:public:ProcessInstanceMgr ();void suspendProcessInstance();void suspendProcessInstance(String instanceId);4.5.2 功效实现说明图10 设备端口管理模块Sequence图4.6 恢复工单模块4.6.1 设计描述恢复工单模块用于恢复步骤实例状态为暂停状态工单。1. ProcessInstanceMgr1） 标识 AP OMS - ProcessManager - ProcessInstanceMgr2） 介绍用于恢复步骤实例状态为暂停状态工单，使工单步骤实例能够继续实施步骤。3） 类定义class ProcessInstanceMgr:public:ProcessInstanceMgr ();void resumeProcessInstance();void resumeProcessInstance(String instanceId);4.6.2 功效实现说明图11 PVC资源管理模块Sequence图4.7 终止工单模块4.7.1 设计描述终止工单模块用于终止在实施中工单步骤实例。1. ProcessInstanceMgr1） 标识 AP OMS - ProcessManager - ProcessInstanceMgr2） 介绍终止工单模块用于用于终止在实施中工单步骤实例，使该步骤实例状态变为终止状态。3） 类定义class ProcessInstanceMgr:public:ProcessInstanceMgr ();void terminateProcessInstance();void terminateProcessInstance(String instanceId);4.7.2 功效实现说明图12 用户管理模块Sequence图4.8 完成工单模块4.8.1 设计描述完成工单模块用于完成步骤实施中工单。1. ProcessInstanceMgr1） 标识 NetParser- ProcessManager - ProcessInstanceMgr2） 介绍用于用于完成步骤实施中工单3） 类定义class ProcessInstanceMgr:public:ProcessInstanceMgr ();void completeProcessInstance();void completeProcessInstance(String instanceId);4.8.2 功效实现说明图13 告警设置模块Sequence图4.9 人工干预模块4.9.1 设计描述人工干预模块用于步骤实施过程中出现异常情况，由人工进行干预处理。1. ProcessManualInterveneMgr1） 标识 AP OMS - ProcessManager - ProcessManualInterveneMgr2） 介绍 人工干预模块用于步骤实施过程中出现异常情况，由人工进行干预处理，从而使步骤能够继续正常实施。3） 类定义class ProcessManualInterveneMgr: public:ProcessManualInterveneMgr ();protected:String instanceId;public:void updateTaskStatus(String taskId,String status);void nextTask(String taskId);void backTask(String taskId);void setTaskRelevantData(TaskRelevantDataCollection dataCollection);void addTaskUserId(String taskId,String userId);void addTaskRoleId(String tasked,String roleId);4.9.2 功效实现说明图14 系统配置模块Sequence图5 数据库设计5.1 实体定义5.1.1 分解描述NetParser后台程序中关键包含管理配置，Syslog采集器和报表生成器。所要用到数据有资源数据，资源映像数据，用户数据和系统配置数据。1. 资源数据表其中资源数据包含资源表，设备表，设备埠表，设备主控板类型表。1） 资源表定义NPResource存放这NetParser所用到全部设备埠资源。当有统计插入到NPDevice表或NPDevicePort表时，首先插入NPResource表中，生成ObjectID, 即得到对应DeviceID和PortID, 将这些ID值插入导NPDevice表和NPDevicePort表中。各属性值描述以下：objectID: 设备索引值， identity. 它等于DeviceID, 当设备类型为NPDevice时，和PortID当设备类型为NPDevicePort时。不可为空。objType: 设备类型， 现在只有两个值：NPDevice和NPDevicePort。不可为空2） 设备表定义此表存放是从Resource资源文件中读入设备数据，各属性意义为：deviceID: 设备索引值。不可为空name: 设备名称。不可为空ipAddress: 设备IP地址，索引。不可为空version: 设备