Préremplissage des champs de formulaires adaptatifs

Employez les données existantes pour préremplir les champs d’un formulaire adaptatif.

Présentation

Vous pouvez préremplir les champs d’un formulaire adaptatif à l’aide de données existantes. Lorsqu’un utilisateur ouvre un formulaire, les valeurs de ces champs sont préremplies. Pour préremplir les données utilisateur dans un formulaire adaptatif, définissez-les sous la forme d’un fichier XML/JSON prérempli au format respectant la structure de données de préremplissage des formulaires adaptatifs.

Structure of prefill data

Un formulaire adaptatif peut contenir un mélange de champs liés et non liés. Bound fields are fields which are dragged from the Content Finder tab and contain non-empty bindRef property value in the field edit dialog. Les champs non liés sont déplacés directement à partir du navigateur de composant de Sidekick et possède une valeur bindRef vide.

Vous pouvez préremplir les champs liés et non liés d’un formulaire adaptatif. Les données de préremplissage contiennent les sections afBoundData et afUnBoundData pour préremplir les champs liés et non liés d’un formulaire adaptatif. La section afBoundData contient les données de préremplissage pour les champs liés et les panneaux. Ces données doivent être conformes au schéma de modèle de formulaire associé :

  • Pour les formulaires adaptatifs utilisant le modèle de formulaire XFA, le code XML de préremplissage doit être conforme au schéma de données du modèle XFA.
  • Pour les formulaires adaptatifs utilisant le schéma XML, utilisez le code XML de préremplissage compatible avec la structure du schéma XML.
  • Pour les formulaires adaptatifs utilisant le schéma JSON, utilisez le code JSON de préremplissage compatible avec le schéma JSON.
  • Pour les formulaires adaptatifs utilisant le schéma FDM, utilisez le code JSON de préremplissage compatible avec le schéma FDM.
  • Pour les formulaires adaptatifs sans modèle de formulaire, il n’existe aucune donnée liée. Chaque champ est un champ non lié qui est prérempli à l’aide du code XML non lié.

Exemple de structure XML préremplie

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

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

Exemple de structure JSON préremplie

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

Pour les champs liés avec le même bindref ou les champs non liés portant le même nom, les données spécifiées dans la balise XML ou l’objet JSON sont insérées dans tous les champs. For example, two fields in a form are mapped to the name textbox in the prefill data. Pendant l’exécution, si la première zone de texte contient « A », « A » est automatiquement inséré dans la deuxième zone de texte. On appelle cette opération liaison directe de champs de formulaires adaptatifs.

Formulaire adaptatif utilisant le modèle de formulaire XFA

La structure du code XML de préremplissage et du code XML envoyé pour les formulaires adaptatifs basés sur XFA est la suivante :

  • Structure XML de préremplissage : le code XML de préremplissage du formulaire adaptatif basé sur XFA doit être conforme au schéma de données du modèle de formulaire XFA. To prefill unbound fields, wrap the prefill XML structure into /afData/afBoundData tag.

  • Structure XML envoyée : si aucun code XML de préremplissage n’est utilisé, le code XML envoyé contient des données pour les champs liés et non liés dans la balise wrapper afData. Si du code XML de préremplissage est utilisé, le code XML envoyé possède la même structure que celui-ci. Si le code XML de préremplissage commence par la balise racine afData, le code XML de sortie possède également le même format. Si le code XML de préremplissage ne dispose pas du wrapper afData/afBoundData et commence plutôt directement par la balise racine du schéma telle que employeeData, le code XML envoyé commence également par la balise employeeData.

Prefill-Submit-Data-ContentPackage.zip

Obtenir un fichierExemple contenant des données de préremplissage et des données envoyées

Formulaires adaptatifs basés sur un schéma XML 

La structure du code XML de préremplissage et du code XML envoyé pour les formulaires adaptatifs basés sur le schéma XML se présente comme suit :

  • Structure XML de préremplissage : le code XML de préremplissage doit être conforme au schéma XML associé. Pour préremplir des champs non liés, placez la structure XML de préremplissage dans la balise /afData/afBoundData.
  • Structure XML envoyée : si aucun code XML de préremplissage n’est utilisé, le code XML envoyé contient des données pour les champs liés et non liés dans la balise afData wrapper. Si du code XML de préremplissage est utilisé, le code XML envoyé possède la même structure que celui-ci. Si le code XML de préremplissage commence par la balise racine afData, le code XML de sortie possède également le même format. Si le code XML de préremplissage ne dispose pas du wrapper afData/afBoundData et commence plutôt directement par la balise racine du schéma telle que employeeData, le code XML envoyé commence également par la balise 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>

Pour les champs dont le modèle est le schéma XML, les données sont remplies dans la balise afBoundData, comme illustré dans l’exemple de code XML ci-dessous. Elle peut servir à préremplir un formulaire adaptatif avec un ou plusieurs champs de texte non liés.

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

Il est recommandé de ne pas utiliser de champs non liés dans les panneaux liés (panneaux avec une valeur bindRef non vides qui ont été créés en faisant glisser des composants depuis Sidekick ou l’onglet Sources de données). Cela peut entraîner une perte des données de ces champs non liés. Il est également recommandé que les noms des champs soient uniques dans le formulaire, notamment pour les champs non liés.

Exemple sans wrapper afData et 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>

Formulaires adaptatifs basés sur un schéma JSON

Pour les formulaires adaptatifs basés sur le schéma JSON, la structure du code JSON de préremplissage et du code JSON envoyé est décrite ci-dessous. Pour plus d’informations, reportez-vous à la section Création de formulaires adaptatifs à l’aide d’un schéma JSON.

  • Structure du préremplissage JSON : le préremplissage JSON doit être conforme au schéma JSON associé. Si vous le souhaitez, il peut être encapsulé dans l’objet /afData/afBoundData si vous souhaitez préremplir également des champs non liés.
  • Structure JSON envoyée : si aucun fichier JSON prérempli n’est utilisé, le fichier JSON envoyé contient des données pour les champs liés et non liés dans la balise wrapper afData. Si le fichier JSON de préremplissage est utilisé, le fichier JSON envoyé a la même structure que le fichier JSON de préremplissage. Si le fichier JSON prérempli début avec l’objet racine afData, le fichier JSON de sortie a le même format. Si le fichier JSON de préremplissage ne dispose pas du wrapper afData/afBoundData et s’début directement à partir de l’objet racine du schéma, tel que user, le fichier JSON envoyé début également avec l’objet utilisateur.
{
    "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"
}}}}}

Pour les champs qui utilisent le modèle de schéma JSON, les données sont remplies dans l’objet afBoundedData, comme illustré dans l’exemple JSON ci-dessous. Il peut servir à préremplir un formulaire adaptatif avec un ou plusieurs champs de texte non liés. Below is an example of data with afData/afBoundData wrapper:

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

Below is an example without afData/afBoundData wrapper:

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

L’utilisation de champs non liés dans les panneaux liés (panneaux avec une valeur bindRef non vides qui ont été créés en faisant glisser des composants du Sidekick ou de l’onglet Sources de données) n’est pas recommandée car elle peut entraîner une perte de données des champs non liés. Il est recommandé d’utiliser des noms de champs uniques dans le formulaire, notamment pour les champs non liés.

Formulaire adaptatif sans modèle de formulaire

For adaptive forms with no form model, the data for all the fields is under the <data> tag of <afUnboundData> tag.

Prenez également en compte les points suivants :

Les balises XML des données utilisateur envoyées pour différents champs sont générées avec le nom des champs. Par conséquent, les noms des champs doivent être uniques.

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

Configuration du service de préremplissage à l’aide de Configuration Manager

Pour activer le service de préremplissage, spécifiez la configuration du service de préremplissage par défaut dans la configuration de la console Web AEM. Suivez les étapes suivantes pour configurer le service de préremplissage :

Remarque

La configuration du service de préremplissage s’applique aux formulaires adaptatifs, aux formulaires HTML5 et aux ensembles de formulaires HTML5.

  1. Open Adobe Experience Manager Web Console Configuration by using the URL:
    https://<serveur>:<port>/system/console/configMgr

  2. Recherchez et ouvrez la configuration de service de préremplissage par défaut.

    prefill_config

  3. Entrez l’emplacement de données ou une expression regex (expression régulière) pour les emplacements de fichiers de données. Voici des exemples d’emplacements de fichier de données valides :

    • file://C:/Users/public/Document/Prefill/.&ast;
    • http://localhost:8000/somesamplexmlfile.xml
    Remarque

    Par défaut, le préremplissage est autorisé par le biais des fichiers crx pour tous les types de Forms adaptative (XSD, XDP, JSON, FDM et sans modèle de formulaire). Le préremplissage est autorisé uniquement avec les fichiers XML et JSON.

  4. Le service de préremplissage est maintenant configuré pour votre formulaire.

    Remarque

    Le protocole crx s’occupe de la sécurité des données préremplies et par conséquent, est activé par défaut. Le préremplissage par le biais d’autres protocoles à l’aide de l’expression regex peut entraîner une vulnérabilité. Dans la configuration, spécifiez une configuration d’URL sécurisée pour protéger vos données.

Cas étrange des panneaux répétables

En règle générale, les champs liés (schéma de formulaire) et non liés sont créés dans un même formulaire adaptatif. Les éléments suivants constituent cependant quelques exceptions lorsque les liaisons sont répétables :

  • Les panneaux répétables non liés ne sont pas pris en charge pour les formulaires adaptatifs utilisant le modèle de formulaire XFA, XSD, le schéma JSON ou le schéma FDM.
  • N’utilisez pas de champs non liés dans les panneaux répétables liés.
Remarque

En règle générale, vous ne devez pas mélanger de champs liés et non liés s’ils sont recoupés dans les données remplies dans les champs non liés par l’utilisateur final. Si possible, vous devez modifier le schéma ou le modèle de formulaire XFA et ajouter une entrée pour les champs non liés pour qu’ils deviennent également liés et que ses données soient disponibles comme tout autre champ dans les données envoyées.

Protocoles pris en charge pour le préremplissage des données utilisateur

Les formulaires adaptatifs peuvent être préremplis avec des données d’utilisateurs au format de données de préremplissage via les protocoles suivants lorsqu’ils sont configurés avec une expression regex valide :

Protocole crx://

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

Le nœud spécifié doit posséder une propriété nommée jcr:data et contenir les données.

Protocole file:// 

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

Le fichier référencé doit se trouver sur le même serveur.

Protocole https://

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

Protocole service://

http://localhost:4502/content/forms/af/abc.html?wcmmode=disabled&dataRef=service://[SERVICE_NAME]/[IDENTIFIER]
  • SERVICE_NAME fait référence au nom du service de préremplissage OSGI. Voir Création et exécution d’un service de préremplissage.
  • IDENTIFIER fait référence à toutes les métadonnées requises par le service de préremplissage OSGI pour récupérer les données de préremplissage. Un identifiant à l’utilisateur connecté est un exemple de métadonnées qui pourraient être utilisées.
Remarque

La transmission des paramètres d’authentification n’est pas prise en charge.

Définition de l’attribut data dans slingRequest

You can also set the data attribute in slingRequest, where the data attribute is a string containing XML or JSON, as shown in the sample code below (Example is for 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);
%>

Vous pouvez écrire une chaîne XML ou JSON simple contenant toutes les données et la définir dans slingRequest. Cette opération peut facilement être effectuée dans le JSP de rendu pour tout composant que vous souhaitez inclure dans la page où vous pouvez définir l’attribut data slingRequest.

Imaginons que vous souhaitez une conception spécifique pour votre page avec un type spécifique d’en-tête. Pour obtenir ce résultat, vous pouvez écrire votre propre fichier header.jsp à inclure dans votre composant de page et définir l’attribut.data

Prenons un autre bon exemple dans lequel vous souhaitez préremplir les données à la connexion par le biais de comptes de réseau social tels que Facebook, Twitter ou LinkedIn. Dans ce cas, vous pouvez inclure un JSP simple dans header.jsp qui récupère les données du compte d’utilisateur et définit le paramètre data.

prefill-page component.zip

Get FileSample prefill.jsp dans le composant de page

Service de préremplissage personnalisé d’AEM Forms

Vous pouvez utiliser le service de préremplissage personnalisé pour les scénarios, où vous lisez en permanence des données à partir d’une source prédéfinie . Le service de préremplissage lit des données à partir des sources de données définies et préremplit les champs du formulaire adaptatif avec le contenu du fichier de données de préremplissage. Il vous permet également d’associer de manière permanente des données de préremplissage à un formulaire adaptatif.

Création et exécution d’un service de préremplissage

Le service de préremplissage est un service OSGi et fait partie du package OSGi. Vous créez le groupe OSGi, vous le chargez et l’installez sur les groupes AEM Forms. Avant de débuter la création du groupe :

Création d’un service de préremplissage

Le package standard (exemple de package de services de préremplissage) contient un exemple d’implémentation du service de préremplissage d’AEM Forms. Ouvrez le package standard dans un éditeur de code. Par exemple, ouvrez le projet standard dans Eclipse pour le modifier. Une fois le package standard ouvert dans un éditeur de code, procédez comme suit pour créer le service.

  1. Ouvrez le fichier src\main\java\com\adobe\test\Prefill.java pour le modifier.

  2. Dans le code, définissez la valeur de :

    • nodePath: La variable node path pointant vers l’emplacement crx-repository contient le chemin d’accès du fichier de données (préremplissage). Par exemple, /content/prefilldata.xml
    • label: Le paramètre label spécifie le nom d’affichage du service. Par exemple, service de préremplissage par défaut
  3. Save and close the Prefill.java file.

  4. Ajoutez le AEM Forms Client SDK package sur le chemin de génération du projet standard.

  5. Compilez le projet et créez le fichier .jar pour le groupe.

Démarrage et utilisation du service de préremplissage

Pour démarrer le service de préremplissage, chargez le fichier JAR dans la console Web d’AEM Forms et activez le service. Désormais, le démarrage du service s’affiche dans l’éditeur de formulaires adaptatifs. Pour associer un service de préremplissage à un formulaire adaptatif :

  1. Ouvrez le formulaire adaptatif dans l’éditeur de formulaires et ouvrez le panneau des propriétés du conteneur de formulaires.
  2. In the Properties console, navigate to AEM Forms container > Basic > Prefill Service.
  3. Sélectionnez le service de préremplissage par défaut et cliquez sur Enregistrer. Le service est associé au formulaire.

Sur cette page