Configurar um ambiente de desenvolvimento local e um projeto de desenvolvimento inicial

Ao configurar e configurar um Adobe Experience Manager Forms como um ambiente Cloud Service, você configura ambientes de desenvolvimento, armazenamento temporário e produção na nuvem. Além disso, também é possível configurar e configurar um ambiente de desenvolvimento local.

Você pode usar o ambiente de desenvolvimento local para criar formulários e ativos relacionados (temas, modelos, ações de envio personalizadas e muito mais) e converter PDF forms para o Adaptive Forms sem fazer logon no ambiente de desenvolvimento de nuvem. Depois que um formulário adaptável ou ativos relacionados estiverem prontos na instância de desenvolvimento local, é possível exportar o formulário adaptável e os ativos relacionados do ambiente de desenvolvimento local para um ambiente de Cloud Service para testes e publicações adicionais.

Você também pode desenvolver e testar código personalizado, como componentes personalizados e serviços de preenchimento prévio no ambiente de desenvolvimento local. Quando o código personalizado é testado e pronto, você pode usar o repositório Git do ambiente de desenvolvimento do Cloud Service para implantar o código personalizado.

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

Pré-requisitos

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

Software Descrição Links de download
Adobe Experience Manager Forms as a Cloud Service SDK O SDK inclui as ferramentas Adobe Experience Manager QuickStart e Dispatcher Baixar de Distribuição de software
Arquivo de recursos 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

Configurar ferramentas de desenvolvimento para Projetos AEM

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

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

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

Configurar o ambiente Experience Manager local para desenvolvimento

O SDK do Cloud Service fornece um arquivo QuickStart . Ela executa uma versão local do Experience Manager. Você pode executar as instâncias Autor ou Publicação 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 como Cloud Service. Portanto, sempre teste seus recursos e código com Adobe Experience Manager como um ambiente de desenvolvimento de Cloud Service antes de mover os recursos para o palco ou produção.

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

Adicione o arquivo Forms às instâncias de Autor e Publicação locais e configure usuários específicos do Forms

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

Instale o arquivo de recursos complementares mais recente do Forms

O arquivo de recursos Adobe Experience Manager Forms as a Cloud Service 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 use vários outros recursos de AEM Forms. Para instalar o pacote:

  1. Baixe e extraia o arquivo AEM Forms mais recente para seu sistema operacional a partir de Distribuição de software.

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

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

Configurar usuários e permissões

Crie usuários como o Desenvolvedor de formulários e o Praticante 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ário de formulários:

Tipo de usuário Grupo AEM
Administrador de formulários / forms-users (Usuários do AEM Forms), template-authors, workflow-users, workflow-editorse fdm-authors
Desenvolvedor de formulários forms-users (Usuários do AEM Forms), template-authors, workflow-users, workflow-editorse fdm-authors
Designer de UX ou líder na experiência do cliente forms-users, template-authors
Administrador do AEM aem-administrators, fd-administrators
Usuário final Quando um usuário precisar fazer logon para visualizar e enviar um formulário adaptável, adicione esses usuários ao grupo forms-users.
Quando nenhuma autenticação de usuário for 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)

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

  1. Instalar e configurar o Docker:

    • (Para Microsoft Windows) Instale Docker Desktop. Ele configura o Mecanismo Docker e o docker-compom na máquina.

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

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

    OBSERVAÇÃO
    • Para Apple macOS, coloque pastas em uma lista de permissões contendo instâncias locais do autor do AEM.

    • O Docker Desktop para Windows suporta dois backends, Hyper-V
      (herdado) e WSL2 (moderno). O compartilhamento de arquivos é automático
      gerenciado pela Docker ao usar o WSL2 (moderno). Você tem que
      configure explicitamente o compartilhamento de arquivos ao usar o Hyper-V (herdado).

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

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

    o aem forms extraído adiciona 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 o sdk.bat ou sdk.sh para edição. Defina o 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 o seguinte comando para iniciar o SDK:

    • (no Microsoft Windows) sdk.bat start
    • (no Linux ou no Apple Mac OS) AEM_HOME=[local AEM Author installation] ./sdk.sh start
    OBSERVAÇÃO

    Se você tiver definido a variável de ambiente no arquivo sdk.sh , é opcional especificar na linha de comando. 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 Documento de registro. Para testar, faça upload de 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/check-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

Use este projeto para criar o Adaptive Forms, implantar atualizações de configuração, sobreposições, criar componentes personalizados do Formulário adaptável, testar e código personalizado no SDK local Experience Manager Forms. Após testar localmente, você pode implantar o projeto em Experience Manager Forms como um ambiente de produção e não produção de Cloud Service. Para configurar o projeto:

  1. Repositório Git do Clone Cloud Manager na instância de desenvolvimento local: o repositório Git do Cloud Manager contém um projeto de AEM padrão. É baseado em AEM Archetype. Clone seu Repositório Git do Cloud Manager usando o Gerenciamento de conta Git de 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 Git.
  1. Criar um projeto Experience Manager Forms as a [Cloud ] Service: crie um projeto Experience Manager Forms as a [Cloud ] Service com base no AEM Archetype 27 ou posterior. O arquétipo ajuda os desenvolvedores a começarem a desenvolver facilmente para AEM Forms como um Cloud Service. Também inclui alguns temas e modelos de exemplo para ajudar você a começar rapidamente.

    Abra o prompt de comando e execute o comando abaixo para criar um Experience Manager Forms como um projeto do Cloud Service. Para incluir Forms configurações, temas e modelos específicos, defina includeForms=y.

    mvn -B archetype:generate -DarchetypeGroupId=com.adobe.aem -DarchetypeArtifactId=aem-project-archetype -DarchetypeVersion=27 -DaemVersion="cloud" -DappTitle="My Site" -DappId="mysite" -DgroupId="com.mysite" -DincludeForms="y"
    

    Além disso, altere appTitle, appId e groupId, no comando acima para refletir seu ambiente.

  2. Implante o projeto no ambiente de desenvolvimento local. Você pode usar o seguinte comando para implantar em seu ambiente de desenvolvimento local

    mvn -PautoInstallPackage clean install

    Para obter a lista completa de comandos, consulte Criação e Instalação

  3. Implante o código no AEM Forms ambiente Cloud Service.

Configurar ferramentas locais do Dispatcher

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 Publish. O Dispatcher é parte integrante da arquitetura de 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 o Dispatcher local

O Experience Manager como SDK do Cloud Service 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 transpor os 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 container Docker.

O armazenamento em cache no Dispatcher permite que 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 locais do Dispatcher

Adicionar regras específicas do Forms ao Dispatcher

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

  1. Abra o Projeto do 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 recém-criado para editar e substituir o seguinte código:

    #/ignoreUrlParams {
    #/0001 { /glob "*" /type "deny" }
    #/0002 { /glob "q" /type "allow" }
    #}
    

    com

    /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 AEM Forms como um ambiente Cloud Service.

Considerações sobre o armazenamento em cache

  • O armazenamento em cache do Dispatcher permite que 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 ativar o recurso, você pode executar as instruções fornecidas no artigo Armazenamento em cache de conteúdo protegido
  • O Dispatcher pode não conseguir invalidar algum Adaptive Forms e o Adaptive Forms relacionado. Para resolver esses problemas, consulte AEM Forms Cache na seção solução de problemas.
  • Armazenamento em cache do Forms adaptável 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>
    • Por padrão, a opção Localidade do navegador está desativada. Para alterar a configuração de local do navegador,
  • Quando você usa o Formato de URL http://host:port/content/forms/af/<adaptivefName>.html e Usar Localidade do Navegador no gerenciador de configuração está desativado, a versão não localizada do Formulário adaptativo é exibida. O idioma não localizado é o idioma usado durante o desenvolvimento do Formulário adaptável. A localidade configurada para o seu navegador (localidade do navegador) não é considerada e uma versão não localizada do Formulário adaptável é disponibilizada.
  • Quando você usa o Formato de URL http://host:port/content/forms/af/<adaptivefName>.html e Usar Localidade do Navegador no gerenciador de configuração está ativado, uma versão localizada do Formulário adaptativo é disponibilizada, se disponível. O idioma do formulário adaptável localizado é baseado na localidade configurada para seu navegador (localidade do navegador). Isso pode levar a [armazenar em cache apenas 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 está armazenada em cache na seção Solução de problemas.

Seu ambiente de desenvolvimento local está pronto.

Atualizar seu ambiente de desenvolvimento local

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. Certifique-se de que qualquer código, configuração ou conteúdo que não deve ser destruído esteja comprometido com o Git ou seja exportado das instâncias do Experience Manager local como Pacotes CRX.

Como evitar perda de conteúdo ao atualizar o SDK

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

Faça o backup e importe conteúdo específico do Forms para um novo ambiente do SDK

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

  • Crie um backup do seu conteúdo existente.

  • Configure um novo ambiente do SDK.

  • Importe o backup para o novo ambiente SDK.

Crie um backup do seu conteúdo existente

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

  1. 🔗 DownloadAdaptive Forms, themes e PDF forms.

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

  3. Baixar modelos de dados de 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 do seu ambiente de desenvolvimento local. Para exportar essas configurações e 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

Importe Forms adaptáveis, modelos, modelo de dados de formulário, tema, configurações e código personalizado para seu novo ambiente. Você pode executar a seguinte ação para importar o backup:

  1. 🔗 Importe Forms adaptáveis, temas e PDF forms para novos ambientes SDK.

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

  3. Faça upload de Modelos de dados de formulário para o novo ambiente SDK.

  4. Importe modelos editáveis, configurações de nuvem e modelo de fluxo de trabalho. Para importar todos os itens mencionados anteriormente no novo ambiente do SDK, importe o Pacote CRX contendo esses itens para o novo ambiente do SDK.

  5. Importe configurações de email, envio e código de ações de preenchimento prévio de seu ambiente de desenvolvimento local. Para importar essas configurações e configurações, coloque os seguintes arquivos do seu antigo projeto do Archetype no novo projeto do Archetype:

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

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

Nesta página