中央业务平台数据下发接口规范.docx

《中央业务平台数据下发接口规范.docx》由会员分享，可在线阅读，更多相关《中央业务平台数据下发接口规范.docx（31页珍藏版）》请在三一办公上搜索。

1、中国移动一级经营分析系统中央业务平台数据下发接口规范飞信分册V1.0中国移动通信有限公司2007年07月文档变更记录序号变更内容说明版本号修订日期生效日期1文档建立1.02007-07-032007年7月目 录1总则11.1背景11.2目的11.3适用范围11.4起草单位11.5解释权11.6参考文档11.7缩略语21.8约定22接口说明42.1接口双方责任42.1.1源数据提供方的责任42.1.2数据接收方的责任42.2接口文件命名规则42.2.1中央业务平台列表42.2.2接口单元编码规则52.2.3文件分类及命名规则52.2.4文件命名说明62.3接口文件设计72.3.1设计原则72.3

2、.2接口文件格式72.4数据质量保障82.4.1数据转换规则82.4.2文件级校验102.4.3数据异常处理机制112.4.4系统及时性要求112.5文件目录及维护112.5.1文件目录的划分112.6文件的保存期123接口数据133.1数据接口133.1.1日活跃用户明细133.1.2月活跃用户明细153.1.3日用户开通/关闭操作记录163.1.4飞信用户登录信息183.1.5飞信用户好友明细203.2字典接口213.2.1飞信字典定义213.2.2飞信字典代码定义224附录：省份编码24271 总则1.1 背景为方便各省经营分析系统共享和利用各中央业务平台产生的大量信息资源，为各省公司的

3、市场经营、决策管理提供及时、准确、科学的数据和应用支撑，特制定本规范。1.2 目的 制订全国统一的接口规范，由一级经营分析系统将中央业务平台相关数据分发各省经营分析系统； 各省经营分析系统根据此接口规范获取中央业务平台数据，并依据规定的数据格式入库存储，开展后续应用分析。1.3 适用范围本接口规范是中国移动一级经营分析系统中央业务平台接口数据下发的基本依据。中国移动各中央业务平台数据的下发以及省公司接收数据应依照本规范执行。1.4 起草单位本接口规范由中国移动通信有限公司业务支撑系统部负责起草。1.5 解释权本接口规范的增补、修订及解释权属中国移动通信有限公司业务支撑系统部。1.6 参考文档中

4、国移动省级经营分析系统与源系统接口规范v2.0中国移动一级经营分析系统省级数据接口规范1.7 缩略语本文将用到以下名词及缩写：缩写专用名词有限公司中国移动通信有限公司一经系统中国移动一级经营分析系统二经系统中国移动省级经营分析系统飞信基于手机应用以及与Internet深度互通的即时通讯产品中央业务平台泛指在全网一点集中建设运营的业务平台1.8 约定名词说明源数据提供方有限公司一经系统数据接收方各省公司二经系统接口文件指源数据提供方根据本方案要求生成的供二经使用的文件，包括接口数据文件、接口校验文件。接口数据文件是指源数据提供方根据本方案要求，在指定的时间内，完成对源数据进行周期性抽取所形成的数

5、据文件。接口校验文件指由源数据提供方在每一个抽取周期中，针对每个接口数据文件产生的文件级校验所依据的信息。文件级校验报告指一级经营分析系统对每一个接口数据文件进行文件级校验后产生的报告文件。日志文件指接口系统在操作过程中进行数据处理的记录文件。由一经系统和中央业务平台产生。包括传输日志、链路状态日志、告警日志等。每日增量指抽取每日00：00-24：00发生变化的、新产生数据的最新状态的快照。每月增量指抽取每月1日00：00时始至月未最后一日24：00止，发生变化的、新产生的数据最新状态的快照。每日全量指抽取每日24：00时，所有数据的最新状态快照。每月全量指抽取每月月未最后一日24：00时，所

6、有数据的最新状态快照。每日新增数据指抽取每日00：00-24：00新产生的数据。每月新增数据指抽取每月1日00：00时始至月未最后一日24：00止，新产生的数据。2 接口说明2.1 接口双方责任2.1.1 源数据提供方的责任 保证提供接口方案规定的数据内容，并在指定的时间范围内完成数据的生成。 保证接口数据文件的大小不能超过2GB，如果接口数据文件太大，必须按要求将文件拆分，拆分后的文件命名参见文件分类及命名规则。 根据接口规范的要求，保证接口文件中的记录各值域在有效的取值范围内，数据中均不能包含0x0D0A（回车换行符），确保数据的有效性和准确性。 数据的提供方负责数据的一致性控制，保证生成

7、的接口数据与中央业务平台中存储的数据一致。 遵循本接口方案中规定的校验规则和异常处理规则，保证提供数据的质量。2.1.2 数据接收方的责任 负责与源数据提供方的信息交互和沟通。 负责对源数据提供方提供的接口数据文件、接口校验文件进行即时的读取、接收、核对及传输。2.2 接口文件命名规则2.2.1 中央业务平台列表 飞信平台2.2.2 接口单元编码规则对中央业务平台的各接口单元的编码采用平台代码与序列号组成，其中平台代码为三位数字，序列号为两位数值，各接口单元的编码规则是：。平台代码编码表：系统名称平台代码飞信业务平台4002.2.3 文件分类及命名规则文件类型文件名格式备注接口数据文件正常数据

8、：增量/全量/新增数据标志_省份编码_数据日期_接口单元编码_重传序号_序列号.dat如正常数据为：a_10100_20031201_01001_00_001.dat增量_省份编码_数据日期_接口单元编码_重传序号_序列号.后缀名接口校验文件正常数据：增量/全量/新增数据标志_省份编码_数据日期_接口单元编码_重传序号.verf对同一个抽取周期同一个接口单元产生的接口数据，如果有文件拆分的，需要将这些文件的校验信息写在同一个接口校验文件内，所以文件名不需要序列号文件级校验报告单个报告文件命名：正常数据：f_增量/全量/新增数据标志_省份编码_数据日期_接口单元编码_重传序号_序列号.verf每

9、一个数据文件，对应一个文件级校验报告省份编码参见：附录一2.2.4 文件命名说明 文件名称中的要素取值 增量/全量标志取值为：增量：“a”，全量：“i” ，新增数据：“s”； 省份编码具体编码请参见附录一。 接口单元编码接口单元编码是每一个接口单元的唯一标识，各接口单元的编码请参见下文。 数据日期数据日期是描述当前抽取周期中，数据的发生日期（如：20031201，则表示抽取的数据是2003年12月1日的快照）。按日抽取的数据文件，其数据日期就是数据的发生日期；按月抽取的数据文件，则数据日期取数据发生的年月（对数据日期有特殊要求的接口单元，将在其“数据要求”中详细描述）。 系统日期系统日期是描述

10、程序处理的日期。例如：记录日志文件时，操作日志文件的日期即为当时取得的操作系统时间。 重传序号重传序号必须是二位数字型字符。重传序号是用于描述同一个接口单元的同一数据日期内，由于数据异常、校验重传等原因，需要重新生成、上传数据时，则需要通过重传序号来描述当前接口文件的重传顺序号：00：表示该数据日期的接口文件是首次正常生成数据上传（非重传）01：表示该数据日期的接口文件是第一次重传02：表示该数据日期的接口文件是第二次重传N+1: 表示该数据日期的接口文件是第N+1次重传 序列号序列号必须是三位数字型字符。序列号是用于描述同一个接口单元在同一个抽取周期中的文件顺序号，若一个接口单元被分割成多个

11、文件或每日多次抽取同一个接口单元，则其流水号必须不同，并且依次递增，如： 001、002、003； 接口数据文件、接口校验文件、接口文件校验报告等所有文件在文件生成过程中，后缀为 .tmp ，待生成文件成功后，再改成.dat等后缀名；此措施用于防止文件生成过程中发生异常。 所有的文件名称中用到的字母均需小写。2.3 接口文件设计2.3.1 设计原则在满足要求的前提下，为了使应用接口尽量简单、明了，并便于实现，一级经营分析系统下发的中央业务平台的数据采用文本文件方式，文件格式采用ASCII码格式。为了保证接口数据的一致性，避免各类数据类型和格式错误，在形成所传输的ASCII格式文件之前，将数据转

12、成本接口方案所规定的数据类型和格式。接口文件均按本方案要求的数据内容、数据类型长度及顺序采用定长方式记录数据，每行数据以回车换行符0x0D0A结束（抽取的数据内容中不能包含此符号）。如果数据的实际字节长度小于方案中要求的字段长度，则必须用空格补齐（右补齐），如果数据的实际长度大于方案中的要求，则需要截断（如字符描述）。接口数据文件均按此描述及顺序，以定长方式记录数据，并以0x0D0A(回车换行符)为每行的结束标志，因此，数据内容中不能包含0x0D0A(回车换行符)。2.3.2 接口文件格式2.3.2.1 接口数据文件接口数据文件的格式请参见下文中对各接口单元的具体描述。2.3.2.2 接口校验

13、文件接口校验文件是由源数据提供方负责，用于描述每一个传输周期内，提供的接口文件的文件列表及数据校验信息，数据采用定长方式，校验文件中的信息由以下内容组成：顺序信息内容数据类型及长度说明1接口数据文件名称char(40)2文件的大小（字节数）number(20)文件的物理存储大小3文件中包含的记录数number(20)文件中包含的记录数4数据日期char(8)日期格式：YYYYMMDD，如果抽取周期为月，则格式为：YYYMM，后两位补空格；5文件的生成时间char(14)日期格式：YYYYMMDDHH24MMSS60x0D0A回车换行符2.4 数据质量保障2.4.1 数据转换规则源数据提供方在生

14、成接口数据文件时，必须遵守如下数据转换规则： 无意义维度取值的转换对中央业务平台中维度取值为NULL值、空值，必须转换成规定长度的空格。 编码格式 汉字：GBK内码 西文：ASCII码 数字格式 在接口数据文件中，数字的表示必须规范，小数点的前后必需有数字，如：0.01或34.0,不能用“.01”或“34.”表示； 符号处理：数字最高位的左边第一位为符号位。对于负数，符号位为“-”，正数不用加符号位； 左对齐，必须以空格右填充至定义的长度； 字符格式 左对齐，必以空格右填充至定义的长度； 空记录（NULL）数据仓库系统中不允许出现NULL，所有中央业务平台中出现的NULL被认为是无意的，所以在

15、上传数据文件中，NULL必须按照如下规则转换： 字符类型的NULL，以空格填充至定义的长度 数字类型的NULL，以0填充，并加以空格填充至定义的长度 时间类型的NULL，以空格填充至定义的长度 空格 在业务系统中，字段的值完全为空格（一个或多个）或字段值首尾包含的空格，在数据仓库中视为无意义，所以如果在业务系统存在中以上类型的空格，必须转换为有意义的其它字符，字符串的前后空格均视为无意义。 日期类型 日期类型统一采用YYYYMMDD格式，YYYYMMDD必须为有意义的日期 YYYY为四位数字，必须是有效的年份 MM为两位数字，必须是有效的月份（01-12） DD为两位数字，必须是有效的日期（0

16、1-31） 对于不符合日期约束规则的日期值，处理方式存在以下两种情况：1) 无值的日期或者无意义的日期，这时在接口中一律以“00010101”（公元元年1月1日）填充；2) 接口单元中的“失效日期”在表示“未失效”含义时，一律以“29991231”（公元2999年12月31日）填充。 在以下数据接口单元中，日期类型统一使用“date”定义。 时间类型 统一采用HHMMSS格式 HH为两位数字，必须是有效的小时（00-23），24小时制 MM为两位数字，必须是有效的分钟（00-59） SS为两位数字，必须是有效的秒（00-59） 对于不符合时间约束规则的时间值，处理方式同NULL2.4.2 文件

17、级校验文件级校验是指根据源数据提供方提供的接口校验文件信息，对传输的接口数据文件进行校验，校验内容如下： 接口数据文件名称 根据接口校验文件中记录的文件名，查找“接口数据文件目录”（参见文件目录的划分）下该接口数据文件是否存在。 检查接口数据文件的名称是否遵守本规范中的命名规范（参见文件分类及命名规则）。 数据日期验证接口校验文件中记载的数据日期与接口数据文件名中的数据日期（参见文件命名说明）是否一致。 文件的生成日期验证接口校验文件中记载的文件生成日期与实际接口数据文件的生成日期是否一致。 文件的大小（字节数）验证接口校验文件中记载的文件大小与实际接口数据文件的文件大小是否一致。 文件中包含

18、的记录数验证接口校验文件中记载的文件记录数与实际接口数据文件中的记录行数是否一致。 文件中单行记录的长度验证实际接口数据文件中的每行记录长度是否与本规范定义的长度一致。2.4.3 数据异常处理机制2.4.3.1 发送方触发有限公司一经系统如果发现已经下发的数据有问题，将重新生成数据并进行下发，并通知各省公司重新获取和加载。2.4.3.2 接收方触发各省公司如果发现下发的数据有错误或者未及时下发，需和有限公司联系，由有限公司更新数据。2.4.4 系统及时性要求对于下发周期为日的接口单元，源数据提供方在当日12点前完成上一日的数据下发任务；对于下发周期为月的数据，源数据提供方在次月5日前完成上月数

19、据下发任务。数据接收方的接口系统应在2小时内读取当日接口文件并删除。2.5 文件目录及维护2.5.1 文件目录的划分一经系统中央业务平台接口数据下发文件目录设置如下。目录编号目录名称存放内容说 明二经权限一经权限/interface/fetion/incoming飞信接口数据文件存放有限公司下发的飞信文件读、写读、写/interface/fetion/backup数据备份目录备份数据读读、写说明：1. incoming目录各省公司登陆后可以读取相关接口文件，各省公司取走之后需要删除原文件以释放空间；2. 当省公司下载下来的文件发生遗失或者损坏，可以到backup目录下重新下载。2.6 文件的保

20、存期目录名称存放内容存放期限/interface/fetion/backup数据备份目录4月说明：1. 各省接口服务器将配置程序定期删除过期文件。3 接口数据3.1 数据接口接口单元编码接口单元名称接口单元说明40001日活跃用户明细截至当日24时，当日有过订购关系的用户且登录过PC客户端或手机客户端或WAP客户端或发送过上行短信或使用过IVR通话的用户40002月活跃用户明细截至当月最后一天24时，当月有过订购关系的用户且登录过PC客户端或手机客户端或WAP客户端或发送过上行短信或使用过IVR通话的用户40003日用户开通/关闭操作记录记录每日00时00分00秒到24时00分00秒，飞信用户

21、开通/关闭操作记录40004飞信用户登录信息记录飞信用户当天24小时内登录操作记录，本接口操作记录数据不进行排重40005飞信用户好友明细本接口提供截止到当月底，在网飞信用户的好友数据3.1.1 日活跃用户明细3.1.1.1 数据内容接口单元名称：日活跃用户明细接口单元编码：40001接口单元说明：截至当日24时，当日有过订购关系的用户且登录过PC客户端或手机客户端或WAP客户端或发送过上行短信或使用过IVR通话的用户接口单元属性列表：属性编码属性名称属性英文名称属性类型备注00记录行号number(8)唯一标识记录在接口数据文件中的行号。01日期DayTimeChar(8)格式：”YYYYM

22、MDD”。数据日期与接口文件命名中日期保持一致，均取生成接口文件当前日期的前一天作数据日期。02手机号MobileNochar(11)手机号03飞信号Sidchar（9）用户开通的飞信号。一个手机号码只能拥有一个飞信号04活跃方式OpTypechar(2)活跃方式，每2位代表一种方式，01-PC02-短信03-IVR04-Wap05-手机具体类型以字典接口为准0x0D0A回车换行符3.1.1.2 抽取方式及周期每日新增抽取。3.1.1.3 接口单元文件名称 每日新增抽取数据时 接口数据文件名s_XXXXX_yyyymmdd_40001_XX_XXX.dat 校验文件名s_XXXXX_yyyym

23、mdd_40001_XX.verf3.1.2 月活跃用户明细3.1.2.1 数据内容接口单元名称：月活跃用户明细接口单元编码：40002接口单元说明：截至当月最后一天24时，当月有过订购关系的用户且登录过PC客户端或手机客户端或WAP客户端或发送过上行短信或使用过IVR通话的用户接口单元属性列表：属性编码属性名称属性英文名称属性类型备注00记录行号number(8)唯一标识记录在接口数据文件中的行号。01日期DayTimeChar(6)格式：”YYYYMM”。02手机号MobileNochar(11)手机号03飞信号Sidchar（9）用户开通的飞信号。一个手机号码只能拥有一个飞信号04活跃方

24、式OpTypechar(2)活跃方式，每2位代表一种方式，01-PC02-短信03-IVR04-Wap05-手机具体类型以字典接口为准0x0D0A回车换行符3.1.2.2 抽取方式及周期每月新增抽取。3.1.2.3 接口单元文件名称 每月新增抽取数据时 接口数据文件名s_XXXXX_yyyymm_40002_XX_XXX.dat 校验文件名s_XXXXX_yyyymm_40002_XX.verf3.1.3 日用户开通/关闭操作记录3.1.3.1 数据内容接口单元名称：日用户开通/关闭操作记录接口单元编码：40003接口单元说明：记录每日00时00分00秒到24时00分00秒，飞信用户开通/关闭

25、操作记录接口单元属性列表：属性编码属性名称属性英文名称属性类型备注00记录行号number(8)唯一标识记录在接口数据文件中的行号。01日期DayTimechar（8）格式：”YYYYMMDD”数据日期与接口文件命名中日期保持一致，均取生成接口文件当前日期的前一天作数据日期。02手机号MobileNochar(11)用户手机号码 PK03飞信号Sidchar(9)用户开通的飞信帐号 一个用户只能拥有一个飞信号。04操作类型OpTypechar(2)通过字典传送取值范围和定义PK取值如： 00 开通01 关闭02 销号03 暂停04 恢复05操作时间OpTimechar(14)格式: YYYYM

26、MDDHHMMSS06操作方式OpStylechar(2)通过字典传送取值范围和定义取值如：00 批开01 自主07请求来源RequestSourcechar(10)通过字典传送取值范围和定义0x0D0A回车换行符3.1.3.2 抽取方式及周期每日新增抽取。3.1.3.3 接口单元文件名称 每日新增抽取数据时 接口数据文件名s_XXXXX_yyyymmdd_40003_XX_XXX.dat 校验文件名s_XXXXX_yyyymmdd_40003_XX.verf3.1.4 飞信用户登录信息3.1.4.1 数据内容接口单元名称：飞信用户登录信息接口单元编码：40004接口单元说明：记录飞信用户当天

27、24小时内登录操作记录，本接口操作记录数据不进行排重接口单元属性列表：属性编码属性名称属性英文名称属性类型备注00记录行号number(8)唯一标识记录在接口数据文件中的行号。01日期DayTimechar（8）格式：”YYYYMMDD”数据日期与接口文件命名中日期保持一致，均取生成接口文件当前日期的前一天作数据日期02手机号MobileNochar(11)用户手机号码 PK03飞信号Sidchar(9)用户开通的飞信帐号一个用户只能拥有一个飞信号。04操作类型OpTypechar(2)通过字典传送取值范围和定义取值如：01 登录02 下线 05操作时间OpTimechar(14)格式: YY

28、YYMMDDHHMMSS 24时制06终端类型ClientTypechar(10)通过字典传送取值范围和定义取值如：飞信PC客户端飞信手机JAVA客户端飞信手机SYMBIAN客户端飞信手机SMART PHONE客户端飞信手机POCKET PC客户端飞信WAP客户端短信0x0D0A回车换行符3.1.4.2 抽取方式及周期每日新增抽取。3.1.4.3 接口单元文件名称 每日新增抽取数据时 接口数据文件名s_XXXXX_yyyymmdd_40004_XX_XXX.dat 校验文件名s_XXXXX_yyyymmdd_40004_XX.verf3.1.5 飞信用户好友明细3.1.5.1 数据内容接口单元

29、名称：飞信用户好友明细接口单元编码：40005接口单元说明：本接口提供截止到当月底，在网飞信用户的好友数据接口单元属性列表：属性编码属性名称属性英文名称属性类型备注00记录行号number(8)唯一标识记录在接口数据文件中的行号。01数据月份Monthchar(6)格式：YYYYMM02用户手机号MobileNochar(11)03用户飞信号Sidchar(9)一个用户手机号只能拥有一个飞信号。04好友手机号Frdmsisdnchar(11)05好友飞信号Frdsidchar(6)06当月交往次数countnumber(10)0x0D0A回车换行符3.1.5.2 抽取方式及周期每月全量抽取。3

30、.1.5.3 接口单元文件名称 每月全量抽取数据时 接口数据文件名i_XXXXX_yyyymm_40005_XX_XXX.dat 校验文件名i_XXXXX_yyyymm_40005_XX.verf3.2 字典接口接口单元编码接口单元名称接口单元说明40099飞信字典定义本接口说明所定义的字典针对的业务数据接口单元及字段本接口中涉及到的字典包括：活跃方式、飞信用户开通/关闭操作记录的操作类型、飞信用户终端类型、飞信用户登录操作记录操作类型40098飞信字典代码定义本接口定义业务数据接口单元中字段取值对应字典所包含的代码项目3.2.1 飞信字典定义3.2.1.1 数据内容接口单元名称：飞信字典定义

31、接口单元编码：40099接口单元说明：本接口说明所定义的字典针对的业务数据接口单元及字段本接口中涉及到的字典包括：活跃方式、飞信用户开通/关闭操作记录的操作类型、飞信用户终端类型、飞信用户登录操作记录操作类型接口单元属性列表：属性编码属性名称属性描述属性类型备注00记录行号唯一标识记录在接口数据文件中的行号。number(8)01字典标识char(10)字典编码02字典标识名称char(128)03接口单元编码char(128)使用字典的接口单元编码04接口文件字段名char(128)使用字典的接口文件英文属性名称0x0D0A3.2.1.2 抽取方式及周期每日全量抽取。3.2.1.3 接口单元

32、文件名称 每日全量数据抽取时 接口数据文件名s_XXXXX_yyyymmdd_40099_XX_XXX.dat 校验文件名s_XXXXX_yyyymmdd_40099_XX.verf3.2.2 飞信字典代码定义3.2.2.1 数据内容接口单元名称：飞信字典代码定义接口单元编码：40098接口单元说明：本接口定义业务数据接口单元中字段取值对应字典所包含的代码项目接口单元属性列表：属性编码属性名称属性描述属性类型备注00记录行号唯一标识记录在接口数据文件中的行号。Number(8)01字典标识char(10)02字典代码标识char(128)字典标识对应的接口单元某属性的取值03字典代码名称cha

33、r(128)对属性取值的定义04备注char(128)本字段允许为空。0x0D0A3.2.2.2 抽取方式及周期每日全量抽取。3.2.2.3 接口单元文件名称 每日全量数据抽取时 接口数据文件名s_XXXXX_yyyymmdd_40098_XX_XXX.dat 校验文件名s_XXXXX_yyyymmdd_40098_XX.verf4 附录：省份编码CMCC运营机构编号BASS_STD1_0054名称CMCC运营机构编码长度5发布序号01编码编码名称描述10000中国移动通信有限公司10100北京移动通信有限责任公司10200上海移动通信有限责任公司10300天津移动通信有限责任公司10400重

34、庆移动通信有限责任公司10500贵州移动通信有限责任公司10600湖北移动通信有限责任公司10700陕西移动通信有限责任公司10800河北移动通信有限责任公司10900河南移动通信有限责任公司11000安徽移动通信有限责任公司11100福建移动通信有限责任公司11200青海移动通信有限责任公司11300甘肃移动通信有限责任公司11400浙江移动通信有限责任公司11500海南移动通信有限责任公司11600黑龙江移动通信公司11700江苏移动通信有限责任公司11800吉林移动通信有限责任公司11900宁夏移动通信有限责任公司12000山东移动通信有限责任公司12100山西移动通信有限责任公司12200新疆移动通信有限责任公司12300广东移动通信有限责任公司12400辽宁移动通信有限责任公司12500广西移动通信有限责任公司12600湖南移动通信有限责任公司12700江西移动通信有限责任公司12800内蒙移动通信有限责任公司12900云南移动通信有限责任公司13000四川移动通信有限责任公司13100西藏移动通信有限责任公司12.29.202211:1811:18:0222.12.2911时18分11时18分2秒12月. 29, 2229 十二月 202211:18:02 上午11:18:022022年12月29日星期四11:18:02