DocumentaciónAEM as a Cloud ServiceGuía del usuario

Configurar un entorno de desarrollo local para AEM Forms overview

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Creado para:

  • Administrador
  • Desarrollador
  • Usuario

Al establecer y configurar un Adobe Experience Manager Forms como entorno de Cloud Service, configura entornos de desarrollo, de puesta en escena y de producción en la nube. Además, también puede establecer y configurar un entorno de desarrollo local.

Puede utilizar el entorno de desarrollo local para realizar las siguientes acciones sin iniciar sesión en el entorno de desarrollo de la nube:

Después de que un formulario adaptable o activos relacionados estén listos en la instancia de desarrollo local o una solicitud para generar [Comunicaciones del cliente], puede exportar el formulario adaptable o la solicitud Comunicaciones del cliente desde el entorno de desarrollo local a un entorno de Cloud Service para realizar más pruebas o desplazarse a entornos de producción.

También puede desarrollar y probar código personalizado como componentes personalizados y servicio de relleno previo en el entorno de desarrollo local. Cuando el código personalizado esté listo y se haya probado, puede utilizar el repositorio Git del entorno de desarrollo de Cloud Service para implementar el código personalizado.

Para configurar un nuevo entorno de desarrollo local y utilizarlo para desarrollar actividades, realice las siguientes acciones en el orden indicado:

Requisitos previos

Necesita el siguiente software para configurar un entorno de desarrollo local. Descargue estos elementos antes de comenzar a configurar el entorno de desarrollo local:

Software
Descripción
Vínculos de descarga
SDK de Adobe Experience Manager as a Cloud Service
SDK incluye Adobe Experience Manager Herramientas de QuickStart y Dispatcher
Descargue el SDK más reciente de Distribución de software
Archivo de características de Adobe Experience Manager Forms (complemento de AEM Forms)
Herramientas para crear, aplicar estilos y optimizar formularios adaptables y otras características de Adobe Experience Manager Forms
Descargar desde Distribución de software
(Opcional) Contenido de referencia de Adobe Experience Manager Forms
Herramientas para crear, aplicar estilos y optimizar formularios adaptables y otras características de Adobe Experience Manager Forms
Descargar desde Distribución de software
(Opcional) Adobe Experience Manager Forms Designer
Herramientas para crear, aplicar estilos y optimizar formularios adaptables y otras características de Adobe Experience Manager Forms
Descargar desde Distribución de software

Descargue la última versión de software desde Distribución de software software-distribution

Para descargar la última versión del SDK de Adobe Experience Manager as a Cloud Service, el archivo de características de Experience Manager Forms (complemento de AEM Forms), los activos de referencia de formularios o Forms Designer desde Distribución de software:

  1. Inicie sesión en https://experience.adobe.com/#/downloads con su Adobe ID

    note note
    NOTE
    Su organización de Adobe debe estar aprovisionada para AEM as a Cloud Service para descargar el SDK de AEM as a Cloud Service.

  2. Vaya a la pestaña AEM as a Cloud Service.

  3. Ordene por fecha de publicación en orden de bajada.

  4. Haga clic en el SDK de Adobe Experience Manager as a Cloud Service más reciente, el archivo de características de Experience Manager Forms (complemento de AEM Forms), los activos de referencia de formularios o Forms Designer.

    note note
    NOTE
    Le recomendamos que se descargue la última versión del archivo de características de Experience Manager Forms (complemento de AEM Forms), los recursos de referencia de formularios o Forms Designer para lograr una compatibilidad perfecta con el SDK de Adobe Experience Manager as a Cloud Service.

  5. Revise y acepte el EULA. Seleccione el botón Descargar.

Configurar las herramientas de desarrollo para Proyectos AEM setup-development-tools-for-AEM-projects

El proyecto de Adobe Experience Manager Forms es una base de código personalizado. Contiene código, configuraciones y contenido que se implementa mediante Cloud Manager en Adobe Experience Manager as a Cloud Service. El proyecto AEM Maven Archetype proporciona la estructura de la línea de base para el proyecto.

Configure las siguientes herramientas de desarrollo para usar con su Adobe Experience Manager proyecto de desarrollo:

Para obtener instrucciones detalladas para configurar las herramientas de desarrollo mencionadas anteriormente, consulte Configurar las herramientas de desarrollo.

Configurar el entorno local de Experience Manager para el desarrollo

El SDK de Cloud Service proporciona un archivo de QuickStart. Ejecuta una versión local de Experience Manager. Puede ejecutar las instancias Author o Publish de manera local.

Aunque QuickStart proporciona una experiencia de desarrollo local, no todas las características están disponibles en Adobe Experience Manager as a Cloud Service. Por lo tanto, pruebe siempre las características y el código con el entorno de desarrolloAdobe Experience Manager as a Cloud Service antes de mover las características a fase o producción.

Para instalar y configurar el entorno local de Experience Manager, realice los siguientes pasos:

Agregue el archivo Forms a las instancias locales Author y Publish y configure usuarios específicos de Forms add-forms-archive-configure-users

Realice los siguientes pasos en el orden indicado para agregar el archivo de Forms a instancias de Experience Manager y configurar usuarios específicos de Forms:

Instale el último archivo de características de complementos de Forms add-forms-archive

El archivo de características de Adobe Experience Manager Forms as a Cloud Service proporciona herramientas para crear, agregar estilos y optimizar formularios adaptables en el entorno de desarrollo local. Instale el paquete para crear un formulario adaptable y utilice otras características de AEM Forms. Para instalar el paquete, haga lo siguiente:

  1. Descargue y extraiga el archivoAEM Forms más reciente para su sistema operativo desde Distribución de software.

  2. Navegue hasta el directorio crx-quickstart/install. Si la carpeta no existe, créela.

  3. Detenga la instancia de AEM, coloque el archivo de características de complementos de AEM Forms, aem-forms-addon-<version>.far, en la carpeta de instalación.

  4. Vaya a la ventana de comandos activa y pulse el comando Ctrl + C para reiniciar el SDK.

    note note
    NOTE
    Se recomienda utilizar el comando "Ctrl + C" para reiniciar el SDK. El reinicio del SDK de AEM mediante métodos alternativos, como detener los procesos de Java, puede generar incoherencias en el entorno de desarrollo de AEM.

Configurar usuarios y permisos configure-users-and-permissions

Cree usuarios como Desarrollador de formularios y Profesional de formularios y agregue estos usuarios a grupos de formularios predefinidos para proporcionarles los permisos necesarios. La siguiente tabla muestra todos los tipos de usuarios y grupos predefinidos para cada tipo de usuarios de formularios:

Tipo de usuario
Grupo de AEM
Profesional del formulario /
forms-users (Usuarios de AEM Forms), template-authors, workflow-users, workflow-editorsy fdm-authors
Desarrollador de formularios
forms-users (Usuarios de AEM Forms), template-authors, workflow-users, workflow-editorsy fdm-authors
Posible cliente de experiencia del cliente o Diseñador de UX
forms-users, template-authors
Administrador de AEM
aem-administrators, fd-administrators
Usuario final
Cuando un usuario debe iniciar sesión para ver y enviar un formulario adaptable, agregue estos usuarios al grupo forms-users.
Cuando no se requiera autenticación de usuario para acceder a los formularios adaptables, no asigne ningún grupo a esos usuarios.

Configurar el entorno de desarrollo local para el documento de registro (DoR) docker-microservices

AEM Forms as a Cloud Services proporciona un entorno SDK basado en Docker que facilita el desarrollo del documento de registro y el uso de otros microservicios. Evita que deba configurar manualmente binarios y adaptaciones específicos de la plataforma. Para configurar el entorno, haga lo siguiente:

  1. Instale y configure Docker:

    • (Para Microsoft® Windows) Instale Docker Desktop. Configura Docker Engine y docker-compose en su máquina.

    • (Apple macOS) Instale Docker Desktop para Mac. Incluye Docker Engine, Docker CLI client, Docker Compose, Docker Content Trust, Kubernetes y Credential Helper.

    • (Para Linux®) Instale Docker Engine y Docker Compose en su máquina.

    note note
    NOTE

    • Para Apple macOS, incluya en la lista de permitidos las carpetas que contengan instancias de locales de AEM Author.

    • Docker Desktop para Windows admite dos backends, Hyper-V
      (heredado) y WSL2 (moderno). El uso compartido de archivos lo administra automáticamente
      Docker cuando se utiliza WSL2 (moderno). Tiene que
      configurar explícitamente el uso compartido de archivos mientras utiliza Hyper-V (heredado).

  2. Cree una carpeta, por ejemplo aem-sdk, en paralelo a las instancias Author y Publish. Por ejemplo, C:\aem-sdk.

  3. Extraiga el archivoaem-forms-addon-<version>.zip\aem-forms-addon-native-<version>.zip.

    formularios aem extraídos de add on nativos

  4. Cree una variable de entorno AEM_HOME y apunte a la instalación local de AEM Author. Por ejemplo, C:\aem\author.

  5. Abra sdk.bat o sdk.sh para editarlo. Establezca AEM_HOME para que apunte a la instalación local de AEM Author. Por ejemplo, C:\aem\author.

  6. Abra el símbolo del sistema y navegue hasta la carpeta aem-forms-addon-native-<version>.

  7. Asegúrese de que la instancia local AEM Author esté funcionando. Ejecute los siguientes comandos para iniciar el SDK:

    • En Microsoft® Windows

      code language-shell 
      sdk.bat start

    • Linux® o Apple macOS

      code language-shell 
      % export AEM_HOME=[local AEM Author installation]
% ./sdk.sh start
    note note
    NOTE
    Si ha definido la variable de entorno en el archivo sdk.sh, es opcional especificarla en la línea de comandos. La opción para definir la variable de entorno en la línea de comandos se proporciona para ejecutar el comando sin actualizar el script shell.

    start-sdk-command

Ahora puede utilizar el entorno de desarrollo local para procesar el documento de registro. Para realizar pruebas, cargue un archivo XDP en su entorno y procéselo. Por ejemplo, http://localhost:4502/libs/xfaforms/profiles/default.print.pdf?template=crx:///content/dam/formsanddocuments/cheque-request.xdp convierte el archivo XDP al documento PDF.

Configurar un proyecto de desarrollo para Forms basado en el arquetipo de Experience Manager forms-cloud-service-local-development-environment

Utilice este proyecto para crear formularios adaptables, implementar actualizaciones de configuración, superposiciones, crear componentes de formularios adaptables personalizados, probar y personalizar código en el SDK local Experience Manager Forms. Después de realizar la prueba de manera local, puede implementar el proyecto en entornos de producción y no producción Experience Manager Formsas a Cloud Service. Al implementar el proyecto, también se implementan los siguientes activos de AEM Forms:

Temáticas
Plantillas
Modelo de datos de formulario (FDM)
Canvas 3.0
Basic
Microsoft® Dynamics 365
Tranquilo
Blank
Salesforce
Urbane
Ultramarine
Beryl
NOTE
Configure la versión 30 o posterior del tipo de archivo del proyecto AEM para poder utilizar el modelo de datos de formulario (Form Data Model, FDM) de Microsoft® Dynamics 365 y Salesforce con AEM Forms as a Cloud Service.
Configure la versión 32 o posterior de AEM Archetype para obtener y utilizar los temas Tranquil, Urbane y Ultramarine con AEM Forms as a Cloud Service.

Para configurar el proyecto, haga lo siguiente:

  1. Clone el repositorio Git de Cloud Manager en su instancia de desarrollo local: Su repositorio Git de Cloud Manager contiene un proyecto de AEM predeterminado. Se basa en AEM Archetype. Clone su Repositorio Git de Cloud Manager mediante la administración de cuentas Git de autoservicio desde la interfaz de usuario de Cloud Manager para llevar el proyecto a su entorno de desarrollo local. Para obtener más información sobre el acceso al repositorio, consulte Acceso a repositorios.

  2. Cree un proyecto de Experience Manager Forms as a [Cloud Service]: cree un proyecto de Experience Manager Forms as a [Cloud Service] basado en la última versión del Arquetipo de AEM o posterior. El tipo de archivo ayuda a los desarrolladores a empezar a desarrollar fácilmente AEM Forms as a Cloud Service. También incluye algunas temáticas de muestra y plantillas para ayudarle a empezar rápidamente.

    Abra el símbolo del sistema y ejecute el siguiente comando para crear un proyecto de Experience Manager Forms as a Cloud Service.

    code language-shell 
    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"

    Cambie el appTitle, appIdy groupId en el comando anterior para reflejar su entorno. Además, establezca el valor de includeFormsenrollment, includeFormscommunications e includeFormsheadless en y o n según la licencia y los requisitos. includeFormsheadless es obligatorio para crear formularios adaptables basados en componentes principales.

    • Utilice la opción includeFormsenrollment=y para incluir configuraciones, temáticas, plantillas, componentes principales y dependencias específicos para formularios, que son necesarios para crear formularios adaptables. Si utiliza el portal de Forms establezca la opción includeExamples=y. Agregue al proyecto los componentes principales del portal de Forms.

    • Utilice la opción includeFormscommunications=y para incluir los componentes principales de Forms y las dependencias necesarias para incluir la funcionalidad de comunicaciones del cliente.

      note warning
      WARNING
      • Al crear un proyecto de tipo de archivo con versión 45, la variable [Carpeta de proyecto de tipo de archivo de AEM]/pom.xml establece inicialmente la versión de los componentes principales de formularios en 2.0.64. Antes de crear o implementar el proyecto Archetype, actualice la versión de los componentes principales de Forms a 2.0.62.

  3. Implemente el proyecto en su entorno de desarrollo local. Puede utilizar el siguiente comando para implementarlo en su entorno de desarrollo local

    mvn -PautoInstallPackage clean install

    Para obtener la lista completa de comandos, consulte Creación e instalación

  4. Implemente el código en su entorno de AEM Forms as a Cloud Service.

Configurar las herramientas locales de Dispatcher setup-local-dispatcher-tools

Dispatcher es un módulo de servidor web HTTP Apache que proporciona una capa de seguridad y rendimiento entre el nivel de CDN y AEM Publish. Dispatcher es una parte integral de la arquitectura de Experience Manager general y debe formar parte del entorno de desarrollo local.

Realice los siguientes pasos para configurar Dispatcher local y luego agregarle reglas específicas de formularios:

Configurar Dispatcher local setup-local-dispatcher

El SDK de Experience Manager as a Cloud Service incluye la versión de herramientas de Dispatcher recomendada, que facilita la configuración, validación y simulación de Dispatcher de manera local. Las herramientas de Dispatcher están basadas en Docker y proporcionan herramientas de línea de comandos para transformar archivos de configuración de Apache HTTP Web Server y Dispatcher en un formato compatible e implementarlos en Dispatcher, que se ejecuta en el contenedor de Docker.

El almacenamiento en caché en Dispatcher permite AEM Forms rellenar previamente formularios adaptables en un cliente. Mejora la velocidad de procesamiento de los formularios rellenados previamente.

Para obtener instrucciones detalladas sobre la configuración de Dispatcher, consulte Configurar las herramientas locales de Dispatcher

Agregar reglas específicas de Forms a Dispatcher forms-specific-rules-to-dispatcher

Realice los siguientes pasos para configurar la memoria caché de Dispatcher para Experience Manager Forms as a Cloud Service:

  1. Abra el proyecto AEM y navegue hasta \src\conf.dispatcher.d\available_farms

  2. Cree una copia del archivo default.farm. Por ejemplo, forms.farm.

  3. Abra el archivo forms.farm creado para editar y reemplazar el siguiente código:

    code language-json 
    #/ignoreUrlParams {
#/0001 { /glob "*" /type "deny" }
#/0002 { /glob "q" /type "allow" }
#}

    con

    code language-json 
    /ignoreUrlParams {
/0001 { /glob "*" /type "deny" }
/0002 { /glob "dataRef" /type "allow" }
}

  4. Guarde y cierre el archivo.

  5. Vaya a conf.d/enabled_farms y cree un vínculo simbólico al archivoforms.farm.

  6. Compile e implemente el proyecto en su entorno AEM Formsas a Cloud Service.

Consideraciones sobre el almacenamiento en caché considerations-about-caching

  • El almacenamiento en caché de Dispatcher permite AEM Forms rellenar previamente formularios adaptables en un cliente. Mejora la velocidad de procesamiento de los formularios rellenados previamente.

  • La funciones relacionadas con el almacenamiento en caché de contenido seguro están deshabilitadas de forma predeterminada. Para habilitar la característica, puede seguir las instrucciones que se proporcionan en el artículo Almacenamiento en caché de contenido seguro

  • Dispatcher puede fallar al validar algunos formulario adaptables y los formularios adaptables relacionados. Para resolver estos problemas, consulte AEM Forms Almacenamiento en caché en la sección Solución de problemas.

  • Almacenamiento en caché de formularios adaptables localizados:

    • En el entorno de Cloud Service, utilice el formato de URL http://host:port/content/forms/af/<afName>.<locale>.html para solicitar una versión localizada de un formulario adaptable en lugar de http://host:port/content/forms/af/afName.html?afAcceptLang=<locale>
    • La opción Explorador local está deshabilitada de manera predeterminada. Para cambiar la configuración del explorador local,

  • Cuando se usa el formato de URL http://host:port/content/forms/af/<adaptivefName>.html y la opción Usar configuración regional del explorador está desactivada en el Administrador de configuración, se proporciona la versión no localizada del formulario adaptable. El idioma no localizado es el utilizado al desarrollar el formulario adaptable. No se tendrá en cuenta la configuración local de su explorador (explorador local) y se proporcionará una versión no localizada del formulario adaptable.

  • Cuando usa el formato de URL http://host:port/content/forms/af/<adaptivefName>.html y la opción Usar configuración regional del explorador está activada en el Administrador de configuración, se proporciona una versión localizada del formulario adaptable, si está disponible. El idioma del formulario adaptable localizado se basará en la configuración local del explorador (explorador local). Puede llevar a [almacenar en caché solo la primera instancia de un formulario adaptable]. Para evitar que el problema se produzca en su instancia, consulte solo se almacena en caché la primera instancia de un formulario adaptable en la sección Solución de problemas.

El entorno de desarrollo local está listo.

Habilitar los componentes principales de formularios adaptables en el entorno de desarrollo as a Cloud Service y local de AEM Forms

Al habilitar los componentes principales de los formularios adaptables en AEM Forms as a Cloud Service, puede empezar a crear, publicar y ofrecer en varios canales los componentes principales basados en formularios adaptables y sin encabezado mediante las instancias de Cloud Service de AEM Forms. Se necesita un entorno habilitado para los componentes principales de formularios adaptables para utilizar formularios adaptables sin encabezado.

Para obtener instrucciones, consulte Habilitar los componentes principales de formularios adaptables en el entorno de desarrollo as a Cloud Service y local de AEM Forms

Actualice su entorno de desarrollo local upgrade-your-local-development-environment

La actualización del SDK a una nueva versión requiere reemplazar todo el entorno de desarrollo local, lo que provoca la pérdida de todo el código, la configuración y el contenido de los repositorios locales. Asegúrese de que cualquier código, configuración o contenido que no se deba destruir se conserva de forma segura con Git o se exporta desde las instancias de Experience Manager locales como paquetes CRX.

Evitar la pérdida de contenido al actualizar el SDK avoid-content-loss-when-upgrading--SDK

Actualizar el SDK es crear de manera efectiva una nueva instancia Author y Publish, que incluyan un repositorio nuevo (Configurar proyectos AEM), lo que significa que se perderá cualquier cambio realizado en el repositorio de un SDK anterior. Para conocer estrategias viables que permitan mantener el contenido entre las actualizaciones del SDK, consulte Evitar la pérdida de contenido al actualizar el SDK de AEM

Realizar una copia de seguridad e importar contenido específico de Forms a un entorno nuevo del SDK backup-and-import-Forms-specific-content-to-new-SDK-environment

Para realizar una copia de seguridad y mover activos del SDK existente a un entorno nuevo del SDK, haga lo siguiente:

  • Cree una copia de seguridad del contenido existente.

  • Configure un entorno nuevo del SDK.

  • Importe la copia de seguridad en su nuevo entorno del SDK.

Crear una copia de seguridad del contenido existente create-backup-of-your-existing-content

Haga una copia de seguridad de los formularios adaptables, plantillas, modelo de datos de formulario (FDM), tema, configuraciones y código personalizado. Puede realizar la siguiente acción para crear una copia de seguridad:

  1. Descargar formularios adaptables, temáticas y PDF forms.

  2. Exportar plantillas de formularios adaptables.

  3. Descargar modelos de datos de formularios

  4. Exportar plantillas editables, configuraciones de nube y modelos de flujo de trabajo. Para exportar todos los elementos mencionados anteriormente desde el SDK existente, cree un Paquete CRX con los siguientes filtros:

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

  5. Exporte configuraciones de correo electrónico, envíe y rellene previamente código de acciones desde su entorno de desarrollo local. Para exportar esta configuración, cree una copia de las siguientes carpetas y archivos en el entorno de desarrollo 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

Importe la copia de seguridad en su entorno nuevo del SDK import-the-backup-to-your-new-SDK-environment

Importe formularios adaptables, plantillas, modelos de datos de formulario, temáticas, configuraciones y códigos personalizados a su entorno nuevo. Puede realizar las siguientes acciones para importar la copia de seguridad:

  1. Importar formularios adaptables, temáticas y PDF forms a entornos nuevos del SDK.

  2. Importar plantillas de formularios adaptables al entorno nuevo del SDK.

  3. Cargar modelos de datos de formulario al entorno nuevo del SDK.

  4. Importar plantillas editables, configuraciones de nube y modelos de flujo de trabajo. Para importar todos los elementos mencionados anteriormente en su nuevo entorno del SDK, importe el paquete CRX que contenga estos elementos en su entorno nuevo del SDK.

  5. Importe configuraciones de correo electrónico, envíe y rellene previamente código de acciones desde su entorno de desarrollo local. Para importar esta configuración, coloque los siguientes archivos del proyecto Archetype antiguo en el nuevo:

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

El entorno nuevo ahora tendrá formularios y activos relacionados del entorno antiguo.

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab