Rellenar campos de formulario adaptables

Introducción

Puede rellenar previamente los campos de un formulario adaptable utilizando los datos existentes. Cuando un usuario abre un formulario, los valores de esos campos se rellenan previamente. Para rellenar previamente los datos en un formulario adaptable, haga que los datos del usuario estén disponibles como un archivo XML/JSON de relleno previo en el formato que se ajusta a la estructura de datos de formularios adaptables.

Estructura de los datos de relleno previo

Un formulario adaptable puede tener una combinación de campos enlazados y no enlazados. Los campos enlazados son campos que se arrastran desde la ficha Buscador de contenido y que contienen un valor de propiedad bindRef no vacío en el cuadro de diálogo de edición de campo. Los campos no enlazados se arrastran directamente desde el navegador de componentes de la barra de tareas y tienen un valor bindRef vacío.

Puede rellenar previamente los campos enlazados y no enlazados de un formulario adaptable. Los datos de relleno previo contienen las secciones afBoundData y afUnBoundData para rellenar previamente los campos enlazados y no enlazados de un formulario adaptable. La sección afBoundData contiene los datos de relleno previo para los campos y paneles enlazados. Estos datos deben ser compatibles con el esquema del modelo de formulario asociado:

• Para los formularios adaptables que utilizan la plantilla de formulario XFA, utilice el archivo XML de cumplimentación previa compatible con el esquema de datos de la plantilla XFA.
• Para los formularios adaptables que utilizan esquema XML, utilice el archivo XML de cumplimentación previa compatible con la estructura de esquema XML.
• Para los formularios adaptables que utilizan esquema JSON, utilice el cumplimento previo de JSON compatible con el esquema JSON.
• Para los formularios adaptables que utilizan esquema FDM, utilice el cumplimento previo de JSON compatible con el esquema FDM.
• Para formularios adaptables con sin modelo de formulario, no hay datos enlazados. Cada campo es un campo independiente y se rellena previamente con el XML independiente.

Ejemplo de estructura XML de relleno previo

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

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

Ejemplo de estructura JSON de relleno previo

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

Para los campos enlazados con los mismos campos enlazados o no enlazados con el mismo nombre, los datos especificados en la etiqueta XML o el objeto JSON se rellenan en todos los campos. Por ejemplo, dos campos de un formulario se asignan al nombre textbox en los datos de relleno previo. Durante el tiempo de ejecución, si el primer campo de cuadro de texto contiene "A", entonces "A" se rellena automáticamente en el segundo cuadro de texto. Esta vinculación se denomina vinculación dinámica de campos de formulario adaptables.

Formulario adaptable con plantilla de formulario XFA

La estructura del archivo XML de relleno previo y el código XML enviado para formularios adaptables basados en XFA es la siguiente:

• Prerellenar estructura XML: El formulario adaptable precumplimentado XML para XFA debe ser compatible con el esquema de datos de la plantilla de formulario XFA. Para rellenar previamente los campos independientes, ajuste la estructura XML de relleno previo en una etiqueta /afData/afBoundData.

• Estructura XML enviada: Cuando no se utiliza ningún XML de relleno previo, el XML enviado contiene datos para los campos enlazados y no enlazados en la etiqueta afData wrapper. Si se utiliza un XML de relleno previo, el XML enviado tiene la misma estructura que el XML de relleno previo. Si los inicios XML de relleno previo tienen la etiqueta raíz afData, el XML de salida también tiene el mismo formato. Si el XML de relleno previo no tiene afData/afBoundDataenvolvente y, en su lugar, inicios directamente de la etiqueta raíz de esquema como employeeData, el XML enviado también inicio con la etiqueta employeeData.

Prefill-Submit-Data-ContentPackage.zip

Obtener
FileSample que contiene datos de relleno previo y datos enviados

Formularios adaptables basados en esquemas XML 

La estructura de cumplimentación previa de XML y XML enviado para formularios adaptables basados en el esquema XML es la siguiente:

• Prerellenar estructura XML: El XML de relleno previo debe ser compatible con el Esquema XML asociado. Para rellenar previamente los campos independientes, ajuste la estructura XML de relleno previo en la etiqueta /afData/afBoundData.
• Estructura XML enviada: si no se utiliza ningún XML de relleno previo, el XML enviado contiene datos para los campos enlazados y no enlazados en la etiqueta afData wrapper. Si se utiliza el XML de relleno previo, el XML enviado tiene la misma estructura que el XML de relleno previo. Si las inicios XML de relleno previo tienen la etiqueta raíz afData, el XML de salida tiene el mismo formato. Si el archivo XML de relleno previo no tiene afData/afBoundData envolvente y, en su lugar, inicio directamente desde la etiqueta raíz de esquema como employeeData, el archivo XML enviado también inicio con la etiqueta 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>

Para los campos cuyo modelo es de esquema XML, los datos se rellenan previamente en la etiqueta afBoundData, como se muestra en el ejemplo XML siguiente. Se puede utilizar para anteponer un formulario adaptable a uno o varios campos de texto sin enlazar.

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

Un ejemplo sin el envoltorio afData y afBoundData

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

Formularios adaptables basados en esquema JSON

Para los formularios adaptables basados en el esquema JSON, la estructura de cumplimentar JSON previamente y JSON enviado se describe a continuación. Para obtener más información, consulte Creación de formularios adaptables con el esquema JSON.

• Prerellenar estructura JSON: El JSON de relleno previo debe ser compatible con el Esquema JSON asociado. Opcionalmente, se puede ajustar en el objeto /afData/afBoundData si también se desea rellenar previamente los campos no enlazados.
• Estructura JSON enviada: si no se utiliza JSON de relleno previo, el JSON enviado contiene datos para los campos enlazados y no enlazados en la etiqueta de envoltorio afData. Si se utiliza el JSON de relleno previo, el JSON enviado tiene la misma estructura que el JSON de relleno previo. Si el inicio JSON de relleno previo con el objeto raíz afData, el JSON de salida tiene el mismo formato. Si el JSON de relleno previo no tiene el contenedor afData/afBoundData y, en su lugar, inicios directamente desde el objeto raíz de esquema, como el usuario, el JSON enviado también inicio con el objeto de usuario.

{
    "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"
}}}}}

Para los campos que utilizan el modelo de esquema JSON, los datos se rellenan previamente en el objeto afBoundData, como se muestra en el JSON de ejemplo siguiente. Se puede utilizar para anteponer un formulario adaptable a uno o varios campos de texto sin enlazar. A continuación se muestra un ejemplo de datos con el contenedor afData/afBoundData:

{
  "afData": {
    "afUnboundData": {
      "data": { "textbox": "Ignorance is bliss :) " }
    },
    "afBoundData": {
      "data": { {
   "user": {
    "address": {
     "city": "Noida",
     "country": "India"
}}}}}}}

A continuación se muestra un ejemplo sin contenedor afData/afBoundData:

{
 "user": {
  "address": {
   "city": "Noida",
   "country": "India"
}}}

Formulario adaptable sin modelo de formulario

Para formularios adaptables sin modelo de formulario, los datos de todos los campos se encuentran bajo la etiqueta <data> de <afUnboundData> tag.

Asimismo, tome nota de lo siguiente:

Las etiquetas XML de los datos de usuario enviados para varios campos se generan con el nombre de los campos. Por lo tanto, los nombres de campo deben ser únicos.

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

Configuración del servicio de prerfill mediante Configuration Manager

Para habilitar el servicio de cumplimentación previa, especifique la Configuración predeterminada del servicio de cumplimentación previa en la Configuración de la consola web de AEM. Siga los pasos siguientes para configurar el servicio de relleno previo:

1. Abra Configuración de la consola web de Adobe Experience Manager mediante la dirección URL:
   https://<servidor>:<puerto>/system/console/configMgr

2. Busque y abra Configuración predeterminada del servicio de relleno previo.

   

3. Introduzca la ubicación de datos o un regex (expresión regular) para las ubicaciones de archivos de datos. Ejemplos de ubicaciones válidas de archivos de datos son:

   • file:///C:/Users/public/Document/Prefill/.*
   • https://localhost:8000/somesamplexmlfile.xml
   NOTA

   De forma predeterminada, se permite rellenar previamente mediante archivos crx para todos los tipos de Forms adaptable (XSD, XDP, JSON, FDM y sin modelo de formulario basado). El relleno previo solo se permite con archivos JSON y XML.

4. El servicio de cumplimentación previa ahora está configurado para el formulario.

   NOTA

   El protocolo crx se ocupa de la seguridad de los datos precargados y, por lo tanto, está permitido de forma predeterminada. La cumplimentación previa a través de otros protocolos que utilizan regex genérico puede causar vulnerabilidad. En la configuración, especifique una configuración de URL segura para proteger los datos.

El curioso caso de los paneles repetibles

Generalmente, los campos enlazados (esquema de formulario) y no enlazados se crean en el mismo formulario adaptable, pero las siguientes son algunas excepciones en caso de que el enlace sea repetible:

• Los paneles repetitivos no enlazados no son compatibles con los formularios adaptables que utilizan la plantilla de formulario XFA, el esquema XSD, JSON o el esquema FDM.
• No utilice campos independientes en paneles repetibles enlazados.

Protocolos admitidos para el prefijo de datos de usuario

Los formularios adaptables se pueden rellenar previamente con datos de usuario en formato de datos de relleno previo mediante los siguientes protocolos cuando se configuran con regex válido:

El protocolo crx://

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

El nodo especificado debe tener una propiedad denominada jcr:data y contener los datos.

El protocolo file:// 

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

El archivo referido debe estar en el mismo servidor.

El protocolo https://

https://localhost:4502/content/forms/af/xml.html?wcmmode=disabled&dataRef=https://localhost:8000/somesamplexmlfile.xml

El protocolo service://

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

• SERVICE_NAME hace referencia al nombre del servicio de cumplimentación previa OSGI. Consulte Crear y ejecutar un servicio de relleno previo.
• IDENTIFIER se refiere a cualquier metadato que requiera el servicio de rellenado previo OSGI para recuperar los datos de relleno previo. Un identificador para el usuario que ha iniciado sesión es un ejemplo de metadatos que se pueden utilizar.

Configuración del atributo de datos en slingRequest

También puede establecer el atributo data en slingRequest, donde el atributo data es una cadena que contiene XML o JSON, como se muestra en el código de ejemplo siguiente (Ejemplo es para 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);
%>

Puede escribir una cadena XML o JSON simple que contenga todos los datos y establecerla en slingRequest. Esto se puede hacer fácilmente en el JSP del procesador para cualquier componente, que se desea incluir en la página donde se puede establecer el atributo de datos slingRequest.

Por ejemplo, donde desea un diseño específico para la página con un tipo específico de encabezado. Para lograrlo, puede escribir su propio header.jsp, que puede incluir en el componente de página y establecer el atributo data.

Otro buen ejemplo es un caso de uso en el que le gustaría rellenar previamente los datos de inicio de sesión a través de cuentas sociales como Facebook, Twitter o LinkedIn. En este caso, puede incluir un JSP simple en header.jsp, que recopila datos de la cuenta de usuario y establece el parámetro data.

prefill-page component.zip

Obtener
FileSample prefill.jsp en el componente de página

Servicio de cumplimentación previa personalizado de AEM Forms

Puede utilizar el servicio de cumplimentación previa personalizado para los escenarios, donde siempre se leen datos de un origen predefinido. El servicio de rellenado previo lee datos de orígenes de datos definidos y antepone los campos del formulario adaptable al contenido del archivo de datos de relleno previo. También ayuda a asociar de forma permanente datos prerellenados con un formulario adaptable.

Crear y ejecutar un servicio de relleno previo

El servicio de prerfill es un servicio OSGi y se empaqueta a través del paquete OSGi. Puede crear el paquete OSGi, cargarlo e instalarlo en paquetes de AEM Forms. Antes de empezar a crear el paquete:

• Descargar el SDK de AEM Forms Client

• Descargar el paquete repetitivo

• Coloque el archivo de datos (rellene previamente los datos) en el repositorio crx. Puede colocar el archivo en cualquier ubicación de la carpeta \contents de crx-repository.

Obtener archivo

Crear un servicio de prerelleno

El paquete repetitivo (paquete de servicio de prerelleno de muestra) contiene una implementación de muestra del servicio de prerelleno de AEM Forms. Abra el paquete repetitivo en un editor de código. Por ejemplo, abra el proyecto repetitivo en Eclipse para editarlo. Después de abrir el paquete repetitivo en un editor de código, realice los siguientes pasos para crear el servicio.

1. Abra el archivo src\main\java\com\adobe\test\Prefill.java para editarlo.

2. En el código, establezca el valor de:

   • nodePath: La variable de ruta de nodo que señala a la ubicación de crx-repositorio contiene la ruta del archivo de datos (prerfill). Por ejemplo, /content/prefilldata.xml
   • label: El parámetro label especifica el nombre para mostrar del servicio. Por ejemplo, el servicio Prefill predeterminado

3. Guarde y cierre el archivo Prefill.java.

4. Añada el paquete AEM Forms Client SDK a la ruta de compilación del proyecto repetitivo.

5. Compile el proyecto y cree el archivo .jar para el paquete.

Inicio y uso del servicio de relleno previo

Para inicio del servicio de cumplimentación previa, cargue el archivo JAR en AEM Forms Web Console y active el servicio. Ahora, los inicios de servicio aparecen en el editor de formularios adaptables. Para asociar un servicio de cumplimentación previa a un formulario adaptable:

1. Abra el formulario adaptable en el Editor de Forms y abra el panel Propiedades del Contenedor de formulario.
2. En la consola Propiedades, vaya a AEM Forms contenedor > Básico > Servicio de relleno previo.
3. Seleccione el servicio de relleno predeterminado y haga clic en Guardar. El servicio está asociado al formulario.

Rellenar datos previamente en el cliente

Cuando se rellena previamente un formulario adaptable, el servidor de AEM Forms combina los datos con un formulario adaptable y le envía el formulario rellenado. De forma predeterminada, la acción de combinación de datos tiene lugar en el servidor.

Puede configurar el servidor de AEM Forms para que realice la acción de combinación de datos en el cliente en lugar del servidor. Reduce considerablemente el tiempo necesario para rellenar y procesar formularios adaptables. De forma predeterminada, la función está deshabilitada. Puede habilitarlo desde el Administrador de configuración o la línea de comandos.

• Para habilitar o deshabilitar desde el administrador de configuración:
  1. Abra AEM Administrador de configuración.
  2. Localizar y abrir la configuración del Canal web de comunicación interactiva y formulario adaptable
  3. Habilite la opción Configuration.af.clientside.datamerge.enabled.name
• Para habilitar o deshabilitar desde la línea de comandos:

  • Para habilitar, ejecute el siguiente comando cURL:

    curl -u admin:admin -X POST -d apply=true \ -d propertylist=af.clientside.datamerge.enabled \ -d af.clientside.datamerge.enabled=true \ http://${crx.host}:${crx.port}/system/console/configMgr/Adaptive%20Form%20and%20Interactive%20Communication%20Web%20Channel%20Configuration

  • Para deshabilitar, ejecute el siguiente comando cURL:

    curl -u admin:admin -X POST -d apply=true \ -d propertylist=af.clientside.datamerge.enabled \ -d af.clientside.datamerge.enabled=false \ http://${crx.host}:${crx.port}/system/console/configMgr/Adaptive%20Form%20and%20Interactive%20Communication%20Web%20Channel%20Configuration
    Para aprovechar al máximo los datos rellenados previamente en la opción de cliente, actualice el servicio de relleno previo para devolver FileAttachmentMap y CustomContext