Transaction reporting Billable APIs for AEM Forms on JEE
Last update: June 24, 2024
- Topics:
- Transaction Reports
CREATED FOR:
- Admin
- User
- Developer
AEM Forms on JEE provide several APIs to submit, process, 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. Here are a few common scenarios where a billable API is used:
- Converting a document from one format to another
- Flattening a dynamic PDF document
- Merging an interactive PDF document with another PDF document
Billing APIs does not account for the number of pages, the length of a document or form, or final format of the rendered document.
Below is the list of JEE billable APIs. Find the list of billable APIs for AEM Forms on OSGi.
Billable Document Services APIs
Generate PDF Service
| API | Description | Transaction report category |
| CreatePDF | Creates Adobe PDF to supported file types. | Conversion |
| CreatePDF3 | Creates Adobe PDF to supported file types. | Conversion |
| HtmlToPDF | Converts HTML file to Adobe PDF. | Conversion |
| ExportPDF | Exports PDF to supported file types. | Conversion |
| ExportPDF2 | Exports PDF to supported file types. | Conversion |
| ExportPDF3 | Exports PDF to supported file types. | Conversion |
| HtmlFileToPDF | Converts HTML file to PDF. | Conversion |
| HtmlToPDF2 | Converts HTML file to PDF. | Conversion |
| OptimizePDF | Optimizes PDF to reduce file size by stripping unnecessary metadata without affecting the quality. | Conversion |
DocAssurance Service
| API | Description | Transaction report category |
| Sign/Certify | This API enables you to secure your document. You can use the API to sign and certify a PDF document. | Conversion |
Distiller Service
| API | Description | Transaction report category |
| CreatePDF | Creates Adobe PDF from supported file types. | Conversion |
| CreatePDF2 | Creates Adobe PDF from supported file types. | Conversion |
Output Service
| API | Description | Transaction report category |
| generateOutput | Merges data and templates to create a PDF document. | Documents Rendered |
| generatePDFOutput | Merges data and templates to create a PDF document. | Documents Rendered |
| generatePDFOutput2 | Merges data and templates to create a PDF document. | Documents Rendered |
| generatePrintedOutput | Converts XDP and PDF documents to PostScript (PS), Printer Command Language (PCL), and ZPL file formats. | Documents Rendered |
| generatePrintedOutput2 | Converts XDP and PDF documents to PostScript (PS), Printer Command Language (PCL), and ZPL file formats. | Documents Rendered |
| transformPDF | Converts a set of XDP and PDF documents to a set of PostScript (PS), Printer Command Language (PCL), and ZPL file formats. | Documents Conversion |
Convert PDF Service
| API | Description | Transaction report category |
| toImage2 | Converts a PDF document to a list of image documents. Supported image formats are JPEG, JPEG2K, PNG, and TIFF. | Documents Conversion |
| toPS2 | Converts a Flat PDF file to PostScript format using the options specified in the option spec. | Documents Conversion |
| toSWF | Converts a Flat PDF file to SWF format using the options specified in the option spec. | Documents Conversion |
Barcoded Forms Service
| API | Description | Transaction report category |
| decode | Decodes all the barcodes in a Document object and returns an org.w3c.dom.Document object that contains data that was retrieved from the barcode. | Documents Conversion |
Assembler Service
| API | Description | Transaction report category |
| invoke | Executes the specified DDX document and returns an AssemblerResult object containing the resultant documents. | Documents Conversion |
| invokeDDX | Executes the specified DDX document and returns an AssemblerResult object containing the resultant documents. | Documents Conversion |
| invokeOneDocument | Convert a specified document to PDF/A using the options specified. | Documents Conversion |
| invokeDDXOneDocument | Convert a specified document to PDF/A using the options specified. | Documents Conversion |
| toPDFA | Convert a specified document to PDF/A using the options specified. | Documents Conversion |
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. For instance, the conversion from XDP format to PDF format.
- 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.
NOTE- The invoke API of the assembler service can internally call a billable API of another service depending on the input. So, the
invoke APIcan 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 such as
invokeandinvokeDDX, can be accounted as none, single, or multiple transactions. The number of transactions counted depends upon the supplied code.
Billable Data Capture APIs
Forms
API
Description
Transaction report category
exportData
Submits form.
Forms Submitted
exportData2
Submits form.
Forms Submitted
renderForm
Submits form.
Forms Rendered
renderHTMLForm
Submits form.
Forms Rendered
renderHTMLForm2
Submits form.
Forms Rendered
renderPDFForm
Submits form.
Forms Rendered
renderPDFForm2
Submits form.
Forms Rendered
renderPDFFormWithUsageRights
Submits form.
Forms Rendered
Related Articles
recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2