AEM Project Archetype

AEM Project Archetype är en Maven-mall som skapar ett minimalt, metodbaserat Adobe Experience Manager-projekt (AEM) som utgångspunkt för webbplatsen.

TIPS

Den senaste AEM Project Archetype finns på GitHub.

Resurser

  • Arketype Documentation (this document): Översikt över arkitekturen och dess olika moduler.
    • Använda Archetype: Mer information om hur du använder arkitypen och tillgängliga moduler
    • ui.front: Så här använder du modulen för frontendbygge
  • Följande självstudiekurser är baserade på denna arketyp:
    • WKND-plats: Lär dig hur du skapar en ny webbplats.
    • WKND Single Page App: Lär dig hur du skapar en React- eller Angular-webbapp som är helt redigerbar i AEM.

Funktioner

Användning

Om du vill generera ett projekt justerar du följande kommandorad efter dina behov:

mvn -B org.apache.maven.plugins:maven-archetype-plugin:3.2.1:generate \
 -D archetypeGroupId=com.adobe.aem \
 -D archetypeArtifactId=aem-project-archetype \
 -D archetypeVersion=XX \
 -D appTitle="My Site" \
 -D appId="mysite" \
 -D groupId="com.mysite" \
  • Ersätt XX med de senaste versionsnummer för arkivtyp.
  • Ange aemVersion=cloud for AEM as a Cloud Service;
    Ange aemVersion=6.5.0 for Adobes hanterade tjänstereller lokalt.
    Core Components-beroendet läggs bara till för andra versioner än molnbaserade, eftersom Core Components tillhandahålls OTB för AEM as a Cloud Service.
  • Justera appTitle="My Site" för att definiera webbplatsens titel och komponentgrupper.
  • Justera appId="mysite" för att definiera Maven artifactId, komponentens, konfigurations- och innehållsmappens namn samt klientbibliotekens namn.
  • Justera groupId="com.mysite" för att definiera Maven groupId och Java Source Package.
  • Leta upp listan med tillgängliga egenskaper för att se om det finns mer att justera.

Tillgängliga egenskaper

Namn Standard Beskrivning
appTitle Programtitel, kommer att användas för webbplatsens titel och komponentgrupper (t.ex. "My Site").
appId Tekniskt namn, kommer att användas för komponentnamn, konfigurations- och innehållsmappnamn samt klientbiblioteksnamn (t.ex. "mysite").
artifactId ${appId} Base Maven artifact ID (t.ex. "mysite").
groupId Grupp-ID för Bas Maven-grupp (t.ex. "com.mysite"). Värdet måste vara en giltigt namn på Java-paket.
package ${groupId} Källpaket för Java (t.ex. "com.mysite").
version 1.0-SNAPSHOT Projektversion (t.ex. 1.0-SNAPSHOT).
aemVersion cloud AEM (kan cloud for AEM as a Cloud Service; eller 6.5.0, eller 6.4.4 for Adobes hanterade tjänster eller på plats).
sdkVersion latest När aemVersion=cloud en SDK kan anges (t.ex. 2020.02.2265.20200217T222518Z-200130).
includeDispatcherConfig y Innehåller en dispatcherkonfiguration för antingen molnet eller AMS/lokal, beroende på värdet för aemVersion (kan y eller n).
frontendModule general Innehåller en Webpack-modul för klientbibliotek (kan general eller none för vanliga webbplatser, kan angular eller react för en Single Page-app som implementerar SPA).
language en Språkkod (ISO 639-1) för att skapa innehållsstrukturen från (t.ex. en, deu).
country us Landskod (ISO 3166-1) för att skapa innehållsstrukturen från (t.ex. US).
singleCountry y Innehåller en struktur för överordnad innehåll (kan vara y, eller n).
includeExamples n Innehåller en Komponentbibliotek exempelwebbplats (kan y, eller n).
includeErrorHandler n Innehåller en anpassad 404-svarssida som är global till hela instansen (kan y eller n).
includeCommerce n Inkluderar CIF-kärnkomponenter beroenden och genererar motsvarande artefakter.
commerceEndpoint Krävs endast för CIF. Valfri slutpunkt för e-handelssystemets GraphQL-tjänst som ska användas (t.ex. https://hostname.com/grapql).
includeFormscommunications n Inkluderar Forms Core Components beroenden, mallar, formulärdatamodeller, teman och genererar motsvarande artefakter för Forms Communications-program.
includeFormsenrollment n Inkluderar Forms Core Components beroenden, mallar, formulärdatamodeller, teman och genererar motsvarande artefakter för Forms Enrollment-program.
sdkFormsVersion latest När aemVersion=cloud och en av includeFormsenrollment=y eller includeFormscommunications=ykan en Forms SDK-version anges (t.ex. 2020.12.17.02).
datalayer y Aktivera integrering med Adobe-klientdatalager.
amp n Aktivera AMP stöd för genererade projektmallar.
enableDynamicMedia n Aktiverar basen för DynamicMedia-komponenter i projektpolicyinställningar och aktiverar Dynamic Media-funktioner i huvudbildkomponentens policy.
enableSSR n Möjlighet att aktivera SSR för front-end-projektet
precompiledScripts n Alternativ till förkompilera serverskript från ui.apps och bifoga dem till bygget som en sekundär paketartefakt i ui.apps projekt. aemVersion ska anges till cloud.
includeFormsheadless n Inkluderar Forms Core Components beroenden, ui.frontend.react.forms.afoch utan störande artefakter.

Systemkrav

Arketyp AEM as a Cloud Service AEM 6.5 Java SE Maven
40 Kontinuerlig 6.5.7.0+ 8, 11 3.3.9+

Konfigurera den lokala utvecklingsmiljön för AEM as a Cloud Service SDK eller för äldre versioner av AEM.

Kända fel

När du kör i Windows och genererar dispatcherkonfigurationen bör du köra i en förhöjd kommandotolk eller i Windows-undersystemet för Linux (se #329).

När arketypen körs i interaktivt läge (utan -B parameter) kan egenskaperna med standardvärden inte ändras, såvida inte den slutliga bekräftelsen avvisas, som sedan upprepar frågorna genom att inkludera egenskaperna med standardvärden i frågorna (se
ARCHETYPE-308 för mer information).

Du kan inte använda den här arkitypen i Eclipse när du startar ett nytt projekt med File -> New -> Maven Project sedan genereringsskriptet archetype-post-generate.groovy kommer inte att köras på grund av Eclipse-problem. Du kan komma runt problemet genom att använda ovanstående kommandorad och sedan använda den i Eclipse File -> Import -> Existing Maven Project.

Ytterligare läsning

Mer information om hur du använder arkitypen, inklusive dess fördelar, alternativ och hur dess moduler fungerar, finns i Använda Arketype-dokumentet.

På denna sida