アダプティブフォームまたはアダプティブフォームフラグメントのレコードのドキュメントを生成 generate-document-of-record-for-adaptive-forms
アダプティブフォームの新規作成または AEM Sites ページへのアダプティブフォームの追加には、最新の拡張可能なデータキャプチャコアコンポーネントを使用することをお勧めします。これらのコンポーネントは、アダプティブフォームの作成における大幅な進歩を表し、ユーザーエクスペリエンスの向上を実現します。この記事では、基盤コンポーネントを使用してアダプティブフォームを作成する古い方法について説明します。
概要 overview
フォームを送信した後、顧客は通常、印刷するかまたはドキュメント形式で保存するかのどちらかで、フォームに記入した情報を今後の参考のために記録しておきたいと考えます。これを、レコードのドキュメントといいます。
この記事では、アダプティブフォームまたはアダプティブフォームフラグメントのレコードのドキュメントを生成する方法について説明します。
アダプティブフォームのタイプとレコードのドキュメント adaptive-form-types-and-their-documents-of-record
アダプティブフォームの作成時に、フォームモデルを選択できます。以下のオプションがあります。
-
フォームテンプレート
アダプティブフォームの XFA テンプレートを選択できます。XFA テンプレートを選択した場合は、上記のように、レコードのドキュメントに関連付けられている XDP ファイルを使用することができます。 -
XML スキーマ
アダプティブフォームの XML スキーマ定義を選択できます。アダプティブフォームの XML スキーマを選択すると、以下のことが可能になります。- レコードのドキュメントに XFA テンプレートを関連付ける。関連する XFA テンプレートで、アダプティブフォームと同じ XML スキーマを使用するようにする。
- レコードのドキュメントの自動生成
-
なし
フォームのモデルを指定せずに、アダプティブフォームを作成できます。レコードのドキュメントは、アダプティブフォーム用に自動的に生成されます。
フォームモデルを選択する場合は、「レコードのドキュメントテンプレート設定」で使用可能なオプションを使用してレコードのドキュメントを設定します。レコードのドキュメントのテンプレート設定を参照してください。
自動生成されたレコードのドキュメント automatically-generated-document-of-record
レコードのドキュメントを使用すると、送信したフォームを顧客が印刷目的で保存することができます。レコードのドキュメントを自動的に生成すると、フォームを変更するたびに、そのレコードのドキュメントもすぐに更新されます。例えば、居住国に米国を選択した顧客のレコードでは、年齢のフィールドを削除したとします。このような顧客がレコードのドキュメントを生成する場合、レコードのドキュメントには年齢フィールドが顧客に対して表示されません。
自動生成されたレコードのドキュメントには、次のような利点があります。
- データ連結が処理されます。
- 送信時にレコードのドキュメントから除外されるとマークされたフィールドについて、自動的に非表示にします。余分な労力が不要になります。
- レコードのドキュメントテンプレートの設計時間を節約できます。
- 様々な基本テンプレートを使用しながら様々なスタイリングと外観を試すことで、レコードのドキュメントにとって最良のスタイルと外観を選択できます。スタイリングを設定することはオプションです。スタイルを指定しない場合は、システムスタイルがデフォルトとして設定されます。
- フォーム内のすべての変更が、確実かつ即座にレコードのドキュメントに反映されます。
レコードのドキュメントを自動生成するためのコンポーネント components-to-automatically-generate-a-document-of-record
アダプティブフォーム用のレコードのドキュメントを生成するには、次のコンポーネントが必要です。
アダプティブフォーム レコードのドキュメントを生成するアダプティブフォーム。
アダプティブフォームフラグメント レコードのドキュメントを生成するアダプティブフォームフラグメント。
基本テンプレート（推奨） AEM Designer で作成された XFA テンプレート（XDP ファイル）。基本テンプレートは、レコードのドキュメントテンプレートのスタイリングとブランディング情報を指定するために使用されます。
レコードのドキュメントの基本テンプレートを参照してください
レコードのドキュメントのテンプレート アダプティブフォームから生成された XFA テンプレート（XDP ファイル）。
レコードのドキュメントのテンプレート設定を参照してください。
フォームデータ ユーザーがアダプティブフォームに入力した情報。これは、レコードのドキュメントを生成するため、レコードのドキュメントテンプレートと結合されます。
アダプティブフォーム要素のマッピング mapping-of-adaptive-form-elements
以下の節では、レコードのドキュメント内でアダプティブフォーム要素がどのように表示されるかについて説明します。
フィールド fields
コンテナ containers
静的コンポーネント static-components
テーブル tables
ヘッダー、フッター、および列といった、アダプティブフォームのテーブルコンポーネントは、対応する XFA コンポーネントにマッピングされます。反復パネルをレコードのドキュメントのテーブルにマッピングできます。
レコードのドキュメントの基本テンプレート base-template-of-a-document-of-record
基本テンプレートは、レコードのドキュメントにスタイリングとアピアランスの情報を提供します。これにより、自動生成されたレコードのドキュメントに対して、デフォルトのアピアランスをカスタマイズできます。例えば、レコードのドキュメントのヘッダーに会社のロゴを、そしてフッターに著作権情報を追加するとします。基本テンプレートから作成されたメインページは、レコードのドキュメントのテンプレートのメインページとして使用されます。メインページには、レコードのドキュメントに適用可能なページヘッダー、ページフッター、ページ番号などの情報を含めることができます。レコードのドキュメント自動生成用の基本テンプレートを使用することで、この情報をレコードのドキュメントに適用できます。基本テンプレートを使用すると、フィールドのデフォルトプロパティを変更することができます。
基本テンプレートを設計する際は、基本テンプレートの規則に従ってください。
基本テンプレートの規則 base-template-conventions
基本テンプレートは、レコードのドキュメントのヘッダー、フッター、スタイル、およびアピアランスを定義するために使用されます。ヘッダーとフッターには、会社のロゴや著作権テキストなどの情報を含めることができます。基本テンプレートの最初のマスターページはコピーされ、レコードのドキュメント用のマスターページとして使用されます。この中には、ヘッダー、フッター、ページ番号、またはレコードのドキュメント内のすべてのページに表示される他の情報が含まれています。基本テンプレートの規則に準拠していない基本テンプレートを使用している場合、その最初のマスターページは依然としてレコードのドキュメントテンプレートで使用されます。基本テンプレートを規則通りに設計し、レコードのドキュメント自動生成に使用することを強くお勧めします。
マスターページの規則
-
基本テンプレートでは、ルートサブフォームに
AF_METATEMPLATE、およびマスターページにAF_MASTERPAGEの名前を付ける必要があります。 -
ルートサブフォームの
AF_MASTERPAGE下に位置するAF_METATEMPLATEという名前のマスターページには、ヘッダー、フッター、およびスタイル情報を抽出するための優先順位が与えられています。 -
AF_MASTERPAGEが存在しない場合は、基本テンプレート中に存在する最初のマスターページが使用されます。
フィールドのスタイリング規則
-
レコードのドキュメント内のフィールドにスタイルを適用するため、基本テンプレートは
AF_METATEMPLATEルートサブフォーム内のAF_FIELDSSUBFORMサブフォームにフィールドを作成します。 -
これらのフィールドのプロパティは、レコードのドキュメント内のフィールドに適用されます。これらのフィールドは、
AF_<name of field in all caps>_XFOの命名規則に従う必要があります。例えば、チェックボックスのフィールド名はAF_CHECKBOX_XFOとする必要があります。
基本テンプレートを作成するには、AEM Designer で次の手順を実行します。
-
ファイル／新規 をクリックします。
-
「テンプレートに基づく」のオプションを選択します。
-
「Forms - レコードのドキュメント」のカテゴリを選択します。
-
「DoR 基本テンプレート」を選択します。
-
「次へ」をクリックし、必要な情報を入力します。
-
（オプション）レコードのドキュメント内のフィールドに適用する、フィールドのスタイル設定と外観を変更します。
-
フォームを保存します。
これで、保存されたフォームをレコードのドキュメント用基本テンプレートとして使用できます。基本テンプレート中に存在するスクリプトについて、いずれも変更したり、削除したりしないでください。
基本テンプレートの変更
- 基本テンプレート内のフィールドに対していずれのスタイルも適用していない場合は、基本テンプレートからそれらのフィールドを削除することをお勧めします。これにより、基本テンプレートのアップグレードを自動的に適用することができます。
- 基本テンプレートを変更するときは、スクリプトを削除、追加、変更しないでください。
レコードのドキュメントのテンプレート設定 document-of-record-template-configuration
フォームのレコードのドキュメントテンプレートを設定して、顧客が送信したフォームを印刷用ファイルとしてダウンロードできるようにします。XDP ファイルは、レコードのドキュメントテンプレートとして機能します。顧客がダウンロードしたレコードのドキュメントは、XDP ファイルで指定されたレイアウトに従ってフォーマットされます。
次の手順を実行し、アダプティブフォーム向けレコードのドキュメントを設定します。
-
AEM オーサーインスタンスで、フォーム／フォームとドキュメント をクリックします。
-
フォームを選択し、「プロパティの表示」をクリックします。
-
プロパティウィンドウで、「フォームモデル」を選択します。
フォームモデルの選択は、フォームの作成時にも行うことができます。note note NOTE 「フォームモデル」のタブで、必ず「次から選択」ドロップダウンから「スキーマ」または「なし」を選択します。レコードのドキュメントは、XFA ベースのフォームや、フォームテンプレートがフォームモデルとして使用されたアダプティブフォームではサポートされません。 -
「フォームモデル」タブの「レコードのドキュメントのテンプレート設定」セクションで、次のいずれかのオプションを選択します。
なし フォームのレコードのドキュメントを設定しない場合は、このオプションを選択します。
フォームテンプレートをレコードのドキュメントとして関連付ける レコードのドキュメント用のテンプレートとして使用する XDP ファイルがある場合は、このオプションを選択します。このオプションを選択すると、AEM Forms リポジトリで利用可能なすべての XDP ファイルが表示されます。適切なファイルを選択します。
選択された XDP ファイルは、アダプティブフォームに関連付けられます。
レコードのドキュメントの生成 レコードのドキュメントのスタイルと外観が定義された基本テンプレートとして XDP ファイルを使用するには、このオプションを選択します。このオプションを選択すると、AEM Forms リポジトリで利用可能なすべての XDP ファイルが表示されます。適切なファイルを選択します。
note note NOTE 次の場合は、アダプティブフォーム作成するために使用されるスキーマと、XFA フォームのスキーマ（データスキーマ）が同じであることを確認します。 code language-none * アダプティブフォームがスキーマベースの場合 * レコードのドキュメント用の「**フォームテンプレートをレコードのドキュメントテンプレートとして関連付ける**」オプションを使用している場合 -
「完了」をクリックします。
レコードのドキュメントにあるブランディング情報をカスタマイズ customize-the-branding-information-in-document-of-record
レコードのドキュメントの生成中に、「レコードのドキュメント」タブにあるレコードのドキュメントのブランディング情報を変更できます。「レコードのドキュメント」タブには、ロゴ、外観、レイアウト、ヘッダー、フッター、免責事項などのオプションや、選択されていないチェックボックスやラジオボタンを含めるかどうかのオプションが含まれています。
「レコードのドキュメント」タブに入力するブランディング情報をローカライズするには、ブラウザーのロケールが正しく設定されている必要があります。レコードのドキュメントのブランディング情報をカスタマイズするには、以下の手順を実施します。
-
レコードのドキュメント内でパネル（ルートパネル）を選択して、「
-
-
レコードのドキュメントをレンダリングするために、デフォルトテンプレートまたはカスタムテンプレートのいずれかを選択します。デフォルトテンプレートを選択すると、レコードのドキュメントのサムネイルがテンプレートドロップダウンの下に表示されます。
カスタムのテンプレートを選択する場合は、AEM Forms サーバーで XDP を参照して選択します。AEM Forms サーバーにないテンプレートを使用する場合は、最初に XDP を AEM Forms サーバーにアップロードする必要があります。
-
デフォルトのテンプレートとカスタムのテンプレートのどちらを選択するかに応じて、以下のプロパティの一部または全てが「レコードのドキュメント」タブに表示されます。これらを正しく設定します。
- ロゴ画像：アダプティブフォームのロゴ画像を使用するか、DAM から選択するか、コンピューターからアップロードすることができます。
- フォームタイトル
- ヘッダーテキスト
- 免責事項ラベル
- 免責事項
- 免責事項テキスト
- アクセントの色：ヘッダーテキストおよび区切り線の色は、レコードのドキュメントの PDF でレンダリングされます
- フォントファミリー：レコードのドキュメント PDF にあるテキストフォントファミリー
- チェックボックスおよびラジオボタンのコンポーネントには、選択した値のみを表示
- 複数選択されている値のセパレーター
- データモデルにバインドされていないフォームオブジェクトを含める
- レコードのドキュメントから非表示フィールドを除外
- パネルの説明を非表示
選択したカスタム XDP テンプレートに複数のマスターページが含まれている場合、これらのページのプロパティは「レコードのドキュメント」タブの「コンテンツ」セクションに表示されます。
マスターページのプロパティには、ロゴ画像、ヘッダーテキスト、フォームタイトル、免責事項ラベル、免責事項テキストが含まれます。アダプティブフォームまたは XDP テンプレートのプロパティは、レコードのドキュメントに適用できます。AEM Forms は、デフォルトでテンプレートのプロパティをレコードのドキュメントに適用します。マスターページのプロパティにカスタム値を定義することもできます。レコードのドキュメントに複数のマスターページを適用する方法については、レコードのドキュメントに複数のマスターページを適用するを参照してください。
note note NOTE バージョン 6.3 より前の Designer で作成されたアダプティブフォームテンプレートを使用している場合、アクセントの色およびフォントファミリーのプロパティを適用するには、ルートサブフォームの下にあるアダプティブフォームテンプレートに以下が存在することを確認してください。 code language-xml <proto> <font typeface="Arial"/> <fill> <color value="4,166,203"/> </fill> <edge> <color value="4,166,203"/> </edge> </proto> -
ブランディングの変更内容を保存するには、「完了」を選択します。
レコードのドキュメントのパネルに表示される表と列のレイアウト table-and-column-layouts-for-panels-in-document-of-record
いくつかのフォームフィールドを使用すると、アダプティブフォームのサイズが大きくなる場合があります。レコードのドキュメントをアダプティブフォームの正確なコピーとして保存したくない場合があります。これで、1 つまたは複数のアダプティブフォームパネルをレコードのドキュメント PDF に保存するために、表や列のレイアウトを選択できます。
レコードのドキュメントを生成する前に、パネルの設定で、そのパネルの「レコードのドキュメントのレイアウト」として「表または列」を選択します。パネル内のフィールドは、レコードのドキュメントに合わせて配置されます。
レコードのドキュメントのテーブルレイアウト内でレンダリングされたパネルのフィールド
レコードのドキュメントの列レイアウト内でレンダリングされたパネルのフィールド
レコードのドキュメントの設定 document-of-record-settings
レコードのドキュメント設定では、レコードのドキュメントに含めるオプションを選択できます。例えば、銀行では、名前、年齢、社会保障番号、電話番号などをフォームから受け取ります。このフォームで、銀行口座番号や支店の詳細が生成されます。レコードのドキュメントでは、名前、社会保障番号、銀行口座、および支店の詳細のみが表示されるように選択できます。
コンポーネントのレコードのドキュメント設定は、そのプロパティ内で使用できます。コンポーネントのプロパティにアクセスするには、コンポーネントを選択し、オーバーレイ内の
フィールドレベルの設定
-
レコードのドキュメントから除外：プロパティを「true」に設定すると、そのフィールドがレコードのドキュメントから除外されます。これは
excludeFromDoRという名前のスクリプト可能プロパティです。その動作は、非表示の場合はレコードのドキュメントからフィールドを除外 フォームレベルプロパティに依存します。 -
パネルをテーブルとして表示： パネルに含まれるフィールドの数が 6 個未満の場合、このプロパティを設定することでパネルがテーブルとしてレコードのドキュメントに表示されます。この設定は、パネルにのみ適用されます。
-
レコードのドキュメントからタイトルを除外： このプロパティを設定すると、レコードのドキュメントからパネルやテーブルのタイトルが除外されます。パネルおよびテーブルに対してのみ適用できます。
-
レコードのドキュメントから説明を除外： このプロパティを設定すると、レコードのドキュメントからパネルやテーブルの説明が除外されます。パネルおよびテーブルに対してのみ適用できます。
-
ページネーション／場所：パネルを配置する場所を指定します。
- 場所／前に従う：親パネル内の前のオブジェクトの後にパネルを配置します。
- 場所／コンテンツ領域内 ／コンテンツ領域名：指定したコンテンツ領域にパネルを配置します。
- 場所／次のコンテンツ領域の先頭：パネルを次のコンテンツ領域の先頭に配置します。
- 場所／コンテンツ領域の先頭／コンテンツ領域名：指定したコンテンツ領域の先頭にパネルを配置します。
- 場所／ページ上／マスターページの名前：指定したページにパネルを配置します。改ページが自動的に挿入されない場合、AEM Forms は改ページを追加します。
- 場所／次のページの先頭：パネルを次のページの先頭に配置します。改ページが自動的に挿入されない場合、AEM Forms は改ページを追加します。
- 場所／ページの先頭／マスターページの名前：指定したページがレンダリングされる際に、パネルをページの先頭に配置します。改ページが自動的に挿入されない場合、AEM Forms は改ページを追加します。
-
ページネーション／後：パネルを配置した後に入力する領域を決定します。後 セクションでは次のフィールドを使用できます。
- 後／親の入力を続行：親パネルに入力されたまま残っているすべてのオブジェクトのデータを引き続き結合します。
- 後／次のコンテンツ領域に移動：パネルを配置した後に、次のコンテンツ領域の埋め込みを開始します。
- 後／コンテンツ領域に移動／コンテンツ領域名：パネルを配置した後に、指定したコンテンツ領域の入力を開始します。
- 後／次のページに移動：パネルを配置した後で、次のページへの入力を開始します。
- 後／ ページに移動／ページ名：パネルを配置した後に、指定したページへの入力を開始します。
-
ページネーション／オーバーフロー：パネルまたはページに広がるテーブルのオーバーフローを設定します。「オーバーフロー」セクションでは次のフィールドを使用できます。
- オーバーフロー／なし：次のページへの入力を開始します。改ページが自動的に挿入されない場合、AEM Forms は改ページを追加します。
- オーバーフロー／コンテンツ領域に移動／コンテンツ領域名：指定したコンテンツ領域への入力を開始します。
- オーバーフロー／ページに移動／ページ名：指定したページへの入力を開始します。
note note NOTE ページネーションプロパティは、アダプティブフォームフラグメントでは使用できません。
レコードのドキュメントで改ページを適用し、複数のマスターページを適用する方法について詳しくは、 レコードのドキュメントに対する改ページの適用およびレコードのドキュメントに対する複数のマスターページの適用を参照してください。
フォームレベルの設定
- バインドされていないフィールドをレコードのドキュメントに含める： このプロパティを設定すると、スキーマベースのアダプティブフォームのバインドされていないフィールドが、レコードのドキュメントに追加されます。デフォルトでは true になっています。
- 非表示の場合に DoR からフィールドを除外： フォーム送信時にレコードのドキュメントから非表示のフィールドを除外するようにプロパティを設定します。サーバーで再検証を有効にすると、サーバーは非表示のフィールドを再計算してから、レコードのドキュメントから非表示のフィールドを除外します。
レコードのドキュメントに対する改ページの適用 apply-page-breaks-in-dor
複数の方法を使用して、レコードのドキュメントに改ページを適用できます。
レコードのドキュメントに改ページを適用するには：
-
パネルを選択し、「
-
「レコードのドキュメント」を展開すると、プロパティが表示されます。
-
「ページネーション」セクションで、「場所」フィールドの「
-
「次のページの先頭」を選択し、「選択」を選択します。また、「ページの先頭」を選択してマスターページを選択し、「選択」を選択して改ページを適用することもできます。
-
「
選択したパネルは次のページに移動します。
レコードのドキュメントに対する複数のマスターページの適用 apply-multiple-master-pages-dor
選択したカスタム XDP テンプレートに複数のマスターページが含まれている場合、これらのページのプロパティは、「 レコードのドキュメント」タブの「コンテンツ」セクションに表示されます。詳しくは、レコードのドキュメントにあるブランディング情報のカスタマイズを参照してください。
アダプティブフォームのコンポーネントに異なるマスターページを適用することで、レコードのドキュメントに複数のマスターページを適用できます。複数のマスターページを適用する場合は、レコードのドキュメントプロパティの「ページネーション」セクションを使用します。
レコードのドキュメントに複数のマスターページを適用する方法の例を以下に示します。
4 つのマスターページを含む XDP テンプレートを AEM Forms サーバーにアップロードします。AEM Forms は、デフォルトでレコードのドキュメントにテンプレートのプロパティを適用します。また、AEM Forms はテンプレートにおける最初のマスターページのプロパティをレコードのドキュメントに適用します。
2 つ目のマスターページのプロパティをパネルに適用し、3 つ目のマスターページのプロパティをそれ以降のパネルに適用するには、以下の手順を実行します。
- パネルを選択して 2 つ目のマスターページを適用し、「
- 「ページネーション」セクションで、「場所」フィールドの「
- 「ページ上」を選択して、2 つ目のマスターページを選択し、「選択」を選択します。
AEM Forms は、アダプティブフォーム内の該当するパネルとそれ以降のすべてのパネルに 2 つ目のマスターページを適用します。 - 「ページネーション」セクションで、「後」フィールドの「
- 「ページに移動」を選択して、3 つ目のマスターページを選択し、「選択」を選択します。
- 「
AEM Forms は、アダプティブフォーム内の該当するパネルとそれ以降のすべてのパネルに 3 つ目のマスターページを適用します。
レコードのドキュメントで作業する場合の主な注意点 key-considerations-when-working-with-document-of-record
アダプティブフォーム用のレコードのドキュメントで作業する際は、以下の点に注意してください。
- レコードのドキュメントのテンプレートは、リッチテキストをサポートしていません。そのため、スタティックアダプティブフォームまたはエンドユーザー入力情報に含まれるリッチテキストは、レコードのドキュメントではプレーンテキストとして表示されます。
- アダプティブフォーム内のドキュメントフラグメントは、レコードのドキュメントには表示されません。ただし、アダプティブフォームのフラグメントはサポートされています。
- XML スキーマベースのアダプティブフォームは、レコードの生成されたドキュメント内でのコンテンツのバインドに対応していません。
- ユーザーがレコードのドキュメントのレンダリングを要求すると、ローカライズされたバージョンのレコードのドキュメントが、ロケールに合わせてオンデマンドで作成されます。レコードのドキュメントのローカライゼーションは、アダプティブフォームのローカライゼーションと同時に発生します。レコードのドキュメントおよびアダプティブフォームのローカライゼーションの詳細については、「AEM 翻訳ワークフローを使用したアダプティブフォールおよびレコードのドキュメントのローカライズ」を参照してください。
カスタム XCI ファイルの使用
XCI ファイルは、ドキュメントの様々なプロパティを設定する場合に役立ちます。 カスタム XCI ファイルを使用して、既存の XCI ファイルで指定されている 1 つ以上のデフォルトのプロパティを上書きできます。 例えば、ドキュメントにフォントを埋め込むか、すべてのドキュメントに対してタグ付きプロパティを有効にするかを選択できます。XCI オプションを次の表に示します。
ローカルのForms開発環境でカスタム XCI ファイルを使用する
- XCI ファイルをアップロード環境にローカル開発します。
- 開く 設定マネージャー。
- 「アダプティブフォームおよびインタラクティブ通信 Web チャネル」の設定を検索して開きます。
- XCI ファイルのパスを指定し、「保存」をクリックします。