Lokale ontwikkelomgeving instellen voor AEM Forms overview
Wanneer u opstelling en vormt Adobe Experience Manager Forms als Cloud Service omgeving, stelt u ontwikkelings-, staging- en productieomgevingen in op cloud. Daarnaast kunt u ook een lokale ontwikkelomgeving instellen en configureren.
U kunt de lokale ontwikkelomgeving gebruiken om de volgende acties uit te voeren zonder u aan te melden bij de ontwikkelomgeving van de cloud:
- Formulieren maken en verwante elementen (thema's, sjablonen, aangepaste verzendhandelingen, enzovoort)
- PDF forms converteren naar adaptieve Forms
- Toepassingen maken om te genereren Klantcommunicatie op verzoek of in batchmodus.
Nadat een adaptief formulier of verwante elementen gereed zijn voor de lokale ontwikkelingsinstantie of een toepassing om te genereren [Klantcommunicatie] is gereed, kunt u de toepassing Adaptief formulier of Klantcommunicatie van de lokale ontwikkelomgeving naar een Cloud Service-omgeving exporteren voor verdere tests of voor overstap naar productieomgevingen.
U kunt ook aangepaste code zoals aangepaste componenten en vooraf ingevulde service ontwikkelen en testen in de lokale ontwikkelomgeving. Wanneer de aangepaste code is getest en gereed, kunt u de Git-opslagplaats van de ontwikkelomgeving van uw Cloud Service gebruiken om de aangepaste code te implementeren.
Als u een nieuwe lokale ontwikkelomgeving wilt instellen en deze wilt gebruiken voor de ontwikkeling van activiteiten, voert u de volgende acties uit in de aangegeven volgorde:
Vereisten
U hebt de volgende software nodig om een lokale ontwikkelomgeving in te stellen. Download deze bestanden voordat u de lokale ontwikkelomgeving instelt:
Download de nieuwste versie van software van Software Distribution software-distribution
Als u de nieuwste versie van de SDK van Adobe Experience Manager as a Cloud Service, het Experience Manager Forms-functiearchief (AEM Forms-invoegtoepassing), formulieren en referentiebestanden wilt downloaden van Forms Designer Softwaredistributie:
-
Aanmelden bij https://experience.adobe.com/#/downloads met uw Adobe ID
note note NOTE Uw Adobe-organisatie moet zijn ingericht zodat AEM as a Cloud Service de AEM as a Cloud Service SDK kan downloaden. -
Ga naar het tabblad AEM as a Cloud Service.
-
Sorteren op gepubliceerde datum in aflopende volgorde.
-
Klik op de nieuwste Adobe Experience Manager as a Cloud Service SDK, Experience Manager Forms-functiearchief (AEM Forms add-on), formulieren met naslaginformatie of Forms Designer.
note note NOTE Het wordt aanbevolen de nieuwste versie van het Experience Manager Forms-functiearchief (AEM Forms add-on), de referentiebestanden van formulieren of Forms Designer te downloaden voor naadloze compatibiliteit met de Adobe Experience Manager as a Cloud Service SDK. -
De EULA evalueren en aanvaarden. Selecteer de Download knop.
Ontwikkelingshulpmiddelen instellen voor AEM projecten setup-development-tools-for-AEM-projects
Het Adobe Experience Manager Forms-project is een aangepaste codebasis. Het bevat code, configuraties en inhoud die via Cloud Manager worden geïmplementeerd op Adobe Experience Manager as a Cloud Service. De AEM Project Maven Archetype verstrekt de basislijnstructuur voor het project.
Stel de volgende ontwikkelingsprogramma's in die u voor uw Adobe Experience Manager ontwikkelingsproject:
Voor gedetailleerde instructies voor het instellen van eerder vermelde ontwikkelingsgereedschappen raadpleegt u Ontwikkelingshulpmiddelen instellen.
Lokale Experience Manager instellen voor ontwikkeling
De Cloud Service SDK biedt een QuickStart-bestand. Er wordt een lokale versie van Experience Manager uitgevoerd. U kunt de instanties Auteur of Publiceren lokaal uitvoeren.
Hoewel QuickStart een lokale ontwikkelervaring biedt, beschikt QuickStart niet over alle functies die beschikbaar zijn in Adobe Experience Manager as a Cloud Service. Test dus altijd uw functies en code met Adobe Experience Manager as a Cloud Service ontwikkelomgeving voordat de functies naar het werkgebied of de productie worden verplaatst.
Voer de volgende stappen uit om de lokale Experience Manager-omgeving te installeren en te configureren:
- Downloaden en uitpakken de Adobe Experience Manager AS A CLOUD SERVICE SDK
- Een instantie Auteur instellen
- Een instantie voor publiceren instellen
Forms-archief toevoegen aan lokale instanties voor auteurs en publiceren en Forms-specifieke gebruikers configureren add-forms-archive-configure-users
Voer de volgende stappen in de vermelde volgorde uit om Forms-archief toe te voegen aan instanties van Experience Managers en formulierspecifieke gebruikers te configureren:
Installeer het nieuwste Forms add-on functiearchief add-forms-archive
Archief met as a Cloud Service functies van Adobe Experience Manager Forms biedt tools voor het maken, opmaken en optimaliseren van Adaptive Forms in de lokale ontwikkelomgeving. Installeer het pakket om een adaptief formulier te maken en gebruik verschillende andere functies van AEM Forms. Het pakket installeren:
-
Download en extraheer de nieuwste AEM Forms archiveren voor uw besturingssysteem vanuit Softwaredistributie.
-
Navigeer naar de map crx-quickstart/install. Als de map niet bestaat, maakt u deze.
-
Stop uw AEM instantie, plaats AEM Forms add-on functiearchief,
aem-forms-addon-<version>.far
, in de installatiemap. -
Ga naar actief opdrachtvenster en druk op
Ctrl + C
om de SDK opnieuw te starten.note note NOTE Het wordt aanbevolen de SDK opnieuw te starten met de opdracht 'Ctrl + C'. Het opnieuw opstarten van de AEM SDK met behulp van alternatieve methoden, bijvoorbeeld het stoppen van Java-processen, kan leiden tot inconsistenties in de AEM ontwikkelomgeving.
Gebruikers en machtigingen configureren configure-users-and-permissions
Gebruikers maken zoals Form Developer and Form Practice en deze gebruikers toevoegen aan vooraf gedefinieerde formuliergroepen om hun vereiste toestemmingen te verstrekken. In de onderstaande tabel worden alle typen gebruikers en vooraf gedefinieerde groepen voor elk type formuliergebruiker weergegeven:
Wanneer geen gebruikersverificatie is vereist voor toegang tot Adaptive Forms, wijst u geen groep toe aan dergelijke gebruikers.
Lokale ontwikkelomgeving instellen voor Document of Record (DoR) docker-microservices
AEM Forms als Cloud Servicen biedt een docker-gebaseerde SDK-omgeving voor een eenvoudigere ontwikkeling van Document of Record en voor het gebruik van andere microservices. U kunt hiermee geen handmatig platformspecifieke binaire bestanden en aanpassingen configureren. Omgeving instellen:
-
Docker installeren en configureren:
-
(Voor Microsoft® Windows) Installeren Docker Desktop. IT-configuraties
Docker Engine
endocker-compose
op uw computer. -
(Apple macOS) Installeren Docker Desktop voor Mac. Dit omvat Docker Engine, Docker CLI-client, Docker Compose, Docker Content Trust, Kubernetes en Credential Helper.
-
(Voor Linux®) Installeren Docker Engine en Samenstellen dokken op uw computer.
note note NOTE -
Voor Apple macOS, de omslagen van de lijst van gewenste personen die lokale AEM instanties van de Auteur bevatten.
-
Docker Desktop voor Windows ondersteunt twee achtergronden, Hyper-V
(oud) en WSL2 (modern). Bestanden delen wordt automatisch
beheerd door Docker wanneer het gebruiken van WSL2 (modern). U moet
Configureer het delen van bestanden expliciet tijdens het gebruik van Hyper-V (verouderd).
-
-
Maak een map, bijvoorbeeld aem-sdk, parallel aan de auteur en publiceer instanties. Bijvoorbeeld C:\aem-sdk.
-
Het gereedschap
aem-forms-addon-<version>.zip\aem-forms-addon-native-<version>.zip
bestand. -
Maak een omgevingsvariabele AEM_HOME en wijs naar de lokale installatie van AEM auteur. Bijvoorbeeld C:\aem\author.
-
Open sdk.bat of sdk.sh voor bewerking. Stel de AEM_HOME in om naar de lokale installatie van AEM auteur te verwijzen. Bijvoorbeeld C:\aem\author.
-
Opdrachtprompt openen en naar de
aem-forms-addon-native-<version>
map. -
Zorg ervoor dat uw lokale AEM Author-instantie actief is. Voer de volgende opdrachten uit om de SDK te starten:
-
Op Microsoft® Windows
code language-shell sdk.bat start
-
Linux® of Apple macOS
code language-shell % export AEM_HOME=[local AEM Author installation] % ./sdk.sh start
note note NOTE Als u de omgevingsvariabele in het bestand sdk.sh hebt gedefinieerd, is het opgeven van deze variabele op de opdrachtregel optioneel. De optie om de omgevingsvariabele op de opdrachtregel te definiëren, wordt opgegeven om de opdracht uit te voeren zonder het shellscript bij te werken. -
U kunt nu de lokale ontwikkelomgeving gebruiken om Document of Record te renderen. Upload een XDP-bestand naar uw omgeving en geef het weer om het te testen. Bijvoorbeeld: http://localhost:4502/libs/xfaforms/profiles/default.print.pdf?template=crx:///content/dam/formsanddocuments/cheque-request.xdp converteert het XDP-bestand naar het PDF-document.
Een ontwikkelingsproject voor Forms instellen op basis van het archetype Experience Manager forms-cloud-service-local-development-environment
Met dit project kunt u Adaptive Forms maken, configuratie-updates, overlays implementeren, aangepaste componenten voor adaptieve formulieren maken, testen en aangepaste code op lokale Experience Manager Forms SDK. Na het testen plaatselijk, kunt u het project opstellen aan Experience Manager Forms as a Cloud Service productie- en niet-productieomgevingen. Wanneer u het project opstelt, worden de volgende activa van AEM Forms ook opgesteld:
Opstelling AEM Archetype versie 32 of later gebaseerd project om Tranquil, Urbane, en Ultramarine thema's met AEM Forms as a Cloud Service te krijgen en te gebruiken.
Het project instellen:
-
Clone Cloud Manager Git-opslagplaats op uw lokale ontwikkelingsinstantie: De gegevensopslagruimte van uw cloudbeheerkit bevat een standaard AEM project. Het is gebaseerd op AEM Archetype. Clone your Cloud Manager Git Repository using Self-Service Git Account Management from Cloud Manager UI om het project over te brengen naar uw lokale ontwikkelomgeving. Zie voor meer informatie over toegang tot de gegevensopslagruimte Toegang tot opslagplaatsen.
-
Een Experience Manager Forms als [Cloud Service] project: Een Experience Manager Forms als [Cloud Service] project op basis van AEM Archetype of hoger. De archetype Help-ontwikkelaars beginnen gemakkelijk te ontwikkelen voor AEM Forms as a Cloud Service. Het bevat ook enkele voorbeeldthema's en sjablonen waarmee u snel aan de slag kunt gaan.
Open de opdrachtprompt en voer de onderstaande opdracht uit om een Experience Manager Forms as a Cloud Service project.
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"
Wijzig de
appTitle
,appId
, engroupId
in het bovenstaande bevel om uw milieu te weerspiegelen. Stel ook de waarde voor includeFormsenrollment, includeFormscommunications en includeFormsheadless in opy
ofn
afhankelijk van uw licentie en vereisten. IncludeFormadless is verplicht om Adaptive Forms te creëren die op de Componenten van de Kern wordt gebaseerd.-
Gebruik de
includeFormsenrollment=y
voor Forms-specifieke configuraties, -thema's, -sjablonen, -kerncomponenten en -afhankelijkheden die vereist zijn voor het maken van een adaptieve Forms. Als u Forms Portal gebruikt, stelt u de optieincludeExamples=y
-optie. Ook worden kerncomponenten van Forms Portal aan het project toegevoegd. -
Gebruik de
includeFormscommunications=y
-optie om Forms Core-componenten en -afhankelijkheden op te nemen die vereist zijn om de functionaliteit voor communicatie van de klant op te nemen.note warning WARNING - Wanneer u een project Archetype maakt met versie 45, [Projectmap Archetype AEM]Met /pom.xml worden de kerncomponenten van formulieren aanvankelijk ingesteld op versie 2.0.64. Voordat u het project Archetype gaat maken of implementeren, moet u de kerncomponentversie van de formulieren bijwerken naar versie 2.0.62.
-
-
Implementeer het project in uw lokale ontwikkelomgeving. U kunt het volgende bevel gebruiken om aan uw lokale ontwikkelomgeving op te stellen
mvn -PautoInstallPackage clean install
Zie voor de volledige lijst met opdrachten Samenstellen en installeren
-
De code implementeren op uw AEM Forms as a Cloud Service omgeving.
De lokale gereedschappen voor Dispatcher instellen setup-local-dispatcher-tools
Dispatcher is een Apache HTTP Web server module die een veiligheid en prestatieslaag tussen CDN en AEM publiceer rij verstrekt. Dispatcher is een integraal onderdeel van de algehele architectuur van de Experience Manager en moet onderdeel zijn van de lokale ontwikkelomgeving.
Voer de volgende stappen uit om lokale Dispatcher te vormen en dan Forms-specifieke regels aan het toe te voegen:
Lokale verzender instellen setup-local-dispatcher
De Experience Manager as a Cloud Service SDK bevat de aanbevolen versie van Dispatcher Tools voor het lokaal configureren, valideren en simuleren van Dispatcher. De Hulpmiddelen van de afzender zijn op docker-Gebaseerde en verstrekken bevel-lijn hulpmiddelen om de configuratiedossiers van de Server en van de Verzender van het Web van Apache HTTP in een compatibel formaat te transpileren en hen op Verzender op te stellen die in de container van het Docker lopen.
Caching op Dispatcher staat AEM Forms om Adaptieve Forms vooraf in te vullen op een client. Het verbetert de rendersnelheid van voorgevulde formulieren.
Voor gedetailleerde instructies voor het instellen van Dispatcher raadpleegt u De lokale gereedschappen voor Dispatcher instellen
Specifieke Forms-regels toevoegen aan Dispatcher forms-specific-rules-to-dispatcher
Voer de volgende stappen uit om de Dispatcher-cache voor Experience Manager Forms as a Cloud Service te configureren:
-
Open uw AEM Project en navigeer naar
\src\conf.dispatcher.d\available_farms
-
Maak een kopie van het dialoogvenster
default.farm
bestand. Bijvoorbeeld:forms.farm
. -
Het gemaakte bestand openen
forms.farm
bestand voor bewerken en vervangen van de volgende code:code language-json #/ignoreUrlParams { #/0001 { /glob "*" /type "deny" } #/0002 { /glob "q" /type "allow" } #}
with
code language-json /ignoreUrlParams { /0001 { /glob "*" /type "deny" } /0002 { /glob "dataRef" /type "allow" } }
-
Sla het bestand op en sluit het.
-
Ga naar
conf.d/enabled_farms
en een symbolische koppeling naar deforms.farm
bestand. -
Compileer en stel het project aan uw op AEM Forms as a Cloud Service omgeving.
Overwegingen over caching considerations-about-caching
-
Door verzending in cache te plaatsen, is AEM Forms om Adaptieve Forms vooraf in te vullen op een client. Het verbetert de rendersnelheid van voorgevulde formulieren.
-
Functies voor beveiligde inhoud die in de cache worden geplaatst, zijn standaard uitgeschakeld. Om de functie in te schakelen, kunt u de instructies uitvoeren die worden gegeven in het dialoogvenster Beveiligde inhoud in cache plaatsen artikel
-
De Dispatcher kan sommige Adaptive Forms en verwante Adaptive Forms niet valideren. Ga voor het oplossen van dergelijke problemen naar AEM Forms Caching in de sectie Problemen oplossen.
-
Gelokaliseerde adaptieve Forms in cache plaatsen:
- URL-indeling gebruiken
http://host:port/content/forms/af/<afName>.<locale>.html
een gelokaliseerde versie van een adaptief formulier aanvragen in plaats vanhttp://host:port/content/forms/af/afName.html?afAcceptLang=<locale>
- De optie Landinstelling browser is standaard uitgeschakeld. Als u de landinstelling van de browser wilt wijzigen,
- URL-indeling gebruiken
-
Wanneer u URL-indeling gebruikt
http://host:port/content/forms/af/<adaptivefName>.html
En en Browser gebruiken in configuratiebeheer is uitgeschakeld, wordt de niet-gelokaliseerde versie van het adaptieve formulier weergegeven. De niet-gelokaliseerde taal is de taal die wordt gebruikt bij het ontwikkelen van het adaptieve formulier. De landinstelling die is geconfigureerd voor uw browser (landinstelling browser) wordt niet in overweging genomen en er wordt een niet-gelokaliseerde versie van het Adaptief formulier weergegeven. -
Wanneer u URL-indeling gebruikt
http://host:port/content/forms/af/<adaptivefName>.html
En als Landinstelling browser gebruiken in configuratiebeheer is ingeschakeld, wordt een gelokaliseerde versie van het Adaptief formulier weergegeven, indien beschikbaar. De taal van het gelokaliseerde Adaptieve formulier is gebaseerd op de landinstelling die is geconfigureerd voor uw browser (landinstelling browser). Het kan leiden tot [alleen de eerste instantie van een adaptief formulier in cache plaatsen]. Als u wilt voorkomen dat het probleem op uw exemplaar optreedt, raadpleegt u alleen de eerste instantie van een adaptief formulier wordt in de cache geplaatst in de sectie Problemen oplossen.
Uw lokale ontwikkelomgeving is klaar.
Adaptieve Forms Core-componenten inschakelen in de as a Cloud Service en lokale ontwikkelomgeving van AEM Forms
Als u Adaptive Forms Core Components inschakelt op AEM Forms as a Cloud Service, kunt u beginnen met het maken, publiceren en leveren van Core Components based Adaptive Forms and Headless Forms met uw AEM Forms Cloud Service-instanties naar meerdere kanalen. Voor het gebruik van Headless Adaptive Forms hebt u de omgeving geschikt voor Adaptive Forms Core Components nodig.
Zie voor instructies Adaptieve Forms Core-componenten inschakelen in de as a Cloud Service en lokale ontwikkelomgeving van AEM Forms
Upgrade uw lokale ontwikkelomgeving upgrade-your-local-development-environment
Voor het upgraden van de SDK naar een nieuwe versie moet de volledige lokale ontwikkelomgeving worden vervangen. Dit leidt tot verlies van alle code, configuratie en inhoud in de lokale opslagruimten. Zorg ervoor dat om het even welke code, config, of inhoud die niet zou moeten worden vernietigd veilig aan Git wordt begaan, of uit de lokale instanties van de Experience Manager als CRX-Pakketten wordt uitgevoerd.
Inhoud verliezen bij het upgraden van de SDK voorkomen avoid-content-loss-when-upgrading--SDK
Door de SDK te upgraden, maakt u in feite een geheel nieuwe auteur- en publicatieversie, waaronder een nieuwe opslagplaats (AEM project instellen), dat wil zeggen dat eventuele wijzigingen in de opslagplaats van een eerdere SDK verloren gaan. Voor levensvatbare strategieën voor het helpen in het voortbestaan van inhoud tussen de verbeteringen van SDK, zie Hoe te om inhoudsverlies te vermijden wanneer het bevorderen van de AEM SDK
Een back-up maken van Forms-specifieke inhoud en deze importeren in een nieuwe SDK-omgeving backup-and-import-Forms-specific-content-to-new-SDK-environment
Een back-up maken van bestaande SDK en elementen verplaatsen naar een nieuwe SDK-omgeving:
-
Maak een back-up van uw bestaande inhoud.
-
Stel een nieuwe SDK-omgeving in.
-
Importeer de back-up naar de nieuwe SDK-omgeving.
Maak een back-up van uw bestaande inhoud create-backup-of-your-existing-content
Maak een back-up van uw Adaptieve Forms, sjablonen, FDM (Form Data Model), thema, configuraties en aangepaste code. U kunt de volgende actie uitvoeren om een back-up te maken:
-
Downloaden Adaptieve Forms, thema's en PDF forms.
-
Aangepaste formuliersjablonen exporteren.
-
Formuliergegevensmodellen downloaden
-
Bewerkbare sjablonen, cloudconfiguraties en workflowmodel exporteren. Als u alle eerder vermelde items vanuit uw bestaande SDK wilt exporteren, maakt u een CRX-pakket met de volgende filters:
- /conf/ReferenceEditableTemplates
- /conf/global/settings/cloudconfigs
- /conf/global/settings/wcm
- /var/workflow/modellen
- /conf/global/settings/workflow
-
Exporteer e-mailconfiguraties, verzend en vooraf ingevulde actiecode vanuit uw lokale ontwikkelomgeving. Als u deze instellingen en configuratie wilt exporteren, maakt u een kopie van de volgende mappen en bestanden in uw lokale ontwikkelomgeving:
[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
De back-up importeren in de nieuwe SDK-omgeving import-the-backup-to-your-new-SDK-environment
Importeer Adaptief Forms, sjablonen, formuliergegevensmodel, thema, configuraties en aangepaste code naar uw nieuwe omgeving. U kunt de volgende actie uitvoeren om een back-up te importeren:
-
Importeren Adaptieve Forms, thema's en PDF forms naar nieuwe SDK-omgevingen.
-
Importeer Aangepaste formuliersjablonen naar de nieuwe SDK-omgeving.
-
Upload modellen van formuliergegevens naar de nieuwe SDK-omgeving.
-
Bewerkbare sjablonen, cloudconfiguraties en workflowmodel importeren. Als u alle eerder vermelde items in uw nieuwe SDK-omgeving wilt importeren, importeert u het CRX-Package met deze items in uw nieuwe SDK-omgeving.
-
Importeer de code voor e-mailconfiguraties, verzenden en vooraf invullen van handelingen vanuit uw lokale ontwikkelomgeving. Om deze montages en configuratie in te voeren, plaats de volgende dossiers van uw oud project Archetype aan uw nieuw project Archetype:
[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
Uw nieuwe omgeving beschikt nu over formulieren en gerelateerde elementen van een oude omgeving.