前台详细设计文档——专业版本

前台详细设计文档——专业版本 ChinaPostService 作者：陈国煊 修正： 完成日期：二〇〇九年十二月三十日 签收人： 签收日期： 1 引言........................................................................................................................................... 3 1.1 编写目的 ....................................................................................................................... 3 1.2 读者对象 ....................................................................................................................... 3 1.3 参考资料 ....................................................................................................................... 3 2 范围........................................................................................................................................... 3 2.1 系统主要目标 ............................................................................................................... 3 2.1.1 客户授权信息 ................................................................................................... 3 2.1.2 短信任务生成 ................................................................................................... 4 2.1.3 短信发送 ........................................................................................................... 4 2.1.4 短信接收 ........................................................................................................... 4 2.1.5 通讯录 ............................................................................................................... 4 2.1.6 短信汇总统计 ................................................................................................... 4 2.2 实现 ....................................................................................................................... 5 3 软件系统结构设计 ................................................................................................................... 5 3.1 软件体系结构图 ........................................................................................................... 5 3.2 短信服务系统功能结构图 ........................................................................................... 6 4 程序功能/模块设计说明.......................................................................................................... 6 4.1 白名单导入 ................................................................................................................... 6 4.1.1 白名单导入 ....................................................................................................... 6 4.2 短信审批 ....................................................................................................................... 7 4.2.1 短信审批 ........................................................................................................... 7 4.3 流程业务 ....................................................................................................................... 8 4.3.1 业务管理 ........................................................................................................... 8 4.3.2 变量管理 ......................................................................................................... 11 4.3.3 运行记录 ......................................................................................................... 12 4.3.4 流程定义 ......................................................................................................... 13 4.3.5 短信审批 ......................................................................................................... 14 4.3.6 发送短信 ......................................................................................................... 15 4.3.7 内容转换 ......................................................................................................... 17 4.3.8 查询操作 ......................................................................................................... 18 4.3.9 非查询操作 ..................................................................................................... 20 4.3.10 截取字符串 ..................................................................................................... 21 4.3.11 索引 ................................................................................................................. 22 4.3.12 获取信息开头 ................................................................................................. 23 4.3.13 批量发送 ......................................................................................................... 24 4.3.14 网络服务 ......................................................................................................... 26 4.3.15 条件分支 ......................................................................................................... 27 4.3.16 闹钟唤醒 ......................................................................................................... 28 4.3.17 内容分析 ......................................................................................................... 29 4.4 通讯录 ......................................................................................................................... 30 4.4.1 群组管理 ......................................................................................................... 30 4.4.2 联系人 ............................................................................................................. 32 4.4.3 导入联系人 ..................................................................................................... 34 4.4.4 导出联系人 ..................................................................................................... 35 4.4.5 高级查询 ......................................................................................................... 36 4.5 SP号码管理 ............................................................................................................... 38 4.5.1 SP号码管理 ................................................................................................... 38 4.6 回执调用 ..................................................................................................................... 39 4.6.1 回执调用 ......................................................................................................... 39 1 1.1 本说明书针对邮政短信业务系统，概括地描述了系统的设计，它以需求 说明为依据；同时该文档将作为产品的实现与进度控制的依据。并作为二次 开发的参考资料。 1.2 开发人员、测试人员，项目经理，二次开发人员等关系人。 1.3 短信服务系统需求规格说明书.doc 2 2.1 邮政短信业务系统：以广州市邮政局现有的短信接口作为统一的“自 邮一族”短信服务端口，与移动、联通及电信公司申请相应的短信发送接口， 并与我局现有台实现互联；实现的功能有：客户授权信息、短信任务生成、 短信发送、短信接收、短信汇总统计等功能。 2.1.1 通过MO服务：该功能，可查询会员的短信授权日期、授权手机号码、 会员信息、服务项目。另外，系统需要提供相关的数据导入接口，允许按照既定 的文件向系统导入客户数据，相关客户数据导入后先与已有数据进行匹配， 对已存在数据进行更新，对于未存在的新数据则生成新的客户数据。 2.1.2 系统根据服务类型和客户资料，自动生成或手工生成短信任务。每个短信任 务包括发送对象，发送时间，发送内容三部分内容，在设定相关变量后，系统自 动根据呼出的变量设置从客户数据库中提取相关的客户数据，生成相关短信任 务。 2.1.3 根据系统生成的短信任务列，向目标对象发送对应短信内容。包括业务提 醒、服务通知、产品信息和活动通知、节日祝福等内容。该功能窗口拥有导入、 添加接收人，添加、撰写短信内容，发送短信，保存短信等功能。 2.1.4 通过该功能可查询由客户端发送的信息，包括查询短信、预定短信、反馈 短信等类型。 2.1.5 该功能包括联系人组操作、联系人操作、查找联系人、导入/导出联系人等功能。 2.1.6 通过该功能，可查看客户发送和接收的短信历史详情；可实现对短信发送 记录的查询和发送成功与否的历史统计；同时可导出发送失败的记录以作重发操 作；通过汇总分析短信数据，以提高服务针对性和有效性。 2.2 本系统在已有的web功能与短信网关相关功能的基础进行开发。 页面系统由 1) 白名单导入。 2) 短息审批。 3) 流程业务。 4) 报表设计。 5) 通讯录管理。 6) SP号码管理。 7) 回执调用。 7大部分组成 3 3.1 图：3.1 3.2 短信服务系统功能结构图 白名单导入短息审批流程业务通讯录管理回执调用SP号码管理 群组管理 新增变量流程业务记录查看高级查询 导出通讯录 MT流程子流程MO流程导入通讯录 联系人管理 1.内容分析 2.内容转换 3.条件分支 4.截取字符串 5.索引 6.获取信息开头 7.查询操作 添加SP号码删除业务大类新增业务大类8.非查询操作 9.存储过程 10.批量发送短信 11.闹钟唤醒 12.发送短信 13.网络服务 14.短信审批 图：3.2 4 / 4.1 4.1.1 编号：WHITELIST 名称 白名单导入 模块代号 WHITELIST 功能 导入CSV文件（以逗号隔开的文本文件），导入到白名单数据表 要求 无 限制条件 以逗号隔开的文本文件或CSV文件 输 入 1. 以逗号隔开的文本文件或CSV文件 输 出 无 算法逻辑 无 TableServlet 相关对象 Org.mo4j.servlet.备注 及接口 1. 电话号码：存储白名单电话号码 4.2 4.2.1 编号：sms_approval 名称 查询操作 模块代号 sms_approval 功能 使用空闲（非待审批状态）的短信审批流程，实现相似的功能 要求 必须选择空闲的流程 限制条件 正确的语句 输 入 空闲审批，审批内容，发送号码，审批号码 算法逻辑 无 相关对象 Org.mo4j.servlet.buinessServlet 及接口 备注 无 如表在所述 4.3 4.3.1 编号：buiness 名称 查询操作 模块代号 buiness 功能 在系统里面新增，修改，删除一个业务 要求 无 限制条件 必须选择SP号码 业务名称，业务代码，上下行，业务大类，sp号码，状态报告支持， 算法逻辑 无 输 入 业务说明，使用用户，优先级，运行状态相关对象 Org.mo4j.servlet.buinessServlet 及接口 新增，修改业务 如表在所述 4.3.2 编号：DBNotSelect 名称 非查询操作 模块代号 DBNotSelect 功能 新增，修改，删除变量 要求 无 限制条件 无 输 入 变量名称，变量类型，变量描述 算法逻辑 无 相关对象 org.mo4j.servlet.varDef 及接口 备注 删除后影响环节使用 如表在所述 4.3.3 编号：runrecord 名称 运行记录 模块代号 runrecord 功能 查看业务运行状态 要求 无 输 入 无 输 出 运行记录 算法逻辑 无 相关对象 Org.mo4j.serblet.AjaxServlet 及接口 备注 MO和MT的显示条目不同 如表在所述 4.3.4 编号：Process 名称 流程定义 模块代号 Process 功能 新增，修改，删除相关流程() 要求 无 输 入 流程名称,流程类型,手机号码变量，手机内容变量，短信编号变量 输 出 无 算法逻辑 无 相关对象 Org.mo4j.serblet.ProcessSteps 及接口 备注 MO和MT的显示显示位置不一样,包含MO流程,MT流程,子流程 如表在所述 4.3.5 编号：SMS_Approval 名称 短信审批 模块代号 SMS_Approval 功能 审批业务短信，待审批通过后下发业务短信给对象 要求 限制条件 输 入 1.填写短信类容 2.填写审批内容 3.导入发送号码 输 出 无 算法逻辑 相关对象 环节功能，要在业务流程在体现 及接口 备注 发送号码导入必须是CSV逗号隔开文件 如表在所述 4.3.6 编号：SendSMS 名称 发送短信 模块代号 SendSMS 功能 发送短信 要求 只适用于MO 限制条件 1.发送对象（指定对象，变量指定）2.单条发送，多条发送 输 入 3.源地址尾码 4.业务代码 输 出 无 算法逻辑 相关对象 Org.mo4j.servlet.kindOfSteps Org.mo4j.dao.SendMessageDAO 及接口 备注 如表在所述 4.3.7 编号：ContentConversion 名称 内容转换 模块代号 ContentConversion 功能 内容转换 要求 只适用于MO 限制条件 输 入 1.被转换内容变量（全大写，全小写，启用字典）2.转换后赋予变量 输 出 无 算法逻辑 相关对象 Org.mo4j.servlet.kindOfSteps Org.mo4j.dao.ContentConversionDAO 及接口 备注 如表在所述 4.3.8 编号：Select 名称 查询操作 模块代号 select 功能 查询操作 要求 限制条件 1.默认访问数据库2.查询语句 3记录集赋予变量 4.数据行赋予变量 输 入 5.行6.列7根据行列赋予到变量8.数据库异常跳转 9.语句执行异常跳转 输 出 无 算法逻辑 相关对象 Org.mo4j.servlet.kindOfSteps Org.mo4j.dao.SelectDAO 及接口 备注 如表在所述 4.3.9 编号：NotSelect 名称 非查询操作 模块代号 Notselect 功能 非查询操作 要求 限制条件 输 入 1.默认访问数据库2.查询语句8.数据库异常跳转 9.语句执行异常跳转 输 出 无 算法逻辑 相关对象 Org.mo4j.servlet.kindOfSteps Org.mo4j.dao.NotSelectDAO 及接口 备注 如表在所述 4.3.10 编号：SubString 名称 截取字符串 模块代号 SubString 功能 截取字符串 要求 限制条件 输 入 1.指定截取2.结束指定4.结果集赋予 输 出 无 算法逻辑 相关对象 Org.mo4j.servlet.kindOfSteps Org.mo4j.dao.SubStringDAO 及接口 备注 如表在所述 4.3.11 编号：Index 名称 索引 模块代号 Index 功能 索引 要求 限制条件 输 入 1.字符串来源变量2.索引字符4.记录索引位置变量 输 出 无 算法逻辑 相关对象 Org.mo4j.servlet.kindOfSteps Org.mo4j.dao.IndexDAO 及接口 备注 如表在所述 4.3.12 编号：startwith 名称 获取信息开头 模块代号 startwith 功能 获取信息开头 要求 限制条件 输 入 1.开头字符串2.开头字符串变量3.结束字符串变量 输 出 无 算法逻辑 相关对象 Org.mo4j.servlet.kindOfSteps Org.mo4j.dao.StartWithDAO 及接口 备注 如表在所述 4.3.13 编号：SendMSMS 名称 批量发送短信 模块代号 SendMSMS 批量发送短信（与发送短信功能雷同，增加发送时间限制，与二维数组与记录集二功能 个字段） 要求 限制条件 类型对应 1.发送对象2.内容指定（直接指定，变量指定）3.发送时间段（开始-结束时间） 输 入 4.源地址尾码 5.业务代码 输 出 无 算法逻辑 相关对象 Org.mo4j.servlet.kindOfSteps Org.mo4j.dao.SendMSMSDAO 及接口 备注 如表在所述 4.3.14 编号：WebServices 名称 网络服务 模块代号 WebServices 功能 动态调用WebServices 要求 必须按循序获取 限制条件 输 入 1.url地址 2.服务名称 3 接口名称 4.方法名称 5. 参数列表 6.返回值变量 输 出 无 算法逻辑 org.apache.axis工具 相关对象 Org.mo4j.servlet.kindOfSteps Org.mo4j.dao.WebServicesDAO 及接口 备注 如表所述 4.3.15 编号：Branch 名称 条件分支 模块代号 Branch 功能 按Velocity(Velocity 的模板语言)分析语句，按结果执行不同的跳转 要求 无 限制条件 模板语言 输 入 1.Velocity语句 2.跳转种类 3.跳转目标 4.跳转结果 输 出 无 算法逻辑 无 相关对象 Org.mo4j.servlet.kindOfSteps Org.mo4j.dao.BranchDAO 及接口 备注 如表在所述 4.3.16 编号：Clock 名称 闹钟唤醒 模块代号 Clock 功能 在有效期日期，有效天，有效时间段内，按指定分隔唤醒。 要求 无 限制条件 无 输 入 1.类型 2.时间间隔 3.有效时间 4.每天触发时间 输 出 无 算法逻辑 相关对象 Org.mo4j.servlet.kindOfSteps Org.mo4j.dao.ClockDAO 及接口 备注 类型分为每日 和 每周两种 如表在所述 4.3.17 编号：Analysis 名称 内容分析 模块代号 Analysis 功能 按指定的分隔符对内容进行分析 要求 无 限制条件 无 输 入 1.类型 2.时间间隔 3.有效时间 4.每天触发时间 输 出 无 算法逻辑 相关对象 Org.mo4j.servlet.kindOfSteps Org.mo4j.dao.AnalysisDAO 及接口 备注 如表在所述 4.4 4.4.1 编号：groupManager 名称 群组管理 模块代号 groupManager 功能 可以对通讯录群组进行新增，修改，删除操作 要求 无 限制条件 无 输 入 1.群组名 2.维护用户 3.使用用户 4.上级通讯录 输 出 无 算法逻辑 相关对象 org.mo4j.servlet.ContactServlet Org.mo4j.dao.ContactDAO 及接口 备注 选择相应的群组可以新增，修改，删除相应群组 如表在所述 4.4.2 编号：contactor 名称 群组管理 模块代号 contactor 功能 可以对联系人进行新增，修改，删除操作 要求 无 限制条件 无 1.姓名 2.手机号码 3.性别 4.电话 5.电子邮件 6.工作单位 7.身份证号码 输 入 8.职务 9.生日 10.备注 11.所属群组 输 出 无 算法逻辑 相关对象 org.mo4j.servlet.ContactServlet Org.mo4j.dao.ContactDAO 及接口 备注 如表在所述 4.4.3 编号：InputContactor 名称 导入联系人 模块代号 InputContactor 功能 可以批量添加联系人 要求 无 限制条件 无 1.选择要导入的群组 2.选择文件路径 3.选择字段对应的excel列位（可以选择输 入 不输入） 输 出 无 算法逻辑 相关对象 org.mo4j.servlet.ContactServlet Org.mo4j.dao.ContactDAO 及接口 备注 现在只支持EXCEL 文件的导入 第一步 第二步 4.4.4 编号：OutputContactor 名称 导出联系人 模块代号 OutputContactor 功能 可以批量导出联系人进行文件保存 要求 无 限制条件 无 输 入 可以选择群组及其子群组 进行导出 输 出 无 算法逻辑 相关对象 org.mo4j.servlet.ContactServlet Org.mo4j.dao.ContactDAO 及接口 备注 现在只支持EXCEL 文件的导入 4.4.5 编号：hight_select 名称 高级查询 模块代号 hight_select 功能 根据群组，姓名，手机号码，性别，工作单位作为条件进行查询 要求 无 限制条件 无 输 入 群组(可选)，姓名(可选)，手机号码(可选)，性别(可选)，工作单位(可选) 输 出 无 算法逻辑 相关对象 org.mo4j.servlet.ContactServlet Org.mo4j.dao.ContactDAO 及接口 备注 查询条件 查询结果 4.5 SP 4.5.1 SP 编号：spmanager 名称 Sp号码管理 模块代号 spmanager 功能 可以创建新的业务大类并向其添加所属的sp号码 要求 无 限制条件 无 输 入 输入sp号码 输 出 无 算法逻辑 相关对象 org.mo4j.servlet.SPServlet 及接口 备注 Sp号码不能重复 Sp号码管理 如表在所述 4.6 4.6.1 编号：huizhi 名称 回执调用 模块代号 huizhi 功能 可以创建新的业务大类并向其添加所属的sp号码 要求 无 限制条件 无 输 入 输入sp号码 输 出 无 算法逻辑 相关对象 org.mo4j.servlet.SPServlet 及接口 备注 Sp号码不能重复