Lokale ontwikkelomgeving instellen voor AEM Forms overview
Wanneer u een Adobe Experience Manager Forms als een Cloud Service -omgeving instelt en configureert, stelt u ontwikkelings-, staging- en productieomgevingen in in de 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:
- creeer vormenen verwante activa (thema's, malplaatjes, douane verzendt Acties, en meer)
- zet PDF forms in AanpassingsFormsom
- Bouw toepassingen om Mededelingen van de Klantop bestelling of in partijwijzen te produceren.
Nadat een AanpassingsVorm of verwante activa op de lokale ontwikkelingsinstantie of een toepassing klaar zijn om [ Mededelingen van de Klant te produceren ] is, kunt u de AanpassingsVorm of Communicatie van de Klant toepassing van de lokale ontwikkelomgeving naar een milieu van de Cloud Service voor het verdere testen of het bewegen naar productiemilieu's uitvoeren.
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
Om recentste versie van SDK van Adobe Experience Manager as a Cloud Service, het eigenschaparchief van Experience Manager Forms (AEM Forms toe:voegen-op), de activa van de vormenverwijzing, of Forms Designer van de Distributie van de Softwarete downloaden:
-
Meld u aan 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 SDK van AEM as a Cloud Service 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 een naadloze compatibiliteit met Adobe Experience Manager as a Cloud Service SDK. -
De EULA evalueren en aanvaarden. Selecteer de knop Download .
Ontwikkelingshulpmiddelen instellen voor AEM projecten setup-development-tools-for-AEM-projects
Het Adobe Experience Manager Forms-project is een aangepaste codebasis. Deze bevat code, configuraties en inhoud die via Cloud Manager wordt geïmplementeerd in Adobe Experience Manager as a Cloud Service. Het AEM Project Maven Archetypeverstrekt de basislijnstructuur voor het project.
Stel de volgende ontwikkelingsprogramma's in die u voor uw Adobe Experience Manager -project wilt gebruiken voor ontwikkeling:
Voor gedetailleerde instructies aan opstelling eerder vermelde ontwikkelingshulpmiddelen, zie de ontwikkelingshulpmiddelen van de Opstelling.
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 Publish lokaal uitvoeren.
Hoewel QuickStart een lokale ontwikkelingservaring 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 u de functies verplaatst naar het werkgebied of de productie.
Voer de volgende stappen uit om de lokale Experience Manager-omgeving te installeren en te configureren:
- Download en haalde Adobe Experience Manager as a Cloud Service SDK uit
- Opstelling een instantie van de Auteur
- Opstelling een instantie van Publish
Forms-archief toevoegen aan lokale auteur- en Publish-instanties 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
Het Adobe Experience Manager Forms as a Cloud Service-functiearchief 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:
-
De download en haalt het recentste AEM Forms archief voor uw werkend systeem van Distributie van de Software.
-
Navigeer naar de map crx-quickstart/install. Als de map niet bestaat, maakt u deze.
-
Stop uw AEM instantie, plaats het AEM Forms add-on functiearchief
aem-forms-addon-<version>.far
in de installatiemap. -
Ga naar het actieve 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
Creeer gebruikers zoals de Ontwikkelaar van de Vorm en de Praktijk van de Vorm en voeg deze gebruikers aan vooraf bepaalde vormgroepentoe om hen 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® Vensters) installeer de Desktop van de Dokker.
Docker Engine
endocker-compose
worden geconfigureerd op uw computer. -
(Apple macOS) installeer de Desktop van de Dokker voor Mac. Dit omvat Docker Engine, Docker CLI-client, Docker Compose, Docker Content Trust, Kubernetes en Credential Helper.
-
(Voor Linux®) installeer de Motor van het Docken stelt de Teller samenop uw machine.
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.
-
Pak het bestand
aem-forms-addon-<version>.zip\aem-forms-addon-native-<version>.zip
uit. -
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.
-
Open de opdrachtprompt en navigeer naar de map
aem-forms-addon-native-<version>
. -
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. http://localhost:4502/libs/xfaforms/profiles/default.print.pdf?template=crx:///content/dam/formsanddocuments/cheque-request.xdp converteert bijvoorbeeld 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 voor de lokale Experience Manager Forms SDK gebruiken. Nadat u het project lokaal hebt getest, kunt u het in Experience Manager Forms as a Cloud Service productie- en niet-productieomgevingen implementeren. 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:
-
de bewaarplaats van de Git van Cloud Manager van de Kloon op uw lokale ontwikkelingsinstantie: Uw bewaarplaats van de Git van Cloud Manager 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 to bring the project on your local development environment. Voor details om tot de bewaarplaats toegang te hebben, zie Toegang hebbend tot Bewaarplaatsen.
-
creeer een Experience Manager Forms als project van de a [ Cloud Service ]: creeer een Experience Manager Forms als project van de a [ Cloud Service ] dat op recentste wordt gebaseerd AEM Archetypeof later. De ontwikkelaars van de archetype Help kunnen eenvoudig beginnen met het 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 te maken.
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 de bovenstaande opdracht om uw omgeving te weerspiegelen. Stel ook 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.-
Met de optie
includeFormsenrollment=y
kunt u specifieke Forms-configuraties, -thema's, -sjablonen, -kerncomponenten en -afhankelijkheden opnemen die vereist zijn om een adaptieve Forms te maken. Stel de optieincludeExamples=y
in als u Forms Portal gebruikt. Ook worden kerncomponenten van Forms Portal aan het project toegevoegd. -
Gebruik de optie
includeFormscommunications=y
om Forms Core-componenten en afhankelijkheden op te nemen die vereist zijn om de communicatiefunctionaliteit van de klant op te nemen.note warning WARNING - Wanneer het creëren van een project Archetype met versie 45, plaatst de [ AEM omslag van het Project van het Archetype ] /pom.xml aanvankelijk de versie van de componenten van de vormenkern aan 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
Voor de volledige lijst van bevelen, zie Bouw en het Installeren
Lokale Dispatcher-gereedschappen instellen setup-local-dispatcher-tools
Dispatcher is een Apache HTTP Web server module die een veiligheid en prestatieslaag tussen CDN en AEM de rij van Publish verstrekt. Dispatcher is een integraal onderdeel van de algehele architectuur van de Experience Manager en moet deel uitmaken van de lokale ontwikkelingsomgeving.
Voer de volgende stappen uit om lokale Dispatcher te vormen en dan Forms-specifieke regels aan het toe te voegen:
Lokale Dispatcher instellen setup-local-dispatcher
De Experience Manager as a Cloud Service SDK bevat de aanbevolen versie van Dispatcher Tools waarmee u Dispatcher lokaal kunt configureren, valideren en simuleren. De Hulpmiddelen van Dispatcher zijn op docker-Gebaseerd en verstrekken bevel-lijn hulpmiddelen om Apache HTTP- de configuratiedossiers van de Server en van Dispatcher in een compatibel formaat te transpileren en hen op Dispatcher op te stellen die in de container van de Dokker lopen.
In cache plaatsen op Dispatcher kan AEM Forms Adaptieve Forms vooraf invullen op een client. Het verbetert de rendersnelheid van voorgevulde formulieren.
Voor gedetailleerde instructies aan opstelling Dispatcher, zie de lokale hulpmiddelen van Dispatcher van de Opstelling
Specifieke Forms-regels toevoegen aan Dispatcher forms-specific-rules-to-dispatcher
Voer de volgende stappen uit om 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
default.farm
-bestand. Bijvoorbeeldforms.farm
. -
Open het gemaakte
forms.farm
-bestand om de volgende code te bewerken en te vervangen: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 maak een symbolische koppeling naar hetforms.farm
-bestand. -
Compileer en implementeer het project in uw AEM Forms as a Cloud Service omgeving.
Overwegingen over caching considerations-about-caching
-
Met Dispatcher caching kan AEM Forms Adaptive Forms vooraf op een client invullen. Het verbetert de rendersnelheid van voorgevulde formulieren.
-
Functies voor beveiligde inhoud die in de cache worden geplaatst, zijn standaard uitgeschakeld. Om de eigenschap toe te laten, kunt u de instructies uitvoeren die in het Caching Beveiligde artikel van de Inhoudworden verstrekt
-
De Dispatcher kan sommige Adaptive Forms en verwante Adaptive Forms niet valideren. Om dergelijke kwesties op te lossen, zie AEM Forms Cachingin het oplossen van problemensectie.
-
Gelokaliseerde adaptieve Forms in cache plaatsen:
- Gebruik de URL-indeling
http://host:port/content/forms/af/<afName>.<locale>.html
om een gelokaliseerde versie van een adaptief formulier aan te vragen 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,
- Gebruik de URL-indeling
-
Wanneer u URL-indeling
http://host:port/content/forms/af/<adaptivefName>.html
gebruikt en Landinstelling 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
http://host:port/content/forms/af/<adaptivefName>.html
gebruikt en Landinstelling browser gebruiken in configuratiebeheer is ingeschakeld, wordt een gelokaliseerde versie van het adaptieve 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 tot [ caching slechts eerste instantie van een AanpassingsVorm ] leiden. Om de kwestie te verhinderen op uw instantie te gebeuren, zie slechts eerste geval van een AanpassingsVormin het oplossen van problemensectie in het voorgeheugen onder wordt gebracht.
Uw lokale ontwikkelomgeving is klaar.
Aangepaste 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.
Voor instructies, zie de Aangepaste Componenten van de Kern van Forms op AEM Forms as a Cloud Service en lokale ontwikkelomgevingtoelaten
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
De bevordering van SDK leidt effectief tot een gloednieuwe Instanties van de Auteur en van Publish, met inbegrip van een nieuwe bewaarplaats ( Opstelling AEM project), betekenend om het even welke veranderingen die aan de bewaarplaats van een vroegere SDK worden aangebracht worden verloren. Voor levensvatbare strategieën om in het voortbestaan inhoud tussen verbeteringen van SDK bij te staan, zie hoe te inhoudsverlies 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:
-
DownloadAangepaste Forms, thema's, en PDF forms.
-
Aangepaste formuliersjablonen exporteren.
-
Formuliergegevensmodellen downloaden
-
Bewerkbare sjablonen, cloudconfiguraties en workflowmodel exporteren. Om alle eerder vermelde punten van uw bestaande SDK uit te voeren, creeer een CRX-Pakketmet 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:
-
🔗 Aangepaste Forms, thema's, en PDF forms van de invoer van 0} {aan nieuwe milieu's SDK.
-
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-pakket 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.