交易报表计费API transaction-reports-billable-apis

CAUTION
AEM 6.4已结束扩展支持,本文档将不再更新。 有关更多详细信息,请参阅 技术支助期. 查找支持的版本 此处.

作为交易入账的所有API的列表

AEM Forms提供了多个API来提交表单、处理文档和渲染文档。 某些API作为交易入账,而其他API则可免费使用。 本文档提供了作为交易报表中的交易入账的所有API的列表。 以下是使用可计费API的一些常见情况:

  • 提交自适应表单、HTML5表单和表单集
  • 呈现交互式通信的打印版或Web版
  • 将文档从一种格式转换为另一种格式
  • 拼合动态PDF文档
  • 生成记录文档
  • 将交互式PDF文档与其他PDF文档合并
  • 使用AEM Workflow的分配任务步骤和文档服务步骤
  • 在自适应表单中使用自适应表单

帐单API不考虑页数、文档或表单的长度或渲染文档的最终格式。 事务报表将事务分为三类:已处理的文档、已呈现的文档和Forms已提交的文档。

  • Forms已提交: 从使用AEM Forms创建的任何类型的表单提交数据,并将数据提交到任何数据存储库或数据库时,都会将数据视为表单提交。 例如,提交自适应表单、HTML5表单、PDF forms和表单集将作为提交的表单入账。 表单集中的每个表单都被视为提交。 例如,如果表单集有5个表单,则提交表单集后,交易报告服务会将其计为5次提交。
  • 呈现的文档: 通过组合模板和数据、对文档进行数字签名或认证、使用用于文档服务的可计费文档服务API或将文档从一种格式转换为另一种格式来生成文档,都作为所呈现的文档入账。
NOTE
交易报表UI显示三个类别:Forms已提交、已提交的文档和已处理的文档。 已呈现的文档和已处理的文档均作为已呈现的文档入账。

计费文档服务API billable-document-services-apis

生成PDF服务 generate-pdf-service

API
描述
交易记录报表类别
附加信息
createPDF
从支持的文件类型创建Adobe PDF 。
已处理的文档
createPDF2
从支持的文件类型创建Adobe PDF 。
已处理的文档
exportPDF
将Adobe PDF转换为支持的文件类型。
已处理的文档
exportPDF2
将Adobe PDF转换为支持的文件类型。
已处理的文档
exportPDF3
将Adobe PDF转换为支持的文件类型。
已处理的文档
htmlFileToPdf
从PDF页面创建HTML。
已处理的文档
htmlToPdf
从指向PDF页面的URL创建HTML。
已处理的文档
htmlToPdf2
从指向PDF页面的URL创建HTML。
已处理的文档
optimizePDF
优化PDF以减小文件大小,方法是在不影响质量的情况下删除不必要的元数据。
已处理的文档

Distiller服务 distiller-service

API
描述
交易记录报表类别
附加信息
createPDF
从支持的文件类型创建Adobe PDF 。
已处理的文档
createPDF2
从支持的文件类型创建Adobe PDF 。
已处理的文档

记录服务文档(DoR服务) document-of-record-service-dor-service

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

输出服务 output-service

API
描述
交易记录报表类别
附加信息
generatePDFOutput
合并数据和模板以创建PDF文档。
已处理的文档
generatePDFOutputBatch
合并数据和模板以创建一组PDF文档。
已处理的文档
generatePrintedOutput
将XDP和PDF文档转换为PostScript(PS)、打印机命令语言(PCL)和ZPL文件格式。
已处理的文档
generatePrintedOutput
将XDP和PDF文档转换为PostScript(PS)、打印机命令语言(PCL)和ZPL文件格式。
已处理的文档
generatePrintedOutputBatch
将一组XDP和PDF文档转换为一组PostScript(PS)、打印机命令语言(PCL)和ZPL文件格式。
已处理的文档

表单服务 forms-service

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

转换PDF服务 convert-pdf-service

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

条形码Forms服务 barcoded-forms-service

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

汇编程序服务 assembler-service

API
描述
交易记录报表类别
附加信息
调用
执行指定的DDX文档并返回 汇编程序结果 包含生成文档的对象。
已处理的文档

下列业务不会入账为交易:

  • 创建资源包或项目组合
  • 拼合多个XDP
调用
执行指定的DDX文档并返回 汇编程序结果 包含生成文档的对象。
已处理的文档
PDF生成器、Forms和输出服务支持的所有输入文件格式,汇编程序服务支持所有这些格式作为输出文件格式。
toPDFA
使用指定的选项将指定的文档转换为PDF/A。
已处理的文档
NOTE
  • 汇编程序服务的调用API可以根据输入在内部调用另一个服务的计费API。 因此,调用API可以计为无、单个或多个事务。 计数的事务数取决于输入和调用的内部API。
  • 使用汇编程序服务生成的单个PDF文档可以计为无、单个或多个事务。 计数的交易数取决于提供的DDX代码。

PDF实用程序服务 pdf-utility-service

API
描述
交易记录报表类别
附加信息
convertPDFtoXDP
将PDF文档转换为XDP文件。 为了将PDF文档成功转换为XDP文件,PDF文档必须在AcroForm词典中包含XFA流。
已处理的文档

文档保障服务 doc-assurance-service

API
描述
交易记录报表类别
附加信息
secureDocument
利用API,可保护文档安全。 您可以使用API对PDF文档进行签名、认证、读取器扩展或加密。
已处理的文档
仅对 secureDocument 开单。

计费数据捕获API billable-data-capture-apis

自适应表单、HTML5 Forms和表单集的所有提交事件均作为交易记录入账。 默认情况下,提交PDF表单不会计为交易。 使用提供的 交易报表API 将PDF forms提交记录为交易。

自适应表单 adaptive-forms

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

HTML5 表单 html-forms

用例
描述
交易记录报表类别
附加信息
提交HTML5表单
提交HTML5表单以提交在表单中配置的URL。
已提交的表单

表单集 form-set

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

OSGi API上的计费交互式通信和以表单为中心的AEM工作流 billable-interactive-communication-and-form-centric-aem-workflows-on-osgi-apis

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

交互通信 - Web 渠道 interactive-communication-web-channel

API
描述
交易记录报表类别
附加信息
呈现Web渠道
打开交互式通信的Web版本。
已渲染的文档

交互式通信 — 打印渠道 interactive-communication-print-channel

API
描述
交易记录报表类别
附加信息
render (转换为PDF)
生成交互式通信的PDF版本。
已渲染的文档

OSGi上以表单为中心的AEM工作流 form-centric-aem-workflows-on-osgi

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

将计费API记录为自定义代码的交易记录 recording-billable-apis-as-transactions-for-custom-code

诸如提交PDF表单、使用代理UI预览交互式通信、使用非标准表单提交和自定义实施等操作不会计为交易。 AEM Forms提供了一个API来记录此类操作(如交易)。 您可以从自定义实施中将API调用到 记录交易.

相关文章 related-articles

recommendation-more-help
a6ebf046-2b8b-4543-bd46-42a0d77792da