Wenn Sie eine Adobe Experience Manager Forms-as-a- Cloud Service-Umgebung einrichten und konfigurieren, richten Sie Entwicklungs-, Staging- und Produktionsumgebungen in der Cloud ein. Darüber hinaus können Sie auch eine lokale Entwicklungsumgebung einrichten und konfigurieren.
Sie können die lokale Entwicklungsumgebung verwenden, um die folgenden Aktionen durchzuführen, ohne sich bei der Cloud-Entwicklungsumgebung anzumelden:
Nachdem ein adaptives Formular oder zugehörige Elemente in der lokalen Entwicklungsinstanz oder in einem Programm zum Generieren der [Kundenkommunikation] bereit sind, können Sie das Programm mit dem adaptiven Formular oder der Kundenkommunikation aus der lokalen Entwicklungsumgebung in eine Cloud Service-Umgebung exportieren, um weitere Tests durchzuführen oder zu Produktionsumgebungen zu wechseln.
Sie können auch benutzerdefinierten Code wie benutzerdefinierte Komponenten und den Vorbefüllungs-Service in der lokalen Entwicklungsumgebung entwickeln und testen. Wenn der benutzerdefinierte Code getestet und bereit ist, können Sie das Git-Repository Ihrer Cloud Service-Entwicklungsumgebung verwenden, um den benutzerdefinierten Code bereitzustellen.
Um eine neue lokale Entwicklungsumgebung einzurichten und sie zur Entwicklung für Aktivitäten zu nutzen, führen Sie folgende Aktionen in angegebener Reihenfolge durch:
Einrichten einer lokalen Autoren- und Veröffentlichungsinstanz
Hinzufügen eines Forms-Archivs in lokalen Entwicklungsinstanzen und Konfigurieren von Benutzern
Einrichten einer lokalen Entwicklungsumgebung für Microservices
Sie benötigen folgende Software, um eine lokale Entwicklungsumgebung einzurichten. Laden Sie diese herunter, bevor Sie mit der Einrichtung der lokalen Entwicklungsumgebung beginnen:
Software | Beschreibung | Downloadlinks |
---|---|---|
Adobe Experience Manager as a Cloud Service SDK | SDK enthält Adobe Experience Manager-QuickStart- und -Dispatcher-Tools | Laden Sie das neueste SDK von Software Distribution herunter. |
Adobe Experience Manager Forms-Funktionsarchiv (AEM Forms-Add-on) | Tools zum Erstellen, Gestalten und Optimieren adaptiver Formulare und anderer Adobe Experience Manager Forms-Funktionen | Download aus Software Distribution |
(Optional) Adobe Experience Manager Forms-Referenzinhalt | Tools zum Erstellen, Gestalten und Optimieren adaptiver Formulare und anderer Adobe Experience Manager Forms-Funktionen | Download aus Software Distribution |
(Optional) Adobe Experience Manager Forms Designer | Tools zum Erstellen, Gestalten und Optimieren adaptiver Formulare und anderer Adobe Experience Manager Forms-Funktionen | Download aus Software Distribution |
Herunterladen der neuesten Version von Adobe Experience Manager as a Cloud Service SDK, Experience Manager Forms-Funktionsarchiv (AEM Forms-Add-on), Forms-Referenzelemente oder Forms Designer von Software Distribution:
Melden Sie sich bei https://experience.adobe.com/#/downloads mit Ihrer Adobe ID an.
Ihre Adobe-Organisation muss für AEM as a Cloud Service bereitgestellt werden, um das AEM as a Cloud Service SDK herunterladen zu können.
Navigieren Sie zur Registerkarte AEM as a Cloud Service.
Sortieren Sie in absteigender Reihenfolge nach dem Veröffentlichungsdatum.
Klicken Sie auf das neueste Adobe Experience Manager as a Cloud Service SDK, Experience Manager Forms Feature Archiv (AEM Forms-Add-on), die Formularverweis-Assets oder Forms Designer.
Lesen und akzeptieren Sie den Endbenutzer-Lizenzvertrag. Klicken Sie auf die Schaltfläche Herunterladen.
Das Adobe Experience Manager Forms-Projekt ist eine benutzerdefinierte Code-Basis. Diese enthält Code, Konfigurationen und Inhalte, die über Cloud Manager in Adobe Experience Manager as a Cloud Service bereitgestellt werden. Der AEM-Projekt Maven-Archetyp stellt die Grundlinie für das Projekt bereit.
Richten Sie die folgenden Entwicklungs-Tools ein, die für Ihr Adobe Experience Manager-Projekt zur Entwicklung verwendet werden sollen:
Detaillierte Anweisungen zum Einrichten der zuvor erwähnten Entwicklungs-Tools finden Sie unter Einrichten von Entwicklungs-Tools.
Das Cloud Service-SDK stellt eine QuickStart-Datei bereit. Es führt eine lokale Version von Experience Manager aus. Sie können entweder die Autoren- oder die Veröffentlichungsinstanz lokal ausführen.
Während QuickStart eine lokale Entwicklungsumgebung bietet, sind hier nicht alle Funktionen vorhanden, die bei Adobe Experience Manager as a Cloud Service verfügbar sind. Testen Sie daher Ihre Funktionen und den Code immer in einer Adobe Experience Manager as a Cloud Service-Entwicklungsumgebung, bevor Sie sie in die Staging- oder Produktionsumgebung verschieben.
Installieren und Konfigurieren einer lokalen Experience Manager-Umgebung:
Führen Sie folgende Schritte in der aufgeführten Reihenfolge aus, um Forms-Archive zu Experience Manager-Instanzen hinzuzufügen und Forms-spezifische Benutzer zu konfigurieren:
Das Funktionsarchiv für Adobe Experience Manager Forms as a Cloud Service bietet Tools zum Erstellen, Gestalten und Optimieren von adaptiven Formularen in der lokalen Entwicklungsumgebung. Installieren Sie das Paket, um ein adaptives Formular zu erstellen, und verwenden Sie verschiedene andere Funktionen von AEM Forms. Installieren des Pakets:
Laden Sie das neueste AEM Forms-Archiv für Ihr Betriebssystem aus Software Distribution herunter und extrahieren Sie es.
Navigieren Sie zum Verzeichnis „crx-quickstart/install“. Wenn der Ordner nicht vorhanden ist, erstellen Sie ihn.
Beenden Sie Ihre AEM-Instanz, platzieren Sie das AEM Forms-Add-on-Funktionsarchiv aem-forms-addon-<version>.far
im Installationsordner und starten Sie die Instanz neu.
Erstellen Sie Benutzer wie „Formularentwickler“ oder „Formularpraktiker“ und fügen Sie diese Benutzer vordefinierten Formulargruppen hinzu, um ihnen die erforderlichen Berechtigungen zu gewähren. In folgender Tabelle werden alle Benutzertypen und vordefinierten Gruppen für jeden Formularbenutzertyp aufgeführt:
Benutzertyp | AEM-Gruppe |
---|---|
Formularpraktiker/ | forms-users (AEM Forms-Benutzer), template-authors, workflow-users, workflow-editors und fdm-authors |
Formularentwickler | forms-users (AEM Forms-Benutzer), template-authors, workflow-users, workflow-editors und fdm-authors |
Customer Experience Lead oder UX-Designer | forms-users, template-authors |
AEM-Administrator | aem-administrators, fd-administrators |
Endanwender | Fügen Sie Benutzer, die sich anmelden müssen, um ein adaptives Formular anzuzeigen und zu übermitteln, der Gruppe forms-users hinzu. Wenn für den Zugriff auf adaptive Formulare keine Benutzerauthentifizierung erforderlich ist, weisen Sie diesen Benutzern keine Gruppe zu. |
AEM Forms as a Cloud Service bietet eine Docker-basierte SDK-Umgebung zur einfacheren Entwicklung des Datensatzdokuments und zur Verwendung anderer Microservices. So müssen Sie plattformspezifische Binärdateien und Anpassungen nicht manuell konfigurieren. So richten Sie die Umgebung ein:
Installieren und Konfigurieren von Docker:
(Für Microsoft® Windows) Installieren Sie Docker Desktop. Damit werden Docker Engine
und docker-compose
auf Ihrem Computer konfiguriert.
(Apple macOS) Installieren Sie Docker Desktop für Mac. Dazu gehören Docker Engine, Docker-CLI-Client, Docker Compose, Docker Content Trust, Kubernetes und Credential Helper.
(Für Linux®) Installieren Sie Docker Engine und Docker Compose auf Ihrem Computer.
Setzen Sie für Apple macOS Ordner, die lokale AEM-Autoreninstanzen enthalten, auf die Zulassungsliste.
Docker Desktop für Windows unterstützt zwei Backends, Hyper-V
(veraltet) und WSL2 (modern). Die Dateifreigabe wird
bei Verwendung von WSL2 (modern) von Docker automatisch verwaltet. Bei Verwendung von Hyper-V (alt)
müssen Sie die Dateifreigabe explizit konfigurieren.
Erstellen Sie parallel zu Ihrer Autoren- und Veröffentlichungsinstanz einen Ordner, z. B. „aem-sdk“. Beispiel: C:\aem-sdk.
Extrahieren Sie die Datei aem-forms-addon-<version>.zip\aem-forms-addon-native-<version>.zip
.
Erstellen Sie eine Umgebungsvariable AEM_HOME und verweisen Sie auf die lokale AEM-Autoreninstallation. Beispiel: C:\aem\author.
Öffnen Sie „sdk.bat“ oder „sdk.sh“ zur Bearbeitung. Legen Sie AEM_HOME auf die lokale AEM-Autoreninstallation fest. Beispiel: C:\aem\author.
Öffnen Sie eine Eingabeaufforderung und navigieren Sie zum Ordner aem-forms-addon-native-<version>
.
Stellen Sie sicher, dass Ihre lokale AEM-Autoreninstanz ausgeführt wird. Führen Sie den folgenden Befehl aus, um das SDK zu starten:
sdk.bat start
AEM_HOME=[local AEM Author installation] ./sdk.sh start
Wenn Sie die Umgebungsvariable in der Datei sdk.sh definiert haben, ist die Angabe in der Befehlszeile optional. Die Option zum Definieren der Umgebungsvariablen in der Befehlszeile wird bereitgestellt, um den Befehl auszuführen, ohne das Shell-Skript zu aktualisieren.
Sie können jetzt die lokale Entwicklungsumgebung zum Rendern des Datensatzdokuments verwenden. Laden Sie zum Testen eine XDP-Datei in Ihre Umgebung hoch und rendern Sie sie. Beispiel: http://localhost:4502/libs/xfaforms/profiles/default.print.pdf?template=crx:///content/dam/formsanddocuments/cheque-request.xdp konvertiert die XDP-Datei in das PDF-Dokument.
Verwenden Sie dieses Projekt, um adaptive Formulare zu erstellen, Konfigurationsaktualisierungen und Überlagerungen bereitzustellen, benutzerdefinierte adaptive Formularkomponenten zu erstellen sowie zu testen und benutzerdefinierten Code im lokalen Experience Manager Forms-SDK zu erstellen. Nach dem lokalen Test können Sie das Projekt in Experience Manager Forms as a Cloud Service-Produktions- und -Nichtproduktionsumgebungen bereitstellen. Beim Bereitstellen des Projekts werden auch die folgenden AEM Forms-Assets bereitgestellt:
Designs | Vorlagen | Formulardatenmodelle |
---|---|---|
Canvas 3.0 | Allgemein | Microsoft® Dynamics 365 |
Tranquil | Leer | Salesforce |
Urbane | ||
Ultramarine | ||
Beryl |
Richten Sie ein auf AEM-Archetyp Version 30 oder höher basierendes Projekt ein, um Microsoft® Dynamics 365- und Salesforce-Formulardatenmodelle mit AEM Forms as a Cloud Service abzurufen und zu verwenden.
Richten Sie ein auf AEM-Archetyp Version 32 oder höher basierendes Projekt ein, um Tranquil-, Urbane- und Ultramarine-Designs mit AEM Forms as a Cloud Service abzurufen und zu verwenden.
Einrichten des Projekts:
Klonen Sie das Cloud Manager-Git-Repository in Ihrer lokalen Entwicklungsinstanz: Ihr Cloud Manager-Git-Repository enthält ein AEM-Standardprojekt. Es basiert auf dem AEM-Archetyp. Klonen Sie Ihr Cloud Manager-Git-Repository mithilfe der Self-Service-Git-Kontoverwaltung der Cloud Manager-Benutzeroberfläche, um das Projekt in Ihre lokale Entwicklungsumgebung zu bringen. Weitere Informationen zum Zugriff auf das Repository finden Sie unter Zugriff auf Repositorys.
Erstellen Sie ein Experience Manager Forms als [Cloud Service]-Projekt: Erstellen Sie ein Experience Manager Forms als [Cloud Service]-Projekt, das auf dem neuesten AEM-Archetyp oder höher basiert. Der Archetyp unterstützt Entwickler beim einfachen Einstieg in die Entwicklung für AEM Forms as a Cloud Service. Darin sind auch einige Beispiel-Designs und Vorlagen enthalten, die Ihnen bei den ersten Schritten helfen.
Öffnen Sie die Eingabeaufforderung und führen Sie den folgenden Befehl aus, um ein Experience Manager Forms as a Cloud Service-Projekt zu erstellen.
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"
Ändern Sie im obigen Befehl appTitle
, appId
und groupId
, sodass die Werte Ihrer Umgebung entsprechen. Setzen Sie außerdem den Wert für includeFormsenrollment, includeFormSkommunikations und includeFormSheadless je nach Ihrer Lizenz und Ihren Anforderungen auf y
oder n
. „includeFormSheadless“ ist erforderlich, um adaptive Formulare basierend auf Kernkomponenten zu erstellen.
Verwenden Sie die Option includeFormsenrollment=y
zum Einschließen von Forms-spezifischen Konfigurationen, Designs, Vorlagen, Kernkomponenten und Abhängigkeiten, die zum Erstellen adaptiver Formulare erforderlich sind. Wenn Sie das Formularportal verwenden, legen Sie die Option includeExamples=y
fest. Dadurch werden dem Projekt Kernkomponenten des Formularportals hinzugefügt.
Durch Verwenden der Option includeFormscommunications=y
werden Formular-Kernkomponenten und -Abhängigkeiten einbezogen, die für die Verwendung der Kundenkommunikations-Funktion erforderlich sind.
Stellen Sie das Projekt in Ihrer lokalen Entwicklungsumgebung bereit. Sie können folgenden Befehl verwenden, um die Bereitstellung für Ihre lokale Entwicklungsumgebung durchzuführen.
mvn -PautoInstallPackage clean install
Die vollständige Liste der Befehle finden Sie unter Erstellen und Installieren
Stellen Sie den Code in Ihrer AEM Forms as a Cloud Service-Umgebung bereit.
Dispatcher ist ein Apache HTTP-Webservermodul, das eine Sicherheits- und Leistungsebene zwischen der CDN- und der AEM Publish-Ebene bereitstellt. Er ist ein integraler Bestandteil der Gesamtarchitektur von Experience Manager und sollte auch in der lokalen Entwicklungsumgebung vorhanden sein.
Führen Sie folgende Schritte aus, um den lokalen Dispatcher zu konfigurieren und ihm dann Forms-spezifische Regeln hinzuzufügen:
Die Experience Manager Das as a Cloud Service SDK enthält die empfohlene Dispatcher Tools-Version, die die lokale Konfiguration, Validierung und Simulation des Dispatchers erleichtert. Dispatcher-Tools sind Docker-basiert und bieten Befehlszeilen-Tools, um Apache HTTP-Webserver- und Dispatcher-Konfigurationsdateien in ein kompatibles Format zu übertragen und sie in Dispatcher bereitzustellen, der im Docker-Container ausgeführt wird.
Durch das Caching auf Dispatcher kann AEM Forms adaptive Formulare auf einem Client vorbefüllen. Dadurch wird die Rendering-Geschwindigkeit vorbefüllter Formulare verbessert.
Detaillierte Anweisungen zum Einrichten von Dispatcher finden Sie unter Einrichten lokaler Dispatcher-Tools
Führen Sie folgende Schritte aus, um den Dispatcher-Cache für Experience Manager Forms as a Cloud Service zu konfigurieren:
Öffnen Sie Ihr AEM-Projekt und navigieren Sie zu \src\conf.dispatcher.d\available_farms
Erstellen Sie eine Kopie der default.farm
-Datei. Zum Beispiel forms.farm
.
Öffnen Sie die erstellte forms.farm
-Datei zur Bearbeitung und ersetzen Sie den folgenden Code:
#/ignoreUrlParams {
#/0001 { /glob "*" /type "deny" }
#/0002 { /glob "q" /type "allow" }
#}
durch
/ignoreUrlParams {
/0001 { /glob "*" /type "deny" }
/0002 { /glob "dataRef" /type "allow" }
}
Speichern und schließen Sie die Datei.
Wechseln Sie zu conf.d/enabled_farms
und erstellen Sie eine symbolische Verknüpfung zur Datei forms.farm
.
Kompilieren Sie das Projekt und stellen Sie es in Ihrer AEM Forms as a Cloud Service-Umgebung bereit.
http://host:port/content/forms/af/<afName>.<locale>.html
anstelle von http://host:port/content/forms/af/afName.html?afAcceptLang=<locale>
, um die lokalisierte Version eines adaptiven Formulars aufzurufen.http://host:port/content/forms/af/<adaptivefName>.html
verwenden und „Browser-Gebietsschema verwenden“ im Konfiguratioins-Manager deaktiviert ist, wird die nicht lokalisierte Version des adaptiven Formulars bereitgestellt. Die nicht lokalisierte Sprache ist die Sprache, die bei der Entwicklung des adaptiven Formulars verwendet wurde. Das für Ihren Browser konfigurierte Gebietsschema (Browser-Gebietsschema) wird nicht berücksichtigt und es wird eine nicht lokalisierte Version des adaptiven Formulars bereitgestellt.http://host:port/content/forms/af/<adaptivefName>.html
verwenden und „Browser-Gebietsschema verwenden“ im Konfigurations-Manager aktiviert ist, wird, sofern verfügbar, eine lokalisierte Version des adaptiven Formulars bereitgestellt. Die Sprache des lokalisierten adaptiven Formulars basiert auf dem für Ihren Browser konfigurierten Gebietsschema (Browser-Gebietsschema). Dies kann dazu führen, dass nur [die erste Instanz eines adaptiven Formulars zwischengespeichert abgelegt wird]. Um zu verhindern, dass das Problem in Ihrer Instanz auftritt, lesen Sie Nur die erste Instanz eines adaptiven Formulars wird zwischengespeichert im Abschnitt zur Fehlerbehebung.Ihre lokale Entwicklungsumgebung ist bereit.
Durch die Aktivierung der Kernkomponenten für adaptive Formulare in AEM Forms as a Cloud Service können Sie mit der Erstellung, Veröffentlichung und Bereitstellung von auf Kernkomponenten basierenden adaptiven Formularen und Headless-Formularen beginnen, und das mithilfe Ihrer Instanzen von AEM Forms as a Cloud Service für mehrere Kanäle. Sie benötigen eine Umgebung mit aktivierten Kernkomponenten für adaptive Formulare, um adaptive Headless-Formulare zu verwenden.
Anweisungen finden Sie unter Aktivieren der Kernkomponenten für adaptive Formulare in AEM Forms as a Cloud Service und lokaler Entwicklungsumgebung
Ein Upgrade des SDK auf eine neue Version erfordert das Ersetzen der gesamten lokalen Entwicklungsumgebung, wodurch Code, Konfiguration und Inhalt in den lokalen Repositorys verlorengehen. Stellen Sie sicher, dass alle Codes, Konfigurationen oder Inhalte, die nicht entfernt werden sollen, sicher in Git übertragen oder als CRX-Pakete aus den lokalen Experience Manager-Instanzen exportiert werden.
Beim Upgrade des SDK werden ganz neue Autoren- und Veröffentlichungsinstanzen erstellt, einschließlich eines neuen Repositorys (Einrichten eines AEM-Projekts), d. h. alle Änderungen, die an einem früheren SDK-Repository vorgenommen wurden, gehen verloren. Durchführbare Strategien für die Beibehaltung von Inhalten zwischen SDK-Upgrades finden Sie unter Vermeiden von Inhaltsverlusten beim Upgrade des AEM-SDK
Sichern von Assets und Verschieben vom vorhandenen SDK in eine neue SDK-Umgebung:
Erstellen Sie eine Sicherung Ihres vorhandenen Inhalts.
Richten Sie eine neue SDK-Umgebung ein.
Importieren Sie die Sicherung in Ihre neue SDK-Umgebung.
Sichern Sie adaptive Formulare, Vorlagen, Formulardatenmodell, Design, Konfigurationen und benutzerdefinierten Code. Sie können folgende Aktion ausführen, um eine Sicherung zu erstellen:
Adaptive Formulare, Designs und PDF-Formulare herunterladen.
Vorlagen für adaptive Formulare exportieren.
Formulardatenmodelle herunterladen.
Bearbeitbare Vorlagen, Cloud-Konfigurationen und Workflow-Modell exportieren. Um alle zuvor erwähnten Elemente aus Ihrem bestehenden SDK zu exportieren, erstellen Sie ein CRX-Paket mit folgenden Filtern:
Exportieren Sie E-Mail-Konfigurationen und Code von Übermittlungs- und Vorbefüllungsaktionen aus Ihrer lokalen Entwicklungsumgebung. Um diese Einstellungen und Konfigurationen zu exportieren, erstellen Sie eine Kopie folgender Ordner und Dateien in Ihrer lokalen Entwicklungsumgebung:
[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
Importieren Sie adaptive Formulare, Vorlagen, Formulardatenmodell, Design, Konfigurationen und benutzerdefinierten Code in Ihre neue Umgebung. Sie können zum Importieren der Sicherung folgende Aktion ausführen:
Adaptive Formulare, Designs und PDF-Formulare in die neue SDK-Umgebung importieren.
Adaptive Formularvorlagen in die neue SDK-Umgebung importieren.
Formulardatenmodellen in die neue SDK-Umgebung hochladen.
Bearbeitbare Vorlagen, Cloud-Konfigurationen und Workflow-Modell importieren. Um alle zuvor erwähnten Elemente in Ihre neue SDK-Umgebung zu importieren, importieren Sie das CRX-Paket, das diese Elemente enthält, in Ihre neue SDK-Umgebung.
Importieren Sie E-Mail-Konfigurationen und Code von Übermittlungs- und Vorbefüllungsaktionen aus Ihrer lokalen Entwicklungsumgebung. Um diese Einstellungen und Konfigurationen zu importieren, fügen Sie folgende Dateien aus Ihrem alten in Ihr neues Archetyp-Projekt ein:
[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
Ihre neue Umgebung enthält jetzt Formulare und zugehörige Elemente aus Ihrer alten Umgebung.