Introdução ao Edge Delivery Services para AEM Forms usando o Universal Editor (WYSIWYG)

Versão
Link do artigo
Criação com base no Editor universal
Este artigo
Criação baseada em documento
Clique aqui

Este recurso está disponível através do programa de acesso antecipado. Para solicitar acesso, envie um email de seu endereço oficial para aem-forms-ea@adobe.com com o nome da organização do GitHub e o nome do repositório. Por exemplo, se a URL do repositório for https://github.com/adobe/abc, o nome da organização é adobe e o nome do repositório é abc.

Na era digital de hoje, formulários amigáveis são essenciais para todas as organizações. O Edge Delivery Services Forms é criado usando o Editor universal, que oferece recursos do WYSIWYG (what-you-see-is-what-you-get, o que você vê é o que você obtém). Ele fornece uma interface moderna e intuitiva para a criação eficiente de formulários.

O AEM Forms fornece um bloco, conhecido como Bloco adaptável do Forms, para ajudar você a criar facilmente o Edge Delivery Services Forms para capturar e armazenar dados. Você pode criar um novo Projeto do AEM pré-configurado com o Bloco do Adaptive Forms ou adicionar o Bloco do Adaptive Forms a um Projeto do AEM existente.

Fluxo De Trabalho Do Repositório Github {align="center" width="50%"}

Este tutorial o orienta por meio da criação, visualização e publicação de seu próprio formulário com um projeto do Adobe Experience Manager Site novo ou existente usando a criação do WYSIWYG no Universal Editor.

Pré-requisitos

  • Você tem uma conta GitHub e compreende as noções básicas sobre Git.
  • Você entende as noções básicas do HTML, CSS e JavaScript.
  • Você tem o Node/npm instalado para desenvolvimento local.

Criar um novo projeto do AEM pré-configurado com o Bloco Adaptive Forms

O modelo do AEM Forms Boilerplate inicia rapidamente com um projeto do AEM pré-configurado com o Bloco de Forms adaptável. É a maneira mais rápida e fácil de seguir as práticas recomendadas da AEM e começar a criar formulários.

Introdução ao modelo de repositório padronizado do AEM Forms

  1. Crie um repositório GitHub para seu projeto do AEM. Para criar um repositório:

    1. Ir para https://github.com/adobe-rnd/aem-boilerplate-forms.

      Modelo do AEM Forms

    2. Clique na opção Usar este modelo e selecione a opção Criar um novo repositório.

      Criar novo repositório usando o Modelo do AEM Forms

      A tela Criar um novo repositório é aberta.

    3. Na tela Criar um novo repositório, selecione o proprietário e especifique o Nome do repositório. A Adobe recomenda definir o repositório como Público. Então, selecione a opção pública e clique em Criar Repositório.

      Definir o repositório como público

  2. Instale o aplicativo GitHub de sincronização de código da AEM em seu repositório. Para instalar:

    1. Ir para https://github.com/apps/aem-code-sync/installations/new.
    2. Na tela Instalar sincronização de código do AEM, selecione a opção Selecionar apenas repositórios e selecione o repositório recém-criado. Clique em Salvar.

    Definir o repositório como público

  3. Agora vincule o repositório GitHub criado por meio do AEM Forms Boilerplate ao ambiente de criação do AEM Project. Para conectar:

    1. Vá para o repositório GitHub criado anteriormente usando a Matriz do AEM Forms.

    2. Abra o arquivo fstab.yaml para edição.

      abrir arquivo fstab.yaml

    3. Edite o arquivo fstab.yaml para atualizar o ponto de montagem do seu projeto. Substitua o URL pelo URL da sua instância de criação do AEM as a Cloud Service.

      https://<aem-author>/bin/franklin.delivery/<owner>/<repository>/main

      editar arquivo fstab.yaml

    4. Confirme o arquivo fstab.yaml atualizado, depois de atualizar a referência e tudo ficará bem.

      confirmar as alterações

      Se você encontrar problemas de compilação, consulte Solução de problemas de compilação do GitHub.

Criar um novo projeto do AEM

Agora que você tem um projeto GitHub, pode prosseguir para criar e publicar um novo projeto do AEM na instância de criação do AEM as a Cloud Service.

  1. Para criar um novo projeto do AEM:

    1. Faça logon na instância de criação do AEM as a Cloud Service e selecione Sites.

      selecionar sites

    2. Clique em Criar > Site do modelo.

      criar-sites

    3. Selecione o modelo de Site do Edge Delivery Services e clique em Próximo.

      selecionar-modelo-site

      note note
      NOTE
      • Se o modelo de site do Edge Delivery Services não estiver disponível na instância de criação, clique no botão Importar para fazer upload do modelo.
      • Você pode baixar os modelos de site do Edge Delivery Services no GitHub.
    4. Insira os seguintes detalhes para criar um novo projeto do AEM:

      • Título do site - Adicione um título descritivo para o site.
      • Título do site - Use o site-name que você definiu na etapa anterior.
      • URL do GitHub - Use a URL do projeto GitHub criado na etapa anterior.

      criar Site do AEM

    5. A caixa de diálogo Criar Site é exibida. Clique em OK.

      clique em OK

      Em apenas alguns minutos, o novo projeto do AEM será criado.

    6. Navegue até o projeto do AEM recém-criado no console Sites e clique em Editar.
      Nesse caso, a página index.html é usada para ilustração.

      editar site do AEM

      O Projeto AEM é aberto no Editor universal em uma nova guia, permitindo a criação no WYSIWYG. Agora você pode editar seu projeto do AEM.

      Aberturas de site no Editor Universal

  2. Publicar o projeto criado no AEM

    Depois de concluir a edição do projeto do AEM, publique-o. Para publicar:

    1. No console Sites, selecione todas as páginas do Projeto do AEM e clique em Publicação rápida.

      publicar Projeto do AEM Sites

    2. A caixa de diálogo de confirmação Publicação rápida é exibida. Clique em Publicar para iniciar o processo de publicação.

      Caixa de diálogo de confirmação de Publicação Rápida

      Como alternativa, você pode publicar as páginas do Projeto do AEM diretamente da interface do usuário do Universal Editor.

      Caixa de diálogo de confirmação de Publicação Rápida

    Parabéns! Você tem um novo site em execução em https://<branch>--<repo>--<owner>.aem.page/content/<site-name>/.

    • <branch> refere-se à ramificação do seu repositório GitHub.
    • <repository> indica seu repositório GitHub.
    • <owner> refere-se ao nome de usuário da sua conta GitHub que hospeda seu repositório GitHub.
    • <site-name> refere-se ao nome do site criado.

    Por exemplo, se o nome da ramificação for main, o repositório for edsforms, o proprietário for wkndforms e o site-name for eds-forms, o site estará funcionando a https://main--edsforms--wkndforms.aem.page/content/eds-forms/

    note note
    NOTE
    • Para exibir a página index.html do Projeto do AEM, use a URL: https://<branch>--<repo>--<owner>.aem.page/content/<site-name>/
    • Para exibir páginas diferentes da index page do Projeto AEM, use a URL: https://<branch>--<repo>--<owner>.aem.page/content/<site-name>/<site-page-name>

Agora, você pode começar a criar e adicionar formulários ao seu Projeto do AEM.

Adicionar bloco adaptável do Forms ao seu projeto existente do AEM

Se você tiver um projeto do AEM existente, é possível integrar o Bloco de Forms adaptável ao seu projeto atual para começar a criar formulários.

NOTE
Esta etapa se aplica aos projetos compilados com o AEM Boilerplate. Se você criou seu projeto do AEM usando o Modelo do AEM Forms, ignore esta etapa.

Para integrar:

  1. Adicionar arquivos e pastas necessários

    1. Copie e cole as seguintes pastas e arquivos do AEM Forms Boilerplate no seu projeto do AEM:

  2. Atualizar definições de componentes e arquivos de modelos

    1. Navegue até o arquivo ../models/_component-definition.json em seu projeto do AEM e atualize-o com as alterações do arquivo _component-definition.json no Modelo do AEM Forms.

    2. Navegue até o arquivo ../models/_component-models.json em seu projeto do AEM e atualize-o com as alterações do arquivo _component-models.json no Modelo do AEM Forms

  3. Adicionar Editor de Formulário no script do editor

    1. Navegue até o arquivo ../scripts/editor-support.js no seu projeto do AEM e atualize-o com as alterações do arquivo editor-support.js no Modelo do AEM Forms
  4. Atualizar arquivo de configuração ESLint

    1. Navegue até o arquivo ../.eslintignore em seu projeto do AEM e adicione a seguinte linha de códigos para evitar erros relacionados ao mecanismo de regra de Bloco de formulário:

      code language-none
          blocks/form/rules/formula/*
          blocks/form/rules/model/*
      
  5. Confirme e envie essas alterações para o repositório de projetos do AEM no GitHub.

Pronto! O bloco adaptável do Forms agora faz parte do projeto do AEM. Você pode começar a criar e adicionar formulários ao seu projeto do AEM.

Criar Forms usando o WYSIWYG

É possível abrir o projeto do AEM no Editor universal para criação no WYSIWYG, onde você pode editar o projeto e adicionar a seção Formulário adaptável para incluir formulários do Edge Delivery Services nas páginas do projeto do AEM.

  1. Adicione a seção Formulário adaptável à página Projeto do AEM. Para adicionar:

    1. Navegue até o projeto do AEM no console Sites, selecione a página do site que deseja editar e clique em Editar. A página do projeto AEM é aberta no Editor universal para edição.
      Nesse caso, a página index.html é usada para ilustração.
    2. Abra a árvore Conteúdo e navegue até uma seção onde deseja adicionar a seção Formulário adaptável.
    3. Clique no ícone Adicionar e selecione o componente Formulário adaptável na lista de componentes.

    árvore de conteúdo

    A seção Formulário adaptável é adicionada. Agora é possível começar a adicionar componentes de formulário à página Projeto do AEM.

  2. Adicionar componentes de formulário à seção Formulário adaptável adicionada. Para adicionar componentes de formulário:

    1. Navegue até a seção Formulário adaptável adicionada na árvore Conteúdo.

      bloco de formulários adaptáveis adicionado

    2. Clique no ícone Adicionar e adicione os componentes desejados da lista Componentes de Formulários Adaptáveis.

      adicionar componente

      Você também pode arrastar e soltar os componentes necessários do Adaptive Forms, já que o Editor universal oferece um recurso intuitivo de arrastar e soltar.

    3. Selecione o componente de Formulário adaptável adicionado para atualizar suas propriedades usando Propriedades.

      abrir propriedades

    4. Visualize o formulário.
      A captura de tela abaixo exibe o formulário criado no projeto do AEM usando a criação do WYSIWYG:

      formulário adicionado

      Depois de satisfeito com a pré-visualização, o usuário pode prosseguir para publicar a página.

      note note
      NOTE
      É importante publicar a página do Projeto do AEM novamente depois de fazer as alterações; caso contrário, as atualizações não estarão visíveis no navegador.
  3. Publique novamente a página do Projeto do AEM.

    1. Clique em Publicar para publicar a página do Projeto do AEM novamente depois de adicionar o formulário.

      formulário de publicação

    2. A caixa de diálogo de confirmação Publicar aparece na tela. Clique em Publicar para iniciar a publicação.

      publicar formulário1

      Depois de clicar no botão Publicar, a mensagem Publish started successfully será exibida.

      publicar formulário2

    Agora você pode exibir a página Projeto do AEM com o formulário do Edge Delivery Services adicionado no seguinte URL:
    https://<branch>--<repo>--<owner>.aem.page/content/<site-name>/.

    Por exemplo, se o nome da ramificação for main, o repositório for edsforms, o proprietário for wkndforms e o nome do site for eds-forms, a URL será:
    https://main--edsforms--wkndforms.aem.page/content/eds-forms/

    página de índice

Você pode estilizar o Forms do Edge Delivery Services editando os arquivos .css e .js no Bloco de Forms Adaptável e configurando um ambiente de desenvolvimento do AEM local para exibir as alterações instantaneamente em seu navegador.

Configurar ambiente de desenvolvimento do AEM local

Você pode configurar um ambiente de desenvolvimento do AEM local para desenvolver estilos e componentes personalizados localmente. Para começar a usar um ambiente de desenvolvimento do AEM local:

  1. Instalar a CLI do AEM: a CLI do AEM simplifica as tarefas de desenvolvimento. Vamos instalá-lo globalmente usando npm:

    code language-bash
        npm install -g @adobe/aem-cli
    
  2. Clonar seu projeto do GitHub: clone seu repositório de projetos do AEM do GitHub usando o seguinte comando, substituindo <owner> com o proprietário do repositório e <repo> com o nome do repositório:

    code language-none
    git clone https://github.com/<owner>/<repo>
    
  3. Iniciar o Ambiente Local: Navegue até o diretório do projeto e inicie a instância do AEM local com um único comando:

    code language-none
    cd <repo>
    aem up
    

Você pode fazer alterações locais na pasta Bloco de Forms Adaptável blocks/form para estilizar e codificar seus formulários! Edite os arquivos .css ou .js nesse diretório e você poderá ver que as alterações foram refletidas instantaneamente em seu navegador.

Depois de concluir as alterações, use os comandos do Git para confirmá-las e enviá-las por push. Isso atualiza seus ambientes de visualização e produção, acessíveis nos seguintes URLs (substitua espaços reservados pelos detalhes do projeto):

Visualização: https://<branch>--<repo>--<owner>.aem.page/content/<site-name>

Produção: https://<branch>--<repo>--<owner>.aem.live/content/<site-name>

Solução de problemas de build do GitHub

Verifique se o processo de criação do GitHub está descomplicado, solucionando possíveis problemas:

  • Manipular Erros de Linting:
    Caso encontre erros de impressão, você pode ignorá-los. Abra o arquivo [Projeto EDS]/package.json e modifique o script "lint" de "lint": "npm run lint:js && npm run lint:css" para "lint": "echo 'skipping linting for now'". Salve o arquivo e confirme as alterações no projeto GitHub.

  • Resolver Erro de Caminho do Módulo:
    Se você encontrar o erro "Não é possível resolver o caminho para o módulo "'…/…/scripts/lib-franklin.js'", navegue até o arquivo [EDS Project]/blocks/forms/form.js. Atualize a instrução de importação substituindo o arquivo lib-franklin.js pelo arquivo aem.js.

Consulte também:

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