预填自适应表单字段 prefill-adaptive-form-fields

简介 introduction

您可以使用现有数据预填自适应表单的字段。 当用户打开表单时，这些字段的值会预先填充。 要在自适应表单中预填充数据，请按照预填充自适应Forms数据结构所遵循的格式，将用户数据作为预填充XML/JSON提供。

预填充数据的结构 the-prefill-structure

自适应表单可以包含绑定字段和未绑定字段的组合。 绑定字段是从“内容查找器”选项卡拖动的字段，在字段编辑对话框中包含非空的bindRef属性值。 未绑定的字段直接从Sidekick的组件浏览器中拖动，并且具有空的bindRef值。

您可以预填自适应表单的绑定和未绑定字段。 预填充数据包含afBoundData和afUnBoundData部分，用于预填充自适应表单的绑定和未绑定字段。 afBoundData部分包含绑定字段和面板的预填充数据。 此数据必须与关联的表单模型架构兼容：

预填充XML结构示例 sample-prefill-xml-structure

<?xml version="1.0" encoding="UTF-8"?>
<afData>
  <afBoundData>
     <employeeData>
        .
     </employeeData>
  </afBoundData>

  <afUnboundData>
    <data>
      <textbox>Hello World</textbox>
         .
         .
      <numericbox>12</numericbox>
         .
         .
    </data>
  </afUnboundData>
</afData>

预填充JSON结构示例 sample-prefill-json-structure

{
   "afBoundData": {
      "employeeData": { }
   },
   "afUnboundData": {
      "data": {
         "textbox": "Hello World",
         "numericbox": "12"
      }
   }
}

对于同名的绑定字段或未绑定字段，所有字段中都会填充在XML标记或JSON对象中指定的数据。 例如，表单中的两个字段映射到预填充数据中的名称textbox。 在运行时，如果第一个文本框字段包含“A”，则“A”会自动填充到第二个文本框中。 此链接称为自适应表单字段的实时链接。

使用XFA表单模板的自适应表单 xfa-based-af

基于XFA的自适应Forms的预填充XML和提交的XML的结构如下：

Prefill-Submit-Data-ContentPackage.zip

获取文件
包含预填充数据和已提交数据的示例

基于XML架构的自适应Forms  xml-schema-af

基于XML架构的自适应Forms的预填充XML和提交的XML的结构如下：

<?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架构的字段，数据将预填充到afBoundData标记中，如下面的示例XML所示。 它可用于使用一个或多个未绑定的文本字段预填自适应表单。

<?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>

不具有afData和afBoundData包装器的示例 an-example-without-afdata-and-afbounddata-wrapper

<?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架构的自适应Forms json-schema-based-adaptive-forms

对于基于JSON模式的自适应Forms，预填充JSON和提交的JSON的结构描述如下。 有关详细信息，请参阅使用JSON架构创建自适应Forms。

{
  "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架构模型的字段，数据预填充到afBoundData对象中，如下面的示例JSON所示。 它可用于使用一个或多个未绑定的文本字段预填自适应表单。 以下是使用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"
    }
  }
}

无表单模型的自适应表单 adaptive-form-with-no-form-model

对于没有表单模型的自适应Forms，所有字段的数据都在<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>

配置预填充服务 configuring-prefill-service-using-configuration-manager

使用​ 默认预填充服务配置 ​的alloweddataFileLocations属性设置数据文件的位置或数据文件位置的正则表达式。

以下JSON文件显示了一个示例：

  {
  "alloweddataFileLocations": "`file:///C:/Users/public/Document/Prefill/.*`"
  }

要设置配置的值，请使用AEM SDK生成OSGi配置和将配置部署到您的Cloud Service实例。

可重复面板的奇特案例 the-curious-case-of-repeatable-panels

通常，绑定（表单架构）和未绑定字段是在同一自适应表单中创作的，但如果绑定是可重复的，则以下是一些例外情况：

支持预填充用户数据的协议 supported-protocols-for-prefilling-user-data

配置了有效的正则表达式后，可通过以下协议使用预填充数据格式的用户数据预填充自适应Forms：

crx://协议 the-crx-protocol

http
https://`servername`/content/forms/af/xml.html?wcmmode=disabled&dataRef=crx:///tmp/fd/af/myassets/sample.xml

指定的节点必须具有名为jcr:data的属性并保存数据。

file://协议  the-file-protocol-nbsp

https://`servername`/content/forms/af/someAF.html?wcmmode=disabled&dataRef=file:///C:/Users/form-user/Downloads/somesamplexml.xml

引用的文件必须位于同一服务器上。

https://协议 the-http-protocol

https://`servername`/content/forms/af/xml.html?wcmmode=disabled&dataRef=https://servername/somesamplexmlfile.xml

service://协议 the-service-protocol

https://`servername`/content/forms/af/abc.html?wcmmode=disabled&dataRef=service://[SERVICE_NAME]/[IDENTIFIER]

在slingRequest中设置数据属性 setting-data-attribute-in-slingrequest

您还可以在slingRequest中设置data属性，其中data属性是包含XML或JSON的字符串，如下面的示例代码所示（示例为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中进行设置。 可以在任何组件的渲染器JSP中轻松完成此操作，您想要将这些组件包含在可设置slingRequest数据属性的页面中。

例如，您希望为具有特定标题类型的页面使用特定设计。 要实现此目的，您可以编写自己的header.jsp，将其包含在页面组件中并设置data属性。

另一个很好的示例是用例，您想要在通过Facebook、Twitter或LinkedIn等社交帐户登录时预填充数据。 在这种情况下，您可以在header.jsp中包含一个简单的JSP，它从用户帐户中获取数据并设置数据参数。

预填充页面component.zip

获取文件
页面组件中的prefill.jsp示例

AEM Forms自定义预填充服务 aem-forms-custom-prefill-service

您可以对这些方案使用自定义预填充服务，在这些方案中，您会不断从预定义的源中读取数据。 预填充服务从定义的数据源中读取数据，并使用预填充数据文件的内容预填充自适应表单的字段。 它还有助于您将预填数据与自适应表单永久关联。

创建并运行预填充服务 create-and-run-a-prefill-service

预填充服务是一种OSGi服务，通过OSGi捆绑包进行打包。 您可以创建OSGi捆绑包，将其上传并安装到AEM Forms捆绑包。 开始创建捆绑包之前：

获取文件

创建预填充服务 create-a-prefill-service

样板包（示例预填充服务包）包含AEM Forms预填充服务的示例实现。 在代码编辑器中打开样板包。 例如，在Eclipse中打开样板项目进行编辑。 在代码编辑器中打开样板包后，请执行以下步骤，以创建该服务。

启动并使用预填充服务 start-and-use-the-prefill-service

要启动预填充服务，请将JAR文件上载到AEM Forms Web控制台，然后激活该服务。 现在，该服务开始出现在自适应Forms编辑器中。 要将预填充服务与自适应表单关联，请执行以下操作：