Arquétipo de projeto do AEM

O Arquétipo de projeto do AEM é um modelo Maven que cria um projeto mínimo do Adobe Experience Manager (AEM) com base em práticas recomendadas, como ponto de partida para o seu site.

DICA

O Arquétipo de projeto do AEM mais recente pode ser encontrado no GitHub.

Recursos

  • Documentação do arquétipo (este documento): Visão geral da arquitetura do arquétipo e de seus diferentes módulos.
  • Os seguintes tutoriais são baseados neste arquétipo:

Recursos

Uso

Para gerar um projeto, ajuste a seguinte linha de comando de acordo com suas necessidades:

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" \
  • Substitua XX pelo número de versão do arquétipo mais recente.
  • Defina aemVersion=cloud para o AEM as a Cloud Service.
    Defina aemVersion=6.5.0 para Adobe Managed Services, ou no local.
    A dependência dos Componentes principais é adicionada apenas para versões do AEM que não estão na nuvem, pois os Componentes principais são fornecidos OOTB para o AEM as a Cloud Service.
  • Ajuste appTitle="My Site" para definir o título do site e os grupos de componentes.
  • Ajuste appId="mysite" para definir o Maven artifactId, os nomes do componente, da configuração e da pasta de conteúdo, e os nomes da biblioteca do cliente.
  • Ajuste groupId="com.mysite" para definir o Maven groupId e o Pacote de origem Java.
  • Pesquise a lista de propriedades disponíveis para ver se há mais itens que você deseja ajustar.

Propriedades disponíveis

Nome Padrão Descrição
appTitle O título do aplicativo será usado para o título do site e grupos de componentes (por exemplo, "My Site").
appId O nome técnico será usado para nomes de componentes, configurações e pastas de conteúdo, e para nomes de bibliotecas de clientes (por exemplo, "mysite").
artifactId ${appId} ID de artefato Maven de base (por exemplo, "mysite").
groupId ID de grupo Maven de base (por exemplo, "com.mysite").
package ${groupId} Java Source Package (por exemplo, "com.mysite").
version 1.0-SNAPSHOT Versão do projeto (por exemplo, 1.0-SNAPSHOT).
aemVersion cloud Versão do AEM de destino (pode ser cloud para o AEM como Cloud Service; ou 6.5.0, ou 6.4.4 para o Adobe Managed Services ou no local).
sdkVersion latest Quando for aemVersion=cloud, uma versão SDK pode ser especificada (por exemplo, 2020.02.2265.20200217T222518Z-200130).
includeDispatcherConfig y Inclui uma configuração de dispatcher para nuvem ou para AMS/no local, dependendo do valor de aemVersion (pode ser y ou n).
frontendModule general Inclui um módulo de build de front-end do Webpack que gera as bibliotecas de clientes (pode ser general ou none para sites regulares; pode ser angular ou react para um Aplicativo de página única que implementa o Editor de SPA).
language en Código de idioma (ISO 639-1) para criar a estrutura de conteúdo de (por exemplo, en, deu).
country us Código do país (ISO 3166-1) para criar a estrutura de conteúdo de (por exemplo, US).
singleCountry y Inclui uma estrutura de conteúdo principal de idioma (pode ser y ou n).
includeExamples n Inclui um site de exemplo de Biblioteca de componentes (pode ser y ou n).
includeErrorHandler n Inclui uma página de resposta 404 personalizada que será global para toda a instância (pode ser y ou n).
includeCommerce n Inclui dependências de Componentes principais da CIF e gera artefatos correspondentes.
commerceEndpoint Necessário somente para CIF. Ponto de extremidade opcional do sistema de comércio do serviço GraphQL a ser usado (por exemplo, https://hostname.com/grapql).
datalayer y Ativa a integração com a Camada de dados de clientes Adobe.
amp n Habilita o suporte AMP para modelos de projeto gerados.
enableDynamicMedia n Ativa os componentes básicos do Dynamic Media nas configurações de política do projeto e ativa os recursos do Dynamic Media na política do componente de Imagem principal.
enableSSR n Opção para habilitar o SSR para o projeto de front-end.
precompiledScripts n Opção para pré-compilar os scripts do lado do servidor de ui.apps e anexá-los ao build como um artefato de pacote secundário no projeto ui.apps. aemVersion deve ser definido como cloud.
includeFormscommunications n Inclui dependências de Componentes principais do Forms, templates, modelos de dados de formulário, temas e gera artefatos correspondentes para programas de Comunicações do Forms.
includeFormsenrollment n Inclui dependências de Componentes principais do Forms, templates, modelos de dados de formulário, temas e gera artefatos correspondentes para programas de Inscrição do Forms.

Requisitos do sistema

Arquétipo AEM as a Cloud Service AEM 6.5 Java SE Maven
37 Contínuo 6.5.7.0+ 8, 11 3.3.9+

Configure seu ambiente de desenvolvimento local para o SDK do AEM as a Cloud Service ou para versões mais antigas do AEM.

Problemas conhecidos

Ao executar no Windows e gerar a configuração do dispatcher, você deve executar um prompt de comando elevado ou o Subsistema do Windows para Linux (consulte #329).

Ao executar o arquétipo no modo interativo (sem o parâmetro -B), as propriedades com valores padrão não podem ser alteradas, a menos que a confirmação final seja descartada, o que então repete as perguntas incluindo as propriedades com valores padrão nas perguntas (consulte
ARCHETYPE-308 para obter detalhes).

Você não pode usar esse arquétipo no Eclipse ao iniciar um novo projeto com File -> New -> Maven Project, já que o script de pós-geração archetype-post-generate.groovy não será executado devido a um problema do Eclipse. A solução alternativa é usar a linha de comando acima e, em seguida, no Eclipse usar File -> Import -> Existing Maven Project.

Leitura adicional

Para mais detalhes sobre o uso do arquétipo, incluindo seus benefícios, opções e como seus módulos funcionam, consulte o documento Uso do Arquétipo.

Nesta página