EMS能源管理平台移动应用App概要设计说明书 V1.00

智慧运维手机APP For EMSV1.5.0概要设计说明书V1.00EMS V1.5.0 能源管理平台移动APP 概要设计说明书文件编号生效日期受控编号保密级别版 本 号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 引言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 APP功能需求2.3.2 非功能需求（1）安全可靠千兆接入网络，支持大规模并发数据流量接入;（2）对主要数据和功能进行安全隔离；（3）具备统一的运行监管功能，对主要模块的运行状态进行统一监管，要求具有良好的运行监测、负载监控管理、流量监控、故障分析和故障恢复能力；（4）智慧运维，整体方案中数据处理协议和关键业务数据算法模块支持升级替换，利于第三方接入和投资保护；（5）数据安全保护，支持安全加密，完善的数据备份和容灾备份方案。（6）响应性能。在公网部署的情况下，平台带宽要求大于等于5M，最大连接数40台。APP需尽量节省流量，需要在后台的数据和页面尽量减少流量的消耗，单页面流量不大于2M。网络正常情况下，单个页面响应速度不超过5S。2.4 条件与限制本文档仅针对EMSV1.5.0APP的需求开发，本文档中的“本APP”、“APP”等词通指EMSV1.5.0 APP系统。3 总体设计3.1 设计原则由于APP for EMSV1.5.0的目标是为客户的运维人员提供一套有效的移动端运维管理工具，借助此工具能够查询到企业当前的能耗使用状态和设备产生的告警信息，同时能够对告警进行直接处理。因此本APP是一个应用场景清晰、功能明确、实时性要求高的移动端能耗运维管理利器，在开发本APP时，一定要在设计规划阶段进行细致认真的工作，确定APP的目标，这样才能保证APP构建的顺利进行和规避不必要的风险。以下是在系统建设过程中所需要遵循的一些原则。3.1.1 阶段性  考虑到我司APP产品建设是一项长久的工程，因此系统建设可以分成多个阶段来逐步实现。基于之前的APP系统已经有一定的设计经验积累，在此次开发的阶段重点需要解决之前版本中的不足和缺憾，加以改善和解决。以达到此版本APP开发后能够确定APP产品体系的明确和优势所在。随着时间的推移及企业的发展，逐渐拓展新的移动运维需求，并将新的需求融入到APP体系中，从而最终实现一个可靠、可扩展的APP产品。 3.1.2 先进性  作为支撑公司EMS产品线移动端运维需要的重要APP版本，在APP的设计过程中，还必须强调先进性。保证APP未来的生命力，能够满足一定时间段内用户运维的需要。 3.1.3 低流量消耗  为方便用户运维人员实时运维需要，APP会在多种网络环境下使用，因此APP不宜消耗太多流量，APP与服务器之间通讯尽量简化，减少非必要的数据传输。 3.1.4 高性能  作为一套实时操作的APP产品，需要达到较高的性能要求。才能较好支撑用户运维人员的实时运维需要。 3.1.5 易用性  为便于不同类型用户的使用，APP风格确定为简洁、大方。每个页面展示一个主题内容。字体字号美观大气，易于辨认。操作路径不宜过深。 3.1.6 安全性  由于移动设备往往能有效标记用户的身份，因此APP的安全性尤为重要。设计时必须考虑各种场景下的安全信息。安全性是整个APP正常发展的基础保障。 3.1.7 稳定性 若APP本身如果不稳定，经常崩溃、退出，则用户必定会产生极大抵触情绪，所以APP的稳定是APP产品成功的命脉所在。3.2 总体结构 系统整体分为3层，其中数据层的功能是持久化存储各模块的数据。平台处理层分为两部分，一部分是APP公共管理平台，由我司运维部（市场部）进行管理维护。提供APP版本管理、动态、APP用户意见反馈管理等。另一部分是客户企业内的EMSV1.5.0平台，主要提供APP用户的登录、登出、能耗模块查询、告警模块查询处理等功能。业务展现层的功能为，从移动APP端提供辅助客户运维人员的能耗查询界面、告警查询处理界面、APP版本升级、意见反馈、常见问题获取等功能，为用户提供专业的运维工具和APP辅助功能。3.3 总体方案总体方案如上图所示。APP通过无线网络（2G/3G/4G/WIFI）访问服务器中的API。由于APP公共管理平台的接口要保持一致性和可访问性，同时鉴于无法确定的保持某公网环境可持续用于APP公共管理平台，此处做出以下处理方案。首先搭建我司APP统一的APP管理平台，假如约定放在“10.xx.xx.56”服务器的6000端口上。其次在我司官网域名下开启二级域名地址用于部署一个服务接口，用于提供可用APP公共管理平台可用的最新地址。当APP分发时，APP默认与约定的“10.xx.xx.56”地址的6000端口建立连接，如果可用，则进行关联。如果发现无响应或返回错误信息，则尝试连接开启的公司官网特定二级域名下的特定接口服务，根据其返回最新的可用的APP公共管理平台地址，并覆盖写入原有默认的地址。3.4 模块功能APP for EMSV1.5.0功能实现包含两部分：一部分是APP侧，另一部分是平台侧。平台侧分两部分，一部分是EMSV1.5.0平台，另一部分是由公司统一维护的APP公共管理平台。APP中的用户登录、能耗、告警、用户登出由EMSV1.5.0平台提供服务。APP版本更新、公司产品推介、意见反馈等功能由APP公共管理平台提供支撑。本说