Ativação e visualização de relatórios de transações para o AEM Forms no JEE transaction-reports-overview
O recurso de Relatório de Transações foi introduzido para o AEM Forms no JEE pela AEM Forms 6.5.20.0. Este recurso está desabilitado por padrão e pode ser habilitado na Interface do Usuário do Administrador.
Os relatórios de transações no AEM Forms no JEE permitem que você mantenha uma contagem de todas as transações realizadas na implantação do AEM Forms. O objetivo é fornecer informações sobre o uso do produto e ajudar as partes interessadas a entender seus volumes de processamento digital. Exemplos de uma transação incluem:
- Apresentação de um documento
- Representação de um documento
- Conversão de um documento de um formato de arquivo para outro
Para obter mais informações sobre o que é considerado uma transação, consulte APIs faturáveis.
Habilitar relatório de transações enable-transaction-reporting
Por padrão, a gravação da transação está desativada. Para ativar a emissão de relatórios de transação, execute as seguintes etapas:
-
Navegue até o
/adminuino seu AEM Forms no JEE, por exemplo,http://10.14.18.10:8080/adminui. -
Fazer logon como Administrador.
-
Vá para Configurações > Configurações Principais do Sistema > Configurações.
-
Clique na caixa de seleção para Habilitar relatórios de transações e Salvar as configurações.
-
Reinicie o servidor.
-
Além das alterações no servidor, no lado do cliente, você deve atualizar o arquivo
adobe-livecycle-client.jarno seu projeto, se estiver usando o mesmo.
Exibição do relatório de transações view-transaction-report
Ao habilitar o relatório de transações, as informações sobre as contagens de transações ficam acessíveis por meio do relatório de transações por meio do painel e de um relatório de transações detalhado por meio do arquivo de log. Ambos são explicados abaixo:
Relatório de transações via painel transaction-report-dashboard
O relatório de transações via painel fornece o número total de contagens de transações para cada tipo de transação. Por exemplo, você obtém as informações sobre o número total de formulários renderizados, convertidos e enviados conforme mostrado na imagem. Para obter o relatório de transações:
- Navegue até o
/adminuino seu AEM Forms no JEE, por exemplo:http://10.13.15.08:8080/adminui. - Fazer logon como Administrador.
- Clique em Monitor de integridade.
- Navegue até a guia Repórter de Transações, clique em Calcular Total de Transações. Agora você verá que um gráfico de pizza representa o número de PDF forms - enviadas, renderizadas ou convertidas.
Relatório de transações via arquivo de log transaction-report-logfile
O relatório de transações via arquivo de registro fornece informações detalhadas sobre cada transação. Para acessar os logs de transação, siga o caminho do contexto relativo à inicialização do servidor. As transações são capturadas em um arquivo de log separado transaction_log.log por padrão. O caminho do arquivo é relativo ao contexto de início do servidor. O caminho padrão para servidores diferentes é fornecido abaixo:
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"
Exemplo de um registro de transação de amostra:[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 da transação transaction-record-structure-jee
A estrutura do log de transações define como cada transação é registrada por meio de seus vários parâmetros, como serviço, operação, tipo de transação e outros. Cada uma é apresentada em detalhes abaixo. A estrutura do registro de transação é a seguinte:
TransactionRecord
{
service='...',
operation='...',
internalService='...',
internalOperation='...',
transactionOperationType='...',
transactionCount=...,
elapsedTime=...,
transactionDate=...
}
- serviço: nome do serviço.
- operação: nome da operação.
- internalService: nome do receptor da chamada se houver uma chamada interna, caso contrário, igual ao nome do serviço.
- internalOperation: nome do chamado em que há uma chamada interna, caso contrário, igual ao nome da operação.
- transactionOperationType: tipo de transação (Enviar, Renderizar, Converter).
- transactionCount: Contagem total de transações.
- elapsedTime: tempo entre a iniciação da chamada e a resposta recebida.
- transactionDate: carimbo de data/hora indicando quando o serviço foi chamado.
Log de transações de exemplo:
[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
}
Frequência de gravação da transação transaction-recording-frequency
A frequência de transações de registro é determinada pelas operações de atualização no servidor para cada formulário enviado, renderizado ou convertido com sucesso.
-
No painel, a contagem de transações é atualizada periodicamente. O padrão é definido como 1 minuto. Você pode atualizar a frequência definindo a propriedade do sistema como
"com.adobe.idp.dsc.transaction.recordFrequency". Por exemplo, no AEM Forms para JEE em JBoss®, adicione-Dcom.adobe.idp.dsc.transaction.recordFrequency=5emJAVA_OPTSpara definir a frequência de atualização para 5 minutos. -
Em logs de transações, a atualização para cada transação ocorre instantaneamente quando um formulário é enviado, renderizado ou convertido com êxito.