AEM Formsas a Cloud Service通信批量处理

上次更新: 2024-01-15
  • 主题:
  • Adaptive Forms
    查看有关此主题的更多信息
  • APIs
    查看有关此主题的更多信息
  • 创建对象:
  • Admin
    Developer
    User

通信允许您创建、收集和提供面向品牌的个性化通信,如业务往来函、文档、报表、索赔处理函、福利通知、每月账单和欢迎资料包。 您可以使用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 Storage。 它可让您为客户拥有的Microsoft Azure帐户指定凭据以连接到该帐户。

批量数据存储配置(USC):批量数据配置可帮助您为批处理API配置特定的Blob存储实例。 它可让您在客户拥有的Microsoft Azure Blob Storage中指定输入和输出位置。

批处理API:可让您创建批处理配置并根据这些配置执行批处理运行,以将PDF或XDP模板与数据合并并生成PDF、PS、PCL、DPL、IPL和ZPL格式的输出。 通信提供了批处理API,用于配置管理和批量执行。

data-merge-table

存储:通信API使用客户拥有的Microsoft Azure云存储来获取客户记录并存储生成的文档。 您可以在Experience Manager Cloud Service配置中配置Microsoft Azure Storage。

应用程序:使用批处理API生成和使用文档的自定义应用程序。

使用批处理操作生成多个文档

您可以使用批处理操作按计划间隔生成多个文档。

您可以观看视频或执行以下说明,了解如何使用批处理操作生成文档。 视频中使用的API参考文档以.yaml格式提供。 您可以下载 批处理API 将其上载到Postman以检查API的功能并观看视频。

先决条件

要使用批处理API,需要满足以下条件:

设置环境

使用批处理操作之前:

  • 将客户数据(XML文件)上传到Microsoft Azure Blob Storage
  • 创建云配置
  • 创建批量数据存储配置
  • 将模板和其他资源上传到Experience Manager FormsCloud Service实例

将客户数据(XML文件)上传到Azure存储

在您的Microsoft Azure Storage上,创建 容器上传客户数据(XML)文件夹 在容器内。

注意

您可以将Microsoft Azure Storage配置为自动清理输入文件夹,或按计划时间间隔将输出文件夹的内容移动到其他位置。 但是,请确保在引用文件夹的批处理操作仍在运行时不清理文件夹。

创建云配置

云配置可将您的Experience Manager实例连接到Microsoft Azure Storage。 要创建云配置,请执行以下操作:

  1. 转到“工具”>“Cloud Service”>“Azure存储”
  2. 打开文件夹以托管配置,然后单击“创建”。 您可以使用全局文件夹或创建文件夹。
  3. 指定要连接到服务的配置和凭据的名称。 您可以 从Microsoft Azure Storage门户检索这些凭据.
  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 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请求正文中包含以下必需属性:

  • 配置名称:指定批次的唯一名称。 例如,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不返回任何有效负载。 您可以使用执行标识符检索批次的状态。

注意

在批处理运行时,请勿对相应的源文件夹和目标文件夹、数据源配置以及Microsoft Azure云配置进行任何更改。

检查批次的状态

要检索批次的状态,请使用 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的功能。

在此页面上