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

XX信息系统项目设计概要说明书
（模板）
建设单位：XXXXXXXXXXXXX
承建单位：XXXXXXXXXXXXX
二零二零年十月
目录
第1章引言 (3)
1.1编写目的 (3)
1.2项目背景 (3)
1.3定义 (3)
1.4参考资料 (3)
第2章总体设计 (4)
2.1需求规定 (4)
2.2基本设计概念和处理流程 (5)
2.2.1设计原则和要求 (5)
2.2.2设计概念 (5)
2.3功能需求与程序的关系 (6)
2.3.1网格事件 (6)
2.3.2基础数据 (7)
2.3.3综合指挥 (7)
2.3.4决策分析 (8)
第3章接口设计 (9)
3.1用户接口 (9)
3.2外部接口 (9)
3.2.1短信接口 (9)
3.2.2网络传真 (9)
3.3内部接口 (10)
第4章运行设计 (11)
4.1运行模块组合 (11)
4.2运行控制 (11)
4.3运行时间 (11)
第5章系统出错处理设计 (12)
5.1出错信息 (12)
5.2补救措施 (13)
5.3系统维护设计 (13)
第1章引言
1.1编写目的
本文档依照《XXXX项目__需求规格说明书》进行编写，目的是对该项目进行总体设计，在明确系统需求的基础上划分系统的功能模块，进行系统开发的分工，为进行后面的详细设计和实现做准备。

本文档的预期读者为项目业主、系统设计以及项目其他相关人员。

1.2项目背景
根据某社会应急联动工作机制及机制运行现状，结合当前先进的网络技术、计算机技术、移动互联网技术等搭建一套贯穿各个联动单位的业务平台，实现社会应急联动指令“一个平台”“、“一呼百应”、“一竿到底”、“一触即发“及各类应急管理信息大整合的城市应急综合指挥调度平台。

平台支持多级派单，根据用户需要，可设定多个分中心，以联动中心为龙头，分中心为分支，多级交办。

1.3定义
缩略语，包括本文档规定的名词术语以及英文缩写：
1.4参考资料
本文档中直接引用的所有文档，包括其它相关文档、经审批的立项申请表或合同、批文和编制该文档时参考的资料、文献、软件开发标准等。

第2章总体设计
根据某社会应急联动工作机制及机制运行现状，结合当前先进的网络技术、计算机技术、移动互联网技术等搭建一套贯穿各个联动单位的业务平台，实现社会应急联动指令“一个平台”“、“一呼百应”、“一竿到底”、“一触即发“及各类应急管理信息大整合的城市应急综合指挥调度平台。

平台支持多级派单，根据用户需要，可设定多个分中心，以联动中心为龙头，分中心为分支，多级交办。

平台以指挥调度为中心，依靠短信指令、网络派单等方式，建立安全、快速、高效的应急指挥体系，以应急预案库、应急专家库和应
急知识库等为辅助，借助GIS平台进一步实现可视化调度、扁平化指挥。

2.1需求规定
需求包括联动门户网站、接警受理子系统相关平台的建设需求，具体可见《某公安分局应急联动子系统需求规格说明书V1.0.0》。

2.2基本设计概念和处理流程
2.2.1设计原则和要求
程序中各模块间相互独立，但有公共接口供其它模块访问，其它不公开的数据严格封闭；当某一个模块中出现不能解决的异常须弹出错误信息；系统中的部分内置矩阵可以在后期维护过程中根据需求进行更改。

2.2.2设计概念
Cas单点认证平台：
Cas是业界最常用的可靠的单点登录解决方法，本系统所有应用全部通过Cas实现统一认证。

TGT是CAS为用户签发的“总的”登录票据。

拥有了TGT，用户就可以证明自己在CAS成功登录过。

TGT 相当于你的护照，拥有了护照就能证明你的身份。

TGT的本质就是Cookie。

用户在CAS认证成功后，CAS生成cookie，写入浏览器，同时生成一个TGT对象，放入CAS服务器端的缓存中。

当客户端浏览
器再次请求时，会提交cookie，CAS以此cookie值为key查询CAS 服务器中有无对应的TGT ，如果有的话，则说明用户之前登录过，如果没有，则用户需要重新登录。

ST是CAS为用户签发的访问某一应用服务（Service）的票据，例如用户要访问OA，CAS就会给用户签发访问OA的ST。

ST有点类似于签证，在护照上加盖一个签证的钢印，就允许你进入某个国家了，否则光有一张护照还是不行的。

用户访问Service时，系统如果发现用户没有ST，则要求用户去CAS获取ST。

用户向CAS发出获取ST的请求，如果用户的请求中包含CAS 服务器的cookie，则CAS会以此cookie值为key查询缓存中有无TGT，如果存在TGT，则用此TGT签发一个ST，返回给用户。

用户凭借ST去访问service，service拿ST去CAS验证，验证通过后，允许用户访问资源。

统一管理中心：
为集团的部门、用户、权限、应用管理提供一站式解决方案，提供统一日志服务，简化各个平台组织架构、权限等配置管理。

协同办公平台：
以公文管理为核心，以日常管理、事务审批等功能模块为辅，提供便捷高效的日常办公平台。

移动门户：
通过目前主流平台andriod、ios、window，在手机和平板上实现
移动办公平台全覆盖，不仅实现日常办公平台，更提供即时通讯相关功能，使得办公、沟通更为顺畅。

即时通讯：
平台界面设计简洁，提供良好的用户体验，集成了组织架构、即时通讯、文件传输、语音视频、远程协助、公告通知等功能，开放式的应用中心，用户可自行集成自己的应用，为企业提供了一站式入口。

2.3功能需求与程序的关系
2.3.1网格事件
2.3.2基础数据
2.3.3综合指挥
2.3.4决策分析
第3章接口设计
3.1用户接口
在用户界面部分，根据需求分析结果，用户需要一个友善的界面。

在界面设计上，应该做到简单明了，易于操作，并且要注意到界面的布局，应突出的显示重要的功能以及出错信息。

接口方面，各模块之间采用函数调用、参数传递、返回值的方式进行信息传递。

接口传递的信息将是以数据结构封装了的数据，以参
数传递或返回值的形式在各个模块之间传输。

3.2外部接口
3.2.1短信接口
系统短信收发的功能由移动提供相关接口，系统调用移动提供的webservice，地址为http://X.X.X.X/webservice/services/sendmsg （ip为企业短信接入服务器ip）。

具体的实现用例及webservice说明文档参考移动提供的《java 调用webservice接口-示例》、《Webservice接口》。

3.2.2网络传真
接口协议：HTTP；
数据格式：http://<接口地址>/ bnetaccount =<value>& useraccount =<value>&……；
详细说明：客户端调用此接口通知服务端要使用网络传真产品，网络传真根据传递的参数验证其合法性，若合法则通过进入使用页面，否则跳出相应的错误提示。

具体的接口参数说明参考电信提供的《ECP&网络传真接口规范1.1》。

3.3内部接口
移动门户：
移动门户的日常办公的相关接口由OA提供，微消息的接口由即时通讯平台提供，所以接口统一以webservice的形式进行发布。

移动门户基于公司的移动中间平台，根据不同的操作，调用不同的接口，相关接口见下面列表，具体的接口参数及返回值格式见《数字城投（一期）业务系统及支撑平台详细设计（统一管理中心、集团内网门户、协同办公系统）》。

即时通讯:
即时通讯需提供一些接口供其它系统进行调用，如统一管理中心需要调用即时通讯的接口进行组织架构的同步、OA需要调用接口进行待办事宜的推送、移动门户需要调用接口实现微消息的相关功能等，即时通讯提供的接口以webservice形式发布，目前需要提供的接口见下面列表，具体的接口参数及返回值格式见《数字城投（一期）
业务系统及支撑平台详细设计（统一管理中心、集团内网门户、协同办公系统）》。

第4章运行设计
4.1运行模块组合
本程序主要是以一个窗口为模块，一般一个窗口完成一个特定的功能，主窗口通过打开另一个子窗口来实现各模块之间不同功能的连接和组织，各模块之间相互独立，程序的可移植性好，各模块之间主要以传递数据项的方式来实现模块之间的合作和数据共享。

4.2运行控制
只要符合操作说明书，用户可自由控制，不额外限定用户输入，异常在程序内部进行处理，给出相应的提示信息。

4.3运行时间
简单的查询和报表生成平均响应时间在2秒以内，最大响应时间不超过10秒；复杂报表生成和一般的分析统计平均响应时间在10秒以内，最大响应时间不超过20秒；复杂的分析应用平均响应时间在30秒以内，最大响应时间不超过60秒；所有客户端的操作应无明显的等待时间。

第5章系统出错处理设计
5.1出错信息
统一管理中心、内网门户、协同办公系统：
利用log4j/log4net提供的错误处理机制，在程序任何可能出错的地方设置错误捕获和处理程序，对因用户操作不当导致的错误，系统能积极防止并给出适当的错误提示。

确保系统不因为出错而意外终止，确保系统中的数据不因为出错处理不当而被破坏或丢失。

即时通讯：
利用Delphi异常处理机制，在程序任何可能抛出异常的地方设置捕获和处理程序。

对于因用户非法操作而导致的异常，及时给出提示或者禁止此处操作。

对于系统自身的异常信息一方面记录在日志文件中，供开发人员定位程序问题，另一方面也会适时给出错误提示信息，确保系统稳定运行。

所有业务系统的日志在统一管理中心可以进行查看。

5.2补救措施
1、通过设置相关应用服务的开机自动重启，当服务器出现异常
关闭，重启服务器后，所有应用能够自动重启，无需再做其它操作，就可以访问相关应用；
2、通过数据库的每天定时备份，当原始系统的数据丢失时，可
以通过备份数据进行恢复。

5.3系统维护设计
1、系统日志监控
系统的所有关键操作、访问、错误信息统一调用基础框架提供的相关方法，通过框架的方法存储在数据库里，同时提供相应的查看页面用于查看所有记录。

2、常见配置文件的维护
系统基础配置文件为web.config，包括了下面几个基本配置，
cas单点登录的相关配置：
<casClientConfig
casServerLoginUrl="http://192.168.188.11:8088/cas3/login" casServerUrlPrefix="http://192.168.188.11:8088/cas3/" serverName="http://localhost"
notAuthorizedUrl="~/NotAuthorized.aspx"
cookiesRequiredUrl="~/CookiesRequired.aspx" redirectAfterValidation="true" renew="false" singleSignOut="true" ticketValidatorName="Cas20"
serviceTicketManager="CacheServiceTicketManager" />
数据库连接字符串，设置数据库地址、用户名、密码等：
<connectionStrings>
<add name="Frame_ConnectionString"
connectionString="Database=EpointOANew_ZS;Server=192.168.56. 101;User ID=XX;Password=XXXXX;" providerName="System.Data.SqlClient" />
</connectionStrings>
其它参数配置，如存储附件的文件夹地址、是否自动迁移日志等：
<appSettings>
<clear />
<!--存储附件的文件夹地址-->
<add key="AttachFileStorage" value="D\框架
\trunk\EpointFrame\BigFileUpLoadStorage" />
<add key="SuperPasswordValue"
value="XXXXX" />
<add key="FCKeditor:BasePath" value="~/fckeditor/" />
<add key="AutoMoveLogHour" value="1" />
<!-- 是否自动迁移日志时间，如：1，代表是1点中迁移 --> <add key="ValidateID" value="EpointFrame" />
<!-- 下载组织架构的验证ID，只有相同，才能下载 -->
<add key="NewWaitHandleSpecial" value="办理" />
<!--待办事宜特殊背景色对应的类别-->
<add key="EpointUserManageServiceUrl"
value="http://X.X.X.X/EpointNetoffice7" />
<!-- 首次同步组织架构的配置的中心的WebService地址 --> <add key="UsingASP" value="0" />
<!-- 是否为ASP应用模式，如果=1,这为ASP应用模式 -->
<!-- 帐号模式，分别为DB、SOA、AD -->
<add key="AccountDB" value="DB" />
<!--如果此系统只给一个部门使用，IsTop=0；否则=1 -->
<add key="IsTop" value="0" />
<!--公文收发员角色Guid-->
<add key="GWSF" value="公文收发员" />
<!--管理员角色名称-->
<add key="Admin" value="adminGroup" />
<!--部门管理员角色名称-->
<add key="OUAdmin" value="OuAdminGroup" />
<!--网络硬盘的配置项File/DB。

默认为File。

如果没有此配置项则为File。

File为文件存储方式，DB为数据库存储方式-->
<add key="NetHardDiskStorageType" value="DB" />
<!--OA的论坛是否采用的是Discuz论坛，如果是为1，否则，其他-->
<add key="UseDiscuz" value="0"/>
<!-- 当前系统对应的主题，默认只有1个EpointOA8_vmid，使用的masterpage也是WebDeskTop_VMid中的 -->
<add key="AppThemeName" value="EpointOA8_vmid"/>
<!-- 系统登录后的首页面配置，目前分为IMac与Metro，目前在模块管理中对应的子系统关联 -->
<add key="CurrentFrameName" value="IMac"/>
<!--Epoint.Security-->
<add key="Sql_SkipPara" value=""></add>
<add key="Sql_SkipURL"
value="ReadAttachFile.aspx|ImageHandler.aspx|Module_List.asp x|eWebEditor/admin/login.aspx|admin/style.aspx|EpointArchive/Pag es/WorkItem_Unlock.aspx|EpointArchive/Pages/OfficeEdit/Edit_Save .aspx|EpointArchive/Pages/Forms/downloadWebFlowAttach.aspx|ewebe ditor/admin/modilicense.aspx|EpointChat/Pages|Design/MethodRegis ter_Tree.aspx|EpointWorkflow/Pages/Client/WorkItem_Unlock.aspx|f ckeditor/editor/filemanager/connectors/aspx/upload.aspx|eWebEdit or/aspx/upload.aspx|WJRSJOAMisc/Pages/Query/Add_News.aspx" /> <add key="Sql_ShortFileOrFolderNameDisclosure" value="true"/>
<!-->防SQL注入的字符列表 %20为参数中空格-->
<add key="Sql_InData" value="exec|insert|select |delete |update |count(|chr(|mid （|master|truncate|declare|cast|xp_cmdshell" />
<!--是否启用ewebedit控件，默认启用；=false，则不启用--> <add key="EpointEditor:IsUsingEWebEditor" value="true"/> <!-- 系统主题，如果是采用WebDeskTop页面，则固定配置下面的配置项，否则可以不设置 -->
<!--<add key="SkinName" value="Epoint" />-->
</appSettings>
3、软件常见问题维护
a.用户在发文单页面没有“打印发文单”按钮，出现此情况是由于工作流相应活动的“基本信息”--“应用程序配置”里面的“<打印发文单>0</打印发文单>”设置的值为0，将0改成1即可。

b.待办事宜无法在移动端处理，提示“请在PC端处理”，出现此问题，首先确认此步骤是否有涉及到某些特殊的操作，比如需要对正文进行清稿操作，就没法在移动端进行处理的，必须在PC端进行操作，若没有类似的特殊操作，则可以通过工作流相应的活动步骤配置如下事件，就可在移动端进行操作了。