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

智慧运维手机APP概要设计说明书文件编号生效日期受控编号保密级别版本号V1.02457003修改状态总页数正文附录编制审核批准评审记录对《智慧运维手机APPForEMSV1.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.1APP侧 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.1EMS1.31侧数据库设计 375.2公共平台侧数据库设计 375.2.1用户表（TB_USER） 375.2.2APP版本管理表（TB_APP_VERSION） 385.2.3APP天溯动态提示表（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.1APP侧 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.1EMS1.31侧数据库设计 325.2公共平台侧数据库设计 325.2.1用户表（TB_USER） 325.2.2APP版本管理表（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编写目的本文档是在《智慧运维手机APPForEMSV1.5.0用户需求说明书》的基础上，进行详细需求分解和技术应对后得出的概要设计说明书，旨在明确目标系统的总体结构、接口形式、数据模型，以及重要业务流程和对象的设计，并明确需求用例的各个功能点在架构中的体现，为后续的详细设计、编码实现以及产品测试等工作提供指导性规范。本文档预期读者包括：（1）技术营销人员、行业线解决方案设计人员、产品经理等需求侧的相关人员，用于明确和追踪软件产品需求的实现程度，验证需求实现中的正确性和完整性。（2）项目经理、系统工程师、研发工程师等研发侧的相关人员，用于理解软件系统组成、模块接口、数据模型以及整体技术要求，为后续详细设计和系统开发提供基础和依据；（3）测试工程师和品质管理人员，用于理解软件系统边界、组成和模块关系，确定测试方案和测试计划，进行软件质量管理。1.2项目背景拟开发系统名称：本文档规范的软件系统是南京智慧运维手机APPForEMSV1.5.0，本项目简称EMS1.5.0APP。项目提出者：南京项目开发者：南京研发中心本项目重点为EMSV1.5.0系统提供一套移动端应用程序，使得客户能够充分利用碎片化时间对其能源消耗情况和设备运行状况进行查询、管理。1.3定义1.4参考资料1、本项目的经核准的计划任务书或合同、上级机关的批文；（1）《能源管理系统EMSV1.5.0用户需求说明书》（2）《智慧运维手机APPForEMSV1.5.0用户需求说明书》2、属于本项目的其他已发表的文件暂无。3、其他参考的文件、资料和标准《移动端技术选型报告》《HybridAPP开发之IONIC开发方式的分析报告》2任务概述2.1任务目标公司基于“平台战略”提出了智慧运维管理平台的移动端产品，目标是建立一个使客户便于使用、能利用碎片化时间，集能耗数据信息查询、告警信息查询、告警处理、意见反馈、公司产品推介、知识库等为一体的APP精品产品。在整体战略的驱动下，EMSV1.31APP研发的目标定位是在现有的EMS平台之外，再开拓出一个移动市场的产品线，利用目前移动化的趋势，充分满足客户多场景的运维管理的需要。2.2运行环境本小节规定本项目开发和目标平台，以及测试部署使用的软硬件运行环境。本项目部分软硬件产品具备平台移植能力，通过微调和重新编译可适应新的软硬件平台。2.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）具备统一的运行监管功能，对主要模块的运行状态进行统一监管，要求具有良好的运行监测、负载监控管理、流量监控、故障分析和故障恢复能力；（4）智慧运维，整体方案中数据处理协议和关键业务数据算法模块支持升级替换，利于第三方接入和投资保护；（5）数据安全保护，支持安全加密，完善的数据备份和容灾备份方案。（6）响应性能。在公网部署的情况下，平台带宽要求大于等于5M，最大连接数40台。APP需尽量节省流量，需要在后台的数据和页面尽量减少流量的消耗，单页面流量不大于2M。网络正常情况下，单个页面响应速度不超过5S。更加详细的功能需求，性能需求以及其他需求参见本项目的需求规格说明书。2.4条件与限制本文档仅针对EMSV1.5.0APP的需求开发，本文档中的“本APP”、“APP”等词通指EMSV1.5.0APP系统。3总体设计3.1设计原则由于APPforEMSV1.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.43高性能

作为一套实时操作的APP产品，需要达到较高的性能要求。已能才能较好支撑用户运维人员的实时运维需要。3.1.54易用性

为便于不同类型用户的使用，APP风格确定为简洁、大方。每个页面展示一个主题内容。字体字号美观大气，易于辨认。操作路径不宜过深。3.1.65安全性

由于移动设备往往能有效标记用户的身份，因此APP的安全性尤为重要。设计时必须考虑各种场景下的安全信息。安全性是整个APP正常发展的基础保障。3.1.76稳定性若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模块功能APPforEMSV1.5.0功能实现包含两部分：一部分是APP侧，另一部分是平台侧。平台侧分两部分，一部分是EMSV1.5.0平台，另一部分是由公司统一维护的APP公共管理平台。APP中的其中用户登录、能耗、告警、用户登出由EMSV1.5.0平台实现提供服务。APP版本更新、公司产品推介、FAQ知识库、意见反馈等功能由由公司统一维护的一个APP后台公共管理系统平台提供服务支撑。本说明书包含这部分APP侧的概设和APP公共管理平台部分的概设，以及APP需要EMS1.31提供的部分内容。详功能模块主要分为APP侧和平台侧。详情请参考以下内容。4详细设计4.1内部接口4.1.1配置服务器信息接口4.1.2获取驾驶舱之当月能耗总览信息能源能耗占比能耗总览数据接口4.1.3获取驾驶舱之KPI总览数据接口4.1.4获取驾驶舱之告警总览数据接口4.1.5获取能耗分析数据接口4.1.6获取KPI定额管理信息数据接口4.1.7获取能耗KPI数据接口4.1.85获取能耗查询条件接口 4.2.765获取当月能耗分析数据接口4.2.76获取当月能耗KPI数据接口4.2.8获取告警处理统计接口（实时）4.1.9获取告警筛选条件接口4.1.1087获取告警列表数据接口同步到其它列表接口同步到其它列表接口4.1.1198获取告警详情及历史处理信息接口4.1.12获取告警历史处理信息接口4.1.13告警操作（确认、处理、撤销，单个/批量）接口4.2.1029告警确认接口4.2.1130告警处理接口4.2.1124告警处理撤销接口5数据结构设计5.1EMS1.31侧数据库设计本APP的数据库跟随EMS1.31数据库设计，本文档不包含此部分内容。由于我司存在多个产品线、版本并行存在的情况，将会出现多个版本的APP应用到不同的客户企业中。因此EMS平台需要包含当前客户的行业（如医疗）；平台版本（如EMS1.31）、客户编码（如TAYG）、客户名称（如天安云谷）、APP版本（如EMS1.31APP）等信息。由于定额KPI可能未配置，此页面是否显示，根据EMS1.31平台配置显示与否。平台配置APP的能耗模块是否显示KPI页面。修改修改为判断APP用户是否首次登录，需要在EMS1.3用户表中增加APP登录标记（APP_LOING，BIT，Default0）。如用户在APP上登录过，则改变状态(值为1)。5.2公共平台侧数据库设计5.2.1用户表（TB_USER）序号字段名类型长度描述约束1IDINT4索引、标识主键2USERIDVARCHAR40用户登录ID唯一性约束3USERNAMEVARCHAR40用户名4PASSWORDVARCHAR40密码5ADDDATEDATETIME10用户添加日期6ENABLEDbit1是否启用5.2.2APP版本管理表（TB_APP_VERSION）序号字段名类型长度描述约束1IDINT4索引、标识主键2APPNAMEVARCHAR40APP的名称MAIN_VERSIONVARCHAR20APP所属产品版本，如EMS1.31、eWay2.21等APP版本UPDATE_VERSIONVARCHAR20升级版本，如1603201（规则：年月日+序号）CUSTOMCODEVARCHAR20适用客户（升级此版本的客户企业代码）URLVARCHAR20此APP的获取路径STATUSVARCHAR100APP状态（待启用、已启用、已停用）5.2.3APP天溯动态提示表（TB_NEWS_NOTIFICATION）序号字段名类型长度描述约束1IDINT4索引、标识主键2UPDATECODEVARCHAR40更新代码（依次增大）3BEGINDATEDATETIME提示开始时间4ENDDATEDATETIME提示结束时间5.2.34常见问题知识表（TB_FAQKNOWLEDGE）序号字段名类型长度描述约束1IDINT4索引、标识主键2QUESTIONTITLEVARCHAR40问题内容知识标题ANSWERCONTENTVARCHAR502000问题回复知识内容DOMAINVARCHAR50领域（医疗、机场等）TYPEVARCHAR50分类标签TAGVARCHAR50知识标签STATUSVARCHAR20常见问题状态SORTVARCHAR100常见问题的排序5.2.45用户反馈意见及回复表（TB_USER_FEEDBACK_REPLY）序号字段名类型长度描述约束1IDINT4索引、标识主键2USERIDVARCHAR40反馈用户的IDUSERNAMEVARCHAR50反馈用户的用户名VERSIONVARCHAR20反馈问题的APP版本CUSTOM_CODEVARCHAR100反馈用户所属客户3TYPEVARCHAR20意见所属类型3TITLEVARCHAR50反馈意见标题4CONTENTVARCHAR500反馈意见内容5STATUSDATE10反馈状态（未处理、已处理、挂起）REPLY_USERIDVARCHAR回复的平台用户ID外键6REPLYVARCHAR500意见回复内容FLAGVARCHAR10意见标识（重要、一般、干扰）5.2.6客户表（TB_CUSTOM）序号字段名类型长度描述约束1IDINT4索引、标识主键2CUSTOM_CODEVARCHAR40客户企业代码3CUSTOMVARCHAR50客户名称PRODUCTION_VERSIONVARCHAR20购买产品版本(EMS1.31/eWay