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

Ao configurar e configurar um ​ Adobe Experience Manager Forms como ​ 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 executar as seguintes ações 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 ou em um aplicativo para gerar [Comunicações do cliente] estiver pronto, você pode exportar o aplicativo Adaptive Form ou Customer Communications do ambiente de desenvolvimento local para um ambiente Cloud Service para testes adicionais ou para ambientes de produção.

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 as a Cloud Service SDK O SDK inclui Adobe Experience Manager Ferramentas do QuickStart e do Dispatcher Baixe o SDK mais recente em Distribuição de software
Arquivo de recursos do Adobe Experience Manager Forms (complemento 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

Faça o download da versão mais recente do software na Distribuição de software

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 AEM Forms), os ativos de referência de formulários ou o Forms Designer de Distribuição de software:

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

    OBSERVAÇÃO

    Sua organização do Adobe deve ser provisionada para AEM as a Cloud Service baixar o SDK as a Cloud Service AEM.

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

  3. Classifique por data publicada em ordem decrescente.

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

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

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 são implantados via Cloud Manager no Adobe Experience Manager as a Cloud Service. O Arquétipo de Maven do Projeto AEM fornece a estrutura de base do projeto.

Configure as seguintes ferramentas de desenvolvimento para usar em seu Adobe Experience Manager projeto de 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 as a Cloud Service. Portanto, sempre teste seus recursos e código com Adobe Experience Manager Ambiente de desenvolvimento as a Cloud Service antes de mover os recursos para o estágio 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 as a Cloud Service de recursos 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 a versão mais recente AEM Forms arquivar 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 a variável AEM Forms arquivo de recursos complementares, aem-forms-addon-<version>.far, na pasta install e reinicie a instância.

Configurar usuários e permissões

Crie usuários como o desenvolvedor de formulários e o profissional de formulários e adicionar 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
Cliente Experience Lead 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 a forms-users grupo.
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:

    OBSERVAÇÃO
    • Para o Apple macOS, lista de permissões pastas de contendo instâncias locais do AEM Author.

    • 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 aem-forms-addon-<version>.zip\aem-forms-addon-native-<version>.zip arquivo.

    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é o aem-forms-addon-native-<version> pasta.

  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 Apple macOS) 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/cheque-request.xdp converte o arquivo XDP no documento PDF.

Configurar um projeto de desenvolvimento para o Forms com base no arquétipo do 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 local Experience Manager Forms SDK. Após testar localmente, você pode implantar o projeto no Experience Manager Forms Ambientes as a Cloud Service de produção e não de produção. Ao implantar o projeto, os seguintes ativos da AEM Forms também são implantados:

Temas Modelos Modelos de dados de formulário
Tela 3.0 Básico Microsoft® Dynamics 365
Tranquilo Em branco Salesforce
Urbane
Ultramarina
Beril
OBSERVAÇÃO

Configure AEM projeto baseado no Archetype versão 30 ou posterior para obter e usar os Modelos de dados de formulário do Microsoft® Dynamics 365 e Salesforce com o AEM Forms as a Cloud Service.
Configure AEM projeto baseado no Archetype versão 32 ou posterior para obter e usar os temas Tranquil, Urbane e Ultramarine com o AEM Forms as a 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 Arquétipo de AEM. 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 Acessar repositórios.

  2. Crie um Experience Manager Forms como [Cloud Service] projeto: Crie um Experience Manager Forms como [Cloud Service] projeto baseado em Arquétipo de AEM 32 ou posterior. O arquétipo ajuda os desenvolvedores a começarem facilmente a desenvolver AEM Forms as a 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 Projeto as a Cloud Service.

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

    Altere o appTitle, appIde groupId no comando acima para refletir seu ambiente.

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

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

  3. 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

  4. Implante o código no AEM Forms Ambiente as a 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 Dispatcher local

O Experience Manager O SDK as a 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 AEM Forms para preencher 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 as a Cloud Service:

  1. Abra o AEM Project e acesse \src\conf.dispatcher.d\available_farms

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

  3. Abra o arquivo recém-criado forms.farm 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. Ir para conf.d/enabled_farms e criar um link simbólico para a forms.farm arquivo.

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

Considerações sobre o armazenamento em cache

  • O armazenamento em cache do Dispatcher permite AEM Forms para preencher 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 Armazenamento em cache de conteúdo protegido artigo
  • O Dispatcher pode não conseguir invalidar algum Adaptive Forms e o Adaptive Forms relacionado. Para resolver esses problemas, consulte AEM Forms Armazenamento em cache na seção solução de problemas.
  • Armazenamento em cache do Forms adaptável localizado:
    • Usar 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,
  • Ao usar o Formato de URL http://host:port/content/forms/af/<adaptivefName>.htmle Usar Localidade do Navegador no gerenciador de configuração estiver desativado, a versão não localizada do Formulário Adaptável será 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.
  • Ao usar o Formato de URL http://host:port/content/forms/af/<adaptivefName>.htmle Usar local do navegador no gerenciador de configuração estiver ativado, uma versão localizada do Formulário adaptável será exibida, se disponível. O idioma do formulário adaptável localizado é baseado na localidade configurada para seu navegador (localidade do navegador). Pode levar a [armazenamento em cache somente da 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 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 uma nova instância de Autor e Publicação, incluindo um novo repositório (Configurar AEM projeto), o que significa que as alterações feitas em um repositório anterior do SDK são perdidas. Para obter estratégias viáveis para ajudar no conteúdo persistente entre atualizações de SDK, consulte Como evitar perda de conteúdo ao atualizar o SDK do AEM

Faça backup e importe conteúdo específico do Forms para um novo ambiente 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. Baixar Forms adaptável, temas 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 Pacote CRX 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. Importar Adaptável Forms, 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