Aangepaste formuliervelden vooraf invullen prefill-adaptive-form-fields
de Adobe adviseert gebruikend de moderne en verlengbare gegevens vangen Componenten van de Kernvoor het creëren van nieuwe Aangepaste Formsof het toevoegen van Aangepaste Forms aan de pagina's van AEM Sites. Deze componenten betekenen een aanzienlijke vooruitgang in de aanmaak van Adaptive Forms en zorgen voor indrukwekkende gebruikerservaring. In dit artikel wordt een oudere aanpak beschreven voor de auteur Adaptive Forms die gebruikmaakt van stichtingscomponenten.
Inleiding introduction
U kunt de velden van een adaptief formulier vooraf invullen met bestaande gegevens. Wanneer een gebruiker een formulier opent, worden de waarden voor die velden vooraf ingevuld. Als u gegevens vooraf wilt invullen in een adaptief formulier, maakt u de gebruikersgegevens beschikbaar als een vooraf ingevulde XML/JSON in de indeling die voldoet aan de vooraf ingevulde gegevensstructuur van adaptieve formulieren.
Structuur van vooraf ingevulde gegevens the-prefill-structure
Een adaptief formulier kan bestaan uit gebonden en niet-gebonden velden. Gebonden velden zijn velden die worden gesleept vanaf het tabblad Inhoudszoeker en die een niet-lege waarde voor de eigenschap bindRef
bevatten in het dialoogvenster voor het bewerken van velden. Niet-gebonden velden worden rechtstreeks vanuit de deelbrowser van Sidekick gesleept en hebben een lege bindRef
-waarde.
U kunt zowel gebonden als niet-gebonden velden van een adaptief formulier vooraf invullen. De vooraf ingevulde gegevens bevatten de secties afBoundData en afUnBoundData om zowel gebonden als niet-gebonden velden van een adaptief formulier vooraf in te vullen. De sectie afBoundData
bevat de vooraf ingevulde gegevens voor gebonden velden en deelvensters. Deze gegevens moeten voldoen aan het bijbehorende formuliermodelschema:
- Voor adaptieve vormen die het XFA vormmalplaatjegebruiken, gebruik Prefill XML volgzaam met het gegevensschema van het malplaatje XFA.
- Voor adaptieve vormen die schema van XML gebruiken, gebruik Prefill XML volgzaam met de het schemastructuur van XML.
- Voor adaptieve vormen die JSON schemagebruiken, gebruik Prefill JSON volgzaam met het schema JSON.
- Gebruik voor adaptieve formulieren met FDM-schema de Prefill JSON die compatibel is met het FDM-schema.
- Voor adaptieve vormen met geen vormmodel, is er geen gebonden gegevens. Elk veld is een niet-gebonden veld en wordt voorgevuld met de niet-gebonden XML.
Voorbeeld van vooraf ingevulde XML-structuur 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>
Voorbeeld van JSON-structuur vooraf invullen sample-prefill-json-structure
{
"afBoundData": {
"employeeData": { }
},
"afUnboundData": {
"data": {
"textbox": "Hello World",
"numericbox": "12"
}
}
}
Voor gebonden velden met dezelfde bindref- of niet-gebonden velden met dezelfde naam worden de gegevens die zijn opgegeven in de XML-tag of het JSON-object, in alle velden ingevuld. Twee velden in een formulier worden bijvoorbeeld toegewezen aan de naam textbox
in de vooraf ingevulde gegevens. Als tijdens runtime het eerste tekstvak A bevat, wordt A automatisch ingevuld in het tweede tekstvak. Deze koppeling wordt actieve koppeling van adaptieve formuliervelden genoemd.
Adaptief formulier met XFA-formuliersjabloon xfa-based-af
De structuur van vooraf ingevulde XML en de ingediende XML voor op XFA gebaseerde adaptieve formulieren is als volgt:
-
vooraf ingevulde de Structuur van XML: Prefill XML voor op XFA-Gebaseerde adaptieve vorm moet met het gegevensschema van het XFA vormmalplaatje volgzaam zijn. Als u niet-gebonden velden vooraf wilt invullen, plaatst u de vooraf ingevulde XML-structuur in de tag
/afData/afBoundData
. -
Voorgelegde Structuur van XML: Wanneer geen vooraf ingevulde XML wordt gebruikt, bevat voorgelegde XML gegevens voor zowel verbindende als ongebonden gebieden in
afData
omslag markering. Als een vooraf ingevulde XML wordt gebruikt, heeft het voorgelegde XML-bestand dezelfde structuur als de vooraf ingevulde XML. Als de vooraf ingevulde XML begint met de hoofdtagafData
, heeft de uitvoer-XML ook dezelfde indeling. Als vooraf ingevulde XML nietafData/afBoundData
omslag heeft en in plaats daarvan direct van de markering van de schemawortel zoalsemployeeData
begint, begint voorgelegde XML ook met deemployeeData
markering.
Prefill-Submit-Data-ContentPackage.zip
krijgt Dossier
Voorbeeld met vooraf ingevulde gegevens en verzonden gegevens
Adaptieve formulieren op basis van een XML-schema xml-schema-af
De structuur van vooraf ingevulde XML en verzonden XML voor adaptieve formulieren op basis van het XML-schema is als volgt:
- vooraf ingevulde structuur van XML: Prefill XML moet volgzaam aan het bijbehorende Schema van XML zijn. Als u niet-gebonden velden vooraf wilt invullen, plaatst u de vooraf ingevulde XML-structuur in de tag /afData/afBoundData.
- Voorgelegde structuur van XML: als geen vooraf ingevulde XML wordt gebruikt, bevat voorgelegde XML gegevens voor zowel verbindende als ongebonden gebieden in
afData
omslag markering. Als de vooraf ingevulde XML wordt gebruikt, heeft het voorgelegde XML-bestand dezelfde structuur als de vooraf ingevulde XML. Als de vooraf ingevulde XML begint met de hoofdtagafData
, heeft de uitvoer-XML dezelfde indeling. Als de vooraf ingevulde XML nietafData/afBoundData
wrapper heeft en in plaats daarvan direct begint vanaf de hoofdtag van het schema, zoalsemployeeData
, begint de verzonden XML ook met de tagemployeeData
.
<?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>
Voor velden waarvan het model het XML-schema is, worden de gegevens vooraf ingevuld in de tag afBoundData
, zoals in het voorbeeld-XML hieronder wordt getoond. Deze kan worden gebruikt voor het vooraf invullen van een adaptief formulier met een of meer niet-gebonden tekstvelden.
<?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>
bindRef
die zijn gemaakt door componenten te slepen van het tabblad Sidekick of Gegevensbronnen). Hierdoor kunnen gegevens van deze niet-gebonden velden verloren gaan. Daarnaast wordt aanbevolen dat de namen van de velden uniek zijn in het formulier, met name voor niet-gebonden velden.Een voorbeeld zonder de omslag afData en 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>
Adaptieve formulieren op basis van JSON-schema json-schema-based-adaptive-forms
Voor adaptieve formulieren op basis van JSON-schema wordt de structuur van de prefill JSON en de ingediende JSON hieronder beschreven. Voor meer informatie, zie Creërend adaptieve vormen gebruikend schema JSON.
- vooraf ingevulde JSON structuur: Prefill JSON moet met het bijbehorende Schema JSON volgzaam zijn. Naar keuze, kan het in het /afData/afBoundData Voorwerp worden verpakt als u niet verbindende gebieden eveneens wilt vooraf invullen.
- voorgelegde JSON structuur: als geen prefill JSON wordt gebruikt, bevat voorgelegde JSON gegevens voor zowel gebonden als niet gebonden gebieden in afData omslagmarkering. Als de Prefill JSON wordt gebruikt, heeft de verzonden JSON dezelfde structuur als de Prefill JSON. Als de Prefill JSON begint met het afData-hoofdobject, heeft de uitvoer-JSON dezelfde indeling. Als de prefill JSON geen afData/afBoundData omslag heeft en in plaats daarvan direct van het schemawortelvoorwerp zoals gebruiker begint, begint voorgelegde JSON ook met het gebruikersvoorwerp.
{
"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"
}}}}}
Voor velden die het JSON-schemamodel gebruiken, worden de gegevens voorgevuld in het afBoundData-object, zoals in het voorbeeld JSON hieronder wordt getoond. Deze kan worden gebruikt voor het vooraf invullen van een adaptief formulier met een of meer niet-gebonden tekstvelden. Hieronder ziet u een voorbeeld van gegevens met afData/afBoundData
wrapper:
{
"afData": {
"afUnboundData": {
"data": { "textbox": "Ignorance is bliss :) " }
},
"afBoundData": {
"data": { {
"user": {
"address": {
"city": "Noida",
"country": "India"
}}}}}}}
Hieronder ziet u een voorbeeld zonder afData/afBoundData
wrapper:
{
"user": {
"address": {
"city": "Noida",
"country": "India"
}}}
Adaptief formulier zonder formuliermodel adaptive-form-with-no-form-model
Voor adaptieve formulieren zonder formuliermodel staan de gegevens voor alle velden onder de <data>
-tag van <afUnboundData> tag
.
Let ook op het volgende:
De XML-labels voor de gebruikersgegevens die voor verschillende velden worden verzonden, worden gegenereerd met de naam van de velden. De veldnamen moeten daarom uniek zijn.
<?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>
Prefill-service configureren met Configuratiebeheer configuring-prefill-service-using-configuration-manager
Om de prefill dienst toe te laten, specificeer de Standaard Prefill Configuratie van de Dienst in de Configuratie van de Console van het AEM Web. Gebruik de volgende stappen om de Prefill dienst te vormen:
-
Open Adobe Experience Manager Web Console Configuration met de URL:
https://<server>:<port>/system/console/configMgr -
Zoeken en openen Default Prefill Service Configuration .
-
Ga de gegevensplaats of regex (regelmatige uitdrukking) voor de plaatsen van de dossiers van Gegevens in. Voorbeelden van geldige locaties voor gegevensbestanden zijn:
- file:///C:/Users/public/Document/Prefill/.*
- https://localhost:8000/somesamplexmlfile.xml
note note NOTE Prefill wordt standaard toegestaan via crx-bestanden voor alle typen adaptieve Forms (XSD, XDP, JSON, FDM en geen gebaseerd formuliermodel). Vooraf invullen is alleen toegestaan met JSON- en XML-bestanden. -
De prefill-service is nu geconfigureerd voor uw formulier.
note note NOTE Het crx-protocol zorgt voor de beveiliging van vooraf ingevulde gegevens en is daarom standaard toegestaan. Prefilling via andere protocollen met behulp van generieke regex kan kwetsbaarheid veroorzaken. Geef in de configuratie een veilige URL-configuratie op om uw gegevens te beveiligen.
Het merkwaardige geval van herhaalbare deelvensters the-curious-case-of-repeatable-panels
Over het algemeen worden gebonden (formulierschema) en niet-gebonden velden gemaakt in dezelfde adaptieve vorm, maar het volgende is een paar uitzonderingen voor het geval de gebonden velden herhaalbaar zijn:
- Niet-gebonden herhaalbare deelvensters worden niet ondersteund voor adaptieve formulieren met de XFA-formuliersjabloon, XSD, JSON-schema of FDM-schema.
- Gebruik geen niet-gebonden velden in gebonden herhaalbare deelvensters.
Ondersteunde protocollen voor het vooraf invullen van gebruikersgegevens supported-protocols-for-prefilling-user-data
Adaptieve formulieren kunnen worden voorgevuld met gebruikersgegevens in de indeling voor vooraf ingevulde gegevens via de volgende protocollen wanneer ze zijn geconfigureerd met geldige regex:
Het protocol crx:// the-crx-protocol
https://localhost:4502/content/forms/af/xml.html?wcmmode=disabled&dataRef=crx:///tmp/fd/af/myassets/sample.xml
Het opgegeven knooppunt moet een eigenschap met de naam jcr:data
hebben en de gegevens bevatten.
Het protocol file:// the-file-protocol-nbsp
https://localhost:4502/content/forms/af/someAF.html?wcmmode=disabled&dataRef=file:///C:/Users/form-user/Downloads/somesamplexml.xml
Het betreffende bestand moet zich op dezelfde server bevinden.
Het protocol https:// the-http-protocol
https://localhost:4502/content/forms/af/xml.html?wcmmode=disabled&dataRef=https://localhost:8000/somesamplexmlfile.xml
Het protocol service:// the-service-protocol
https://localhost:4502/content/forms/af/abc.html?wcmmode=disabled&dataRef=service://[SERVICE_NAME]/[IDENTIFIER]
- SERVICE_NAME verwijst naar de naam van de prefill dienst OSGI. Verwijs tot stand brengen en in werking stellen de prefill dienst.
- IDENTIFIER verwijst naar om het even welke meta-gegevens die door de Prefill dienst worden vereist OSGI om de Prefill gegevens te halen. Een id voor de aangemelde gebruiker is een voorbeeld van metagegevens die kunnen worden gebruikt.
Gegevenskenmerk instellen in slingRequest setting-data-attribute-in-slingrequest
U kunt het kenmerk data
ook instellen in slingRequest
, waarbij het kenmerk data
een tekenreeks is die XML of JSON bevat, zoals in de voorbeeldcode hieronder wordt getoond (Voorbeeld is voor 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);
%>
U kunt een eenvoudige XML- of JSON-tekenreeks met al uw gegevens schrijven en deze in slingRequest instellen. Dit kan gemakkelijk in uw renderer JSP voor om het even welke component worden gedaan, die u in de pagina wilt omvatten waar u het slingRequest gegevensattribuut kunt plaatsen.
Bijvoorbeeld, waar u een specifiek ontwerp voor uw pagina met een specifiek type van kopbal wilt. Hiervoor kunt u uw eigen header.jsp
schrijven, dat u kunt opnemen in uw paginacomponent en het kenmerk data
instellen.
Een ander goed voorbeeld is een gebruiksgeval waarin u gegevens over aanmelding via sociale accounts, zoals Facebook, Twitter of LinkedIn, vooraf wilt invullen. In dit geval kunt u een eenvoudige JSP in header.jsp
opnemen, die gegevens van de gebruikersrekening haalt en de gegevensparameter plaatst.
prefill-page component.zip
krijgt Dossier
Voorbeeld prefill.jsp in paginacomponent
AEM Forms, aangepaste Prefill-service aem-forms-custom-prefill-service
U kunt de douane vooraf ingevulde dienst voor de scenario's gebruiken, waar u constant gegevens van een vooraf bepaalde bron leest. De Prefill-service leest gegevens uit gedefinieerde gegevensbronnen en vult de velden van het adaptieve formulier vooraf in met de inhoud van het Prefill-gegevensbestand. Hiermee kunt u ook vooraf ingevulde gegevens permanent koppelen aan een adaptief formulier.
Een vooraf ingevulde service maken en uitvoeren create-and-run-a-prefill-service
De prefill dienst is de dienst OSGi en door bundel OSGi verpakt. U maakt de OSGi-bundel, uploadt en installeert deze naar AEM Forms-bundels. Voordat u begint met het maken van de bundel:
-
Het tekstbouwsteenpakket downloaden
-
Plaats het gegevensbestand (vooraf ingevulde gegevens) in crx-bewaarplaats. U kunt het bestand op elke locatie in de map \contents van de crx-opslagplaats plaatsen.
Een vooraf ingevulde service maken create-a-prefill-service
Het bouwsteenpakket (voorbeeldenservicepakket) bevat een voorbeeldimplementatie van de AEM Forms Prefill-service. Open het tekstbouwsteenpakket in een code-editor. Open bijvoorbeeld het bouwsteenproject in Eclipse en bewerk het. Nadat u het bouwsteenpakket in een coderedacteur opent, voer de volgende stappen uit om de dienst tot stand te brengen.
-
Open het bestand src\main\java\com\adobe\test\Prefill.java voor bewerking.
-
Stel in de code de waarde in van:
nodePath:
De knooppuntvariabele die naar de crx-gegevensopslaglocatie wijst, bevat een pad van het gegevensbestand (prefill). Bijvoorbeeld /content/prefilldata.xmllabel:
Met de parameter label wordt de weergavenaam van de service opgegeven. Bijvoorbeeld, de StandaardVooraf ingevulde Dienst
-
Sla het
Prefill.java
-bestand op en sluit het. -
Voeg het pakket
AEM Forms Client SDK
toe aan de bouwstijlweg van het bouwsteenproject. -
Compileer het project en creeer .jar voor de bundel.
De Prefill-service starten en gebruiken start-and-use-the-prefill-service
Als u de Prefill-service wilt starten, uploadt u het JAR-bestand naar de AEM Forms-webconsole en activeert u de service. De service verschijnt nu in de editor voor aangepaste formulieren. Een vooraf ingevulde service koppelen aan een adaptief formulier:
- Open het adaptieve formulier in de Forms Editor en open het deelvenster Eigenschappen voor de Formuliercontainer.
- Navigeer in de eigenschappenconsole naar AEM Forms-container > Basic > Prefill Service.
- Selecteer de standaardvoorgevulde service en klik op Save . De service is gekoppeld aan het formulier.
Gegevens vooraf invullen op client prefill-at-client
Wanneer u een adaptief formulier vooraf instelt, voegt de AEM Forms-server gegevens samen met een adaptief formulier en levert het ingevulde formulier aan u. De handeling voor het samenvoegen van gegevens vindt standaard plaats op de server.
U kunt de AEM Forms-server zo configureren dat de handeling voor het samenvoegen van gegevens wordt uitgevoerd op de client in plaats van op de server. Hierdoor wordt de tijd die nodig is om adaptieve formulieren vooraf in te vullen en weer te geven, aanzienlijk verkort. De functie is standaard uitgeschakeld. U kunt het van de Manager van de Configuratie of bevellijn toelaten.
-
Om van configuratiemanager toe te laten of onbruikbaar te maken:
- Open AEM Configuration Manager.
- Zoek en open het Adaptieve formulier en de Interactieve communicatie Web Channel Configuration
- Schakel de optie Configuration.af.clinentside.datamerge.enabled.name in
-
U kunt als volgt vanaf de opdrachtregel in- of uitschakelen:
-
Voer de volgende opdracht cURL uit om in te schakelen:
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
-
Als u deze optie wilt uitschakelen, voert u de volgende opdracht cURL uit:
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
Om volledig voordeel van prepopulate gegevens bij cliëntoptie te nemen, werk uw prefill dienst bij om FileAttachmentMapen CustomContextterug te keren
-