プロセスレポートの概要 getting-started-with-process-reporting

プロセスレポートを使用すると、AEM Forms のユーザーは、AEM Forms 実装で現在定義されている AEM Forms プロセスに関する情報を照会できます。ただし、プロセスレポートは、AEM Forms のリポジトリのデータに直接アクセスしません。まず、スケジュールに従ってプロセスレポートのリポジトリにデータが公開されます(ProcessDataPublisher サービスおよび ProcessDataStorage サービスによって ​行われます)。次に、リポジトリに公開されたプロセスレポートのデータから、プロセスレポートのレポートとクエリが生成されます。プロセスレポートは、Forms Workflow モジュールの一部としてインストールされています。

この記事では、プロセスレポートのリポジトリへの AEM Forms データの公開を有効にする手順を説明します。その後、プロセスレポートを使用して、レポートとクエリを実行できるようになります。この記事では、プロセスレポートサービスの設定に使用できるオプションについても説明します。

プロセスレポートの前提条件 process-reporting-pre-requisites

不要なプロセスのパージ purge-non-essential-processes

現在 Forms Workflow を使用している場合、AEM Forms データベースには大量のデータが含まれている可能性があります。

プロセスレポート公開サービスでは、データベースで現在使用可能なすべての AEM Forms データが公開されます。つまり、レポートやクエリの実行対象でないレガシーデータがデータベースに含まれている場合、レポートに必要ないそのようなデータもすべてリポジトリに公開されます。そのようなデータは、プロセスレポートリポジトリにデータを公開するサービスを実行する前に、パージすることをお勧めします。これにより、公開サービスも、レポート用データのクエリサービスもパフォーマンスが向上します。

AEM Forms プロセスデータのパージについて詳しくは、プロセスデータのパージを参照してください。

NOTE
パージユーティリティのヒントとテクニックについては、Adobe Developer Connection の「プロセスとジョブのパージ」に関する記事を参照してください。

プロセスレポートサービスの設定 configuring-process-reporting-services

プロセスデータの公開をスケジュール schedule-process-data-publishing

プロセスレポートサービスは、AEM Forms データベースから Process Reporting リポジトリに、スケジュールに従ってデータを公開します。

この操作はリソースを大量に消費する可能性があり、AEM Forms サーバーのパフォーマンスに影響を与える可能性があります。プロセスデータの公開は、AEM Forms サーバーが混んでいない時間帯にスケジュールすることをお勧めします。

デフォルトでは、データの公開は毎日午前 2 時に実行されるようにスケジュールされています。

公開スケジュールを変更するには、次の手順を実行します。

NOTE
クラスターで AEM Forms を実装して実行している場合は、クラスターの各ノードで次の手順を実行します。
  1. AEM Forms サーバーインスタンスを停止します。

    • (Windows の場合)[JBoss root]/bin/run.conf.bat ファイルをエディターで開きます。
    • (Linux®、AIX®、Solaris™ の場合)[JBoss root]/bin/run.conf.sh ファイルをエディターで開きます。
  2. JVM 引数 -Dreporting.publisher.cron = <expression>. を追加します。

    例:次の Cron 式を使用すると、プロセスレポートは 5 時間ごとに AEM Forms データをプロセスレポートリポジトリに公開します。

    • -Dreporting.publisher.cron = 0_0_0/5_*_*_?
  3. run.conf.bat ファイルを保存して閉じます。

  4. AEM Forms サーバーインスタンスを再起動します。

  5. AEM Forms サーバーインスタンスを停止します。

  6. WebSphere® Administrative Console にログインします。 ナビゲーションツリーで、 サーバー > アプリケーションサーバー 次に、右側のウィンドウで、サーバ名をクリックします。

  7. 「サーバーインフラストラクチャー」で、Java™ とプロセス管理プロセス定義 ​をクリックします。

  8. 「その他のプロパティ」で「Java™ 仮想マシン」をクリックします。

    「汎用 JVM 引数」ボックスで引数 -Dreporting.publisher.cron = <expression>. を追加します。

    :次の Cron 式を使用すると、プロセスレポートは 5 時間ごとに AEM Forms データをプロセスレポートリポジトリに公開します。

    • -Dreporting.publisher.cron = 0_0_0/5_*_*_?
  9. 適用」をクリックし、次に「マスター構成に直接保存」をクリックします。

  10. AEM Forms サーバーインスタンスを再起動します。

  11. AEM Forms サーバーインスタンスを停止します。

  12. WebLogic 管理コンソールにログインします。WebLogic 管理コンソールのデフォルトのアドレスは、https://[hostname]:[port]/console です。

  13. Change Center で、「Lock & Edit」をクリックします。

  14. ドメイン構造で​ 環境サーバー ​をクリックし、右側のウィンドウで管理対象サーバーの名前をクリックします。

  15. 次の画面で、「設定 ​タブ」、「サーバー起動」タブをクリックします。

  16. 「引数」ボックスに、JVM 引数 -Dreporting.publisher.cron = <expression> を追加します。

    :次の Cron 式を使用すると、プロセスレポートは時間ごとに AEM Forms データをプロセスレポートリポジトリに公開します。

    -Dreporting.publisher.cron = 0_0_0/5_*_*_?

  17. 保存」をクリックし、「変更をアクティベート」をクリックします。

  18. AEM Forms サーバーインスタンスを再起動します。

processdatapublisherservice

NOTE
「Ctrl + C」コマンドを使用して SDK を再起動することをお勧めします。 別の方法(Java プロセスの停止など)を使用してAEM SDK を再起動すると、AEM開発環境で不整合が生じる場合があります。

ProcessDataStorage サービス processdatastorage-service

ProcessDataStorageProvider サービスは、ProcessDataPublisher サービスからプロセスデータを受け取り、そのデータを Process Reporting リポジトリに保存します。

公開サイクルごとに、事前に定義されたルートフォルダーのサブフォルダーにデータが保存されます。

管理コンソールを使用すると、プロセスデータが格納される、ルート(デフォルト/content/reporting/pm)の場所とサブフォルダー(デフォルト/yyyy/mm/dd/hh/mi/ss)の階層形式を設定できます。

プロセスレポートリポジトリの場所の設定 to-configure-the-process-reporting-repository-locations

  1. 管理者の資格情報で​ 管理コンソール ​にログインします。管理コンソールのデフォルト URL は https://'[server]:[port]'/adminuiです。

  2. ホームサービスアプリケーションとサービスサービス管理 ​に移動して ProcessDataStorageProvider サービスを開きます。

    process-data-storage-service

    RootFolder

    レポート用にプロセスデータが格納される CRX の場所。

    Default/content/reporting/pm

    フォルダー階層

    プロセス作成時間に基づいて、プロセスデータが格納されるフォルダー階層。

    Default/yyyy/mm/dd/hh/mi/ss

  3. 保存」をクリックします。

ReportConfiguration サービス reportconfiguration-service

ReportConfiguration サービスは、プロセスレポートのクエリサービスを設定するために、プロセスレポートで使用されます。

ReportingConfiguration サービスを設定するには: to-configure-the-reportingconfiguration-service

  1. CRX 管理者の資格情報で​ 設定マネージャー ​にログインします。設定マネージャーのデフォルトの URL は https://'[server]:[port]'/lc/system/console/configMgr です。

  2. ReportingConfiguration サービスを開きます。

  3. レコード数

    リポジトリでクエリを実行すると、結果に多数のレコードが含まれている可能性があります。結果セットが大きい場合、クエリの実行によってサーバーリソースが消費される可能性があります。

    大きな結果セットを処理するために、ReportConfiguration サービスはクエリ処理を複数のレコードに分割します。これにより、システムの負荷が軽減されます。

    Default1000

    CRX ストレージパス

    レポート用にプロセスデータを格納する CRX の場所。

    Default/content/reporting/pm

    note note
    NOTE
    これは、ProcessDataStorage 設定で「ルートフォルダー」オプションに指定した場所と同じです。
    ProcessDataStorage 設定の「ルートフォルダー」オプションを更新する場合は、ReportConfiguration サービスの CRX ストレージパスの場所を更新する必要があります。
  4. 保存」をクリックして CQ 設定マネージャー ​を閉じます。

ProcessDataPublisher サービス processdatapublisher-service

ProcessDataPublisher サービスは、AEM Forms データベースからプロセスデータをインポートし、格納のためにそのデータを ProcessDataStorageProvider サービスに公開します。

ProcessDataPublisher サービスの設定 to-configure-processdatapublisher-service-nbsp

  1. 管理者の資格情報で​ 管理コンソール ​にログインします。

    デフォルトの URL は https://'server':port]/adminui/ です。

  2. ホームサービスアプリケーションとサービスサービス管理 ​に移動して ProcessDataPublisher サービスを開きます。

processdatapublisherservice-1

データを公開

プロセスデータの公開を開始するには、このオプションを有効にします。デフォルトでは、このオプションは無効になっています。

プロセスレポートコンポーネントに関連するすべての構成が適切に設定されている場合にのみ、プロセスレポートを有効にします。

または、不要になったプロセスデータの公開を無効にするために、このオプションを使用します。

DefaultOff

バッチ間隔(秒)

ProcessDataPublisher サービスが実行されるたびに、このサービスはまず、最後のサービス実行からの時間をバッチ間隔で分割します。次に、サービスは AEM Forms データの各間隔を個別に処理して、パブリッシャーがサイクル内の各実行(バッチ)中にエンドツーエンドで処理するデータのサイズを制御できるようにします。

例えばパブリッシャーを毎日実行する場合、1 回の実行で 1 日分のデータをすべて処理する代わりに、デフォルトで、それぞれ 1 時間の 24 個のバッチに分割して処理します。

Default3600

UnitSeconds

ロックタイムアウト(秒)

パブリッシャーサービスは、データの処理を開始する際にロックを取得するので、パブリッシャーの複数のインスタンスが実行を開始したり、データを同時に処理したりすることはありません。

ロックを取得したパブリッシャーサービスが、ロックタイムアウト値で定義された秒数の間アイドル状態になった場合は、そのロックが解除され、他のパブリッシャーサービスインスタンスが処理を続行できるようになります。

Default3600

UnitSeconds

次の時間からデータを公開

AEM Forms 環境には、環境が設定された時点からのデータが含まれています。

デフォルトでは、ProcessDataPublisher サービスは AEM Forms データベースからすべてのデータを読み込みます。

レポートのニーズに応じて、特定の日時以降にデータに対してレポートやクエリを実行する予定がある場合は、日時を指定することをお勧めします。その後、公開サービスは、その日時以降に日付を公開します。

Default01-01-1970 00:00:00

Formatdd-MM-yyyy HH:mm:ss

プロセスレポートユーザーインターフェイスへのアクセス accessing-the-process-reporting-user-interface

プロセスレポートのユーザーインターフェイスは、ブラウザーベースです。

プロセスレポートを設定したら、AEM Forms のインストール先の次の場所で、プロセスレポートの使用を開始できます。

https://<server>:<port>/lc/pr

プロセスレポートへのログイン log-in-to-process-reporting

プロセスレポートの URL(https://<server>:<port>/lc/pr)に移動すると、ログイン画面が表示されます。

プロセスレポートモジュールにログオンするには、資格情報を指定します。

NOTE
プロセスレポートユーザーインターフェイスにログインするには、次の AEM Forms 権限が必要です。
PERM_PROCESS_REPORTING_USER

プロセスレポートへのログイン

プロセスレポートにログインすると、ホーム ​画面が表示されます。

プロセスレポートのホーム画面 process-reporting-home-screen

process-reporting-home-screen

プロセスレポートのツリー表示: ​ホーム画面の左側にあるツリー表示には、プロセスレポートモジュールの項目が表示されます。

ツリー表示は、次の最上位項目で構成されます。

レポート: ​この項目には、プロセスレポートに付属する、そのままで使用できるレポートが含まれています。

事前定義済みレポートについて詳しくは、プロセスレポートの事前定義済みレポートを参照してください。

アドホッククエリ: ​この項目には、プロセスとタスクをフィルターベースで検索するオプションが含まれています。

アドホッククエリについて詳しくは、プロセスレポートのアドホッククエリを参照してください。

カスタム: ​カスタムノードには、作成したカスタムレポートが表示されます。

カスタムレポートの作成と表示の手順については、プロセスレポートのカスタムレポートを参照してください。

プロセスレポートのタイトルバー: ​プロセスレポートのタイトルバーには、ユーザーインターフェイスで作業する際に使用できる一般的なオプションがいくつか含まれています。

プロセスレポートのタイトル: ​プロセスレポートのタイトルは、タイトルバーの左隅に表示されます。

タイトルをクリックすれば、いつでもホーム画面に戻ることができます。

最終更新時間: ​プロセスデータは、AEM Forms データベースからプロセスレポートリポジトリに、スケジュールに従って公開されます。

最終更新時間には、データの更新がプロセスレポートリポジトリにプッシュされた最終日時が表示されます。

データ公開サービスおよびこのサービスのスケジュール方法について詳しくは、「プロセスレポートの概要」のプロセスデータの公開をスケジュールを参照してください。

プロセスレポートのユーザー: ​ログインしたユーザーの名前が、最終更新時間の右側に表示されます。

プロセスレポートのタイトルバーのドロップダウンリスト: ​プロセスレポートのタイトルバーの右隅にあるドロップダウンリストには、次のオプションが含まれます。

  • 同期:埋め込まれたプロセスレポートリポジトリを AEM Forms データベースと同期します。
  • ヘルプ:プロセスレポートに関するヘルプドキュメントを表示します。
  • ログアウト:プロセスレポートからログアウトします
recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2