《综合能源-智慧运维APP概要设计说明书.pdf》由会员分享，可在线阅读，更多相关《综合能源-智慧运维APP概要设计说明书.pdf（23页珍藏版）》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。
1、智慧运维手机智慧运维手机 APP概要设计说明书概要设计说明书文件编号生效日期受控编号保密级别版 本 号V1.00修改状态总 页 数正文附录编制审核批准评审记录评审记录对智慧运维手机APP For EMSV1.5.0概要设计说明书V1.00的评审意见：上述问题修改验证后，由上述问题修改验证后，由验证后，本文件即可发布。验证后，本文件即可发布。评审人员签字：问题修改验证结果：验证人签字：时间：变更日志变更日志编号版本修改内容修改人修改日期1V1.00定稿。目录1 引言.61.1 编写目的.61.2 项目背景.61.3 定义.61.4 参考资料.72 任务概述.72.1 任务目标.72.2 运行环境
2、.72.3 需求概述.82.3.1 功能需求.82.3.2 非功能需求.82.4 条件与限制.93 总体设计.93.1 设计原则.93.2 总体结构.103.3 总体方案.113.4 模块功能.123.4.1 用户登录.错误！未定义书签。错误！未定义书签。3.4.2 能耗模块.错误！未定义书签。错误！未定义书签。3.4.3 告警模块.错误！未定义书签。错误！未定义书签。3.4.4“更多”模块.错误！未定义书签。错误！未定义书签。4 接口设计.错误！未定义书签。错误！未定义书签。4.1 外部接口.错误！未定义书签。错误！未定义书签。4.1.1 版本更新检查接口.错误！未定义书签。错误！未定义书签
3、。4.1.2 获取动态的更新提示服务.错误！未定义书签。错误！未定义书签。4.1.3 查询新闻列表接口.错误！未定义书签。错误！未定义书签。4.1.4 获取新闻详情接口.错误！未定义书签。错误！未定义书签。4.1.5 提交反馈意见接口.错误！未定义书签。错误！未定义书签。4.1.6 获取反馈意见列表接口.错误！未定义书签。错误！未定义书签。4.1.7 获取反馈意见回复接口.错误！未定义书签。错误！未定义书签。4.1.8 提交用户页面访问时长接口.错误！未定义书签。错误！未定义书签。4.1.9 关于页面接口.错误！未定义书签。错误！未定义书签。4.2 内部接口.124.2.1 配置服务器信息接口
4、.124.2.2 用户登录接口.错误！未定义书签。错误！未定义书签。4.2.3 用户登出接口.错误！未定义书签。错误！未定义书签。4.2.4 获取当月能耗占比数据接口.124.2.5 获取 KPI 信息接口.134.2.6 获取区域树/业态树接口.174.2.7 获取能耗分析数据接口.194.2.8 获取告警统计接口（实时）.194.2.8 获取告警筛选条件接口.194.2.9 获取告警列表数据接口.194.2.10 获取告警详情接口.204.2.11 获取告警历史处理信息接口.214.2.12 告警操作（确认、处理、撤销，单个/批量）接口.215 错误处理设计.225.1 系统级故障与错误.
5、225.1.1 服务器及移动端软硬件故障.225.1.2 数据访问和存储能力.226 安全保密设计.231 引言1.1 编写目的本文档是在智慧运维手机 APP For EMSV1.5.0 用户需求说明书的基础上，进行详细需求分解和技术应对后得出的概要设计说明书，旨在明确目标系统的总体结构、接口形式、数据模型，以及重要业务流程和对象的设计，并明确需求用例的各个功能点在架构中的体现，为后续的详细设计、编码实现以及产品测试等工作提供指导性规范。本文档预期读者包括：（1）技术营销人员、行业线解决方案设计人员、产品经理等需求侧的相关人员，用于明确和追踪软件产品需求的实现程度，验证需求实现中的正确性和完整
6、性。（2）项目经理、系统工程师、研发工程师等研发侧的相关人员，用于理解软件系统组成、模块接口、数据模型以及整体技术要求，为后续详细设计和系统开发提供基础和依据；（3）测试工程师和品质管理人员，用于理解软件系统边界、组成和模块关系，确定测试方案和测试计划，进行软件质量管理。1.2 项目背景拟开发系统名称：本文档规范的软件系统是南京智慧运维手机 APP For EMSV1.5.0，本项目简称 EMS 1.5.0APP。项目提出者：南京项目开发者：南京研发中心本项目重点为 EMSV1.5.0 系统提供一套移动端应用程序，使得客户能够充分利用碎片化时间对其能源消耗情况和设备运行状况进行查询、管理。1.
7、3 定义名词/缩略语英文中文含义APPApplication智能手机应用程序1.4 参考资料1、本项目的经核准的计划任务书或合同、上级机关的批文；（1）能源管理系统 EMSV1.5.0 用户需求说明书（2）智慧运维手机 APP For EMSV1.5.0 用户需求说明书2、属于本项目的其他已发表的文件暂无。3、其他参考的文件、资料和标准移动端技术选型报告HybridAPP 开发之 IONIC 开发方式的分析报告2 任务概述2.1 任务目标公司基于“平台战略”提出了智慧运维管理平台的移动端产品，目标是建立一个使客户便于使用、能利用碎片化时间，集能耗数据查询、告警信息查询、告警处理、意见反馈、公司
8、产品推介等为一体的 APP 精品产品。在整体战略的驱动下，EMSV1.3 1APP 研发的目标定位是在现有的 EMS 平台之外，再开拓出一个移动市场的产品线，利用目前移动化的趋势，充分满足客户多场景运维管理的需要。2.2 运行环境本小节规定本项目开发和目标平台，以及测试部署使用的软硬件运行环境。本项目部分软硬件产品具备平台移植能力，通过微调和重新编译可适应新的软硬件平台。序号子系统设备要求1EMSV1.5.0APP兼容机型iPhone5S、6、6S；三星GALAXYS4、S5、S6、Note4、Note5；华为荣耀6、6Plus、7、P6、P7、P8；小米3、4、5；魅族MX3、MX4、MX5
9、等。2兼容平台IOS、Android2.3 需求概述2.3.1 功能需求以下 6 个模块相关，13 个接口需要修改。1.告警管理模块。2.驾驶舱模块。3.能耗展示模块。4.KPI 管理模块。5.能耗累计算法与 WEB 端保持一致。6.同环比算法与 WEB 端保持一致。数据和用户权限用户数据权限修改为角色和 APPALARM 后台配置页面。图 1EMSV1.5.0APP 功能需求2.3.2 非功能需求（1）安全可靠千兆接入网络，支持大规模并发数据流量接入;（2）对主要数据和功能进行安全隔离；（3）具备统一的运行监管功能，对主要模块的运行状态进行统一监管，要求具有良好的运行监测、负载监控管理、流量
10、监控、故障分析和故障恢复能力；（4）智慧运维，整体方案中数据处理协议和关键业务数据算法模块支持升级替换，利于第三方接入和投资保护；（5）数据安全保护，支持安全加密，完善的数据备份和容灾备份方案。（6）响应性能。在公网部署的情况下，平台带宽要求大于等于 5M，最大连接数 40 台。APP 需尽量节省流量，需要在后台的数据和页面尽量减少流量的消耗，单页面流量不大于 2M。网络正常情况下，单个页面响应速度不超过 5S。2.4 条件与限制本文档仅针对 EMSV1.5.0APP 的需求开发，本文档中的“本 APP”、“APP”等词通指EMSV1.5.0APP 系统。3 总体设计3.1 设计原则由于 AP
11、P for EMSV1.5.0 的目标是为客户的运维人员提供一套有效的移动端运维管理工具，借助此工具能够查询到企业当前的能耗使用状态和设备产生的告警信息，同时能够对告警进行直接处理。因此本 APP 是一个应用场景清晰、功能明确、实时性要求高的移动端能耗运维管理利器，在开发本 APP 时，一定要在设计规划阶段进行细致认真的工作，确定 APP的目标，这样才能保证 APP 构建的顺利进行和规避不必要的风险。以下是在系统建设过程中所需要遵循的一些原则。3.1.1 阶段性考虑到我司 APP 产品建设是一项长久的工程，因此系统建设可以分成多个阶段来逐步实现。基于之前的 APP 系统已经有一定的设计经验积累
12、，在此次开发的阶段重点需要解决之前版本中的不足和缺憾，加以改善和解决。以达到此版本 APP 开发后能够确定 APP 产品体系的明确和优势所在。随着时间的推移及企业的发展，逐渐拓展新的移动运维需求，并将新的需求融入到 APP 体系中，从而最终实现一个可靠、可扩展的 APP 产品。3.1.2 先进性作为支撑公司 EMS 产品线移动端运维需要的重要 APP 版本，在 APP 的设计过程中，还必须强调先进性。保证 APP 未来的生命力，能够满足一定时间段内用户运维的需要。3.1.3 低流量消耗为方便用户运维人员实时运维需要，APP 会在多种网络环境下使用，因此 APP 不宜消耗太多流量，APP 与服务
13、器之间通讯尽量简化，减少非必要的数据传输。3.1.4 高性能作为一套实时操作的 APP 产品，需要达到较高的性能要求。才能较好支撑用户运维人员的实时运维需要。3.1.5 易用性为便于不同类型用户的使用，APP 风格确定为简洁、大方。每个页面展示一个主题内容。字体字号美观大气，易于辨认。操作路径不宜过深。3.1.6 安全性由于移动设备往往能有效标记用户的身份，因此 APP 的安全性尤为重要。设计时必须考虑各种场景下的安全信息。安全性是整个 APP 正常发展的基础保障。3.1.7 稳定性若 APP 本身如果不稳定，经常崩溃、退出，则用户必定会产生极大抵触情绪，所以 APP的稳定是 APP 产品成功
14、的命脉所在。3.2 总体结构系统整体分为 3 层，其中数据层的功能是持久化存储各模块的数据。平台处理层分为两部分，一部分是 APP 公共管理平台，由我司运维部（市场部）进行管理维护。提供 APP 版本管理、动态、APP 用户意见反馈管理等。另一部分是客户企业内的 EMSV1.5.0 平台，主要提供 APP 用户的登录、登出、能耗模块查询、告警模块查询处理等功能。业务展现层的功能为，从移动 APP 端提供辅助客户运维人员的能耗查询界面、告警查询处理界面、APP 版本升级、意见反馈、常见问题获取等功能，为用户提供专业的运维工具和 APP 辅助功能。3.3 总体方案总体方案如上图所示。APP 通过无
15、线网络（2G/3G/4G/WIFI）访问服务器中的 API。由于 APP 公共管理平台的接口要保持一致性和可访问性，同时鉴于无法确定的保持某公网环境可持续用于 APP 公共管理平台，此处做出以下处理方案。首先搭建我司 APP 统一的APP 管理平台，假如约定放在“10.xx.xx.56”服务器的 6000 端口上。其次在我司官网域名下开启二级域名地址用于部署一个服务接口，用于提供可用 APP 公共管理平台可用的最新地址。当 APP 分发时，APP 默认与约定的“10.xx.xx.56”地址的 6000 端口建立连接，如果可用，则进行关联。如果发现无响应或返回错误信息，则尝试连接开启的公司官网特
16、定二级域名下的特定接口服务，根据其返回最新的可用的 APP 公共管理平台地址，并覆盖写入原有默认的地址。3.4 模块功能APP for EMSV1.5.0 功能实现包含两部分：一部分是 APP 侧，另一部分是平台侧。平台侧分两部分，一部分是 EMSV1.5.0 平台，另一部分是由公司统一维护的 APP 公共管理平台。APP 中的用户登录、能耗、告警、用户登出由 EMSV1.5.0 平台提供服务。APP 版本更新、公司产品推介、意见反馈等功能由 APP 公共管理平台提供支撑。本说明书包含 APP 侧的概设。4 详细设计4.1 内部接口4.1.1 配置服务器信息接口HTTP 动词URL地址参数列表
17、返回值（示例）说明GET/projectName/version/checkserverversion:/APP版本status:true,/errorcode:,/status为false时有效/errormsg:,/status为false时有效data:custom_code:tayg,/客户代码（加密后的）custom:天安云谷/客户名称配置服务器接口服务器会验证目前 EMS 版本和APP 的版本是否一致。4.1.2 获取驾驶舱之能耗总览数据接口HTTP 动词URL地址参数列表返回值（示例）说明GET/projectName/version/GetCurrentMonthEnergyS
18、token:标识用户身份信息的标记status:true,/errorcode:,/status为false时有效/errormsg:,/status为false时有效获取当月能耗占比接口ummarydata:total:6283.25,/能耗lasttotal:6283.25,/去年能耗unit:tce,/单位tongbi:12.34,/同比（正代表增、负代表降）nodeid:/默认的区域/业态idnode:新城科技园,/默认区域或业态date:2017/10,/当前月items:code:elec,/分项代码unit:kw,/分项单位name:电,/分项名称value:1267418,/值
19、lastvalue:6283.25,/去年值compare:12.34%/同比（正值表示增加，负值相反）timetype:null,Quota:0,tceitems:code:elec,/分项代码unit:tce,/分项单位name:电,/分项名称value:1267418,/值lastvalue:6283.25,/去年值compare:12.34%/同比（正值表示增加，负值相反）timetype:null,Quota:0,4.1.3 获取驾驶舱之 KPI 总览数据接口HTTP 动词URL地址参数列表返回值（示例）说明GET/projectName/version/GetCurrentMoto
20、ken:标识用户身份信息的标记status:true,/errorcode:,/status为false时有效获取当月能耗占比接口Timetype 代表返nthKPISummary/errormsg:,/status为false时有效data:nodeid:/默认的区域idnode:新城科技园,/默认区域items:info:,status:true,code:00000,unit:tce,name:本月总能耗,value:18.65,lastvalue:0,compare:0.0186,timetype:本月,Quota:1000,info:定额值未配置,status:false,code:
21、,unit:,name:本月电,value:0,lastvalue:0,compare:-,timetype:,Quota:0,info:,status:true,code:00000,unit:tce,name:上月总能耗,value:15033.89,lastvalue:0,compare:0.7517,timetype:上月,Quota:20000,info:,status:true,code:01000,unit:kWh,name:上月电,value:86192.8,lastvalue:0,compare:0.0013,timetype:上月,Quota:66666666回数据的时间，
22、可能的四个取值分别是，上月、上年、当月、当年。用来在连接到 项目KPI 页面时候构造时间范围。4.1.4 获取驾驶舱之告警总览数据接口HTTP 动词URL地址参数列表返回值（示例）说明GET/projectName/version/getwarnlisttoken：/标识用户身份信息的标记status:true,/errorcode:,/status为false时有效/errormsg:,/status为false时有效data:total_todeal:1256,/未处理数today_todeal_f:true,/今日未处理有变化today_new:256,/今日新产生告警总数today_n
23、ew_f:true,/今日新增有变化update:true,/false/是否有变化，震动提醒pushtime:/推送时间获取告警总览数据接口4.1.5 获取能耗分析数据接口HTTP 动词URL地址参数列表返回值（示例）说明GET/projectName/version/GetEnergyAnalysisDatatoken:标识用户身份信息的标记type:year/month/day，年、月、日三种视图date:日期，格式为：2017/2017-10/2017-2-21nodetype:area/yetai/节点类型，area表示采用区域节点、yetai表示采用业态节点area:区域id，值为
24、null时代表根节点yetai:业态id，值为null时代表根节点item_code:能源类型(后端返回原始数据、同比环比数据，前端做筛选。)status:true,/errorcode:,/status为false时有效/errormsg:,/status为false时有效data:chartunit:kWh,unit:kWh,/单位title:新城科技园/区域或业态名称。total:12340544512/总消耗,prevtotalpercent:7.21,lasttotalpercent:-135860.68,chartdatacategories:2017-03-01,2017-03-
25、02,2017-03-31,series:获取能耗分析数据接口name:消耗值,data:20000.0,22000.9,24000.5,name:同比值,data:21200.0,21300.9,23000.5,name:环比值,data:21200.0,21300.9,28400.24.1.6 获取定额管理数据接口HTTP 动词URL地址参数列表返回值（示例）说明GET/projectName/version/GetQuotaListtoken:标识用户身份信息的标记datetype:year/month/时间类型，本年/本月nodetype:area/yetai节点类型，区域/业态lev
26、el:层级，1/2/3分别表示一级/二级/三级status:true,/errorcode:,/status为false时有效/errormsg:,/status为false时有效data:nodename:新城科技园1 栋本月,/节点名称nodeid:,/节点IDkpis:name:单位门诊能耗,/默认区域,kpicode:,/kpi代码,ratio:-,/完成率info:定额值未配置,name:万元 GDP 能耗,/默认区域,ratio:7.46%,/完成率info:,获取定额管理数据接口4.1.7 获取能耗 KPI 数据接口HTTP 动词URL地址参数列表返回值（示例）说明GET/pro
27、jectName/version/GetKPIInfotoken:标识用户身份信息的标记datetype:/时 间 类 型，year/monthdate:/2017/2017-1nodeid:节点iditemcode:/KPI的细类，总/水/电/单位床日等status:true,/errorcode:,/status为false时有效/errormsg:,/status为false时有效data:unit:tce,/单位info:,status:true,nodename:新城科技园,/节点名称（默认区域或业态节点）,complete:7.46%,/完成率quota:3562478,/当月定额
28、consum:12530,/当月消耗remain:3549948,/当月剩余获取能耗 KPI 信息接口4.1.8 获取能耗查询条件接口HTTP 动词URL地址参数列表返回值（示例）说明GET/projectName/version/GetAreaListtoken:标识用户身份信息的标记status:true,/errorcode:,/status为false时有效/errormsg:,/status为false时有效data:allareaitems:/全部区域节点areaid:62,name:新城科技园,parentid:0,level:1,areaid:63,name:新城科技园1栋,p
29、arentid:62,level:2,获取业态树或区域树的接口allotherareaitems:/全部业态节点areaid:1,name:业态总,parentid:0,level:1,areaid:63,name:业态节点1,parentid:1,level:2,，areaitems:/有权限区域节点areaid:62,name:新城科技园,parentid:0,level:1,areaid:63,name:新城科技园1栋,parentid:62,level:2,otherareaitems:/有权限业态节点areaid:1,name:业态总,parentid:0,level:1,areai
30、d:63,name:业态节点1,parentid:1,level:2,4.1.9 获取告警筛选条件接口HTTP 动词URL地址参数列表返回值（示例）说明GET/projectName/version/GetAlarmConditiontoken：/标识用户身份信息的标记status:true,/errorcode:,/status为false时有效/errormsg:,/status为false时有效data:status:code:0,name:正在告警,/告警状态level:code:,name:全部,/告警等级type:code:,name:全部,/告警类型begindate:2015-
31、1-1/查询起时间modules:code:,name:全部,code:1,name:配电自动化,/告警归属子系统获取告警列表数据接口4.1.10 获取告警列表数据接口HTTP 动词URL地址参数列表返回值（示例）说明GET/projectName/version/GetAlarmListtoken：/标识用户身份信息的标记module:1/告警模块idstatus:2/告警状态codeminlevel:1/告警最低等级maxlevel:10/告警最低等级type:1/告警类型begin:2017-09-27/起始时间end:2017-09-27/结束时间（也是首屏加载时间。为了加载更多也的时
32、候，第一页时，当前时间，pageindex=1）pageindex:1/第几页status:true,/errorcode:,/status为false时有效/errormsg:,/status为false时有效data:TotalPage:12,Records:id:,/告警idinfo:,/告警信息object:,/告警对象occurtime:,/发生时间item:,/告警项获 取 告警 列 表数 据 接口pagesize:10/每页记录数sortby:/排序依据（支持告警性质 Group3、告警等级AlarmLevel、告 警 状 态AlarmStatus、告 警 时 间AlarmTim
33、e排序）sorttype:/排序方式asc，desc等keyword:/关键字(设备名称或告警对象或告警项或告警信息)alarmtype:1/告警项codelevel:,/告警等级status:,/告警状态opertateconfirm:true,deal:true,undo:false,.4.1.11 获取告警详情接口HTTP 动词URL地址参数列表返回值（示例）说明GET/projectName/version/getwarndetailtoken：/标识用户身份信息的标记,id:2312323/告警记录IDstatus:true,/errorcode:,/status为false时有效/
34、errormsg:,/status为false时有效data:id:,/告警idinfo:,/告警信息object:,/告警对象occurtime:,/发生时间item:,/告警项level:,/告警级别status:,/告警状态statuscode:,/告警状态代码area:/安装位置module:,/归属模块property:,/告警属性opertateconfirm:true,deal:true,undo:false获取告警详情信息接口4.1.12 获取告警历史处理信息接口HTTP 动词URL地址参数列表返回值（示例）说明GET/projectName/version/GetAlarmH
35、istorytoken：/标识用户身份信息的标记,id:2312323/告警记录IDstatus:true,/errorcode:,/status为false时有效/errormsg:,/status为false时有效data:dealtime:,/处理时间status:,/告警状态info:,/告警信息source:,operator:,/操作人,获取告警历史处理信息接口4.1.13 告警操作（确认、处理、撤销，单个/批量）接口HTTP 动词URL地址参数列表返回值（示例）说明GET/projectName/version/warnconfirmtoken：/标识用户身份信息的标记,ids:
36、Id:,IsNosta:1,Id:,IsNosta:1,Id:,IsNosta:0/告警记录ID的数组type:do/处理(do)或确认(confirm)或撤销(undo)remark:/处理备注status:true,/errorcode:,/status为false时有效/errormsg:,/status为false时有效data:success:true,告警批量确认或处理、撤销接口三个用一个接口，批量和单个都在此接口处理，APP 端根据返回success 字段区分是否成功。5 错误处理设计5.1 系统级故障与错误5.1.1 服务器及移动端软硬件故障由于本 APP 整个系统的构建包括了
37、 APP 本身、客户企业 EMSV1.5.0 系统和公共的 APP管理平台三部分。每部分的故障不同。其中 EMSV1.5.0 的故障跟随 EMSV1.5.0 系统概设处理。本小节描述的服务器、APP 客户端软硬件故障包括：（1）服务器硬件，包括公共 APP 管理平台服务器的处理器、主板、内存、硬盘、网卡、电源等故障造成服务器运行终止或部分功能终止；（2）服务器系统软件，包括操作系统、数据库、消息队列、IIS 等故障造成服务器整体或部分功能终止（3）服务器应用软件，包括部署于服务器上的属于本项目范围内的自研软件故障导致系统运行终止或部分功能停用。（4）移动设备，安装 APP 的设备不属于本 AP
38、P 的兼容机型范围之内。（5）APP 故障，APP 安装包由于某种原因导致的错误、异常，导致无法安装，或正常运行等情况。服务器软硬件故障可能带来的问题包括：（1）服务器通信中断，停止服务（2）系统产生的实时数据丢失（3）系统存储的历史数据损坏或丢失（4）系统远程控制功能失效（5）系统数据分析功能失效（6）系统历史数据查询或统计失效5.1.2 数据访问和存储能力本系统中可能涉及到数据访问和存储能力问题主要包括以下场景，尤其可能出现在多个场景叠加的情境下：（1）不同用户同时对同一个告警进行处理（4）长时期范围内的统计数据查询6 安全保密设计本 APP（APP for EMSV1.5.0）在安全保密上仅仅考虑基于用户名，密码和验证码的登录验证。获取数据时附带上标记用户身份的 token 数据。其他通信安全等暂时不做考虑。规划下个版本版本实现时采用 HTTPS 加密方式传输数据。