既存データを使用して、アダプティブフォームのフィールドを事前入力することができます。ユーザーがフォームを開くと、これらのフィールドの値は事前入力されています。アダプティブフォームにデータを事前入力するには、アダプティブフォームの事前入力データ構造に合った形式を使用して、事前入力 XML または JSON としてユーザーデータを作成します。
アダプティブフォームには、連結されたフィールドと連結されていないフィールドが混在している場合があります。連結されたフィールドは、「コンテンツファインダー」タブからドラッグされたフィールドです。フィールドの編集ダイアログには、空ではない bindRef
プロパティ値が含まれています。連結されていないフィールドは、サイドキックのコンポーネントブラウザーから直接ドラッグされ、bindRef
値が含まれています。
アダプティブフォームの連結されたフィールドと連結されていないフィールドの両方を事前入力できます。事前入力データには afBoundData セクションと afUnBoundData セクションが含まれており、アダプティブフォームの連結されたフィールドと連結されていないフィールドの両方を事前入力できます。afBoundData
セクションには連結されたフィールドとパネルの事前入力データが含まれています。このデータは関連するフォームモデルスキーマに準拠している必要があります。
<?xml version="1.0" encoding="UTF-8"?>
<afData>
<afBoundData>
<employeeData>
.
</employeeData>
</afBoundData>
<afUnboundData>
<data>
<textbox>Hello World</textbox>
.
.
<numericbox>12</numericbox>
.
.
</data>
</afUnboundData>
</afData>
{
"afBoundData": {
"employeeData": { }
},
"afUnboundData": {
"data": {
"textbox": "Hello World",
"numericbox": "12"
}
}
}
同じ bindref を持つ連結されているフィールド、または同じ名前を持つ連結されていないフィールドの場合、XML タグまたは JSON オブジェクトで指定したデータがすべてのフィールドに入力されます。例えば、フォーム内の 2 つのフィールドは、事前入力データの名前 textbox
にマップされます。ランタイム時、最初のテキストボックスに「A」が含まれる場合、この「A」が 2 番目のテキストボックスに自動的に挿入されます。このリンクは、アダプティブフォームフィールドのライブリンクと呼ばれます。
XFA ベースのアダプティブフォームの事前入力 XML と送信済み XML の構造は次のとおりです。
事前入力 XML 構造:XFA ベースのアダプティブフォームのための事前入力 XML は、XFA フォームテンプレートのデータスキーマに準拠している必要があります。連結されていないフィールドを事前入力するには、事前入力 XML 構造を /afData/afBoundData
タグにラップします。
送信済み XML 構造:事前入力 XML が使用されていない場合、送信済み XML の afData
ラッパータグには、連結されたフィールドと連結されていないフィールドの両方のデータが含まれます。事前入力 XML が使用された場合、送信済み XML は、事前入力 XML と同じ構造をしています。事前入力 XML が afData
のルートタグで開始する場合、出力 XML もまた同じフォーマットとなります。事前入力 XML に afData/afBoundData
のラッパーが無く、直接 employeeData
のようなスキーマルートタグから開始する場合は、送信済み XML もまた employeeData
タグから開始します。
Prefill-Submit-Data-ContentPackage.zip
ファイルを取得
事前入力データと送信済みデータが含まれているサンプル
XML スキーマをベースとするアダプティブフォームの事前入力 XML と送信済み XML の構造は次のとおりです。
afData
のラッパータグに連結されたフィールドと連結されていないフィールド両方のデータを含みます。事前入力 XML が使用された場合、送信済み XML は、事前入力 XML と同じ構造をしています。事前入力 XML が afData
のルートタグで開始する場合、出力 XML は同じフォーマットとなります。事前入力 XML に afData/afBoundData
のラッパーが無く、直接 employeeData
のようなスキーマルートタグから開始する場合は、送信済み XML もまた employeeData
タグから開始します。<?xml version="1.0" encoding="utf-8" ?>
<xs:schema targetNamespace="https://adobe.com/sample.xsd"
xmlns="https://adobe.com/sample.xsd"
xmlns:xs="https://www.w3.org/2001/XMLSchema">
<xs:element name="sample" type="SampleType"/>
<xs:complexType name="SampleType">
<xs:sequence>
<xs:element name="noOfProjectsAssigned" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:schema>
XML スキーマをモデルとするフィールドの場合、以下の XML のサンプルに示すように、afBoundData
タグのデータは事前入力されます。これは、1 つ以上の連結されていないテキストフィールドでアダプティブフォームを事前入力する場合に使用できます。
<?xml version="1.0" encoding="UTF-8"?><afData>
<afUnboundData>
<data>
<textbox>Ignorance is bliss :) </textbox>
</data>
</afUnboundData>
<afBoundData>
<data>
<noOfProjectsAssigned>twelve</noOfProjectsAssigned>
</data>
</afBoundData>
</afData>
連結されているパネル(サイドキックまたは「データソース」タブからコンポーネントをドラッグして作成された、空ではない bindRef
が含まれているパネル)では、連結されていないフィールドを使用しないことをお勧めします。これらの連結していないフィールドのデータの損失を招くことがあります。また、フィールド名は、特に連結されていないフィールドに対して、フォーム間で一意にすることをお勧めします。
<?xml version="1.0" encoding="UTF-8"?><config>
<assignmentDetails descriptionOfAssignment="Some Science Project" durationOfAssignment="34" financeRelatedProject="1" name="Lisa" numberOfMentees="1"/>
<assignmentDetails descriptionOfAssignment="Kidding, right?" durationOfAssignment="4" financeRelatedProject="1" name="House" numberOfMentees="3"/>
</config>
JSON スキーマをベースとするアダプティブフォームの場合、事前入力 JSON と送信済み JSON の構造は次のようになります。詳しくは、JSON スキーマを使ったアダプティブフォームの作成を参照してください。
{
"id": "https://some.site.somewhere/entry-schema#",
"$schema": "https://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"address": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"age": {
"type": "integer"
}
}
}
}
}
JSON スキーマモデルを使用するフィールドの場合、以下の JSON のサンプルに示すように、afBoundData オブジェクトのデータは事前入力されます。これは、1 つ以上の連結されていないテキストフィールドでアダプティブフォームを事前入力する場合に使用できます。以下は afData/afBoundData
ラッパーが含まれるデータの一例です。
{
"afData": {
"afUnboundData": {
"data": { "textbox": "Ignorance is bliss :) " }
},
"afBoundData": {
"data": { {
"user": {
"address": {
"city": "Noida",
"country": "India"
}}}}}}}
以下は afData/afBoundData
ラッパーが含まれない場合の一例です。
{
"user": {
"address": {
"city": "Noida",
"country": "India"
}
}
}
連結パネル(サイドキックまたは「データソース」タブからコンポーネントをドラッグして作成された、空でない bindRef を含むパネル)で、連結されていないフィールドを使用すると、 not 非連結フィールドのデータが失われる可能性があるので、お勧めします。 特に連結されていないフィールドに対しては、フォーム全体に一意のフィールド名を付けることをお勧めします。
フォームモデルが含まれていないアダプティブフォームの場合、すべてのフィールドのデータは、<afUnboundData> tag
の <data>
タグの下にあります。
また、次の点にも注意してください。
各種フィールドに送信されたユーザーデータのための XML タグは、フィールド名を使用して生成されます。したがって、フィールド名は一意である必要があります。
<?xml version="1.0" encoding="UTF-8"?><afData>
<afUnboundData>
<data>
<radiobutton>2</radiobutton>
<repeatable_panel_no_form_model>
<numericbox>12</numericbox>
</repeatable_panel_no_form_model>
<repeatable_panel_no_form_model>
<numericbox>21</numericbox>
</repeatable_panel_no_form_model>
<checkbox>2</checkbox>
<textbox>Nopes</textbox>
</data>
</afUnboundData>
<afBoundData/>
</afData>
デフォルトの事前入力サービス設定の alloweddataFileLocations
プロパティを使用すると、データファイルの場所またはデータファイルの場所を表す正規表現(regex)を設定できます。
以下の JSON ファイルにサンプルが表示されています。
{
"alloweddataFileLocations": "`file:///C:/Users/public/Document/Prefill/.*`"
}
設定の値をセットするには、AEM SDK を使用して OSGi 設定を生成し、Cloud Service インスタンスに設定をデプロイします。
連結された(フォームスキーマ)フィールドや連結されていないフィールドは通常、同じアダプティブフォームに作成されます。ただし、連結が繰り返し可能な場合は、次のような例外があります。
連結されていないフィールドにエンドユーザーが入力したデータ内で、連結されたフィールドと連結されていないフィールドが重なっている場合、それらのフィールドを混在させないでください。 可能な場合は、スキーマまたは XFA フォームテンプレートを変更し、連結されていないフィールドのエントリを追加して、連結されたデータも、送信されたデータ内の他のフィールドと同様に使用できるようにする必要があります。
アダプティブフォームは、有効な正規表現で設定されている場合、次のプロトコルを介して事前入力データ形式のユーザーデータを事前入力できます。
http
https://`servername`/content/forms/af/xml.html?wcmmode=disabled&dataRef=crx:///tmp/fd/af/myassets/sample.xml
特定のノードには、jcr:data
と呼ばれるプロパティがあり、データを保持していなければなりません。
https://`servername`/content/forms/af/someAF.html?wcmmode=disabled&dataRef=file:///C:/Users/form-user/Downloads/somesamplexml.xml
参照元ファイルは、同じサーバー上になければなりません。
https://`servername`/content/forms/af/xml.html?wcmmode=disabled&dataRef=https://servername/somesamplexmlfile.xml
https://`servername`/content/forms/af/abc.html?wcmmode=disabled&dataRef=service://[SERVICE_NAME]/[IDENTIFIER]
認証パラメーターの引き渡しはサポートされていません。
以下のサンプルコードが示すように、data
属性が XML または JSON を含む文字列である、slingRequest
の data
属性を設定することもできます(以下は XML が含まれている場合の例です)。
<%
String dataXML="<afData>" +
"<afUnboundData>" +
"<data>" +
"<first_name>"+ "Tyler" + "</first_name>" +
"<last_name>"+ "Durden " + "</last_name>" +
"<gender>"+ "Male" + "</gender>" +
"<location>"+ "Texas" + "</location>" +
"</data>" +
"</afUnboundData>" +
"</afData>";
slingRequest.setAttribute("data", dataXML);
%>
すべてのデータを含む単純な XML または JSON 文字列を記述し、slingRequest に設定できます。 これは、slingRequest data 属性を設定するページに含むすべてのコンポーネントのレンダラー JSP で、簡単にできます。
例えば、特定のタイプのヘッダーを持つページに特定のデザインを使用する場合などです。 これを達成するには、頁コンポーネントに含んで、header.jsp
属性を設定することができる独自の data
を作成します。
例えば、Facebook、Twitter、LinkedIn などのソーシャルアカウントを使用して、ログイン時にデータを事前入力するとします。この場合、header.jsp
ユーザーアカウントからデータを取得し、データパラメーターを設定するに単純な JSP を含めることができます。
prefill-page component.zip
ファイルを取得
ページコンポーネントのサンプル prefill.jsp
事前定義されたソースからデータを頻繁に読み取る必要がある場合は、カスタム事前入力サービスを使用できます。事前入力サービスでは、定義済みデータソースからデータを読み取り、事前入力データファイルの内容を、アダプティブフォームのフィールドに事前入力します。事前入力データをアダプティブフォームと永続的に関連付ける場合にも役立ちます。
事前入力サービスは OSGi サービスで、OSGi バンドルを使用してパッケージ化します。OSGi バンドルを作成し、アップロードし、AEM Forms バンドルにインストールします。バンドルの作成を開始する前に、以下を行います。
ボイラープレートパッケージをダウンロードします
データ(事前入力データ)ファイルを crx-repository に配置します。ファイルは crx-repository の \contents フォルダー内の任意の場所に配置できます。
ボイラープレートパッケージ(サンプルの事前入力サービスパッケージ)には、AEM Forms 事前入力サービスのサンプル実装が含まれています。コードエディターでテンプレートパッケージを開きます。 例えば、Eclipse でテンプレートプロジェクトを開いて編集します。 コードエディターでテンプレートパッケージを開いた後、次の手順を実行してサービスを作成します。
src\main\java\com\adobe\test\Prefill.javaファイルを編集用に開きます。
コードで、次の値を設定します。
nodePath:
crx-repository の場所を指すノードパス変数には、データ(事前入力)ファイルのパスが含まれています。例:/content/prefilldata.xmllabel:
label パラメーターは、サービスの表示名を指定します。例:Default Prefill ServicePrefill.java
ファイルを保存して閉じます。
AEM Forms Client SDK
パッケージをボイラープレートプロジェクトのビルドパスに追加します。
プロジェクトをコンパイルし、バンドルの.jar を作成します。
事前入力サービスを起動するには、JAR ファイルを AEM Forms web コンソールにアップロードし、サービスをアクティブ化します。サービスはアダプティブフォームエディターに表示されるようになります。事前入力サービスをアダプティブフォームに関連付けるには: