Komma igång - självstudiekurs för utvecklare
I dagens digitala samhälle är det viktigt för alla företag att skapa användarvänliga formulär. Med Edge Delivery Services för AEM Forms kan du skapa formulär med välbekanta verktyg som Google Docs och Microsoft Office.
Dessa formulär skickar data direkt till en Microsoft Excel- eller Google Sheets-fil, vilket gör att du kan använda aktiva ekosystem och stabila API:er för Google Sheets, Microsoft Excel och Microsoft SharePoint för att enkelt bearbeta inlämnade data eller starta ett befintligt arbetsflöde.
AEM Forms har ett block, Adaptive Forms Block, som gör det enkelt att skapa formulär för att hämta in och lagra inhämtade data. Du kan skapa ett nytt AEM-projekt förkonfigurerat med Adaptivt Forms-block .
Den här AEM Forms-självstudiekursen guidar dig genom att skapa, förhandsgranska och publicera egna anpassade formulär med ett nytt Adobe Experience Manager (AEM) Forms-projekt.
Förutsättningar
- Du har ett GitHub-konto och förstår Git-grunderna.
- Du har ett Google- eller Microsoft SharePoint-konto.
- Du förstår grunderna i HTML, CSS och JavaScript.
- Du har installerat Node/npm för lokal utveckling.
Upp med huvudet! I den här självstudien används macOS, Chrome och Visual Studio Code. Stegen kan anpassas för andra inställningar, men skärmbilderna och specifika gränssnittselement kan skilja sig åt beroende på vilket operativsystem, vilken webbläsare och vilken kodredigerare du har valt.
Skapa ett nytt AEM-projekt förkonfigurerat med Adaptive Forms Block
Med AEM Forms-mallen Boilerplate kommer du snabbt igång med ett AEM-projekt som är förkonfigurerat med Adaptive Forms Block. Det är det snabbaste och enklaste sättet att följa AEM bästa praxis och börja skapa formulär.
Kom igång med AEM Forms mall för standarddatabas
-
Skapa en GitHub-databas för ditt AEM-projekt. Så här skapar du databas:
-
Gå till https://github.com/adobe-rnd/aem-boilerplate-forms.
-
Klicka på alternativet Använd den här mallen och välj alternativet Skapa en ny databas. Skärmen Skapa en ny databas öppnas.
-
Välj owner och ange Databasnamn på skärmen Skapa en ny databas. Adobe rekommenderar att databasen är inställd på Offentlig. Välj därför alternativet public och klicka på Skapa databas.
-
-
Installera AEM Code Sync GitHub App i din databas. Installera:
- Gå till https://github.com/apps/aem-code-sync/installations/new.
- På skärmen Installera AEM Code Sync väljer du alternativet Only select Repositories och väljer din nya databas. Klicka på Spara.
note note NOTE Om du använder GitHub Enterprise med IP-filtrering kan du lägga till följande IP-adress i tillåtelselista: 3.227.118.73 Grattis! Du har en ny webbplats som körs på
https://<branch>--<repo>--<owner>.aem.page/
.<branch>
refererar till din GitHub-databas.<repository>
betecknar din GitHub-databas.<owner>
refererar till användarnamnet för ditt GitHub-konto som är värd för din GitHub-databas.
Om filialnamnet till exempel är
main
, databasen ärwefinance
och ägaren ärwkndforms
, kommer webbplatsen att vara igång påhttps://main--wefinance--wkndforms.aem.page
<!—(https://main—weFinance—wkndform.aem.page)—>
Länka din egen innehållskälla
Så här kopierar du exempelinnehållet till din egen innehållsmapp och pekar din GitHub-databas mot din egen innehållsmapp:
-
Skapa en ny mapp specifikt för ditt AEM-innehåll i Google Drive eller Microsoft SharePoint. I det här dokumentet används en mapp som har skapats i Microsoft SharePoint.
-
Dela mappen med Adobe Experience Manager-användaren (forms@adobe.com).
Se till att du har gett Adobe Experience Manager-användaren redigeringsbehörighet för mappen.
-
Kopiera exempelinnehållet till din mapp. Kopiera:
-
Zippa upp den hämtade mappen och kopiera innehållet.
Filerna
nav
ochfooter
definierar den grundläggande layouten för dina sidor och ändras sällan i ett projekt. De har också en särskild struktur som skiljer sig från de flesta andra innehållsfiler. Genom att undersöka dessa filer får du en känsla för hur innehållet är organiserat i AEM Projects. -
Överför dessa filer till Microsoft SharePoint eller Google Drive-mappen.
Kontrollera att du kopierar bladet
enquiry
från exempelinnehållet till din mapp på Google Drive eller Microsoft SharePoint. Den innehåller en struktur för ett exempelformulär.
-
-
Nu när du har konfigurerat innehållsmappen är det dags att länka den till ditt projekt på GitHub som du skapade med AEM Forms Boilerplate tidigare. Ansluta:
-
Gå till GitHub-databasen som du skapade tidigare med AEM Forms Boilerplate.
-
Lägg till filen
fstab.yaml
i rotmappen. -
Lägg till referensen med sökvägen till mappen som du delade med AEM-användaren (forms@adobe.com).
Om du använder Microsoft SharePoint har mappsökvägen följande format:
code language-html https://<tenant>.SharePoint.com/sites/<sp-site>/Shared%20Documents/<folder-name>
Exempel:
code language-html https://adobe.SharePoint.com/sites/wkndforms/Shared%20Documents/wefinance
Mer information om hur du hanterar filer med Microsoft SharePoint finns i Använda Adobe SharePoint.
-
Genomför filen
fsatb.yaml
när du har lagt till referensen så ser allting bra ut. Om du stöter på några byggproblem kan du läsa Felsökning av GitHub-byggproblem.Detta kopplar innehållsmappen till webbplatsen. När du har uppdaterat referensen kan felet"404 Hittades inte" uppstå från början. Det beror på att ditt innehåll inte har förhandsvisats än. I nästa avsnitt beskrivs hur du börjar redigera och förhandsgranska ditt innehåll.
-
Förhandsgranska och publicera ditt innehåll
När du är klar med det sista steget är den nya innehållskällan inte tom, men den syns inte på webbplatsen förrän den befordras till förhandsgranskningen eller live-stadierna. För närvarande kan detta orsaka 404 fel.
Så här förhandsgranskar du opublicerat innehåll:
-
Installera Chrome-tillägget AEM Sidekick.
När du har installerat tillägget på Chrome, glöm inte att fästa det, blir det enklare att hitta det.
-
Om du vill konfigurera Sidekick Chrome-tillägget går du till den tidigare delade Google Drive- eller Microsoft SharePoint-mappen och högerklickar på tilläggsikonen i webbläsarens verktygsfält och väljer
Add this project
.När tillägget är installerat och ditt projekt har lagts till kan du förhandsgranska och publicera ditt innehåll från Google Drive.
-
Markera alla dokument i Microsoft SharePoint- eller Google Drive-mappen. Du kan välja flera dokument genom att hålla ned Ctrl-tangenten (Windows/Linux) eller Cmd-tangenten (Mac) medan du klickar.
-
Klicka på AEM Sidekick-ikonen som är fäst i ditt tilläggsfält för Chrome. Ett verktygsfält visas på skärmen. Du kan välja att förhandsgranska eller publicera ditt innehåll.
Om du kopierade över
index
-,nav
-,footer
- ochenquiry
-filer är alla dessa separata dokument med sina egna förhandsgransknings- och publiceringscykler, så se till att du förhandsgranskar (och publicerar) alla dem.När du förhandsgranskar filerna visas dokumenten på de nya webbläsarflikarna. Om du vill förhandsgranska exempelformuläret går du till följande URL:
code language-html https://<branch>--<repository>--<owner>.aem.live
<branch>
refererar till din GitHub-databas.<repository>
betecknar din GitHub-databas.<owner>
refererar till användarnamnet för ditt GitHub-konto som är värd för din GitHub-databas.
URL för
https://<branch>--<repo>--<owner>.aem.page/enquiry
.Om projektets databas till exempel heter "weFinance", finns den under kontoägaren "wkndform" och du använder huvudgrenen och formulärnamnet
enquiry
, är URLhttps://main--wefinance--wkndform.aem.live/enquiry
.
<!—(https://main—weFinance—wkndform.aem.live/inquiry).—>
Skapa ett formulär
Exempelinnehållet innehåller ett frågeblad som fungerar som mall för frågeformuläret. Varje rad i kalkylbladet representerar ett formulärfält och kolumnrubrikerna definierar fältegenskaperna. Det här exempelformuläret ger dig ett försprång när du skapar formuläret.
helix-default
och shared-aem
kan användas som bladnamn.Vi börjar med att uppdatera en fältetikett. Öppna förfrågningsbladet för redigering, ändra etiketten för skicka-knappen till Let's Talk
och använd AEM Sidekick för att förhandsgranska och publicera filen.
När du förhandsgranskar eller publicerar filen visas en JSON-version av filen på en ny flik. Kopiera förhandsgransknings- (.aem.page) eller publicerings-URL:en (.aem.live) för filen.
Öppna filen enquiry
och ersätt URL:en i formulärblocket med URL:en för filen som kopierades i föregående steg. Kontrollera att URL:en är en hyperlänk.
Använd AEM Sidekick för att förhandsgranska och publicera förfrågningsdokumentet.
Om du vill förhandsgranska det uppdaterade frågeformuläret går du till följande URL:
https://<branch>--<repository>--<owner>.aem.page/enquiry
Etiketten för skicka-knappen uppdateras till Let's Talk
.
<!—(https://main—weFinance—wkndform.aem.live/inquiry)—>
URL: https://main--wefinance--wkndform.aem.live/enquiry
<!—(https://main—weFinance—wkndform.aem.live/inquiry)—>
Mer information om hur du skapar och publicerar ett nytt formulär finns i handboken Skapa ett formulär.
Börja utveckla format och funktionalitet
För att komma igång med en lokal utvecklingsmiljö från AEM på nolltid:
-
Installera AEM CLI: AEM CLI förenklar utvecklingsuppgifter. Låt oss installera det globalt med npm:
code language-bash npm install -g @adobe/aem-cli
-
Klona ditt GitHub-projekt: Klona din projektdatabas från GitHub med följande kommando och ersätt
<owner>
med databasägaren och<repo>
med databasnamnet:code language-none git clone https://github.com/<owner>/<repo>
-
Starta din lokala miljö: Navigera till din projektkatalog och starta den lokala AEM-instansen med ett enda kommando:
code language-none cd <repo> aem up
Mappen Adaptive Forms Block blocks/form
är din spelningsmiljö för formatering och kod för dina formulär! Redigera alla .css
- eller .js
-filer i den här katalogen så ser du ändringarna direkt i webbläsaren.
Är du redo att visa upp din skapelse? Använd Git för att implementera och föra över ändringarna. Detta uppdaterar förhandsgransknings- och produktionsmiljöer som du kan nå på dessa URL:er (ersätt platshållare med projektinformation):
Förhandsgranska: https://<branch>--<repo>--<owner>.aem.page/
Produktion: https://<branch>--<repo>--<owner>.aem.live/
Grattis! Du har konfigurerat den lokala utvecklingsmiljön och distribuerat ändringarna.
Lägg till adaptiv Forms Block i ditt befintliga AEM-projekt
Om du har ett befintligt AEM-projekt kan du integrera det adaptiva Forms-blocket i ditt nuvarande projekt för att komma igång med att skapa formulär.
Integrera:
-
Navigera till AEM Project-databasmappen på din lokala dator.
-
Kopiera och klistra in följande mappar och filer från AEM Forms-originalet i ditt AEM-projekt:
- Mappen formulärblock
- filen form-editor-support.js
- form-editor-support.css fil
-
Navigera till filen
/scripts/editor-support.js
i ditt AEM-projekt och uppdatera den med filen editor-support.js i AEM Forms-mallen -
Navigera till
/models/_section.json
i ditt AEM-projekt och lägg till"form" och"embed-adaptive-form" i komponentarrayen för objektetfilters
:code language-none "filters": [ { "id": "section", "components": [ . . . "form", "embed-adaptive-form" ] }]
-
(Valfritt) Navigera till
/.eslintignore
i ditt AEM-projekt och lägg till nedanför kodraderna:code language-none blocks/form/rules/formula/* blocks/form/rules/model/* blocks/form/rules/functions.js scripts/editor-support.js scripts/editor-support-rte.js
-
(Valfritt) Navigera till
/.eslintrc.js
i ditt AEM-projekt och lägg till nedanför kodraderna i objektetrules
:code language-none 'xwalk/max-cells': ['error', { '*': 4, // default limit for all models 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, }], 'xwalk/no-orphan-collapsible-fields': 'off', // Disable until enhancement is done for Forms properties
-
Öppna terminalen och kör kommandona nedan:
code language-none npm i npm run build:json
note note NOTE Innan du skickar ändringarna till AEM Project-databasen på GitHub måste du se till att filerna component-definition.json
,component-models.json
ochcomponent-filters.json
som finns på rotnivån i AEM-projektet uppdateras med formulärrelaterade objekt. -
Genomför och skicka dessa ändringar till AEM Project-databasen på GitHub.
Så ja! Det adaptiva Forms-blocket ingår nu i ditt AEM-projekt. Du kan börja skapa och lägga till formulär på dina AEM-sidor.
Felsökning av byggproblem med GitHub
Se till att GitHub-byggprocessen blir smidig genom att åtgärda potentiella problem:
-
Resolve Module Path-fel:
Om du får felmeddelandet"Det går inte att lösa sökvägen till modulen "'/scripts/lib-franklin.js'" går du till filen [EDS Project]/blocks/forms/form.js. Uppdatera importsatsen genom att ersätta filen lib-franklin.js med filen aem.js. -
Hantera lintingfel:
Om du skulle stöta på ett lintingfel kan du kringgå dem. Öppna [EDS-projektfilen]/package.json och ändra lint-skriptet från"lint": "npm run lint:js && npm run lint:css"
till"lint": "echo 'skipping linting for now'"
. Spara filen och implementera ändringarna i GitHub-projektet.