版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领
文档简介
智慧运维手机APPForEMSV1.31概要设计说明书V1.00智慧运维手机APPForEMSV1.31概要设计说明书文件编号生效日期受控编号保密级别一级版本号V1.024563修改状态总页数43367正文附录编制赵胜利审核批准(版权所有,翻版必究)评审记录对《智慧运维手机APPForEMSV1.31概要设计说明书V1.00》的评审意见:上述问题修改验证后,由验证后,本文件即可发布。评审人员签字:问题修改验证结果:验证人签字:时间:
变更日志1,删除了APP公共管理平台侧的概设内容。2,细化了告警统计信息的分类和统计方法。3,增加了告警统计信息的推送功能。4,增加了告警列表筛选的交互说明。5,删除了知识库部功能。
目录1引言 图1,其中可分为登录模块、能耗模块、告警模块、“更多”模块等4个模块。其中登录、能耗、告警等模块数据来源于EMS1.31系统。“更多”模块中的APP版本更新、知识库、关于页面、天溯新闻/新产品动态、意见反馈等功能是针对公司的全部所有客户用户,。任何客户的这些功能的数据、这部分的接口服务等是部署于研发中心统一设立的公网服务器中,所有用户的此部分数据集中统一管理。同时此部分功能要管控未来多个移动端产品。如EMS1.31APP、EMS1.32APP、eWay2.21APP、eWay2.3APP等。1、登录模块支持根据用户的登录名和密码实现登录功能,支持记住密码,自动登陆,在用户第一次成功登录后,再次重启APP直接登录陆,仅在用户登出后,再次提示用户登录。2、能耗模块能耗模块主要用于展示能耗相关数据,主要包括:能耗总览、能耗分析、KPI指标。告警模块告警模块主要用于展示设备及系统产生的告警数据,使用能及时了解当前设备及系统的运行情况,便于管理人员及时定位处理设备故障。“更多”模块“更多”功能模块是APP的附属功能模块,主要包括用户登出、APP版本更新、天溯动态、知识库、关于页面、意见反馈等。除登录模块是通过EMS1.31平台实现外,剩余的模块是均由APP公共管理平台统一管理。图1EMSV1.3APP功能需求2.3.2非功能需求(1)安全可靠千兆接入网络,支持大规模并发数据流量接入;(2)对主要数据和功能进行安全隔离;(3)具备统一的运行监管功能,对主要模块的运行状态进行统一监管,要求具有良好的运行监测、负载监控管理、流量监控、故障分析和故障恢复能力;(4)智慧运维,整体方案中数据处理协议和关键业务数据算法模块支持升级替换,利于第三方接入和投资保护;(5)数据安全保护,支持安全加密,完善的数据备份和容灾备份方案。(6)响应性能。在公网部署的情况下,平台带宽要求大于等于5M,最大连接数40台。APP需尽量节省流量,需要在后台的数据和页面尽量减少流量的消耗,单页面流量不大于2M。网络正常情况下,单个页面响应速度不超过5S。更加详细的功能需求,性能需求以及其他需求参见本项目的需求规格说明书。2.4条件与限制本文档仅针对EMSV1.31APP的需求开发,本文档中的“本APP”、“APP”等词通指EMSV1.31APP系统。开发时间要求为2016.01-2016.04,即在2015年4月31日前完成规定任务的设计、研发和测试第一轮工作。3总体设计3.1设计原则由于APPforEMSV1.31的目标是位为客户的运维人员提供一套有效的移动端运维管理工具,借助此工具能够查询到企业当前的能耗使用状态和设备产生的告警信息,同时能够对告警进行直接处理。因此本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用户意见反馈管理等。另一部分是客户企业内的EMS1.31平台,主要提供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.31功能实现包含两部分:一部分是APP侧,另一部分是平台侧。平台侧分两部分,一部分是EMS1.31平台,另一部分是由公司统一维护的APP公共管理平台。APP中的其中用户登录、能耗、告警、用户登出由EMS1.31平台实现提供服务。APP版本更新、公司产品推介、FAQ知识库、意见反馈等功能由由公司统一维护的一个APP后台公共管理系统平台提供服务支撑。本说明书包含这部分APP侧的概设和APP公共管理平台部分的概设,以及APP需要EMS1.31提供的部分内容。针对不同网络条件下的APP可用性状况、APP用户权限管理等跨模块的概设,放在第一部分公共模块中描述。详功能模块主要分为APP侧和平台侧。详情请参考以下内容。3.4.1公共模块APP在不同网络条件下的APP网络访问处理情况、APP用户权限管理、APP公共管理平台访问的合法性验证等跨模块的设计方案,都在此处说明。1.
APP网络访问:我公司EMS1.31系统最终部署于客户企业的网络环境中。客户企业的网络访问状况可能很复杂。部署在客户企业网络中的EMS1.31系统,会出现三种情况:只能通过外网地址访问、只能通过内网地址访问、即可通过外网访问又可通过内网访问,但有时只有一种网络访问有效。
另外,APP从功能方面分,会出现四种网络情况:仅能访问APP公共管理平台、仅能访问EMS1.31平台、既能访问APP公共管理平台和EMS1.31平台、同时无法访问APP公共管理平台和EMS1.31平台。APP需要面对在各种网络环境情况,访问APP公共管理平台和访问EMS1.31系统相互不影响。2.
APP用户权限管理:根据安全需要,针对不同用户组,能够访问的功能不同。不同用户组对APP的权限在EMS1.31系统进行配置。用户登录APP后仅能查看有权限访问的模块。3.APP公共管理平台访问合法性验证:由于APP的用户是客户企业EMS1.31平台中的。APP访问APP公共管理平台时,无法进行单个用户验证。但此处需要对访问合法性做验证。设计方案1.
APP网络访问:为APP配置两个地址(内网地址、外网地址)链接EMS1.31平台。如果用户登录时仅配置了一个地址,则只使用此地址链接EMS1.31平台。如果同时配置了内网和外网地址,APP初次链接默认采用内网地址链接,如果不通,尝试切换外网地址,如果也不通进行提示。在APP工作过程中,如果发现当前地址不可用,则尝试切换另一地址,如果新地址可用则将新地址设为默认地址。对于可能出现的EMS1.31平台和APP公共管理平台不可用情况,APP实现过程中仔细判断网络情况,对于接口无法访问时,友好提示,确保页面展示正常。在网络不可用时,APP各功能模块之间切换不影响。2.
APP用户权限管理:APP用户的访问权限来由后台进行配置。用户首次登录APP时,后台接口返回当前用户可访问的所有页面id,APP根据页面id进行动态展示。对于只显示用户有权限访问的页面。数据权限由EMS1.31平台控制,仅返回用户有权限访问的数据。对于告警处理等操作权限,亦由平台返回标识控制。2.
APP公共管理平台访问合法性验证:APP用户主要是客户企业EMS1.31平台内的用户。考虑到各局点用户分散,持续保持一致性代价较大,APP公共管理平台做单个用户的验证。但为了验证请求合法性,每次请求时附上加密的“客户代码”,服务器端获取请求后解码客户代码,如果能找到匹配的客户代码,即表示属于合法的APP请求。3.4.1APP侧用户登录模块是用户使用本APP的第一步。用户登录模块包括服务器配置、用户登录、用户引导三个功能。每个功能的详细信息如下:1.
服务器配置:此功能帮助用户连接到其所属客户的EMS系统中。EMS1x系统是部署到客户企业环境中的,用户首次使用APP时需配置其要连接的服务器信息。配置完毕后,后期默认使用第一次配置的服务器信息,除非用户主动修改配置信息。配置完成后对配置结果进行提示,如“服务器地址无效”或“服务器配置成功,欢迎进入XX智能运维系统”。服务器配置有两个地址,分别是公网地址、内网地址。默认连接内网,如果不通尝试连接公网。如果还不通,进行网络异常提示。2.
用户登录:此功能是用户使用APP的权限验证部分。用户在登录界面输入用户名、密码然后点击登录按钮,系统将用户验证信息发给服务器进行验证;(信息加密,返回token)。3.用户引导:此功能是对配置后首次使用本APP的用户进行使用方法介绍。用户引导通过蒙板和高亮区域对重点功能进行介绍,方便客户快速了解相关功能入口;需求用例图如下:1.
人性化。在配置完、用户输入密码、登陆后对用户操作进行提示。如配置完成后提示用户是否配置成功,若配置失败,提示失败原因等。配置完成后反馈用户是否配置成功,未配置成功的返回原因。为便于用户使用,用户首次登录后,在APP关闭再进入的时候不再进行登录。2.
安全性。敏感信息如:用户名、密码等均进行加密后传输。用户获取数据均带上token信息,服务器端进行验证。用户登出后删除服务器端token信息。登录模块的总体流程图如下:1.
服务器配置功能,为方便对用户配置信息进行校验,WEB平台预留默认的配置信息确认接口。同时为了今后版本考虑,增加版本确认信息。2.
用户登录功能,用户名、密码信息进行加密后传输(采用MD5方法加密)。为了便于用户直接使用不必每次都登录,登录成功后返回token信息。此信息持久化存入web平台中。随后用户每次申请数据均附带上此token信息。对于没有token的屏蔽访问。3.
使用引导在用户完成配置后首次登录时显示。4.
为了对用户进行行为进行记录,用户的APP登录操作记入日志信息。日志包含用户名、登录时间、登录的IP等信息。用户登录模块是用户使用本APP的第一步。用户登录模块包括服务器配置、用户登录、用户引导三个功能。每个功能的详细信息如下:1.
服务器配置:此功能帮助用户连接到其所属客户的EMS系统中。EMS1x系统是部署到客户企业环境中的,用户首次使用APP时需配置其要连接的服务器信息。配置完毕后,后期默认使用第一次配置的服务器信息,除非用户主动修改配置信息。配置完成后对配置结果进行提示,如“服务器地址无效”或“服务器配置成功,欢迎进入XX智能运维系统”。服务器配置有两个地址,分别是公网地址、内网地址。默认连接内网,如果不通尝试连接公网。如果还不通,进行网络异常提示。2.
用户登录:此功能是用户使用APP的权限验证部分。用户在登录界面输入用户名、密码然后点击登录按钮,系统将用户验证信息发给服务器进行验证;(信息加密,返回token)。3.用户引导:此功能是对配置后首次使用本APP的用户进行使用方法介绍。用户引导通过蒙板和高亮区域对重点功能进行介绍,方便客户快速了解相关功能入口;需求用例图如下:1.
人性化。在配置完、用户输入密码、登陆后对用户操作进行提示。如配置完成后提示用户是否配置成功,若配置失败,提示失败原因等。配置完成后反馈用户是否配置成功,未配置成功的返回原因。为便于用户使用,用户首次登录后,在APP关闭再进入的时候不再进行登录。2.
安全性。敏感信息如:用户名、密码等均进行加密后传输。用户获取数据均带上token信息,服务器端进行验证。用户登出后删除服务器端token信息。登录模块的总体流程图如下:1.
服务器配置功能,为方便对用户配置信息进行校验,WEB平台预留默认的配置信息确认接口。为了同时为了今后多版本管理需要考虑,增加版本确认信息。2.
用户登录功能,用户名、密码信息进行加密后传输(采用MD5方法加密)。为了便于用户直接使用不必每次都登录,登录成功后返回token信息。此信息持久化存入web平台中。随后用户每次申请数据均附带上此token信息。对于没有token的屏蔽访问。3.
使用引导在用户完成配置后首次登录时显示。用户登录后服务器返回当前用户是否是第一次使用此版本,是,则进行使用引导,不是,则直接跳过。4.
为了对用户进行行为进行记录,用户的APP登录操作记入日志信息。日志包含用户名、登录时间、登录的IP等信息。能耗数据是用户了解其企业能耗使用情况的重要依据。能耗模块主要用于展示能耗相关数据,包括:能耗总览、能耗分析、KPI指标。每个功能的详细信息如下:1.
能耗总览:此功能提供用户查看当月能耗的汇总信息。包括当月能耗占比信息和当月能耗总览信息。当月能耗占比信息包括:当月能耗数据、当月各分项能耗数据(电、水、气等能耗)、当月各分项能耗的占比图(显示百分比数据)。当月能耗总览包括:、相对上月同期的增加/减少(为0时,不显示向上向下箭头)。 能源类型根据系统配置展示。2.
能耗分析:此功能方便用户查看近期企业能耗使用的趋势信息。用户能够根据时间、类型、业态、区域、能耗类型等对能耗数据进行过滤。时间支持年、月。并同时能够查看当前筛选条件下的同比、环比数据。3.KPI指标:此功能提供查看用户企业能源消耗相关KPI数据,方便用户掌握其能耗的关键指标;KPI包含能耗KPI和分项能耗KPI。总能耗KPI包括:总能耗定额KPI值(单位TCE,未配置显示N/A)、总能耗实际消耗值(单位TCE)、总能耗剩余值(单位TCE,未配置显示N/A)、实际消耗百分比(小数点后保留两位)、能耗同比;分项能耗KPI包括:分项能耗的定额KPI值(未配置显示N/A),实际消耗值、剩余值(未配置显示N/A)、实际消耗百分比(小数点后保留两位)、能耗同比能源消耗速度。 由于定额KPI可能未配置,此页面是否显示,根据EMS1.31平台配置显示与否。平台配置APP的能耗模块是否显示KPI页面。需求用例图如下:1.
人性化。为便于用户查看能耗的总体、分项信息、趋势信息等,此部分信息主要采用图表展示方法。包含环形图、柱状图、仪表图等。由于此部分主要是信息查看,此处采用数据模块方式展示查看数据的关系:告警模块是用户运维人员了解其企业设备运行状况的重要功能。告警模块主要用于对当日客户企业设备运行的异常信息进行管理,通过此模块能够查看告警总览、告警列表、告警详情,并对告警进行处理等。每个功能的详细信息如下:1.
告警总览:展示告警统计数据,包括:今日新增告警数、今日新增告警已处理数、告警待处理总量、告警回复总数量;显示今日新增的告警数量、今日新增告警中已处理的数量,便于客户运维人员总体了解今日设备运行状况。今日新增告警数:从今日凌晨零点开始,到当前时间,所产生的告警的总数;今日新增告警已处理数:对今日新增的告警,同时状态为已处理的告警总数;告警待处理总量:正在告警的总数+告警类型为(诊断告警/一般告警的发生态信息),告警状态为已确认的告警总数告警恢复总量:全部告警的已恢复态信息状态的告警总数。2.
告警列表:此功能方便运维人员查看今日发生的所有告警信息。每条告警信息包含:告警时间、告警状态、告警内容、告警等级、告警模块项、告警类型项图标等内容。告警列表默认按照告警时间倒序排序。运维人员可根据告警模块、告警状态、告警等级(范围)、告警类型、告警时间(范围)进行过滤,同时能够根据告警类型、告警等级、告警时间进行排序。3.告警详情:告警详情是告警列表中每一天告警记录的详细信息,包含了一条告警的最详细内容,主要有:告警对象、告警项、告警信息、归属模块、告警性质、告警等级、告警状态、告警时间、告警区域等。4.告警历史信息:告警历史信息是记录每条告警的历史处理信息,包括告警时间、告警状态、告警信息、备注等。此功能方便运维人员查看单条告警的历史处理情况。5.告警处理:告警处理功能是为运维人员提供的告警处理工具。通过告警处理功能,运维人员能够使用APP直接对告警进行处理。消除了用户必须在电脑端操作的限制。告警处理针对手机端处理还是PC端处理进行区分。 EMS.131平台端返回告警列表数据,并标记用户是否有操作权限。告警处理状态变化有以下3条路径:正在告警已确认(确认操作)已处理(处理操作)正在告警已处理(直接处理操作)已处理已确认(撤销处理操作)6.告警处理操作记录:告警处理是用户企业运维的重要工作,运维人员每次对告警的处理操作进行记录,内容包括:处理操作时间、告警状态、告警信息、操作终端、操作人、告警处理文字。时间、处理前后的告警状态、处理人员。7.告警处理权限控制:本APP用户主要分:客户企业的管理人员和运维人员。此处的处理功能仅对运维人员开启。对于管理人员仅提供查看告警信息。8.告警推送:为了保持告警总览信息的实时性和告警有变化时进行提醒,AP告警统计信息P采用websocket推送方式实现与服务器实时同步的功能与服务器长连接实现告警推送功能。01APP在运行期间,收到新通知后,会以震动的方式提示用户,并在对应的数据项上以红点展示。告警推送通知以用户账号为接收单元。通知的数据需要由后台先进行筛选统计汇总。;
02时间计算方式为统计方法:以当前用户前用户上一次刷新统计告警数据的时间为起始时间,在此时间之后发生产生的告警统计项目的为新告警数据,经过后台筛选后作为通知推送给用户由后台统计并推送给前台,并标记处是否有更新,是否进行提示等。;
03告警通知展示方式为:在告警首页上展示新数据提示,展示包括:在今日所有新增的告警数、今日新增告警已处理数、告警的待处理总数、告警的恢复总数的数字上,以红点展示统计数据项的右上侧显示红色标记。某项数据产生更新,则有此标记表示。如果在上次统计返回后,用户查看了相应的列表项,且没有产生新的数据,则不显示此标记。如果此次统计时间内有新数据产生,则手机进行震动提示。;
04后台筛选方式为:后台根据配置文件,对推送的告警进行筛选,筛选条件根据告警模块、告警项和告警等级进行筛选,需要根据不同用户做配置,不同权限的用户的筛选条件可能不同;
05由告警统计进入告警列表入口的告警通知处理方式为:进入告警列表页面时根据当前入口项目的筛选条件,显示相应的告警列表内容。当有新数据产生提示时,点击进入新页面后,根据点击按钮,做条件筛选,在页面最上方展示新数据;
权限管理告警配置功能:此功能是是否保持告警推送。默认选中,表示保持推送,APP实时和服务器同步此处的告警统计信息。如果取消,则APP断开与服务器联系。管理人员(没有告警处理权限)的需求用例图如下:运维人员(有告警处理权限)的需求用例图如下:1.
人性化。告警筛选条件较多,为了最大化的方便用户进行筛选操作,筛选操作分为两个入口为便于用户查看能耗的总体、分项信息、趋势信息等,此部分信息主要采用图表展示方法。包含环形图、柱状图、仪表图等:普通筛选和综合筛选。普通筛选是展示所有筛选条件,给用户逐一选择的筛选功能。普通筛选的筛选条件是完整的,用户可以通过此功能精确的定位到需要告警范围中。综合筛选,只有一个关键字输入框。APP启动时,从服务器获取所有可用的筛选条件,存于本地。当用户在关键字输入框中输入关键字时,程序自动搜索所有匹配用户输入关键字的筛选条件值,以下拉项方式呈现给用户。用户可直接选择某一筛选条件值。。选择完一个筛选条件值后,用户可以继续输入关键词,程序继续自动搜索除了已选的筛选条件外的其它条件值,给用户选择。用户可以依此选择多个条件,单击搜索按钮进行查询。32.
安全性。告警处理是用户企业运维的重要工作,运维人员每次对告警的处理操作进行记录,内容包括:处理时间、处理前后的告警状态、处理人员。此部分涉及若干页面的数据和部分功能模块的数据,其关系参考下图:告警处理逻辑部分较为复杂,其主要处理流程如下参考下图:“更多”模块是当前登录用户的信息以及本APP相关的功能。主要包括用户登出、APP版本更新信息、公司天溯动态产品推介、FAQ、意见反馈等功能。用户登出功能是在用户企业服务器中实现。其它功能需要APP连接统一的公网服务器。每个功能的详细信息如下:1.
用户登出:本功能用于切换当前登录用户。在用户登录时,服务器会生成token信息用于标识唯一用户。当用户登出时,服务器删除此token信息以及相应的session数据。2.
版本检查:由于Android和IOS平台对APP管理的差异,Android平台和IOS平台的版本升级功能管理。此模块功能适用于Android平台。IOS平台由于Appleappstore统一管理,IOS版本的APP将删除不含此功能。版本检查提供了用户统一的APP升级渠道。为了保持用户使用的APP及时更新,由研发中心维护一个统一的APP升级服务。每次用户使用时APP首先访问升级服务,如有新版本可用,则提示用户下载。用户也可以主动访问“检查升级”功能。APP保持大版本共存,小版本升级替换的模式。即不同的客户可能使用不同大版本。如禄口机场使用EMS1.2APP,华西医院使用EMS1.31APP、卫计委使用eWay2.21APP;禄口机场存在从APPEMS1.2.1603041升级到APPEMS1.2.1607011,卫计委从APPeWay2.21.1603171升级到APPeWay2.21.1605201等。3.关于页面:APP的关于页面包含:公司名称、联系电话、官方微博、官方微信、APP当前版本号等信息。43.公司产品推介天溯动态:此功能是对我司及我司产品介绍的广告性质的模块。用于向用户介绍我司产品的最新的进展、亮点等。客户的APP使用人员能通过此功能了解到我司产品的最新信息。由于此页面更新频繁,此页面采用H5静态页面实现,部署与APP公共平台系统特定路径中,用户访问此功能时,APP访问服务器调取此页面展示给用户。天溯动态具有主动提示功能功能。当产生新的有效期内的新闻时,APP通过标记提示有新内容,引导用户及时查看。54.FAQ:常见问题列表知识库模块,是对用户使用经常遇到的问题、专业术语等的问答形式的介绍是对行业一些专业知识介绍、展示的模块。通过此功能,用户能够查看学习、查看到常见问题分类、行业的一些专业知识常见问题、,常见问题的解答等以辅助提升其工作。知识库内容包括:标题、内容、分类、标签字段。其中内容是图文混排形式。知识库列表支持按照标签、分类、标题进行模糊筛选。565.意见反馈:为了和用户保持直接接触,从而了解到实际用户使用APP过程中的感受和意见,专门开发了此功能。用户通过此功能提交意见。后台管理人员可以对用户提出的意见进行反馈或解释。针对用户提出较多的修改建议,可列入下版本的修改需求单中。67.是否推送配置项:针对APP此配置是针对告警项是否保持推送功能,。增加一个配置选项。此选项默认选中,选中状态表示保持推送,不选中表示不保持推送。7.连接合法性验证:APP用户的验证,考虑到各局点用户分散,持续保持一致性代价较大,APP公共管理平台不做单个用户的验证。但为了验证请求合法性,每次请求时附上“加密的当前客户的客户代码”,服务器端获取请求后解码客户代码,如果能找到匹配的客户代码,即表示属于合法的APP请求。在意见反馈、提交访问统计信息功能时,APP会附带提交所属的客户代码、客户名称(指企业客户)、用户id等,公共管理平台可以通过这些信息区分哪个局点、用户。针对用户经常提出的非修改的问题,可以定时收集并筛选其中典型的问题,列入FAQ中。用户登出功能需求用例图如下:APP版本更新用例图如下:用户查看我司产品推介天溯动态相关用例图如下:用户访问FAQ知识库需求用例:(图-1)用户反馈APP意见的需求用例图:1.
可持续。由于版本检查、FAQ知识库获取、意见反馈、APP用户访问统计信息等功能是跨客户跨版本的模块,通过需通过APP公共管理平台实现,因此必须保持此平台的可持续访问性。1.
APP公共管理平台的连接方案。搭建APP统一APP管理平台:假如设定APP统一的APP管理平台放在“10.xx.xx.56”服务器的6000端口上。2.
创建APP统一管理平台最新地址的接口服务:在我司官网域名下开启二级域名地址,部署一个服务接口。用于提供可用APP公共管理平台可用的最新地址。当APP分发时,APP默认与约定的“10.xx.xx.56”地址的6000端口建立连接,如果可用,则进行关联。如果发现无响应或返回错误信息,则尝试连接开启的公司官网特定二级域名下的特定接口服务,根据其返回最新的可用的APP公共管理平台地址,并覆盖写入原有默认的地址。详细见以下图示。 24. APP获取天溯动态通知提示的流程图如下:3.4.2平台侧用户登录模块主要包括登录验证、验证码、密码加密的功能APP登录、登出的验证功能有EMS1.31平台实现。登录验证输入用户名和密码判断用户名是否存在;密码是否正确;两个都匹配则登录成功,加载APP版本管理和意见反馈模块;否则提示登录失败平台根据APP调用登录接口时提交的用户名和加密的密码,访问数据库用户表读取相应用户名的记录到内存,判断APP版本是否当前EMS平台的APP版本,匹配则判断用户名、密码是否正确。正确,返回相应信息(token、是否首次登录、客户企业ID、客户企业名称等,具体参考接口)。如果首次登录,则修改相应值。生成token,并持久化存储于DB中。失败,则提示失败原因(用户名不存在、密码错误、APP版本不匹配等)。APP登录流程接口用户名验证码用户登录时必须输入验证码:如果输入错误,刷新验证码,提示验证码错误;否则在用户名和密码都输入正确的情况下才可以登录系统。密码加密登出用户登录密码以MD5加密方式存储于数据库中。APP用户登录时先由APP客户端对用户密码进行MD5加密,先对用户输入的密码进行MD5计算再传输至服务端,由服务器进行判断验证服务器收到用户登出的请求,删除此用户session数据、token等,返回消息,然后再进行数据库字段内容的比较判断密码是否正确。由于Android和IOS平台对APP管理的差异,此APP版本管理只管理Android版本的APP。IOS版本APP由Appleappstore统一管理。APP版本管理是维护APP版本升级的重要内容功能。主要实现的功能有:增加最新的添加APP版本信息、启用APP版本信息、设置升级更新特定版本的客户、。停用APP版本信息等。APP版本管理能够对多个大版本进行管理。如并行存在EMS1.31APP、eWay2.21APP,每个大版本以下发布可升级的小版本。如发布了EMS1.31APP1603201版本,它能是EMS1.31APP的16年3月20日发布的第一个更新版本,能升级EMS1.31APP此日期前发布的版本。(1)增加添加APP版本信息:平台用户能够对APP版本进行管理,同时能可以指定可升级此APP版本适用的客户。。(2)添加用户:登录ID、密码、用户名、添加日期、所属部门等。(32)编辑APP版本信息用户:管理员可以对APP版本信息用户信息进行编辑。编辑内容不包括用户密码。(43)启用/停用APP版本信息用户:停用/启用功能用于暂停或恢复相应用户的平台使用权限停用的租户将不允许登录平台开启或停止此APP版本的更新推送。平台APP版本管理和APP更新步骤图发布新版本流程:新版APP开发测试完成(对应发布新APP版本)>在APP管理平台的APP版本管理模块增加一条新的APP版本记录(因为要对APP进行升级管理,需要记录每一次的版本信息。APP检查更新时,提交APP当前版本信息,服务器进行对比判断并返回是否有更新,如有则返回新版APP路径,供客户端下载)>部署新版APP安装包(将新版APP安装包放置于某路径下,并将此路径录入第二步中的记录中,供手机端远程下载)。天溯动态功能,实现共分两部分:提示功能和公司及产品介绍内容本身。为了灵活兼容各种需求场景,此处采用提示和内容分离的方式实现。(一)动态提示管理,此功能是每次修改天溯动态后,需向APP用户进行的提示的管理功能。提示管理功能包括新增提示、编辑提示、删除提示、查询提示。(1)新增提示:一个提示的字段有:提示代码、提示开始日期、提示结束日期。(2)编辑提示:每条提示的编辑功能。(3)删除提示:对无效的提示、错误的提示进行删除。(二)公司产品推介天溯动态,动态信息是公司客户展示我司的形象面貌、最新产品动态的窗口。鉴于此页面可能更新频繁,固此页面主要在服务器端实现。此页面采用纯H5静态页面方式实现,不属于平台系统的特定路径下。用户查看此功能时,远程访问此页面展示给用户。(1)公司产品推介首页:包括我司公司介绍、产品介绍两个模块的简单介绍和入口。(2)公司详情介绍:展示向客户提供的我司相关的信息,图文并茂。(3)最新产品介绍:展示我司最新的产品规划、软硬件产品最新的成果等。FAQ知识库管理是对APP用户经常遇到的问题的汇总信息能源运维行业的专业知识、经验知识汇总的知识库管理模块。主要实现的功能有:常见问题知识查询、知识添加、常见问题知识编辑、常见问题知识删除等。不同版本具有不同的知识库。(1)知识常见问题查询:平台用户能够查询知识常见问题。支持按照所属版本、知识问题类型、知识标签、知识标题问题关键字、解答关键字知识内容等进行查询。支持模糊查询。(2)添加知识常见问题:平台用户能够添加知识常见问题。常见问题主要包括知识问题类型、知识标签、知识问题标题、知识内容问题解答、知识问题排序等。知识内容是图文混合模式,采用HTML编辑控件实现。(3)编辑知识常见问题:平台用户能编辑已有的知识加常见问题内容。(4)删除知识常见问题:平台用户能够对不需要的知识常见问题进行删除。意见反馈管理是对APP用户反馈使用意见的管理模块。主要实现的功能有:APP用户反馈意见的查询、回复APP用户的反馈、导出用户反馈、标记用户反馈等功能。意见反馈区分版本及客户。(1)查询反馈意见:平台用户能够查询用户反馈意见。支持按照平台版本、反馈时间、反馈人、问题类型、关键字等进行查询。支持模糊查询。(2)回复用户反馈问题:平台用户能够对用户反馈信息进行回复,此回复内容可被反馈的用户查看。(3)导出用户反馈及回复:为了更好的分析用户反馈意见,平台支持对用户反馈信息的导出功能。(4)标记重要反馈信息:平台用户可以对重要的反馈意见进行标记,以方便后续汇总和管理。用户管理是APP公共管理平台用户的管理模块。基本功能包括用户查询、添加用户、用户资料修改、用户删除、修改用户密码等功能。(1)查询用户:管理员通过输入查询条件进行检索,得到查询结果,即符合查询条件的用户列表。支持模糊查询。(2)添加用户:登录ID、密码、用户名、添加日期、所属部门等。(3)编辑用户:管理员可以对用户信息进行编辑。编辑内容不包括用户密码。(4)启用/停用用户:停用/启用功能用于暂停或恢复相应用户的平台使用权限停用的租户将不允许登录平台。APP页面用户访问统计信息查询页面,是用户使用APP在各页面停留时长的统计信息汇总页面。此功能是为产品经理团队开发,方便产品经理团队了解APP用户使用APP个页面的频率及时长的信息。支持查询每个用户的在某个页面使用时长和访问频次、所有用户在不同页面的访问时长和访问频次等。(1)查询单个用户的使用信息:查询每个用户的在某个页面使用时长和访问频次。(2)查询所有用户的使用信息:统计显示所有用户在不同页面的访问时长和访问频次等。4接口设计4.1外部接口4.1.1版本更新检查接口后续细化,下同后续细化,下同4.1.2获取天溯动态的更新提示服务4.1.3查询新闻列表接口同步到其它列表接口同步到其它列表接口4.1.4获取新闻详情接口4.1.2获取公司及产品的推介服务此接口不是非数据接口。公司产品推介服务主要是HTML5以图文并茂的静态页面方式实现公司产品介绍的页面。部署与APP公共平台的特定路径中。由APP远程访问。主要包括首页、公司介绍页、公司最新产品介绍页三部分。4.1.3获取知识分类接口4.1.432获取某分类下的FAQ知识分类列表接口4.1.43获取某分类下FAQ列表接口4.1.5查询知识库列表接口4.1.654获取某FAQ知识的详情接口4.1.5765提交反馈意见接口新增数据用POST。PUT一般用来修改数据新增数据用POST。PUT一般用来修改数据4.1.6获取反馈意见列表接口同步到其它列表接口同步到其它列表接口4.1.7876获取反馈意见回复接口4.1.8987提交用户页面访问时长接口新增数据用POST,PUT一般用来修改数据新增数据用POST,PUT一般用来修改数据4.1.910关于页面接口4.2内部接口4.2.1配置服务器信息接口4.2.2用户登录接口4.2.3用户登出接口4.2.4获取当月能耗总览信息能源能耗占比数据接口4.2.5获取KPI信息接口4.2.65获取区域树/业态树接口4.2.765获取当月能耗分析数据接口4.2.76获取当月能耗KPI数据接口4.2.8获取告警处理统计接口(实时)4.2.8获取告警筛选条件接口4.2.987获取告警列表数据接口同步到其它列表接口同步到其它列表接口4.2.1098获取告警详情及历史处理信息接口4.2.11获取告警历史处理信息接口4.2.12告警操作(确认、处理、撤销,单个/批量)接口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问题内容知识标题ANSWER
温馨提示
- 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
- 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
- 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
- 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
- 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
- 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
- 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。
最新文档
- 洛阳文化旅游职业学院《体育法》2023-2024学年第一学期期末试卷
- 2024年植保无人机及其配件采购合同
- 单位人员管理制度范例大全
- 地热养殖基地施工合同
- 2024年快手电商合作合同样本版B版
- 商业街区巡逻保安协议
- 大型度假村建设施工管理承包合同
- 临时健身房租赁与教练服务合同
- 2025运输保险合同范本
- 消防栓检查与维护手册
- 读了萧平实导师的《念佛三昧修学次第》才知道原来念佛门中有微妙法
- 周边传动浓缩刮泥机检验报告(ZBG型)(完整版)
- 纸箱理论抗压强度、边压强度、耐破强度的计算
- 土地增值税清算审核指南
- 死亡通知书模板
- 鹬蚌相争课件
- PMC(计划物控)面试经典笔试试卷及答案
- 失业保险金申领表_11979
- 《质量管理体系文件》风险和机遇评估分析表
- 食品安全约谈通知书
- 舒尔特方格A4直接打印版
评论
0/150
提交评论