使用批次處理

通信允許您建立、組合和提供面向品牌的個性化通信,如業務通信、文檔、對帳單、理賠處理信函、福利通知、理賠處理信函、每月賬單和歡迎套件。 您可以使用通信API將模板(XFA或PDF)與客戶資料結合,以PDF、PS、PCL、DPL、IPL和ZPL格式生成文檔。

通訊提供API,以供隨選和排程的檔案產生。 您可以針對隨需和批次API(非同步API)使用同步API,以排程產生檔案:

  • 同步API適用於隨需、低延遲和單記錄檔案產生使用案例。 這些API更適合使用者動作的使用案例。 例如,在用戶填寫表單後生成文檔。

  • 批次API(非同步API)適用於排程的高吞吐量多檔案產生使用案例。 這些API會以批次產生檔案。 例如,每月生成電話賬單、信用卡對帳單和福利對帳單。

批處理操作

批處理操作是按計畫間隔為一組記錄生成多個類似類型的文檔的過程。 批工序包含兩個部分:配置(定義)和執行。

  • 配置(定義):批次設定會儲存各種資產和屬性的相關資訊,以針對產生的檔案進行設定。 例如,它提供有關XDP或PDF範本的詳細資訊,以及要使用的客戶資料的位置,並指定輸出檔案的各種屬性。

  • 執行:要啟動批處理操作,請將批處理配置名稱傳遞到批處理執行API。

批操作的元件

雲端設定:Experience Manager Cloud設定可協助您將Experience Manager執行個體連結至客戶擁有的Microsoft Azure Storage。 它可讓您指定客戶擁有的Microsoft Azure帳戶的憑證,以便連線至該帳戶。

批次資料儲存配置(USC):批次資料設定可協助您為批次API設定Blob儲存的特定例項。 它可讓您在客戶擁有的Microsoft Azure Blob儲存體中指定輸入和輸出位置。

批次API:可讓您建立批配置並根據這些配置執行批運行,以將PDF或XDP模板與資料合併,並以PDF、PS、PCL、DPL、IPL和ZPL格式生成輸出。 通訊提供批次API,以進行設定管理和批次執行。

資料合併表

儲存:通訊API使用客戶擁有的Microsoft Azure Cloud儲存空間,擷取客戶記錄並儲存產生的檔案。 您可以在「Microsoft設定」中設定Experience Manager Cloud Service Azure Storage。

應用程式:您的自訂應用程式,以使用批次API來產生和使用檔案。

使用批處理工序生成多個文檔

您可以使用批處理操作以計畫的間隔生成多個文檔。

您可以觀看影片或執行以下指示,了解如何使用批次作業產生檔案。 影片中使用的API參考檔案以.yaml格式提供。 您可以下載 批次API 檔案並上傳至Postman,以檢查API的功能,並觀看影片。

先決條件

若要使用批次API,需執行下列操作:

設定您的環境

使用批工序之前:

  • 上傳客戶資料(XML檔案)至Microsoft Azure Blob儲存
  • 建立雲端設定
  • 建立批次資料儲存配置
  • 將範本和其他資產上傳至您的Experience Manager FormsCloud Service例項

將客戶資料(XML檔案)上傳至Azure儲存

在您的Microsoft Azure儲存上,建立 容器上傳客戶資料(XML)資料夾 內。

注意

您可以設定Microsoft Azure儲存空間,以自動清除輸入資料夾,或以排程間隔將輸出資料夾的內容移至不同位置。 但是,請確保當引用資料夾的批處理操作仍在運行時不會清理資料夾。

建立雲端設定

雲端設定會將您的Experience Manager執行個體連線至Microsoft Azure Storage。 若要建立雲端設定:

  1. 前往「工具>Cloud Services> Azure Storage」
  2. 開啟資料夾以托管配置,然後按一下「建立」。 使用全局資料夾或建立資料夾。
  3. 指定連接到服務的配置和憑據的名稱。 您可以 從您的Microsoft Azure儲存入口網站擷取這些憑證.
  4. 按一下建立。

您的Experience Manager例項現在已準備好連線至Microsoft Azure Storage,並視需要使用它來儲存和讀取內容。

建立批次資料儲存配置

批次資料設定可協助您設定容器和資料夾以進行輸入和輸出。 您將客戶記錄保留在「源資料夾」中,並將生成的文檔放在「目標資料夾」中。

若要建立設定:

  1. 前往「工具> Forms >統一儲存連接器」。
  2. 開啟資料夾以托管配置,然後按一下「建立」。 使用全局資料夾或建立資料夾。
  3. 指定設定的標題和名稱。 在儲存中,選取Microsoft Azure Storage。
  4. 在儲存配置路徑中,瀏覽並選擇包含客戶擁有的Azure儲存帳戶憑據的雲配置。
  5. 在源資料夾中,指定Azure儲存容器的名稱和包含記錄的資料夾。
  6. 在目標資料夾中,指定Azure儲存容器的路徑和資料夾,以儲存生成的文檔。
  7. 按一下建立。

您的Experience Manager執行個體現在已連線至Microsoft Azure Storage,並已設定為擷取資料,並將資料傳送至Microsoft Azure儲存上的特定位置。

上傳範本和其他資產至您的Experience Manager例項

組織通常有多個範本。 例如,信用卡報表、福利報表和報銷申請各一個模板。 將所有這類XDP和PDF範本上傳至您的Experience Manager執行個體。 上傳範本:

  1. 開啟您的Experience Manager例項。
  2. 前往Forms > Forms和檔案
  3. 按一下「建立」>「資料夾」並建立資料夾。 開啟資料夾。
  4. 按一下「建立>檔案上傳」並上傳範本。

使用批次API生成文檔

若要使用批次API,請建立批次設定,並根據該設定執行執行。 API檔案提供建立及執行批次的API、對應參數,以及可能錯誤的相關資訊。 您可以下載 API定義檔案 將檔案上傳至 Postman 或類似的軟體來測試API以建立和執行批次操作。

建立批次

要建立批,請使用 POST /config API。 在HTTP要求內文中加入下列必要屬性:

  • configName:指定批的唯一名稱。 例如, wknd-job

  • dataSourceConfigUri:指定批資料儲存配置的位置。 它可以是配置的相對路徑或絕對路徑。 例如:/conf/global/settings/forms/usc/batch/wknd-batch

  • outputTypes:指定輸出格式:PDF和打印。 如果使用PRINT輸出類型,請在 printedOutputOptionsList 屬性,指定至少一個打印選項。 打印選項是通過其渲染類型標識的,因此目前不允許使用具有相同渲染類型的多個打印選項。 支援的格式為PS、PCL、DPL、IPL和ZPL。

  • 範本:指定模板的絕對路徑或相對路徑。 例如, crx:///content/dam/formsanddocuments/wknd/statements.xdp

如果您指定相對路徑,也提供內容根。 如需內容根目錄的詳細資訊,請參閱API檔案。

您可以使用 GET /config /[configName] 以查看批配置的詳細資訊。

運行批處理

要運行(執行)批處理,請使用 POST /config /[configName]/execution. 例如,要運行名為wknd-demo的批處理,請使用/config/wknd-demo/execution。 伺服器在接受請求時傳回HTTP回應代碼202。 API不會針對伺服器上執行的批次作業,在HTTP回應標題中傳回除唯一代碼(執行識別碼)以外的任何裝載。 您可以使用執行標識符來檢索批的狀態。

注意

當批處理正在運行時,請勿對相應的源資料夾和目標資料夾、資料源配置和Microsoft Azure Cloud配置進行任何更改。

檢查批的狀態

要檢索批的狀態,請使用 GET /config /[configName]/execution/[execution-identifier]. 執行識別碼包含在批次執行請求的HTTP回應標題中。

狀態請求的回應包含狀態區段。 它提供了有關批處理作業的狀態、已在管道中(已讀取和正在處理)的記錄數以及每個outputType/renderType(正在處理的項數、成功和失敗的項數)的狀態的詳細資訊。 狀態還包括批處理作業的開始和結束時間以及有關錯誤的資訊(如果有)。 結束時間為–1,直到批處理運行實際完成。

注意
  • 請求多種PRINT格式時,狀態包含多個條目。 例如,PRINT/ZPL、PRINT/IPL。
  • 批處理作業不會同時讀取所有記錄,而是繼續讀取和增加記錄數。 因此,在讀取所有記錄之前,狀態將返回–1。

查看生成的文檔

作業完成時,將生成的文檔儲存到 success 資料夾(位於批次資料儲存配置中指定的目標位置)。 如果有任何錯誤,服務會建立 failure 檔案夾。 它提供錯誤類型和原因的相關資訊。

讓我們透過範例來了解:假設有輸入資料檔案 record1.xml 和兩種輸出類型: PDFPCL. 然後,目標位置包含兩個子資料夾 pdfpcl,每個輸出類型各一個。 假設PDF產生成功,則 pdf 子資料夾包含 success 子資料夾,該子資料夾又包含實際生成的PDF文檔 record1.pdf. 假設PCL生成失敗,則 pcl 子資料夾包含 failure 子資料夾中又包含錯誤檔案 record1.error.txt 其中包含錯誤的詳細資訊。 此外,目標位置包含名為的臨時資料夾 __tmp__ 它保存批處理執行期間所需的某些檔案。 當沒有參考目標資料夾的活動批處理運行時,可以刪除此資料夾。

注意

根據輸入記錄的數量和模板的複雜性,處理批處理可能需要一些時間,然後等待幾分鐘,再檢查輸出檔案的目標資料夾。

API參考檔案

API參考檔案提供有關API所提供所有參數、驗證方法和各種服務的詳細資訊。 API參考檔案提供.yaml格式。 您可以下載 批次API 檔案並上傳至Postman以檢查API的功能。

本頁內容