XX系统概要设计说明书

目录

1. 文档介绍 1

1.1 文档目的 1

1.2 文档范围 1

1.3 读者对象 1

1.4 参考文献 1

1.5 术语与缩写解释 1

2. 系统概述 2

3. 设计约束 2

3.1需求约束 2

3.2隐含约束 2

4. 设计策略 3

4.1扩展策略 3

4.2复用策略 3

4.3折衷策略 3

5．系统总体结构 3

5.1、系统总体结构 3

5.2、子系统功能及接口 4

6. 子系统的结构与功能 5

6.1、TERMSERV 5

7. 功能需求追溯 5

8. 环境的配置 5

9．其它 6

附录 6

A、 与主机接口 6

B、与终端接口 6

1. 文档介绍

1.1 文档目的

编写该文档的目的在于从总体设计的角度明确xxxx系统的功能和处理模式，明确与银联的接口，使系统开发人员和产品管理人员明确产品功能，可以有针对性的进行系统开发、测试、验收等各方面的工作。

1.2 文档范围

1.3 读者对象

该文档的读者为用户代表、软件分析人员、开发管理人员和测试人员。

1.4 参考文献

《xxxx系统需求说明书》　

1.5 术语与缩写解释

无

2. 系统概述

XX系统是以触摸屏为主要交互工具，帮助用户以自助方式做业务查询。本系统的主要功能包括：话费查询、新业务介绍、网点分布查询、自助终端分布查询、电信新闻、交易监控、设备维护和监控等。本系统的设计目标是保证系统可以7*24小时安全、高效无故障运行；业务人员可以轻松完成设备和交易的监控、管理工作；报表种类齐全，可以满足业务人员各种帐务需求。

3. 设计约束

3.1需求约束

* 本系统应当遵循的标准

数据命名的规则遵循《C语言编程规约》中相关的规定；

* 软、硬件环境

本系统共包括联机处理和系统监控2大模块。

联机模块基于C/S结构，采用AIX操作系统，informix数据库，用ESQL/C语言开发，服务器采用PC

SERVER；

监控模块基于B/S结构，采用WIN9X/2000/XP操作系统，使用ASP.NET开发。

* 接口/协议

系统与自助终端和电信主机之间的通讯使用TCP/IP协议；

与自助终端的接口见附录A、与自助终端接口

与电信主机的接口见附录B、与电信接口

* 用户界面

监控部分使用WINDOWS图形化界面，保证中专以上文化程度的人员可以无障碍操作。

* 软件质量

正确性：系统必须交易能够被正确处理；

健壮性：系统应能够7*24小时无故障运行；

效率：系统可以支持100个终端同时发起交易，处理交易的时间不超过10秒钟；

易用性：监控界面应采用图形化操作方式，便于业务人员操作；

安全性：报文中的关键数据域以密文的方式传输；

可扩展性：应该充分考虑到将来交易的修改或增加，避免需求变更时大规模修改程序；

3.2隐含约束

使用监控管理功能的人员是银行的业务人员，他们具有较强的业务技能和基本的电脑知识，对他们提供的操作界面应保证他们经过简单培训后无障碍的操作；

报表应该可以在多种操作系统上浏览、打印；

系统应提供审记追踪功能；

应该把有可能变动的参数存放到配置文件或数据库中，保证修改参数的灵活性。

4. 设计策略

4.1扩展策略

该系统是事务处理型系统，将来功能的扩展主要是指增加新的交易。为了方便本系统在将来扩展功能，在做系统设计时应采取如下策略：

为了保证增加新的功能或接口变更时程序改动规模最小化，应该使用报文格式配置文件解析、组织报文；

为了保证系统的灵活性，应该把可变参数保存到配置文件中；

XX系统详细设计说明书

目录

第一章 引言 1

1.1 概述 1

1.2 背景 1

1.3 定义 1

1.4 参考资料 1

1.5 术语与缩写解释 1

2. 程序结构 2

2.1 模块汇总表 2

3. 程序设计说明 2

3.1 终端通讯子系统 2

3.1.1 子系统功能说明 2

3.1.2 子系统流程图 3

3.1.3 子系统模块设计说明 5

4. 数据结构设计 5

4.1 终端档案表 TERMFILE 5

5. 接口设计 5

5.1 与自助设备接口 5

5.2 与主机接口 6

5.3 内部接口 6

第一章 引言

1.1 概述

　　编写

XX产品详细设计说明书的目的在于从详细设计的角度明确XX项目的业务品种、功能范围，明确与业务主机/终端系统的接口和业务处理模式，使系统开发人员和产品管理人员明确产品功能，可以有针对性的进行系统开发、测试、验收等各方面的工作。

1.2 背景

　　系统名称：XX系统

　　任务提出者：XXX

　　开发者：XX部门

　　用户：XX电信

1.3 定义

1.4 参考资料

　　《项目开发计划书》

　　《产品需求分析说明书》

　　《系统总体设计说明书》

1.5 术语与缩写解释

2. 程序结构

2.1 模块汇总表

终端通讯子系统模块名称功能简述readdata接收终端请求报文writelog把报文写入日志setsockscoket设置解析/组织报文以及报文分流模块名称功能简述unpack_c解析终端请求报文printstruct_c输出解吸后的报文checkpackage报文合法性检查pack_c组织应答报文：：：：

3. 程序设计说明

3.1 终端通讯子系统

3.1.1 子系统功能说明

建立TCP/IP 服务器侦听从来自自助设备端的连接请求。

为一个侦听到的连接创建一个进程，负责该连接上的接收和发送，并将接收和发送的原始数据写入LOG文件。

将接收到的数据送到队列1，从队列2取数据进行用于发送。

实现子系统功能程序列表：

termserv.c

子系统接口描述:

输入：终端请求报文、解析/组织报文以及报文分流模块产生的应答报文

输出：向解析/组织报文以及报文分流模块输出终端请求报文、向终端输出应答报文、向日志文件输出接收到的数据

3.1.2 子系统流程图

第一章 引言.... 1

1.1 编写目的... 1

1.2 项目背景... 1

1.3 基本定义... 1

第二章 产品概述.... 2

2.1 系统功能... 2

2.2 运行环境... 2

2.3 用户的特点... 2

2.3 条件与限制... 2

第三章 功能需求.... 3

3.1 功能划分... 3

3.2 功能描述... 3

4.3 软件接口... 4

4.4 故障处理... 4

第四章 其它需求.... 5

4.1 应用环境... 5

4.2 其它要求... 5

第一章 引言

1.1 编写目的

编写该文档的目的在于明确XX系统的用户需求，使得软件开发人员与用户对待开发软件的需求有统一的、无二义性的认识。该文档所描述的内容，可作为软件确认测试的依据。该文档的读者为用户代表、软件分析人员、开发管理人员和测试人员。

1.2 项目背景

见《XX项目启动会议记要》

1.3 基本定义

第二章 产品概述

2.1 系统功能

序号

功能名称

优先级

简要描述

1联机功能

高

解决实时交易问题

2管理监控功能

高

解决终端日常维护问题

2.2 运行环境

软件平台：服务器为AIX UNIX 4.3.3操作系统、informix数据库；

监控端为WINDONS 98/2000/XP操作系统。

硬件平台：服务器为IBM RS6000系列主机；

监控端为PC机。

2.3 用户的特点

由于使用自助终端的人员是广大市民，所以自助终端的操作界面应满足初中以上文化程度的人无障碍的操作；

使用监控管理功能的人员是业务人员，他们具有较强的业务技能和基本的电脑知识，对他们提供的操作界面应保证他们经过培训后无障碍的操作。

2.3 条件与限制

本次开发的期限为2002-2-5开始，2002-3-5结束；

议采用SOCKET通讯协议；

主机端的接口由主机端给出，不可更改；

与终端的接口由公司与终端厂家协商。

例如，颜色值 #FF0000 之所以被渲染为红色，是因为红色的值达到了最高值 FF (等于十进制的 255)。

当你使用 !DOCTYPE 声明指定为标准兼容模式时，Microsoft^® Internet Explorer 6 和以后版本将忽略不遵从样式表(CSS)级别 1 的样式表声明。根据 CSS 1，以十六进制 RGB 值指定的颜色必须带有前导“#”字符。像“FFFFFF”这样的值将被忽略，而不会被理解为“#FFFFFF”(即白色)，但 Internet Explorer 的先前版本是这么理解的。这影响所有接受颜色值的属性。

下表列出了 Internet Explorer 4.0 支持的颜色。

用户定义的系统颜色

Microsoft^® Windows^® 维护着一组用于绘制用户界面不同部分的系统颜色。除了定义在颜色表中的颜色，在 Internet Explorer 4.0 中也可正常显示以下系统颜色指定为颜色值的 Web 页。

用户可以使用 Windows 控制面板设置用于将来 Windows 会话的系统颜色。下表演示了定义在控制面板中的颜色名称的对应情况。

GNOME:

CTRL+B 书签

CTRL+D 复制粘贴

CTRL+F 查找

SHIFT+CTRL+F WEB查找

CTRL+I 显示属性页

CTRL+H 切换到HOME

CTRL+U 向上一级

CTRL+N 建立新文件夹

CTRL+O 打开

CTRL+W 关闭窗口

SHIFT+CTRL+W 关闭所有窗口

CTRL+= 放大

CTRL+- 缩小

CTRL+[ 返回

CTRL+] 向前

CTRL+T 放到垃圾筒

CTRL+R 刷新

CTRL+A 全选

KDE

CTRL+TAB 切换工作桌面

ALT+TAB 切换应用程序

ALT+F1 打开应用程序菜单

ALT+F2 打开命令窗口

ALT+F3 打开窗口菜单

ALT+F4 关闭窗口

F1 HELP

F2 在页面搜索

F3 在页面搜索下一个

SPACE 选中/取消选中文件

CTRL+N 打开文件管理器

CTRL+A 全选当前目录下的文件和目录

CTRL+T 在当前目录下打开一个终端

CTRL+W 关闭窗口

CTRL+F 搜索文件

CTRL+C 拷贝

CTRL+r 粘贴

Char  Dec  Oct  Hex | Char  Dec  Oct  Hex | Char  Dec  Oct  Hex | Char Dec  Oct   Hex
-------------------------------------------------------------------------------------
(nul)   0 0000 0x00 | (sp)   32 0040 0x20 | @      64 0100 0x40 | `      96 0140 0x60
(soh)   1 0001 0x01 | !      33 0041 0x21 | A      65 0101 0x41 | a      97 0141 0x61
(stx)   2 0002 0x02 | "      34 0042 0x22 | B      66 0102 0x42 | b      98 0142 0x62
(etx)   3 0003 0x03 | #      35 0043 0x23 | C      67 0103 0x43 | c      99 0143 0x63
(eot)   4 0004 0x04 | $      36 0044 0x24 | D      68 0104 0x44 | d     100 0144 0x64
(enq)   5 0005 0x05 | %      37 0045 0x25 | E      69 0105 0x45 | e     101 0145 0x65
(ack)   6 0006 0x06 | &      38 0046 0x26 | F      70 0106 0x46 | f     102 0146 0x66
(bel)   7 0007 0x07 | '      39 0047 0x27 | G      71 0107 0x47 | g     103 0147 0x67
(bs)    8 0010 0x08 | (      40 0050 0x28 | H      72 0110 0x48 | h     104 0150 0x68
(ht)    9 0011 0x09 | )      41 0051 0x29 | I      73 0111 0x49 | i     105 0151 0x69
(nl)   10 0012 0x0a | *      42 0052 0x2a | J      74 0112 0x4a | j     106 0152 0x6a
(vt)   11 0013 0x0b | +      43 0053 0x2b | K      75 0113 0x4b | k     107 0153 0x6b
(np)   12 0014 0x0c | ,      44 0054 0x2c | L      76 0114 0x4c | l     108 0154 0x6c
(cr)   13 0015 0x0d | -      45 0055 0x2d | M      77 0115 0x4d | m     109 0155 0x6d
(so)   14 0016 0x0e | .      46 0056 0x2e | N      78 0116 0x4e | n     110 0156 0x6e
(si)   15 0017 0x0f | /      47 0057 0x2f | O      79 0117 0x4f | o     111 0157 0x6f
(dle)  16 0020 0x10 | 0      48 0060 0x30 | P      80 0120 0x50 | p     112 0160 0x70
(dc1)  17 0021 0x11 | 1      49 0061 0x31 | Q      81 0121 0x51 | q     113 0161 0x71
(dc2)  18 0022 0x12 | 2      50 0062 0x32 | R      82 0122 0x52 | r     114 0162 0x72
(dc3)  19 0023 0x13 | 3      51 0063 0x33 | S      83 0123 0x53 | s     115 0163 0x73
(dc4)  20 0024 0x14 | 4      52 0064 0x34 | T      84 0124 0x54 | t     116 0164 0x74
(nak)  21 0025 0x15 | 5      53 0065 0x35 | U      85 0125 0x55 | u     117 0165 0x75
(syn)  22 0026 0x16 | 6      54 0066 0x36 | V      86 0126 0x56 | v     118 0166 0x76
(etb)  23 0027 0x17 | 7      55 0067 0x37 | W      87 0127 0x57 | w     119 0167 0x77
(can)  24 0030 0x18 | 8      56 0070 0x38 | X      88 0130 0x58 | x     120 0170 0x78
(em)   25 0031 0x19 | 9      57 0071 0x39 | Y      89 0131 0x59 | y     121 0171 0x79
(sub)  26 0032 0x1a | :      58 0072 0x3a | Z      90 0132 0x5a | z     122 0172 0x7a
(esc)  27 0033 0x1b | ;      59 0073 0x3b | [      91 0133 0x5b | {     123 0173 0x7b
(fs)   28 0034 0x1c | <      60 0074 0x3c | \      92 0134 0x5c | |     124 0174 0x7c
(gs)   29 0035 0x1d | =      61 0075 0x3d | ]      93 0135 0x5d | }     125 0175 0x7d
(rs)   30 0036 0x1e | >      62 0076 0x3e | ^      94 0136 0x5e | ~     126 0176 0x7e
(us)   31 0037 0x1f | ?      63 0077 0x3f | _      95 0137 0x5f | (del) 127 0177 0x7f

ASCII Name 
Description 
C Escape Sequence 
nul 
null byte 
\0 
bel 
bell character 
\a 
bs 
backspace 
\b 
ht 
horizontal tab 
\t 
np 
formfeed 
\f 
nl 
newline 
\n 
cr 
carriage return 
\r 
vt 
vertical tab 
esc 
escape 
sp 
space