トランザクションレポートの表示と理解

トランザクションレポートでは、送信されたフォーム、処理されたドキュメント、レンダリングされたドキュメントの数を追跡できます。これらのトランザクションを追跡する目的は、プロダクトの使用状況について十分な情報を基に判断を行い、ハードウェアとソフトウェアに対する投資の割合を調整することにあります。 詳しくは、 AEM Formsトランザクションレポートの概要を参照してください。

トランザクションレポートの設定

トランザクションレポートの機能は、AEM forms アドオンパッケージの一部として利用できます。すべてのオーサーインスタンスとパブリッシュインスタンスにアドオンパッケージをインストールする方法の詳細は、AEM Forms のインストールと設定を参照してください。AEM Forms アドオンパッケージをインストールしたら、以下の手順を実行します。

  • すべてのパブリッシュインスタンスでリバースレプリケーションを有効にする
  • トランザクションレポートを有効にする
  • トランザクションレポートを表示する権限を付与する
  • （オプション）トランザクションフラッシュ期間とアウトボックスを設定する 🔗
メモ
  • AEM Formsトランザクションレポートは、パブリッシュインスタンスのみを含むトポロジをサポートしていません。
  • トランザクションレポートを使用する前に、すべてのパブリッシュインスタンスでリバースレプリケーションが有効になっているか確認します。
  • トランザクションデータは、パブリッシュインスタンスから、対応するオーサーインスタンスまたは処理インスタンスにのみリバースレプリケーションされます。 オーサーインスタンスまたは処理インスタンスは、別のインスタンスにデータを複製できません。

すべてのパブリッシュインスタンスでリバースレプリケーションを有効にする

トランザクションレポートでは、リバースレプリケーションを使用して、パブリッシュインスタンスのトランザクション数をオーサーインスタンスに統合します。 すべてのパブリッシュインスタンスでリバースレプリケーションを設定してください。リバースレプリケーションを設定する手順の詳細については、複製を参照してください。

トランザクションレポートを有効にする

トランザクションレポートは、デフォルトで無効になっています。 AEM Web コンソールからレポートを有効にできます。 AEM Forms 環境でトランザクションレポートを有効にするには、すべてのオーサーインスタンスとパブリッシュインスタンスで次の手順を実行します。

  1. AEM インスタンスに管理者としてログインします。「ツール」>「操作」>「Web コンソール」にアクセスします。

  2. Forms トランザクションレポート​サービスを探して開きます。

  3. 「取引を記録」チェックボックスを選択します。「保存」をクリックします。

    手順 1 から 3 を、すべてのオーサーインスタンスとパブリッシュインスタンスで繰り返します。

トランザクションレポートを表示する権限を付与する

トランザクションレポートを表示できるのは、fd-administrator グループのメンバーだけです。 ユーザーがトランザクションレポートを表示できるようにするには、ユーザーを fd-administrator グループのユーザーに指定します。 ユーザーを AEM グループのメンバーに指定する手順については、ユーザー、グループ、アクセス権の管理を参照してください。

（オプション）トランザクションフラッシュ期間とアウトボックスの設定

トランザクションは、リポジトリに保存される前にメモリにキャッシュされます。 この処理を実行することで、リポジトリへの書き込みが頻繁に行われないようにします。 デフォルトでは、キャッシュ期間（トランザクションフラッシュ期間）は 60 秒に設定されています。 デフォルトの期間は、環境に合わせて変更できます。 デフォルトのキャッシュ間隔を変更するには、以下の手順を実行します。

  1. オーサーインスタンスに管理者としてログインします。「ツール」>「操作」>「Web コンソール」にアクセスします。
  2. Forms Transaction Repository Storage Provider サービスを探して開きます。
  3. 秒数を「トランザクションフラッシュ期間」フィールドに入力します。 「保存」をクリックします。

リバースレプリケーションを行うと、トランザクションデータがオーサーインスタンスのデフォルトのアウトボックスにコピーされます。 トランザクションデータは、カスタムアウトボックスに配置できます。 次の手順を実行して、カスタムアウトボックスを指定します。

  1. オーサーインスタンスに管理者としてログインします。ツール ／運営／web コンソール​に移動します。
  2. Forms トランザクションリポジトリストレージプロバイダー​サービスを見つけて開きます。
  3. カスタムアウトボックスの名前を​アウトボックス​フィールドに指定します。 「保存」をクリックします。指定した名前のアウトボックスがすべてのオーサーインスタンス上に作成されます。

トランザクションレポートの表示

オーサーインスタンスまたはパブリッシュインスタンスのトランザクションレポートを表示できます。 オーサーインスタンスのトランザクションレポートは、設定されたオーサーインスタンスとパブリッシュインスタンスで発生するすべてのトランザクションの集計合計を提供します。 パブリッシュインスタンスのトランザクションレポートは、基になるパブリッシュインスタンスでのみ発生するトランザクションの数を提供します。 レポートを表示するには、次の手順を実行します。

  1. AEM Forms サーバーに https://[hostname]:'port' でログインします。
  2. ツール／Forms／トランザクションレポートの表示​に移動します。

レポートについて

AEM Forms には、次の要約レポートに示すように、設定した日付以降のトランザクションレポートが表示されます。

sample-transaction-report-author

  • 「日付を今日にリセット」オプションを使用して、トランザクションレコードをリセットします。日付を今日にリセットすると、以前のトランザクションレコードはすべて失われます。 オーサーインスタンスで日付をリセットした場合、この変更はパブリッシュインスタンスのトランザクションレポートには影響しません（逆も同様です）。
  • パブリッシュインスタンスのトランザクションのみを表示​を使用して、設定済みのパブリッシュインスタンスまたはパブリッシュファームでのみ発生したすべてのトランザクションを表示します。
  • 処理済みのドキュメント、レンダリングされたドキュメント、送信済みのフォーム​のカテゴリを使用して、対応するトランザクションを表示します。 これらのカテゴリで説明されるトランザクションのタイプについては、請求可能なトランザクションレポート API を参照してください。

トランザクションレポートログの表示

トランザクションレポートでは、レポートに表示されるすべての情報と一部の追加情報がログに記録されます。 ログに表示される情報は、上級ユーザーにとって役立ちます。 例えば、ログはレポートに表示される 3 つの統合カテゴリと比較して、トランザクションを複数の詳細なカテゴリに分割します。 ログは、/crx-repository/logs/ ディレクトリの error.log ファイルで利用できます。 ログは、AEM web コンソールからトランザクションレポートを有効にしない場合でも使用できます。

このページ