數字檔案館二期財務系統會計電子文件歸檔接口標準

目錄TOC\o"1-2"\h\z\u1 引言 31.1 概述 31.2 適用范圍 31.3 開發(fā)平臺與環(huán)境 32 接口概述 42.1 設計原則 42.2 歸檔內容 42.3 財務系統歸檔接口流程描述 52.4 接口要求 72.5 接口交互數據格式要求 83 WebService服務描述 93.1 電子文件歸檔信息包批次歸檔接口服務 93.2 電子文件校驗結果反饋接口服務 113.3 電子文件歸檔信息包格式說明 14附件 3/161引言概述為了深入開展公司檔案信息化工作，數字檔案館系統需要與財務系統做到財務數據歸檔環(huán)節(jié)。針對統一接口平臺進行數據歸檔制定本標準。適用范圍本方案可為財務系統提供商的設計和開發(fā)工作提供參考。開發(fā)平臺與環(huán)境檔案管理系統開發(fā)商開發(fā)平臺與環(huán)境：基于J2EE框架，eclipse開發(fā)工具，Tomcat6.0以上，JDK1.6以上。接口概述設計原則為了保證檔案統一數據接口平臺和各上游系統間高效、準確地交換信息，接口的建設應符合如下原則：檔案統一接口系統應具備完整性、規(guī)范性、開放性和靈活性；接口定義應遵循易理解、易使用、易交流和易擴展的原則；在滿足業(yè)務需求的前提下，使接口數據量最少，最大限度地減輕數據提供方壓力；具有可靠完善的接口數據傳輸與錯誤處理機制；檔案統一接口系統的互動接口連接必須具有安全控制機制；由數據傳送方或數據接收方發(fā)起的接口擴展，都必須采用現有的傳輸協議與模式，并與現有接口編碼規(guī)則和命名規(guī)則保持一致。歸檔內容本接口標準規(guī)定的采集歸檔的范圍為財務系統會計檔案，其中要歸檔的數據內容按不同二級分類包括：會計憑證、會計賬簿、會計報告、會計其他類。歸檔的內容包括：著錄項、版式文件、原始文件等。財務系統歸檔接口流程描述流程過程描述：（1）通過調用接口平臺提供的SFTP服務，通過sftp傳輸協議上傳封裝好的電子文件歸檔信息包（eep格式）；（2）調用接口平臺提供的歸檔批次服務，同步需要（加密）傳遞的檔案的信息。在接口調用失敗的情況下，同步模塊需要記錄下失敗的信息，并有重試的處理；（3）接口平臺根據傳遞的檔案信息，對eep包進行四性校驗（校驗方案依據電子文件檢測工具配置的四性檢測方案檢測項），并調用財務系統的校驗結果接收服務，（加密）推送校驗狀態(tài)等結果信息。校驗成功的數據，通過分發(fā)配置，自動流轉到數字檔案館系統。（4）檔案員可在歸檔列表模塊進行校驗結果查詢，如針對校驗失敗的數據可再次進行修改必錄項等，可對修改后的數據進行手動歸檔（后臺重新封裝）；（5）系統管理員可以通過接口界面查看歸檔的情況，以及反饋信息。接口功能財務系統通過接口將待歸檔數據接入到AMS-ETL，需要實現四個功能：特別說明：eep文件傳輸采用sftp傳輸協議，xml交互需要加密（參見附件）傳輸。（1）檔案歸檔列表模塊開發(fā)該功能模塊，權限分配給檔案員。此功能模塊可修改必輸項內容，可記錄文件發(fā)送、歸檔狀態(tài)及接口反饋詳細信息的查詢；可手動觸發(fā)歸檔流程，便于【問題文件】重新打包歸檔；（2）電子文件歸檔信息包同步模塊開發(fā)SFTP客戶端程序。通過調用AMS-ETL提供的SFTP服務，將封裝好的電子文件歸檔信息包（eep格式）通過sftp傳輸協議傳送到AMS-ETL上，并記錄接口調用、返回記錄；（3）電子文件歸檔信息包批次同步模塊通過調用AMS-ETL提供的WebService服務將每份檔案的屬性信息（批次標識、檔案類型、檔案附件數量、每個eep文件的大小、校驗碼等基本信息及對應的調用接口的系統標識、系統名稱等來源信息）（加密）傳遞給接口服務，并記錄接口調用、返回記錄；（4）電子文件歸檔校驗結果收集模塊開發(fā)服務端，接收AMS-ETL反饋的四性校驗結果數據（解密）。（標準詳見章節(jié)3.2）。系統準入說明線上由AMS-ETL接口配置模塊生成財務系統接口準入的驗證用戶信息、token等。接口配置說明在正式使用前，根據財務檔案的分類和著錄項等業(yè)務規(guī)范，配置必錄項等信息；根據業(yè)務需要，支持財務系統采用按月、按天或實時的方式進行歸檔；根據技術對接需要，財務系統增加歸檔狀態(tài)、以及校驗結果字段。狀態(tài)值：未推送、已推送未校驗、推送失敗、校驗失敗、校驗成功且歸檔、數據修改待推送。接口要求接口實現方保證按時提供接口規(guī)范規(guī)定的數據內容；對接口數據提供相關的驗證功能，保證數據的準確性、一致性；對于傳送的數據，可以根據數據量、帶寬和系統性能等因素考慮是否采用壓縮方式；若原系統有變更，則要求在變更前提供變更內容說明，并及時更新本接口規(guī)范及相關附件的相應內容；遵循本接口規(guī)范中規(guī)定的驗證規(guī)則；應及時解決接口數據提供過程中出現的問題；對于未盡事宜，應同數據接收方協商解決；提供EEP壓縮工具類、提供web服務調用工作類；提供EtlEncryptiUtil加密工具類，供接入方使用。接口調用方按時接收接口規(guī)范規(guī)定的相關數據內容；對于數據采用壓縮方式傳送的情況，需要在接收時對消息中的數據進行解壓縮操作；若檔案統一數據接口平臺接口有變更，需要在變更之前，提供變更內容的相關說明，并及時更新本接口規(guī)范及相關附件的相應內容；遵循本接口規(guī)范中規(guī)定的驗證規(guī)則和變更說明；對于未盡事宜，應同WebService服務提供方協商解決。接口交互數據格式要求接口數據在傳遞過程中應該遵循以下原則：采用WebService進行交互；文件傳輸采用sftp協議進行傳輸；傳遞的數據格式：約定格式的XML數據（AMS-ETL提供加密工具類，見章節(jié)附件）；編碼格式：UTF-8；數據格式：數字格式：如果存在小數點，則小數點前后必須有數字；對于負數，符號位“-”必須出現在首位，整數則不加符號位；字符格式：對數據中含有的特殊字符，需要做轉義處理；日期格式：日期格式統一采用“YYYYMMDD”格式傳遞；時間類型：統一采用“HH24:MI:SS”格式；日期時間類型：統一采用“YYYYMMDDHH24:MI:SS”格式。WebService服務描述電子文件歸檔信息包批次歸檔接口服務AMS-ETL接口平臺開發(fā)電子文件歸檔信息包批次歸檔接口服務，供財務系統等上游系統推送按照eep規(guī)范封裝好的eep包批次信息。功能接收批次信息，寫入四性檢測表中；四性檢測；修改檢測結果，并調用反饋接口服務。接口規(guī)范服務信息服務標識ETLLOADSXJCDATA服務中文名稱電子文件歸檔信息包批次收集接口服務描述收集上游系統傳輸的eep電子文件歸檔信息包批次信息服務版本號V1.0服務提供方檔案統一數據接口平臺服務類型?讀取?寫入同步/異步方式同步業(yè)務場景說明1、財務系統將符合要求的電子文件歸檔信息包歸入統一數據接口平臺；2、統一數據接口平臺。實時/定時?定時?實時服務安全和權限要求無輸入信息調用基本的xml結構：<?xmlversion="1.0"encoding="UTF-8"?><PDE-INTERFACE-CONTENT> <HEADERINFO> <!--該部分節(jié)點數據格式，后續(xù)表格中詳細說明--> <!--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信息；序號節(jié)點名稱字段描述數據類型是否必錄備注1SOURCESYSTEMID調用方IDVARCHAR(20)Y2SOURCESYSTEMNAME調用方名稱VARCHAR(50)Y浪潮3TOKEN身份令牌VARCHAR(50)Y調用方身份令牌，初始令牌由接口平臺分發(fā)，后續(xù)攜帶當前令牌提交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信息：序號節(jié)點名稱字段描述數據類型是否必錄備注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創(chuàng)建日期VARCHAR2(20)Y歸檔文件封裝包創(chuàng)建日期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信息：序號節(jié)點名稱字段描述數據類型備注1ID封裝包IDVARCHAR(50)唯一標識，封裝包ID，GSABC201709262STATE處理結果狀態(tài)VARCHAR(30)1成功2失敗3已存在4忽略3RESULTMSG結果信息VARCHAR(1000)EEP包命名規(guī)范封裝包名稱主要由系統名稱、批次名稱、封裝日期等內容組成，例如GS單位編號201710121024.eep：需要保障封裝包的唯一性，并且需要記錄傳輸的封裝包整體批次信息。GS：系統名稱（AMS-ETL注冊接入時提供）；DWBH：單位編號；20171012：憑證日期;憑證編號：批次信息（建議為記錄主鍵、無主鍵的話建議可以用GUID）。電子文件校驗結果反饋接口服務AMS-ETL定時調用由財務系統開發(fā)提供的校驗反饋結果接收模塊服務，推送電子文件信息包的四性檢測結果反饋。功能接收四性檢測結果反饋信息。接口規(guī)范服務信息服務標識ETLSXJCSTATUSRESULT服務中文名稱電子文件歸檔四性校驗結果接收接口服務描述電子文件歸檔信息包（eep包）四性檢測校驗狀態(tài)反饋服務版本號V1.0服務提供方上游系統（財務系統）服務類型?讀取?寫入同步/異步方式同步業(yè)務場景說明1.接口平臺系統定時調用業(yè)務系統開發(fā)的校驗反饋結果收集接口服務；2.業(yè)務系統根據反饋情況分類處理。實時/定時?定時?實時服務安全和權限要求無輸入信息調用基本的xml結構：<?xmlversion="1.0"encoding="UTF-8"?><PDE-INTERFACE-CONTENT> <HEADERINFO> <!--該部分節(jié)點數據格式,后續(xù)表格中詳細說明--> <!--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信息；序號節(jié)點名稱字段描述數據類型是否必錄備注1SOURCESYSTEMID調用方IDVARCHAR(20)Yuuid（隨機）2SOURCESYSTEMNAME調用方名稱VARCHAR(50)YGS3TOKEN身份令牌VARCHAR(50)Y調用方身份令牌，初始令牌由接口平臺分發(fā)，后續(xù)攜帶當前令牌提交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校驗錯誤數據信息說明：序號節(jié)點名稱字段描述數據類型備注1IDEPP包批次的IDVARCHAR(50)2JYZT整體校驗狀態(tài)VARCHAR(30)0未校驗2通過3失敗3JOAX檢測結果明細VARCHAR(3000)4YJDW_ZQXJY準確性校驗狀態(tài)VARCHAR(30)1通過2失敗5YJDW_ZQXJYRESULT準確性校驗結果VARCHAR(200)6YJDW_WZXJY完整性校驗狀態(tài)VARCHAR(30)1通過2失敗7YJDW_WZXJYRESULT完整性校驗結果VARCHAR(200)8YJDW_KOAJY可用性校驗狀態(tài)VARCHAR(30)1通過2失敗9YJDW_KOAJYRESULT可用性校驗結果VARCHAR(200)10YJDW_AQXJY安全性校驗狀態(tài)VARCHAR(30)1通過2失敗11YJDW_AQXJYRESULT安全性校驗結果VARCHAR(200)12ROWDATAINFOID發(fā)送的批次信息IDVARCHAR(200)檔案系統生成RESPONSECOLLECTION校驗正確數據信息說明：序號節(jié)點名稱字段描述數據類型備注1IDEPP包批次的IDVARCHAR(50)2JYZT整體校驗狀態(tài)VARCHAR(30)0未校驗2通過3失敗3ROWDATAINFOID發(fā)送的批次信息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信息：序號節(jié)點名稱字段描述數據類型是否必錄備注1ROWDATAINFOIDEPP包批次的IDVARCHAR2(50)YEPP包批次的ID2STATE狀態(tài)信息VARCHAR2(50)Y1成功2失敗3RESULT狀態(tài)結果信息VARCHAR2(50)Y成功、失敗上游系統（財務系統）收集到反饋的結果分析，針對失敗數據修改處理，手動歸檔進行重新封裝打包eep，重新調用收集接口進行數據修改操作。電子文件歸檔信息包格式說明歸檔結構說明包含文件目錄.xml、說明文件.xml、文件夾、文件元數據.xml、電子文件，電子文件歸檔信息包放到中間的文件存儲系統上（一般