AEM Formsas a Cloud Service通訊批次處理

通訊可讓您建立、組合及傳遞品牌導向和個人化的通訊,例如商務通訊、檔案、報表、索賠處理信函、福利通知、每月帳單和歡迎套件。 您可以使用Communications API將範本(XFA或PDF)與客戶資料結合,以產生PDF、PS、PCL、DPL、IPL和ZPL格式的檔案。

通訊提供API,用於隨選和排程檔案產生。 您可以根據需求使用同步API,也可以根據排程檔案產生使用批次API (非同步API):

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

  • 批次API (非同步API)適合用於排程的高輸送量多檔案產生使用案例。 這些 API 批次產生文件。例如,每月產生的電話帳單、信用卡報表和福利報表。

批次作業 batch-operations

批次作業是以排定的間隔為一組記錄產生多個型別相似檔案的程式。 批次操作有兩個部分:設定(定義)和執行。

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

  • 執行:若要啟動批次作業,請將批次組態名稱傳遞至批次執行API。

批次作業的元件 components-of-a-batch-operations

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

批次資料存放區組態(USC):批次資料組態可協助您為批次API設定特定的Blob存放區執行個體。 它可讓您在客戶擁有的Microsoft Azure Blob儲存空間中指定輸入和輸出位置。

批次API:可讓您建立批次設定,並根據這些設定執行批次執行,以合併PDF或XDP範本與資料,並產生PDF、PS、PCL、DPL、IPL和ZPL格式的輸出。 通訊提供批次API用於設定管理和批次執行。

data-merge-table

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

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

使用批次作業產生多個檔案 generate-multiple-documents-using-batch-operations

您可以使用批次作業,以排定的間隔產生多個檔案。

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

必要條件 pre-requisites

若要使用批次API,需具備下列條件:

設定您的環境 setup-your-environment

使用批次作業之前:

  • 將客戶資料(XML檔案)上傳至Microsoft Azure Blob Storage
  • 建立雲端設定
  • 建立批次資料存放區設定
  • 將範本和其他資產上傳到您的Experience Manager FormsCloud Service執行個體

將客戶資料(XML檔案)上傳至Azure儲存體 upload-customer-data-to-Azure-Storage

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

NOTE
您可以設定Microsoft Azure儲存體以自動清除輸入資料夾,或依排程間隔將輸出資料夾的內容移至其他位置。 不過,請確保當參照資料夾的批次作業仍在執行時,不要清除資料夾。

建立雲端設定 create-a-cloud-configuration

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

  1. 前往「工具>Cloud Service> Azure儲存體」
  2. 開啟要裝載設定的資料夾,然後按一下「建立」。 您可以使用全域資料夾或建立資料夾。
  3. 指定要連線至服務的組態名稱和認證。 您可以從您的Microsoft Azure儲存體入口網站擷取這些認證
  4. 按一下「建立」。

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

建立批次資料存放區設定 create-batch-data-store-configuration

批次資料設定可幫助您設定用於輸入和輸出的容器和資料夾。 您會將客戶記錄儲存在Source資料夾中,且產生的檔案會放置在目標資料夾中。

若要建立組態:

  1. 前往「工具> Forms >統一儲存聯結器」。
  2. 開啟要裝載設定的資料夾,然後按一下「建立」。 您可以使用全域資料夾或建立資料夾。
  3. 指定設定的標題和名稱。 在儲存體中,選取Microsoft Azure儲存體。
  4. 在儲存體設定路徑中,瀏覽並選取包含客戶擁有的Azure儲存體帳戶認證的雲端設定。
  5. 在Source資料夾中,指定Azure儲存體容器的名稱和包含記錄的資料夾。
  6. 在目標資料夾中,指定Azure儲存體容器的路徑以及儲存產生檔案的資料夾。
  7. 按一下「建立」。

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

將範本和其他資產上傳到您的Experience Manager執行個體 upload-templates-and-other-assets-to-your-AEM-instance

組織通常有多個範本。 例如,信用卡對帳單、福利對帳單,以及索賠申請各有一個範本。 將所有這類XDP和PDF範本上傳到您的Experience Manager執行個體。 若要上傳範本:

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

使用批次API產生檔案 use-batch-API-to-generate-documents

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

建立批次 create-a-batch

若要建立批次,請使用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]檢視批次組態的詳細資料。

執行批次 run-a-batch

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

NOTE
批次執行時,請勿對對應的來源和目的地資料夾、資料來源設定和Microsoft Azure雲端設定進行任何變更。

檢查批次的狀態 status-of-a-batch

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

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

NOTE
  • 當您請求多個PRINT格式時,狀態包含多個專案。 例如,PRINT/ZPL、PRINT/IPL。
  • 批次作業不會同時讀取所有記錄,而是持續讀取並增加記錄數量。 因此,狀態會傳回–1,直到所有記錄都已讀取為止。

檢視產生的檔案 view-generated-documents

工作完成時,產生的檔案會儲存在批次資料存放區組態中所指定目的地位置的success資料夾中。 如果有任何錯誤,服務會建立failure資料夾。 它提供有關錯誤型別和原因的資訊。

讓我們透過範例來瞭解:假設有一個輸入資料檔record1.xml和兩種輸出型別: PDFPCL。 然後,目的地位置包含兩個子資料夾pdfpcl,每個輸出型別各一個。 假設PDF產生成功,則pdf子資料夾包含success子資料夾,而該子資料夾又包含實際產生的PDF檔案record1.pdf。 假設PCL產生失敗,則pcl子資料夾包含failure子資料夾,而該子資料夾又包含錯誤檔案record1.error.txt,其中包含錯誤的詳細資料。 此外,目的地位置包含名為__tmp__的暫存資料夾,其中會儲存批次執行期間所需的特定檔案。 當沒有參考目的地資料夾的有效批次執行時,可以刪除此資料夾。

NOTE
根據輸入記錄的數量和範本的複雜性,處理批次可能需要一些時間,請等候幾分鐘再檢查輸出檔案的目標資料夾。

API參考檔案

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

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab