AEM Forms proporciona varias API para enviar formularios, procesar documentos y procesar documentos. Algunas API se contabilizan como transacciones y otras son libres de usar. Este documento proporciona una lista de todas las API que se contabilizan como transacciones en un informe de transacciones. Estos son algunos casos comunes en los que se utiliza una API facturable:
Las API de facturación no tienen en cuenta el número de páginas, la longitud de un documento o formulario o el formato final del documento procesado. Un informe de transacciones divide las transacciones en dos categorías: Documentos procesados y Forms enviado.
Forms Enviado: cuando se envían datos desde cualquier tipo de formulario creado con AEM Forms y los datos se envían a cualquier repositorio de almacenamiento de datos o base de datos, se considera envío de formulario. Por ejemplo, enviar un formulario adaptable, Formulario HTML5, PDF forms y conjunto de formularios se contabilizan como formularios enviados. Cada formulario de un conjunto de formularios se considera un envío. Por ejemplo, si un conjunto de formularios tiene 5 formularios, cuando se envía el conjunto de formularios, el servicio de sistema de informes de transacciones lo cuenta como 5 envíos.
Documentos procesados: la generación de un documento mediante la combinación de una plantilla y datos, la firma o certificación digital de un documento, el uso de una API de servicios de documento facturable para servicios de documento o la conversión de un documento de un formato a otro se contabilizan como documentos procesados.
La interfaz de usuario de Informes de transacciones muestra tres categorías: Envío de Forms, Documentos procesados y Documentos procesados. Los Documentos procesados y los Documentos procesados se contabilizan como Documentos procesados.
API |
Descripción | Categoría del informe de transacciones | Información adicional |
createPDF | Crea Adobe PDF a partir de tipos de archivo admitidos. | Documentos procesados | |
createPDF2 | Crea Adobe PDF a partir de tipos de archivo admitidos. | Documentos procesados | |
exportPDF | Convierte Adobe PDF en tipos de archivo admitidos. | Documentos procesados |
|
exportPDF2 | Convierte Adobe PDF en tipos de archivo admitidos. | Documentos procesados |
|
exportPDF3 | Convierte Adobe PDF en tipos de archivo admitidos. | Documentos procesados |
|
htmlFileToPdf | Crea archivos PDF a partir de páginas HTML. |
Documentos procesados |
|
htmlToPdf | Crea archivos PDF a partir de direcciones URL que apuntan a una página HTML. | Documentos procesados |
|
htmlToPdf2 | Crea archivos PDF a partir de direcciones URL que apuntan a una página HTML. | Documentos procesados |
|
optimizarPDF | Optimiza el PDF para reducir el tamaño del archivo eliminando metadatos innecesarios sin afectar a la calidad. | Documentos procesados |
API |
Descripción | Categoría del informe de transacciones | Información adicional |
createPDF |
Crea Adobe PDF a partir de tipos de archivo admitidos. | Documentos procesados | |
createPDF2 | Crea Adobe PDF a partir de tipos de archivo admitidos. | Documentos procesados |
API |
Descripción | Categoría del informe de transacciones | Información adicional |
procesar | Invoca el método de procesamiento especificado para generar un documento de registro utilizando los parámetros proporcionados. | Documentos procesados |
API |
Descripción | Categoría del informe de transacciones | Información adicional |
generatePDFOutput | Combina datos y plantillas para crear un documento PDF. | Documentos procesados | |
generatePDFOutput | Combina datos y plantillas para crear un documento PDF. | Documentos procesados | |
generatePDFOutputBatch | Combina datos y plantillas para crear un conjunto de documentos PDF. | Documentos procesados | La API generatePDFOutputBatch combina una plantilla de formulario con un registro y genera un PDF. Cuando se procesa un lote de registros, el servicio de sistema de informes de transacciones cuenta cada registro como una representación PDF independiente. Puede utilizar el indicador getGenerateManyFilespara combinar varias representaciones en un único archivo PDF. Independientemente del estado del indicador, el servicio cuenta cada registro como una representación PDF independiente. |
generatePrintedOutput | Convierte documentos XDP y PDF a formatos de archivo PostScript (PS), Printer Command Language (PCL) y ZPL. | Documentos procesados | |
generatePrintedOutput | Convierte documentos XDP y PDF a formatos de archivo PostScript (PS), Printer Command Language (PCL) y ZPL. | Documentos procesados | |
generatePrintedOutputBatch | Convierte un conjunto de documentos XDP y PDF en un conjunto de formatos de archivo PostScript (PS), Printer Command Language (PCL) y ZPL. | Documentos procesados | La API generatePDFOutputBatch combina una plantilla de formulario con un registro y genera un PDF. Cuando se procesa un lote de registros, el servicio de sistema de informes de transacciones cuenta cada registro como una representación PDF independiente. Puede utilizar el indicador getGenerateManyFilespara combinar varias representaciones en un único archivo PDF. Independientemente del estado del indicador, el servicio cuenta cada registro como una representación PDF independiente. |
API |
Descripción | Categoría del informe de transacciones | Información adicional |
procesarPDFForm | Procesa el formulario PDF a partir de plantillas XDP. Las plantillas XP se crean en Forms Designer. | Documentos procesados | |
exportData | Extrae datos de un formulario PDF o plantillas XDP | Documentos procesados |
API |
Descripción | Categoría del informe de transacciones | Información adicional |
toImage | Convierte un documento PDF en una lista de documentos de imagen. Los formatos de imagen admitidos son JPEG, JPEG2K, PNG y TIFF. | Documentos procesados | |
toPS | Convierte un archivo PDF plano al formato PostScript utilizando las opciones especificadas en la especificación de opciones. | Documentos procesados |
API |
Descripción | Categoría del informe de transacciones | Información adicional |
decode | Descodifica todos los códigos de barras de un objeto Documento y devuelve un objeto org.w3c.dom.Documento que contiene datos recuperados del código de barras. | Documentos procesados |
API |
Descripción | Categoría del informe de transacciones | Información adicional |
invoke | Ejecuta el documento DDX especificado y devuelve un objeto AssemblyResult que contiene los documentos resultantes. | Documentos procesados | Las siguientes operaciones no se contabilizan como transacciones:
|
invoke | Ejecuta el documento DDX especificado y devuelve un objeto AssemblyResult que contiene los documentos resultantes. | Documentos procesados | Todos los formatos de archivo de entrada que los servicios de generación de archivos PDF, Forms y Output admiten, el servicio Ensamblador admite todos esos formatos como formatos de archivo de salida. |
toPDFA | Convierta un documento especificado a PDF/A con las opciones especificadas. | Documentos procesados |
API |
Descripción | Categoría del informe de transacciones | Información adicional |
convertPDFtoXDP | Convierte un documento PDF en un archivo XDP. Para que un documento PDF se convierta correctamente en un archivo XDP, el documento PDF debe contener una secuencia XFA en el diccionario AcroForm. | Documentos procesados |
Todos los eventos de envío de formularios adaptables, HTML5 Forms y conjunto de formularios se contabilizan como transacciones. De forma predeterminada, el envío de un formulario PDF no se contabiliza como una transacción. Utilice la API de registro de transacciones proporcionada para registrar un envío de PDF forms como una transacción.
Caso práctico |
Descripción | Categoría del informe de transacciones | Información adicional |
Envío de un formulario adaptable | Envía un formulario adaptable a la acción de envío configurada. | Formularios enviados |
|
Caso práctico |
Descripción | Categoría del informe de transacciones | Información adicional |
Envío de un formulario HTML5 | Envía un formulario HTML5 para enviar la URL configurada en el formulario. | Formularios enviados |
API |
Descripción | Categoría del informe de transacciones | Información adicional |
Envío de un conjunto de formularios | Envía el conjunto de formularios a la URL de envío configurada en el conjunto de formularios. | Formularios enviados |
|
Asignar pasos de servicios de tarea y documento de Flujos de trabajo de AEM centrados en el formulario en OSGi y todas las representaciones de comunicación interactiva y se contabilizan como transacciones. La vista previa de una comunicación interactiva en la instancia de autor y la vista previa en la instancia de publicación mediante la interfaz de usuario del agente no se contabilizan como transacciones. Si un paso de workflow registra una transacción y el flujo de trabajo no se completa, el recuento de transacciones no se invierte.
API |
Descripción | Categoría del informe de transacciones | Información adicional |
Representación de un canal web | Abre la versión web de una comunicación interactiva. | Documentos procesados |
|
API |
Descripción | Categoría del informe de transacciones | Información adicional |
procesar (convertir a PDF) | Genera la versión PDF de una comunicación interactiva. | Documentos procesados |
|
Caso de uso |
Categoría del informe de transacciones | Información adicional |
Envío de un paso Asignar Tarea | Formularios enviados |
|
Envío de un punto de inicio de aplicación de flujo de trabajo | Formularios enviados | |
Envío de una comunicación interactiva (Canal de impresión) desde la interfaz de usuario del agente a un flujo de trabajo | Documentos procesados |
Las acciones como enviar un formulario PDF, utilizar la interfaz de usuario del agente para realizar la previsualización de una comunicación interactiva mediante el envío de formularios no estándar y las implementaciones personalizadas no se contabilizan como transacciones. AEM Forms proporciona una API para registrar acciones como transacciones. Puede llamar a la API desde sus implementaciones personalizadas para registrar una transacción.