Activación y visualización de informes de transacciones para AEM Forms en JEE transaction-reports-overview

: la capacidad Informes de transacciones se ha introducido para AEM Forms en JEE desde AEM Forms 6.5.20.0. Esta característica está deshabilitada de manera predeterminada y se puede habilitar desde la interfaz de usuario de administración.

Los informes de transacciones de AEM Forms en JEE permiten mantener un recuento de todas las transacciones realizadas en la implementación de AEM Forms. El objetivo es proporcionar información sobre el uso del producto y ayudar a las partes interesadas empresariales a comprender sus volúmenes de procesamiento digital. Algunos ejemplos de transacciones son:

  • Presentación de un documento
  • Representación de un documento
  • Conversión de un documento de un formato de archivo a otro

Para obtener más información sobre lo que se considera una transacción, consulte API facturables.

Habilitar informes de transacciones enable-transaction-reporting

De forma predeterminada, el registro de transacciones está desactivado. Para habilitar los informes de transacciones, realice los siguientes pasos:

  1. Vaya a /adminui en su AEM Forms en JEE, por ejemplo, http://10.14.18.10:8080/adminui.

  2. Inicie sesión como administrador.

  3. Vaya a Configuración > Configuración del sistema principal > Configuraciones.

  4. Haga clic en la casilla de verificación para habilitar los informes de transacciones y guardar la configuración.

    sample-transaction-report-jee

  5. Reinicie el servidor.

  6. Aparte de los cambios en el servidor, en el lado del cliente debe actualizar el archivo adobe-livecycle-client.jar en su proyecto, si está utilizando el mismo.

Ver informe de transacciones view-transaction-report

Cuando habilita los informes de transacciones, se puede obtener acceso a la información sobre los recuentos de transacciones a través del informe de transacciones a través del panel y de un informe de transacciones detallado a través del archivo de registro. Ambos se explican a continuación:

Informe de transacciones mediante tablero transaction-report-dashboard

El informe de transacciones a través del panel proporciona el número total de transacciones contabilizadas para cada tipo de transacción. Por ejemplo, se obtiene la información sobre el número total de formularios procesados, convertidos y enviados como se muestra en la imagen. Para obtener el informe de transacciones:

  1. Vaya a /adminui en su AEM Forms en JEE, por ejemplo: http://10.13.15.08:8080/adminui.
  2. Inicie sesión como administrador.
  3. Haga clic en Monitor de estado.
  4. Vaya a la ficha Informador de transacciones, haga clic en Calcular transacciones totales y verá que un gráfico circular representa el número de PDF forms enviados, procesados o convertidos.

sample-transaction-report-jee

Informe de transacciones mediante archivo de registro transaction-report-logfile

El informe de transacciones mediante el archivo de registro proporciona información detallada sobre cada transacción. Para acceder a los registros de transacciones, siga la ruta de contexto relativa al inicio del servidor. De forma predeterminada, las transacciones se capturan en un archivo de registro independiente transaction_log.log. La ruta de archivo es relativa al contexto de inicio del servidor. A continuación se indica la ruta predeterminada para diferentes servidores:

For Jboss Turnkey:
"<AEM_Forms_Installation>/jboss/bin/transaction_log.log"

For IBM Websphere:
"<IBM_WAS_Profile_path>/transaction_log.log"

For Oracle Weblogic:
"<Weblogic_Domain_path>/transaction_log.log"

For Jboss Cluster:
"<Jboss home>/transaction_log.log"

Ejemplo de registro de transacción de ejemplo:
[2024-02-28 06:11:27] [INFO] TransactionRecord{service='GeneratePDFService', operation='HtmlFileToPDF', internalService='GeneratePDFService', internalOperation='HtmlFileToPDF', transactionOperationType='CONVERT', transactionCount=1, elapsedTime=1906, transactionDate=Wed Feb 28 06:11:25 UTC 2024}

Registro de transacciones transaction-record-structure-jee

La estructura del registro de transacciones define cómo se registra cada transacción a través de sus distintos parámetros, como servicio, operación, tipo de transacción y otros. Cada uno se detalla a continuación. La estructura del registro de transacciones es la siguiente:

TransactionRecord
{
    service='...',
    operation='...',
    internalService='...',
    internalOperation='...',
    transactionOperationType='...',
    transactionCount=...,
    elapsedTime=...,
    transactionDate=...
}
  • servicio: nombre del servicio.
  • operación: nombre de operación.
  • internalService: Nombre del destinatario de la llamada si hay una llamada interna; de lo contrario, es igual que el nombre del servicio.
  • internalOperation: El nombre del destinatario de la llamada allí es una llamada interna; de lo contrario, será el mismo que el nombre de la operación.
  • transactionOperationType: tipo de transacción (enviar, procesar, convertir).
  • transactionCount: Recuento total de transacciones.
  • elapsedTime: tiempo entre el inicio de la llamada y la respuesta recibida.
  • transactionDate: marca de tiempo que indica cuándo se invocó el servicio.

Registro de transacciones de ejemplo:

[2024-02-14 14:23:25] [INFO] TransactionRecord
{
    service='BarcodedFormsService',
    operation='decode',
    internalService='BarcodedFormsService',
    internalOperation='decode',
    transactionOperationType='CONVERT',
    transactionCount=1,
    elapsedTime=47405,
    transactionDate=Wed Feb 14 14:22:37 UTC 2024
}

Frecuencia de registro de transacciones transaction-recording-frequency

La frecuencia de registro de transacciones está determinada por las operaciones de actualización en el servidor para cada formulario que se envía, procesa o convierte correctamente.

  • En panel, el recuento de transacciones se actualiza periódicamente; el valor predeterminado es 1 minuto. Puede actualizar la frecuencia estableciendo la propiedad del sistema en "com.adobe.idp.dsc.transaction.recordFrequency". Por ejemplo, en AEM Forms para JEE en JBoss®, agregue -Dcom.adobe.idp.dsc.transaction.recordFrequency=5 en JAVA_OPTS para establecer la frecuencia de actualización en 5 minutos.

  • En registros de transacciones, la actualización de cada transacción se produce instantáneamente cuando un formulario se envía, procesa o convierte correctamente.

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