Transaction Reports Billable APIs transaction-reports-billable-apis
AEM Forms provides several APIs to submit forms, process documents, and render documents. Some APIs are accounted as transactions and others are free to use. This document provides a list of all the APIs that are accounted as transactions in a transaction report. Here are a few common scenarios where a billable API is used:
- Submitting an adaptive form
- Converting a document from one format to another
- Flattening a dynamic PDF document
- Generating a Document of Record (using Forms Service or Output Service)
- Merging an interactive PDF document with another PDF document
- Using the assign task step and Communication API steps of AEM Workflows
Billing APIs does not account for the number of pages, the length of a document or form, or final format of the rendered document. A transaction report divides the transactions into two categories: Forms Submitted and Documents Rendered.
-
Forms Submitted: When data is submitted from any type of form created with AEM Forms and the data is submitted to any data storage repository or database is considered form submission. For example, submitting an adaptive form or a form set is considered as forms submitted. If a form set has 5 forms, and when the form set is submitted, transaction reporting service counts it as 5 submissions.
-
Documents Rendered: Generating a document by combining a template and data, digitally signing or certifying a document, using a billable document services APIs for document services, or converting a document from one format to another are accounted as documents rendered.
Billable Document Services APIs billable-document-services-apis
Generate PDF Service generate-pdf-service
Output Service output-service
DocAssurance Service DocAssurance-Service
Document of Record (DOR) Service document-of-record-dor-forms-service-and-output-service
Assembler Service assembler-service
The invoke API’s usage is counted as a transaction, when you perform one or more of the following operations:
- Conversion from non-PDF formats to PDF formats.
- Conversion from PDF format to PDF/A format.
- Conversion from PDF format to non-PDF formats. Examples encompass the transformation from PDF to Image format or the conversion from PDF to Text format.
- The invoke API of the assembler service can internally call a billable API of another service depending on the input. So, the invoke API can be accounted as none, single, or multiple transactions. The number of transactions counted depends upon the input and the internal APIs invoked.
- A single PDF document produced using assembler service can be accounted as none, single, or multiple transactions. The number of transactions counted depends upon the supplied code.
Billable Data Capture APIs billable-data-capture-apis
All the submission events of adaptive forms are accounted as transactions. By default, submission of a PDF Form is not accounted as a transaction. Use the provided transaction recorder API to record a PDF Forms submission as a transaction.
Adaptive Forms adaptive-forms
Billable Form-centric AEM Workflows billable--form-centric-aem-workflows
Assign task and document services steps of Form-centric AEM Workflows are accounted as transactions. If a workflow step accounts a transaction and the workflow fails to complete, the transaction count is not reversed.
Form-centric AEM Workflows form-centric-aem-workflows
Recording billable APIs as transactions for custom code recording-billable-apis-as-transactions-for-custom-code
Actions like submitting a PDF Form, using Agent UI to preview an interactive communication, using non-standard form submission, and custom implementations are not accounted as transactions. AEM Forms provides an API to record such actions as transactions. You can call the API from your custom implementations to record a transaction.