Konfigurera en lokal utvecklingsmiljö och ett inledande utvecklingsprojekt

När du konfigurerar och konfigurerar ​ Adobe Experience Manager Forms som ​ Cloud Service -miljö kan du konfigurera utvecklings-, staging- och produktionsmiljöer i molnet. Dessutom kan du konfigurera och konfigurera en lokal utvecklingsmiljö.

Du kan använda den lokala utvecklingsmiljön för att utföra följande åtgärder utan att logga in i molnutvecklingsmiljön:

• Skapa formulär och samhörande resurser (teman, mallar, anpassade överföringsåtgärder med mera)
• Konvertera PDF forms till adaptiv Forms
• Bygg applikationer som ska genereras Kundkommunikation on demand eller i gruppläge.

När ett adaptivt formulär eller relaterade resurser är klara för den lokala utvecklingsinstansen eller ett program att generera [Kundkommunikation] är klart kan du exportera Adaptive Form eller Customer Communications från den lokala utvecklingsmiljön till en Cloud Service-miljö för vidare testning eller gå över till produktionsmiljöer.

Du kan också utveckla och testa anpassad kod som anpassade komponenter och förifyllningstjänst i den lokala utvecklingsmiljön. När den anpassade koden har testats och är klar kan du använda Git-databasen i Cloud Servicens utvecklingsmiljö för att distribuera den anpassade koden.

Om du vill konfigurera en ny lokal utvecklingsmiljö och använda den för att utveckla aktiviteter utför du följande åtgärder i listordning:

• Konfigurera utvecklingsverktyg

• Konfigurera lokala författarinstanser och publiceringsinstanser

• Lägg till Forms-arkiv i lokala utvecklingsinstanser och konfigurera användare

• Konfigurera lokal utvecklingsmiljö för mikrotjänster

• Konfigurera ett utvecklingsprojekt

• Konfigurera lokala Dispatcher-verktyg

Förutsättningar

Du behöver följande program för att konfigurera en lokal utvecklingsmiljö. Ladda ned dessa innan du börjar konfigurera den lokala utvecklingsmiljön:

Ladda ned den senaste versionen av programvara från Software Distribution

Om du vill hämta den senaste versionen av Adobe Experience Manager as a Cloud Service SDK, Experience Manager Forms feature archive (AEM Forms add-on), formulärreferensresurser eller Forms Designer från Programvarudistribution:

1. Logga in på https://experience.adobe.com/#/downloads med din Adobe ID

   OBSERVERA

   Din Adobe-organisation måste ha etablerats för att AEM as a Cloud Service ska kunna hämta den AEM as a Cloud Service SDK:n.

2. Navigera till fliken AEM as a Cloud Service.

3. Sortera efter publicerat datum i fallande ordning.

4. Klicka på den senaste versionen av Adobe Experience Manager as a Cloud Service SDK, Experience Manager Forms feature archive (AEM Forms add-on), formulärreferensmaterial eller Forms Designer.

5. Granska och godkänn slutanvändaravtalet. Tryck på Download -knappen.

Ställ in utvecklingsverktyg för AEM projekt

Adobe Experience Manager Forms-projektet är en anpassad kodbas. Den innehåller kod, konfigurationer och innehåll som distribueras via Cloud Manager till Adobe Experience Manager as a Cloud Service. The AEM Project Maven Archetype innehåller projektets baslinjestruktur.

Konfigurera följande utvecklingsverktyg som ska användas för Adobe Experience Manager utvecklingsprojekt:

• Java™
• Git
• Node.js (npm)
• Maven

Detaljerade anvisningar om hur du ställer in tidigare nämnda utvecklingsverktyg finns i Konfigurera utvecklingsverktyg.

Konfigurera lokal Experience Manager-miljö för utveckling

I Cloud Service SDK finns en QuickStart-fil. Den kör en lokal version av Experience Manager. Du kan köra antingen författaren eller publiceringsinstanserna lokalt.

QuickStart har en lokal utvecklingsupplevelse, men inte alla funktioner i Adobe Experience Manager as a Cloud Service. Så testa alltid funktionerna och koden med Adobe Experience Manager as a Cloud Service utvecklingsmiljö innan funktionerna flyttas till scenen eller produktionen.

Så här installerar och konfigurerar du den lokala Experience Manager-miljön:

• Hämta och extrahera den Adobe Experience Manager as a Cloud Service SDK
• Konfigurera en Author-instans
• Konfigurera en publiceringsinstans

Lägg till Forms-arkiv i lokala Author- och Publish-instanser och konfigurera Forms-specifika användare

Utför följande steg i listad ordning för att lägga till Forms-arkiv i Experience Manager-instanser och konfigurera formulärspecifika användare:

Installera det senaste funktionsarkivet för Forms-tillägg

Adobe Experience Manager Forms as a Cloud Service funktionsarkiv innehåller verktyg för att skapa, formatera och optimera adaptiva Forms i den lokala utvecklingsmiljön. Installera paketet för att skapa ett adaptivt formulär och använda olika funktioner i AEM Forms. Så här installerar du paketet:

1. Hämta och extrahera den senaste AEM Forms arkiv för ditt operativsystem från Programvarudistribution.

2. Navigera till katalogen crx-quickstart/install. Om mappen inte finns skapar du den.

3. Stoppa AEM-instansen genom att placera AEM Forms tilläggsarkiv, aem-forms-addon-<version>.far, i installationsmappen och starta om instansen.

Konfigurera användare och behörigheter

Skapa användare som Form Developer och Form Practitioner och lägga till dessa användare i fördefinierade formulärgrupper för att ge dem nödvändiga behörigheter. Tabellen nedan visar alla typer av användare och fördefinierade grupper för varje typ av formuläranvändare:

Konfigurera lokal utvecklingsmiljö för DoR (Document of Record)

AEM Forms som Cloud Services har en dockningsbaserad SDK-miljö för enklare utveckling av Document of Record och för användning av andra mikrotjänster. Du slipper konfigurera plattformsspecifika binärfiler och anpassningar manuellt. Så här konfigurerar du miljön:

1. Installera och konfigurera Docker:

   • (För Microsoft® Windows) Installera Docker Desktop. Den konfigurerar Docker Engine och docker-compose på din dator.

   • (Apple macOS) Installera Docker Desktop för Mac. Det innehåller Docker Engine, Docker CLI-klient, Docker Compose, Docker Content Trust, Kubernetes och Credential Helper.

   • (För Linux®) Installera Dockningsmotor och Docker Compose på din dator.

   OBSERVERA

   • För Apple macOS tillåtslista du mappar som innehåller lokala AEM Author-instanser.

   • Docker Desktop för Windows har stöd för två backends, Hyper-V
     (äldre) och WSL2 (modern). Fildelning sker automatiskt
     hanteras av Docker när WSL2 används (modern). Du måste
     konfigurera fildelning explicit när Hyper-V används (äldre).

2. Skapa en mapp, till exempel aem-sdk, parallellt med författaren och publiceringsinstanser. Till exempel C:\aem-sdk.

3. Extrahera aem-forms-addon-<version>.zip\aem-forms-addon-native-<version>.zip -fil.

   

4. Skapa en miljövariabel AEM_HOME och peka på en lokal AEM Author-installation. Till exempel C:\aem\author.

5. Öppna sdk.bat eller sdk.sh för redigering. Ställ in AEM_HOME så att det pekar på en lokal AEM Author-installation. Till exempel C:\aem\author.

6. Öppna kommandotolken och navigera till aem-forms-addon-native-<version> mapp.

7. Kontrollera att din lokala AEM Author-instans är igång och körs. Kör följande kommando för att starta SDK:

   • (i Microsoft® Windows) sdk.bat start
   • (i Linux® eller Apple macOS) AEM_HOME=[local AEM Author installation] ./sdk.sh start
   OBSERVERA

   Om du har definierat miljövariabeln i sdk.sh-filen är det valfritt att ange den på kommandoraden. Alternativet att definiera systemvariabeln på kommandoraden ges för att köra kommandot utan att uppdatera gränssnittsskriptet.

   

Du kan nu använda den lokala utvecklingsmiljön för att återge arkivhandlingar. Testa genom att överföra en XDP-fil till miljön och återge den. Till exempel: http://localhost:4502/libs/xfaforms/profiles/default.print.pdf?template=crx:///content/dam/formsanddocuments/cheque-request.xdp konverterar XDP-filen till PDF-dokumentet.

Konfigurera ett utvecklingsprojekt för Forms baserat på Experience Manager-arkitypen

Använd det här projektet för att skapa Adaptiv Forms, distribuera konfigurationsuppdateringar, överlägg, skapa anpassade adaptiva formulärkomponenter, testa och anpassa kod på lokala Experience Manager Forms SDK. När du har testat lokalt kan du distribuera projektet till Experience Manager Forms as a Cloud Service produktions- och icke-produktionsmiljöer. När du distribuerar projektet distribueras även följande AEM Forms-resurser:

Så här ställer du in projektet:

1. Git-databasen för Cloud Manager på din lokala utvecklingsinstans: Din Cloud Manager Git-databas innehåller ett AEM. Den baseras på AEM. Klona din Cloud Manager Git-databas med Git-kontohantering för självbetjäning från användargränssnittet i Cloud Manager för att få projektet i din lokala utvecklingsmiljö. Mer information om hur du kommer åt databasen finns i Åtkomst till databaser.

2. Skapa en Experience Manager Forms som [Cloud Service] projekt: Skapa en Experience Manager Forms som [Cloud Service] projekt baserat på det senaste AEM eller senare. Med denna typ kan utvecklarna enkelt börja utveckla för AEM Forms as a Cloud Service. Den innehåller även några exempelteman och mallar som hjälper dig att snabbt komma igång.

   Öppna kommandotolken och kör nedanstående kommando för att skapa en Experience Manager Forms as a Cloud Service projekt.

   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=40 -D aemVersion="cloud" -D appTitle="Borgo AEM Forms" -D appId="bgaemforms" -D groupId="com.bgaemforms" -D includeFormsenrollment="y" -D includeFormscommunications="y" -D includeExamples="y" -D
   

   Ändra appTitle, appIdoch groupId i ovanstående kommando för att återspegla din miljö. Ange också ett värde för includeFormsenrollment, includeFormsCommunications och includeFormsheadless till y eller n beroende på licens och krav. IncludeFormsheadless är obligatoriskt för att skapa Adaptiv Forms baserat på kärnkomponenter.

   • Använd includeFormsenrollment=y om du vill inkludera Forms-specifika konfigurationer, teman, mallar, kärnkomponenter och beroenden som krävs för att skapa Adaptiv Forms. Om du använder Forms Portal anger du includeExamples=y alternativ. Dessutom läggs kärnkomponenterna i Forms Portal till i projektet.

   • Använd includeFormscommunications=y möjlighet att inkludera Forms Core-komponenter och beroenden som krävs för att inkludera funktionen för kundkommunikation.

3. Distribuera projektet till din lokala utvecklingsmiljö. Du kan använda följande kommando för att distribuera till den lokala utvecklingsmiljön

   mvn -PautoInstallPackage clean install

   En fullständig lista med kommandon finns på Bygga och installera

4. Distribuera koden till AEM Forms as a Cloud Service miljö.

Konfigurera lokala Dispatcher-verktyg

Dispatcher är en Apache HTTP-webbservermodul som tillhandahåller ett säkerhets- och prestandalager mellan CDN- och AEM-publiceringsnivån. Dispatcher är en viktig del av den övergripande Experience Manager-arkitekturen och bör ingå i den lokala utvecklingsmiljön.

Utför följande steg för att konfigurera lokal Dispatcher och lägg sedan till Forms-specifika regler i den:

Konfigurera lokal Dispatcher

The Experience Manager as a Cloud Service SDK innehåller den rekommenderade versionen av Dispatcher Tools, som gör det lättare att konfigurera, validera och simulera Dispatcher lokalt. Dispatcher Tools är Docker-baserade och har kommandoradsverktyg för att överföra konfigurationsfilerna för Apache HTTP Web Server och Dispatcher till ett kompatibelt format och distribuera dem till Dispatcher som körs i Docker-behållaren.

Cachelagring av Dispatcher tillåter AEM Forms för att förifylla Adaptiv Forms på en kund. Det förbättrar återgivningshastigheten för förfyllda formulär.

Detaljerade anvisningar om hur du konfigurerar Dispatcher finns i Konfigurera lokala Dispatcher-verktyg

Lägg till Forms-specifika regler i Dispatcher

Så här konfigurerar du Dispatcher-cachen för Experience Manager Forms as a Cloud Service:

1. Öppna AEM och gå till \src\conf.dispatcher.d\available_farms

2. Skapa en kopia av default.farm -fil. Till exempel, forms.farm.

3. Öppna den nyskapade forms.farm -fil för redigering och ersättning av följande kod:

   #/ignoreUrlParams {
   #/0001 { /glob "*" /type "deny" }
   #/0002 { /glob "q" /type "allow" }
   #}
   

   med

   /ignoreUrlParams {
   /0001 { /glob "*" /type "deny" }
   /0002 { /glob "dataRef" /type "allow" }
   }
   

4. Spara och stäng filen.

5. Gå till conf.d/enabled_farms och skapa en symbolisk länk till forms.farm -fil.

6. Kompilera och distribuera projektet till AEM Forms as a Cloud Service miljö.

Att tänka på vid cachelagring

• Dispatcher-cachning tillåter AEM Forms för att förifylla Adaptiv Forms på en kund. Det förbättrar återgivningshastigheten för förfyllda formulär.
• Cachelagring av funktioner för skyddat innehåll är inaktiverat som standard. Om du vill aktivera funktionen kan du följa instruktionerna i Cachelagra skyddat innehåll artikel
• Dispatcher kan inte göra vissa adaptiva Forms och relaterade adaptiva Forms ogiltiga. Information om hur du löser sådana problem finns i AEM Forms Cachelagring i felsökningsavsnittet.
• Cachelagrar lokaliserade adaptiva Forms:
  • Använd URL-format http://host:port/content/forms/af/<afName>.<locale>.html begära en lokaliserad version av ett adaptivt formulär i stället för http://host:port/content/forms/af/afName.html?afAcceptLang=<locale>
  • Alternativet Webbläsarspråk är inaktiverat som standard. Om du vill ändra språkinställningen för webbläsaren
• När du använder URL-format http://host:port/content/forms/af/<adaptivefName>.html, och Använd webbläsarspråk i konfigurationshanteraren är inaktiverat, används den icke-lokaliserade versionen av det adaptiva formuläret. Det icke-lokaliserade språket är det språk som används vid utvecklingen av det adaptiva formuläret. Det språk som är konfigurerat för webbläsaren (webbläsarens språkområde) beaktas inte och en icke-lokaliserad version av det anpassade formuläret används.
• När du använder URL-format http://host:port/content/forms/af/<adaptivefName>.html, och Använd webbläsarspråk i konfigurationshanteraren är aktiverat, kommer en lokaliserad version av det adaptiva formuläret att användas, om en sådan finns. Språket i det lokaliserade adaptiva formuläret baseras på det språk som är konfigurerat för webbläsaren (webbläsarens språkområde). Det kan leda till [cachelagra endast första instansen av ett adaptivt formulär]. Om du vill förhindra att ett problem inträffar på din instans kan du läsa endast första instansen av ett adaptivt formulär cachelagras i felsökningsavsnittet.

Din lokala utvecklingsmiljö är klar.

Aktivera adaptiva Forms Core-komponenter för ett befintligt AEM Archetype-baserat projekt

Om du använder AEM Arketype version 40 eller senare för AEM Forms as a Cloud Service aktiveras Core Components automatiskt för din miljö.

Om du vill aktivera adaptiva Forms Core-komponenter för din as a Cloud Service AEM Forms-miljö baserat på äldre versioner av Archetype bäddar du in både WCM Core Component Examples-artefakter och Forms Core Component-artefakter (inklusive exempel) i ditt projekt:

1. Öppna projektmappen AEM Archetype i en ren textredigerare. Exempel: VS-kod.

2. Öppna POM-filen (överordnad POM) på ditt AEM Archetype-projekt i din lokala miljö, lägg till följande egenskaper i filen och spara den.

   <properties>
       <core.forms.components.version>2.0.4</core.forms.components.version> <!-- Replace the version with the latest released version at https://github.com/adobe/aem-core-forms-components/tags -->
       <core.wcm.components.version>2.21.2</core.wcm.components.version>
   </properties>
   

   För den senaste versionen av core.forms.components och core.wcm.components, kontrollera kärnkomponentdokumentation.

3. Lägg till följande beroenden i avsnittet Beroenden i den översta (överordnade) ppm.xml-filen:

       <!-- Forms Core Component Dependencies -->
               <dependency>
                   <groupId>com.adobe.aem</groupId>
                   <artifactId>core-forms-components-core</artifactId>
                   <version>${core.forms.components.version}</version>
               </dependency>
               <dependency>
                   <groupId>com.adobe.aem</groupId>
                   <artifactId>core-forms-components-apps</artifactId>
                   <version>${core.forms.components.version}</version>
                   <type>zip</type>
               </dependency>
               <dependency>
                   <groupId>com.adobe.aem</groupId>
                   <artifactId>core-forms-components-af-core</artifactId>
                   <version>${core.forms.components.version}</version>
               </dependency>
               <dependency>
                   <groupId>com.adobe.aem</groupId>
                   <artifactId>core-forms-components-af-apps</artifactId>
                   <version>${core.forms.components.version}</version>
                   <type>zip</type>
               </dependency>
               <dependency>
                   <groupId>com.adobe.aem</groupId>
                   <artifactId>core-forms-components-examples-apps</artifactId>
                   <type>zip</type>
                   <version>${core.forms.components.version}</version>
               </dependency>
               <dependency>
                   <groupId>com.adobe.aem</groupId>
                   <artifactId>core-forms-components-examples-content</artifactId>
                   <type>zip</type>
                   <version>${core.forms.components.version}</version>
               </dependency>
       <!-- End of AEM Forms Core Component Dependencies -->
   

4. Öppna filen all/pom.xml och lägg till följande beroenden för att lägga till adaptiva Forms Core Components-artefakter i ditt AEM Archetype-projekt:

       <dependency>
           <groupId>com.adobe.aem</groupId>
           <artifactId>core-forms-components-af-apps</artifactId>
           <type>zip</type>
       </dependency>
       <dependency>
           <groupId>com.adobe.aem</groupId>
           <artifactId>core-forms-components-examples-apps</artifactId>
           <type>zip</type>
       </dependency>
       <dependency>
           <groupId>com.adobe.aem</groupId>
           <artifactId>core-forms-components-examples-content</artifactId>
           <type>zip</type>
       </dependency>
   

   OBSERVERA

   Kontrollera att följande adaptiva Forms Core Components-artefakter inte ingår i ditt projekt.
   <dependency>
<groupId>com.adobe.aem</groupId>
<artifactId>core-forms-components-apps</artifactId>
</dependency>
   och
   <dependency>
<groupId>com.adobe.aem</groupId>
<artifactId>core-forms-components-core</artifactId>
</dependency>

5. Kör pipeline. Efter den lyckade pipeline-körningen aktiveras adaptiva Forms Core-komponenter för din miljö. Dessutom läggs den adaptiva Forms-mallen (Core Componets) och Canvas-temat till i Forms as a Cloud Service miljö.

Uppgradera din lokala utvecklingsmiljö

Om du uppgraderar SDK till en ny version måste du ersätta hela den lokala utvecklingsmiljön, vilket resulterar i att all kod, konfiguration och innehåll i de lokala databaserna går förlorat. Se till att kod, konfiguration eller innehåll som inte ska förstöras implementeras i Git på ett säkert sätt, eller exporteras från lokala Experience Manager-instanser som CRX-paket.

Så här undviker du innehållsförluster när du uppgraderar SDK

Genom att uppgradera SDK skapas en helt ny instans av Author och Publish, inklusive en ny databas (Ställ in AEM projekt), vilket innebär att ändringar som gjorts i en tidigare SDK-databas går förlorade. Om du vill ha en genomförbar strategi för att hjälpa till med bestående innehåll mellan SDK-uppgraderingar kan du gå till Så här undviker du innehållsförluster när du uppgraderar AEM SDK

Säkerhetskopiera och importera Forms-specifikt innehåll till en ny SDK-miljö

Så här säkerhetskopierar och flyttar du resurser från befintlig SDK till en ny SDK-miljö:

• Skapa en säkerhetskopia av befintligt innehåll.

• Konfigurera en ny SDK-miljö.

• Importera säkerhetskopian till din nya SDK-miljö.

Skapa en säkerhetskopia av befintligt innehåll

Säkerhetskopiera dina adaptiva Forms, mallar, formulärdatamodell, tema, konfigurationer och anpassad kod. Du kan utföra följande åtgärd för att skapa en säkerhetskopia:

1. Hämta Adaptiv Forms, teman och PDF forms.

2. Exportera adaptiva formulärmallar.

3. Hämta formulärdatamodeller

4. Exportera redigerbara mallar, molnkonfigurationer och arbetsflödesmodell. Om du vill exportera alla tidigare nämnda objekt från din befintliga SDK skapar du en CRX-paket med följande filter:

   • /conf/ReferenceEditableTemplates
   • /conf/global/settings/cloudconfigs
   • /conf/global/settings/wcm
   • /var/workflow/models
   • /conf/global/settings/workflow

5. Exportera e-postkonfigurationer, skicka och förifyll åtgärdskod från den lokala utvecklingsmiljön. Om du vill exportera dessa inställningar och konfigurationer skapar du en kopia av följande mappar och filer i den lokala utvecklingsmiljön:

   • [Archetype Project in Cloud Service Git]/core/src/main/java/com/<program name>/core/service
   • [Archetype Project in Cloud Service Git] /core/src/main/java/com/<program name>/core/servlets/FileAttachmentServlet.java
   • [Archetype Project in Cloud Service Git]/ui.apps/src/main/content/jcr_root/apps/<program name>/config

Importera säkerhetskopian till din nya SDK-miljö

Importera adaptiva Forms, mallar, formulärdatamodell, tema, konfigurationer och anpassad kod till din nya miljö. Du kan utföra följande åtgärd för att importera säkerhetskopior:

1. Importera Adaptiv Forms, teman och PDF forms till nya SDK-miljöer.

2. Importera adaptiva formulärmallar till en ny SDK-miljö.

3. Överför formulärdatamodeller till en ny SDK-miljö.

4. Importera redigerbara mallar, molnkonfigurationer och arbetsflödesmodell. Om du vill importera alla tidigare nämnda objekt till din nya SDK-miljö importerar du det CRX-paket som innehåller dessa objekt till din nya SDK-miljö.

5. Importera e-postkonfigurationer, skicka och förifyll åtgärdskod från den lokala utvecklingsmiljön. Om du vill importera dessa inställningar och konfigurationer placerar du följande filer från ditt gamla Arketype-projekt i ditt nya Arketype-projekt:

   • [Archetype Project in Cloud Service Git]/core/src/main/java/com/<program name>/core/service
   • [Archetype Project in Cloud Service Git] /core/src/main/java/com/<program name>/core/servlets/FileAttachmentServlet.java
   • [Archetype Project in Cloud Service Git]/ui.apps/src/main/content/jcr_root/apps/<program name>/config

Din nya miljö innehåller nu formulär och relaterade resurser från den gamla miljön.

Resurser för Business.Adobe.com