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

Versión
Vínculo del artículo
AEM 6.5
Haga clic aquí
AEM as a Cloud Service
Este artículo

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
  • Convertir un documento de un formato a otro
  • Acoplar un documento PDF dinámico
  • Generar un documento de registro (mediante el servicio de Forms o el servicio de salida)
  • Combinar un documento PDF interactivo con otro PDF
  • Uso del paso para asignar tarea y de los pasos de API de comunicación de los flujos de trabajo de AEM

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: formularios enviados y documentos representados.

  • 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, enviar un formulario adaptable o un conjunto de formularios se considera un formulario enviado. Por ejemplo, si un conjunto de formularios tiene cinco formularios, cuando se envía el conjunto de formularios, el servicio de informes de transacciones lo contabiliza como cinco envíos.

  • Documentos representados: generar un documento mediante la combinación de una plantilla y datos, la firma o certificación digitalmente de un documento, el uso de las 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.

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
Generar un documento PDF a partir de una plantilla y combinar los datos con ella;
Documentos procesados
exportPDF
Convierte un archivo XDP o un documento PDF en tipos de archivo compatibles.
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 (PDFOutputOptions)
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
generatePrintedOutput
Convierte los documentos XDP y PDF a los formatos de archivo PostScript (PS), Printer Command Language (PCL) y ZPL.
Documentos procesados
generatePrintedOutput (PrintedOutputOptions)
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

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 PDF.
Documentos procesados
Solo se factura la operación firmar y certificar de secureDocument.

Servicio de documento de registro (DOR) document-of-record-dor-forms-service-and-output-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 mediante el servicio Forms

Servicio Assembler assembler-service

API
Descripción
Categoría del informe de transacción
Información adicional
invoke
Ejecuta el DDX en los documentos de entrada dados y devuelve un objeto que contiene los documentos de resultado
Documentos procesados

Las siguientes operaciones no se contabilizan como transacciones:

  • Crear paquetes o portafolios
  • Configurar varios XDP
invoke
Ejecuta el DDX en los documentos de entrada dados y devuelve un objeto que contiene los documentos de resultado
Documentos procesados
Todos los formatos de archivo de entrada compatibles con Generador de PDF, Formularios y Servicios de salida; el servicio Assembler 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 PDF a formatos 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 Assembler 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 Assembler puede contabilizarse como ninguna, única o múltiples transacciones. El número de transacciones contabilizadas depende del código proporcionado.

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

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

Flujos de trabajo de AEM centrados en formularios facturables billable--form-centric-aem-workflows

Los pasos de asignación de tareas y servicios de documentos de los flujos de trabajo de AEM centrados en formularios 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.

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

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

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.

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab