API facturables de informes de transacciones transaction-reports-billable-apis

AEM Forms ofrece varias API para enviar formularios, procesar documentos y representar documentos. Algunas API se contabilizan como transacciones y otras se pueden usar libremente. Este documento proporciona una lista de todas las API que se contabilizan como transacciones en un informe de transacciones. Estos son algunos escenarios comunes en los que se utiliza un API facturable:

  • Enviar un formulario adaptable, un formulario HTML5 y un conjunto de formularios
  • Representar una versión impresa o web de una comunicación interactiva
  • Convertir un documento de un formato a otro
  • Acoplar un documento PDF dinámico
  • Generar un documento de registro
  • Combinar un documento PDF interactivo con otro documento PDF
  • Usar los pasos asignar tarea y servicios doc de flujos de trabajo de AEM
  • Usar 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 representado. Un informe de transacciones divide las transacciones en dos categorías: documentos representados y formularios enviados.

  • Formularios enviados: 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 contabiliza como 5 envíos.

  • Documentos representados: 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 una API de servicios de documentos facturables para servicios de documento o la conversión de un documento de un formato a otro se contabilizan como documentos representados.

NOTE
La interfaz de usuario Informes de transacciones muestra tres categorías: formularios enviados, documentos representados y documentos procesados. Tanto los documentos representados como los documentos procesados se contabilizan como documentos representados.

API de servicios de documentos facturables billable-document-services-apis

Generar un servicio PDF generate-pdf-service

API
Descripción
Categoría del informe de transacción
Información adicional
createPDF
Crea un Adobe PDF a partir de tipos de archivo compatibles.
Documentos procesados
createPDF2
Crea un Adobe PDF a partir de tipos de archivo compatibles.
Documentos procesados
exportPDF
Convierte un Adobe PDF en tipos de archivo compatibles.
Documentos procesados
exportPDF2
Convierte un Adobe PDF en tipos de archivo compatibles.
Documentos procesados
exportPDF3
Convierte un Adobe PDF en tipos de archivo compatibles.
Documentos procesados
htmlFileToPdf
Crea un PDF a partir de páginas HTML.
Documentos procesados
htmlToPdf
Crea un PDF a partir de direcciones URL que señalan una página HTML.
Documentos procesados
htmlToPdf2
Crea un PDF a partir de direcciones URL que señalan una página 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 DocAssurance DocAssurance-Service

API
Descripción
Categoría del informe de transacción
Información adicional
secureDocument
Esta API le permite proteger su documento. Puede utilizar la API para firmar, certificar, leer, extender o cifrar un documento de PDF.
Documentos procesados
Solo se factura la operación firmar y certificar del secureDocument.

Servicio Distiller distiller-service

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

Documento de servicio de registro (Servicio DoR) document-of-record-service-dor-service

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

Servicio de salida output-service

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 PDF.
Documentos procesados
El 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 el indicador 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 a un conjunto de formatos de archivo PostScript (PS), Printer Command Language (PCL) y ZPL.
Documentos procesados
El 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 el indicador 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 forms-service

API
Descripción
Categoría del informe de transacción
Información adicional
renderPDFForm
Representa 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

Servicio ConvertPDF convert-pdf-service

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 compatibles 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 barcoded-forms-service

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

Servicio Assembler assembler-service

API
Descripción
Categoría del informe de transacción
Información adicional
invoke
Ejecuta el documento DDX especificado y devuelve un objeto AssemblerResult que contiene los documentos resultantes.
Documentos procesados

Las siguientes operaciones no se contabilizan como transacciones:

  • Crear paquetes o portafolios
  • Configurar varios XDP
invoke
Ejecuta el documento DDX especificado y devuelve un objeto AssemblerResult que contiene los documentos resultantes.
Documentos procesados
Todos los formatos de archivo de entrada compatibles con Generador de PDF, Formularios y Servicios de salida; el servicio Ensamblador admite todos esos formatos como formatos de archivo de salida.
toPDFA
Convertir un documento especificado en PDF/A utilizando las opciones especificadas.
Documentos procesados

El uso de la API de invocación se cuenta como una transacción, cuando realiza una o más de las siguientes operaciones:

  1. Conversión de formatos que no son de PDF a formatos de PDF. Por ejemplo, la conversión de formato XDP a formato PDF, que ofrece formas de comunicación interactivas y no interactivas, y la conversión de Word a PDF.
  2. Conversión de formato PDF a formato PDF/A.
  3. Conversión de formato PDF a formatos no PDF. Algunos ejemplos son la transformación de PDF a formato de imagen o la conversión de PDF a formato de texto.
NOTE
  • El API de invocación del servicio de ensamblador puede llamar internamente a un API facturable de otro servicio en función de la entrada. Por lo tanto, la API de invocación puede contabilizarse como ninguna, única o múltiples transacciones. El número de transacciones contabilizadas depende de la entrada y las API internas invocadas.
  • Un documento PDF único producido mediante el servicio de ensamblador puede contabilizarse como ninguna, única o múltiples transacciones. El número de transacciones contabilizadas depende del código DDX proporcionado.

Servicio de utilidad de PDF pdf-utility-service

API
Descripción
Categoría del informe de transacción
Información adicional
convertPDFtoXDP
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 una secuencia XFA en el diccionario de AcroForm.
Documentos procesados

API de captura de datos facturables billable-data-capture-apis

Todos los eventos de envío de formularios adaptables, formularios HTML5 y conjuntos 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.

Formularios adaptables adaptive-forms

Caso práctico
Descripción
Categoría del informe de transacción
Información adicional
Enviar 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 mediante 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 documento de registro (DOR).
  • El uso del formulario adaptable en un formulario adaptable (conjunto de formularios de formulario adaptable) contabiliza solo una transacción. Puede tener cualquier número de formularios adaptables dentro de un formulario adaptable.

Formularios HTML5 html-forms

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

Conjunto de formularios form-set

API
Descripción
Categoría del informe de transacción
Información adicional
Enviar 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) contabiliza solo 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 Formularios 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 billable-interactive-communication-and-form-centric-aem-workflows-on-osgi-apis

Asignar 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 interactive-communication-web-channel

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

Comunicación interactiva - Canal de impresión interactive-communication-print-channel

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

Flujos de trabajo AEM centrados en formularios en OSGi form-centric-aem-workflows-on-osgi

Caso de uso
Categoría del informe de transacción
Información adicional
Enviar un paso Asignar tarea
Formularios enviados
Enviar un punto de inicio de aplicación de flujo de trabajo
Formularios enviados
Enviar una comunicación interactiva (canal de impresión) desde la interfaz de usuario del agente a un flujo de trabajo
Documentos representados

Registrar API facturables como transacciones para código personalizado recording-billable-apis-as-transactions-for-custom-code

Las acciones como enviar un formulario PDF, utilizar la interfaz de usuario del agente para obtener una vista previa de una comunicación interactiva, usar el envío de formulario no estándar y las implementaciones personalizadas no se contabilizan como transacciones. AEM Forms proporciona un API para registrar esas acciones como transacciones. Puede llamar al API desde sus implementaciones personalizadas para registrar una transacción.

Artículos relacionados related-articles

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2