Configuration de l’environnement de développement local pour AEM Forms

Lorsque vous définissez et configurez un environnement ​ Adobe Experience Manager Forms as a ​ Cloud Service, vous configurez des environnements de développement, d’évaluation et de production sur le cloud. Vous pouvez en outre également définir et configurer un environnement de développement local.

Vous pouvez utiliser l’environnement de développement local pour effectuer les actions suivantes sans vous connecter à l’environnement de développement cloud :

• Créez des formulaires et les ressources associées (thèmes, modèles, actions d’envoi personnalisées, etc.).
• Convertissez des formulaires PDF en formulaires adaptatifs.
• Créez des applications pour générer des communications client à la demande ou en mode batch.

Une fois qu’un formulaire adaptatif ou les ressources associées sont prêts sur l’instance de développement locale ou qu’une application pour générer des [communications client] est prête, vous pouvez exporter l’application de formulaire adaptatif ou de communications client de l’environnement de développement local vers un environnement de Cloud Service pour effectuer d’autres tests ou passer aux environnements de production.

Vous pouvez également développer et tester du code personnalisé (composants personnalisés, par exemple) et le service de préremplissage sur l’environnement de développement local. Lorsque le code personnalisé est testé et prêt, vous pouvez utiliser le référentiel Git de votre environnement de développement Cloud Service pour le déployer.

Pour configurer un nouvel environnement de développement local et l’utiliser pour développer des activités, effectuez les actions suivantes dans l’ordre indiqué :

• Configuration des outils de développement

• Configuration des instances locales d’auteur et de publication

• Ajout de l’archive Forms aux instances de développement local et configuration des utilisateurs

• Configuration d’un environnement de développement local pour les microservices

• Configuration d’un projet de développement

• Configuration des outils du Dispatcher local

Conditions préalables

Pour configurer un environnement de développement local, vous avez besoin des logiciels ci-après. Téléchargez ces logiciels avant de commencer à configurer l’environnement de développement local :

Téléchargement de la dernière version du logiciel à partir de la distribution logicielle

Pour télécharger la dernière version du SDK Adobe Experience Manager as a Cloud Service, l’archive de fonctionnalités Experience Manager Forms (module complémentaire AEM Forms), les ressources de référence de formulaires ou Forms Designer depuis la distribution logicielle :

1. Connectez-vous à https://experience.adobe.com/#/downloads avec votre Adobe ID.

   REMARQUE

   Votre organisation Adobe doit être configurée pour AEM as a Cloud Service afin de télécharger le SDK AEM as a Cloud Service.

2. Accédez à l’onglet AEM as a Cloud Service.

3. Effectuez un tri par date de publication dans l’ordre décroissant.

4. Cliquez sur le dernier SDK Adobe Experience Manager as a Cloud Service, l’archive de fonctionnalités Experience Manager Forms (module complémentaire AEM Forms), les ressources de référence de formulaires ou Forms Designer.

5. Examinez et acceptez le contrat de licence de l’utilisateur final. Appuyez sur le bouton Télécharger.

Configuration des outils de développement pour les projets AEM

Le projet Adobe Experience Manager Forms est une base de code personnalisé. Il contient le code, les configurations et le contenu qui est déployé via Cloud Manager sur Adobe Experience Manager as a Cloud Service. L’archétype Maven de projet AEM fournit la structure de base du projet.

Configurez les outils de développement suivants à utiliser pour votre projet Adobe Experience Manager de développement :

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

Pour obtenir des instructions détaillées sur la configuration des outils de développement susmentionnés, voir Configuration des outils de développement.

Configuration d’un environnement Experience Manager local pour le développement

Le SDK Cloud Service fournit un fichier QuickStart. Il exécute une version locale d’Experience Manager. Vous pouvez exécuter les instances d’auteur ou de publication localement.

Bien que QuickStart fournisse un environnement de développement local, il ne dispose pas de toutes les fonctionnalités disponibles dans Adobe Experience Manager as a Cloud Service. Ainsi, testez toujours vos fonctionnalités et votre code avec l’environnement de développement Adobe Experience Manager as a Cloud Service avant de déplacer les fonctionnalités vers un environnement d’évaluation ou de production.

Pour installer et configurer l’environnement Experience Manager local, procédez comme suit :

• Téléchargez et extrayez le SDK Adobe Experience Manager as a Cloud Service.
• Configurez une instance d’auteur.
• Configurez une instance de publication.

Ajout de l’archive Forms aux instances locales d’auteur et de publication et configurations des utilisateurs spécifiques à Forms

Pour ajouter l’archive Forms aux instances d’Experience Manager et configurer les utilisateurs spécifiques à Forms, effectuez les étapes suivantes dans l’ordre indiqué :

Installation de la dernière archive de fonctionnalités de module complémentaire de Forms

L’archive des fonctionnalités Adobe Experience Manager Forms as a Cloud Service fournit des outils pour créer, mettre en forme et optimiser les formulaires adaptatifs dans l’environnement de développement local. Installez le package pour créer un formulaire adaptatif et utiliser diverses autres fonctionnalités d’AEM Forms. Pour installer le package :

1. Téléchargez et extrayez la dernière archive AEM Forms pour votre système d’exploitation à partir de la distribution logicielle.

2. Accédez au répertoire crx-quickstart/install. Si le dossier n’existe pas, créez-le.

3. Arrêtez votre instance AEM, placez l’archive de fonctionnalités de module complémentaire AEM Forms, aem-forms-addon-<version>.far, dans le dossier d’installation, puis redémarrez l’instance.

Configuration des utilisateurs et des autorisations

Créez des utilisateurs comme Développeur de formulaires et Professionnel de formulaires et ajoutez-les à des groupes de formulaires prédéfinis pour leur fournir les autorisations requises. Le tableau suivant répertorie tous les types d’utilisateurs et les groupes prédéfinis pour chaque type d’utilisateur de formulaires :

Configuration de l’environnement de développement local pour le document d’enregistrement

AEM Forms as a Cloud Services fournit un environnement SDK Docker qui facilite le développement d’un document d’enregistrement et l’utilisation d’autres microservices. Il vous libère de la configuration manuelle de fichiers binaires et d’adaptations spécifiques à la plateforme. Pour configurer l’environnement :

1. Installez et configurez Docker.

   • (Pour Microsoft® Windows) Installez Docker Desktop. Il configure Docker Engine et docker-compose sur votre ordinateur.

   • (Apple macOS) Installez Docker Desktop pour Mac. Il comprend Docker Engine, le client de ligne de commande Docker, Docker Composition, Docker Content Trust, Kubernetes et Credential Helper.

   • (Pour Linux®) Installez Docker Engine et Docker Compose sur votre ordinateur.

   REMARQUE

   • Pour Apple macOS, placez sur liste autorisée les dossiers contenant des instances d’auteur AEM locales.

   • Docker Desktop pour Windows prend en charge deux back-ends, Hyper-V
     (hérité) et WSL2 (moderne). Le partage de fichiers est automatiquement
     géré par Docker lors de l’utilisation de WSL2 (moderne). Vous devez
     configurer explicitement le partage de fichiers lors de l’utilisation d’Hyper-V (hérité).

2. Créez un dossier, par exemple aem-sdk, parallèlement à vos instances d’auteur et de publication, comme C:\aem-sdk.

3. Extrayez le fichier aem-forms-addon-<version>.zip\aem-forms-addon-native-<version>.zip.

   

4. Créez une variable d’environnement AEM_HOME et pointez vers l’installation locale de l’auteur AEM, par exemple C:\aem\author.

5. Ouvrez sdk.bat ou sdk.sh pour le modification. Définissez AEM_HOME pour pointer vers l’installation locale de l’auteur AEM, par exemple C:\aem\author.

6. Ouvrez une invite de commandes et accédez au dossier aem-forms-addon-native-<version>.

7. Assurez-vous que votre instance d’auteur AEM locale est en cours d’exécution. Exécutez la commande suivante pour démarrer le SDK :

   • (sous Microsoft® Windows) sdk.bat start
   • (sous Linux® ou Apple macOS) AEM_HOME=[local AEM Author installation] ./sdk.sh start
   REMARQUE

   Si vous avez défini la variable d’environnement dans le fichier sdk.sh, vous n’êtes pas obligé de la spécifier en ligne de commande. L’option permettant de définir la variable d’environnement sur la ligne de commande est fournie pour exécuter la commande sans mettre à jour le script shell.

   

Vous pouvez maintenant utiliser l’environnement de développement local pour générer un document d’enregistrement. Pour effectuer un test, chargez un fichier XDP dans votre environnement et effectuez son rendu, Par exemple : http://localhost:4502/libs/xfaforms/profiles/default.print.pdf?template=crx:///content/dam/formsanddocuments/cheque-request.xdp convertit le fichier XDP en document PDF.

Configuration d’un projet de développement pour Forms basé sur l’archétype Experience Manager

Utilisez ce projet pour créer des formulaires adaptatifs, déployer des mises à jour de configuration et des superpositions, créer des composants de formulaire adaptatif personnalisés, effectuer des tests et créer du code personnalisé sur le SDK Experience Manager Forms local. Après avoir effectué des tests localement, vous pouvez déployer le projet sur les environnements Experience Manager Forms as a Cloud Service de production et hors production. Lorsque vous déployez le projet, les ressources AEM Forms suivantes sont également déployées :

Pour configurer le projet :

1. Clonez le référentiel Git Cloud Manager sur votre instance de développement locale : votre référentiel Git Cloud Manager contient un projet AEM par défaut. Il est basé sur l’archétype AEM. Clonez votre référentiel Git Cloud Manager à l’aide de la gestion de compte Git en libre-service depuis l’interface utilisateur de Cloud Manager pour intégrer le projet à votre environnement de développement local. Pour plus d’informations sur l’accès au référentiel, consultez Accès aux référentiels.

2. Créez un projet Experience Manager Forms as a [Cloud Service] : créez un projet Experience Manager Forms as a [Cloud Service] basé sur le dernier archétype AEM. L’archétype permet aux développeurs de commencer facilement le développement pour AEM Forms as a Cloud Service. Il comprend également des exemples de thème et de modèle pour vous aider à démarrer rapidement.

   Ouvrez l’invite de commandes et exécutez la commande ci-après pour créer un projet Experience Manager Forms as a Cloud Service.

   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"
   

   Modifiez appTitle, appId et groupId dans la commande ci-dessus pour refléter votre environnement. En outre, définissez la valeur de includeFormsenrollment, includeFormscommunications et includeFormless sur y ou n en fonction de votre licence et de vos exigences. L’élément includeFormsheadless est obligatoire pour créer des formulaires adaptatifs basés sur les composants principaux.

   • Utilisez l’option includeFormsenrollment=y pour inclure des configurations, des thèmes, des modèles, des composants principaux et des dépendances spécifiques à Forms, nécessaires à la création de formulaires adaptatifs. Si vous utilisez Portail Formulaires, définissez l’option includeExamples=y. Vous ajoutez ainsi les composants principaux Portail Formulaires dans le projet.

   • Utilisez l’option includeFormscommunications=y afin d’ajouter les composants principaux Forms et les dépendances nécessaires pour inclure la fonctionnalité de communications client.

     AVERTISSEMENT

     • Lors de la création d’un projet Archetype avec la version 45, la variable [AEM archetype Project Folder]/pom.xml définit initialement la version des composants principaux de formulaires sur 2.0.64. Avant de créer ou de déployer le projet Archetype, mettez à jour la version des composants principaux de formulaires vers la version 2.0.62.

3. Déployez le projet sur votre environnement de développement local. Vous pouvez utiliser la commande suivante pour effectuer un déploiement sur votre environnement de développement local :

   mvn -PautoInstallPackage clean install

   Pour obtenir la liste complète des commandes, voir Création et installation.

4. Déployez le code dans votre environnement AEM Forms as a Cloud Service.

Configuration des outils du Dispatcher local

Le Dispatcher est un module de serveur Web HTTP Apache qui fournit une couche de sécurité et de performances entre le CDN et le niveau AEM Publish. Il fait partie intégrante de l’architecture globale d’Experience Manager et doit faire partie de l’environnement de développement local.

Pour configurer le Dispatcher local et y ajouter ensuite des règles spécifiques à Forms, procédez comme suit :

Configuration du Dispatcher local

La variable Experience Manager Le SDK as a Cloud Service inclut la version recommandée des outils Dispatcher qui facilite la configuration, la validation et la simulation locale de Dispatcher. Les outils du Dispatcher sont basés sur Docker et fournissent des outils en ligne de commandes pour transpiler les fichiers de configuration du serveur web HTTP Apache et du Dispatcher dans un format compatible et les déployer sur le Dispatcher s’exécutant dans le conteneur Docker.

La mise en cache sur le Dispatcher permet à AEM Forms de préremplir les formulaires adaptatifs sur un client. Elle améliore la vitesse de rendu des formulaires préremplis.

Pour obtenir des instructions détaillées sur la configuration du Dispatcher, voir Configuration des outils du Dispatcher local.

Ajout de règles spécifiques à Forms au Dispatcher

Pour configurer le cache du Dispatcher pour Experience Manager Forms en tant que Cloud Service, procédez comme suit :

1. Ouvrez votre projet AEM et accédez à \src\conf.dispatcher.d\available_farms

2. Créez une copie du fichier default.farm, par exemple, forms.farm.

3. Ouvrez le forms.farm pour modifier et remplacer le code suivant :

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

   par

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

4. Enregistrez et fermez votre fichier.

5. Accédez à conf.d/enabled_farms et créez un lien symbolique vers le fichier forms.farm.

6. Compilez et déployez le projet sur l’environnement AEM Forms as a Cloud Service.

Considérations relatives à la mise en cache

• La mise en cache du Dispatcher permet à AEM Forms de préremplir les formulaires adaptatifs sur un client. Elle améliore la vitesse de rendu des formulaires préremplis.
• Par défaut, la mise en cache des fonctionnalités de contenu sécurisé est désactivée. Pour activer la fonctionnalité, vous pouvez exécuter les instructions fournies dans l’article Mise en cache du contenu sécurisé.
• Le Dispatcher peut ne pas réussir à invalider certains formulaires adaptatifs et formulaires adaptatifs associés. Pour résoudre ces problèmes, consultez AEM Forms Mise en cache dans la section de dépannage.
• Mise en cache de formulaires adaptatifs localisés :
  • Utilisez le format d’URL http://host:port/content/forms/af/<afName>.<locale>.html pour demander une version localisée d’un formulaire adaptatif au lieu de http://host:port/content/forms/af/afName.html?afAcceptLang=<locale>
  • L’option des paramètres régionaux du navigateur est désactivée par défaut. Pour modifier les paramètres régionaux du navigateur :
• Lorsque vous utilisez le format d’URL http://host:port/content/forms/af/<adaptivefName>.html et que l’option Utiliser les paramètres régionaux du navigateur située dans le gestionnaire de configuration est désactivée, la version non localisée du formulaire adaptatif est diffusée. La langue non localisée est celle utilisée lors du développement du formulaire adaptatif. Les paramètres régionaux configurés pour votre navigateur (paramètres régionaux du navigateur) ne sont pas pris en compte et une version non localisée du formulaire adaptatif est diffusée.
• Lorsque vous utilisez le format d’URL http://host:port/content/forms/af/<adaptivefName>.html et que l’option Utiliser les paramètres régionaux du navigateur située dans le gestionnaire de configuration est activée, la version localisée du formulaire adaptatif est diffusée. La langue du formulaire adaptatif localisé est basée sur les paramètres régionaux configurés pour votre navigateur (paramètres régionaux du navigateur). Elle peut conduire à la [mise en cache seulement de la première instance d’un formulaire adaptatif]. Pour éviter que le problème ne se produise sur votre instance, consultez seule la première instance d’un formulaire adaptatif est mise en cache dans la section de dépannage.

Votre environnement de développement local est prêt.

Activer les composants principaux des formulaires adaptatifs AEM Forms as a Cloud Service et dans l’environnement de développement local

L’activation des composants principaux Forms adaptatifs sur AEM Forms as a Cloud Service vous permet de commencer à créer, publier et diffuser des composants principaux basés sur Forms adaptatif et Forms sans affichage à l’aide de vos instances de Cloud Service AEM Forms sur plusieurs canaux. L’environnement des composants principaux des formulaires adaptatifs doit être activé pour utiliser les formulaires adaptatifs découplés.

Pour obtenir des instructions, voir Activer les composants principaux des formulaires adaptatifs AEM Forms as a Cloud Service et dans l’environnement de développement local

Mise à niveau de votre environnement de développement local

La mise à niveau du SDK vers une nouvelle version nécessite le remplacement de l’ensemble de l’environnement de développement local, ce qui entraîne la perte de l’intégralité du code, de la configuration et du contenu dans les référentiels locaux. Assurez-vous que l’intégralité du code, de la configuration ou du contenu ne devant pas être détruit est validé en toute sécurité dans Git ou exporté depuis les instances Experience Manager locales en tant que packages CRX.

Comment éviter la perte de contenu lors de la mise à niveau du SDK

La mise à niveau du SDK crée de manière efficace une toute nouvelle instance d’auteur et de publication, y compris un nouveau référentiel (Configuration d’un projet AEM), ce qui signifie que toutes les modifications apportées au référentiel d’un SDK précédent sont perdues. Pour obtenir des stratégies viables afin de conserver le contenu entre les mises à niveau du SDK, voir Comment éviter la perte de contenu lors de la mise à niveau du SDK AEM

Sauvegarde et importation de contenu spécifique à Forms dans un nouvel environnement de SDK

Pour sauvegarder et déplacer des ressources du SDK existant vers un nouvel environnement de SDK :

• Créez une sauvegarde de votre contenu existant.

• Configurez un nouvel environnement de SDK.

• Importez la sauvegarde dans votre nouvel environnement de SDK.

Création d’une sauvegarde de votre contenu existant

Sauvegardez les formulaires adaptatifs, les modèles, le modèle de données de formulaire, le thème, les configurations et le code personnalisé. Vous pouvez exécuter l’action suivante pour créer une sauvegarde :

1. Téléchargez les formulaires adaptatifs, les thèmes et les formulaires PDF.

2. Exportez les modèles de formulaire adaptatif.

3. Téléchargez les modèles de données de formulaire.

4. Exportez les modèles modifiables, les configurations de cloud et le modèle de processus. Pour exporter tous les éléments susmentionnés à partir de votre SDK existant, créez un package-CRX avec les filtres suivants :

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

5. Exportez les configurations de courrier électronique, le code d’envoi et d’actions de préremplissage à partir de votre environnement de développement local. Pour exporter ces paramètres et cette configuration, créez une copie des dossiers et fichiers suivants sur votre environnement de développement local :

   • [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

Importation de la sauvegarde dans votre nouvel environnement de SDK

Importez les formulaires adaptatifs, les modèles, le modèle de données de formulaire, le thème, les configurations et le code personnalisé dans votre nouvel environnement. Vous pouvez effectuer l’action suivante pour importer la sauvegarde :

1. Importez les formulaires adaptatifs, les thèmes et les formulaires PDF dans de nouveaux environnements de SDK.

2. Importez les modèles de formulaire adaptatif dans un nouvel environnement de SDK.

3. Chargez les modèles de données de formulaire dans un nouvel environnement SDK.

4. Importez les modèles modifiables, les configurations de cloud et le modèle de processus. Pour importer tous les éléments mentionnés précédemment dans votre nouvel environnement de SDK, importez le package CRX contenant ces éléments dans votre nouvel environnement SDK.

5. Importez les configurations de courrier électronique, le code d’envoi et d’actions de préremplissage à partir de votre environnement de développement local. Pour importer ces paramètres et cette configuration, importez les fichiers suivants de votre ancien projet d’archétype vers le nouveau :

   • [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

Votre nouvel environnement comporte maintenant des formulaires et des ressources connexes de l’ancien environnement.