综合能源-智慧运维APP概要设计说明书

智慧运维手机APP 概要设计说明书文件编号生效日期受控编号保密级别版 本 号V1.02457003修改状态总 页 数正 文附 录编 制审 核批 准评审记录对智慧运维手机APP For EMSV1.5.0概要设计说明书V1.00的评审意见：上述问题修改验证后，由 验证后，本文件即可发布。评审人员签字：问题修改验证结果： 验证人签字： 时间： 变更日志编号版本修改内容修改人修改日期1V1.00定稿。目录1 引言71.1 编写目的71.2 项目背景71.3 定义71.4 参考资料82 任务概述82.1 任务目标82.2 运行环境82.3 需求概述92.3.1 功能需求92.3.2 非功能需求102.4 条件与限制103 总体设计103.1 设计原则103.2 总体结构123.3 总体方案133.4 模块功能133.4.1 用户登录143.4.2 能耗模块163.4.3 告警模块173.4.4 “更多”模块214 接口设计264.1 外部接口264.1.1 版本更新检查接口264.1.2 获取动态的更新提示服务264.1.3 查询新闻列表接口264.1.4 获取新闻详情接口274.1.5 提交反馈意见接口274.1.6 获取反馈意见列表接口284.1.7 获取反馈意见回复接口284.1.8 提交用户页面访问时长接口294.1.9 关于页面接口294.2 内部接口304.2.1 配置服务器信息接口304.2.2 用户登录接口304.2.3 用户登出接口304.2.4 获取当月能耗占比数据接口314.2.5 获取KPI信息接口314.2.6 获取区域树/业态树接口324.2.7 获取能耗分析数据接口324.2.8 获取告警统计接口（实时）334.2.8 获取告警筛选条件接口334.2.9 获取告警列表数据接口344.2.10 获取告警详情接口344.2.11 获取告警历史处理信息接口354.2.12 告警操作（确认、处理、撤销，单个/批量）接口355 错误处理设计365.1 系统级故障与错误365.1.1 服务器及移动端软硬件故障365.1.2 数据访问和存储能力366 安全保密设计371 引言71.1 编写目的71.2 项目背景71.3 定义71.4 参考资料82 任务概述82.1 任务目标82.2 运行环境82.3 需求概述92.3.1 功能需求92.3.2 非功能需求102.4 条件与限制103 总体设计103.1 设计原则103.2 总体结构123.3 总体方案123.4 模块功能133.4.1 APP侧143.4.2 平台侧254 接口设计284.1 外部接口284.1.1 版本更新检查接口284.1.2 获取天溯动态的更新提示服务294.1.2 获取公司及产品的推介服务294.1.3 获取知识分类接口294.1.4 获取某分类下的知识列表接口304.1.5 查询知识库列表接口304.1.6 获取某知识的详情接口314.1.7 提交反馈意见接口314.1.8 获取反馈意见回复接口314.1.9 提交用户页面访问时长接口324.2 内部接口324.2.1 配置服务器信息接口324.2.2 用户登录接口334.2.3 用户登出接口334.2.4 获取当月能耗总览信息接口334.2.5 获取当月能耗分析数据接口344.2.6 获取当月能耗KPI数据接口344.2.7 获取告警列表数据接口354.2.8 获取告警详情及历史处理信息接口354.2.9 告警确认接口364.2.10 告警处理接口364.2.11 告警处理撤销接口365 数据结构设计375.1 EMS1.31侧数据库设计375.2 公共平台侧数据库设计375.2.1 用户表（TB_USER）375.2.2 APP版本管理表（TB_APP_VERSION）385.2.3 APP天溯动态提示表（TB_NEWS_NOTIFICATION）385.2.4 知识表（TB_KNOWLEDGE）395.2.5 用户反馈意见及回复表（TB_USER_FEEDBACK_REPLY）395.2.6 客户表（TB_CUSTOM）405.2.7 用户访问统计表（TB_VISIT_STATISTICS）416 错误处理设计426.1 系统级故障与错误426.1.1 服务器及移动端软硬件故障426.1.2 数据访问和存储能力437 安全保密设计431 引言51.1 编写目的51.2 项目背景51.3 定义51.4 参考资料62 任务概述62.1 任务目标62.2 运行环境62.3 需求概述72.3.1 功能需求72.3.2 非功能需求82.4 条件与限制83 总体设计83.1 设计原则83.2 总体结构103.3 总体方案103.4 模块功能113.4.1 APP侧123.4.2 平台侧214 接口设计244.1 外部接口244.1.1 版本更新检查接口244.1.2 获取FAQ分类接口254.1.3 获取某分类下FAQ列表接口254.1.4 获取某FAQ详情接口264.1.5 提交反馈意见接口264.1.6 获取反馈意见回复接口274.1.7 提交用户页面访问时长接口274.2 内部接口274.2.1 配置服务器信息接口274.2.2 用户登录接口284.2.3 用户登出接口284.2.4 获取当月能耗总览信息接口294.2.5 获取当月能耗分析数据接口294.2.6 获取当月能耗KPI数据接口294.2.7 获取告警列表数据接口304.2.8 获取告警详情及历史处理信息接口304.2.9 告警确认接口314.2.10 告警处理接口314.2.11 告警处理撤销接口315 数据结构设计325.1 EMS1.31侧数据库设计325.2 公共平台侧数据库设计325.2.1 用户表（TB_USER）325.2.2 APP版本管理表（TB_APP_VERSION）325.2.3 常见问题表（TB_FAQ）335.2.4 用户反馈意见及回复表（TB_USER_FEEDBACK_REPLY）336 错误处理设计356.1 系统级故障与错误356.1.1 服务器及移动端软硬件故障356.1.2 数据访问和存储能力357 安全保密设计361 引言1.1 编写目的本文档是在智慧运维手机APP For EMSV1.5.0用户需求说明书的基础上，进行详细需求分解和技术应对后得出的概要设计说明书，旨在明确目标系统的总体结构、接口形式、数据模型，以及重要业务流程和对象的设计，并明确需求用例的各个功能点在架构中的体现，为后续的详细设计、编码实现以及产品测试等工作提供指导性规范。本文档预期读者包括：（1）技术营销人员、行业线解决方案设计人员、产品经理等需求侧的相关人员，用于明确和追踪软件产品需求的实现程度，验证需求实现中的正确性和完整性。（2）项目经理、系统工程师、研发工程师等研发侧的相关人员，用于理解软件系统组成、模块接口、数据模型以及整体技术要求，为后续详细设计和系统开发提供基础和依据；（3）测试工程师和品质管理人员，用于理解软件系统边界、组成和模块关系，确定测试方案和测试计划，进行软件质量管理。1.2 项目背景拟开发系统名称：本文档规范的软件系统是南京智慧运维手机APP For EMSV1.5.0，本项目简称EMS 1.5.0APP。项目提出者：南京项目开发者：南京研发中心本项目重点为EMSV1.5.0系统提供一套移动端应用程序，使得客户能够充分利用碎片化时间对其能源消耗情况和设备运行状况进行查询、管理。1.3 定义名词/缩略语英文中文含义APPApplication智能手机应用程序1.4 参考资料1、本项目的经核准的计划任务书或合同、上级机关的批文；（1）能源管理系统EMSV1.5.0用户需求说明书（2）智慧运维手机APP For EMSV1.5.0用户需求说明书2、属于本项目的其他已发表的文件暂无。3、其他参考的文件、资料和标准移动端技术选型报告Hybrid APP开发之IONIC开发方式的分析报告2 任务概述2.1 任务目标公司基于“平台战略”提出了智慧运维管理平台的移动端产品，目标是建立一个使客户便于使用、能利用碎片化时间，集能耗数据信息查询、告警信息查询、告警处理、意见反馈、公司产品推介、知识库等为一体的APP精品产品。在整体战略的驱动下，EMSV1.3 1APP研发的目标定位是在现有的EMS平台之外，再开拓出一个移动市场的产品线，利用目前移动化的趋势，充分满足客户多场景的运维管理的需要。2.2 运行环境本小节规定本项目开发和目标平台，以及测试部署使用的软硬件运行环境。本项目部分软硬件产品具备平台移植能力，通过微调和重新编译可适应新的软硬件平台。序号子系统设备要求1EMSV1.5.0APP兼容机型iPhone 5S、6、6S；三星GALAXY S4、S5、S6、Note 4、Note5；华为荣耀6、6Plus、7、P6、P7、P8；小米3、4、5；魅族MX3、MX4、MX5等。2兼容平台IOS、Android2.3 需求概述2.3.1 功能需求以下6个模块相关，13个接口需要修改。1.告警管理模块。2.驾驶舱模块。3.能耗展示模块。4.KPI管理模块。5.能耗累计算法与WEB端保持一致。6.同环比算法与WEB端保持一致。数据和用户权限用户数据权限修改为角色和APPALARM后台配置页面。图1 EMSV1.5.0