DocumentaçãoAEM as a Cloud ServiceGuia do usuário

Configurar ambiente de desenvolvimento local para o AEM Forms overview

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

Criado para:

  • undefined
  • undefined
  • undefined

Ao configurar um ambiente do ​ Adobe Experience Manager Forms as a ​ Cloud Service, você configura ambientes de desenvolvimento, de preparo e de produção na nuvem. Além disso, também é possível definir e configurar um ambiente de desenvolvimento local.

Você pode usar o ambiente de desenvolvimento local para executar as seguintes ações sem fazer logon no ambiente de desenvolvimento da nuvem:

Depois que um formulário adaptável ou ativos relacionados estiverem prontos na instância de desenvolvimento local ou quando um aplicativo para gerar as [Comunicações do cliente] estiver pronto, você poderá exportar o formulário adaptável ou o aplicativo de Comunicações do cliente do ambiente de desenvolvimento local para um ambiente Cloud Service para testes adicionais ou migração para ambientes de produção.

Você também pode desenvolver e testar o código personalizado, como componentes personalizados e preencher o serviço no ambiente de desenvolvimento local. Quando o código personalizado for testado e estiver pronto, você poderá usar o repositório Git do seu ambiente de desenvolvimento de Cloud Service para implantar o código personalizado.

Para configurar um novo ambiente de desenvolvimento local e usá-lo para desenvolver atividades do, execute as seguintes ações na ordem listada:

Pré-requisitos

Você precisa do seguinte software para configurar um ambiente de desenvolvimento local. Baixe-os antes de começar a configurar o ambiente de desenvolvimento local:

Software
Descrição
Links de download
ADOBE EXPERIENCE MANAGER AS A CLOUD SERVICE SDK
O SDK inclui as ferramentas QuickStart e Dispatcher do Adobe Experience Manager
Baixe o SDK mais recente da Distribuição de software
Arquivo de recursos do Adobe Experience Manager Forms (complemento do AEM Forms)
Ferramentas para criar, estilizar e otimizar o Adaptive Forms e outros recursos do Adobe Experience Manager Forms
Baixar de Distribuição de software
(Opcional) Conteúdo de referência do Adobe Experience Manager Forms
Ferramentas para criar, estilizar e otimizar o Adaptive Forms e outros recursos do Adobe Experience Manager Forms
Baixar de Distribuição de software
(Opcional) Adobe Experience Manager Forms Designer
Ferramentas para criar, estilizar e otimizar o Adaptive Forms e outros recursos do Adobe Experience Manager Forms
Baixar de Distribuição de software

Baixar a versão mais recente do software da Distribuição de software software-distribution

Para baixar a versão mais recente do SDK do Adobe Experience Manager as a Cloud Service, o arquivo de recursos do Experience Manager Forms (complemento do AEM Forms), os ativos de referência de formulários ou o Forms Designer em Distribuição de software:

  1. Faça logon no https://experience.adobe.com/#/downloads com sua Adobe ID

    note note
    NOTE
    Sua organização de Adobe deve ser provisionada para que a AEM as a Cloud Service baixe o SDK da AEM as a Cloud Service.

  2. Navegue até a guia AEM as a Cloud Service.

  3. Classifique por data de publicação em ordem decrescente.

  4. Clique no Adobe Experience Manager as a Cloud Service SDK mais recente, no arquivo de recursos do Experience Manager Forms (complemento do AEM Forms), nos ativos de referência de formulários ou no Forms Designer.

    note note
    NOTE
    É recomendável baixar a versão mais recente do arquivo de recursos do Experience Manager Forms (complemento do AEM Forms), dos ativos de referência de formulários ou do Forms Designer para uma compatibilidade perfeita com o SDK do Adobe Experience Manager as a Cloud Service.

  5. Revise e aceite o EULA. Clique no botão Baixar.

Configurar ferramentas de desenvolvimento para Projetos AEM setup-development-tools-for-AEM-projects

O projeto do Adobe Experience Manager Forms é uma base de código personalizada. Ele contém código, configurações e conteúdo que são implantados via Cloud Manager no Adobe Experience Manager as a Cloud Service. O Arquétipo Maven do projeto AEM fornece a estrutura de linha de base para o projeto.

Configure as seguintes ferramentas de desenvolvimento para usar no projeto Adobe Experience Manager para desenvolvimento:

Para obter instruções detalhadas sobre como configurar as ferramentas de desenvolvimento mencionadas anteriormente, consulte Configurar ferramentas de desenvolvimento.

Configurar o ambiente de Experience Manager local para desenvolvimento

O SDK do Cloud Service fornece um arquivo QuickStart. Ele executa uma versão local do Experience Manager. Você pode executar as instâncias Autor ou Publish localmente.

Embora o QuickStart forneça uma experiência de desenvolvimento local, ele não tem todos os recursos disponíveis em Adobe Experience Manager as a Cloud Service. Portanto, sempre teste seus recursos e código com o ambiente de desenvolvimento as a Cloud Service do Adobe Experience Manager antes de mover os recursos para o estágio ou produção.

Para instalar e configurar o ambiente de Experience Manager local, execute as seguintes etapas:

Adicionar arquivo do Forms às instâncias locais do Author e do Publish e configurar usuários específicos do Forms add-forms-archive-configure-users

Execute as seguintes etapas na ordem listada para adicionar o arquivo Forms às instâncias Experience Manager e configurar usuários específicos de formulários:

Instale o arquivo de recursos complementares mais recente do Forms add-forms-archive

O arquivo de recursos as a Cloud Service do Adobe Experience Manager Forms fornece ferramentas para criar, estilizar e otimizar o Adaptive Forms no ambiente de desenvolvimento local. Instale o pacote para criar um Formulário Adaptável e usar vários outros recursos do AEM Forms. Para instalar o pacote:

  1. Baixe e extraia o arquivo morto AEM Forms mais recente para o seu sistema operacional da Distribuição de Software.

  2. Navegue até o diretório crx-quickstart/install. Caso a pasta não exista, crie-a.

  3. Para interromper a instância do AEM, coloque o arquivo de recursos complementares do AEM Forms, aem-forms-addon-<version>.far, na pasta de instalação.

  4. Vá para a janela do comando ativo e pressione o comando Ctrl + C para reiniciar o SDK.

    note note
    NOTE
    É recomendável usar o comando "Ctrl + C" para reiniciar o SDK. Reiniciar o SDK do AEM usando métodos alternativos, por exemplo, parar processos Java, pode levar a inconsistências no ambiente de desenvolvimento do AEM.

Configurar usuários e permissões configure-users-and-permissions

Crie usuários como Desenvolvedor de Formulários e Profissional de Formulários e adicione esses usuários a grupos de formulários predefinidos para fornecer as permissões necessárias. A tabela abaixo lista todos os tipos de usuários e grupos predefinidos para cada tipo de usuários de formulários:

Tipo de usuário
Grupo AEM
Profissional de formulários /
forms-users (Usuários do AEM Forms), template-authors, workflow-users, workflow-editors e fdm-authors
Desenvolvedor de formulários
forms-users (Usuários do AEM Forms), template-authors, workflow-users, workflow-editors e fdm-authors
Líder de experiência do cliente ou UX Designer
forms-users, template-authors
Administrador do AEM
aem-administrators, fd-administrators
Usuário final
Quando um usuário precisar fazer logon para exibir e enviar um Formulário adaptável, adicione esses usuários ao grupo forms-users.
Quando nenhuma autenticação de usuário é necessária para acessar o Adaptive Forms, não atribua nenhum grupo a esses usuários.

Configurar o ambiente de desenvolvimento local para o Documento de registro (DoR) docker-microservices

O AEM Forms as a Cloud Service fornece um ambiente de SDK baseado em docker para facilitar o desenvolvimento do Documento de registro e o uso de outros microsserviços. Isso libera você da configuração manual de binários e adaptações específicos da plataforma. Para configurar o ambiente:

  1. Instalar e configurar o Docker:

    • (Para Microsoft® Windows) Instale O Docker Desktop. Ele configura o Docker Engine e o docker-compose no seu computador.

    • (Apple macOS) Instale o Docker Desktop para Mac. Ele inclui Docker Engine, cliente Docker CLI, Docker Compose, Docker Content Trust, Kubernetes e Credential Helper.

    • (Para Linux®) Instale o Docker Engine e o Docker Compose no computador.

    note note
    NOTE

    • Para o Apple macOS, o incluir na lista de permissões AEM pastas que contêm instâncias locais do Autor.

    • O Docker Desktop para Windows suporta dois back-ends, Hyper-V
      (herdado) e WSL2 (moderno). O compartilhamento de arquivos é automaticamente
      gerenciado pelo Docker ao usar o WSL2 (moderno). Você precisa
      configure explicitamente o compartilhamento de arquivos ao usar o Hyper-V (herdado).

  2. Crie uma pasta, digamos o aem-sdk, em paralelo às instâncias de autor e publicação. Por exemplo, C:\aem-sdk.

  3. Extrair o arquivo aem-forms-addon-<version>.zip\aem-forms-addon-native-<version>.zip.

    complemento extraído do aem forms no nativo

  4. Crie uma variável de ambiente AEM_HOME e aponte para a instalação local do AEM Author. Por exemplo, C:\aem\author.

  5. Abra sdk.bat ou sdk.sh para edição. Defina AEM_HOME para apontar para a instalação local do AEM Author. Por exemplo, C:\aem\author.

  6. Abra o prompt de comando e navegue até a pasta aem-forms-addon-native-<version>.

  7. Certifique-se de que a instância local do autor do AEM esteja ativa e em execução. Execute os seguintes comandos para iniciar o SDK:

    • No Microsoft® Windows

      code language-shell 
      sdk.bat start

    • Linux® ou Apple macOS

      code language-shell 
      % export AEM_HOME=[local AEM Author installation]
% ./sdk.sh start
    note note
    NOTE
    Se você tiver definido a variável de ambiente no arquivo sdk.sh, especificá-la na linha de comando é opcional. A opção para definir a variável de ambiente na linha de comando é fornecida para executar o comando sem atualizar o script de shell.

    start-sdk-command

Agora você pode usar o ambiente de desenvolvimento local para renderizar o Documento de registro. Para testar, carregue um arquivo XDP no seu ambiente e renderize-o. Por exemplo, http://localhost:4502/libs/xfaforms/profiles/default.print.pdf?template=crx:///content/dam/formsanddocuments/cheque-request.xdp converte o arquivo XDP para o documento PDF.

Configurar um projeto de desenvolvimento para o Forms com base no arquétipo de Experience Manager forms-cloud-service-local-development-environment

Use este projeto para criar o Forms Adaptável, implantar atualizações de configuração, sobreposições, criar componentes de Formulário Adaptável personalizados, testar e personalizar código no SDK Experience Manager Forms local. Depois de testar localmente, você pode implantar o projeto em Experience Manager Forms ambientes de produção e não produção as a Cloud Service. Quando você implanta o projeto, os seguintes ativos do AEM Forms também são implantados:

Temas
Modelos
Modelo de dados de formulário (FDM)
Canvas 3.0
Básico
Microsoft® Dynamics 365
Tranquilo
Em branco
Salesforce
Urbana
Ultramarina
Berilo
NOTE
Configure o Arquétipo AEM versão 30 ou posterior do projeto para obter e usar o Microsoft® Dynamics 365 e o Salesforce Form Data Model (FDM) com o AEM Forms as a Cloud Service.
Configure o Arquétipo AEM versão 32 ou posterior do projeto para obter e usar temas Tranquil, Urbane e Ultramarine com o AEM Forms as a Cloud Service.

Para configurar o projeto:

  1. Clonar o repositório Git do Cloud Manager na instância de desenvolvimento local: O repositório Git do Cloud Manager contém um projeto AEM padrão. É baseado no Arquétipo AEM. Clonar o Repositório Git da Cloud Manager usando o Gerenciamento de conta Git por autoatendimento da interface do usuário do Cloud Manager para trazer o projeto para o ambiente de desenvolvimento local. Para obter detalhes sobre como acessar o repositório, consulte Acessando Repositórios.

  2. Criar um Experience Manager Forms como um projeto [Cloud Service]: Criar um Experience Manager Forms como um projeto [Cloud Service] com base no Arquétipo do AEM ou posterior mais recente. O arquétipo ajuda os desenvolvedores a iniciar o desenvolvimento facilmente para o AEM Forms as a Cloud Service. Ele também inclui alguns exemplos de temas e modelos para ajudá-lo a começar rapidamente.

    Abra o prompt de comando e execute o comando abaixo para criar um projeto as a Cloud Service Experience Manager Forms.

    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"

    Altere os appTitle, appId e groupId no comando acima para refletir seu ambiente. Além disso, defina o valor de includeFormsenrollment, includeFormscommunications e includeFormsheadless como y ou n, dependendo da sua licença e dos requisitos. Incluir Formsheadless é obrigatório para criar o Forms adaptável com base nos Componentes principais.

    • Use a opção includeFormsenrollment=y para incluir configurações específicas do Forms, temas, modelos, Componentes principais e dependências necessárias para criar o Forms adaptável. Se você usa o Forms Portal, defina a opção includeExamples=y. Ele também adiciona os componentes principais do Forms Portal ao projeto.

    • Use a opção includeFormscommunications=y para incluir os Componentes principais do Forms e as dependências necessárias para incluir a funcionalidade de Comunicações do cliente.

      note warning
      WARNING
      • Ao criar um projeto do Arquétipo com versão 45, a [Pasta do projeto do Arquétipo AEM]/pom.xml define inicialmente a versão dos componentes principais de formulários como 2.0.64. Antes de criar ou implantar o projeto Arquétipo, atualize a versão dos componentes principais de formulários para 2.0.62.

  3. Implante o projeto no ambiente de desenvolvimento local. Você pode usar o comando a seguir para implantar no ambiente de desenvolvimento local

    mvn -PautoInstallPackage clean install

    Para obter a lista completa de comandos, consulte Compilando e Instalando

  4. Implante o código em seu AEM Forms ambiente as a Cloud Service.

Configurar ferramentas locais do Dispatcher setup-local-dispatcher-tools

O Dispatcher é um módulo de servidor Web Apache HTTP que fornece uma camada de segurança e desempenho entre a camada CDN e AEM do Publish. O Dispatcher é parte integrante da arquitetura Experience Manager geral e deve fazer parte do ambiente de desenvolvimento local.

Execute as seguintes etapas para configurar o Dispatcher local e, em seguida, adicionar regras específicas do Forms a ele:

Configurar Dispatcher local setup-local-dispatcher

O SDK as a Cloud Service do Experience Manager inclui a versão recomendada das Ferramentas do Dispatcher que facilita a configuração, validação e simulação do Dispatcher localmente. As Ferramentas do Dispatcher são baseadas em Docker e fornecem ferramentas de linha de comando para transcompilar arquivos de configuração do Apache HTTP Web Server e do Dispatcher em um formato compatível e implantá-los no Dispatcher em execução no contêiner Docker.

O armazenamento em cache no Dispatcher permite que o AEM Forms preencha previamente o Adaptive Forms em um cliente. Ele melhora a velocidade de renderização de formulários pré-preenchidos.

Para obter instruções detalhadas sobre como configurar o Dispatcher, consulte Configurar ferramentas do Dispatcher locais

Adicionar regras específicas do Forms ao Dispatcher forms-specific-rules-to-dispatcher

Execute as seguintes etapas para configurar o cache do Dispatcher para o Experience Manager Forms as a Cloud Service:

  1. Abra seu projeto AEM e navegue até \src\conf.dispatcher.d\available_farms

  2. Crie uma cópia do arquivo default.farm. Por exemplo, forms.farm.

  3. Abra o arquivo forms.farm criado para edição e substitua o seguinte código:

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

    com

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

  4. Salve e feche o arquivo.

  5. Vá para conf.d/enabled_farms e crie um link simbólico para o arquivo forms.farm.

  6. Compile e implante o projeto no seu ambiente as a Cloud Service AEM Forms.

Considerações sobre armazenamento em cache considerations-about-caching

  • O armazenamento em cache do Dispatcher permite que o AEM Forms preencha previamente o Adaptive Forms em um cliente. Ele melhora a velocidade de renderização de formulários pré-preenchidos.

  • O armazenamento em cache de recursos de conteúdo protegido está desativado, por padrão. Para habilitar o recurso, você pode executar as instruções fornecidas no artigo Cache de conteúdo protegido

  • O Dispatcher pode falhar ao invalidar alguns Forms adaptáveis e alguns Forms adaptáveis relacionados. Para resolver esses problemas, consulte AEM Forms Cache na seção de solução de problemas.

  • Armazenamento em cache do Adaptive Forms localizado:

    • Use o formato de URL http://host:port/content/forms/af/<afName>.<locale>.html para solicitar uma versão localizada de um Formulário adaptável em vez de http://host:port/content/forms/af/afName.html?afAcceptLang=<locale>
    • A opção Local do navegador está desativada, por padrão. Para alterar a configuração do local do navegador,

  • Quando você usa o Formato de URL http://host:port/content/forms/af/<adaptivefName>.html e a opção Usar Localidade do Navegador no gerenciador de configurações está desabilitada, a versão não localizada do Formulário adaptável é fornecida. O idioma não localizado é o idioma usado ao desenvolver o Formulário adaptável. A localidade configurada para seu navegador (localidade do navegador) não é considerada e uma versão não localizada do Formulário adaptável é fornecida.

  • Quando você usa o Formato de URL http://host:port/content/forms/af/<adaptivefName>.html e a opção Usar Localidade do Navegador no gerenciador de configurações estiver habilitada, uma versão localizada do Formulário adaptável será fornecida, se disponível. O idioma do Formulário adaptável localizado se baseia no local configurado para seu navegador (local do navegador). Pode levar ao [armazenamento em cache somente a primeira instância de um Formulário adaptável]. Para evitar que o problema ocorra em sua instância, consulte somente a primeira instância de um Formulário adaptável é armazenada em cache na seção de solução de problemas.

O ambiente de desenvolvimento local está pronto.

Habilitar os componentes principais de formulários adaptáveis no AEM Forms as a Cloud Service e no ambiente de desenvolvimento local

A habilitação dos Componentes principais do Forms adaptável no AEM Forms as a Cloud Service permite que você comece a criar, publicar e fornecer Componentes principais baseados no Forms adaptável e no Forms headless usando as instâncias de Cloud Service do AEM Forms para vários canais. Você precisa do ambiente habilitado dos Componentes principais adaptáveis do Forms para usar o Forms adaptável headless.

Para obter instruções, consulte Habilitar os Componentes principais adaptáveis do Forms no ambiente de desenvolvimento as a Cloud Service e local do AEM Forms

Atualizar o ambiente de desenvolvimento local upgrade-your-local-development-environment

Atualizar o SDK para uma nova versão requer a substituição de todo o ambiente de desenvolvimento local, resultando na perda de todo o código, configuração e conteúdo nos repositórios locais. Verifique se qualquer código, configuração ou conteúdo que não deve ser destruído foi confirmado com segurança no Git ou exportado das instâncias de Experience Manager locais como pacotes do CRX.

Como evitar perda de conteúdo ao atualizar o SDK avoid-content-loss-when-upgrading--SDK

A atualização do SDK está efetivamente criando uma nova instância totalmente nova para Autores e Publish, incluindo um novo repositório (Configurar projeto AEM), o que significa que todas as alterações feitas no repositório de um SDK anterior serão perdidas. Para obter estratégias viáveis para ajudar na persistência de conteúdo entre atualizações do SDK, consulte Como evitar a perda de conteúdo ao atualizar o SDK do AEM

Fazer backup e importar conteúdo específico do Forms para um novo ambiente de SDK backup-and-import-Forms-specific-content-to-new-SDK-environment

Para fazer backup e mover ativos do SDK existente para um novo ambiente de SDK:

  • Crie um backup do conteúdo existente.

  • Configure um novo ambiente do SDK.

  • Importe o backup para o novo ambiente do SDK.

Criar um backup do conteúdo existente create-backup-of-your-existing-content

Faça backup do Forms adaptável, de modelos, do modelo de dados de formulário (FDM), do tema, das configurações e do código personalizado. Você pode executar a seguinte ação para criar o backup:

  1. Baixar Forms adaptável, temas e PDF forms.

  2. Exportar modelos de formulário adaptável.

  3. Baixar modelos de dados do formulário

  4. Exportar modelos editáveis, configurações de nuvem e modelo de fluxo de trabalho. Para exportar todos os itens mencionados anteriormente do SDK existente, crie um CRX-Package com os seguintes filtros:

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

  5. Exporte configurações de email, envie e preencha previamente o código de ações de seu ambiente de desenvolvimento local. Para exportar essas configurações, crie uma cópia das seguintes pastas e arquivos no ambiente de desenvolvimento 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 o backup para o novo ambiente do SDK import-the-backup-to-your-new-SDK-environment

Importe o Adaptive Forms, modelos, modelo de dados de formulário, tema, configurações e código personalizado para seu ambiente atualizado. Execute a seguinte ação para importar o backup:

  1. Importar Forms adaptável, temas e PDF forms para novos ambientes do SDK.

  2. Importar modelos de formulário adaptável para o novo ambiente do SDK.

  3. Fazer upload de modelos de dados de formulário para o novo ambiente do SDK.

  4. Importar modelos editáveis, configurações de nuvem e modelo de fluxo de trabalho. Para importar todos os itens mencionados anteriormente para o novo ambiente do SDK, importe o pacote do CRX que contém esses itens para o novo ambiente do SDK.

  5. Importe configurações de email, envie e preencha previamente o código de ações do seu ambiente de desenvolvimento local. Para importar essas configurações, coloque os seguintes arquivos do seu antigo projeto do Arquétipo para o seu novo projeto do Arquétipo:

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

Seu novo ambiente agora tem formulários e ativos relacionados do ambiente antigo.

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