API facturables de informes de transacciones

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:

  • Envío de un formulario adaptable, un formulario HTML5 y un conjunto de formularios
  • Representación de una versión impresa o web de una comunicación interactiva
  • Conversión de un documento de un formato a otro
  • Acoplamiento de un documento de PDF dinámico
  • Generación de un documento de registro
  • Combinación de un documento de PDF interactivo con otro documento de PDF
  • Uso de los pasos asignar tarea y servicios doc de AEM Flujos de trabajo
  • Uso de formularios adaptables en un formulario adaptable

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 los datos se envían 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, el envío de un formulario adaptable, un formulario HTML5, PDF forms y un 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 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 digitalmente de un documento, el uso de API de servicios de documentos facturables para document services o la conversión de un documento de un formato a otro se contabilizan como documentos procesados.

NOTA

La interfaz de usuario de Informes de transacciones muestra tres categorías: Forms enviado, documentos procesados y documentos procesados. Tanto los documentos procesados como los documentos procesados se contabilizan como documentos procesados.

API de servicios de documentos facturables

Generación del servicio PDF

API

 Descripción Categoría del informe de transacción Información adicional
createPDF Crea Adobe PDF a partir de tipos de archivo compatibles. Documentos procesados
createPDF2 Crea Adobe PDF a partir de tipos de archivo compatibles. Documentos procesados
exportPDF Convierte Adobe PDF en tipos de archivo compatibles. Documentos procesados
exportPDF2 Convierte Adobe PDF en tipos de archivo compatibles. Documentos procesados
exportPDF3 Convierte Adobe PDF en tipos de archivo compatibles. Documentos procesados
htmlFileToPdf

Crea un PDF a partir de páginas de HTML.

 Documentos procesados
htmlToPdf Crea un PDF a partir de direcciones URL que apuntan a una página de HTML. Documentos procesados
htmlToPdf2 Crea un PDF a partir de direcciones URL que apuntan a una página de HTML. Documentos procesados
optimizePDF Optimiza al PDF para reducir el tamaño del archivo eliminando metadatos innecesarios sin afectar a la calidad. Documentos procesados

Servicio de Distiller

API

 Descripción Categoría del informe de transacción Información adicional
createPDF
 Crea Adobe PDF a partir de tipos de archivo compatibles. Documentos procesados
createPDF2 Crea Adobe PDF a partir de tipos de archivo compatibles. Documentos procesados

Documento de Servicio de Registro (Servicio DoR)

API

 Descripción Categoría del informe de transacción Información adicional
procesar Invoca el método de procesamiento especificado para generar un documento de registro utilizando los parámetros proporcionados. Documentos procesados

Servicio de salida

API

 Descripción Categoría del informe de transacción Información adicional
generatePDFOutput Combina datos y plantillas para crear un documento de PDF. Documentos procesados
generatePDFOutput Combina datos y plantillas para crear un documento de PDF. Documentos procesados
generatePDFOutputBatch Combina datos y plantillas para crear un conjunto de documentos de PDF. Documentos procesados La API generatePDFOutputBatch combina una plantilla de formulario con un registro y genera un PDF. Al procesar un lote de registros, el servicio de informes de transacciones contabiliza cada registro como una representación de PDF independiente.
Puede usar la variable getGenerateManyFiles para combinar varias representaciones en un solo archivo PDF. Independientemente del estado del indicador, el servicio cuenta cada registro como una representación de PDF independiente.
generatePrintedOutput Convierte los documentos XDP y PDF a los formatos de archivo PostScript (PS), Printer Command Language (PCL) y ZPL. Documentos procesados
generatePrintedOutput Convierte los documentos XDP y PDF a los 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. Al procesar un lote de registros, el servicio de informes de transacciones contabiliza cada registro como una representación de PDF independiente.
Puede usar la variable getGenerateManyFiles para combinar varias representaciones en un solo archivo PDF. Independientemente del estado del indicador, el servicio cuenta cada registro como una representación de PDF independiente.

Servicio de Forms

API

 Descripción Categoría del informe de transacción Información adicional
renderPDFForm 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 de plantillas XDP Documentos procesados

Convertir servicio PDF

API

 Descripción Categoría del informe de transacción 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 de PDF plano al formato PostScript mediante las opciones especificadas en la especificación de opciones. Documentos procesados

Servicio de Forms con códigos de barras

API

 Descripción Categoría del informe de transacción Información adicional
decode Descodifica todos los códigos de barras de un objeto Document y devuelve un objeto org.w3c.dom.Document que contiene datos recuperados del código de barras. Documentos procesados

Servicio del ensamblador

API

 Descripción Categoría del informe de transacción Información adicional
invoke Ejecuta el documento DDX especificado y devuelve un Resultado del ensamblador que contiene los documentos resultantes. Documentos procesados Las siguientes operaciones no se contabilizan como transacciones:
  • Creación de paquetes o portafolio
  • Configuración de varios XDP
invoke Ejecuta el documento DDX especificado y devuelve un Resultado del ensamblador que contiene los documentos resultantes. Documentos procesados Todos los formatos de archivo de entrada compatibles con PDF Generator, Forms y los servicios de salida, el servicio Assembler admite todos esos formatos como formatos de archivo de salida.
toPDFA Convierta un documento especificado en PDF/A utilizando las opciones especificadas. Documentos procesados
NOTA
  • La API de invocación del servicio de ensamblador puede llamar internamente a una API facturable de otro servicio en función de la entrada. Por lo tanto, la API de invocación puede contabilizarse como transacciones únicas, únicas o múltiples. El número de transacciones contabilizadas depende de la entrada y las API internas invocadas.
  • Un documento de PDF único producido mediante el servicio de ensamblador puede contabilizarse como transacciones únicas, únicas o múltiples. El número de transacciones contadas depende del código DDX proporcionado.

Servicio de PDF

API

 Descripción Categoría del informe de transacción Información adicional
convertirPDFtoXDP Convierte un documento PDF en un archivo XDP. Para que un documento de PDF se convierta correctamente en un archivo XDP, el documento de PDF debe contener un flujo XFA en el diccionario AcroForm. Documentos procesados

API de captura de datos facturables

Todos los sucesos de envío de formularios adaptables, HTML5 Forms y conjuntos de formularios se contabilizan como transacciones. De forma predeterminada, el envío de un formulario de PDF no se contabiliza como una transacción. Utilice el API de registro de transacciones para registrar un envío de PDF forms como una transacción.

Formularios adaptables

Caso práctico

 Descripción Categoría del informe de transacción Información adicional
Envío de un formulario adaptable Envía un formulario adaptable a la acción de envío configurada. Formularios enviados
  • Cuenta de envíos correcta para una o dos transacciones. El número de transacciones contabilizadas depende del tipo de acción de envío utilizada para el envío. Por ejemplo, enviar al PDF a través de cuentas de acción de envío por correo electrónico para dos recuentos de transacciones. Una transacción para el envío de formularios y otra para el PDF generado mediante el servicio Document of Record (DOR).
  • El uso del formulario adaptable en un formulario adaptable (conjunto de formularios de formulario adaptable) cuenta solo de una transacción. Puede tener cualquier número de formularios adaptables dentro de un formulario adaptable.

Formularios HTML5

Caso práctico

 Descripción Categoría del informe de transacción Información adicional
Envío de un formulario de HTML5 Envía un formulario de HTML5 para enviar la dirección URL configurada en el formulario. Formularios enviados

Conjunto de formularios

API

 Descripción Categoría del informe de transacción Información adicional
Envío de un conjunto de formularios Envía el conjunto de formularios a la dirección URL de envío configurada en el conjunto de formularios. Formularios enviados
  • El uso del formulario adaptable en un formulario adaptable (conjunto de formularios de formulario adaptable) cuenta solo de una transacción. Puede tener cualquier número de formularios adaptables dentro de un formulario adaptable.
  • Todos los formularios de un conjunto de formularios de Forms de HTML5 se contabilizan como una transacción independiente.

Flujos de trabajo de comunicación interactiva facturables y AEM centrados en formularios en las API de OSGi

Asigne pasos de tareas y servicios de documentos de Flujos de trabajo AEM centrados en formularios 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 flujo de trabajo cuenta una transacción y el flujo de trabajo no se completa, el recuento de transacciones no se invierte.

Comunicación interactiva - Canal web

API

 Descripción Categoría del informe de transacción Información adicional
Representación de un canal web Abre la versión web de una comunicación interactiva. Documentos procesados

Comunicación interactiva: canal de impresión

API

 Descripción Categoría del informe de transacción Información adicional
render (convertir en PDF) Genera la versión PDF de una comunicación interactiva. Documentos procesados

Flujos de trabajo AEM centrados en formularios en OSGi

Caso de uso

 Categoría del informe de transacción 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

Registro de API facturables como transacciones para código personalizado

Las acciones como enviar un formulario de PDF, utilizar la interfaz de usuario del agente para obtener una vista previa de una comunicación interactiva, utilizar el envío de formulario 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 a registrar una transacción.

En esta página