Forms サービスパフォーマンスの最適化

最終更新日： 2024年7月15日
  • 適用対象：
  • Experience Manager 6.5
  • トピック：

作成対象：

  • 開発者

このドキュメントのサンプルと例は、JEE 環境の AEM Forms のみを対象としています。

Forms サービスパフォーマンスの最適化

フォームをレンダリングする際に、Forms サービスのパフォーマンスを最適化する実行時のオプションを設定できます。Forms サービスのパフォーマンスを向上させるために実行できるもう 1 つのタスクは、XDP ファイルをリポジトリに格納することです。ただし、この節では、このタスクの実行方法については説明しません。（Java クライアントライブラリを使用したサービスの呼び出しを参照。）

メモ
AEM Forms サービスについて詳しくは、『AEM Forms サービスリファレンス』を参照してください。

手順の概要

フォームのレンダリング中に Forms サービスのパフォーマンスを最適化するには、次のタスクを実行します。

  1. プロジェクトファイルを含めます。
  2. Forms Client API オブジェクトを作成します。
  3. パフォーマンスの実行時オプションを設定します。
  4. フォームをレンダリングします。
  5. フォームデータストリームをクライアントの Web ブラウザーに書き込みます。

プロジェクトファイルの組み込み

必要なファイルを開発プロジェクトに含めます。Java を使用してクライアントアプリケーションを作成する場合は、必要な JAR ファイルを含めます。Web サービスを使用している場合は、プロキシファイルを必ず含めてください。

Forms Client API オブジェクトの作成

Forms Service Client API 操作をプログラムで実行する前に、Forms サービスクライアントを作成する必要があります。Java API を使用している場合は、FormsServiceClient オブジェクトを作成します。Forms Web サービス API を使用している場合は、 FormsService オブジェクトを作成します。

パフォーマンスの実行時オプションを設定する

次のパフォーマンス実行時オプションを設定して、Forms サービスのパフォーマンスを向上させることができます。

  • フォームのキャッシュ：サーバーキャッシュ内で PDF としてレンダリングされるフォームをキャッシュできます。各フォームは、初回生成後にキャッシュされます。それ以降のレンダリング時には、キャッシュされたフォームがフォームデザインのタイムスタンプよりも新しい場合、フォームはキャッシュから取得されます。フォームをキャッシュすると、リポジトリからフォームデザインを取得する必要がなくなるので、Forms サービスのパフォーマンスが向上します。
  • フォームガイド（非推奨）は、他の変換タイプよりもレンダリングに時間がかかる場合があります。パフォーマンスを向上させるために、フォームガイド（非推奨）をキャッシュすることをお勧めします。
  • スタンドアロンオプション：Forms サービスでサーバーサイドの計算を実行する必要がない場合は、「スタンドアロン」オプションを true に設定すると、フォームは状態情報なしでレンダリングされます。状態情報は、インタラクティブフォームをエンドユーザーにレンダリングし、そのユーザーがフォームに情報を入力して、そのフォームをFormsサービスに送り返す場合に必要です。次に、Forms サービスは計算処理を実行し、フォームをレンダリングしてユーザーに戻し、結果がフォームに表示されます。フォームが状態情報なしで Forms サービスに送り返された場合、XML データのみが使用可能になり、サーバーサイドの計算は実行されません。
  • 線形化された PDF：線形化された PDF ドキュメントは、ネットワーク環境で効果的に増分アクセスできるよう整理されています。PDF ファイルは、あらゆる点で有効な PDF で、既存のすべてのビューアやその他の PDF アプリケーションと互換性があります。つまり、線形化された PDF は、ダウンロード中に表示できます。
  • このオプションを選択しても、クライアントで PDF フォームがレンダリングされる際のパフォーマンスは向上しません。
  • GuideRSL オプション：実行時の共有ライブラリを使用して、フォームガイド（非推奨）の生成を有効にします。つまり、最初のリクエストでは、小さい SWF ファイルと、ブラウザーのキャッシュに保存されている大きい共有ライブラリがダウンロードされます。詳しくは、Flex ドキュメントの RSL を参照してください。
  • また、クライアントでフォームをレンダリングして、Forms サービスのパフォーマンスを向上させることもできます。（クライアントでの Forms のレンダリングを参照。）

フォームをレンダリング

パフォーマンスオプションを設定した後にフォームをレンダリングするには、パフォーマンスオプションを指定せずにフォームをレンダリングする場合と同じアプリケーションロジックを使用します。

フォームデータストリームをクライアント web ブラウザーに書き込む

Forms サービスがフォームをレンダリングすると、クライアントの Web ブラウザーに書き込む必要があるフォームデータストリームが返されます。クライアント Web ブラウザーに書き込まれると、フォームはユーザーに対して表示されます。

関連トピック

AEM Forms Java ライブラリファイルの追加

接続プロパティの設定

Forms サービス API のクイックスタート

インタラクティブ PDF Forms のレンダリング

Forms を HTML としてレンダリング

Forms をレンダリングする web アプリケーションの作成

Java API を使用したパフォーマンスの最適化

Forms API（Java）を使用して、最適化されたパフォーマンスでフォームをレンダリングします。

  1. プロジェクトファイルを含める

    adobe-forms-client.jar などのクライアント JAR ファイルを Java プロジェクトのクラスパスに含めます。

  2. Forms Client API オブジェクトの作成

    • 接続プロパティを含む ServiceClientFactory オブジェクトを作成します。
    • FormsServiceClient オブジェクトを作成するには、コンストラクターを使用して ServiceClientFactory オブジェクトを渡します。

  3. パフォーマンスの実行時オプションの設定

    • コンストラクターを使用して PDFFormRenderSpec オブジェクトを作成します。
    • フォームキャッシュオプションを設定するには、PDFFormRenderSpec オブジェクトの setCacheEnabled メソッドを呼び出して、true を渡します。
    • 線形化オプションを設定するには、PDFFormRenderSpec オブジェクトの setLinearizedPDF メソッドを呼び出して、true. を渡します。

  4. フォームのレンダリング

    FormsServiceClient オブジェクトの renderPDFForm メソッドを呼び出して、次の値を渡します。

    • ファイル名拡張子を含んだフォームデザイン名を指定する文字列値。
    • フォームに結合するデータを含む com.adobe.idp.Document オブジェクト。データを結合しない場合は、空の com.adobe.idp.Document オブジェクトを渡します。
    • パフォーマンスを向上させるための実行時オプションを保存する PDFFormRenderSpec オブジェクト。
    • Forms サービスで必要な URI 値を格納する URLSpec オブジェクト。
    • 添付ファイルを保存する java.util.HashMap オブジェクト。オプションのパラメーターです。フォームにファイルを添付しない場合は null を指定できます。

    renderPDFForm メソッドは、クライアントの Web ブラウザーに書き込む必要のあるフォームデータストリームを含む FormsResult オブジェクトを返します。

  5. フォームデータストリームをクライアント web ブラウザーに書き込む

    • フォームデータストリームをクライアントの web ブラウザーに送信するために使用する javax.servlet.ServletOutputStream オブジェクトを作成します。
    • FormsResult オブジェクトの getOutputContent メソッドを呼び出すことによって、com.adobe.idp.Document オブジェクトを作成します。
    • com.adobe.idp.Document オブジェクトの getInputStream メソッドを呼び出して、java.io.InputStream オブジェクトを作成します。
    • バイト配列を作成し、フォームデータストリームを入力するには、InputStream オブジェクトの read メソッドを呼び出して、バイト配列を引数として渡します。
    • javax.servlet.ServletOutputStream オブジェクトの write メソッドを呼び出して、フォームデータストリームをクライアント web ブラウザーに送信します。バイト配列を write メソッドに渡します。

関連トピック

クイックスタート（SOAP モード）：Java API を使用したパフォーマンスの最適化

AEM Forms Java ライブラリファイルの組み込み

接続プロパティの設定