Show Menu
主题×

事务处理报告可开单API

AEM Forms提供了多个API,用于提交表单、处理文档和渲染文档。 某些API作为事务处理入账,而其他API则免费使用。 本文档提供了在事务报告中作为事务处理入账的所有API的列表。 以下是使用收费API的几个常见情况:
  • 提交自适应表单、HTML5表单和表单集
  • 渲染交互式通信的打印版或Web版
  • 将文档从一种格式转换为另一种格式
  • 拼合动态PDF文档
  • 生成记录文档
  • 将交互式PDF文档与另一PDF文档合并
  • 使用AEM工作流的分配任务步骤和文档服务步骤
  • 在自适应表单中使用自适应表单
付费API不考虑页数、文档或表单的长度或渲染文档的最终格式。 事务处理报表将事务处理分为两个类别:已渲染的文档和已提交的表单。
  • 提交的表单:当从使用AEM Forms创建的任何类型的表单提交数据并且数据提交到任何数据存储存储库或数据库被视为表单提交。 例如,提交自适应表单、HTML5表单、PDF表单和表单集将作为提交的表单入账。 表单集中的每个表单都被视为提交。 例如,如果表单集有5个表单,则提交表单集时,事务报告服务会将其计为5个提交。
  • 渲染的文档:通过组合模板和数据、对文档进行数字签名或认证、使用文档服务的可计费文档服务API或将文档从一种格式转换为另一种格式来生成文档,作为所呈现的文档入账。
事务处理报表UI显示三个类别:已提交的表单、已呈现的文档和已处理的文档。 渲染的文档和处理的文档均视为渲染的文档。

收费文档服务API

生成PDF服务

API
描述 事务处理报告类别 附加信息
createPDF 根据支持的文件类型创建Adobe PDF。 已处理的文档
createPDF2 根据支持的文件类型创建Adobe PDF。 已处理的文档
exportPDF 将Adobe PDF转换为支持的文件类型。 已处理的文档
exportPDF2 将Adobe PDF转换为支持的文件类型。 已处理的文档
exportPDF3 将Adobe PDF转换为支持的文件类型。 已处理的文档
htmlFileToPdf
从HTML页面创建PDF。
已处理的文档
htmlToPdf 从指向HTML页面的URL创建PDF。 已处理的文档
htmlToPdf2 从指向HTML页面的URL创建PDF。 已处理的文档
优化PDF 优化PDF,通过删除不必要的元数据来减小文件大小,而不会影响质量。 已处理的文档

Distiller Service

API
描述 事务处理报告类别 附加信息
createPDF 根据支持的文件类型创建Adobe PDF。 已处理的文档
createPDF2 根据支持的文件类型创建Adobe PDF。 已处理的文档

记录服务文档(DoR服务)

API
描述 事务处理报告类别 附加信息
渲染 调用指定的渲染方法以使用提供的参数生成记录文档。 已处理的文档

输出服务

API
描述 事务处理报告类别 附加信息
generatePDFOutput 合并数据和模板以创建PDF文档。 已处理的文档
generatePDFOutput 合并数据和模板以创建PDF文档。 已处理的文档
generatePDFOutputBatch 合并数据和模板以创建一组PDF文档。 已处理的文档 generatePDFOutputBatch API将表单模板与记录组合,并生成PDF。 在您处理一批记录时,事务处理报告服务会将每条记录计为单独的PDF再现。 您可以使用 BatchOptions.html#getGenerateManyFiles-- getGenerateManyFiles标志将多个再现合并为单个PDF文件。 无论标记状态如何,服务都将每个记录计为单独的PDF再现。
generatePrintedOutput 将XDP和PDF文档转换为PostScript(PS)、打印机命令语言(PCL)和ZPL文件格式。 已处理的文档
generatePrintedOutput 将XDP和PDF文档转换为PostScript(PS)、打印机命令语言(PCL)和ZPL文件格式。 已处理的文档
generatePrintedOutputBatch 将一组XDP和PDF文档转换为一组PostScript(PS)、打印机命令语言(PCL)和ZPL文件格式。 已处理的文档 generatePDFOutputBatch API将表单模板与记录组合,并生成PDF。 在您处理一批记录时,事务处理报告服务会将每条记录计为单独的PDF再现。 您可以使用 BatchOptions.html#getGenerateManyFiles-- getGenerateManyFiles标志将多个再现合并为单个PDF文件。 无论标记状态如何,服务都将每个记录计为单独的PDF再现。

表单服务

API
描述 事务处理报告类别 附加信息
renderPDFForm 从XDP模板渲染PDF表单。 XP模板是在Forms Designer中创建的。 已处理的文档
exportData 从PDF表单或XDP模板提取数据 已处理的文档

转换PDF服务

API
描述 事务处理报告类别 附加信息
toImage 将PDF文档转换为图像文档列表。 支持的图像格式为JPEG、JPEG2K、PNG和TIFF。 已处理的文档
toPS 使用选项规范中指定的选项将平面PDF文件转换为PostScript格式。 已处理的文档

Barcoded Forms Service

API
描述 事务处理报告类别 附加信息
解码 解码Document对象中的所有条码,并返回一个org.w3c.dom.Document对象,该对象包含从条形码检索到的数据。 已处理的文档

汇编器服务

API
描述 事务处理报告类别 附加信息
调用 执行指定的DDX文档并返回一个 AssemblerResult 对象,其中包含生成的文档。 已处理的文档 下列业务不会作为交易入账:
  • 创建包或包
  • 拼接多个XDP
调用 执行指定的DDX文档并返回一个 AssemblerResult 对象,其中包含生成的文档。 已处理的文档 PDF Generator、Forms和Output服务支持的所有输入文件格式,Assembler服务都支持这些格式作为输出文件格式。
toPDFA 使用指定的选项将指定文档转换为PDF/A。 已处理的文档
  • 汇编程序服务的调用API可以根据输入在内部调用另一服务的可计费API。 因此,调用API可以作为无、单个或多个事务处理进行处理。 计数的事务数取决于输入和调用的内部API。
  • 使用汇编程序服务生成的单个PDF文档可以作为无、单个或多个事务处理进行处理。 计数的事务数取决于提供的DDX代码。

PDF实用程序服务

API
描述 事务处理报告类别 附加信息
convertPDFtoXDP 将PDF文档转换为XDP文件。 要使PDF文档成功转换为XDP文件,PDF文档必须在AcroForm词典中包含XFA流。 已处理的文档

收费数据捕获API

自适应表单、HTML5表单和表单集的所有提交事件都作为事务处理入账。 默认情况下,提交PDF表单不作为事务处理入账。 使用提供的 事务记录器API ,将PDF表单提交记录为事务。

自适应表单

用例
描述 事务处理报告类别 附加信息
提交自适应表单 提交自适应表单以配置提交操作。 已提交的表单
  • 成功提交可完成一两个事务。 计数的事务处理数取决于用于提交的提交操作的类型。 例如,通过电子邮件提交操作帐户发送PDF可处理两个事务。 一个用于提交表单的事务,另一个用于使用记录文档(DOR)服务生成的PDF。
  • 在自适应表单(自适应表单表单集)中使用自适应表单只会计入单个事务。 您可以在自适应表单中拥有任意数量的自适应表单。

HTML5 表单

用例
描述 事务处理报告类别 附加信息
提交HTML5表单 提交HTML5表单以提交在表单中配置的URL。 已提交的表单

表单集

API
描述 事务处理报告类别 附加信息
提交表单集 将表单集提交到在表单集中配置的提交URL。 已提交的表单
  • 在自适应表单(自适应表单表单集)中使用自适应表单只会计入单个事务。 您可以在自适应表单中拥有任意数量的自适应表单。
  • HTML5表单中的每个表单都将帐户设置为单独的事务。

OSGi API上的收费交互式通信和以表单为中心的AEM工作流

在OSGi和交互式通信的所有演绎版上分配以表单为中心的AEM工作流的任务和文档服务步骤,并作为事务处理入账。 在创作实例上预览交互式通信和使用代理UI在发布实例上预览不会作为事务处理入账。 如果工作流步骤将事务处理计算在内,而工作流无法完成,则事务处理计数不会冲销。

交互通信 - Web 渠道

API
描述 事务处理报告类别 附加信息
渲染Web渠道 打开交互式通信的Web版本。 已渲染的文档

Interactive Communication - Print Channel

API
描述 事务处理报告类别 附加信息
渲染 (转换为PDF) 生成交互式通信的PDF版本。 已渲染的文档

OSGi上以表单为中心的AEM工作流

用例
事务处理报告类别 附加信息
提交分配任务步骤 已提交的表单
提交工作流应用程序起点 已提交的表单
将交互式通信(打印渠道)从代理UI提交到工作流 已渲染的文档

将收费API记录为自定义代码的事务处理

诸如提交PDF表单、使用代理UI预览交互式通信、使用非标准表单提交和自定义实现等操作不会作为事务处理入账。 AEM Forms提供了一个API来记录事务等操作。 您可以从自定义实现调用API以记 录事务