流程管理概要设计说明书.docx

1、流程管理概要设计说明书表目录图目录 NetParser管理工具及Syslog Parser概要设计说明书关键词：NetParser, Admin Tools, syslog 数据采集器，守护程序摘 要： NetParser的后台程序由守护程序启动，并接受守护程序的监控。后台程序包括Syslog数据采集器和报表生成器。后台程序与守护程序之间的通信采用Socket通信。缩略语清单：Abbreviations缩略语Full spelling 英文全名Chinese explanation 中文解释NPNetParser华为宽带性能管理系统阿Admin ToolsAdmin Tools管理工具：对用户

2、、配置和资源进行管理HBHeart Beater守护程序，监视着后台的两个进程:Syslog数据采集器和报表生成器，若有进程不处于运行状态，守护程序则对其进行重启。1 简介1.1目的本文是AP OMS流程管理功能模块的概要设计说明书。AP OMS中的流程定义的注册、注销以及流程监控、流程实例的操作都是通过本模块来进行处理。采用Web GUI的方式提供用户入口。本概要设计是软件开发人员进行详细设计和编码实现的指南。1.2范围1.2.1软件名称APSoft Order Manager System 流程管理模块1.2.2 软件功能要实现的软件功能包括：流程注册模块流程注销模块流程监控模块启动工单模

3、块暂停工单模块恢复工单模块终止工单模块完成工单模块人工干预模块1.2.3软件应用本模块为AP OMS中的一部分，主要包括流程的注册、注销、监控以及工单的启动、暂停、恢复、终止、完成等功能。2第0层设计描述2.1软件系统上下文定义图1 流程管理功能模块上下文定义图 3第一层设计描述3.1系统结构3.1.1系统结构描述3.1.2红色框图部分为本文所涉及的模块 图2 AP OMS流程管理系统结构图3.1.3业务流程说明图3 NetPaser后台业务流程图图5是主服务器和从服务器都具有的功能。Parse 文件将数据写入数据库中的原始数据表、用户上网统计表，月用户上网统计表、上线失败原因统计表，下线失败

4、原因统计表。图3的功能模块只在主服务器具有，用来统计5分钟间隔数据中需要原始表和临时表产生的数据。 图4 辅Syslog Parser 业务流程图图5 主 Syslog Parser 业务流程图3.2分解描述本文包括的模块有：注册流程、注销流程、流程监控、启动工单、暂停工单、恢复工单、终止工单、完成工单及人工干预九个模块。3.2.1注册流程模块描述1.简介注册流程模块用于将设计完成的流程定义注册到AP OMS中。2.功能列表1)查询流程定义信息2)注册流程3数据设计1)流程名称信息描述 标识：ProcessName 类型： 目的：用于记录流程定义的名字2)流程版本信息描述标识：ProcessV

5、ersion类型：目的： 用于记录注册流程的版本.3)流程注册标志信息描述标识：RegisterFlag类型：目的： 用于记录流程定义是否已经注册到AP OMS的标志信息3.2.2注销流程模块描述1.简介注销流程模块用于从AP OMS中移除已注册的流程定义。2.功能列表1)查询已注册的流程2)注销流程3.数据设计1)流程名称信息描述 标识：ProcessName 类型： 目的：用于记录流程定义的名字2)流程版本信息描述标识：ProcessVersion类型：目的： 用于记录注册流程的版本.3)流程注册标志信息描述标识：RegisterFlag类型：目的： 用于记录流程定义是否已经注册到AP O

6、MS的标志信息。3.2.3流程监控模块描述1.简介流程监控模块用于实时监控流程执行实例的执行状态，包括查看流程定义、流程执行实例和任务的相关信息。2.功能列表1)查询流程定义数据信息。2)查询流程执行实例数据信息。3)查询任务数据信息。3.数据设计1)流程名称信息描述 标识：ProcessName 类型： 目的：用于记录流程定义的名字2)流程实例名称信息描述标识：ProcessInstanceName类型：目的： 用于记录流程执行实例的名称.3)流程状态信息描述标识：ProcessStatus类型：目的： 用于记录流程执行实例的状态3.2.4启动工单模块描述1.简介启动工单模块用于启动工单对应

7、的流程实例2.功能列表1)启动工单。3.数据设计4)流程名称信息描述 标识：ProcessName 类型： 目的：用于记录流程定义的名字5)流程实例名称信息描述标识：ProcessInstanceName类型：目的： 用于记录流程执行实例的名称.6)流程状态信息描述标识：ProcessStatus类型：目的： 用于记录流程执行实例的状态3.2.5暂停工单模块描述1.简介暂停工单模块用于暂停工单的流程实例。2.功能列表1)查询出流程状态为启动状态的工单信息，并将信息列出给用户浏览。2)暂停工单3.数据设计7)流程名称信息描述 标识：ProcessName 类型： 目的：用于记录流程定义的名字8)

8、流程实例名称信息描述标识：ProcessInstanceName类型：目的： 用于记录流程执行实例的名称.9)流程状态信息描述标识：ProcessStatus类型：目的： 用于记录流程执行实例的状态3.2.6恢复工单模块描述1.简介恢复工单模块用于恢复处于暂停状态的工单，使之处于正常运行状态。2.功能列表1)查询出流程状态为暂停状态的工单信息，并将信息列出给用户浏览。2)恢复工单。3.数据设计1)流程名称信息描述 标识：ProcessName 类型： 目的：用于记录流程定义的名字2)流程实例名称信息描述标识：ProcessInstanceName类型：目的： 用于记录流程执行实例的名称.3)流

9、程状态信息描述标识：ProcessStatus类型：目的： 用于记录流程执行实例的状态3.2.7终止工单模块描述1.简介终止工单模板用于终止工单流程2.功能列表1)查询出流程状态为未完成或未终止状态的工单信息，并将信息列出给用户浏览。2)终止工单。3.数据设计1)流程名称信息描述 标识：ProcessName 类型： 目的：用于记录流程定义的名字2)流程实例名称信息描述标识：ProcessInstanceName类型：目的： 用于记录流程执行实例的名称.3)流程状态信息描述标识：ProcessStatus类型：目的： 用于记录流程执行实例的状态3.2.8完成工单模块描述1.简介完成工单模块用于

10、完成工单的流程实例。2.功能列表1)查询出流程状态为未完成或未终止状态的工单信息，并将信息列出给用户浏览。2)完成工单。3.数据设计1)流程名称信息描述 标识：ProcessName 类型： 目的：用于记录流程定义的名字2)流程实例名称信息描述标识：ProcessInstanceName类型：目的： 用于记录流程执行实例的名称.3)流程状态信息描述标识：ProcessStatus类型：目的： 用于记录流程执行实例的状态3.2.9人工干预模块描述1.简介人工干预模块用于流程执行过程中出现异常情况，由人工进行干预处理。2.功能列表1)查询出需要进行干预的工单信息，并将信息列出给用户浏览。2)人工干

11、预处理。3.数据设计1)流程名称信息描述 标识：ProcessName 类型： 目的：用于记录流程定义的名字2)流程实例名称信息描述标识：ProcessInstanceName类型：目的： 用于记录流程执行实例的名称.3)流程状态信息描述标识：ProcessStatus类型：目的： 用于记录流程执行实例的状态。3.3依赖性描述用户登录AP OMS成功并且用户具有流程管理的功能权限。3.4接口描述3.4.1注册流程模块的接口描述名称：注册流程的接口说明：封装exFlow注册流程的接口，供web端调用 定义： 3.4.2注销流程模块的接口描述名称：注销流程的接口说明：此接口为封装exFlow注销流

12、程的接口，供web端调用 定义： 3.4.3查询流程模块的接口描述名称：查询流程定义的接口说明：此接口为封装exFlow查询流程定义的接口，供web端调用 定义：名称：查询流程实例的接口说明：此接口为封装exFlow查询流程实例信息的接口，供web端调用定义：名称：查询任务的接口说明：此接口为封装exFlow查询流程实例的任务信息的接口，供web端调用 定义：3.4.4启动工单模块的接口描述名称：启动工单接口说明：此接口为封装exFlow启动流程实例的接口，供web端调用 定义： 3.4.5暂停工单模块的接口描述名称：暂停工单接口说明：此接口为封装exFlow暂停流程实例的接口，供web端调用

13、 定义：3.4.6恢复工单模块的接口描述名称：恢复工单接口说明：此接口为封装exFlow恢复流程实例的接口，供web端调用 定义： 3.4.7终止工单模块的接口描述名称：终止工单接口说明：此接口为封装exFlow终止流程实例的接口，供web端调用 定义：3.4.8完成工单模块的接口描述名称：完成工单接口说明：此接口为封装exFlow完成流程实例的接口，供web端调用 定义： 3.4.9人工干预模块的接口描述名称：说明：定义： 4第二层设计描述流程管理功能主要包括注册流程、注销流程、流程监控、启动工单、暂停工单、恢复工单、终止工单、完成工单和人工干预共九个模块。 4.1注册流程模块4.1.1设计

14、描述注册流程模块实现的功能：将设计完成的流程定义注册到AP OMS 中。1.ProcessDefinitionAgent1)标识 AP OMS - ProcessManager - ProcessDefinitionAgent2)简介实现流程定义的注册，注册流程定义到AP OMS中，如果流程定义已经注册到AP OMS，则提示已经注册。3)类定义class ProcessDefinitionAgentprotected: String definitionName;public:ProcessDefinitionAgent (); ProcessDefinitionAgent (String d

15、efinitionName);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 ProcessDefinitionAgentprotec

16、ted: 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 - ProcessMana

17、ger - ProcessDefinitionQuery2） 简介 用于查询流程定义的相关信息数据，包括流程名称、流程定义的任务名称、流程相关参数。3）类定义class ProcessDefinitionQuery:public: ProcessDefinitionQuery (); protected:String definitionName;String definitionId;Map relevantData;Map taskpublic: ProcessDefinitionContextCollection listProcessDefinitions (); ProcessRel

18、evantDataDefinitionCollection getProcessRelevantDataDefinition (String definitionId);ProcessDefinitionContext findProcessDefinitionById (String definitionId); ProcessDefinitionContext findProcessDefinitionByName(String definitionName);2.ProcessInstanceQuery1）标识 AP OMS - Resource - ProcessInstanceQue

19、ry2） 简介 用于查询流程实例的相关信息数据，包括流程名称、流程实例名称、流程实例状态、流程实例相关参数、已执行任务名称、已执行任务状态、未执行任务名称、未执行任务状态。3）类定义class ProcessInstanceQuery:public: ProcessInstanceQuery (); virtual ProcessInstanceQuery (); protected:String definitionName;String definitionId;String instanceId;public:ProcessInstanceContext findProcessInsta

20、nce(String instanceId); ProcessInstanceContextCollection listProcessInstances(); ProcessInstanceContextCollection listProcessInstancesByStatus(String status);ProcessInstanceContextCollection findProcessInstanceByTaskId(String taskId);ProcessInstanceContextCollection findPIByStatusNoSubFlow(String st

21、atus); ProcessRelevantDataCollection getProcessRelevantData(String sInstanceId);String findProcessInstanceIDByTaskId(String taskId);String findMainFlowInstanceId(String subInstanceId);Vector listPINamesByStatus(String sStatus)；3.ProcessTaskQuery1）标识 AP OMS - Resource - ProcessTaskQuery2） 简介 用于查询流程实例

22、中的任务信息数据，包括任务名称、任务相关参数、任务状态、任务完成状态、任务开始时间、任务结束时间、任务执行角色、任务执行用户。3）定义class ProcessTaskQuery : public: ProcessTaskQuery (); protected:String sTaskId;String sInstanceId;TaskContext taskContext; public:Collection listTasks(String sInstanceID); Collection listTasksByStatus(String sInstanceID, String sStat

23、us); 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设计描述启动工单模块用于启动工单

24、对应的流程实例。1.ProcessInstanceMgr1）标识 AP OMS - ProcessManager - ProcessInstanceMgr2） 简介用于启动工单对应的流程实例,包括创建工单实例、启动工单实例。3）类定义class ProcessInstanceMgr:public: ProcessInstanceMgr (); protected:static String sDefinitionID;static String sDefinitionName;static String sInstanceName;static String sInstanceDescript

25、ion;static TimeLimit aTimeLimit;ProcessRelevantDataCollection processRelevantDataCollection;ProcessInstanceContext processInstanceContext;public:ProcessInstanceContext createProcessInstanceByName(String sDefinitionName,String sInstanceName,String sInstanceDescription);ProcessInstanceContext createPr

26、ocessInstance(String sDefinitionID,String sInstanceName,String sInstanceDescription);ProcessRelevantDataCollection getProcessRelevantData();void setProcessRelevantData(ProcessRelevantDataCollection aProcessRelevantDataCollection);bool startProcessInstance(); TimeLimit getTimeLimit();Void setTimeLimi

27、t(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 s

28、uspendProcessInstance(String instanceId); 4.5.2功能实现说明图10 设备端口管理模块的Sequence图4.6恢复工单模块4.6.1设计描述恢复工单模块用于恢复流程实例状态为暂停状态的工单。1.ProcessInstanceMgr1）标识 AP OMS - ProcessManager - ProcessInstanceMgr2） 简介用于恢复流程实例状态为暂停状态的工单，使工单流程实例可以继续执行流程。3）类定义class ProcessInstanceMgr:public: ProcessInstanceMgr (); void resumeP

29、rocessInstance();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设计描述完成