JEE 上の AEM Forms のトランザクションレポートの有効化と表示 transaction-reports-overview
トランザクションレポートを有効にする enable-transaction-reporting
デフォルトでは、トランザクションの記録は無効になっています。トランザクションレポートを有効にするには、次の手順を実行します。
-
JEE における AEM Forms で
/adminui(例:http://10.14.18.10:8080/adminui)に移動します。 -
管理者 としてログインします。
-
設定/コアシステム設定/設定 に移動します。
-
「トランザクションレポートを有効にする」チェックボックスをクリックし、設定を 保存 します。
-
サーバーを再起動します。
-
サーバー上での変更の他に、クライアント側でも、プロジェクトの
adobe-livecycle-client.jarファイルを更新する必要があります(同じファイルを使用する場合)。
トランザクションレポートを表示する view-transaction-report
トランザクションレポートを有効にすると、ダッシュボードを使用したトランザクションレポートとログファイルを使用した詳細なトランザクションレポートから、トランザクション数に関する情報にアクセスできるようになります。この両方について以下で説明します。
ダッシュボードを使用したトランザクションレポート transaction-report-dashboard
ダッシュボードを使用したトランザクションレポートでは、トランザクションタイプごとにトランザクションの合計数が表示されます。例えば、画像に示すように、レンダリングされたフォーム、変換されたフォームおよび送信されたフォームの合計数に関する情報が得られます。トランザクションレポートを取得するには:
- JEE における AEM Forms で
/adminui(例:http://10.13.15.08:8080/adminui)に移動します。 - 管理者 としてログインします。
- ヘルスモニターをクリックします。
- 「トランザクションレポート」タブに移動し、「トランザクションの合計数を計算」をクリックします。これで、送信された PDF フォーム、レンダリングされた PDF フォーム、変換された PDF フォームの数が円グラフで表されていることがわかります。
ログファイルを使用したトランザクションレポート transaction-report-logfile
ログファイルを使用したトランザクションレポートには、各トランザクションに関する詳細な情報が表示されます。トランザクションログにアクセスするには、サーバー起動を基準とした相対コンテキストパスに従います。トランザクションは、デフォルトでは別個のログファイル transaction_log.log に取得されます。ファイルパス は、サーバー起動コンテキストを基準とした相対パスです。各種サーバーのデフォルトパスを以下に示します。
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"
サンプルトランザクションレコードの例:[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}
トランザクションレコード transaction-record-structure-jee
トランザクションログ構造では、サービス、操作、トランザクションタイプなどの様々なパラメーターを使用して、各トランザクションの記録方法を定義します。それぞれの詳細について、以下で説明します。トランザクションレポートの構造は次のとおりです。
TransactionRecord
{
service='...',
operation='...',
internalService='...',
internalOperation='...',
transactionOperationType='...',
transactionCount=...,
elapsedTime=...,
transactionDate=...
}
- service:サービスの名前。
- operation:操作名。
- internalService:内部呼び出しがある場合は呼び出し先の名前。それ以外の場合はサービス名と同じ。
- internalOperation:内部呼び出しがある場合は呼び出し先の名前。それ以外の場合は操作名と同じ。
- transactionOperationType:トランザクションのタイプ(送信、レンダリング、変換)。
- transactionCount:トランザクションの合計数。
- elapsedTime:呼び出しの開始から応答の受信までの時間。
- transactionDate:サービスがいつ呼び出されたかを示すタイムスタンプ。
サンプルトランザクションログ:
[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
}
トランザクションの記録頻度 transaction-recording-frequency
トランザクションの記録頻度は、正常に送信、レンダリング、変換されたフォームごとに、サーバー上の更新操作によって決まります。
-
ダッシュボード では、トランザクション数は定期的に更新されます。デフォルトは 1 分に設定されています。頻度を更新するには、
"com.adobe.idp.dsc.transaction.recordFrequency"でシステムプロパティを設定します。例えば、JBoss® における JEE 向け AEM Forms では、JAVA_OPTSに-Dcom.adobe.idp.dsc.transaction.recordFrequency=5を追加して、更新頻度を 5 分に設定します。 -
トランザクションログ では、フォームを正常に送信、レンダリング、または変換すると、各トランザクションの更新が即時に行われます。