アダプティブフォームの操作のベストプラクティス best-practices-for-working-with-adaptive-forms

Apache Maven aem-project-archetype を使用して、AEM プロジェクトの構造を作成および管理します。AEM プロジェクトに合わせて、推奨される構造およびテンプレートを作成します。さらに、ビルドを自動化し、変更制御システムを提供するので、プロジェクト管理が容易になります。

• Maven archetype:generate コマンドを使用して、最初の構造を生成します。
• Maven eclipse:eclipse コマンドを使用して eclipse プロジェクトファイルを生成し、プロジェクトを eclipse 内に読み込みます。

FileVault ツールまたは VLT は、CRX またはAEMインスタンスのコンテンツをファイルシステムにマッピングする際に役立ちます。 AEMプロジェクトコンテンツのチェックインやチェックアウトなど、変更管理の操作を行うことができます。 VLT ツールの使用方法を参照してください。

Eclipse 統合開発環境を使用する場合は、AEM Developer Tools を使用して、Eclipse IDE をAEMインスタンスとシームレスに統合し、AEMアプリケーションを作成できます。 詳しくは、 AEM developer tools for Eclipse.

アダプティブフォームテンプレートは、アダプティブフォームの構造とヘッダーとフッターの情報を定義する専用のAEMページです。 テンプレートには、アダプティブフォームのレイアウト、スタイル、基本構造が事前に設定されています。 AEM Formsには、アダプティブフォームの作成に使用できる標準のテンプレートとコンポーネントが用意されています。 ただし、必要に応じて、カスタムのテンプレートやコンポーネントを作成できます。 アダプティブフォーム内で必要となる追加のテンプレートやコンポーネントの要件を収集することをお勧めします。 詳しくは、 アダプティブフォームおよびコンポーネントのカスタマイズ.

AEM Formsでは、次のフォームモデルに基づいてアダプティブフォームを作成することができます。 フォームモデルは、フォームとAEMシステムとの間でデータを交換するためのインターフェイスとして機能し、アダプティブフォーム内外のデータフローに XML ベースの構造を提供します。 また、フォームモデルは、スキーマと XFA 制約の形式でアダプティブフォームにルールと制約を適用します。

• なし:このオプションで作成されたアダプティブフォームは、フォームモデルを使用しません。 このようなフォームで生成されるデータ XML は、フィールドと対応する値を持つフラットな構造です。
• XML または JSON スキーマ：XML スキーマと JSON スキーマは、組織内のバックエンドシステムによって生成されて使用されるデータの構造を表します。アダプティブフォームにスキーマを関連付け、そのスキーマの要素を使用することにより、アダプティブフォームに動的なコンテンツを追加することができます。スキーマの要素は、アダプティブフォームを作成する際に、コンテンツブラウザーの「データモデルオブジェクト」タブで使用できます。スキーマ要素をドラッグ＆ドロップしてフォームを作成できます。
• XFA フォームテンプレート:XFA ベースの Forms5 に投資している場合、これは理想的なフォームHTMLです。 XFA ベースのフォームをアダプティブフォームに直接変換する方法を提供します。 既存の XFA ルールは、関連するアダプティブフォーム内でも保持されます。 作成されたアダプティブフォームは、検証、イベント、プロパティ、パターンなどの XFA 構成をサポートします。
• フォームデータモデル：データベース、web サービス、AEM ユーザープロファイルなどのバックエンドシステムを統合し、アダプティブフォームに事前入力して、送信されたフォームデータをバックエンドシステムに再び書き込む場合は、このフォームモデルが適しています。フォームデータモデルエディターを使用すると、アダプティブフォームの作成に使用できるフォームデータモデル内のエンティティやサービスを定義して設定することができます。 詳しくは、 AEM Forms Data Integration.

AEM Formsには、アダプティブフォームの作成に使用できる、標準のアダプティブフォームテンプレートが用意されています。 また、独自のテンプレートを作成することもできます。 AEMには、静的および編集可能なテンプレートが用意されています。

• 静的テンプレートは、開発者が定義し、設定します。
• 編集可能テンプレートは、作成者がテンプレートエディターを使用して作成します。 テンプレートエディターを使用して、テンプレートの基本的な構造と初期コンテンツを定義できます。 構造レイヤーでの変更は、そのテンプレートを使用するすべてのフォームに反映されます。 初期コンテンツには、事前設定済みのテーマ、事前入力サービス、送信アクションなどが含まれる場合があります。 ただし、フォームエディターを使用して、フォームに対してこれらの設定を変更することはできます。 詳しくは、アダプティブフォームテンプレートを参照してください。

特定のフィールドやパネルインスタンスにスタイルを設定するには、インラインスタイルを使用します。または、CSS ファイルでクラスを定義し、コンポーネントの CSS クラスプロパティでクラス名を指定します。

コンポーネントにクライアントライブラリを含めると、そのコンポーネントを使用するアダプティブフォームやフラグメント全体で一貫してスタイルを適用できます。 詳しくは、 アダプティブフォームのページコンポーネントの作成.

クライアントライブラリで定義されたスタイルを適用し、アダプティブフォームコンテナプロパティの「 CSS ファイルパス」フィールドでクライアントライブラリへのパスを指定して、アダプティブフォームを選択します。

スタイルのクライアントライブラリを作成するには、テーマエディターの基本 clientlib またはフォームコンテナのプロパティで、カスタム CSS ファイルを設定します。

アダプティブフォームには、レスポンシブ、タブ付き、アコーディオン、ウィザードなどのパネルレイアウトが用意されており、フォームコンポーネントをパネルにレイアウトする方法を制御できます。 カスタムパネルレイアウトを作成して、フォーム作成者が使用できるようにすることができます。 詳しくは、アダプティブフォームのカスタムレイアウトコンポーネントの作成を参照してください。

また、フィールドやパネルレイアウトなど、アダプティブフォームの特定のコンポーネントをカスタマイズすることもできます。

• 以下を使用： オーバーレイ コンポーネントのコピーを変更するAEMの機能。 デフォルトのコンポーネントを変更することはお勧めしません。
• /libs 内の既製のアダプティブフォームコンポーネントのレイアウトをカスタマイズするには、次の手順を実行します。 カスタムレイアウトコンポーネントの作成 に加えて デフォルトレイアウト.
• カスタムウィジェットや外観を作成して、カスタムインタラクティビティを導入します。 デフォルトのコンポーネントを変更することはお勧めしません。 詳しくは、 外観フレームワーク.

PII データの取り扱いに関する推奨事項については、個人を特定できる情報の取り扱いを参照してください。

フォーム階層の下位にあるフィールドにすばやくアクセスするには、サイドバーのオブジェクトブラウザーを使用します。検索ボックスを使用してフォームまたはオブジェクトツリー内のオブジェクトを検索し、オブジェクト間を移動することができます。

サイドバーのコンポーネントブラウザーでコンポーネントのプロパティを表示して編集するには、コンポーネントを選択して をクリックします。コンポーネントをダブルクリックして、そのプロパティをプロパティブラウザーに表示することもできます。

フォームに対するクイックアクションを実行するには、キーボードショートカットを使用します。 AEM Forms のキーボードショートカットを参照してください。

アダプティブフォームのコンポーネントは、アダプティブフォームのページでのみ使用することをお勧めします。 コンポーネントは、親階層に依存します。 このため、AEM ページではこれらのコンポーネントを使用しないでください。

ルールを記述する際に競合が発生する可能性を避けるために、フォームフィールドとコンポーネントに意味のある一意の名前を付けます。

ルールの式で、コンポーネント自身を参照するには、コンポーネントの this 演算子を使用します。これにより、コンポーネント名が変更されても、ルールは有効なままになります。例えば、field1.valueCommit script: this.value > 10 のようになります。

他のフォームコンポーネントを参照する場合には、コンポーネント名を使用します。フィールドまたはコンポーネントの値を取得するには、value プロパティを使用します。例えば、field1.value のようになります。

競合を回避するために、コンポーネントは固有の相対階層で参照します。例えば、parentName.fieldName のようになります。

複雑なルールや共通で使用するルールを扱う場合には、指定してアダプティブフォーム間で再利用できる別のクライアントライブラリの機能としてビジネスロジックを書くことを検討します。クライアントライブラリは独立のライブラリとし、jQuery および Underscore.js 以外の外部依存はなくす必要があります。クライアントライブラリは、送信されたフォームデータのサーバーサイドの再検証を実行するために使用することもできます。

アダプティブフォームは、アダプティブフォームとの通信やアクションの実行に使用できる一連の API を提供します。 主な API の一部を次に示します。 詳しくは、 アダプティブFormsの JavaScript ライブラリ API リファレンス.

• guideBridge.reset()：フォームをリセットします。

• guideBridge.submit()：フォームを送信します。

• guideBridge.setFocus(somExp, focusOption, runCompletionExp)：フィールドにフォーカスを設定します。

• guideBridge.validate(errorList, somExpression, focus)：フォームを検証します。

• guideBridge.getDataXML(options)：フォームデータを XML として取得します。

• guideBridge.resolveNode(somExpression)：フォームオブジェクトを取得します。

• guideBridge.setProperty(somList, propertyName, valueList)：フォームオブジェクトのプロパティを設定します。

• 上記に加えて、以下のフィールドプロパティを使用できます。

  • field.value でフィールドの値を変更します。
  • field.enabled でフィールドを有効／無効にします。
  • field.visible でフィールドの表示／非表示を変更します。

アダプティブフォームの作成者は、フォーム内でビジネスロジックを構築するために JavaScript コードを記述する必要が生じる場合があります。 JavaScript は強力で効果的ですが、セキュリティ上の期待に基づいて妥協する可能性が高くなります。 したがって、フォーム作成者が信頼できるペルソナであることと、フォームを実稼動環境に配置する前に JavaScript コードを確認して承認するプロセスがあることを確認する必要があります。 管理者は、役割や機能に基づいて、ルールエディターへのアクセスをユーザーグループに制限できます。 詳しくは、 選択したユーザーグループにルールエディターへのアクセスを許可する.

ルール内で式を使用して、アダプティブフォームを動的にすることができます。 すべての式は有効な JavaScript 式で、アダプティブフォームのスクリプティングモデル API を使用します。 これらの式は、特定のタイプの値を返します。数式およびベストプラクティスについて詳しくは、アダプティブフォームの式を参照してください。

可能な場合には、XFA をアダプティブフォームに変換する場合でも、XSD フォームデータモデルを使用してアダプティブフォームを作成することをお勧めします。

アダプティブフォームには、ユーザーからの情報を取り込むフィールドとパネルのみを含めます。 静的コンテンツを最小限に抑えるか、URL を使用してそれらを別のウィンドウで開くことを検討します。

すべてのフォームは特定の目的のために設計されていますが、ほとんどのフォームには一般的なセグメントがいくつかあります。 例えば、個人の詳細、住所、雇用の詳細などです。 フォームの共通の要素およびセクションに対してアダプティブフォームフラグメントを作成し、それらを複数のフォーム間で使用します。既存のフォーム内のパネルをフラグメントとして保存することもできます。 フラグメント内の変更は、関連するすべてのアダプティブフォームに反映されます。 これにより、複数の作成者が同時に、1 つのフォームを構成する別のフラグメントの作業を行えるため、オーサリングの共同作業が促進されます。

• アダプティブフォームと同様に、フラグメント固有のスタイル設定とカスタムスクリプトはすべて、フラグメントコンテナダイアログを使用してクライアントライブラリで定義することをお勧めします。 また、外部のオブジェクトに依存しない自己十分なフラグメントを作成してみてください。
• クロスフラグメントスクリプティングの使用は避けます。 フラグメントの外部に参照する必要があるオブジェクトがある場合は、そのオブジェクトを親フォームの一部にしてみます。 オブジェクトが別のフラグメントに存在する必要がある場合は、スクリプト内でその名前で参照します。

自動保存で「保存と再開」を使用すると、アダプティブフォームが定期的に保存され、後で再度訪問してフォームを完了することができます。

フラグメントの読み込みを遅延的に設定します。 遅延読み込みとマークされたフラグメントは、実行時に必要な場合にのみレンダリングされます。 大きなフォームの場合、読み込み時間が大幅に短縮されます。 また、繰り返し可能なパネルを持つフラグメントでもサポートされています。 詳しくは、 遅延読み込みの設定.

• レスポンシブグリッドレイアウトのフラグメントや最初のパネルでは、遅延読み込みを設定しないでください。
• ファイル添付および利用条件コンポーネントは、遅延読み込みフラグメントではサポートされません。
• 遅延読み込み済みパネルの値を「値を使用」としてマークします。その値がフォームの他の部分で使用されている場合は、その値が、含まれているパネルがアンロードされたときに使用できるようになります。
• 条件に基づいて表示または非表示する必要があるフラグメントに対して、表示ルールを記述することを検討します。

AEM Formsには、事前定義済みのデータ XML ファイルからデータを読み取り、事前入力 XML ファイル内のコンテンツをアダプティブフォームのフィールドに事前入力するための事前入力サービスが用意されています。

事前入力データ XML は、アダプティブフォームに関連付けられたフォームモデルのスキーマに準拠している必要があります。

事前入力 XML には「afBoundedData」および「afUnBoundedData」セクションを含めて、アダプティブフォームの連結されたフィールドと連結されていないフィールドのどちらにも事前入力するようにします。

フォームデータモデルに基づいたアダプティブフォームの場合、AEM Forms にはすぐに使用できるフォームデータモデルの事前入力サービスが用意されています。事前入力サービスは、アダプティブフォーム内のデータモデルオブジェクトに対してデータソースに対してクエリを実行し、フォームのレンダリング時にフィールド値を事前入力します。

アダプティブフォームでは、ファイル、crx、サービス、または http プロトコルを事前入力することもできます。

AEM Formsは、OSGi サービスとしてプラグインしてアダプティブフォームに事前入力できる、カスタム事前入力サービスをサポートしています。

アダプティブフォームが基にしているフォームデータモデルに応じて、DoR 用のテンプレートを次のように設定できます。

• XFA フォームテンプレート:関連する XDP ファイルを DoR テンプレートとして使用します。
• XSD スキーマ:アダプティブフォームで使用されているのと同じ XML スキーマを使用する、関連する XFA テンプレートを使用します。
• なし:自動生成された DoR を使用します。

アダプティブフォームエディターの「レコードのドキュメント」タブから、ヘッダー、フッター、画像、色、フォントなどを直接設定します。

DoRService を使用して、DoR をプログラムにより生成します。

DoR から非表示フィールドを除外します。

afAcceptLang リクエストパラメーターを使用して、別のロケールで DoR を表示します。

複数のフォームに共通する要素に対してアダプティブフォームフラグメントを使用し、フラグメントをローカライズします。これにより、フラグメントを 1 回ローカライズするだけで、ローカライズされたフラグメントが使用されるすべてのフォームに反映されます。

新しいコンポーネントの追加や、ローカライズされたフォームへのスクリプトの適用などの変更は、自動的にはローカライズされません。 したがって、ローカライズを何度も行わなければならない状況を避けるには、フォームをローカライズする前に完成させる必要があります。

ブラウザーのロケールを上書きし、指定したロケールでフォームをレンダリングするには、afAcceptLang 要求パラメーターを使用します。例えば、次の URL を使用すると、ブラウザー設定で指定されたロケールに関係なく、日本語ロケールでのフォームのレンダリングが強制されます。

https://[*server*]:[*port*]/<*contextPath*>/<*formFolder*>/<*formName*>.html?wcmmode=disabled&afAcceptLang=ja

AEM Formsでは現在、英語 (en)、スペイン語 (es)、フランス語 (fr)、イタリア語 (it)、ドイツ語 (de)、日本語 (ja)、ポルトガル語 — ブラジル語 (pt-BR)、中国語 (zh-TW)、韓国語 (ko-KR) の各ロケールのアダプティブフォームコンテンツのローカライゼーションをサポートしています。 ただし、アダプティブフォームの新しいロケールのサポートを実行時に追加することはできます。 詳しくは、 アダプティブフォームのローカリゼーション用に新しいロケールをサポート.

Felix コンソールからの JavaScript および CSS の HTML クライアントライブラリ圧縮を有効にします。

すべてのクライアントライブラリを /etc.clientlibs/fd にキャッシュし、追加のカスタムクライアントライブラリを AEM ディスパッチャーにキャッシュすることで、発行したフォームの応答速度とセキュリティを向上させます。詳しくは、ディスパッチャーを参照してください。

/content/forms/af/ パス および /content/dam/formsanddocuments/* パスはキャッシュしないでください。アダプティブフォームのキャッシュ設定について詳しくは、アダプティブフォームのキャッシュを参照してください。

Web サーバーHTMLモジュールを使用して圧縮を有効にします。 詳しくは、 AEM Formsサーバーのパフォーマンス調整.

大規模なフォームのリクエスト設定ごとに呼び出しを増やします。 詳しくは、 大規模フォームと複雑なフォームのパフォーマンスの最適化.

作成 エラーハンドラーによって表示されるカスタムエラーページ.

AEM Forms サーバーを保護します。

• nosamplecontent 実行モードを使用して、実稼働サーバーにサンプルコンテンツおよびサンプルユーザーがデプロイされていないことを確認します。AEM の実稼動準備完了モードでの実行を参照してください。

ヒープサイズは 8 GB 以上にしてください。 その他の設定については、 AEM Formsサーバーのパフォーマンス調整.

サービスレベルのタスクを実行するには、管理セッションではなく、サービスユーザーセッションを使用します。 詳しくは、 サービス認証.

ドラフトデータの保存：アダプティブフォームの「ドラフト」機能を使用している場合は、カスタムサービスプロバイダーインターフェイス（SPI）を実装して、データベースなどのより安全なストレージにドラフトデータを保存してください。詳しくは、「ドラフト&送信コンポーネントとデータベースの統合」を参照してください。

送信データの保存：「フォームポータル送信保存」を使用している場合は、カスタム SPI を実装してデータベースに送信データを保存してください。統合例については、ドラフト&送信コンポーネントとデータベースの統合の例 を参照してください。

安全なストレージにフォームデータと添付ファイルを保存するカスタム送信アクションを作成することもできます。詳しくは、アダプティブフォーム向けカスタム送信アクションの作成 を参照してください。