プロセスレポートの概要

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

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

プロセスレポートの前提条件

不要なプロセスのパージ

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

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

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

メモ

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

プロセスレポートサービスの設定

プロセスデータの公開をスケジュール

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

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

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

デフォルトのスケジュールを変更するには、次の手順を実行します。

メモ

クラスターで AEM Forms を実装して実行している場合は、クラスターの各ノードで次の手順を実行します。

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

  2. ​

    • （Windows の場合）[JBoss root]/bin/run.conf.bat ファイルをエディターで開きます。
    • （Linux、AIX、Solaris の場合）[JBoss root]/bin/run.conf.sh ファイルをエディターで開きます。

  3. JVM 引数 -Dreporting.publisher.cron = <expression>. を追加します。

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

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

  4. run.conf.bat ファイルを保存して閉じます。

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

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

  7. WebSphere 管理コンソールにログインします。ナビゲーションツリーで​サーバー／アプリケーションサーバー​をクリックし、右側のウィンドウでサーバー名をクリックします。

  8. サーバーインフラストラクチャーで​Java およびプロセス管理／プロセス定義​をクリックします。

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

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

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

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

  10. 「適用」をクリックし、次に「マスター設定に直接保存」をクリックします。

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

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

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

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

  15. 「Domain Structure」で、Environment／Servers をクリックし、右側のウィンドウで、管理対象サーバー名をクリックします。

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

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

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

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

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

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

processdatapublisherservice

ProcessDataStorage サービス

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

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

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

プロセスレポートリポジトリの場所の設定

  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 サービスは、プロセスレポートのクエリサービスを設定するために、プロセスレポートで使用されます。

ReportingConfiguration サービスを設定するには：

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

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

  3. レコード数

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

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

    Default：1000

    CRX ストレージパス

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

    Default：/content/reporting/pm

    メモ

    これは、「ProcessDataStorage 構成」オプションで​ルートフォルダー​に指定した場所と同じです。

    ProcessDataStorage 設定の「ルートフォルダー」オプションを更新する場合は、ReportConfiguration サービスの CRX ストレージパスの場所を更新する必要があります。

  4. 「保存」をクリックして CQ 設定マネージャー​を閉じます。

ProcessDataPublisher サービス

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

ProcessDataPublisher サービスの設定

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

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

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

processdatapublisherservice-1

データを公開

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

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

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

Default：Off

バッチ間隔（秒）

ProcessDataPublisher サービスが実行されるたびに、このサービスはまず、最後のサービス実行からの時間をバッチ間隔で分割します。次にこのサービスは、AEM Forms データの各間隔を個別に処理します。

これは、サイクル内の各実行（バッチ）中に、パブリッシャーがエンドツーエンドで処理するデータのサイズを制御するのに役立ちます。

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

Default：3600

Unit：Seconds

ロックタイムアウト（秒）

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

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

Default：3600

Unit：Seconds

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

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

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

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

Default：01-01-1970 00:00:00

Format：dd-MM-yyyy HH:mm:ss

プロセスレポートユーザーインターフェイスへのアクセス

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

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

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

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

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

プロセスレポートモジュールにログインするための認証情報を指定します。

メモ

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

PERM_PROCESS_REPORTING_USER

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

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

プロセスレポートのホーム画面

process-reporting-home-screen

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • 同期：埋め込まれたプロセスレポートリポジトリを AEM Forms データベースと同期します。
  • ヘルプ：プロセスレポートに関するヘルプドキュメントを表示します。
  • ログアウト：プロセスレポートからログアウトします

このページ