XX信息系统项目概要设计说明书

1、XX 信息系统项目设计概要说明书模板）建设单位：XXXXXXXXXXXXX承建单位：XXXXXXXXXXXXX二零二零年十月目录 TOC o 1-5 h z HYPERLINK l bookmark6 o Current Document 第 1 章 引言 3 HYPERLINK l bookmark8 o Current Document 1.1编写目的 3 HYPERLINK l bookmark10 o Current Document 1.2项目背景 3 HYPERLINK l bookmark12 o Current Document 1.3定义31.4参考资料 3 HYPERLIN

2、K l bookmark14 o Current Document 第 2 章 总体设计 4 HYPERLINK l bookmark16 o Current Document 2.1需求规定 4基本设计概念和处理流程 5 HYPERLINK l bookmark18 o Current Document 2.2.1 设计原则和要求 5 HYPERLINK l bookmark20 o Current Document 2.2.2 设计概念 5 HYPERLINK l bookmark28 o Current Document 2.3 功能需求与程序的关系 62.3.1 网格事件 62.3.2

3、 基础数据 7 HYPERLINK l bookmark30 o Current Document 2.3.3 综合指挥 7 HYPERLINK l bookmark32 o Current Document 2.3.4 决策分析 8 HYPERLINK l bookmark34 o Current Document 第 3 章 接口设计 9 HYPERLINK l bookmark36 o Current Document 3.1 用户接口 93.2 外部接口 9 HYPERLINK l bookmark38 o Current Document 3.2.1 短信接口 9 HYPERLINK

4、 l bookmark40 o Current Document 3.2.2 网络传真 9内部接口 10 HYPERLINK l bookmark42 o Current Document 第 4 章 运行设计 11 HYPERLINK l bookmark44 o Current Document 4.1 运行模块组合 11 HYPERLINK l bookmark46 o Current Document 运行控制 11 HYPERLINK l bookmark48 o Current Document 运行时间 11 HYPERLINK l bookmark50 o Current Do

5、cument 第 5 章 系统出错处理设计 12 HYPERLINK l bookmark52 o Current Document 出错信息 12补救措施 13 HYPERLINK l bookmark56 o Current Document 5.3系统维护设计 13第1章 引言编写目的本文档依照xxxx项目_需求规格说明书进行编写，目的是 对该项目进行总体设计，在明确系统需求的基础上划分系统的功能模 块，进行系统开发的分工，为进行后面的详细设计和实现做准备。本文档的预期读者为项目业主、系统设计以及项目其他相关人员项目背景根据某社会应急联动工作机制及机制运行现状，结合当前先进的 网络技术、

6、计算机技术、移动互联网技术等搭建一套贯穿各个联动单 位的业务平台，实现社会应急联动指令“一个平台”“、“一呼百应”、 “一竿到底”、“一触即发“及各类应急管理信息大整合的城市应急综 合指挥调度平台。平台支持多级派单，根据用户需要，可设定多个分 中心，以联动中心为龙头，分中心为分支，多级交办。定义缩略语，包括本文档规定的名词术语以及英文缩写：缩略语说明/定义吃111.4 参考资料序号文档名称文档编号作者/修订者发布日期出版单位备注1项目投标书一一技术文件2项目开发合同3各阶段讨论的会议纪要4需求规格说明书本文档中直接引用的所有文档，包括其它相关文档、经审批的立 项申请表或合同、批文和编制该文档时

7、参考的资料、文献、软件开发 标准等。第2章 总体设计根据某社会应急联动工作机制及机制运行现状，结合当前先进的 网络技术、计算机技术、移动互联网技术等搭建一套贯穿各个联动单 位的业务平台，实现社会应急联动指令“一个平台”“、“一呼百应”、 “一竿到底”、“一触即发“及各类应急管理信息大整合的城市应急综 合指挥调度平台。平台支持多级派单，根据用户需要，可设定多个分 中心，以联动中心为龙头，分中心为分支，多级交办。平台以指挥调度为中心，依靠短信指令、网络派单等方式，建立 安全、快速、高效的应急指挥体系，以应急预案库、应急专家库和应 急知识库等为辅助，借助 GIS 平台进一步实现可视化调度、扁平化指

8、挥。需求规定需求包括联动门户网站、接警受理子系统相关平台的建设需求，具体可见某公安分局应急联动子系统需求规格说明书V1.0.0。设计原则和要求程序中各模块间相互独立，但有公共接口供其它模块访问，其它 不公开的数据严格封闭；当某一个模块中出现不能解决的异常须弹出 错误信息；系统中的部分内置矩阵可以在后期维护过程中根据需求进 行更改。设计概念Cas 单点认证平台：Cas是业界最常用的可靠的单点登录解决方法，本系统所有应用 全部通过 Cas 实现统一认证。 TGT 是 CAS 为用户签发的“总的”登 录票据。拥有了 TGT,用户就可以证明自己在CAS成功登录过。TGT 相当于你的护照，拥有了护照就能

9、证明你的身份。 TGT 的本质就是 Cookie。用户在CAS认证成功后，CAS生成cookie，写入浏览器，同 时生成一个TGT对象，放入CAS服务器端的缓存中。当客户端浏览 器再次请求时，会提交 cookie，CAS 以此 cookie 值为 key 查询 CAS 服务器中有无对应的 TGT ，如果有的话，则说明用户之前登录过， 如果没有，则用户需要重新登录。ST是CAS为用户签发的访问某一 应用服务（Service）的票据，例如用户要访问OA, CAS就会给用户 签发访问 OA 的 ST。 ST 有点类似于签证，在护照上加盖一个签证的 钢印，就允许你进入某个国家了，否则光有一张护照还是不

10、行的。用 户访问Service时，系统如果发现用户没有ST，则要求用户去CAS获 取ST。用户向CAS发出获取ST的请求，如果用户的请求中包含CAS 服务器的cookie，则CAS会以此cookie值为key查询缓存中有无 TGT，如果存在TGT，则用此TGT签发一个ST，返回给用户。用户凭 借 ST 去访问 service， service 拿 ST 去 CAS 验证，验证通过后，允许 用户访问资源。统一管理中心：为集团的部门、用户、权限、应用管理提供一站式解决方案，提 供统一日志服务，简化各个平台组织架构、权限等配置管理。协同办公平台：以公文管理为核心，以日常管理、事务审批等功能模块为辅，

11、提 供便捷高效的日常办公平台。移动门户：通过目前主流平台andriod、ios、window，在手机和平板上实现 移动办公平台全覆盖，不仅实现日常办公平台，更提供即时通讯相关 功能，使得办公、沟通更为顺畅。即时通讯：平台界面设计简洁，提供良好的用户体验，集成了组织架构、即 时通讯、文件传输、语音视频、远程协助、公告通知等功能，开放式 的应用中心，用户可自行集成自己的应用，为企业提供了一站式入口。功能需求与程序的关系程序 需求网 格 员专 职 网 格 员兼 职 网 格 员网格长网 格 支 部 书 记社 区 管 理 员社 区 业 务 处 理街 道 管 理 员街 道 业 务 处 理 员区 级 管 理

12、 员区 级 业 务 处 理 员管 理 员系 统 管 理 员参数 配 置日 志 生 成日 志 查 询数 据 交 换网格自动识别VVVVVVVVVVVV签收管理VVVV自动下派VVV事件延期VVV超时配置VVV事件标记功能VVVX示维护表卷换出数据比对VVVVVVVVV注册接口VV全科采集VV分级走访V问卷调查VVV决策分析VV综合指挥程序需求问题事件个体工商户机关单位事业单位社团组织场所信息即时通讯VVVVV信息上图V网格区划V决策分析 程序1 1 需 求待 办 查 询已 办 查 询缓 办 查 询回 收 站关注 提 醒日志填写日 志 查 看计 划 查 看计 划 填 写领 导 日 程便签 维 护工

13、作 交 接交 接 清 单 查 询流程 监 控首 页 元 件 配 置快 捷 菜 单 配 置我 的 意 见 配 置个性 签 名 配 置常 用 联 系 人 配 置短 信 常 用 语 配 置秘 书 代 登 配 置流 程 代 理 人 配 置问 题 反 馈 登 记问 题 反 馈 查 询事件来源统计VVVV第3章 接口设计用户接口在用户界面部分，根据需求分析结果，用户需要一个友善的界面。 在界面设计上，应该做到简单明了，易于操作，并且要注意到界面的 布局，应突出的显示重要的功能以及出错信息。接口方面，各模块之间采用函数调用、参数传递、返回值的方式进行信息传递。接口传递的信息将是以数据结构封装了的数据，以参数

14、传递或返回值的形式在各个模块之间传输。外部接口短信接口系统短信收发的功能由移动提供相关接口，系统调用移动提供的webservice,地址为 HYPERLINK http:/X.X.X.X/webservice/services/sendmsg http:/X.X.X.X/webservice/services/sendmsg（ip 为企业短信接入服务器 ip）。功能接口名称、说明短信发送sendmsg短信接收deliver具体的实现用例及webservice说明文档参考移动提供的java 调用webservice接口-示例、Webservice接口网络传真接口协议：HTTP；数 据 格 式 ：

15、 http:/ bnetaccount =& useraccount 二value&；详细说明：客户端调用此接口通知服务端要使用网络传真产品， 网络传真根据传递的参数验证其合法性，若合法则通过进入使用页面 否则跳出相应的错误提示。具体的接口参数说明参考电信提供的ECP &网络传真接口规范1.1。3.3 内部接口移动门户：移动门户的日常办公的相关接口由 OA 提供，微消息的接口 由即时通讯平台提供，所以接口统一以 webservice 的形式进行发布。 移动门户基于公司的移动中间平台，根据不同的操作，调用不同的接 口，相关接口见下面列表，具体的接口参数及返回值格式见数字城 投（一期）业务系统及支

16、撑平台详细设计（统一管理中心、集团内网 门户、协同办公系统）。功能接口名称数据同步Address_GetAllOUCount、 Address_GetAllUserList用户登录User_Getlnfo待办公文列表Handle_GetUnHandleList、待办公文查看Handle_GetArchive公文处理过程Handle_PostAud itOpinion信息栏目列表WebInfo_GetCateGory信息明细WebInfo_GetDetail会议接口Meeting_Message计划总结Schedule_GetList添加日程Schedule_Add即时通讯:即时通讯需提供一些接

17、口供其它系统进行调用，如统一管理中心需要调用即时通讯的接口进行组织架构的同步、OA需要调用接口进行待办事宜的推送、移动门户需要调用 接口实现微消息的相关功能等，即时通讯提供的接口以 webservice 形式发布，目前需要提供的接口见下面列表，具体的接口参数及返回值格式见数字城投（一期）业务系统及支撑平台详细设计（统一管理中心、集团内网门户、协同办公系统）。功能接口名称添加账号AddUser删除账号RemoveUser修改帐号ModifyUser获取帐号信息GetUser更改登录密码ChangePassword验证登录令牌ValidateToken发送系统消息SendSysMsg第4章 运行设

18、计运行模块组合本程序主要是以一个窗口为模块，一般一个窗口完成一个特定的 功能，主窗口通过打开另一个子窗口来实现各模块之间不同功能的连 接和组织，各模块之间相互独立，程序的可移植性好，各模块之间主 要以传递数据项的方式来实现模块之间的合作和数据共享。运行控制只要符合操作说明书，用户可自由控制，不额外限定用户输入， 异常在程序内部进行处理，给出相应的提示信息。运行时间简单的查询和报表生成平均响应时间在 2 秒以内，最大响应时间 不超过 10 秒；复杂报表生成和一般的分析统计平均响应时间在 10 秒 以内，最大响应时间不超过 20 秒；复杂的分析应用平均响应时间在 30 秒以内，最大响应时间不超过6

19、0 秒；所有客户端的操作应无明显 的等待时间。第5章 系统出错处理设计出错信息统一管理中心、内网门户、协同办公系统：利用 log4j/log4net 提供的错误处理机制，在程序任何可能出错 的地方设置错误捕获和处理程序，对因用户操作不当导致的错误，系 统能积极防止并给出适当的错误提示。确保系统不因为出错而意外终 止，确保系统中的数据不因为出错处理不当而被破坏或丢失。即时通讯：利用 Delphi 异常处理机制，在程序任何可能抛出异常的地方设 置捕获和处理程序。对于因用户非法操作而导致的异常，及时给出提 示或者禁止此处操作。对于系统自身的异常信息一方面记录在日志文 件中，供开发人员定位程序问题，另

20、一方面也会适时给出错误提示信 息，确保系统稳定运行。所有业务系统的日志在统一管理中心可以进行查看。系统出错信息处理方法统一管理中心、协同 办公系统、内网门户系统报错页面由维护人员查看程序日志记录，找出报错 的操作，查看错误原因，并针对该错误进行 修改系统错误提示当用户输入信息不符规范时，系统给出统一友好提示，用户根据提示调整输入信息系统黄页由维护人员查看后台程序日志文件信息，找出报错程序位置，即时处理404由维护人员确认相关页面路径是否配置正 常，即时调整页面路径500由实施或开发人员确认服务器是否正常工 作，应用程序池是否启动，即时进行调整移动门户导致程序崩 溃的异常，程 序会黑屏，卡 死或

21、者直接 退出将该异常信息、设备信息、用户信息以及发 生的时间通过接口发送给服务器保存至中 间管理平台，由开发人员或者实施人员登 录中间管理平台查看错误日志找出原因进 行修复导致界面数 据错误的异 常，界面没有 明显的错误 或者会弹出 错误提醒登录时，提示连接超时首先确认移动端网络是否正常，若移动网 络正常，则由维护人员整理移动中间平台、 移动OA相关接口能否正常访问即时通讯统一错误提示窗体友好提示由用户自行处理，系统错误由开发人员定位程序代码，修改并更新统一错误报告由开发人员查看相关日志文件信息，定位程序代码，修改并更新5.2 补救措施1、通过设置相关应用服务的开机自动重启，当服务器出现异常

22、关闭，重启服务器后，所有应用能够自动重启，无需再做其它操作， 就可以访问相关应用；2、通过数据库的每天定时备份，当原始系统的数据丢失时，可 以通过备份数据进行恢复。系统维护设计1、 系统日志监控 系统的所有关键操作、访问、错误信息统一调用基础框架提供的相 关方法，通过框架的方法存储在数据库里，同时提供相应的查看页面用 于查看所有记录。2、 常见配置文件的维护系统基础配置文件为web.config,包括了下面几个基本配置，cas 单点登录的相关配置： 数据库连接字符串，设置数据库地址、用户名、密码等： 其它参数配置，如存储附件的文件夹地址、是否自动迁移日志等： add key二A tt achFileS to rage value二D框架trunkEpointFrameBigFileUpLoadStorage /add key=SuperPasswordValue value=XXXXX /add key二NewWa it HandleSpecial value二办理/add key=EpointUserManageServiceUrl value= HYPERLINK http:/X.X.X.X/EpointNetoffice7 http:/X.X.X.X/EpointNeto