Implementação de um conector do AEM

Última atualização: 18 de outubro de 2024
  • Tópicos:

Criado para:

  • Administrador

As referências úteis para a criação de Conectores AEM são fornecidas a seguir e devem ser lidas com orientações sobre envio e manutenção conectores.

Uma licença de desenvolvedor para AEM pode ser obtida através do Programa Adobe Exchange.

Padrões comuns de integração

O AEM é uma solução de gerenciamento de experiência online de ponta e oferece muitas áreas em potencial de integrações. Padrões comuns de integração incluem:

  • Extrair dados de um sistema externo para o AEM. Por exemplo, exportar informações de contato de um CRM para torná-lo disponível para um público-alvo maior que visita um site viabilizado pelo AEM. As implementações devem usar as Tarefas agendadas do Sling, que garante que a tarefa seja executada mesmo se os contêineres fiquem inativos. O código deve ser projetado supondo que a tarefa possa ser acionada mais de uma vez.
  • Exportar dados do AEM para um sistema externo. Por exemplo, as configurações de assinatura do boletim informativo são enviadas em um site alimentado por AEM para um CRM.
  • Recuperar ativos do AEM. Por exemplo, um Sistema de gerenciamento de conteúdo (CMS) externo que faz referência a um ativo armazenado no AEM Assets. Ou como outro exemplo, um sistema PIM vinculado a uma imagem no AEM Assets.
  • Armazenar ativos na infraestrutura do AEM. Por exemplo, um sistema de Gestão de Recursos de Marketing (MRM) que armazena um ativo aprovado no AEM Assets.
  • Configurar e renderizar um componente de interface personalizado. Por exemplo, permitir que um autor arraste e solte um componente de vídeo e configure um vídeo específico para ser reproduzido no site ativo.
  • Atuar em um ativo com um serviço de parceiro. Por exemplo, enviar um ativo para uma plataforma de vídeo quando uma página é publicada.
  • Analisar um site, página ou ativo no Admin Console AEM. Por exemplo, fazer recomendações de SEO para uma página existente ou não publicada.
  • Acesso em nível de página a dados do usuário mantidos por um serviço externo. Por exemplo, o uso de informações demográficas para personalizar a experiência no site. Leia sobre o ContextHub, uma estrutura para armazenar, manipular e apresentar dados de contexto.
  • Traduzir uma cópia do site ou metadados de ativos. Consulte o Conector de bootstrap da estrutura de tradução do AEM para obter códigos de exemplo usando a Estrutura de tradução do AEM, que é a implementação preferida dos conectores de tradução.

Documentação útil

A documentação do Experience Manager as a Cloud Service fornece informações valiosas sobre desenvolvimento no AEM. Abaixo estão alguns tópicos e referências técnicas específicos que podem ser úteis ao implementar um conector do AEM:

  • Serviços Adobe Consulting (ACS) Exemplos do AEM para código bem comentado para ajudar a educar desenvolvedores do AEM
  • Os vários links de documentação na seção Padrões comuns de integração deste artigo

Recursos da comunidade

Além da documentação estática acima, a Adobe e a comunidade do AEM oferecem recursos para ajudar a trazer um conector para a produção:

  • O Fórum AEM da comunidade da Adobe é um site ativo no qual seus colegas fazem perguntas e respondem a dúvidas
  • Recursos técnicos adicionais da Adobe estão disponíveis para determinados níveis de parceiros. Saiba mais sobre o Programa Adobe Exchange.
  • Se sua organização deseja obter ajuda de implementação, considere a equipe de Serviços profissionais da Adobe ou consulte o Localizador de parceiros de soluções para obter uma lista de parceiros da Adobe em todo o mundo

Regras de estrutura do pacote

Para facilitar as implantações móveis, os pacotes do AEM as a Cloud Service — como conectores — mantêm uma divisão estrita entre conteúdo "imutável" e "mutável". Os pacotes devem ser claramente organizados de modo a incluir:

  • /apps
  • /content e /conf

Os conectores devem seguir essas diretrizes de pacotes, que estão descritas em Estrutura de projeto do AEM. Os conectores existentes também devem ser alterados para estarem em conformidade.

Além disso, somente a Adobe deve gravar código no /libs, com clientes e parceiros escrevendo em /apps.

Os conectores existentes também podem precisar ser refatorados para mover qualquer configuração que tenha sido colocada /etc em outras pastas de nível superior, como /conf. Esta reestruturação foi realizada no âmbito do AEM 6.5 e é descrita na Documentação do AEM 6.5.

A Adobe recomenda colocar a maior parte do código do conector em /apps/connectors/<vendor> para manter uma estrutura de repositório limpa, especialmente para clientes que usam vários conectores.

Configurações dos serviços em nuvem

Um aspecto da implementação do conector é o código que suporta a configuração do conector. Esse código faz com que um cartão com o nome do conector apareça em Ferramentas > Operações > Serviços em nuvem. Quando clicado, um navegador de configuração aparece onde o cliente seleciona a pasta principal para conter a configuração do conector. O código do conector deve resultar em um formulário com todas as propriedades que devem ser configuradas, armazenando os valores em uma pasta de configuração em /conf. Posteriormente, essa pasta pode ser selecionada na guia de propriedades do Sites ou na guia de propriedades do Assets.

Configurações sensíveis ao contexto

As Configurações sensíveis ao contexto permitem criar camadas de configuração em diferentes pastas, incluindo /libs, /apps, /conf e subpastas em /conf. Elas suportam herança, para que um cliente possa configurar a configuração global enquanto faz alterações específicas para cada microsite. Como é possível usar esse recurso para Configurações do Cloud Service, o código do conector deve fazer referência à configuração usando a API de configuração sensível ao contexto, em vez de fazer referência a um nó de configuração específico.

Se as configurações modificadas forem usadas no conector, desenvolva-o para lidar com a inclusão/fusão de qualquer atualização futura nas configurações padrão fornecidas pelo conector com qualquer configuração de cliente. Lembre-se de que modificar conteúdo ou configurações personalizadas pelo cliente sem aviso prévio e consentimento pode interromper ou causar comportamento inesperado em seu conector.