AEM Formsas a Cloud Service通訊批次處理

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

通訊提供API，用於隨選和排程檔案產生。 您可以根據需求使用同步API，也可以根據排程檔案產生使用批次API （非同步API）：

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

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

批次作業

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

• 設定（定義）：批次設定會儲存各種資產和屬性的相關資訊，以便為產生的檔案設定。 例如，它提供有關XDP或PDF範本和要使用的客戶資料位置的詳細資訊，並為輸出檔案指定各種屬性。

• 執行：若要開始批次作業，請將批次設定名稱傳遞至批次執行API。

批次作業的元件

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

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

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

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

應用程式：使用批次API產生及使用檔案的自訂應用程式。

使用批次作業產生多個檔案

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

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

先決條件

若要使用批次API，需具備下列條件：

• Microsoft Azure儲存體帳戶
• PDF或XDP範本
• 要與範本合併的資料
• 具有Experience Manager管理員許可權的使用者

設定您的環境

使用批次作業之前：

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

將客戶資料（XML檔案）上傳至Azure儲存體

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

建立雲端設定

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

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

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

建立批次資料存放區設定

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

若要建立組態：

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

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

將範本和其他資產上傳到您的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

• outputType：指定輸出格式：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。 除了在伺服器上執行的批次作業的HTTP回應標題中的唯一代碼(execution-identifier)，API不會傳回任何裝載。 您可以使用執行識別碼來擷取批次的狀態。

檢查批次的狀態

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

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

檢視產生的檔案

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

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

API參考檔案

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