Bästa tillvägagångssätt för arbete med anpassningsbara formulär best-practices-for-working-with-adaptive-forms

Använd Apache Maven aem-project-archetype för att skapa och hantera struktur för AEM projekt. Den skapar rekommenderade strukturer och mallar för AEM projekt. Dessutom innehåller det system för automatisering och ändringskontroll som underlättar hanteringen av projektet.

• Använd maven archetype:generate för att generera den ursprungliga strukturen.
• Använd maven eclipse:eclipse om du vill generera projektfiler som är förmörkade och importera projektet till förmörkade filer.

Med FileVault-verktyget eller VLT kan du mappa innehållet i en CRX- eller AEM-instans till filsystemet. Den innehåller åtgärder för ändringshantering, som in- och utcheckning av AEM projektinnehåll. Se Så här använder du VLT-verktyget.

Om du använder en Eclipse-integrerad utvecklingsmiljö kan du använda AEM utvecklingsverktyg för smidig integrering av Eclipse IDE med AEM instanser för att skapa AEM program. Mer information finns i AEM för Eclipse.

En adaptiv formulärmall är en specialiserad AEM som definierar struktur och sidhuvud/sidfot-information i ett adaptivt formulär. En mall har förkonfigurerade layouter, format och grundstruktur för ett adaptivt formulär. AEM Forms innehåller färdiga mallar och komponenter som du kan använda för att skapa anpassningsbara formulär. Du kan dock skapa egna mallar och komponenter efter behov. Vi rekommenderar att du samlar in krav för ytterligare mallar och komponenter som du behöver i dina adaptiva formulär. Mer information finns i Anpassa adaptiva formulär och komponenter.

Med AEM Forms kan du skapa anpassningsbara formulär baserade på följande formulärmodeller. Blankettmodellerna fungerar som gränssnitt för datautbyte mellan ett formulär och AEM och ger en XML-baserad struktur för dataflöde både innanför och utanför ett adaptivt formulär. Formulärmodellerna innehåller dessutom regler och begränsningar för anpassningsbara formulär i form av schema- och XFA-begränsningar.

• Ingen: Anpassningsbara formulär som skapas med det här alternativet använder inte någon formulärmodell. Data-XML som genereras från sådana formulär har en platt struktur med fält och motsvarande värden.
• XML- eller JSON-schema: XML- och JSON-scheman representerar den struktur i vilken data produceras eller förbrukas av organisationens serversystem. Du kan koppla ett schema till ett anpassat formulär och använda dess element för att lägga till dynamiskt innehåll i det anpassningsbara formuläret. Elementen i schemat är tillgängliga på fliken Datamodellsobjekt i innehållsläsaren för att skapa adaptiva formulär. Du kan dra och släppa schemaelementen för att skapa formuläret.
• XFA-formulärmall: Det är en idealisk formulärmodell om du har investeringar i XFA-baserade HTML5-formulär. Det är ett direkt sätt att konvertera XFA-baserade formulär till anpassningsbara formulär. Alla befintliga XFA-regler behålls i de tillhörande adaptiva formulären. De färdiga adaptiva formulären har stöd för XFA-konstruktioner, till exempel valideringar, händelser, egenskaper och mönster.
• Formulärdatamodell: Det är att föredra om du vill integrera backend-system som databaser, webbtjänster och AEM användarprofil för att förifylla anpassningsbara formulär och skriva in inlämnade formulärdata i bakomliggande system. Med en redigerare för formulärdatamodell kan du definiera och konfigurera enheter och tjänster i en formulärdatamodell som du kan använda för att skapa adaptiva formulär. Mer information finns i AEM Forms dataintegrering.

AEM Forms har färdiga anpassningsbara formulärmallar som du kan använda för att skapa anpassningsbara formulär. Du kan också skapa egna mallar. AEM innehåller statiska och redigerbara mallar.

• Statiska mallar definieras och konfigureras av utvecklare.
• Redigerbara mallar skapas av författare med hjälp av mallredigeraren. Med mallredigeraren kan du definiera en grundläggande struktur och ursprungligt innehåll i en mall. Alla ändringar i strukturlagret återspeglas i alla formulär som använder den mallen. Det ursprungliga innehållet kan innehålla förkonfigurerat tema, förifyllningstjänst, skicka-åtgärd och så vidare. Dessa inställningar kan dock ändras för ett formulär med formulärredigeraren. Mer information finns i Adaptiva formulärmallar.

Om du vill formatera ett visst fält eller en viss panelinstans använder du infogad formatering. Du kan också definiera en klass i en CSS-fil och ange klassnamnet i komponentens CSS-klassegenskap.

Inkludera ett klientbibliotek i en komponent för att konsekvent tillämpa format på adaptiva formulär eller fragment som använder den komponenten. Mer information finns i Skapa en adaptiv komponent för formulärsidor.

Använd format som har definierats i ett klientbibliotek för att välja adaptiva formulär genom att ange sökvägen till klientbiblioteket i fältet CSS-filsökväg i egenskaperna för den adaptiva formulärbehållaren.

Om du vill skapa ett klientbibliotek med dina format kan du konfigurera den anpassade CSS-filen i Theme Editor-basklienten eller i egenskaperna för formulärbehållaren.

Med adaptiva formulär kan du skapa panellayouter, som responsiva, tabbade, dragspel och guide, för att styra hur formulärkomponenter placeras ut på en panel. Du kan skapa anpassade panellayouter och göra dem tillgängliga för formulärförfattare. Mer information finns i Skapa anpassade layoutkomponenter för anpassade formulär.

Du kan också anpassa specifika adaptiva formulärkomponenter som fält och panellayout.

• Använd Övertäckning AEM funktioner för att ändra en kopia av en komponent. Du bör inte ändra standardkomponenter.
• Om du vill anpassa layouten för färdiga adaptiva formulärkomponenter i /libs skapa anpassade layoutkomponenter utöver standardlayouter.
• Lägg in anpassade interaktiva funktioner genom att skapa anpassade widgetar eller utseenden. Du bör inte ändra standardkomponenter. Mer information finns i Utseenderamverk.

Se Hantera personligt identifierbar information för rekommendationer om hur PII-data ska hanteras.

Använd objektwebbläsaren i sidlisten för att snabbt komma åt fält som är djupa i formulärhierarkin. Du kan använda sökrutan för att söka efter objekt i formulär- eller objektträdet och navigera mellan olika objekt.

Om du vill visa och redigera egenskaperna för en komponent i komponentwebbläsaren i sidofältet markerar du komponenten och klickar på . Du kan också dubbelklicka på en komponent om du vill visa dess egenskaper i egenskapsläsaren.

Använd kortkommandon för att vidta snabba åtgärder i formulären. Se AEM Forms-kortkommandon.

Adaptiva formulärkomponenter rekommenderas för användning endast i adaptiva formulärsidor. Komponenterna är beroende av sin överordnade hierarki. Använd dem därför inte på en AEM sida.

Använd meningsfulla och unika namn för formulärfält och komponenter för att undvika eventuella konflikter när du skriver regler.

Använd this för en komponent att referera till sig själv i ett regeluttryck. Det ser till att regeln förblir giltig även om komponentnamnet ändras. Till exempel, field1.valueCommit script: this.value > 10.

Använd komponentnamn när du refererar till andra formulärkomponenter. Använd value för att hämta värdet för ett fält eller en komponent. Till exempel, field1.value.

Referera komponenter efter en relativ unik hierarki för att undvika konflikter. Till exempel, parentName.fieldName.

När du hanterar komplexa eller ofta använda regler bör du överväga att skriva affärslogik som funktioner i ett separat klientbibliotek som du kan ange och återanvända i adaptiva formulär. Klientbiblioteket ska vara ett självständigt bibliotek och inte ha några externa beroenden, förutom jQuery och Underscore.js. Du kan också använda klientbiblioteket för att framtvinga omvalidering på serversidan av inlämnade formulärdata.

Adaptiva formulär innehåller en uppsättning API:er som du kan använda för att kommunicera med och utföra åtgärder på adaptiva formulär. Några av de viktigaste API:erna är följande. Mer information finns i API-referens för JavaScript-bibliotek för Adaptiv Forms.

• guideBridge.reset(): Återställer ett formulär.

• guideBridge.submit(): Skickar ett formulär.

• guideBridge.setFocus(somExp, focusOption, runCompletionExp): Ställer in fokus på ett fält.

• guideBridge.validate(errorList, somExpression, focus): Validerar ett formulär.

• guideBridge.getDataXML(options): Hämtar formulärdata som XML.

• guideBridge.resolveNode(somExpression): Hämtar ett formulärobjekt.

• guideBridge.setProperty(somList, propertyName, valueList): Anger egenskapen för ett formulärobjekt.

• Du kan dessutom använda följande fältegenskaper:

  • field.value om du vill ändra ett fälts värde.
  • f ield.enabled för att aktivera/inaktivera ett fält.
  • field.visible om du vill ändra synlighet för ett fält.

Anpassa formulärförfattare kan behöva skriva JavaScript-kod för att skapa affärslogik i ett formulär. JavaScript är kraftfullt och effektivt, men det kan troligtvis påverka säkerheten. Därför måste du se till att formulärförfattaren är en betrodd person och det finns processer för att granska och godkänna JavaScript-koden innan ett formulär börjar användas. Administratören kan begränsa åtkomsten till regelredigeraren till användargrupper baserat på deras roll eller funktion. Se Bevilja regelredigeraråtkomst för valda användargrupper.

Du kan använda uttryck i regler för att göra adaptiva formulär dynamiska. Alla uttryck är giltiga JavaScript-uttryck och använder API:er för skriptmodell för adaptiva formulär. Dessa uttryck returnerar värden av vissa typer. Mer information om uttryck och metodtips kring dem finns i Adaptiva formuläruttryck.

Vi rekommenderar att du skapar anpassningsbara formulär med XSD-formulärdatamodell, även när du konverterar en XFA till anpassat formulär, om det är möjligt.

Inkludera endast de fält och paneler i anpassningsbara formulär som hämtar information från användaren. Tänk på att behålla statiskt innehåll så lite som möjligt eller använd URL:er för att öppna dem i ett separat fönster.

Alla formulär har utformats för ett specifikt ändamål, men det finns några vanliga segment i de flesta formulär. Exempel: personuppgifter, adress, anställningsinformation osv. Skapa adaptiva formulärfragment för gemensamma formulärelement och -avsnitt och använda dem i olika formulär. Du kan också spara en panel i ett befintligt formulär som ett fragment. Alla ändringar i ett fragment återspeglas i alla tillhörande adaptiva former. Det främjar samarbete när flera författare kan arbeta samtidigt i olika fragment som utgör ett formulär.

• Precis som adaptiva formulär rekommenderar vi att alla fragmentspecifika format och anpassade skript definieras i klientbiblioteket med hjälp av dialogrutan fragmentbehållare. Försök också att skapa egna fragment som inte är beroende av objekt utanför den.
• Undvik att använda korsfragmentsskript. Om det finns något objekt utanför fragmentet som du måste referera till, kan du försöka göra det objektet till en del av det överordnade formuläret. Om objektet fortfarande måste finnas i ett annat fragment refererar du till det med namnet i skriptet.

Använd Spara och fortsätt med autosparande för att spara det anpassade formuläret regelbundet och göra det möjligt för användare att gå tillbaka senare för att fylla i formuläret.

Konfigurera fragment för att läsa in lager. Vid körning återges fragment som markerats för att läsa in lager endast när de behövs. Det minskar inläsningstiden avsevärt för stora formulär. Den stöds även i fragment med repeterbara paneler. Mer information finns i Konfigurera lazy loading.

• Konfigurera inte lazy loading på fragment i en responsiv rutnätslayout eller i den första panelen.
• Komponenter för bifogade filer och villkor stöds inte i lagerinlästa fragment.
• Markera ett värde i en lat inläst panel som Använd värdet globalt om det värdet används i någon annan del av formuläret, så att värdet är tillgängligt för användning när behållarpanelen tas bort.
• Överväg att skriva synlighetsregler för fragment som ska visas eller döljas baserat på ett villkor.

AEM Forms tillhandahåller en förifyllningstjänst för att läsa data från en fördefinierad XML-datafil och förifylla fälten i ett adaptivt formulär med innehållet i XML-filen för förifyllnad.

XML-koden för förifyllda data måste vara kompatibel med schemat för den formulärmodell som är associerad med det adaptiva formuläret.

Inkludera afBoundedData och afUnBoundedData för att fylla i både bundna och obundna fält i ett adaptivt formulär i förväg i XML.

För anpassningsbara formulär baserade på formulärdatamodell tillhandahåller AEM Forms en färdig tjänst för förifyllning av formulärdatamodell. förifyllningstjänsten söker efter datakällor för datamodellobjekt i det adaptiva formuläret och fyller i fältvärden i förväg när formuläret återges.

Du kan också använda de adaptiva formulären för förifyllnad av filer, krökningar, tjänster och http-protokoll.

AEM Forms har stöd för anpassade förifyllningstjänster som du kan använda som en OSGi-tjänst för att förifylla adaptiva formulär.

Beroende på vilken formulärdatamodell ett anpassat formulär baseras på kan du konfigurera en mall för DoR enligt följande:

• XFA-formulärmall: Använd den associerade XDP-filen som DoR-mall.
• XSD-schema: Använd den associerade XFA-mallen som använder samma XML-schema som det adaptiva formuläret.
• Ingen: Använd autogenererad DoR.

Konfigurera sidhuvud, sidfot, bilder, färg, teckensnitt och så vidare, direkt från fliken Dokument i den adaptiva formulärredigeraren.

Använd DoRService för att generera DoR-koden programmatiskt.

Uteslut dolda fält från DoR.

Använd afAcceptLang begär parameter för att visa DoR i en annan språkinställning.

Använd adaptiva formulärfragment för gemensamma element i olika formulär och lokalisera fragment. Det gör att du kan lokalisera ett fragment en gång och det återspeglas i alla former där det lokaliserade fragmentet används.

Ändringar som att lägga till en ny komponent eller använda ett skript i ett lokaliserat formulär lokaliseras inte automatiskt. Därför måste du slutföra ett formulär innan du lokaliserar det för att undvika flera lokaliseringscykler.

Använd afAcceptLang begär-parameter för att åsidosätta webbläsarens språkområde och återge formuläret i det angivna språkområdet. Följande URL kommer till exempel att tvinga formuläret att återges på japanska, oavsett vilket språk som anges i webbläsarinställningen:

https://[*server*]:[*port*]/<*contextPath*>/<*formFolder*>/<*formName*>.html?wcmmode=disabled&afAcceptLang=ja

AEM Forms har för närvarande stöd för lokalisering av anpassningsbara formulärinnehåll på engelska (en), spanska (es), franska (fr), italienska (it), tyska (de), japanska (ja), portugisiska-brasilianska (pt-BR), kinesiska (zh-CN), kinesiska-taiwanesiska (zh-TW) och koreanska (ko-KR). Du kan dock lägga till stöd för nya språk för adaptiva formulär vid körning. Mer information finns i Stöd för nya språk för lokalisering av adaptiva formulär.

Aktivera HTML-klientbibliotekskomprimering för JavaScript och CSS från Felix Console.

Cachelagra alla klientbibliotek på /etc.clientlibs/fd och eventuella ytterligare anpassade klientbibliotek på AEM Dispatcher för att öka svarstiderna och säkerheten i de publicerade formulären. Mer information finns i Dispatcher.

Cachelagra inte /content/forms/af/ och /content/dam/formsanddocuments/* banor. Mer information om hur du konfigurerar cachning för adaptiva formulär finns i Cachelagra anpassningsbara formulär.

Aktivera HTML via webbserverkomprimeringsmodulen. Mer information finns i Prestandajustering av AEM Forms-server.

Öka antalet anrop per begäran för stora formulär. Se Optimera prestanda för stora och komplexa formulär.

Skapa anpassade felsidor som visas av felhanteraren.

Säker AEM Forms-server.

• Använd nosamplecontent körningsläge för att säkerställa att det inte finns något exempelinnehåll och exempelanvändare distribuerade på produktionsservern. Se Köra AEM i produktionsklart läge.

Behåll stackstorleken till minst 8 GB. Andra inställningar finns i Prestandajustering av AEM Forms-server.

Använd tjänstanvändarsessioner i stället för administratörssessioner för att köra uppgifter på tjänstnivå. Mer information finns i Tjänstautentisering.

Lagra utkastdata: Om du använder funktionen Utkast i adaptiva formulär bör du implementera ett anpassat SPI-gränssnitt (Service Provide Interface) för att lagra utkastdata i en säkrare lagringsplats, som en databas. Mer information finns i Exempel för att integrera komponent för utkast och inlämning med databas.

Lagra inskickningsdata: Om du använder Form Portal Submit Store bör du implementera en anpassad SPI för att lagra data i en databas. Se Exempel för att integrera komponent för utkast och inlämning med databas för en exempelintegrering.

Du kan också skriva en anpassad skicka-åtgärd som lagrar formulärdata och bifogade filer i säker lagring. Se Skriva anpassad skickaåtgärd för anpassningsbara formulär för mer information.