Förifyll adaptiva formulärfält prefill-adaptive-form-fields

Adobe rekommenderar att du använder den moderna och utbyggbara datainhämtningen Core Componentsför att skapa nya adaptiva Formseller att lägga till adaptiva 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.

Version
Artikellänk
AEM 6.5
Klicka här
AEM as a Cloud Service
Den här artikeln

Introduktion introduction

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 the-prefill-structure

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 innehåller icke-tomma bindRef-egenskapsvärden i dialogrutan för fältredigering. Obundna fält dras direkt från komponentwebbläsaren i Sidekick och har ett tomt 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. Avsnittet afBoundData 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 som använder XFA-formulärmallen använder du den förifyllda XML-filen som är kompatibel med XFA-mallens dataschema.
  • För Adaptiv Forms som använder XML-schema använder du den förifyllda XML-filen som är kompatibel med XML-schemastrukturen.
  • För adaptiv Forms som använder JSON-schema använder du JSON-prefill 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.
  • Det finns inga bundna data för Adaptiv Forms med ingen formulärmodell. 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 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>

Exempel på JSON-struktur för förifyllning sample-prefill-json-structure

{
   "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 xfa-based-af

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

  • Förifyll XML-struktur: Förifyll XML för XFA-baserat adaptivt formulär måste vara kompatibelt med dataschemat för XFA-formulärmallen. Om du vill förifylla obundna fält omsluter du XML-strukturen för förifyllning till taggen /afData/afBoundData.

  • 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-taggen. 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 rottaggen afData har XML-utdata också samma format. Om XML-förifyllningen inte har afData/afBoundDatawrapper och i stället startar direkt från schemarottaggen som employeeData, börjar den skickade XML-filen också med taggen employeeData.

Prefill-Submit-Data-ContentPackage.zip

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

XML-schemabaserad Adaptiv Forms  xml-schema-af

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

  • Förifyll XML-struktur: XML-förifyllning måste vara kompatibel med associerat 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-taggen. Om XML-förifyllning används har den skickade XML-filen samma struktur som XML-förifyllningen. Om förifylld XML börjar med rottaggen afData har utdata-XML samma format. Om XML-förifyllningen inte har afData/afBoundData-omslutning och i stället börjar direkt från schemarottaggen som employeeData, börjar den skickade XML-koden också med taggen 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>

För fält vars modell är XML-schema är data förifyllda i taggen afBoundData, vilket visas i exemplet på XML 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>
NOTE
Vi rekommenderar att du inte använder obundna fält i bundna paneler (paneler med bindRef som inte är tomma och som har skapats genom att dra komponenter från Sidekick eller fliken Datakällor). Det kan orsaka dataförlust för dessa obundna fält. Vi rekommenderar dessutom att fältnamnen är unika i hela formuläret, särskilt för obundna fält.

Ett exempel utan afData och afBoundData-wrapper 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 schemabaserad Adaptiv Forms json-schema-based-adaptive-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.

  • Förifyll JSON-struktur: 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örifyllning används innehåller den skickade JSON data för både bundna och obundna fält i afData-wrapper-tagg. 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"
    }
  }
}
NOTE
Användning av obundna fält i bundna paneler (paneler med icke-tomma bindRef som har skapats genom att dra komponenter från Sidekick eller fliken Datakällor) rekommenderas inte eftersom det kan orsaka dataförlust i de obundna fälten. Du bör ha unika fältnamn i hela formuläret, särskilt för obundna fält.

Adaptiv form utan formulärmodell adaptive-form-with-no-form-model

För Adaptiv Forms utan formulärmodell finns data för alla fält under taggen <data> 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 configuring-prefill-service-using-configuration-manager

Använd egenskapen alloweddataFileLocations i standardkonfigurationen för förifyllningstjänsten för att ange platsen för datafilerna eller ett regex (reguljärt uttryck) för datafilernas platser.

I följande JSON-fil visas ett exempel:

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

Generera OSGi-konfigurationer med AEM SDK och distribuera konfigurationen till din Cloud Service om du vill ange värden för en konfiguration.

NOTE
  • Som standard är förifyllning tillåtet via crx-filer för alla typer av adaptiva Forms (XSD, XDP, JSON, FDM och utan formulärmodellbaserad). Förifyll tillåts bara med JSON- och XML-filer.
  • CRX-protokollet hanterar förfylld datasäkerhet och är därför tillåtet som standard. Förifyllnad via andra protokoll med generisk regex kan orsaka sårbarhet. I konfigurationen anger du en säker URL-konfiguration för att skydda dina data.

Det nyfikna fallet med repeterbara paneler the-curious-case-of-repeatable-panels

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.
NOTE
Som tumregel ska du inte blanda bundna och obundna fält om de korsas i data som fylls i av användaren i obundna fält. Om det är möjligt bör du ändra schemat eller XFA-formulärmallen och lägga till en post för obundna fält, så att den också blir bunden och dess data är tillgängliga som andra fält i skickade data.

Protokoll som stöds för förifyllning av användardata supported-protocols-for-prefilling-user-data

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

crx:// the-crx-protocol

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 med namnet jcr:data och innehålla data.

file://  the-file-protocol-nbsp

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:// 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]
  • 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.
NOTE
Det går inte att skicka autentiseringsparametrar.

Ställer in dataattribut i slingRequest setting-data-attribute-in-slingrequest

Du kan också ange attributet data i slingRequest, där attributet data ä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 din egen header.jsp, som du kan inkludera i sidkomponenten och ange attributet data.

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 dataparametern.

prefill-page component.zip

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

AEM Forms anpassad förifyllningstjänst aem-forms-custom-prefill-service

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 create-and-run-a-prefill-service

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:

  • Hämta 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 create-a-prefill-service

Mallpaketet (exempelpaketet för förifyllningstjänsten) innehåller exempelimplementering av AEM Forms-förifyllningstjänsten. Ö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 filen Prefill.java.

  4. Lägg till paketet AEM Forms Client SDK i standardmallprojektets byggsökväg.

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

Starta och använda förifyllningstjänsten start-and-use-the-prefill-service

Om du vill starta förifyllningstjänsten överför du JAR-filen till AEM Forms-webbkonsolen och aktiverar 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 AEM Forms-behållaren > Grundläggande > Förifyll tjänst i egenskapskonsolen.
  3. Välj standardtjänsten för förifyllnad och klicka på Save. Tjänsten är kopplad till formuläret.
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab