交易报告可记帐API transaction-reports-billable-apis

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

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

计费API不考虑页数、文档或表单的长度或渲染文档的最终格式。 事务报表将事务分为两类:已渲染的文档和Forms已提交。

  • Forms已提交: 如果从使用AEM Forms创建的任何类型的表单提交数据,并且将数据提交到任何数据存储存储库或数据库,则被视为表单提交。 例如,提交自适应表单、HTML5表单、PDF forms和表单集均被视为提交的表单。 表单集中的每个表单都被视为提交。 例如,如果一个表单集有5个表单,在提交该表单集时,transaction reporting服务将其计为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
从HTML页创建PDF。
已处理的文档
htmlToPdf
从指向HTML页面的URL创建PDF。
已处理的文档
htmlToPdf2
从指向HTML页面的URL创建PDF。
已处理的文档
optimizePDF
优化PDF以通过去除不必要的元数据而减小文件大小,同时不影响质量。
已处理的文档

DocAssurance服务 DocAssurance-Service

API
描述
交易报告类别
附加信息
secureDocument
此API使您能够保护文档。 您可以使用该API对PDF文档进行签名、认证、阅读器扩展或加密。
已处理的文档
只对secureDocument的签名和认证操作收费。

Distiller服务 distiller-service

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

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

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

输出服务 output-service

API
描述
交易报告类别
附加信息
generatePDFOutput
合并数据和模板以创建PDF文档。
已处理的文档
generatePDFOutput
合并数据和模板以创建PDF文档。
已处理的文档
generatePDFOutputBatch
合并数据和模板以创建一组PDF文档。
已处理的文档
generatePDFOutputBatch API将表单模板与记录组合在一起,并生成PDF。 当您处理一批记录时,交易报告服务会将每个记录计为单独的PDF演绎版。
您可以使用 getGenerateManyFile 用于将多个呈现组合为单个PDF文件的标记。 无论标志的状态如何,该服务都把每个记录计为单独的PDF演绎版。
generatePrintedOutput
将XDP和PDF文档转换为PostScript (PS)、Printer Command Language (PCL)和ZPL文件格式。
已处理的文档
generatePrintedOutput
将XDP和PDF文档转换为PostScript (PS)、Printer Command Language (PCL)和ZPL文件格式。
已处理的文档
generatePrintedOutputBatch
将一组XDP和PDF文档转换为一组PostScript (PS)、打印机命令语言(PCL)和ZPL文件格式。
已处理的文档
generatePDFOutputBatch API将表单模板与记录组合在一起,并生成PDF。 当您处理一批记录时,交易报告服务会将每个记录计为单独的PDF演绎版。
您可以使用 getGenerateManyFile 用于将多个呈现组合为单个PDF文件的标记。 无论标志的状态如何,该服务都把每个记录计为单独的PDF演绎版。

表单服务 forms-service

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

转换PDF服务 convert-pdf-service

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

条形码Forms服务 barcoded-forms-service

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

汇编程序服务 assembler-service

API
描述
交易报告类别
附加信息
调用
执行指定的DDX文档并返回 Assemblerresult 包含结果文档的对象。
已处理的文档

下列操作不作为交易入账:

  • 创建资源包或项目组合
  • 拼接多个XDP
调用
执行指定的DDX文档并返回 Assemblerresult 包含结果文档的对象。
已处理的文档
PDF Generator、Forms和输出服务支持的所有输入文件格式,汇编程序服务支持所有这些格式作为输出文件格式。
toPDFA
使用指定的选项将指定的文档转换为PDF/A。
已处理的文档

当您执行以下一个或多个操作时,调用API的使用情况计为事务:

  1. 从非PDF格式转换为PDF格式。 如XDP格式到PDF格式的转换,兼顾了交互和非交互两种形式的通信,以及从Word到PDF的转换。
  2. 从PDF格式转换为PDF/A格式。
  3. 从PDF格式转换为非PDF格式。 示例包括从PDF到图像的转换或从PDF到文本的转换。
NOTE
  • 汇编器服务的调用API可以在内部调用另一个服务的可计费API,具体取决于输入。 因此,调用API可以计为无、单个或多个事务。 计算的事务数取决于输入和调用的内部API。
  • 使用汇编程序服务生成的单个PDF文档可计为无、单个或多个事务。 计算事务数的数量取决于提供的DDX代码。

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

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

计费数据捕获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 Workflows的任务和文档服务步骤以及交互式通信的所有演绎版,并作为事务入账。 在创作实例上预览交互式通信和使用代理UI在发布实例上预览不会计为事务。 如果工作流步骤将事务处理入帐,但工作流未能完成,则不会冲销事务处理计数。

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

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

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

API
描述
交易报告类别
附加信息
渲染 (转换为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
19ffd973-7af2-44d0-84b5-d547b0dffee2