Incrustar formulario adaptable en una página web externa

Última actualización: 2024-01-16
  • Creado para:
  • Admin
    Developer
    User
Versión Vínculo del artículo
AEM 6.5 Haga clic aquí
AEM as a Cloud Service Este artículo

Puede integrar formularios adaptables en una página de AEM Sites o en una página web alojada fuera de AEM. El formulario adaptable incrustado es completamente funcional, y los usuarios pueden rellenarlo y enviarlo sin abandonar la página. Esto permite al usuario mantenerse en el contexto de otros elementos de la página web e interactuar simultáneamente con el formulario.

Requisitos previos

Realice los siguientes pasos antes de incrustar un formulario adaptable en un sitio web externo

  • Publique el formulario adaptable que desee integrar en la instancia de publicación del servidor de AEM Forms.
  • Cree o identifique una página web en su sitio web para alojar el formulario adaptable. Asegúrese de que la página web pueda leer archivos jQuery de una CDN o de que tenga una copia local de jQuery incrustada. jQuery es necesario para procesar un formulario adaptable.
  • Cuando el servidor de AEM y la página web están en dominios diferentes, realice los pasos que se enumeran en la sección permitir que AEM Forms ofrezca formularios adaptables a un sitio de dominios cruzados.

Incrustar formulario adaptable

Puede incrustar un formulario adaptable si inserta algunas líneas de JavaScript en la página web. La API del código envía una solicitud HTTP al servidor de AEM para obtener recursos de formularios adaptables e inserta el formulario adaptable en el contenedor de formulario especificado.

Para incrustar el formulario adaptable, haga lo siguiente:

  1. Cree una página web en su sitio web con el siguiente código:

    <!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. En el código incrustado:

    • Cambie el valor de la variable options.path con la ruta de la URL de publicación del formulario adaptable. Si el servidor de AEM se ejecuta en una ruta de contexto, asegúrese de que la dirección URL incluya la ruta de contexto. Siempre mencione el nombre completo del formulario adaptable, incluida la extensión. Por ejemplo, el código anterior y el formulario adaptable residen en el mismo servidor de AEM Forms, por lo que el ejemplo utiliza la ruta de contexto del formulario adaptable /content/forms/af/locbasic.html.
    • Reemplace options.dataRef por atributos para pasar con la dirección URL. Puede utilizar la variable dataref para rellenar previamente un formulario adaptable.
    • Reemplace options.themePath por la ruta a una temática distinta a la configurada en el formulario adaptable. También puede especificar la ruta de la temática mediante el atributo de solicitud.
    • CSS_Selector es el selector CSS del contenedor de formularios en el que está incrustado el formulario adaptable. Por ejemplo, la clase css .customafsection es el selector de CSS del ejemplo anterior.

El formulario adaptable está incrustado en la página web. Observe lo siguiente en el formulario adaptable integrado:

  • El encabezado y el pie de página del formulario adaptable original no se incluyen en el formulario incrustado.
  • Los borradores y los formularios enviados están disponibles en la pestaña Borradores y envíos del portal de formularios.
  • La acción de envío configurada en el formulario adaptable original se mantendrá en el formulario incrustado.
  • Las reglas de los formularios adaptables se conservarán y funcionarán perfectamente en el formulario incrustado.
  • La segmentación de experiencias y las pruebas A/B configuradas en el formulario adaptable original no funcionarán en el formulario incrustado.
  • Si Adobe Analytics está configurado en el formulario original, el servidor de Adobe Analytics capturará los datos de análisis. Sin embargo, no estará disponible en el informe de análisis de Forms.

Topología de ejemplo

La página web externa que incrusta el formulario adaptable envía solicitudes al servidor de AEM, que normalmente se encuentra detrás del firewall en una red privada. Para garantizar que las solicitudes se dirijan de forma segura al servidor de AEM, se recomienda configurar un servidor proxy inverso.

Veamos un ejemplo de cómo puede configurar un servidor proxy inverso Apache 2.4 sin un Dispatcher. En este ejemplo, aloja el servidor de AEM con la ruta de contexto /forms y el mapa /forms para el proxy inverso. Garantiza que cualquier solicitud de /forms en el servidor de Apache se dirijan a la instancia de AEM. Esta topología ayuda a reducir el número de reglas en la capa de Dispatcher, ya que todas las solicitudes con el prefijo /forms se envían al servidor de AEM.

  1. Abra el archivo de configuración httpd.conf y quite el comentario de las siguientes líneas de código. Como alternativa, puede agregar estas líneas de código en el archivo.

    LoadModule proxy_html_module modules/mod_proxy_html.so
    LoadModule proxy_http_module modules/mod_proxy_http.so
    
  2. Configure las reglas de proxy al agregar las siguientes líneas de código en el archivo de configuración httpd-proxy.conf.

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

    Reemplace [AEM_Instance] por la URL de publicación del servidor de AEM en las reglas.

Si no monta el servidor AEM en una ruta de contexto, las reglas de proxy en la capa de Apache son las siguientes:

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
NOTA

Si configura cualquier otra topología, asegúrese de agregar las direcciones URL de envío, de relleno previo y de otro tipo a la lista de permitidos de Dispatcher.

Prácticas recomendadas

Al incrustar un formulario adaptable en una página web, tenga en cuenta las siguientes prácticas recomendadas:

  • Asegúrese de que las reglas de estilo definidas en la página web de CSS no entren en conflicto con el objeto de formulario de CSS. Para evitar conflictos, puede reutilizar la página web de CSS en la temática del formulario adaptable mediante la biblioteca de cliente de AEM. Para obtener información sobre el uso de la biblioteca de cliente en temáticas de formularios adaptables, consulte temáticas en AEM Forms.
  • Haga que el contenedor de formularios de la página web utilice la anchura de toda la ventana. Garantiza que las reglas CSS configuradas para dispositivos móviles funcionen sin ningún cambio. Si el contenedor de formularios no tiene la anchura de toda la ventana, deberá escribir un CSS personalizado para que el formulario se adapte a diferentes dispositivos móviles.
  • Use la API [getData](https://helpx.adobe.com/es/experience-manager/6-5/forms/javascript-api/GuideBridge.html) para obtener la representación XML o JSON de los datos de formulario en el cliente.
  • Use la API [unloadAdaptiveForm](https://helpx.adobe.com/es/experience-manager/6-5/forms/javascript-api/GuideBridge.html) para descargar el formulario adaptable desde DOM HTML.
  • Configure el encabezado access-control-origin al enviar una respuesta desde un servidor de AEM.

Permita que AEM Forms ofrezca formularios adaptables a un sitio de dominios cruzados

  1. En la instancia de publicación de AEM, vaya al Administrador de configuración de la consola web de AEM en https://'[server]:[port]'/system/console/configMgr.
  2. Busque y abra la configuración Filtro de referencias de Apache Sling.
  3. En el campo Hosts permitidos, especifique el dominio en el que reside la página web. Permita que el host realice peticiones POST al servidor de AEM. También puede utilizar una expresión regular para especificar una serie de dominios de aplicación externos.

En esta página