流程管理概要设计说明书.docx
《流程管理概要设计说明书.docx》由会员分享，可在线阅读，更多相关《流程管理概要设计说明书.docx（53页珍藏版）》请在冰豆网上搜索。
流程管理概要设计说明书
表目录
图目录
NetParser管理工具及SyslogParser概要设计说明书
关键词：
NetParser,AdminTools,syslog数据采集器，守护程序
摘要：
NetParser的后台程序由守护程序启动，并接受守护程序的监控。
后台程序包括Syslog数据采集器和报表生成器。
后台程序与守护程序之间的通信采用Socket通信。
缩略语清单：
Abbreviations缩略语
Fullspelling英文全名
Chineseexplanation中文解释
NP
NetParser
华为宽带性能管理系统
阿AdminTools
AdminTools
管理工具：
对用户、配置和资源进行管理
HB
HeartBeater
守护程序，监视着后台的两个进程:
Syslog数据采集器和报表生成器，若有进程不处于运行状态，守护程序则对其进行重启。
1
简介
1.1目的
本文是APOMS－流程管理功能模块的概要设计说明书。
APOMS中的流程定义的注册、注销以及流程监控、流程实例的操作都是通过本模块来进行处理。
采用WebGUI的方式提供用户入口。
本概要设计是软件开发人员进行详细设计和编码实现的指南。
1.2范围
1.2.1软件名称
APSoftOrderManagerSystem－流程管理模块
1.2.2软件功能
要实现的软件功能包括：
∙流程注册模块
∙流程注销模块
∙流程监控模块
∙启动工单模块
∙暂停工单模块
∙恢复工单模块
∙终止工单模块
∙完成工单模块
∙人工干预模块
1.2.3软件应用
本模块为APOMS中的一部分，主要包括流程的注册、注销、监控以及工单的启动、暂停、恢复、终止、完成等功能。
2第0层设计描述
2.1软件系统上下文定义
图1流程管理功能模块上下文定义图
3第一层设计描述
3.1系统结构
3.1.1系统结构描述
3.1.2
红色框图部分为本文所涉及的模块
图2APOMS流程管理系统结构图
3.1.3业务流程说明
图3NetPaser后台业务流程图
图5是主服务器和从服务器都具有的功能。
Parse文件将数据写入数据库中的原始数据表、用户上网统计表，月用户上网统计表、上线失败原因统计表，下线失败原因统计表。
图3的功能模块只在主服务器具有，用来统计5分钟间隔数据中需要原始表和临时表产生的数据。
图4辅SyslogParser业务流程图
图5主SyslogParser业务流程图
3.2分解描述
本文包括的模块有：
注册流程、注销流程、流程监控、启动工单、暂停工单、恢复工单、终止工单、完成工单及人工干预九个模块。
3.2.1注册流程模块描述
1.简介
注册流程模块用于将设计完成的流程定义注册到APOMS中。
2.功能列表
1）查询流程定义信息
2）注册流程
3．数据设计
1）流程名称信息描述
标识：
ProcessName
类型：
目的：
用于记录流程定义的名字
2）流程版本信息描述
标识：
ProcessVersion
类型：
目的：
用于记录注册流程的版本.
3）流程注册标志信息描述
标识：
RegisterFlag
类型：
目的：
用于记录流程定义是否已经注册到APOMS的标志信息
3.2.2注销流程模块描述
1.简介
注销流程模块用于从APOMS中移除已注册的流程定义。
2.功能列表
1）查询已注册的流程
2）注销流程
3.数据设计
1）流程名称信息描述
标识：
ProcessName
类型：
目的：
用于记录流程定义的名字
2）流程版本信息描述
标识：
ProcessVersion
类型：
目的：
用于记录注册流程的版本.
3）流程注册标志信息描述
标识：
RegisterFlag
类型：
目的：
用于记录流程定义是否已经注册到APOMS的标志信息。
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依赖性描述
用户登录APOMS成功并且用户具有流程管理的功能权限。
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设计描述
注册流程模块实现的功能：
将设计完成的流程定义注册到APOMS中。
1.ProcessDefinitionAgent
1）标识
APOMS-ProcessManager-ProcessDefinitionAgent
2）简介
实现流程定义的注册，注册流程定义到APOMS中，如果流程定义已经注册到APOMS，则提示已经注册。
3）类定义
classProcessDefinitionAgent
{
protected:
StringdefinitionName;
public:
ProcessDefinitionAgent（）;
ProcessDefinitionAgent（StringdefinitionName）;
public:
boolregister（）;
boolunRegister（）;
};
4.1.2功能实现说明
图6资源输入模块的Sequence图
4.2注销流程模块
4.2.1设计描述
注销流程模块用于将已注册的流程定义从APOMS中移除。
1.ProcessDefinitionAgent
1）标识
APOMS-ProcessManager-ProcessDefinitionAgent
2）简介
用于将已注册的流程定义从APOMS中移除，注销后的流程定义在APOMS中不可用
3）类定义
classProcessDefinitionAgent
{
protected:
StringdefinitionName;
public:
ProcessDefinitionAgent（）;
ProcessDefinitionAgent（StringdefinitionName）;
public:
boolregister（）;
boolunRegister（）;
};
4.2.2功能实现说明
图7资源导出管理模块的Sequence图
4.3流程监控模块
4.3.1设计描述
流程监控模块用于实时监控流程执行实例的执行状态，包括查看流程定义、流程执行实例和任务的相关信息。
1.ProcessDefinitionQuery
1）标识
APOMS-ProcessManager-ProcessDefinitionQuery
2）简介
用于查询流程定义的相关信息数据，包括流程名称、流程定义的任务名称、流程相关参数。
3）类定义
classProcessDefinitionQuery:
{
public:
ProcessDefinitionQuery（）;
protected:
StringdefinitionName;
StringdefinitionId;
MaprelevantData;
Maptask
public:
ProcessDefinitionContextCollectionlistProcessDefinitions（）;
ProcessRelevantDataDefinitionCollectiongetProcessRelevantDataDefinition（StringdefinitionId）;
ProcessDefinitionContextfindProcessDefinitionById（StringdefinitionId）;
ProcessDefinitionContextfindProcessDefinitionByName（StringdefinitionName）;
}
2.ProcessInstanceQuery
1）标识
APOMS-Resource-ProcessInstanceQuery
2）简介
用于查询流程实例的相关信息数据，包括流程名称、流程实例名称、流程实例状态、流程实例相关参数、已执行任务名称、已执行任务状态、未执行任务名称、未执行任务状态。
3）类定义
classProcessInstanceQuery:
{
public:
ProcessInstanceQuery（）;
virtual~ProcessInstanceQuery（）;
protected:
StringdefinitionName;
StringdefinitionId;
StringinstanceId;
public:
ProcessInstanceContextfindProcessInstance（StringinstanceId）;
ProcessInstanceContextCollectionlistProcessInstances（）;
ProcessInstanceContextCollectionlistProcessInstancesByStatus（Stringstatus）;
ProcessInstanceContextCollectionfindProcessInstanceByTaskId（StringtaskId）;
ProcessInstanceContextCollectionfindPIByStatusNoSubFlow（Stringstatus）;
ProcessRelevantDataCollectiongetProcessRelevantData（StringsInstanceId）;
StringfindProcessInstanceIDByTaskId（StringtaskId）;
StringfindMainFlowInstanceId（StringsubInstanceId）;
VectorlistPINamesByStatus（StringsStatus）；
}
3.ProcessTaskQuery
1）标识
APOMS-Resource-ProcessTaskQuery
2）简介
用于查询流程实例中的任务信息数据，包括任务名称、任务相关参数、任务状态、任务完成状态、任务开始时间、任务结束时间、任务执行角色、任务执行用户。
3）定义
classProcessTaskQuery:
{
public:
ProcessTaskQuery（）;
protected:
StringsTaskId;
StringsInstanceId;
TaskContexttaskContext;
public:
CollectionlistTasks（StringsInstanceID）;
CollectionlistTasksByStatus（StringsInstanceID,StringsStatus）;
CollectionlistTasksByStatus（StringsStatus）;
TaskContextfindTask（StringsTaskId）
CollectionlistTasksByRoleID（StringsRoleID）;
CollectionlistTasksByUserID（StringsUserID）;
TaskRelevantDataCollectiongetTaskRelevantData（StringsTaskId）
}
4.3.2功能实现说明
图8地区管理模块的Sequence图
4.4启动工单模块
4.4.1设计描述
启动工单模块用于启动工单对应的流程实例。
1.ProcessInstanceMgr
1）标识
APOMS-ProcessManager-ProcessInstanceMgr
2）简介
用于启动工单对应的流程实例,包括创建工单实例、启动工单实例。
3）类定义
classProcessInstanceMgr:
{
public:
ProcessInstanceMgr（）;
protected:
staticStringsDefinitionID;
staticStringsDefinitionName;
staticStringsInstanceName;
staticStringsInstanceDescription;
staticTimeLimitaTimeLimit;
ProcessRelevantDataCollectionprocessRelevantDataCollection;
ProcessInstanceContextprocessInstanceContext;
public:
ProcessInstanceContextcreateProcessInstanceByName（StringsDefinitionName,StringsInstanceName,StringsInstanceDescription）;
ProcessInstanceContextcreateProcessInstance（StringsDefinitionID,StringsInstanceName,StringsInstanceDescription）;
ProcessRelevantDataCollectiongetProcessRelevantData（）;
voidsetProcessRelevantData（ProcessRelevantDataCollectionaProcessRelevantDataCollection）;
boolstartProcessInstance（）;
TimeLimitgetTimeLimit（）;
VoidsetTimeLimit（TimeLimitaTimeLimit）;
}
4.4.2功能实现说明
图9设备管理模块的Sequence图
4.5暂停工单模块
4.5.1设计描述
暂停工单模块用于暂停工单的流程实例。
1.ProcessInstanceMgr
1）标识
APOMS-ProcessManager-ProcessInstanceMgr
2）简介
用于暂停工单的流程实例，暂停的流程实例将不继续执行流程，直到流程实例被恢复。
3）类定义
classProcessInstanceMgr:
{
public:
ProcessInstanceMgr（）;
…
…
…
voidsuspendProcessInstance（）;
voidsuspendProcessInstance（StringinstanceId）;
}
4.5.2功能实现说明
图10设备端口管理模块的Sequence图
4.6恢复工单模块
4.6.1设计描述
恢复工单模块用于恢复流程实例状态为暂停状态的工单。
1.ProcessInstanceMgr
1）标识
APOMS-ProcessManager-ProcessInstanceMgr
2）简介
用于恢复流程实例状态为暂停状态的工单，使工单流程实例可以继续执行流程。
3）类定义
classProcessInstanceMgr:
{
public:
ProcessInstanceMgr（）;
…
…
…
voidresumeProcessInstance（）;
voidresumeProcessInstance（StringinstanceId）;
}
4.6.2功能实现说明
图11PVC资源管理模块的Sequence图
4.7终止工单模块
4.7.1设计描述
终止工单模块用于终止在执行中的工单流程实例。
1.ProcessInstanceMgr
1）标识
APOMS-ProcessManager-ProcessInstanceMgr
2）简介
终止工单模块用于用于终止在执行中的工单流程实例，使该流程实例的状态变为终止状态。
3）类定义
classProcessInstanceMgr:
{
public:
ProcessInstanceMgr（）;
…
…
…
voidterminateProcessInstance（）;
voidterminateProcessInstance（StringinstanceId）;
}
4.7.2功能实现说明
图12用户管理模块的Sequence图
4.8完成工单模块
4.8.1设计描述
完成
升级会员 