Tipo de archivo del proyecto AEM

El tipo de archivo del proyecto de AEM es una plantilla de Maven que crea un proyecto mínimo de Adobe Experience Manager (AEM) basado en las prácticas recomendadas como punto de partida para su sitio web.

SUGERENCIA

El último tipo de archivo del proyecto de AEM se encuentra en GitHub.

Medios

  • Documentación de tipo de archivo (este documento): Información general sobre la arquitectura de tipo de archivo y sus distintos módulos.
  • Los siguientes tutoriales están basados en este tipo de archivo:

Características

Uso

Para generar un proyecto, ajuste la siguiente línea de comandos según sus necesidades:

mvn -B archetype:generate \
 -D archetypeGroupId=com.adobe.aem \
 -D archetypeArtifactId=aem-project-archetype \
 -D archetypeVersion=XX \
 -D appTitle="My Site" \
 -D appId="mysite" \
 -D groupId="com.mysite" \
  • Sustituya XX por el último número de versión del tipo de archivo.
  • Configure aemVersion=cloud para AEM Cloud Service;
    Configure aemVersion=6.5.0 para Adobe Managed Services o en línea.
    La dependencia de componentes principales solo se agrega para versiones de AEM que no sean en la nube, ya que los componentes principales se proporcionan como OOTB para AEM Cloud Service.
  • Ajuste appTitle="My Site" para definir el título del sitio web y los grupos de componentes.
  • Ajuste appId="mysite" para definir los nombres de Maven artifactId, los componentes, la configuración y las carpetas de contenido, así como los nombres de las bibliotecas de cliente.
  • Ajuste groupId="com.mysite" para definir el groupId de Maven y el paquete de origen de Java.
  • Busque la lista de propiedades disponibles para ver si hay más que desee ajustar.

Propiedades disponibles

Nombre Predeterminado Descripción
appTitle El título de la aplicación se utilizará para el título del sitio web y los grupos de componentes (p. ej. "My Site").
appId El nombre técnico se utilizará para nombres de componentes, configuración y carpetas de contenido, así como nombres de bibliotecas de cliente (p. ej. "mysite").
artifactId ${appId} ID del artefacto base de Maven (p. ej. "mysite").
groupId ID del grupo base de Maven (p. ej. "com.mysite").
package ${groupId} Paquete de origen de Java (p. ej. "com.mysite").
version 1.0-SNAPSHOT Versión del proyecto (p. ej. 1.0-SNAPSHOT).
aemVersion cloud Versión de AEM de destino (puede ser cloud para AEM Cloud Service; o 6.5.0 o 6.4.4 para Adobe Managed Services o en línea).
sdkVersion latest Cuando aemVersion=cloud se puede especificar una versión de SDK (p. ej. 2020.02.2265.20200217T222518Z-200130).
includeDispatcherConfig y Incluye una configuración de Dispatcher para la nube o para AMS/en línea, según el valor de aemVersion (puede ser y o n).
frontendModule general Incluye un módulo de versión de front-end de Webpack que genera las bibliotecas de cliente (puede ser general o none para sitios normales; puede ser angular o react para una aplicación de una sola página que implementa el Editor SPA).
language en Código de idioma (ISO 639-1) desde el que se crea la estructura de contenido (p. ej. en, deu).
country us Código de país (ISO 3166-1) desde el que crear la estructura de contenido (p. ej. US).
singleCountry y Incluye una estructura de contenido maestra de idioma (puede ser y o n).
includeExamples n Incluye un sitio de ejemplo de la Biblioteca de componentes (puede ser y o n).
includeErrorHandler n Incluye una página de respuesta 404 personalizada que será global para toda la instancia (puede ser y o n).
includeCommerce n Incluye las dependencias Componentes principales del CIF y genera los artefactos correspondientes.
commerceEndpoint Necesario solo para CIF. Punto final opcional del servicio GraphQL del sistema de comercio que se va a utilizar (p. ej. https://hostname.com/grapql).
datalayer y Activar la integración con la Capa de datos del cliente de Adobe.
amp n Habilite la compatibilidad con AMP para plantillas de proyecto generadas.
enableDynamicMedia n Habilita los componentes básicos de Dynamic Media en la configuración de directivas de proyecto y activa las funciones de Dynamic Media en la directiva del componente de imagen principal.
enableSSR n Opción para habilitar SSR para el proyecto front-end
precompiledScripts n Opción para precompilar los scripts del lado del servidor de ui.apps y adjuntarlos a la versión como un artefacto de paquete secundario en el proyecto ui.apps. aemVersion debe establecerse en cloud.
includeFormscommunications n Incluye dependencias, plantillas, modelos de datos de formulario y temas de Componentes principales de Forms y genera los elementos correspondientes para los programas de comunicaciones de Forms.
includeFormsenrollment n Incluye dependencias, plantillas, modelos de datos de formulario y temas de Componentes principales de Forms y genera los elementos correspondientes para los programas de inscripción de Forms.

Requisitos del sistema

Tipo de archivo AEM as a Cloud Service AEM 6.5 Java SE Maven
36 Continua 6.5.7.0+ 8, 11 3.3.9+

Configure su entorno de desarrollo local para AEM Cloud Service SDK o para versiones anteriores de AEM.

Problemas conocidos

Cuando se ejecuta en Windows y genera la configuración de Dispatcher, debe estar ejecutando un símbolo del sistema elevado o el Subsistema de Windows para Linux (consulte #329).

Al ejecutar el tipo de archivo en modo interactivo (sin el parámetro -B), las propiedades con valores predeterminados no se pueden cambiar, a menos que se descarte la confirmación final, que después repite las preguntas incluyendo las propiedades con valores predeterminados en las preguntas (consulte
ARCHETYPE-308 para más detalles).

No se puede usar este tipo de archivo en Eclipse al iniciar un nuevo proyecto con File -> New -> Maven Project, ya que el script de generación posterior archetype-post-generate.groovy no se ejecutará debido a un problema con Eclipse. La solución es usar la línea de comandos anterior y luego usar Eclipse File -> Import -> Existing Maven Project.

Lectura adicional

Para obtener más información sobre el uso del tipo de archivo, incluidas sus ventajas, opciones y cómo funcionan sus módulos, consulte el documento Utilizar el tipo de archivo.

En esta página