Introdução - Tutorial do desenvolvedor
Na era digital de hoje, criar formulários amigáveis é essencial para qualquer organização. O Edge Delivery Services for AEM Forms permite criar formulários usando ferramentas familiares como o Google Docs e o Microsoft Office.
Esses formulários enviam dados diretamente para um arquivo do Microsoft Excel ou do Google Sheets, permitindo que você use um ecossistema vibrante e APIs robustas do Google Sheets, do Microsoft Excel e do Microsoft SharePoint para processar facilmente os dados enviados ou iniciar um fluxo de trabalho de negócios existente.
O AEM Forms fornece um bloco, conhecido como Bloco adaptável do Forms, para ajudar você a criar formulários facilmente para capturar e armazenar dados capturados. Você pode criar um novo projeto do AEM pré-configurado com o Bloco de Forms Adaptável .
Este tutorial do AEM Forms orienta você na criação, visualização e publicação de seu próprio formulário personalizado com um novo projeto do Adobe Experience Manager (AEM) Forms.
Pré-requisitos
- Você tem uma conta GitHub e compreende as noções básicas sobre Git.
- Você tem uma conta do Google ou do Microsoft SharePoint.
- Você entende as noções básicas do HTML, CSS e JavaScript.
- Você tem o Node/npm instalado para desenvolvimento local.
Atenção! Este tutorial usa macOS, Chrome e Visual Studio Code. Embora as etapas possam ser adaptadas para outras configurações, as capturas de tela e os elementos específicos da interface do usuário podem ser diferentes com base no sistema operacional, no navegador e no editor de código escolhidos.
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
-
Crie um repositório GitHub para seu projeto do AEM. Para criar um repositório:
-
Ir para https://github.com/adobe-rnd/aem-boilerplate-forms.
-
Clique na opção Usar este modelo e selecione a opção Criar um novo repositório. A tela criar um novo repositório é aberta.
-
Na tela Criar um novo repositório, selecione o proprietário e especifique o Nome do repositório. A Adobe recomenda que o repositório seja definido como Público. Então, selecione a opção pública e clique em Criar Repositório.
-
-
Instale o aplicativo GitHub de sincronização de código da AEM em seu repositório. Para instalar:
- Ir para https://github.com/apps/aem-code-sync/installations/new.
- 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.
note note NOTE Se você estiver usando o GitHub Enterprise com filtragem de IP, poderá adicionar o seguinte IP à inclui na lista de permissões: 3.227.118.73 Parabéns! Você tem um novo site em execução em
https://<branch>--<repo>--<owner>.aem.page/.<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.
Por exemplo, se o nome da ramificação for
main, o repositório forwefinancee o proprietário forwkndforms, o site estará ativo e em execução emhttps://main--wefinance--wkndforms.aem.page
<!—(https://main–wefinance–wkndform.aem.page)–>
Vincular sua própria fonte de conteúdo
Para copiar o conteúdo de amostra para sua própria pasta de conteúdo e apontar seu repositório GitHub para sua própria pasta de conteúdo:
-
Crie uma nova pasta especificamente para o conteúdo do AEM no Google Drive ou no Microsoft SharePoint. Este documento usa uma pasta criada no Microsoft SharePoint.
-
Compartilhe a pasta com o usuário do Adobe Experience Manager (forms@adobe.com).
Certifique-se de ter fornecido direitos de edição na pasta ao usuário do Adobe Experience Manager.
{width="50%"}
{width="50%"}
-
Copie o conteúdo de exemplo para sua pasta. Para copiar:
-
Descompacte a pasta baixada e copie o conteúdo.
Os arquivos
navefooterdefinem o layout básico de suas páginas e raramente mudam em todo o projeto. Eles também têm uma estrutura específica diferente da maioria dos outros arquivos de conteúdo. Ao examinar esses arquivos, você terá uma ideia de como o conteúdo é organizado no AEM Projects. -
Faça upload desses arquivos para a pasta Microsoft SharePoint ou Google Drive.
Certifique-se de copiar a folha
enquirydo conteúdo de amostra para sua pasta no Google Drive ou no Microsoft SharePoint. Ele contém a estrutura de um formulário de amostra.
-
-
Agora que sua pasta de conteúdo está configurada, é hora de vinculá-la ao seu projeto no GitHub que você criou usando o AEM Forms Boilerplate anteriormente. Para conectar:
-
Vá para o repositório GitHub criado anteriormente usando a Matriz do AEM Forms.
-
Adicione o arquivo
fstab.yamlà pasta raiz. -
Adicione a referência com o caminho para a pasta que você compartilhou com o usuário do AEM (forms@adobe.com).
Se você usar o Microsoft SharePoint, o caminho da pasta usará o seguinte formato:
code language-html https://<tenant>.SharePoint.com/sites/<sp-site>/Shared%20Documents/<folder-name>Por exemplo,
code language-html https://adobe.SharePoint.com/sites/wkndforms/Shared%20Documents/wefinancePara obter mais informações sobre como gerenciar arquivos com o Microsoft SharePoint, consulte Como usar o Adobe SharePoint.
-
Confirme o arquivo
fsatb.yamldepois de adicionar a referência e tudo ficará bem. Se você encontrar problemas de compilação, consulte Solução de problemas de compilação do GitHub.
Isso conecta sua pasta de conteúdo ao seu site. Depois de atualizar a referência, você pode enfrentar os erros "404 Não encontrado" inicialmente. Isso ocorre porque seu conteúdo ainda não foi visualizado. A próxima seção explica como começar a criar e visualizar seu conteúdo.
-
Pré-visualizar e publicar seu conteúdo
Após concluir a última etapa, a nova fonte de conteúdo não ficará vazia, mas não estará visível no site até que seja promovida para a pré-visualização ou estágios ao vivo. No momento, isso pode causar erros 404.
Para visualizar conteúdo não publicado:
-
Instale a extensão do Chrome chamada AEM Sidekick.
Depois de instalar a extensão no Chrome, não se esqueça de fixá-la, isso facilita a localização.
-
Para configurar a extensão do Sidekick Chrome, vá para a pasta Google Drive ou Microsoft SharePoint compartilhada anteriormente, clique com o botão direito do mouse no ícone de extensão na barra de ferramentas do navegador e selecione
Add this project.
Quando a extensão for instalada e seu projeto for adicionado, você estará pronto para visualizar e publicar seu conteúdo do Google Drive.
-
Selecione todos os documentos na pasta Microsoft SharePoint ou Google Drive. Você pode escolher vários documentos mantendo pressionada a tecla Ctrl (Windows/Linux) ou a tecla Cmd (Mac) enquanto clica em.
-
Clique no ícone do AEM Sidekick fixado à barra de extensão do Chrome. Uma barra de ferramentas é exibida na tela. Você pode optar por visualizar ou publicar seu conteúdo.
Se você copiou mais de
index,nav,footereenquiryarquivos, todos esses são documentos separados com seus próprios ciclos de visualização e publicação, portanto, visualize (e publique) todos eles.Ao visualizar os arquivos, novas guias do navegador exibem os documentos. Para visualizar o formulário de amostra, vá para o seguinte URL:
code language-html https://<branch>--<repository>--<owner>.aem.live<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.
URL
https://<branch>--<repo>--<owner>.aem.page/enquiry.Por exemplo, se o repositório do seu projeto se chamar "wefinance", estiver localizado sob o proprietário da conta "wkndform" e você estiver usando a ramificação "main" e o nome do formulário como
enquiry, a URL será:https://main--wefinance--wkndform.aem.live/enquiry.
<!—(https://main–wefinance–wkndform.aem.live/enquiry).–>
Criar um formulário
O conteúdo de amostra inclui uma folha de "consulta" que serve como modelo para o formulário "consulta". Cada linha da planilha representa um campo de formulário, e os cabeçalhos de coluna definem as propriedades do campo. Este formulário de amostra oferece uma vantagem inicial na criação do formulário.
helix-default e shared-aem podem ser usados como nomes de planilha.Vamos começar com a atualização de um rótulo de campo. Abra a planilha "consulta" para edição, altere o rótulo do botão enviar para Let's Talk e use o AEM Sidekick para visualizar e publicar o arquivo.
Ao visualizar ou publicar o arquivo, uma versão JSON do arquivo é exibida em uma nova guia. Copie o URL de visualização (.aem.page) ou publicação (.aem.live) do arquivo.
Abra o arquivo enquiry e substitua a URL no bloco de formulário pela URL do arquivo copiado na etapa anterior. Certifique-se de que o URL seja um hiperlink.
Use o AEM Sidekick para visualizar e publicar o documento de consulta.
Para visualizar o formulário de consulta atualizado, vá para o seguinte URL:
https://<branch>--<repository>--<owner>.aem.page/enquiry
O rótulo do botão de envio é atualizado para Let's Talk.
<!—(https://main–wefinance–wkndform.aem.live/enquiry)–>
URL: https://main--wefinance--wkndform.aem.live/enquiry
<!—(https://main–wefinance–wkndform.aem.live/enquiry)–>
Para obter informações detalhadas sobre como criar e publicar um novo formulário, vá para o guia criar um formulário.
Começar a desenvolver estilo e funcionalidade
Para começar a usar rapidamente um ambiente de desenvolvimento local do AEM:
-
Instalar a AEM CLI: a AEM CLI simplifica as tarefas de desenvolvimento. Vamos instalá-lo globalmente usando npm:
code language-bash npm install -g @adobe/aem-cli -
Clonar o projeto do GitHub: clone o repositório de projetos do GitHub usando o seguinte comando, substituindo
<owner>pelo proprietário do repositório e<repo>pelo nome do repositório:code language-none git clone https://github.com/<owner>/<repo> -
Inicie o ambiente local: navegue até o diretório do projeto e acione a instância local do AEM com um único comando:
code language-none cd <repo> aem up
A pasta Bloco de Forms Adaptável blocks/form é o seu playground para estilo e código de seus formulários! Edite quaisquer arquivos .css ou .js neste diretório e você verá as alterações refletidas instantaneamente em seu navegador.
Pronto para apresentar sua criação? Use o Git para confirmar e enviar suas alterações. Isso atualiza seus ambientes de visualização e produção acessíveis nesses URLs (substitua espaços reservados pelos detalhes do projeto):
Visualização: https://<branch>--<repo>--<owner>.aem.page/
Produção: https://<branch>--<repo>--<owner>.aem.live/
Parabéns! Você configurou seu ambiente de desenvolvimento local com êxito e implantou suas alterações.
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.
Para integrar:
-
Navegue até a pasta do repositório do Projeto AEM no sistema local.
-
Copie e cole as seguintes pastas e arquivos do AEM Forms Boilerplate no seu projeto do AEM:
-
Navegue até o arquivo
/scripts/editor-support.jsno seu projeto do AEM e atualize-o com o arquivo editor-support.js no Modelo do AEM Forms -
Navegue até
/models/_section.jsonno seu projeto do AEM e anexe "formulário" e "formulário-incorporado-adaptável-formulário" à matriz de componentes do objetofilters:code language-none "filters": [ { "id": "section", "components": [ . . . "form", "embed-adaptive-form" ] }] -
(Opcional) Navegue até
/.eslintignoreno seu projeto do AEM e adicione abaixo das linhas de código:code language-none blocks/form/rules/formula/* blocks/form/rules/model/* blocks/form/rules/functions.js scripts/editor-support.js scripts/editor-support-rte.js -
(Opcional) Navegue até
/.eslintrc.jsno seu projeto do AEM e adicione abaixo das linhas de código no objetorules:code language-none 'xwalk/max-cells': ['error', { '*': 4, // default limit for all models form: 15, wizard: 12, 'form-button': 7, 'checkbox-group': 20, checkbox: 19, 'date-input': 21, 'drop-down': 19, email: 22, 'file-input': 20, 'form-fragment': 15, 'form-image': 7, 'multiline-input': 23, 'number-input': 22, panel: 17, 'radio-group': 20, 'form-reset-button': 7, 'form-submit-button': 7, 'telephone-input': 20, 'text-input': 23, accordion: 14, modal: 11, rating: 18, password: 20, tnc: 12, }], 'xwalk/no-orphan-collapsible-fields': 'off', // Disable until enhancement is done for Forms properties -
Abra o terminal e execute os comandos abaixo:
code language-none npm i npm run build:jsonnote note NOTE Antes de enviar as alterações para o repositório do Projeto AEM no GitHub, verifique se os arquivos component-definition.json,component-models.jsonecomponent-filters.jsonlocalizados no nível raiz do projeto AEM estão atualizados com os objetos relacionados ao formulário. -
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 às suas páginas do AEM.
Solução de problemas de build do GitHub
Verifique se o processo de criação do GitHub está descomplicado, solucionando possíveis problemas:
-
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. -
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.