接口规范
中国电信商务领航定制终端
管理系统技术规范 (BNSP接口)
2008年10月
页码:1/14
1. 定义和缩写 ......................................................................................................................................................3 2. 系统目标 ..........................................................................................................................................................4 3. 接口概述 ..........................................................................................................................................................5 4. 接口说明 ..........................................................................................................................................................7 4.1. 4.1.1. 4.1.2. 4.2. 4.2.1. 4.2.2.
源数据发布接口 ....................................................................................................................................7 接口场景描述....................................................................................................................................7 接口时序.............................................................................................................................................7 获取数据集成反馈结果接口............................................................................................................11 接口场景描述..................................................................................................................................11 接口时序...........................................................................................................................................11
1. 数据反馈通知方式 ..................................................................................................................................12 2. 数据反馈通知文件命名及格式规范 ...................................................................................................13 5. 异常处理 ........................................................................................................................................................14
接口规范 页码:2/14
1. 定义和缩写
接收数据系统:
商务领航定制终端技术服务支撑平台系统:简称(BNSP) 传送数据系统:
各省的网关管理系统:简称(BBMS)
接口规范
页码:3/14
2. 系统目标
能查询按网关类型划分的统计内容 能查询按套餐类型划分的统计内容 能查询按接入方式划分的统计内容 能查询按厂商划分的统计内容 接口规范能查询按业务状态划分的统计内容
页码:4/14
3. 接口概述
BNSP(商务领航定制终端技术服务支撑平台系统) 数据传送接口A省BBMS系统B省BBMS系统C省BBMS系统
各省BBMS作为源系统,将源数据以文本文件方式通过FTP方式(程序自动实现)保存到BNSP系统的指定路径,BNSP系统去指定路径获得源数据。具体流程如下:
BNSP系统首先在本地FTP的指定路径下建立省份文件夹,其次在省份
文件中每天创建时间文件夹
各省BBMS系统按照规定的格式,将源数据生成的文本文件保存在
BNSP系统的服务器下,.数据生成以天为单位,形成多个数据源文件。BNSP系统去本地指定的文件夹进行数据采集。 BNSP系统读取BBMS系统数据进行入库处理。
数据入库处理结束后,同时生成结果报告反馈给各省BBMS系统。 如果其中某个省的传输源文件没有收到、格式错误和其它错误,BNSP
系统会生成ErrorReport文件, 并把反馈文件存放在本地的服务器下,BBMS系统进行自动获取该文件,并判断传输数据是否正确。
各系统接口的实现功能
接口规范
页码:5/14
BNSP(商务领航定制终端技术服务支撑平台系统)实现的功能: 定期创建时间文件夹,存放BBMS系统的源数据 定期获取BBMS系统传送的源数据文件
数据处理完成后,反馈数据集成结果给各省BBMS系统
各省BBMS系统实现的功能:
接口规范 定期生成源数据文件并发送到BNSP系统指定的文件路径。 获取BNSP(商务领航定制终端技术服务支撑平台系统)的数据集成结
果的反馈 页码:6/14
4. 接口说明
4.1.源数据发布接口 4.1.1.
接口场景描述
该接口用于各业务系统(各省BBMS系统)向BNSP系统定期传送源数据。
4.1.2. 接口时序
业务流程:
省BBMS系统BNSP系统1、传送源数据2、数据读取、处理3、获取数据集成反馈(异步)
发起方:各省BBMS系统 接收方:BNSP系统 接口协议:ftp
数据传送方式
IP地址为:xxx.xxx.xxx.xxx
FTP帐号为:用户名/******,(暂定为:用户名: 省份码+user,密码:省份码+user 目录:
/sme/省份码 /时间文件夹 放置各省BBMS系统传送的源数据文件;
接口规范 页码:7/14
各省BBMS系统定期生成源数据文件;
数据文件命名格式 数据文件
文件命名格式:省份码+表名+文件采集时间+.txt 文件编码格式:所有文件以GB2312为统一的编码格式 1) 省份码
省份编号如下:
省份 省份码 上海市 S01 江苏省 S02 浙江省 S03 安徽省 S04 陕西省 S05 福建省 S06 甘肃省 S07 北京市 S08 广东省 S09 广西壮族自治区 S10 贵州省 S11 海南省 S12 河北省 S13 河南省 S14 黑龙江省 S15 湖北省 S16 湖南省 S17 吉林省 S18 江西省 S19 辽宁省 S20 内蒙古自治区 S21 宁夏回族自治区 S22 青海省 S23 山东省 S24 山西省 S25 四川省 S26 云南省 S27 西藏自治区 S28 新疆维吾尔自治区 S29 接口规范
页码:8/14
天津市 重庆市 S30 S31 2) 表名:
网关型号统计表:gateway 套餐类型统计表:series 接入方式统计表:connect_way 厂商网关型号统计表:factor_gateway 业务类型统计表:work_type
3) 文件采集时间,(注:文件生成时间的前一天,既数据采集时间): 用“YYYYMMDD”表示,如2007年10月20日表示为“20071020”;
数据文件格式
采用文本方式,每个字段之间用竖线相隔,如果字段内容为空则用大写字符串“NULL”表示,每一条记录按照换行来相隔。 数据传送时间
1) 各省BBMS系统每日于3:00传送相关数据文件; 2) BNSP系统于每日4:00,读取数据文件;
3) BNSP系统于每日4点30生成当天的采集结果的反馈文件;
文件内容 数据文件:
网关型号统计表:gateway
网关型号统计表(gateway_table) 字段含义 位置信息(省份) 受理量 注册量 在线量 接口规范
字段名 province accetp regist device_status 类型 varchar2(20) int int int
描述 参照编码表 总数量,具体详见备注 总数量,具体详见备注 总数量,具体详见备注 页码:9/14
网关型号 统计时间 gateway_type time varchar2(20) string(10) 参照编码表 格式:年-月-日
套餐类型统计表:series
套餐类型统计表(series_table) 字段含义 位置信息(省份) 受理量 注册量 套餐类型 速率 统计时间 字段名 province accetp regist series_type gateway_speed time 类型 varchar2(20) int int varchar2(20) varchar2(20) string(10) 描述 参照编码表 总数量,具体详见备注 总数量,具体详见备注 参照编码表 参照编码表 格式:年-月-日
接入方式统计表:connect_way
接入方式统计表(connect_way_table) 字段含义 位置信息(省份) 数量 百分比 接入方式 统计时间 字段名 province num percent connect_type time 类型 varchar2(20) int varchar2(8) varchar2(20) string(10) 描述 参照编码表 总数量 格式为:25% 参照编码表 格式:年-月-日
厂商网关型号统计表:factor_gateway
厂商网关型号统计表(factory_gateway_table) 字段含义 位置信息(省份) 注册量 网关型号 厂商 统计时间 字段名 province regist gateway_type factory_name time 类型 varchar2(20) int varchar2(20) varchar2(20) string(10) 描述 参照编码表 总数量,具体详见备注 参照编码表 参照编码表 格式:年-月-日
业务类型统计表:work_type
业务类型统计表(work_type_table) 接口规范
页码:10/14
字段含义 位置信息(省份) 开通量 暂停量 复机量 移机量 拆机量 业务名称 统计时间 字段名 province opens number pause number restoration number moves number stops number work_name time 类型 varchar2(20) int int int int int varchar2(20) string(10) 描述 参照编码表 总数量 总数量 总数量 总数量 总数量 参照编码表 格式:年-月-日 备注:
受理量:受理量是CRM受理的网关设备量的统计 注册量:注册量是BBMS管理的网关设备量的统计 在线量:在线量是BBMS统计时刻网关设备在线数量
4.2.获取数据集成反馈结果接口 4.2.1.
接口场景描述
该接口用于BNSP系统反馈数据集成结果。
4.2.2. 接口时序
业务流程:
省BBMS系统BNSP系统数据集成反馈(异步)
发起方:各省BBMS系统
接口规范
页码:11/14
接收方: BNSP系统 接口协议:ftp
接收数据集成反馈结果接口格式:
数据传送方式
IP地址为:xxx.xxx.xxx.xxx FTP帐号为:同上面定义,
目录:BBMS系统需去BNSP系统FTP服务器下指定路径去获取
/SME/省份码/时间文件夹 BNSP系统上传的反馈信息文件;
在每天BNSP系统采集完各省的BBMS数据后,系统会对采集的数据文件进行检查,以确定从各省采集的BBMS数据是否有数据文件缺失。
如果某省发生数据文件缺失,则BNSP系统将不对该省的数据进行数据预处理和数据分析。并会向发生数据文件缺失的省BBMS给出数据缺失通知,存放在BNSP系统的本地服务器中,要求该省BBMS必须在当天将缺失的数据文件重新上传FTP,省BBMS对接收到的数据缺失报告进行解析,然后将缺失的数据文件上传,再由BNSP系统进行采集,直至BNSP系统反馈成功为止。如果重试还是失败,BNSP系统应该向本系统管理员发送邮件告警,并转人工干预。
1. 数据反馈通知方式
要求BNSP系统给出数据缺失通知文件,BBMS系统通过FTP方式读取数据缺失通知文件;省BBMS对接收到的数据缺失通知文件进行解析,然后将缺失的数据文件上传。
各省BBMS系统对BNSP FTP Server的要求:
FTP用户名和密码:BNSP开通 FTP Server上为BBMS系统开设FTP登录
用户名和密码;
用户名/密码暂定为:定义同上
接口规范 页码:12/14
FTP文件目录:BNSP FTP Server上为BBMS系统开设数据缺失通知文件的
上传目录;
FTP文件目录暂定为:/SME/省份码/时间文件夹
2. 数据反馈通知文件命名及格式规范 1) 文件命名规范
当发生数据文件缺失时,系统会向相关省BBMS发送数据缺失通知信息;若数据文件完整(文件齐全,格式正确)BNSP系统也会向相关省BBMS发送数据接收成功通知信息。
反馈文件后缀名规则:re{n}”(n表示重传次数)标识,进行区别。 数据通知文件的命名格式为: INFORM .re{n}
INFORM:表示是数据反馈通知;
例:INFORM.re1 :表示BNSP第一次反馈的文件
INFORM.re2 :表示BNSP第二次反馈的文件
2) 文件格式规范 反馈文件: 字段内容 字段类型 注释 反馈结果(0:成功,1:文件缺失失败,2:格式错CHAR(2) 误失败,3:其他错误) 缺失文件名(如有多条,以分号分割)
CHAR(256) 接口规范 页码:13/14
5. 异常处理
异常自动处理场景描述:
1.当BNSP系统数据采集应用发现数据有误(文件未找到、格式错误、数据错误等),以FTP反馈文件(后缀为re{n})的方式通知BBMS厂商; 2.厂商收到需要定期检查反馈文件,并及时处理,重新上传相关文件; 3.BNSP系统数据采集应用在等待指定的时间后,重新下载所有的文件,并进行相关检查和处理。
异常自动处理每天处理2次,超过2次的采用人工干预 具体时间和任务如下:
时间(24H) 4:00之前 4:00 6:00之前 6:00 BBMS厂商 上传当天数据 检查相关反馈文件 修正错误(第一次),重新上传文件 检查相关反馈文件 BNSP系统 下载相关文件 上传反馈文件 重新下载并处理 第二次上传反馈文件 重新下载并处理 第三次上传反馈文件 如果有错误则处理如下事务 8:00之前 8:00 10:00之前 10:00 如果有错误则处理如下事务 修正错误(第二次),12:00之前 重新上传文件 12:00 14:00之前 14:00 检查相关反馈文件 如果有错误则人工干预
接口规范 页码:14/14
因篇幅问题不能全部显示,请点此查看更多更全内容