[AEM Forms]{class="badge positive" title="S’applique à AEM Forms)."}
Configurer des points d’entrée REST spécifiques à un environnement pour le même formulaire adaptatif
Lorsque vous promouvez un formulaire adaptatif du développement à l’évaluation en passant par la production, le formulaire doit généralement être envoyé à un point d’entrée REST différent dans chaque environnement, tandis que le formulaire lui-même reste identique. Le codage en dur de l’URL du point d’entrée dans l’action d’envoi du formulaire rompt cette étape, car la même URL accompagne ensuite le formulaire dans chaque environnement.
Cet article décrit comment conserver un seul formulaire adaptatif portable et faire en sorte que son action Envoyer vers le point d’entrée REST soit résolue sur le point d’entrée correct dans chaque environnement. Le formulaire fait référence à une configuration REST par nom plutôt que par URL, et chaque environnement fournit sa propre valeur pour cette configuration.
Conditions préalables prerequisites
- Formulaire adaptatif basé sur les composants principaux.
- Un Conteneur de configurations créé via l’explorateur de configurations (Outils > Général > Explorateur de configurations) avec l’Configurations cloud activé.
- Autorisation d’accès à Outils > Services cloud et, pour la promotion, Gestionnaire de packages sur chaque environnement (ou un pipeline de déploiement Cloud Manager 🔗).
Créer la configuration de service RESTful lors de l’évaluation create-rest-configuration
Sur l’instance d’auteur d’évaluation, créez la configuration nommée à laquelle votre formulaire fait référence. Définissez l’URL du point d’entrée du service sur le point d’entrée REST ou webhook pour l’évaluation.
-
Accédez à Outils > Services cloud > Sources de données.
-
Sélectionnez votre conteneur de configuration, puis sélectionnez Créer.
-
Dans l’onglet Général, indiquez un Nom pour la configuration (par exemple,
restTest). Utilisez le même nom sur chaque environnement afin que le formulaire soit résolu de manière cohérente après la promotion. -
Dans l’onglet Paramètres d’authentification, configurez :
- Sélectionnez le service RESTful : Point d’entrée du service.
- Type de méthode : POST.
- URL du point d’entrée du service : URL du point d’entrée d’évaluation (par exemple, URL de webhook que vous utilisez pour tester les envois depuis l’évaluation).
- Type de contenu par exemple, Données de formulaire en plusieurs parties.
- Type d’authentification : selon les besoins de votre point d’entrée (par exemple, Aucune ou Authentification de base).
-
Sélectionnez Enregistrer et fermer.
Pointez le formulaire adaptatif sur le conteneur de configuration . set-configuration-container
Lors de l’évaluation, associez le formulaire au conteneur de configuration qui contient votre configuration REST.
-
Dans Forms et documents, sélectionnez votre formulaire adaptatif et ouvrez Propriétés.
-
Dans l’onglet De base, définissez Conteneur de configurations sur le conteneur qui contient la configuration de votre service RESTful (par exemple,
/conf/restConfigTest). -
Sélectionnez Enregistrer et fermer.
Configuration de l’action Envoyer vers le point d’entrée REST configure-submit-action
Lors de l’évaluation, configurez le formulaire à envoyer par le biais de la configuration REST nommée au lieu d’une URL codée en dur. Pour consulter la référence complète de l’action d’envoi, voir Configurer un formulaire adaptatif pour l’action d’envoi de point d’entrée REST.
-
Ouvrez le formulaire adaptatif pour le modifier, sélectionnez le composant Conteneur de guides et ouvrez ses propriétés Conteneur de formulaires adaptatifs.
-
Ouvrez l’onglet Envoi et, dans la liste déroulante Action d’envoi, sélectionnez Envoyer vers le point d’entrée REST.
-
Sous Configuration de l’action, sélectionnez Activer la requête POST.
-
Pour Sélectionner une option, choisissez Configuration (et non URL).
-
Sélectionnez la configuration nommée (par exemple,
restTest) dans la liste. -
Sélectionnez Terminé.
Le formulaire résout désormais son point d’entrée d’envoi par le biais de la configuration nommée plutôt qu’une URL fixe.
Promouvoir le formulaire de l’évaluation à la production promote-across-environments
Après avoir configuré et testé sur l’évaluation, déplacez le même formulaire et le même conteneur de configuration vers la production. Vous pouvez utiliser l’une des approches suivantes.
Option 1 : approche auteur-package option-package
Utilisez cette option lorsque les auteurs et autrices gèrent le formulaire et la configuration directement dans chaque environnement.
-
Sur l’instance d’auteur staging, créez un package de contenu dans Package Manager qui inclut le formulaire et son conteneur de configuration, par exemple :
/content/dam/formsanddocuments/<your-form-path>/content/forms/af/<your-form-path>/conf/<your-config-container>(qui contient des.../settings/cloudconfigs/fdm/<your-config>)
-
Téléchargez le package et installez-le sur l’instance d’auteur de production.
Option 2 : Approche de remplacement basée sur le contexte (recommandée pour l’automatisation) option-context-aware
Utilisez cette option lorsque vous souhaitez une configuration empaquetée dont le point d’entrée, le nom d’utilisateur et le mot de passe sont résolus automatiquement par environnement, sans modification manuelle après le déploiement. Cette approche remplace les propriétés de configuration à l’aide des variables d’environnement Cloud Manager.
Pour les configurations REST, vous créez généralement des variables d’environnement pour les propriétés serviceEndPoint, userName et password, puis vous les référencez à partir d’un fichier de configuration OsgiConfigurationOverrideProvider dans votre projet.
Pour la procédure complète, voir Configurations cloud contextuelles.
Mettre à jour l’URL du point d’entrée en production configure-endpoint-on-production
Après avoir installé le package en production, le formulaire adaptatif et la configuration REST nom (par exemple, restTest) correspondent à l’évaluation. L’URL du point d’entrée du service dans cette configuration pointe toujours vers le point d’entrée d’évaluation à partir du package. Ouvrez la configuration en production et remplacez-la par l’URL du point d’entrée de production.
-
Sur l’instance d’auteur de production, accédez à Outils > Services cloud > Sources de données.
-
Sélectionnez le conteneur de configurations que vous avez déployé (par exemple,
restConfigTest), puis ouvrez la configuration nommée (par exemple,restTest). -
Dans l’onglet Paramètres d’authentification, définissez URL du point d’entrée du service sur le point d’entrée REST de production ou webhook.
-
Sélectionnez Enregistrer et fermer.
Pendant le test, un inspecteur de requêtes, tel qu’un service de capture webhook, vous donne une URL unique par environnement afin que vous puissiez confirmer quel point d’entrée reçoit chaque envoi.
Vérifier le routage verify
Envoyez le même formulaire d’évaluation et de production et confirmez chaque publication d’environnement à son propre point d’entrée, et non à l’URL de l’autre environnement.
-
Sur l’instance d’auteur staging, ouvrez le formulaire adaptatif et envoyez-le avec des données de test (par exemple, saisissez
stagetestdans un champ de texte). Vérifiez que la requête POST arrive à l’URL staging Service Endpoint que vous avez configurée lors de l’évaluation. -
Sur l’instance d’auteur de production, ouvrez le même formulaire adaptatif et envoyez-le avec des données de test (par exemple, saisissez
prodtestdans un champ de texte). Vérifiez que la requête POST arrive à l’URL de production de point d’entrée du service que vous avez configurée en production, et non à l’URL d’évaluation. -
Vérifiez que chaque requête utilise le type de contenu attendu (par exemple, Données de formulaire en plusieurs parties) et inclut les données de formulaire envoyées. Utilisez un véritable point d’entrée sécurisé (HTTPS) pour la production.
Bonnes pratiques best-practices
- Utilisez une configuration identique nom sur chaque environnement afin que le formulaire soit résolu de manière cohérente après la promotion.
- Conservez le point d’entrée valeur spécifique à l’environnement. Ne codez jamais en dur l’URL d’un seul environnement dans l’action d’envoi du formulaire.
- Pour les points d’entrée de production, assurez-vous que l’URL est sécurisée (HTTPS) et que le chemin de réception est configuré pour gérer la requête POST de manière appropriée pour votre modèle d’authentification.
- Privilégiez l’approche de remplacement basée sur le contexte lorsque vous souhaitez que le déploiement soit répétable et exempt de modifications manuelles après le déploiement.