Förifyll adaptiva formulärfält

Adobe rekommenderar att man använder modern och utbyggbar datainhämtning Kärnkomponenter for skapa ny Adaptive Forms eller lägga till adaptiv Forms på AEM Sites-sidor. De här komponenterna utgör ett betydande framsteg när det gäller att skapa adaptiva Forms-filer, vilket ger imponerande användarupplevelser. I den här artikeln beskrivs det äldre sättet att skapa Adaptiv Forms med baskomponenter.

Introduktion

Du kan förifylla fälten i ett adaptivt formulär med befintliga data. När en användare öppnar ett formulär är värdena för dessa fält förifyllda. Om du vill förifylla data i ett adaptivt formulär gör du användardata tillgängliga som förifylld XML/JSON i det format som följer datastrukturen för förifyllnad i Adaptive Forms.

Struktur för förifyllda data

Ett adaptivt formulär kan innehålla en blandning av bundna och obundna fält. Bundna fält är fält som dras från fliken Innehållssökare och som inte är tomma bindRef egenskapsvärde i dialogrutan för fältredigering. Obundna fält dras direkt från komponentwebbläsaren i Sidekick och har ett tomt värde bindRef värde.

Du kan förifylla både bundna och obundna fält i ett adaptivt formulär. Prefill-data innehåller avsnitten afBoundData och afUnBoundData för att förifylla både bundna och obundna fält i ett adaptivt formulär. The afBoundData -avsnittet innehåller förifyllda data för bundna fält och paneler. Dessa data måste vara kompatibla med det associerade formulärmodellschemat:

• För Adaptiv Forms med XFA-formulärmallanvänder du den förifyllda XML-filen som är kompatibel med XFA-mallens dataschema.
• För adaptiv Forms med XML-schemaanvänder du den förifyllda XML-filen som är kompatibel med XML-schemastrukturen.
• För adaptiv Forms med JSON-schemaanvänder du JSON-prefyllnad som är kompatibel med JSON-schemat.
• För adaptiva Forms som använder FDM-schema använder du JSON-prefyllning som är kompatibel med FDM-schemat.
• För adaptiv Forms med ingen formulärmodell, finns det inga bundna data. Varje fält är ett obundet fält och är förifyllt med den obundna XML-koden.

Exempel på XML-struktur för förifyllning

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

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

Exempel på JSON-struktur för förifyllning

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

För bundna fält med samma bindref-fält eller obundna fält med samma namn fylls data som anges i XML-taggen eller JSON-objektet i alla fält. Två fält i ett formulär mappas till exempel till namnet textbox i förifyllda data. Om det första textrutefältet innehåller"A" fylls"A" automatiskt i den andra textrutan under körningen. Denna länkning kallas live-länkning av fält i adaptiva formulär.

Adaptivt formulär med XFA-formulärmall

Strukturen för förifylld XML och inskickad XML för XFA-baserad Adaptive Forms är följande:

• XML-struktur för förifyllning: XML-förifyllnad för XFA-baserad adaptiv form måste vara kompatibel med XFA-formulärmallens dataschema. Om du vill förifylla obundna fält omsluter du XML-strukturen för förifyllning i /afData/afBoundData -tagg.

• Skickad XML-struktur: När ingen förifylld XML används innehåller den skickade XML-filen data för både bundna och obundna fält i afData wrapper-tagg. Om du använder en XML-förifyllning har den skickade XML-filen samma struktur som XML-förifyllningen. Om XML-förifyllningen börjar med afData -taggen har XML-utdata också samma format. Om förifyllnings-XML inte har afData/afBoundDatawrapper och i stället startar direkt från schemats rottagg som employeeDatabörjar den inskickade XML-filen också med employeeData -tagg.

Prefill-Submit-Data-ContentPackage.zip

Hämta fil
Exempel som innehåller förifyllda data och inlämnade data

XML-schemabaserad Adaptiv Forms 

Strukturen för förifylld XML och inskickad XML för Adaptive Forms baserat på XML-schema är följande:

• XML-struktur för förifyllning: XML-förifyllningen måste vara kompatibel med tillhörande XML-schema. Om du vill förifylla obundna fält omsluter du XML-strukturen för förifyllning i taggen /afData/afBoundData.
• Skickad XML-struktur: om ingen förifylld XML används innehåller den skickade XML-filen data för både bundna och obundna fält i afData wrapper-tagg. Om XML-förifyllning används har den skickade XML-filen samma struktur som XML-förifyllningen. Om XML-förifyllningen börjar med afData -taggen har XML-utdata samma format. Om förifyllnings-XML inte har afData/afBoundData wrapper och i stället börja direkt från schemats rottagg som employeeDatabörjar den inskickade XML-filen också med employeeData -tagg.

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

För fält vars modell är XML-schema är data förifyllda i afBoundData -taggen som i XML-exemplet nedan. Den kan användas för att förifylla ett adaptivt formulär med ett eller flera obundna textfält.

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

Ett exempel utan afData och 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 schemabaserad Adaptiv Forms

För Adaptiv Forms baserat på JSON-schema beskrivs strukturen för förifyll JSON och skickad JSON nedan. Mer information finns i Skapa adaptiv Forms med JSON-schema.

• JSON-struktur för förifyllning: JSON för förifyllning måste vara kompatibel med det associerade JSON-schemat. Alternativt kan den kapslas in i /afData/afBoundData-objektet om du även vill förifylla obundna fält.
• Skickad JSON-struktur: Om ingen JSON för förifyllnad används, innehåller den skickade JSON data för både bundna och obundna fält i afData-wrapper-taggen. Om JSON för förifyllning används har den inskickade JSON samma struktur som JSON för förifyllnad. Om JSON för förifyllning börjar med afData-rotobjektet har utdata-JSON samma format. Om JSON-funktionen för förifyllning inte har wrapper afData/afBoundData och i stället startar direkt från schemarotobjektet, till exempel användaren, börjar den skickade JSON-filen också med användarobjektet.

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

För fält som använder JSON-schemamodell är data förifyllda i afBoundData-objektet, vilket visas i exemplet på JSON nedan. Den kan användas för att förifylla ett adaptivt formulär med ett eller flera obundna textfält. Nedan visas ett exempel på data med afData/afBoundData wrapper:

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

Nedan visas ett exempel utan afData/afBoundData wrapper:

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

Adaptiv form utan formulärmodell

För Adaptive Forms utan någon formulärmodell finns data för alla fält under <data> tagg för <afUnboundData> tag.

Observera även följande:

XML-taggarna för användardata som skickas för olika fält genereras med fältnamnet. Därför måste fältnamnen vara unika.

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

Konfigurerar förifyllningstjänst

Använd alloweddataFileLocations egenskapen för Standardkonfiguration för förifyllningstjänst för att ange platsen för datafilerna eller en region (reguljärt uttryck) för datafilernas platser.

I följande JSON-fil visas ett exempel:

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

Så här anger du värden för en konfiguration: Generera OSGi-konfigurationer med AEM SDK och distribuera konfigurationen till din Cloud Service.

Det nyfikna fallet med repeterbara paneler

Vanligtvis skapas bundna (formulärschema) och obundna fält i samma adaptiva form, men följande undantag görs om bindningen är repeterbar:

• Obundna upprepningsbara paneler stöds inte för Adaptive Forms med XFA-formulärmallen, XSD-, JSON-schemat eller FDM-schemat.
• Använd inte obundna fält i bundna repeterbara paneler.

Protokoll som stöds för förifyllning av användardata

Adaptiv Forms kan förifyllas med användardata i förifyllda dataformat via följande protokoll när den konfigureras med giltig regex:

crx://

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

Den angivna noden måste ha en egenskap som kallas jcr:data och lagra data.

file:// 

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

Den refererade filen måste finnas på samma server.

https://

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

service://

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

• SERVICE_NAME refererar till namnet på OSGI-förifyllningstjänsten. Se Skapa och köra en förifyllningstjänst.
• IDENTIFIER avser alla metadata som krävs av OSGI-förifyllningstjänsten för att hämta förifyllda data. En identifierare för den inloggade användaren är ett exempel på metadata som kan användas.

Ställer in dataattribut i slingRequest

Du kan också ange data attribute in slingRequest, där data -attribut är en sträng som innehåller XML eller JSON, vilket visas i exempelkoden nedan (Exempel är för 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);
%>

Du kan skriva en enkel XML- eller JSON-sträng som innehåller alla data och ange den i slingRequest. Detta kan enkelt göras i JSP-återgivningsfilen för alla komponenter som du vill inkludera på sidan där du kan ange dataattributet slingRequest.

Om du till exempel vill ha en särskild design för sidan med en viss typ av sidhuvud. För att uppnå detta kan du skriva en egen header.jspsom du kan ta med i sidkomponenten och ange data -attribut.

Ett annat bra exempel är ett användningsexempel där du vill fylla i data i förväg via sociala konton som Facebook, Twitter eller LinkedIn. I det här fallet kan du inkludera en enkel JSP i header.jsp, som hämtar data från användarkontot och ställer in data-parametern.

prefill-page component.zip

Hämta fil
Exempel på prefill.jsp i sidkomponent

AEM Forms anpassad förifyllningstjänst

Du kan använda en anpassad förifyllningstjänst för scenarierna, där du hela tiden läser data från en fördefinierad källa. Förifyllningstjänsten läser data från definierade datakällor och fyller i fälten i det adaptiva formuläret i förväg med innehållet i datafilen för förifyllnad. Det hjälper dig även att permanent koppla förfyllda data till ett adaptivt formulär.

Skapa och köra en förifyllningstjänst

Förifyllningstjänsten är en OSGi-tjänst och paketeras via OSGi-paketet. Du skapar OSGi-paketet, överför det och installerar det i AEM Forms paket. Innan du börjar skapa paketet:

• Ladda ned AEM Forms Klient-SDK

• Hämta mallpaketet

• Placera datafilen (förifyllda data) i crx-databasen. Du kan placera filen på valfri plats i mappen \contents i crx-database.

Hämta fil

Skapa en förifyllningstjänst

Mallpaketet (exempelpaketet för förifyllningstjänsten) innehåller exempel på implementering av AEM Forms förifyllningstjänst. Öppna mallpaketet i en kodredigerare. Öppna till exempel mallprojektet i Eclipse för redigering. När du har öppnat mallpaketet i en kodredigerare gör du följande för att skapa tjänsten.

1. Öppna src\main\java\com\adobe\test\Prefill.java för redigering.

2. I koden anger du värdet:

   • nodePath: Nodsökvägsvariabeln som pekar på platsen för crx-databasen innehåller sökvägen till datafilen (prefill). Till exempel /content/prefilldata.xml
   • label: Etikettparametern anger tjänstens visningsnamn. Exempel: Standardtjänst för förifyllnad

3. Spara och stäng Prefill.java -fil.

4. Lägg till AEM Forms Client SDK till byggsökvägen för standardprojektet.

5. Kompilera projektet och skapa .jar-filen för paketet.

Starta och använda förifyllningstjänsten

Om du vill starta förifyllningstjänsten överför du JAR-filen till AEM Forms Webbkonsol och aktivera tjänsten. Nu börjar tjänsten visas i Adaptive Forms Editor. Så här associerar du en förifyllningstjänst till ett adaptivt formulär:

1. Öppna det adaptiva formuläret i Forms Editor och öppna egenskapspanelen för formulärbehållaren.
2. Gå till egenskapskonsolen AEM Forms container > Basic > Prefill Service.
3. Välj standardtjänsten för förifyllnad och klicka på Save. Tjänsten är kopplad till formuläret.