DokumentationAEM as a Cloud ServiceAnvändarhandbok

Konfigurera lokal utvecklingsmiljö för AEM Forms overview

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Skapat för:

  • Administratör
  • Utvecklare
  • Användare

När du konfigurerar och konfigurerar en ​ Adobe Experience Manager Forms som en ​ Cloud Service-miljö konfigurerar du 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:

När ett adaptivt formulär eller relaterade resurser är klara på den lokala utvecklingsinstansen eller ett program för att generera [kundkommunikation] är klart, kan du exportera det adaptiva formuläret eller kundkommunikationsprogrammet från den lokala utvecklingsmiljön till en Cloud Service-miljö för ytterligare testning eller för att 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:

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:

Programvara
Beskrivning
Hämta länkar
Adobe Experience Manager as a Cloud Service SDK
SDK innehåller Adobe Experience Manager verktyg för QuickStart och Dispatcher
Hämta den senaste SDK-versionen från Programvarudistribution
Adobe Experience Manager Forms feature archive (AEM Forms add-on)
Verktyg för att skapa, formatera och optimera adaptiva Forms och andra Adobe Experience Manager Forms-funktioner
Hämta från Programvarudistribution
(Valfritt) Adobe Experience Manager Forms referensinnehåll
Verktyg för att skapa, formatera och optimera adaptiva Forms och andra Adobe Experience Manager Forms-funktioner
Hämta från Programvarudistribution
(Valfritt) Adobe Experience Manager Forms Designer
Verktyg för att skapa, formatera och optimera adaptiva Forms och andra Adobe Experience Manager Forms-funktioner
Hämta från Programvarudistribution

Ladda ned den senaste versionen av programvara från Software Distribution 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-tillägg), formulärreferensresurser eller Forms Designer från Software Distribution:

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

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

  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-tillägg), formulärreferensmaterial eller Forms Designer.

    note note
    NOTE
    Vi rekommenderar att du hämtar den senaste versionen av Experience Manager Forms-funktionsarkiv (AEM Forms-tillägg), formulärreferensmaterial eller Forms Designer för att få en sömlös kompatibilitet med Adobe Experience Manager as a Cloud Service SDK.

  5. Granska och godkänn slutanvändaravtalet. Välj knappen Download.

Ställ in utvecklingsverktyg för AEM projekt setup-development-tools-for-AEM-projects

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. AEM Project Maven Archetype innehåller projektets baslinjestruktur.

Konfigurera följande utvecklingsverktyg som ska användas för ditt Adobe Experience Manager-projekt för utveckling:

Detaljerade instruktioner 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 Publish-instansen lokalt.

QuickStart har en lokal utvecklingsupplevelse, men inte alla funktioner som är tillgängliga i Adobe Experience Manager as a Cloud Service. Testa dina funktioner och din kod med Adobe Experience Manager as a Cloud Service utvecklingsmiljö innan du flyttar funktionerna till scenen eller produktionen.

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

Lägg till Forms-arkiv i lokala Author- och Publish-instanser och konfigurera Forms-specifika användare add-forms-archive-configure-users

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 add-forms-archive

Adobe Experience Manager Forms as a Cloud Service feature archive 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änd olika andra funktioner i AEM Forms. Så här installerar du paketet:

  1. Hämta och extrahera det senaste AEM Forms-arkivet för ditt operativsystem från Programvarudistribution.

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

  3. Stoppa din AEM-instans och placera arkivet för tilläggsfunktionen AEM Forms, aem-forms-addon-<version>.far, i installationsmappen.

  4. Gå till det aktiva kommandofönstret och tryck på Ctrl + C-kommandot för att starta om SDK.

    note note
    NOTE
    Du bör använda kommandot Ctrl + C för att starta om SDK:n. Om du startar om AEM SDK med alternativa metoder, till exempel genom att stoppa Java-processer, kan det leda till inkonsekvenser i den AEM utvecklingsmiljön.

Konfigurera användare och behörigheter configure-users-and-permissions

Skapa användare som formulärutvecklare och formulärdeltagare och lägg till dessa användare i fördefinierade formulärgrupper för att ge dem de behörigheter som krävs. Tabellen nedan visar alla typer av användare och fördefinierade grupper för varje typ av formuläranvändare:

Användartyp
AEM
Formuläradministratör /
forms-users (AEM Forms-användare), template-authors, workflow-users, workflow-editors och fdm-authors
Formulärutvecklare
forms-users (AEM Forms-användare), template-authors, workflow-users, workflow-editors och fdm-authors
Customer Experience Lead eller UX Designer
forms-users, template-authors
AEM-administratör
aem-administrators, fd-administrators
Slutanvändare
När en användare måste logga in för att visa och skicka ett adaptivt formulär lägger du till sådana användare i gruppen forms-users.
Om ingen användarautentisering krävs för att få åtkomst till Adaptiv Forms ska du inte tilldela någon grupp till sådana användare.

Ställ in lokal utvecklingsmiljö för DoR (Document of Record) docker-microservices

AEM Forms som Cloud Service 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. Docker Engine och docker-compose konfigureras på datorn.

    • (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 Docker Engine och Docker Compose på datorn.

    note note
    NOTE

    • I Apple macOS tillåtslista du mappar som innehåller lokala AEM författarinstanser.

    • 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. Exempel: C:\aem-sdk.

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

    extraherade aem-formulär har lagts till i ursprungliga

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

  5. Öppna sdk.bat eller sdk.sh för redigering. Ställ in AEM_HOME så att den pekar på den lokala AEM författarinstallationen. Exempel: C:\aem\author.

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

  7. Kontrollera att den lokala AEM Author-instansen körs. Kör följande kommandon för att starta SDK:

    • På Microsoft® Windows

      code language-shell 
      sdk.bat start

    • Linux® eller Apple macOS

      code language-shell 
      % export AEM_HOME=[local AEM Author installation]
% ./sdk.sh start
    note note
    NOTE
    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.

    start-sdk-command

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. http://localhost:4502/libs/xfaforms/profiles/default.print.pdf?template=crx:///content/dam/formsanddocuments/cheque-request.xdp konverterar till exempel XDP-filen till PDF-dokumentet.

Konfigurera ett utvecklingsprojekt för Forms baserat på Experience Manager-arkitypen forms-cloud-service-local-development-environment

Använd det här projektet för att skapa Adaptiv Forms, distribuera konfigurationsuppdateringar, övertäckningar, skapa anpassade adaptiva formulärkomponenter, testa och anpassad kod på lokal 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:

Teman
Mallar
FDM (Form Data Model)
Arbetsyta 3.0
Grundläggande
Microsoft® Dynamics 365
Tranquil
Tom
Salesforce
Urbane
Ultramarin
Beryl
NOTE
Installera AEM Archetype version 30 eller senare för att hämta och använda Microsoft® Dynamics 365 och Salesforce Form Data Model (FDM) med AEM Forms as a Cloud Service.
Installera AEM Archetype version 32 eller senare för att få tillgång till och använda temana Tranquil, Urbane och Ultramarine med AEM Forms as a Cloud Service.

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

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

  2. Skapa ett Experience Manager Forms som ett [Cloud Service]-projekt: Skapa ett Experience Manager Forms som ett [Cloud Service]-projekt baserat på den senaste AEM-arkitekturen eller senare. Med hjälp av arkitypen kan utvecklare 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 ett Experience Manager Forms-as a Cloud Service projekt.

    code language-shell 
    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="41" -D appTitle=mysite -D appId=mysite -D groupId=com.mysite -D includeFormsenrollment="y" -D aemVersion="cloud"

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

    • Använd alternativet 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 alternativet includeExamples=y. Dessutom läggs kärnkomponenterna i Forms Portal till i projektet.

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

      note warning
      WARNING
      • När du skapar ett Arketype-projekt med version 45 anger [AEM Archetype Project Folder]/pom.xml till att börja med 2.0.64 som formulärkärnkomponent. Innan du bygger eller driftsätter Archetype-projektet ska du uppdatera formulärkärnkomponentens version till 2.0.62.

  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 i Bygga och installera

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

Konfigurera lokala Dispatcher-verktyg setup-local-dispatcher-tools

Dispatcher är en Apache HTTP Web Server-modul som tillhandahåller ett säkerhets- och prestandalager mellan CDN- och AEM Publish-skiktet. 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 lokala Dispatcher och lägg sedan till Forms-specifika regler:

Konfigurera lokal Dispatcher setup-local-dispatcher

As a Cloud Service SDK Experience Manager innehåller den rekommenderade Dispatcher-versionen 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 driftsätta dem i Dispatcher som körs i Docker-behållaren.

Cachelagring på Dispatcher gör att AEM Forms kan förifylla Adaptiv Forms på en klient. 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 forms-specific-rules-to-dispatcher

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

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

  2. Skapa en kopia av filen default.farm. Exempel: forms.farm.

  3. Öppna den skapade forms.farm-filen för redigering och ersätt följande kod:

    code language-json 
    #/ignoreUrlParams {
#/0001 { /glob "*" /type "deny" }
#/0002 { /glob "q" /type "allow" }
#}

    med

    code language-json 
    /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 filen forms.farm.

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

Att tänka på vid cachelagring considerations-about-caching

  • Med Dispatcher-cachning kan AEM Forms förifylla Adaptiv Forms på en klient. 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 utföra instruktionerna i artikeln Cachelagra skyddat innehåll

  • Dispatcher kan inte ogiltigförklara vissa adaptiva Forms och relaterade adaptiva Forms. Information om hur du löser sådana problem finns i AEM Forms Caching i felsökningsavsnittet.

  • Cachelagrar lokaliserade adaptiva Forms:

    • Använd URL-formatet http://host:port/content/forms/af/<afName>.<locale>.html för att 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-formatet http://host:port/content/forms/af/<adaptivefName>.html och Använd webbläsarspråk i konfigurationshanteraren är inaktiverat, visas 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-formatet http://host:port/content/forms/af/<adaptivefName>.html, och Använd webbläsarspråk i konfigurationshanteraren är aktiverat, visas en lokaliserad version av det adaptiva formuläret, 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 [cachelagring av endast den första instansen av ett adaptivt formulär]. Om du vill förhindra att problemet inträffar på din instans läser du endast den första instansen av ett adaptivt formulär cachas i felsökningsavsnittet.

Din lokala utvecklingsmiljö är klar.

Aktivera adaptiva Forms Core-komponenter i AEM Forms as a Cloud Service och lokal utvecklingsmiljö

Genom att aktivera adaptiva Forms Core-komponenter i AEM Forms as a Cloud Service kan du börja skapa, publicera och leverera Core Components-baserade adaptiva Forms och Headless Forms med hjälp av AEM Forms Cloud Service-instanser i flera kanaler. Du behöver en adaptiv Forms Core Components-aktiverad miljö för att kunna använda Headless Adaptive Forms.

Instruktioner finns i Aktivera adaptiva Forms Core-komponenter i AEM Forms as a Cloud Service och lokal utvecklingsmiljö

Uppgradera din lokala utvecklingsmiljö upgrade-your-local-development-environment

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 på Git på ett säkert sätt, eller exporteras från de lokala Experience Manager-instanserna som CRX-Packages.

Så här undviker du innehållsförluster när du uppgraderar SDK avoid-content-loss-when-upgrading--SDK

Genom att uppgradera SDK skapas en helt ny författare och Publish-instanser, inklusive en ny databas (Konfigurera 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 hjälp med beständigt innehåll mellan SDK-uppgraderingar kan du läsa 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ö backup-and-import-Forms-specific-content-to-new-SDK-environment

Så här säkerhetskopierar och flyttar du resurser från en 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 create-backup-of-your-existing-content

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

  1. Hämta anpassningsbara 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 ett 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ö import-the-backup-to-your-new-SDK-environment

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 adaptiva 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.

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab