資訊清單檔案
建立檔案的批次處理 (例如資料匯出相關批次處理) 可以在每個處理執行緒中建立一或多個檔案。使用這些檔案的外部應用程式只有在成功完成整個批次處理時才需要處理這些檔案。為了要自動使用這類檔案,外部應用程式會利用函數,使其在資訊清單檔案建立後觸發,以處理資訊清單所參考的所有檔案。資訊清單檔案包含內容雜湊值、檔案大小資訊等明細,有助於在處理檔案之前,先確認檔案內容已完成且未曾被竄改。
下列各區段提供資訊清單檔案的其他相關資訊。
資訊清單選項批次參數
只有特定基準產品擷取相關批次控制才支援建立資訊清單檔案。這些批次控制包含資訊清單選項批次參數,參數可控制是否應在成功完成批次處理後建立資訊清單檔案。您可以使用「批次控制查詢」入口來尋找所有支援此選項的批次控制。
資訊清單檔案資訊
資訊清單檔案內容是以 JSON 格式提供,並包含下列資訊:
-
資訊清單明細結構的版本。
-
可識別產生檔案之批次執行的批次控制代碼、執行編號及重新執行編號
-
批次執行所建立的檔案總數。
-
批次執行所處理的記錄總數。
-
ISO 格式的資訊清單建立時間戳記。
-
先前已完成的批次執行編號 (若有的話)。
-
先前已完成之批次執行所產生的資訊清單檔案 (若有的話)。這可用來確保檔案以正確的順序處理,並協助偵測可能發生的檔案遺失情況。
-
批次執行所建立的檔案列表,其中包含每個檔案的下列明細:檔案的名稱、大小 (位元組),以及檔案內容的 SHA-256 雜湊值。
資訊清單檔案名稱的建構方式如下:
[batch control]_[batch run number]_[batch rerun number]_manifest.json
下列是資訊清單檔案結構範例。
{
"version": 1,
"batchCode": "HD-PDE",
"batchRunNumber": 106,
"batchRerunNumber": 0,
"totalFiles": 3,
"recordsProcessed": 10,
"timeStamp": "2020-05-02T16:55:43.000353Z",
"previousBatchRunNumber":"105"
"previousManifestFileName":"HD-PDE_105_0_manifest.json",
"fileDetails": [
{
"fileName": "SOME_FILE_NAME_001.json.gz",
"fileSize": 1543,
"hashAlgorithm": "SHA-256",
"hashValue": "ff7d4e466f93cadc4a18ab009080916baff631e03b728e2f2684c4a4f92ccbe1"
},
{
"fileName": "SOME_FILE_NAME_002.json.gz",
"fileSize": 1182,
"hashAlgorithm": "SHA-256",
"hashValue": "78869e7ce971f28a70f5b35693a05726ba66109fecf492edb60291a62ae1ba9f"
},
{
"fileName": "SOME_FILE_NAME_003.json.gz",
"fileSize": 1182,
"hashAlgorithm": "SHA-256",
"hashValue": "78869e7ce971f28a70f5b35693a05726ba66109fecf492edb60291a62ae1ba9f"
}
]
}{
驗證資訊清單檔案
外部系統可以使用驗證資訊清單檔案 Web 服務,驗證所收到的特定批次執行資訊清單檔案並未損毀或被竄改。服務會對要求的批次執行傳回資訊清單檔案名稱及其內容的雜湊值,讓呼叫程式將其檔案明細與傳回的值做比較。