数字档案馆二期财务系统会计电子文件归档接口标准

目录TOC\o"1-2"\h\z\u1 引言 31.1 概述 31.2 适用范围 31.3 开发平台与环境 32 接口概述 42.1 设计原则 42.2 归档内容 42.3 财务系统归档接口流程描述 52.4 接口要求 72.5 接口交互数据格式要求 83 WebService服务描述 93.1 电子文件归档信息包批次归档接口服务 93.2 电子文件校验结果反馈接口服务 113.3 电子文件归档信息包格式说明 14附件 3/161引言概述为了深入开展公司档案信息化工作，数字档案馆系统需要与财务系统做到财务数据归档环节。针对统一接口平台进行数据归档制定本标准。适用范围本方案可为财务系统提供商的设计和开发工作提供参考。开发平台与环境档案管理系统开发商开发平台与环境：基于J2EE框架，eclipse开发工具，Tomcat6.0以上，JDK1.6以上。接口概述设计原则为了保证档案统一数据接口平台和各上游系统间高效、准确地交换信息，接口的建设应符合如下原则：档案统一接口系统应具备完整性、规范性、开放性和灵活性；接口定义应遵循易理解、易使用、易交流和易扩展的原则；在满足业务需求的前提下，使接口数据量最少，最大限度地减轻数据提供方压力；具有可靠完善的接口数据传输与错误处理机制；档案统一接口系统的互动接口连接必须具有安全控制机制；由数据传送方或数据接收方发起的接口扩展，都必须采用现有的传输协议与模式，并与现有接口编码规则和命名规则保持一致。归档内容本接口标准规定的采集归档的范围为财务系统会计档案，其中要归档的数据内容按不同二级分类包括：会计凭证、会计账簿、会计报告、会计其他类。归档的内容包括：著录项、版式文件、原始文件等。财务系统归档接口流程描述流程过程描述：（1）通过调用接口平台提供的SFTP服务，通过sftp传输协议上传封装好的电子文件归档信息包（eep格式）；（2）调用接口平台提供的归档批次服务，同步需要（加密）传递的档案的信息。在接口调用失败的情况下，同步模块需要记录下失败的信息，并有重试的处理；（3）接口平台根据传递的档案信息，对eep包进行四性校验（校验方案依据电子文件检测工具配置的四性检测方案检测项），并调用财务系统的校验结果接收服务，（加密）推送校验状态等结果信息。校验成功的数据，通过分发配置，自动流转到数字档案馆系统。（4）档案员可在归档列表模块进行校验结果查询，如针对校验失败的数据可再次进行修改必录项等，可对修改后的数据进行手动归档（后台重新封装）；（5）系统管理员可以通过接口界面查看归档的情况，以及反馈信息。接口功能财务系统通过接口将待归档数据接入到AMS-ETL，需要实现四个功能：特别说明：eep文件传输采用sftp传输协议，xml交互需要加密（参见附件）传输。（1）档案归档列表模块开发该功能模块，权限分配给档案员。此功能模块可修改必输项内容，可记录文件发送、归档状态及接口反馈详细信息的查询；可手动触发归档流程，便于【问题文件】重新打包归档；（2）电子文件归档信息包同步模块开发SFTP客户端程序。通过调用AMS-ETL提供的SFTP服务，将封装好的电子文件归档信息包（eep格式）通过sftp传输协议传送到AMS-ETL上，并记录接口调用、返回记录；（3）电子文件归档信息包批次同步模块通过调用AMS-ETL提供的WebService服务将每份档案的属性信息（批次标识、档案类型、档案附件数量、每个eep文件的大小、校验码等基本信息及对应的调用接口的系统标识、系统名称等来源信息）（加密）传递给接口服务，并记录接口调用、返回记录；（4）电子文件归档校验结果收集模块开发服务端，接收AMS-ETL反馈的四性校验结果数据（解密）。（标准详见章节3.2）。系统准入说明线上由AMS-ETL接口配置模块生成财务系统接口准入的验证用户信息、token等。接口配置说明在正式使用前，根据财务档案的分类和著录项等业务规范，配置必录项等信息；根据业务需要，支持财务系统采用按月、按天或实时的方式进行归档；根据技术对接需要，财务系统增加归档状态、以及校验结果字段。状态值：未推送、已推送未校验、推送失败、校验失败、校验成功且归档、数据修改待推送。接口要求接口实现方保证按时提供接口规范规定的数据内容；对接口数据提供相关的验证功能，保证数据的准确性、一致性；对于传送的数据，可以根据数据量、带宽和系统性能等因素考虑是否采用压缩方式；若原系统有变更，则要求在变更前提供变更内容说明，并及时更新本接口规范及相关附件的相应内容；遵循本接口规范中规定的验证规则；应及时解决接口数据提供过程中出现的问题；对于未尽事宜，应同数据接收方协商解决；提供EEP压缩工具类、提供web服务调用工作类；提供EtlEncryptiUtil加密工具类，供接入方使用。接口调用方按时接收接口规范规定的相关数据内容；对于数据采用压缩方式传送的情况，需要在接收时对消息中的数据进行解压缩操作；若档案统一数据接口平台接口有变更，需要在变更之前，提供变更内容的相关说明，并及时更新本接口规范及相关附件的相应内容；遵循本接口规范中规定的验证规则和变更说明；对于未尽事宜，应同WebService服务提供方协商解决。接口交互数据格式要求接口数据在传递过程中应该遵循以下原则：采用WebService进行交互；文件传输采用sftp协议进行传输；传递的数据格式：约定格式的XML数据（AMS-ETL提供加密工具类，见章节附件）；编码格式：UTF-8；数据格式：数字格式：如果存在小数点，则小数点前后必须有数字；对于负数，符号位“-”必须出现在首位，整数则不加符号位；字符格式：对数据中含有的特殊字符，需要做转义处理；日期格式：日期格式统一采用“YYYYMMDD”格式传递；时间类型：统一采用“HH24:MI:SS”格式；日期时间类型：统一采用“YYYYMMDDHH24:MI:SS”格式。WebService服务描述电子文件归档信息包批次归档接口服务AMS-ETL接口平台开发电子文件归档信息包批次归档接口服务，供财务系统等上游系统推送按照eep规范封装好的eep包批次信息。功能接收批次信息，写入四性检测表中；四性检测；修改检测结果，并调用反馈接口服务。接口规范服务信息服务标识ETLLOADSXJCDATA服务中文名称电子文件归档信息包批次收集接口服务描述收集上游系统传输的eep电子文件归档信息包批次信息服务版本号V1.0服务提供方档案统一数据接口平台服务类型☒读取☑写入同步/异步方式同步业务场景说明1、财务系统将符合要求的电子文件归档信息包归入统一数据接口平台；2、统一数据接口平台。实时/定时☒定时☑实时服务安全和权限要求无输入信息调用基本的xml结构：<?xmlversion="1.0"encoding="UTF-8"?><PDE-INTERFACE-CONTENT> <HEADERINFO> <!--该部分节点数据格式，后续表格中详细说明--> <!--HEADINFODATA--> </HEADERINFO> <INPUTCOLLECTION> <ROW> <ID>OA201709261024</ID> <TYPE>INSERT</TYPE> <NRMS>凭证编号</NRMS> <DWMC>中国交通建设集团有限公司</DWMC> <XXXTMC>浪潮</XXXTMC> <ND>凭证年度</ND> <YJZT>纸质</YJZT> <YJDW_TBSJ></YJDW_TBSJ> <ZTBH>OA201709261024</ZTBH> <SZZYZ>归档文件封装包MD5值</SZZYZ> <FILENAME>OA201709261024.eep</FILENAME> <FILEPATH>201709/OA201709261024.eep</FILEPATH> <CREATEDATE>YYYYMMDDHH24:MI:SS</CREATEDATE> <WJRL></WJRL> </ROW> <!--INPUTICOLLECTION--></INPUTCOLLECTION></PDE-INTERFACE-CONTENT>数据HEADINFODATA信息；序号节点名称字段描述数据类型是否必录备注1SOURCESYSTEMID调用方IDVARCHAR(20)Y2SOURCESYSTEMNAME调用方名称VARCHAR(50)Y浪潮3TOKEN身份令牌VARCHAR(50)Y调用方身份令牌，初始令牌由接口平台分发，后续携带当前令牌提交4USER_ID调用用户标识VARCHAR(20)N接口调用者标识5USER_NAME调用的用户名称VARCHAR(50)N接口调用者名称6SUBMIT_DATE提交时间VARCHAR(20)N提交日期，日期格式：YYYYMMDDHHMISS7TRACE_ID该接口请求标识VARCHAR(50)N该次接口请求标识，根据此标识跟踪接口处理情况8EXPAND_1扩展字段VARCHAR(50)N扩展字段9EXPAND_2扩展字段VARCHAR(50)N扩展字段数据ROW信息：序号节点名称字段描述数据类型是否必录备注1ID封装包IDVARCHAR2(50)Y唯一标识，封装包ID，OA1201709262TYPE类型VARCHAR2(50)YINSERT为新增UPDATE为修改3NRMS内容描述VARCHAR2(248)Y如：凭证编号4DWMC单位名称VARCHAR2(20)Y归档单位的名称5XXXTMC信息系统名称VARCHAR2(20)Y浪潮6ND年度VARCHAR2(4)N文件年度7YJZT移交载体VARCHAR2(20)Y纸质8YJDW_DASL电子档案数量/数据量NUMBER(18)Y归档文件封装包数量9YJDW_TBSJ归档时间DATEN空10ZTBH载体编号VARCHAR2(50)Y归档文件封装包名称（不用带后缀）例：OA20170926102411SZZYZ数字摘要值VARCHAR2(50)Y归档文件封装包MD5值12FILENAME文件名称VARCHAR2(50)Y归档文件封装包文件名,OA201709261024.eep13FILEPATH路径VARCHAR2(200)Ysftp存放路径：文件存放的完整路径，201709/OA201709261024.eep14CREATEDATE创建日期VARCHAR2(20)Y归档文件封装包创建日期15WJRL文件大小VARCHAR2(200)N空输出信息<?xmlversion="1.0"encoding="UTF-8"?><PDE-INTERFACE-RESPONSE> <OUTPUTCOLLECTION> <ROW> <ID>123</ID> <STATE>1</STATE> <RESULTMSG>成功</RESULTMSG> </ROW> </OUTPUTCOLLECTION></PDE-INTERFACE-RESPONSE> 数据ROW信息：序号节点名称字段描述数据类型备注1ID封装包IDVARCHAR(50)唯一标识，封装包ID，GSABC201709262STATE处理结果状态VARCHAR(30)1成功2失败3已存在4忽略3RESULTMSG结果信息VARCHAR(1000)EEP包命名规范封装包名称主要由系统名称、批次名称、封装日期等内容组成，例如GS单位编号201710121024.eep：需要保障封装包的唯一性，并且需要记录传输的封装包整体批次信息。GS：系统名称（AMS-ETL注册接入时提供）；DWBH：单位编号；20171012：凭证日期;凭证编号：批次信息（建议为记录主键、无主键的话建议可以用GUID）。电子文件校验结果反馈接口服务AMS-ETL定时调用由财务系统开发提供的校验反馈结果接收模块服务，推送电子文件信息包的四性检测结果反馈。功能接收四性检测结果反馈信息。接口规范服务信息服务标识ETLSXJCSTATUSRESULT服务中文名称电子文件归档四性校验结果接收接口服务描述电子文件归档信息包（eep包）四性检测校验状态反馈服务版本号V1.0服务提供方上游系统（财务系统）服务类型☒读取☑写入同步/异步方式同步业务场景说明1.接口平台系统定时调用业务系统开发的校验反馈结果收集接口服务；2.业务系统根据反馈情况分类处理。实时/定时☑定时☒实时服务安全和权限要求无输入信息调用基本的xml结构：<?xmlversion="1.0"encoding="UTF-8"?><PDE-INTERFACE-CONTENT> <HEADERINFO> <!--该部分节点数据格式,后续表格中详细说明--> <!--HEADINFODATA--> </HEADERINFO> <INPUTCOLLECTION> <ROWDATAINFOID>ETL201710121024</ROWDATAINFOID> <!--ERRORCOLLECTION校验错误信息--> <ERRORCOLLECTION> <ROWS> <ROW> <ID>GSABC20170926</ID> <JYZT>3</JYZT><JOAX>检测结果明细</JOAX> <YJDW_ZQXJY>2</YJDW_ZQXJY> <YJDW_ZQXJYRESULT>失败原因</YJDW_ZQXJYRESULT> <YJDW_WZXJY>2</YJDW_WZXJY> <YJDW_WZXJYRESULT>失败原因</YJDW_WZXJYRESULT> <YJDW_KOAJY>2</YJDW_KOAJY> <YJDW_KOAJYRESULT>失败原因</YJDW_KOAJYRESULT> <YJDW_AQXJY>2</YJDW_AQXJY> <YJDW_AQXJYRESULT>失败原因</YJDW_AQXJYRESULT> </ROW> <ROW> <ID>GSABC20170926</ID> <JYZT>3</JYZT><JOAX>检测结果明细</JOAX> <YJDW_ZQXJY>2</YJDW_ZQXJY> <YJDW_ZQXJYRESULT>失败原因</YJDW_ZQXJYRESULT> <YJDW_WZXJY>2</YJDW_WZXJY> <YJDW_WZXJYRESULT>失败原因</YJDW_WZXJYRESULT> <YJDW_KOAJY>2</YJDW_KOAJY> <YJDW_KOAJYRESULT>失败原因</YJDW_KOAJYRESULT> <YJDW_AQXJY>2</YJDW_AQXJY> <YJDW_AQXJYRESULT>失败原因</YJDW_AQXJYRESULT> </ROW> </ROWS> </ERRORCOLLECTION> <!--—RESPONSECOLLECTION校验正确的数据信息--> <RESPONSECOLLECTION> <ROWS> <ROW> <ID>GSABC20170926</ID> <JYZT>2</JYZT> </ROW> <ROW> <ID>GSABC20170926</ID> <JYZT>2</JYZT> </ROW> </ROWS> </RESPONSECOLLECTION> <!--INPUTICOLLECTION--> </INPUTCOLLECTION></PDE-INTERFACE-CONTENT>数据HEADINFODATA信息；序号节点名称字段描述数据类型是否必录备注1SOURCESYSTEMID调用方IDVARCHAR(20)Yuuid（随机）2SOURCESYSTEMNAME调用方名称VARCHAR(50)YGS3TOKEN身份令牌VARCHAR(50)Y调用方身份令牌，初始令牌由接口平台分发，后续携带当前令牌提交4USER_ID调用用户标识VARCHAR(20)NGS5USER_NAME调用的用户名称VARCHAR(50)N浪潮6SUBMIT_DATE提交时间VARCHAR(20)N提交日期，日期格式：“YYYYMMDDHH24MMSS”7TRACE_ID该接口请请标识VARCHAR(50)N同SOURCESYSTEMID8EXPAND_1扩展字段VARCHAR(50)N扩展字段9EXPAND_2扩展字段VARCHAR(50)N扩展字段ERRORCOLLECTION校验错误数据信息说明：序号节点名称字段描述数据类型备注1IDEPP包批次的IDVARCHAR(50)2JYZT整体校验状态VARCHAR(30)0未校验2通过3失败3JOAX检测结果明细VARCHAR(3000)4YJDW_ZQXJY准确性校验状态VARCHAR(30)1通过2失败5YJDW_ZQXJYRESULT准确性校验结果VARCHAR(200)6YJDW_WZXJY完整性校验状态VARCHAR(30)1通过2失败7YJDW_WZXJYRESULT完整性校验结果VARCHAR(200)8YJDW_KOAJY可用性校验状态VARCHAR(30)1通过2失败9YJDW_KOAJYRESULT可用性校验结果VARCHAR(200)10YJDW_AQXJY安全性校验状态VARCHAR(30)1通过2失败11YJDW_AQXJYRESULT安全性校验结果VARCHAR(200)12ROWDATAINFOID发送的批次信息IDVARCHAR(200)档案系统生成RESPONSECOLLECTION校验正确数据信息说明：序号节点名称字段描述数据类型备注1IDEPP包批次的IDVARCHAR(50)2JYZT整体校验状态VARCHAR(30)0未校验2通过3失败3ROWDATAINFOID发送的批次信息IDVARCHAR(200)输出信息<?xmlversion="1.0"encoding="UTF-8"?><PDE-INTERFACE-RESPONSE> <OUTPUTCOLLECTION> <ROWDATAINFOID>ETL201710121024</ROWDATAINFOID> <STATE>1</STATE> <RESULT>成功</RESULT> </OUTPUTCOLLECTION></PDE-INTERFACE-RESPONSE>返回数据ROW信息：序号节点名称字段描述数据类型是否必录备注1ROWDATAINFOIDEPP包批次的IDVARCHAR2(50)YEPP包批次的ID2STATE状态信息VARCHAR2(50)Y1成功2失败3RESULT状态结果信息VARCHAR2(50)Y成功、失败上游系统（财务系统）收集到反馈的结果分析，针对失败数据修改处理，手动归档进行重新封装打包eep，重新调用收集接口进行数据修改操作。电子文件归档信息包格式说明归档结构说明包含文件目录.xml、说明文件.xml、文件夹、文件元数据.xml、电子文件，电子文件归档信息包放到中间的文件存储系统上（一般