Aan de slag met Edge Delivery Services for AEM Forms met de Universal Editor
Edge Delivery Services for AEM Forms combineert krachtige webservices met WYSIWYG authoring in Universal Editor. In deze handleiding vindt u het maken, aanpassen en publiceren van formulieren die snel worden geladen.
Wat u gaat bereiken
Aan het einde van deze zelfstudie gaat u als volgt te werk:
- Een GitHub-opslagplaats instellen met het Adaptive Forms Block
- Een AEM-site maken die is geïntegreerd met Edge Delivery Services
- Formulieren maken en publiceren met de Universal Editor
- Lokale ontwikkelomgeving configureren
Kies uw pad
Selecteer de benadering die uw scenario aanpast:
Figuur: Visuele gids om u te helpen de juiste implementatieweg kiezen
Vereisten
Voor een vloeiende en geslaagde ervaring met Edge Delivery Services for AEM Forms met de Universal Editor, moet u de volgende voorwaarden controleren en bevestigen voordat u verdergaat:
Toegangsvereisten
- Rekening GitHub: U moet een rekening GitHub met toestemmingen hebben om nieuwe bewaarplaatsen tot stand te brengen. Dit is essentieel voor het beheren van uw projectbroncode en het samenwerken met uw team.
- Toegang van de Authoring van AEM as a Cloud Service: Zorg ervoor u auteur-vlakke toegang tot uw milieu van AEM as a Cloud Service hebt. Deze toegang is vereist voor het maken, bewerken en publiceren van formulieren.
Technische vereisten
- Familiariteit met Git: U zou comfortabel moeten zijn uitvoerend basishandelingen van het Git zoals het klonen bewaarplaatsen, het begaan van veranderingen, en het duwen van updates. Deze vaardigheden zijn fundamenteel voor broncontrole en projectsamenwerking.
- Begrip van de Technologieën van het Web: Een werkende kennis van HTML, CSS, en JavaScript wordt geadviseerd. Deze technologieën vormen de basis van formulieraanpassingen en probleemoplossing.
- Node.js (versie 16 of hoger): Node.js wordt vereist voor lokale ontwikkeling en het runnen bouwt hulpmiddelen. Zorg ervoor dat versie 16 of hoger op uw systeem is geïnstalleerd.
- de Manager van het Pakket (npm of garen): U zult of npm (de Manager van het Pakket van de Knoop) of garen nodig hebben om projectgebiedsdelen en manuscripten te beheren.
Aanbevolen achtergrond
- de Concepten van AEM Sites: Een basisbegrip van AEM Sites, met inbegrip van plaatsstructuur en inhoud creatie, zal u helpen en vormen effectief integreren navigeren.
- Beginselen van het Ontwerp van de Vorm: De vertrouwdheid met beste praktijken in vorm ontwerp-zoals bruikbaarheid, toegankelijkheid, en gegevensbevestiging-zal u toelaten om efficiënte en gebruikersvriendelijke vormen tot stand te brengen.
- Ervaring met WYSIWYG Editors: De vroegere ervaring die redacteurs gebruikt van What You See Is What You Get (WYSIWYG) zal u hefboomwerking de visuele auteursmogelijkheden van de Universele Redacteur efficiënter helpen.
Pad A: Een nieuw project maken met Forms
geadviseerd voor: Nieuwe projecten, piloten, of bewijs-van-concept initiatieven
Gebruik de AEM Forms Boilerplate om uw projectopstelling te versnellen. Deze bouwsteen biedt een gebruiksklare sjabloon die het Adaptive Forms Block naadloos integreert, waarmee u snel formulieren kunt maken en implementeren binnen uw AEM-site.
Overzicht
Als u uw nieuwe project met geïntegreerde formulieren wilt starten, gaat u als volgt te werk:
- Maak een GitHub-opslagplaats met de AEM Forms Boilerplate-sjabloon.
- Stel AEM Code Sync in om de synchronisatie van inhoud tussen AEM en uw repository te automatiseren.
- Vorm de verbinding tussen uw project GitHub en uw milieu van AEM.
- Een nieuwe AEM-site maken en publiceren.
- Formulieren toevoegen en beheren met de Universal Editor.
De volgende secties zullen u door elke stap in detail begeleiden, die een vlotte en efficiënte ervaring verzekeren van de projectopstelling.
-
heb toegang tot het malplaatje van AEM Forms Boilerplate
Cijfer: AEM Forms Boilerplate bewaarplaats met vooraf gevormd Adaptief Blok van Forms -
creeer uw bewaarplaats
- Klik Gebruik dit malplaatje > creeer een nieuwe bewaarplaats
Cijfer: Gebruikend het malplaatje om een nieuwe bewaarplaats tot stand te brengen -
vorm bewaarplaats montages
- Eigenaar: Selecteer uw rekening GitHub of organisatie
- Naam van de Bewaarplaats: Kies een beschrijvende naam (b.v.,
my-forms-project
) - Zichtbaarheid: Selecteer Openbaar (geadviseerd voor Edge Delivery Services)
- Klik creeer Bewaarplaats
Cijfer: Het vormen van uw nieuwe bewaarplaats met openbaar zicht
Bevestiging: bevestig u een nieuwe bewaarplaats GitHub hebt die op het malplaatje van AEM Forms wordt gebaseerd Boilerplate.
Met AEM Code Sync worden wijzigingen in de inhoud automatisch gesynchroniseerd tussen uw AEM-ontwerpomgeving en uw GitHub-opslagplaats.
-
installeer de App GitHub
-
vorm toegangstoestemmingen
- Selecteer slechts uitgezochte bewaarplaatsen
- Kies uw nieuwe opslagplaats
- Klik sparen
Cijfer: Het installeren van de Synchronisatie van de Code van AEM met bewaarplaats-specifieke toestemmingen
Controlepunt: de Synchronisatie van de Code van AEM is nu geïnstalleerd en heeft toegang tot uw bewaarplaats.
Het bestand fstab.yaml
verbindt de GitHub-opslagplaats met de AEM-ontwerpomgeving voor inhoudssynchronisatie.
-
navigeer aan uw bewaarplaats
- Ga naar uw nieuwe GitHub-opslagplaats
- De AEM Forms Boilerplate-bestanden worden weergegeven
-
creeer het fstab.yaml- dossier
- Klik voeg dossier toe > creeer nieuw dossier in de wortelfolder
- Geef het bestand een naam
fstab.yaml
Cijfer: Creërend het fstab.yaml configuratiedossier -
voeg uw de verbindingsdetails van AEM toe
Kopieer en plak de volgende configuratie, waarbij u de plaatsaanduidingen vervangt:
code language-yaml mountpoints: /: https://<aem-author>/bin/franklin.delivery/<owner>/<repository>/main
vervang:
<aem-author>
: De URL van uw AEM as a Cloud Service-auteur (bijvoorbeeldauthor-p12345-e67890.adobeaemcloud.com
)<owner>
: Uw GitHub-gebruikersnaam of -organisatie<repository>
: De naam van uw gegevensopslagruimte
Voorbeeld:
code language-yaml mountpoints: /: https://author-p12345-e67890.adobeaemcloud.com/bin/franklin.delivery/mycompany/my-forms-project/main
Cijfer: Het vormen van het bergpunt voor de integratie van AEM -
zet de configuratie vast
- Voeg een commit message toe: "Add AEM integration configuration"
- Klik nieuw dossier vastleggen
Cijfer: Het vastmaken van de configuratie fstab.yaml
Bevestig Bevestiging: bevestig uw verbinding van de bewaarplaats GitHub aan AEM.
code language-none |
---|
|
-
heb toegang tot de console van AEM Sites
- Aanmelden bij uw AEM as a Cloud Service-ontwerpinstantie
- Ga aan Plaatsen
Cijfer: Toegang tot de console van AEM Sites -
de plaatsverwezenlijking van het Begin
- Klik creëren > Plaats van malplaatje
Cijfer: Creërend een nieuwe plaats van malplaatje -
selecteer het malplaatje van Edge Delivery Services
- Kies het malplaatje van de Plaats van Edge Delivery Services
- Klik daarna
Cijfer: Het selecteren van het de plaatsmalplaatje van Edge Delivery Servicesnote note NOTE niet beschikbaar Malplaatje? Als de Edge Delivery Services-sjabloon niet wordt weergegeven: - Klik Invoer om het malplaatje te uploaden
- De malplaatjes van de download van versies GitHub
-
vorm uw plaats
Voer de volgende gegevens in:
table 0-row-3 1-row-3 2-row-3 3-row-3 Veld Waarde Voorbeeld Titel van de Plaats Beschrijvende naam voor site "Mijn Forms-project" Naam van de Plaats URL-vriendelijke naam "my-forms-project" GitHub URL URL van opslagplaats https://github.com/mycompany/my-forms-project
Cijfer: Het vormen van uw nieuwe plaats van AEM met integratie GitHub -
Volledige plaatsverwezenlijking
- Uw instellingen controleren
- Klik creëren
Cijfer: Bevestigend plaatsverwezenlijkingSucces! Uw AEM-site wordt nu gemaakt en verbonden met GitHub.
-
Open in Universele Redacteur
- Zoek in de Sites-console uw nieuwe site
- Selecteer de pagina
index
- Klik uitgeven
Cijfer: Het openen van uw plaats voor het uitgevenDe Universal Editor wordt op een nieuw tabblad geopend en biedt mogelijkheden voor het schrijven van WYSIWYG.
Figuur: Uw plaats die in Universele Redacteur voor WYSIWYG wordt geopend die uitgeeft
Bevestiging: bevestig uw plaats van AEM klaar voor vorm creatie is.
Door te publiceren maakt u uw site beschikbaar op Edge Delivery Services voor wereldwijde toegang.
-
Snel publiceren van de console van Plaatsen
- Terug naar de AEM Sites-console
- Selecteer uw sitepagina's (of selecteer alles met Ctrl+A)
- Klik Snel publiceren
Figuur: Het selecteren van pagina's voor snel publiceert -
Bevestig het publiceren
- In de bevestigingsdialoog, klik publiceren
Cijfer: Bevestigend publiceer actieAlternatief: u kunt direct van Universele Redacteur ook publiceren gebruikend publiceren knoop.
Cijfer: Het publiceren direct van Universele Redacteur -
toegang tot uw levende plaats
Uw site is nu live op:
code language-none https://<branch>--<repo>--<owner>.aem.page/content/<site-name>/
Verklaarde Structuur URL:
<branch>
: GitHub-vertakking (gewoonlijkmain
)<repo>
: De naam van uw gegevensopslagruimte<owner>
: Uw GitHub-gebruikersnaam of -organisatie<site-name>
: De naam van uw AEM-site
Voorbeeld:
code language-none https://main--my-forms-project--mycompany.aem.page/content/my-forms-project/
Bevestiging: bevestig uw plaats op Edge Delivery Services levend is.
note tip |
---|
TIP |
Patronen URL: |
|
daarna: creeer uw eerste vorm
Pad B: Forms toevoegen aan bestaand project
Best voor: Bestaande AEM Sites met Edge Delivery Services
Als u al een AEM-project hebt met Edge Delivery Services, kunt u formuliermogelijkheden toevoegen door het Adaptive Forms Block te integreren.
Vereisten voor pad B
Als u formulieren wilt integreren in uw bestaande AEM-project, moet u aan de volgende voorwaarden voldoen:
- U hebt een bestaand project van AEM dat gebruikend AEM Boilerplate XWalkwerd gecreeerd.
- U hebt opstelling van het a lokale ontwikkelmilieu
- U hebt toegang tot uw projectopslagplaats, waardoor u wijzigingen kunt klonen, wijzigen en doorvoeren.
De volgende handleiding biedt een gestructureerde aanpak voor het toevoegen van formuliermogelijkheden aan uw bestaande project. Elke stap is ontworpen voor een naadloze integratie en optimale functionaliteit in de Universal Editor-omgeving.
Overzicht
U voert de volgende stappen op hoog niveau uit:
- Kopieer de Adaptive Forms Block-bestanden naar uw project.
- Werk de configuratie van uw project bij om vormcomponenten te erkennen en te steunen.
- Pas de regels ESLint aan om de nieuwe dossiers en coderingspatronen aan te passen.
- Stel uw project samen en leg de wijzigingen vast aan uw opslagplaats.
-
navigeer aan uw lokaal project
code language-bash cd /path/to/your/aem-project
-
Download vereiste dossiers van AEM Forms Boilerplate
Kopieer deze dossiers van de bewaarplaats van AEM Forms Boilerplate:
table 0-row-3 1-row-3 2-row-3 3-row-3 Source Doel Doel blocks/form/
blocks/form/
Functionaliteit van kernformulieren scripts/form-editor-support.js
scripts/form-editor-support.js
Integratie van Universal Editor scripts/form-editor-support.css
scripts/form-editor-support.css
Editor-opmaak -
de redacteurssteun van de Update
- Vervang uw
/scripts/editor-support.js
dossier met redacteur-support.js van AEM Forms Boilerplate
- Vervang uw
Bevestig Bevestiging: bevestig de dossiers van het vormblok in uw project zijn.
-
het sectiemodel van de Update
Open
/models/_section.json
en voeg formuliercomponenten aan de filters toe:code language-json { "filters": [ { "id": "section", "components": [ "text", "image", "button", "form", "embed-adaptive-form" ] } ] }
wat dit doet: laat vormcomponenten in de Universele de componentenplukker van de Redacteur toe.
Bevestig Bevestiging: bevestig vormcomponenten verschijnen in Universele Redacteur.
waarom deze stap: verhindert het verbinden fouten van vorm-specifieke dossiers en vormt juiste bevestigingsregels.
-
Update.eslintignore
Voeg deze regels toe aan
/.eslintignore
:code language-bash # Form block rule engine files blocks/form/rules/formula/* blocks/form/rules/model/* blocks/form/rules/functions.js scripts/editor-support.js scripts/editor-support-rte.js
-
Update.eslintrc.js
Voeg de volgende regels toe aan het
rules
-object in/.eslintrc.js
:code language-javascript { "rules": { // Existing rules... // Form component cell limits 'xwalk/max-cells': ['error', { '*': 4, // default limit form: 15, wizard: 12, 'form-button': 7, 'checkbox-group': 20, checkbox: 19, 'date-input': 21, 'drop-down': 19, email: 22, 'file-input': 20, 'form-fragment': 15, 'form-image': 7, 'multiline-input': 23, 'number-input': 22, panel: 17, 'radio-group': 20, 'form-reset-button': 7, 'form-submit-button': 7, 'telephone-input': 20, 'text-input': 23, accordion: 14, modal: 11, rating: 18, password: 20, tnc: 12 }], // Disable this rule for forms 'xwalk/no-orphan-collapsible-fields': 'off' } }
Bevestiging: bevestig werken ESLint met vormcomponenten.
-
installeer gebiedsdelen en bouwt
code language-bash # Install any new dependencies npm install # Build component definitions npm run build:json
wat dit doet:
- Updates
component-definition.json
uitvoeren met formuliercomponenten - Genereert
component-models.json
met formuliermodellen - Creeert
component-filters.json
met het filtreren regels
- Updates
-
verifieer geproduceerde dossiers
Controleer of deze bestanden in de hoofdmap van het project formuliergerelateerde objecten bevatten:
component-definition.json
component-models.json
component-filters.json
-
verbind en duw veranderingen
code language-bash git add . git commit -m "Add Adaptive Forms Block integration" git push origin main
Bevestiging: bevestig uw project vormmogelijkheden omvat.
daarna: creeer Uw Eerste Vorm
Uw eerste formulier maken
die deze sectie zou moeten volgen:
Deze sectie is relevant voor gebruikers die of Weg A (nieuw project) of Weg B (bestaand project) volgen.
Met uw project dat nu is uitgerust voor het maken van formulieren, kunt u uw eerste formulier maken met de intuïtieve WYSIWYG-ontwerpomgeving van de Universal Editor. De volgende stappen bieden een gestructureerde aanpak voor het ontwerpen, configureren en publiceren van een formulier binnen uw AEM-site.
Overzicht
Het proces voor het maken van een formulier in de Universal Editor bestaat uit verschillende belangrijke fasen:
-
Tussenvoegsel het Adaptieve Blok van de Vorm
Voeg eerst het Adaptief formulierblok toe aan de door u gekozen pagina. -
voeg de Componenten van de Vorm toe
Vul het formulier door componenten in te voegen, zoals tekstvelden, knoppen en andere invoerelementen. -
vorm de Eigenschappen van de Component
Pas de instellingen en eigenschappen van elke component aan aan de vereisten van het formulier aan. -
Voorproef en test Uw Vorm
Gebruik de voorbeeldfunctionaliteit om de weergave en het gedrag van het formulier te valideren voordat u het publiceert. -
publiceer de Bijgewerkte Pagina
Publiceer de pagina nadat deze is bevonden om het formulier beschikbaar te maken voor eindgebruikers.
In de volgende secties vindt u een gedetailleerde handleiding voor elk van deze stappen, zodat u over een vloeiende en effectieve manier beschikt om formulieren te maken.
-
open uw pagina in Universele Redacteur
- Navigeer aan de Sites console in AEM
- Selecteer de pagina waaraan u een formulier wilt toevoegen (bijvoorbeeld
index
) - Klik uitgeven
De pagina wordt geopend in de Universal Editor voor bewerking in WYSIWYG.
-
voeg de Adaptieve component van de Vorm toe
- Open het paneel van de Boom van de Inhoud (linkerzijbalk)
- Ga naar een sectie waar u het formulier wilt toevoegen
- Klik toevoegen (+) pictogram
- Selecteer Aangepaste Vorm van de componentenlijst
Cijfer: Het toevoegen van een Aangepast blok van de Vorm aan uw pagina
Bevestiging: bevestig u een lege vormcontainer hebt.
-
ga aan uw vormblok
- Zoek in de inhoudsstructuur de sectie Adaptief formulier die u zojuist hebt toegevoegd
Cijfer: Het adaptieve blok van de Vorm in de inhoudsboom -
voeg vormcomponenten toe
U kunt componenten op twee manieren toevoegen:
Methode A: Klik om toe te voegen
- Klik toevoegen (+) pictogram in uw vormsectie
- Selecteer componenten van de Adaptieve lijst van Componenten van de Vorm
Methode B: Sleep en Daling
- Componenten rechtstreeks van het deelvenster Componenten naar het formulier slepen
Cijfer: Het toevoegen van componenten aan uw vormgeadviseerde startercomponenten:
- Tekstinvoer (voor naam, e-mail)
- Tekstgebied (voor berichten)
- Verzendknop
-
vorm componenteneigenschappen
-
Een formuliercomponent selecteren
-
Gebruik het paneel van Eigenschappen (juiste sidebar) om te vormen:
- Labels en plaatsaanduidingen
- Validatieregels
- Vereiste veldinstellingen
Cijfer: Het vormen componenteneigenschappen -
-
Voorproef uw vorm
Uw formulier ziet er ongeveer als volgt uit:
Cijfer: De vorm van het voorbeeld die met Universele Redacteur wordt gecreeerd
Bevestiging: bevestig uw vorm klaar voor het publiceren is.
note important |
---|
IMPORTANT |
Vergeet niet uw pagina te publiceren nadat u wijzigingen hebt aangebracht om updates in de browser te zien. |
-
publiceer van Universele Redacteur
- Klik publiceren knoop in Universele Redacteur
Cijfer: Het publiceren van uw vorm van Universele Redacteur -
Bevestig het publiceren
- In de bevestigingsdialoog, klik publiceren
Cijfer: Bevestigend publiceer actieU ziet een succesbericht waarin de publicatie wordt bevestigd.
Cijfer: Succesvolle publicatiebevestiging -
Mening uw levende vorm
Uw formulier is nu live op:
code language-none https://<branch>--<repo>--<owner>.aem.page/content/<site-name>/
Voorbeeld URL:
code language-none https://main--my-forms-project--mycompany.aem.page/content/my-forms-project/
Cijfer: Uw gepubliceerde vormpagina op Edge Delivery Services
Gefeliciteerd! Uw formulier is nu live en klaar om opmerkingen te verzamelen.
Volgende stappen
Nu u een werkformulier hebt, kunt u:
- pas het stileren door CSS en de dossiers van JavaScript uit te geven aan
- voeg geavanceerde vormeigenschappen als bevestigingsregels en voorwaardelijke logica toe
- opstelling lokale ontwikkeling voor snellere herhaling
- creeer standalone vormen voor specifieke gebruiksgevallen
Lokale ontwikkelomgeving instellen
Best voor: Ontwikkelaars die vorm het stileren en gedrag willen aanpassen
Met een lokale ontwikkelomgeving kunt u wijzigingen aanbrengen en deze direct bekijken zonder de publicatiecyclus te doorlopen.
-
installeer AEM CLI
De AEM CLI vereenvoudigt lokale ontwikkelingstaken:
code language-bash npm install -g @adobe/aem-cli
-
Kloon uw bewaarplaats
code language-bash git clone https://github.com/<owner>/<repo> cd <repo>
Vervang
<owner>
en<repo>
door de werkelijke GitHub-gegevens. -
Begin de lokale ontwikkelingsserver
code language-bash aem up
Hiermee start u een lokale server met hot-reload-mogelijkheden.
-
maak aanpassingen
- Bestanden in de map
blocks/form/
bewerken voor formulieropmaak en -gedrag - Wijzigen
form.css
voor opmaak form.js
bijwerken voor gedrag
zie onmiddellijk veranderingen in uw browser bij
http://localhost:3000
- Bestanden in de map
-
stel uw veranderingen op
code language-bash git add . git commit -m "Custom form styling" git push origin main
Uw wijzigingen zijn beschikbaar op:
- Voorproef:
https://<branch>--<repo>--<owner>.aem.page/content/<site-name>
- Productie:
https://<branch>--<repo>--<owner>.aem.live/content/<site-name>
- Voorproef:
Problemen oplossen
Veelvoorkomende problemen en oplossingen
Probleem: bouwt mislukkingen of het verbinden fouten
Oplossing 1: De Fouten van de handvat het Linting
Als er verbindingsfouten optreden:
-
package.json
openen in de hoofdmap van het project -
Zoek het script
lint
:code language-json "scripts": { "lint": "npm run lint:js && npm run lint:css" }
-
Koppeling tijdelijk uitschakelen:
code language-json "scripts": { "lint": "echo 'skipping linting for now'" }
-
De wijzigingen vastleggen en duwen
Oplossing 2: De Fouten van de Weg van de module
Als u "Kan pad naar module '/scripts/lib-franklin.js' niet omzetten:
-
Navigeren naar
blocks/form/form.js
-
De instructie import bijwerken:
code language-javascript // Change this: import { ... } from '/scripts/lib-franklin.js'; // To this: import { ... } from '/scripts/aem.js';
Probleem: de inzendingen van de vorm werken niet
Oplossingen:
- Controleer of u een verzendknopcomponent hebt
- URL-configuratie van formulieractie controleren
- Formuliervalidatieregels controleren
- Testen in voorvertoningsmodus eerst
Probleem: het stileren kwesties
Oplossingen:
- CSS-bestandspaden controleren in
blocks/form/
- Browser-cache wissen
- CSS-syntaxis verifiëren
- Testen in de lokale ontwikkelomgeving
Probleem: de componenten van de Vorm verschijnen niet in Universele Redacteur
Oplossingen:
- Controleren of AEM Code Sync is geïnstalleerd en uitgevoerd
- Controleer of
fstab.yaml
de juiste URL van de AEM-auteur heeft - Zorg ervoor dat uw AEM-instantie vroege toegang heeft ingeschakeld
component-definition.json
bevestigen bevat formuliercomponenten
Probleem: Veranderingen niet zichtbaar na het publiceren
Oplossingen:
- Wacht op CDN-cache vernieuwen
- Browser cache controleren (modus Incognito/Private proberen)
- Controleren of de juiste URL-indeling wordt gebruikt