中山大学数据共享交换平台接入规范.doc

中山大学数据共享交换平台接入规范(试行)中山大学信息化管理办公室2018年5月目 录1.概述11.1.读者11.2.目的11.3.相关术语11.4.信息资源目录21.5.数据交换方式51.6.数据交换模式51.7.数据日期概念61.8.增量条件62.交换体系设计72.1.总体设计72.2.架构设计82.2.1.SFTP服务架构82.2.2.数据库物理架构92.3.数据交换方式102.3.1.文件方式交换.轮询交换（固定周期）、通报交换（不固定周期）提供的文件.实时交换方式提供的文件.文件路径说明112.3.2.数据库方式交换122.3.3.WEB服务方式交换132.4.系统接入方式133.数据交换模式143.1.实时交换152.1.1.数据报文请求152.1.2.数据文件请求172.1.3.数据报文推送212.1.4.数据文件推送223.2.轮询交换（固定周期）233.2.1.采集过程243.2.2.供数过程263.3.通报交换（不定周期）274.接口设计294.1.接口总体说明294.1.1.通信模式294.1.2.安全控制294.1.3.错误处理294.2.消息定义304.2.1.消息体304.2.2.系统ID（系统编码）314.2.3.接口编码314.3.接口详细设计334.3.1.资源目录管理334.3.2.数据文件请求模式接口374.3.3.数据报文请求模式接口414.3.4.数据采集服务接口434.3.5.供数服务444.3.6.点对点供数454.3.7.数据文件推送464.3.8.数据报文推送484.3.9.消息通知模式494.3.10.通报交换（不固定周期）505.数据权限515.1.资源权限515.2.字段级权限516.附录1错误码527.附录2web服务使用说明537.1.使用交换平台的接口537.2.接入方实现的服务557.3.报文样例571. 概述中山大学数据共享交换平台（下称“交换平台”）是负责传输校内不同信息系统间数据的平台，各业务系统通过与数据交换平台对接，实现业务数据在不同业务系统之间顺畅、实时、批量传输。1.1. 读者 与交换平台对接的信息系统建设方 与交换平台对接的信息系统开发方 交换平台开发方 交换平台运维管理方1.2. 目的本文档是中山大学数据共享交换平台接口需求及设计方案相关文档，可用于指导对接接口开发、联调、测试工作。1.3. 相关术语术语说明数据共享交换平台下文如无特殊说明，简称交换平台。业务系统需要实施数据共享交换的业务信息系统，如人事信息管理系统、教务信息管理系统等。ok文件标志文件，在数据文件生成完成后产生的空文件，供数据需求方判断文件是否可读取资源代码资源如果是数据库表，则资源代码为：数据提供方表名。资源如果是文件,则资源代码为：文件名去掉系统ID和后缀。资源如果是报文，则资源代码为：返回报文中result中的tablename。dcroot交换平台sftp根目，实际为登录后的files目录syroot交换平台为每个业务系统配置的专属sftp根目录。不同的业务系统的根目录不同，实际为登录后的files目录单一资源资源目录中一个资源ID定义为一个资源，当资源为一个文件或一个表时，为单一资源复合资源资源目录中一个资源ID定义为一个资源，当资源为一类资源，即对应多个文件或多个消息时，为复合资源。例如一份完整档案，包含多个不同类型文件集合，此集合属于一个复合资源。1.4. 信息资源目录信息资源目录为数据共享交换的依据，目录所含内容既是对共享信息资源的描述，也是数据交换关系的描述。在数据共享交换中的一张数据库表、一个文件或一类文件都是属于信息资源，注册于信息资源目录中。中山大学信息资源目录由数据模型管理平台管理，数据共享交换实施前需要数据提供方注册，并由数据管理员审核通过后对全校发布。下表详细介绍资源的属性字段名称字段类型是否必填说明resourceIDString是资源ID，一个资源的唯一IDmultiFlagchar是是否包含多个文件标识：S：单一资源（对应一个文件，一个表）；M：复合资源（可多个文件，多个消息定义为一个资源ID，对应一类资源，一类消息）。resourceAliasString是资源代码：（1）当multiFlag=S时：数据库表为：数据提供方表名,文件类型为：文件名去掉系统ID和后缀,报文类型为：返回报文中result中的tablename；（2）当multiFlag=M时：自定义的这一类资源的类别名称，如果是文件类型，建议使用这一类文件的名称统一前缀。提交资源是确保本系统唯一。注：受限于oracle对表名的限制，时分频率供数时表名为 providerSysID_ resourceAlias_ reqSysID，资源代码最长只能为22位；remarkString是资源描述resourceTypeChar是是否结构化数据：（1）结构化数据：S。类似数据库格式化的数据，有字段说明的数据；（2）非结构化数据：N。非结构化数据，如图片文件。providerSysIDString是数据提供方ID。见3.2.2系统ID章节isStorechar是数据是否在中心交换节点留存：Y-代表数据在交换过程中会在中心节点留存，即数据交换过程中数据会在交换平台“落地”；N-代表数据在交换过程中不在中心节点留存，即数据交换过程中数据只交换，但不会在交换平台“落地”。frequencyString否：非定时数据交换方式可为空数据交换任务定时启动的频率定义：minute:30 含义是交换任务从每日0点起每30分钟运行一次；minute:60 含义是交换任务从每日0点起每60分钟运行一次；day 含义每日运行一次；week:n 含义周几运行，如周一，则n=1；month:两位日期 含义每月运行一次，如month:02为每月2日运行；year:四位日期 含义一年运行一次，如year:0321为每年3月21日运行；putTimeString否： 数据提供方完成供数的时间点，格式为HH:mm，此字段与frequency结合使用，用于表述某天某日定时数据交换的时间。例如：getModechar是数据提供方资源承载方式：F：文件方式D：数据库方式I：报文方式M：普通通知类消息（双方直接通讯方式的资源定义）isIncreasechar否是否增量：Y-增量、N-全量。如是增量，中心库需追加；如是全量，中心库需覆盖。注：如数据提供方有物理删除数据，需要写入交换节点机并打D标识。增量的数据必须包括当期新增、修改、删除的数据（业务上逻辑删除的数据为修改）。新建业务系统必须提供增量供数模式，不再接受全量供数模式increaseParamString否：数据库增量抽取的时候必填增量抽取sql中where条件后面的内容。如条件中有数据日期，请使用格式化参数代替，前后加上#1、日期使用#yyyyMMdd#或#yyyy-MM-dd#2、日期时间使用#yyyyMMddHHmmss# 或 #yyyy-MM-dd HH:mm:ss#注：实际执行时日期参数使用具体日期替代，需能够抽取到当期新增和修改的数据（业务上逻辑删除的数据为修改）比如资源定义：lastTime=to_date(#yyyy-MM-dd#,yyyy-mm-dd)实际使用时：C001需传入:lastTime=to_date(2017-10-31,yyyy-mm-dd)平台采集时：lastTime=to_date(2017-10-31,yyyy-mm-dd)注：数据日期说明见1.7，与实际运行日期不同isLogTablechar是是否流水表，流水表只能为增量抽取。Y-是；N-否注：流水表不处理增改删标志，默认只有新增。catalogchar是资源类别：B- 基础数据S- 业务数据C- 决策数据具体定义见附录:资源类别定义themestring是所属主题教职工域教学域财务域学生业务域科研域1.5. 数据交换方式1. 数据库方式：数据供需双方可通过读写交换节点上数据库的表或视图实现数据交换。2. 文件方式：数据供需双方可通过读写交换节点上的文件实现数据交换，如是结构化数据，需要按照接口文档中描述的文件格式提供文件，以便于交换平台对文件解析。3. web服务方式：数据供需双方可通过提供webservice对提供和获取数据，webservice需按照接口文档中的描述方式实现，为http post方式的RESTful方式，参数为Json格式，即需按C001接口实现。详见4.3.3章节。1.6. 数据交换模式1. 实时交换： 通过B001 ，C001，H001，I001等接口请求的数据，会实时返回或生成数据。2. 轮询交换（固定周期）：此方式下，数据提供方或者数据需求方在资源目录中约定数据交换频率（如30分钟一次、1日一次等），并按照该频率，数据提供方提供数据到交换平台，数据需求方定期从交换平台轮询获取数据。此方式下，交换平台不会主动告知各方是否有更新数据，需要数据需求方定期轮询。3. 通报交换（不定周期）：此方式下，业务数据数据发生变更后，数据提供方即时主动通报数据交换平台，由数据交换平台把数据推送给数据需求方，同时通报数据需求方从交换平台获取数据。此种交换方式频率不固定。1.7. 数据日期概念，提供方生成文件需要加上数据日期，文件命名和要加上数据日期，即下文中 yyyyMMdd和 yyyyMMddHHmm，数据日期与实际运行日期是有区别的，实际处理数据是上一期（配合增量条件）的数据，所以数据日期=实际日期-周期。采用数据库交换方式时，交换平台会在交换表中建时间戳内建字段。下面给出具体的例子周期运行日期/时间数据日期/时间说明minute:30201803291130201803291100半点和整点运行minute:60201803291100201803291000整点运行day2018032920180328每天运行week:52018040620180326（上周周一）每周五运行month:012018040220140301（上月1日）每月1日运行year:03012018030120170101（上年元旦）每年3月1日运行1.8. 增量条件数据提供方提供数据可以是增量也可以是全量，原则要求初次提供全量数据，日常提供提供增量数据。为了保证交换平台的数据与源系统数据语义一致，业务系统发生数据新增、修改、删除数据的操作，都应按照增量方式把数据提交给交换平台。数据增加标识字段为A，数据修改的标志位为U，数据删除标识位为D，后续章节将具体介绍。 增量条件中日期部分，请使用格式化参数代替，前后加上#字符1、日期使用#yyyyMMdd#或#yyyy-MM-dd#2、日期时间使用#yyyyMMddHHmmss# 或 #yyyy-MM-dd HH:mm:ss#注：实际执行时日期参数使用具体数据日期替代，需能够抽取到当期新增和修改的数据（业务上逻辑删除的数据为修改）。例如资源定义：lastTime=#yyyy-MM-dd#实际使用时：C001需传入:lastTime=2017-10-31平台采集时：lastTime=2017-10-312. 交换体系设计2.1. 总体设计数据交换平台提供各业务系统数据接入的接口，实现数据交换平台和各业务系统的有机结合，以统一的数据模型、数据质量标准和接口规范实现数据自动提取、转换、发送、校验与审核，同时支持数据同步、历史数据迁移等。数据交换平台以“统一标准”、“统一处理”、“统一交换”、“保证质量”、“透明开发”的方式，为不同业务系统、数据库和数据格式之间进行数据的交换提供服务。数据交换平台通过平台提供的接口规范与接入系统进行通信，以完成数据交换和消息传递的功能。其业务流程具有以下特点：1. 实时、准实时数据交互：如果交互的数据量较小，实时性要求高，可采取数据报文模式，可以实现数据的实时交互；如果数据量较大，则可以采取数据库或文件的方式。2. 主动被动模式：数据可以由数据需求方主动请求，也可由数据提供方主动推送。2.2. 架构设计2.2.1. SFTP服务架构数据交换平台中心节点架设sftp服务器，实现文件的上传和下载；为每个接入的系统建立一个sftp用户，并设置专属sftp目录。为保证文件的安全性，sftp用户只能访问向其开放的专属sftp目录，不能访问其他用户目录的数据文件。接入系统上传和下载文件也只能通过其专属的sftp目录实现。上传和下载的文件目录为sftp登录后的 /files/ 目录。 2.2.2. 数据库物理架构交换平台提供数据库交换节点供业务写入数据和读取数据，交换节点为每个业务系统分配一个账号。管理员或提供方建立资源后，交换平台会在交换节点机建立供业务系统写入的表，表名定义为 源系统ID_资源代码。供数给业务系统时，交换平台会把数据写入交换节点机，表名定义为源系统ID_资源代码_需求方系统ID。2.3. 数据交换方式数据交换方式分为三种：文件，数据库，web服务。他们是资源的承载方式，在资源管理系统上注册资源的时候，可以指定其中一种方式。2.3.1. 文件方式交换. 轮询交换（固定周期）、通报交换（不固定周期）提供的文件 数据文件每一行的数据表示数据库中一行数据，使用unix换行符换行； 文件不包含表头的字段名； 字段之间使用 16进制 0X1B 间隔； blob二进制字段有可能包含字段分隔符0X1B，文件提供方需进行base64编码； 数据库字段值为null的，写入文件为空值 不需要文本限定符，即字段不需要使用引号包含起来； 日期字段格式需格式化为yyyy-MM-dd； 时间字段格式需格式化为yyyy-MM-dd HH:mm:ss； 文件数据编码为UTF-8 在数据原有的字段后面新增三个字段：（1）数据新增、删除、修改标识：A：新增；D：删除；U：修改. （2）数据日期标识：标识数据日期yyyyMMdd或yyyyMMddHHmm.(3)时间戳注：1、资源目录中标识为流水表的，增改删标识设置为A-新增；2、数据标识只针对数据本身，无业务含义，业务系统当前批次逻辑删除的数据，记为U-修改。3、文件中数据不能含有换行符，如有换行符和制表符，需要直接删除，或替换为,换行符ASCII码为char(10),char(13),char(27)4、如果提供轮询交换模式的文件资源，提供方在每个周期都需上传文件，如增量方式提供且当期没有数据，也需提供空dat文件和ok文件。5、需求方获取数据文件（dat文件）前，需要判断是否存在ok文件，以确保文件完整性。. 实时交换方式提供的文件实时交换提供的文件，即一次性请求的文件（如B001接口），文件格式参考上节所述提供的文件格式，只是不需要新增三个标识字段。. 文件路径说明文件路径和文件名设置，预定义dcroot为交换中心sftp登录后/files目录，syroot为业务系统sftp登录后/files目录。下文“xxx”，在单一资源时为资源代码，在复合资源时为报文中定义的文件名。（1） 实时/通报模式文件（B001接口，H001接口）：1. 数据提供方上传文件路径为：syroot/数据提供方id_xxx.dat，syroot/数据提供方id_xxx.ok；2. 数据需求方文件路径为：syroot/数据提供方id_xxx.dat,syroot/数据提供方id_xxx.ok。（2） 轮询模式文件采集：1. 年、月、日频率文件命名：a. 数据提供方上传文件路径为：syroot/yyyyMMdd/数据提供方id_xxx.dat, syroot/yyyyMMdd/数据提供方id_xxx.ok；yyyyMMdd为数据日期，一般偏移量前一周期（参见数据日期概念），如20180315日处理20180314的数据，那么数据日期为20180314。 b. 数据需求方文件路径为：syroot/yyyyMMdd/数据提供方id_xxx.dat 和syroot/yyyyMMdd/数据提供方id_xxx.ok。2. 时、分频率文件命名：a. 数据提供方上传文件路径为：syroot/yyyyMMdd/数据提供方id_xxx_HHMM.dat, syroot/yyyyMMdd/数据提供方id_xxx_HHMM.ok；b. 数据需求方文件路径为：syroot/yyyyMMdd/数据提供方id_xxx_HHMM.dat 和syroot/yyyyMMdd/数据提供方id_xxx_HHMM.ok。2.3.2. 数据库方式交换数据库供数到数据库交换节点已建立好的数据表（源系统ID_资源代码）中，表结构中业务字段定义严格按照信息办发布的中山大学数据资源目录中的表结构，另外，如增量方式提供数据时，交换平台在交换节点机建表时会添加三个控制字段,适用于轮询交换（固定周期）、通报交换（不固定周期）。l dc_dcFieldAUD char(1) AUD标识 ：枚举值：A，U，D三个值，分别为A-新增，U-修改，D-删除l dc_dcDataDate varchar(12) 数据日期，更新数据频率大于等于1天时，格式为YYYYMMDD，更新频率小于1天时，格式为YYYYMMDDHHMM，详解1.7l dc_dcTimeStamp timestamp 时间戳 注：提供方全量供数则无此三个控制字段 交换节点机的表由交换平台建立 全量提供数据时，提供方先删除数据表中的数据，然后写入新一个批次的数据。 增量供数时，第一个批次写入全量数据，三个控制字段必须写入数据dc_dcFieldAUD=Adc_dcDataDate=批次日期dc_dcTimeStamp=写入时间后续批次只需写入增量数据，三个控制字段必须写入数据。注：1、需求方获取数据表数据前，需要发送E001确定平台数据是否供数完成。2.3.3. WEB服务方式交换数据提供方实现了C001接口服务（参见接口编码），可以通过此服务对外提供数据服务功能。此中方式较为灵活，数据需求方可在请求中指定条件，能够获取到更为准确的数据。适合数据量较少，实时性较高的场景。2.4. 系统接入方式在系统建设期间，由信息办统一规划，批量确定接入数据交换平台的系统。系统运行期间，接入数据交换平台的业务系统，需要填写数据接入申请单，根据相关规定进行审批，审批完成后，由数据管理员在管理系统上配置系统环境信息并分配操作用户给系统接入方。系统接入流程1、 业务系统向数据管理员申请接入平台2、 数据管理员审批通过后，分配系统ID（系统ID需统一规划）3、 业务系统提交系统公钥（使用平台秘钥工具产生），数据管理员4、 数据管理员录入提交的公钥和环境信息通过以上步骤即完成系统接入工作，接入系统可以是如下两种角色，可以在资源管理平台上对资源进行管理和操作1、 数据提供方：可在提供的管理系统上新建资源，条件共享并审核需求方的权限申请。2、 数据需求方：可在提供的管理系统上查询资源，并对需要的资源申请权限，权限审批通过后， 才可进行数据交换。3. 数据交换模式完成一次数据交换，需线上和线下共同配合，具体步骤如下1、 管理员在资源管理WEB平台新建接入系统的用户2、 管理员维护提供方或需求方公钥和实时接口的访问地址3、 数据提供方在WEB网站提交新建的资源目录，包括资源的英文名称，数据结构，更新频率等4、 管理员审核数据提供方新建的资源，如数据库资源，平台会在交换节点新建数据库表，供提供方写入数据5、 审核通过的资源即为有效资源，需提供方按照新建资源时设定的频率写入数据（数据库表或文件）6、 管理员对全校发布资源7、 数据需求方线上提交资源需求申请（三种模式：实时，轮询，通报）8、 数据提供方完成资源授权，完成审批流程9、 数据提供方审批完成后，可进行数据交换a) 实时模式：接收需求方或提供方的消息报文请求，根据不同消息报文处理实时数据交换b) 轮询模式：交换平台按照设定的频率读取数据提供方的数据（文件或数据库表），并把数据供给数据需求方（文件或数据库），如需求方提供的数据库环境，则平台在供数前会建立数据库表，表名请参见2.2.2c) 通报模式：平台接收到数据提供方的K001（参见4.3.10）通知后，会读取更新的数据，推送给有需求的数据需求方3.1. 实时交换.1.1. 数据报文请求数据报文请求流程图数据报文请求采用同步方式，数据可由数据提供方提供，也可以由数据库交换节点提供。具体情况如下：1. 当数据未入中心交换节点数据库，或数据已入中心交换节点数据库，但请求报文时要求数据提供方提供数据，由数据提供方提供C001服务或平台查询交换节点提供方数据库表。数据交换平台获取数据提供方数据的方式以资源目录定义为准，数据提供方需实现C001数据报文请求服务，提供服务的方式请参见附录2。数据报文请求数据提供方提供数据2. 数据已入中心库的，由平台交换节点数据库提供数据。数据报文请求平台提供数据2.1.2. 数据文件请求数据文件请求流程图1. 数据未入中心交换节点数据库：数据文件请求采用异步方式，B001响应报文成功并不表示文件已生成。对于未采集到中心库的数据，由数据提供方提供文件或平台查询交换节点提供方数据库表。数据交换平台获取数据提供方数据的方式以资源目录定义为准，数据提供方需要提供B001和B002服务，提供服务的方式请参见附录2。数据文件请求数据提供方提供数据2. 数据已入中心库：数据文件请求采用异步方式，对于已采集到中心交换节点数据库库的数据，平台生成文件。数据需求方获取文件可以有以下两种情况，根据B001报文中needNotice字段确定。(1) 为保证让数据请求方及时获取数据，提供平台通知的方式。数据文件请求平台提供数据并通知请求方(2) 为减轻关联系统的开发压力和提高快速部署能力，数据需求方可通过查询方式或扫描OK文件获取文件是否已提供。数据文件请求平台提供数据，数据请求方主动查询2.1.3. 数据报文推送数据报文推送流程图数据报文推送指的是数据提供方通过报文的方式主动将数据推送给数据接收方，此模式适用于数据变更后及时通知数据接收方的场景。如下图。数据报文推送2.1.4. 数据文件推送数据文件推送流程图数据文件推送指的是数据文件提供方上传文件到sftp目录后，主动通知数据文件需求方获取文件。其中资源提供方式为文件。如下图。数据文件推送3.2. 轮询交换（固定周期）数据的采集可通过以下两种方式：(1) 交换平台采集数据提供方上传到交换节点sftp服务器的文件(2) 交换平台采集数据提供方在数据交换节点的数据库表；.. 采集过程1. 文件采集：（1）数据提供方定期提供数据dat文件和ok文件，平台主动扫描ok文件。如文件存在在处理文件数据。文件采集平台主动扫描2. 数据库采集：数据采集时，平台查询数据提供方的数据库。数据提供方可以随时查询数据采集情况。数据库采集3.2.2. 供数过程1. 文件供数：数据需求方成功申请资源轮询交换后，若数据需求方提供环境为文件交换节点，数据交换平台按照约定的频率从数据提供方采集数据并推送数据文件到数据需求方专属的sftp目录。数据需求方需扫描ok文件确定文件是否已提供。需求方处理完文件后，需要通过E002接口反馈处理数据的结果文件供数2. 数据库供数：数据需求方成功申请资源轮询交换后，若数据需求方提供环境为数据库交换节点，平台则可以将数据直接写入需求方交换节点的数据库表。需求方处理完文件后，需要通过E002接口反馈处理数据的结果数据库供数3.3. 通报交换（不定周期）数据发送变更后，数据提供方通知平台，平台把更新的数据推送给有需要的需求方。此方式由K001和K002实现。需求方需实现K001服务，提供方需实现K002服务。资源为文件方式时，文件名从K001报文中获取，sftp路径为sftp根目录资源为数据库方式时，数据从资源定义的数据库表中获取，供给数据需求方也是数据库表，表名为：提供方系统ID_源系统表名_需求方系统ID注：1、当有多个需求方时提供方会接收多个需求方的K002报文。 2、数据需求方对一个资源只能选取以上轮询交换和通报交换的一种。4. 接口设计. 接口总体说明4.1.1. 通信模式 交换平台对外提供web服务，并提供API供关联方调用； 报文编码UTF-8； 数据采用json格式化数据。4.1.2. 安全控制平台安全控制如下：1. 平台接入需审核。系统运行后，需要接入平台的业务系统需填写接入申请；2. 通信双方线下交换公钥，消息发起方使用私钥加密，消息接受方使用公钥解密，确保信息发送方为真实的、通过审核的发送方；3. 使用nonce防止消息重复重放；4. 字段级授权：如条件共享字段，需要控制不能提供给未授权需求方。4.1.3. 错误处理明确处理结果，返回消息中errCode必填，确保消息请求方可以采用对应的措施。4.2. 消息定义4.2.1. 消息体消息体为各方通信报文的承载方式，即每次交互的数据格式都是按照消息体定义的格式填写，字段类型和顺序需保持一致，不同的接口仅仅是data字段格式不同。字段名称字段类型是否必填说明reqSerialNumString是发起方流水号，具有唯一性，每次通信都不一样，规则：4位发起方系统ID+14位时间yyyyMMddHHmmss+4位流水号correlationSerialNumString否（返回时必填）关联流水号，为平台在收到一个交易多次交互中第一笔流水时生成。在一个交易多次通信中唯一。如数据需求方发B001,平台会生成假设为X，平台返回B001信息会填入，同时请求数据提供方时B002也会填入。B002和B003的关联流水号也必须填入X，以便关联出B001请求。msgCodeString是接口编码，由平台统一分配，4位msgFromSysIDString是消息发起方系统ID，由平台统一分配，4位msgToSysIDString是接收消息的系统ID。如果仅仅发给交换平台则填入交换平台系统ID，其他填入关联系统ID。如B001填入资源提供方系统ID，B003填入交换平台的系统IDtimetimestamp是消息时间戳signString是签名域，使用私钥对流水reqSerialNum签名，确定请求方真实有效，见附录公钥私钥使用说明nonceString是time+reqSerialNum+请求方mac取hash，防止重放errCodeString否（返回必填）错误码：返回信息填写；0：成功；其他见附录1errMsgString否错误消息datajson格式字符否业务数据，请求或返回数据，具体接口见接口详细说明4.2.2. 系统ID（系统编码）由信息办统一规划的4位系统ID。系统中文名称系统编码（ID）系统所属部门人事系统RSXT人事处教务系统JWXT教务部研究生管理系统YJSG研究生院科管系统KGXT科研院校园卡系统XYKX核算中心财务信息系统CWXXNetID系统NETI网络中心资产管理系统ZCGL财务处学工系统XGXT学生处党务系统DWXT组织部统战系统TZXT统战部数据交换平台SJJH合同管理系统HTXT发展规划办4.2.3. 接口编码接口编码（msgCode）为平台统一分配，每个业务分配一个4位接口编码。消息类别分为：A-资源目录管理、B-数据文件请求、C-数据报文请求、D-数据采集服务、E-供数服务、F-点对点供数、H-文件推送模式、I-辅助消息。消息类别接口编码接口名称数据需求方实现平台实现数据提供方实现说明A-资源目录管理A001资源目录查询B-数据文件请求B001请求文件B-数据文件请求B002单次文件准备完成通知B-数据文件请求B003请求文件结果查询C-数据报文请求C001数据报文请求实时报文数据D-数据采集服务D001文件采集情况查询E-供数服务E001轮询交换供数据库查询接口E-供数服务E002轮询交换需求方获取数据反馈F-点对点供数F001点对点供数信息收集点对点供数，未通过交换中心数据传输信息收集H-数据文件推送H001提供方数据文件推送提供方上传文件后，主动推动H-数据文件推送H002数据需求方数据文件接收通知数据文件提供方主动推送，数据接收方异步反馈文件接收完成情况I-数据报文推送I001提供方数据报文推送提供方主动推送数据报文J-辅助消息J001辅助消息在数据交换过程中，数据提供方和数据接收方需通过平台转发的辅助交换过程的其他消息，data内容不定由通信双发协商J-辅助消息J002服务检查接口数据提供方实现K-数据更新K001资源数据更新推送通知K-数据更新K002资源数据更新接收通知4.3. 接口详细设计就每个接口而言，报文中的data格式是不同的。因此，下文将详细规范每个接口中业务数据data的格式。4.3.1. 资源目录管理..3.1.1. A001资源目录查询资源目录查询支持根据资源ID精确查询，也可分页查询。只有数据管理员发布的资源才可以被查询。资源目录为平台的核心信息，所有接入方通信都必须定义资源目录，平台会判断资源目录是否存在，是否授权来确定交换请求是否处理。资源目录的核心信息有资源ID、代码、类别，获取资源的方式，获取资源的参数，如果是提供轮询交换模式的资源，则还需要提供采集频率和预计完成准备时间等。当资源定义multiFlag=M时，不提供轮询交换，只能实时交换和通报交换。不经过交换中心的消息交互和资源交换需要纳入交换中心资源管理，也需定义和提交资源目录，在双方交互完成后，由发起方发送F001接口供交换平台登记。其中，采集供数频率定义如下： minute:30-含义每30分钟运行一次； minute:60-含义每60分钟运行一次； day-含义每日运行一次； week:n-含义周几运行，如周一，则n=1； month:两位日期-含义每月运行一次，如month:02为每月2日运行； year:四位日期-含义一年运行一次，如year:0321为每年3月21日运行；1) 请求数据字段名称字段类型是否必填说明resourceIDString否资源IDproviderSysIDString否系统IDpageInteger是第几页pageSizeInteger是每页条数，最大2000条2) 返回数据字段名称字段类型是否必填说明totalSizeLong是总记录数resultSizeInteger是当前返回记录数pageInteger是第几页，请求原样返回pageSizeInteger是每页条数，请求原样返回resultListmap是见下表3) result字段名称字段类型是否必填说明resourceIDString是资源IDmultiFlagchar是是否包含多个文件标识：S：单一资源（对应一个文件，一个表）；M：复合资源（可多个文件，多个消息定义为一个资源ID，对应一类资源，一类消息）。resourceAliasString是资源代码：（1）当multiFlag=S时：数据库表为：数据提供方表名,文件类型为：文件名去掉系统ID和后缀,报文类型为：返回报文中result中的tablename；（2）当multiFlag=M时：自定义的这一类资源的类别名称，如果是文件类型，建议使用这一类文件的名称统一前缀。提交资源是确保本系统唯一。remarkString是资源描述resourceTypeChar是文件类型：（1）结构化数据：S。类似数据库格式化的数据，有字段说明的数据；（2）非结构化数据：N。非结构化数据，如影像文件。注：非格式化数据平台不处理标识，非结构化数据不入中心库providerSysIDString是资源来数据提供方isStorechar是是否存储进中心库：Y-入中心库，N-不入中心库。注：数据请求时，如已入中心库，优先从中心库获取数据返回。isAuthorizationchar是对查询系统是否已授权，非资源目录本身的信息，关联授权信息获取。Y：已授权N：未授权frequencyString否：非采集时可为空采集供数频率定义：minute:30 含义每30分钟运行一次；minute:60 含义每60分钟运行一次；day 含义每日运行一次；week:n 含义周几运行，如周一，则n=1；month:两位日期 含义每月运行一次，如month:02为每月2日运行；year:四位日期 含义一年运行一次，如year:0321为每年3月21日运行；putTimeString否：文件供数必填数据提供方完成供数的时间点，格式为HH:mm，轮询交换时这个时间作为调度任务时间。getModechar是数据提供方资源承载方式：F：文件方式D：数据库方式I：报文方式M：普通通知类消息（双方直接通讯方式的资源定义）isIncreasechar是是否增量：Y-增量、N-全量。如是增量，中心库需追加；如是全量，中心库需覆盖。注：如数据提供方有物理删除数据，则不能提供增量供数方式。增量的数据必须包括当期新增和修改的数据（业务上逻辑删除的数据为修改）。increaseParamString否：数据库增量抽取的时候必填增量抽取sql中where条件后面的内容。如条件中有日期，请使用格式化参数代替，前后加上#1、日期使用#yyyyMMdd#或#yyyy-MM-dd#2、日期时间使用#yyyyMMddHHmmss# 或 #yyyy-MM-dd HH:mm:ss#注：实际执行时日期参数使用具体日期替代，需能够抽取到当期新增和修改的数据（业务上逻辑删除的数据为修改）比如资源定义：lastTime=#yyyy-MM-dd#实际使用时：C001需传入:lastTime=2017-10-31平台采集时：lastTime=2017-10-31isLogTablechar是是否流水表，流水表只能为增量抽取。Y-是；N-否注：流水表不处理增改删标志，默认只有新增。catalogchar是资源类别：B：基础数据S：业务数据D：决策数据具体定义见附录:资源类别定义4.3.2. 数据文件请求模式接口..3.2.1. B001文件请求数据实时交换通过文件的方式，如涉及条件共享字段且未授权，请数据提供方不要写入文件。当资源数据交换方式为F：文件方式或D：数据库方式时，数据请求方可使用B001请求资源。注意：B001返回报文中correlationSerialNum会作为B002和B003的关联流水号。在B002和B003请求报文中需填入。服务方需判断needNotice，以确定是否发送B002报文通知。1) 请求数据字段名称字段类型是否必填说明resourceIDString是资源IDreqSysIDStirng是数据请求方系统ID注：报文体中msgFromSysID经过平台转发后，会改为SJJHincreaseParamString否：数据库增量抽取的时候必填增量抽取的where条件后面的内容，不含where，需能够抽取到当期新增和修改的数据（业务上逻辑删除的数据为修改）。注：参照资源目录定义的increaseParam，日期格式化字符串需替换为实际日期值。isUseStorechar否是否使用中心库数据，资源为复合资源（multiFlag=M）时无效。Y使用，N不使用。默认为使用中心库，如数据未入中心库，该字段无效。needNoticechar是数据需求方是否需要通知:Y-需要，N-不需要如果填写Y-需要，则需实现B002服务。平台和数据提供方需判断此标志，确定是否发送B002通知。dataFileNameString否数据文件名：（1）当资源为单一资源（multiFlag=S，一个表或一个文件）时，系统ID_资源代码.dat；（2）当资源为复合资源（multiFlag=M）时，交换双方协商，建议交换双方定义的文件名称带上数据提供方ID，避免文件名重复。okFileNameString否标志文件名：（1）当资源为复合资源（multiFlag=S，一个表或一个文件）时，系统ID_资源代码.ok；（2）当资源为复合资源（multiFlag=M）时，交换双方协商，建议交换双方定义的文件名称带上数据提供方ID，避免文件名重复。2) 返回数据为空，即返回报文中data无数据，是否成功参见报文errCode字段。. B002-单次文件准备完成通知文件请求采用异步方式，平台或数据提供方根据B001的needNotice字段判断是否需用使用B002通知文件已生成。注意，请求报文体中correlationSerialNum需填写平台返回B001报文中的correlationSerialNum；返回报文体中correlationSerialNum需原样返回。文件格式请参见本文档2.3.1数据文件格式定义。1) 请求数据字段名称字段类型是否必填说明resourceIDString是资源IDstatuschar是采集供数状态:D-无需执行，N-未运行，R-运行中，F-完成，E-异常remarkString否执行信息dataFileNameString否数据文件名：（1） 当资源定义multiFlag=S时：系统ID_资源代码.dat；（2） 当资源定义multiFlag=M时：交换双方协商，建议交换双方定义的文件名称带上数据提供方ID，避免文件名重复。okFileNameString否标志文件名：（1）当资源定义multiFlag=S时：系统ID_资源代码.ok；（2）当资源定义multiFlag=M时：交换双方协商，建议交换双方定义的文件名称带上数据提供方ID，避免文件名重复。2) 返回数据，报文errCode为0时，反馈文件名称。字段名称字段类型是否必填说明dataFileNameString否数据文件名：（1）当资源定义multiFlag=S时：系统ID_资源代码.dat；（2）当资