Incorporation d’un formulaire adaptatif dans une page web externe

Dernière mise à jour : 2023-09-19
  • Créé pour :
  • User

Adobe recommande d’utiliser la capture de données moderne et extensible. Composants principaux pour création d’un Forms adaptatif ou Ajout de Forms adaptatif à des pages AEM Sites. Ces composants représentent une avancée significative dans la création de Forms adaptatif, ce qui garantit des expériences utilisateur impressionnantes. Cet article décrit une approche plus ancienne de la création de Forms adaptatif à l’aide de composants de base.

Vous pouvez incorporer des formulaires adaptatifs dans une page d’AEM Sites ou une page Web hébergée en dehors d’AEM. Le formulaire adaptatif incorporé est entièrement fonctionnel et les utilisateurs et utilisatrices peuvent le remplir et l’envoyer sans quitter la page. Il permet à l’utilisateur de rester dans le contexte d’autres éléments de la page web et d’interagir simultanément avec le formulaire.

Prérequis

Effectuez les étapes suivantes avant d’incorporer un formulaire adaptatif à un site web externe

Incorporation d’un formulaire adaptatif

Vous pouvez incorporer un formulaire adaptatif en insérant quelques lignes de code JavaScript dans la page web. L’API dans le code envoie une requête HTTP au serveur AEM pour les ressources de formulaire adaptatif et injecte le formulaire adaptatif dans le conteneur de formulaire spécifié.

Pour incorporer le formulaire adaptatif :

  1. Créez une page web sur votre site web avec le code suivant :

    <!doctype html>
    <html>
      <head>
        <title>This is the title of the webpage!</title>
        <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
      </head>
      <body>
      <div class="customafsection"/>
        <p>This section is replaced with the adaptive form.</p>
    
     <script>
     var options = {path:"/content/forms/af/locbasic.html", dataRef:"", themepath:"", CSS_Selector:".customafsection"};
     alert(options.path);
     var loadAdaptiveForm = function(options){
     //alert(options.path);
        if(options.path) {
            // options.path refers to the path of the adaptive form
            // For Example: /content/forms/af/ABC, where ABC is the adaptive form
            // Note: If AEM server is running on a context path, the adaptive form URL must contain the context path
            var path = options.path;
            path += "/jcr:content/guideContainer.html";
            $.ajax({
                url  : path ,
                type : "GET",
                data : {
                    // Set the wcmmode to be disabled
                    wcmmode : "disabled"
                    // Set the data reference, if any
                   // "dataRef": options.dataRef
                    // Specify a different theme for the form object
                  //  "themeOverride" : options.themepath
                },
                async: false,
                success: function (data) {
                    // If jquery is loaded, set the inner html of the container
                    // If jquery is not loaded, use APIs provided by document to set the inner HTML but these APIs would not evaluate the script tag in HTML as per the HTML5 spec
                    // For example: document.getElementById().innerHTML
                    if(window.$ && options.CSS_Selector){
                        // HTML API of jquery extracts the tags, updates the DOM, and evaluates the code embedded in the script tag.
                        $(options.CSS_Selector).html(data);
                    }
                },
                error: function (data) {
                    // any error handler
                }
            });
        } else {
            if (typeof(console) !== "undefined") {
                console.log("Path of Adaptive Form not specified to loadAdaptiveForm");
            }
        }
     }(options);
    
     </script>
      </body>
    </html>
    
  2. Dans le code incorporé :

    • Modifiez la valeur de la variable options.path avec le chemin d’accès à l’URL de publication du formulaire adaptatif. Si le serveur AEM s’exécute sur un chemin de contexte, assurez-vous que l’URL inclut ce chemin. Indiquez toujours le nom complet du formulaire adaptatif, y compris son extension. Par exemple, le code ci-dessus et le formulaire adaptatif résident sur le même serveur AEM Forms, de sorte que l’exemple utilise le chemin d’accès contextuel du formulaire adaptatif. /content/forms/af/locbasic.html.
    • Remplacez options.dataRef par les attributs à transmettre avec l’URL. Vous pouvez utiliser la variable dataref pour pré-remplir un formulaire adaptatif.
    • Remplacer options.themePath avec le chemin d’accès à un thème autre que le thème configuré dans le formulaire adaptatif. Vous pouvez également spécifier le chemin du thème à l’aide de l’attribut de requête.
    • CSS_Selector est le sélecteur CSS du conteneur de formulaire dans lequel le formulaire adaptatif est incorporé. Par exemple, la classe CSS .customafsection est le sélecteur CSS dans l’exemple ci-dessus.

Le formulaire adaptatif est incorporé à la page web. Observez ce qui suit dans le formulaire adaptatif incorporé :

  • L’en-tête et le pied de page du formulaire adaptatif d’origine ne sont pas inclus dans le formulaire incorporé.
  • Les brouillons et les formulaires envoyés sont disponibles dans l’onglet Brouillons et envois du portail des formulaires.
  • L’action Envoyer configurée sur le formulaire adaptatif d’origine est conservée dans le formulaire incorporé.
  • Les règles de formulaire adaptatif sont conservées et entièrement fonctionnelles dans le formulaire incorporé.
  • Le ciblage d’expérience et les tests A/B configurés dans le formulaire adaptatif d’origine ne fonctionnent pas dans le formulaire incorporé.
  • Si Adobe Analytics est configuré sur le formulaire d’origine, les données d’analyse sont capturées par le serveur Adobe Analytics. Cependant, elle n’est pas disponible dans le rapport d’analyse Forms.

Exemple de topologie

La page Web externe qui incorpore le formulaire adaptatif envoie des requêtes au serveur AEM, qui se trouve généralement derrière le pare-feu dans un réseau privé. Pour vous assurer que les demandes sont dirigées en toute sécurité vers le serveur AEM, il est recommandé de configurer un serveur proxy inverse.

Examinons un exemple de configuration d’un serveur proxy inverse Apache 2.4 sans Dispatcher. Dans cet exemple, vous hébergez le serveur AEM avec /forms chemin d’accès et mappage du contexte /forms pour le proxy inverse. Cela garantit que toute demande de /forms sur le serveur Apache sont dirigés vers l’instance AEM. Cette topologie permet de réduire le nombre de règles au niveau de la couche de Dispatcher, car toutes les requêtes sont précédées du préfixe /forms routage vers le serveur AEM.

  1. Ouvrez le fichier de configuration httpd.conf et supprimez les commentaires des lignes de code suivantes. Vous pouvez également ajouter ces lignes de code dans le fichier.

    LoadModule proxy_html_module modules/mod_proxy_html.so
    LoadModule proxy_http_module modules/mod_proxy_http.so
    
  2. Configurez les règles de proxy en ajoutant les lignes de code suivantes dans le fichier de configuration httpd-proxy.conf.

    ProxyPass /forms https://[AEM_Instance]/forms
    ProxyPassReverse /forms https://[AEM_Instance]/forms
    

    Remplacez [AEM_Instance] par l’URL de publication du serveur AEM dans les règles.

Si vous ne montez pas le serveur AEM sur un chemin d’accès contextuel, les règles de proxy au niveau de la couche Apache sont les suivantes :

ProxyPass /content https://<AEM_Instance>/content
ProxyPass /etc https://<AEM_Instance>/etc
ProxyPass /etc.clientlibs https://<AEM_Instance>/etc.clientlibs
# CSRF Filter
ProxyPass /libs/granite/csrf/token.json https://<AEM_Instance>/libs/granite/csrf/token.json

ProxyPassReverse /etc https://<AEM_Instance>/etc
ProxyPassReverse /etc.clientlibs https://<AEM_Instance>/etc.clientlibs
# written for thank you page and other URL present in AF during redirect
ProxyPassReverse /content https://<AEM_Instance>/content
REMARQUE

Si vous configurez une autre topologie, veillez à ajouter les URL d’envoi, de préremplissage et autres à la liste autorisée au niveau de la couche de Dispatcher.

Bonnes pratiques

Lorsque vous incorporez un formulaire adaptatif dans une page web, tenez compte des bonnes pratiques suivantes :

  • Assurez-vous que les règles de style définies dans la page web CSS ne sont pas en conflit avec l’objet de formulaire CSS. Pour éviter les conflits, vous pouvez réutiliser la page web CSS dans le thème du formulaire adaptatif à l’aide de la bibliothèque cliente AEM. Pour plus d’informations sur l’utilisation de la bibliothèque cliente dans les thèmes de formulaire adaptatif, voir Thèmes dans AEM Forms.
  • Faites en sorte que le conteneur du formulaire dans la page web utilise toute la largeur de la fenêtre. Cela permet de s’assurer que les règles CSS configurées pour les appareils mobiles fonctionnent sans aucune modification. Si le conteneur de formulaires ne prend pas toute la largeur de la fenêtre, vous devez écrire une feuille CSS personnalisée pour que le formulaire s’adapte à différents périphériques mobiles.
  • Utilisez l’API [getData](https://helpx.adobe.com/fr/experience-manager/6-3/forms/javascript-api/GuideBridge.html) pour obtenir la représentation XML ou JSON des données de formulaire dans le client.
  • Utilisez l’API [unloadAdaptiveForm](https://helpx.adobe.com/fr/experience-manager/6-3/forms/javascript-api/GuideBridge.html) pour décharger le formulaire adaptatif à partir du DOM HTML.
  • Configurez l’en-tête access-control-origin lors de l’envoi d’une réponse d’un serveur AEM.

Activation d’AEM Forms pour diffuser des formulaires adaptatifs sur un site interdomaines

  1. Sur l’instance de publication AEM, accédez au gestionnaire de la console web AEM à l’adresse https://'[server]:[port]'/system/console/configMgr.
  2. Recherchez et ouvrez la configuration Apache Sling Referrer Filter.
  3. Dans le champ Hôtes autorisés, spécifiez le domaine dans lequel la page Web se trouve. Cette opération permet à l’hôte de créer des requêtes POST vers le serveur AEM. Vous pouvez également utiliser l’expression régulière pour spécifier une série de domaines d’application externes.

Sur cette page