> For the complete documentation index, see [llms.txt](https://docs.caf.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.caf.io/caf-docs/caf-product-guides-pt-br/guia-do-usuario/trust-platform/onboarding-builder.md). # Construtor de Onboarding ### Introdução O Onboarding Builder é o local onde podem ser criados templates para o onboarding do cliente. Esse builder é intuitivo e não requer nenhum código para que o cliente altere suas configurações e personalize cada uma das etapas pelas quais o usuário final passará de acordo com sua identidade visual e necessidades de negócio. Na Trust Platform, há um menu dedicado para isso, e é sobre isso que falaremos a seguir. ### Criando um Template de Onboarding A primeira etapa para criar um template é acessar a tela do Onboarding Builder. Para isso, basta clicar no **"Onboarding Builder"** menu na barra lateral e, ao ser direcionado para a tela onde os templates já estão criados, se você ainda não tiver nenhum ou quiser criar um novo, clique no **"Criar Template"** botão. Quando o modal de criação aparecer, siga estas etapas: 1. Selecione o idioma desejado. 2. Defina o modelo do template (se é para Pessoa, Empresa ou Autenticador Facial). 3. Por fim, escolha um tema. Após tomar essas decisões, o usuário será direcionado para a tela de edição/configuração do template. {% hint style="info" %} **Observação:** para o serviço de Autenticador Facial, é necessário criar um template exclusivo para ele no Builder, por isso a opção de modelo. {% endhint %} {% hint style="warning" %} **Importante:** no fluxo Global, atualmente não há possibilidade de criar um Template de Autenticador Facial. {% endhint %} ### Menu de aparência Ao entrar na seção de edição do template, você encontrará a primeira etapa de personalização, que é **"Aparência"**. Nesse menu, os clientes podem adaptar sua identidade visual, incluindo: 1. **Fonte:** você pode escolher entre todas as fontes disponíveis no Google Fonts. 2. **Fundo:** isso se refere ao fundo do Onboarding, que pode ser uma cor sólida ou uma imagem. 3. **Cores:** você pode alterar as cores automaticamente. 4. **Textos e Imagens:** é possível alterar títulos, subtítulos, texto de botões, mensagens de erro e as imagens de cada etapa do fluxo escolhido. Lembre-se de clicar em **"Salvar"** sempre que forem feitas alterações. ### Menu de fluxo O segundo menu disponível no Onboarding Builder é a seção **"Fluxo"** onde você pode criar e modificar fluxos de acordo com as necessidades do seu negócio. Para isso, basta clicar no segundo ícone no lado esquerdo da tela. Por padrão, já é apresentado um fluxo de sugestão padrão, mas os clientes podem alterá-lo ou usá-lo como guia, adicionando novas etapas, por exemplo. É importante destacar que a ordem de algumas etapas no fluxo sugerido pode ser alterada, mas também existem regras de validação para auxiliar os usuários a fazer personalizações sem criar um fluxo com problemas. Por exemplo, a permissão para acessar a câmera não deve vir depois da captura do documento, logicamente, então disponibilizamos essas validações. Para adicionar uma nova etapa, basta clicar em uma caixa e arrastá-la para o centro da tela, conectando-a a uma seta de um fluxo e etapa existentes. Para excluir uma etapa, clique nos três pontos acima dela e pressione excluir. Também é possível visualizar a etapa como um todo, ver quais textos e cores ela possui e até duplicá-la. ### Menu de configurações O terceiro menu no Builder é o **"Configurações"** menu, onde você tem: 1. **Propriedades:** inclui o favicon, o título do template e a descrição. 2. **Geral:** aqui você pode configurar: * **Template de e-mail:** personalize a mensagem enviada ao usuário final de acordo com a identidade visual do parceiro, construída em HTML. * **Domínio:** personalize o link de onboarding, proporcionando mais confiança ao usuário no processo. * **Botão de ajuda:** especifique a URL de um centro de ajuda para onde o usuário será redirecionado se clicar no botão. * **Somente Mobile:** você pode incentivar os usuários a concluir o onboarding em um dispositivo móvel exibindo um QR code na interface desktop que redireciona o usuário para um dispositivo móvel. * **Capturar dados dos Termos de Aceite:** para cumprir a LGPD, você captura determinadas informações, como data e hora da aceitação, IP do usuário e detalhes do navegador. * **Aviso de compatibilidade com navegadores:** você pode ativar um aviso em modal/pop-up para que os usuários concluam o onboarding usando um dos três navegadores garantidos como 100% compatíveis: Chrome, Firefox e Safari. O onboarding também funciona em outros navegadores, mas pode não oferecer suporte a certos componentes específicos. * **Recarregar dados:** você pode habilitar o salvamento de dados para que, se um usuário não tiver concluído seu onboarding e voltar a ele, não precise inserir novamente os dados que já preencheu, tornando o processo mais rápido. 3. **Reenvio de link:** configure intervalos para reenviar links quando o status do link estiver pendente. 4. **Variáveis:** uma variável é usada para armazenar um valor que pode ser modificado durante o processo de onboarding. As variáveis podem ser usadas em diferentes etapas e momentos ao longo do processo. Algumas variáveis padrão não podem ser modificadas, por exemplo: a variável personCpf não pode ser alterada quando o link de onboarding está associado a um CPF. 5. **Opções de acessibilidade:** essas opções incluem: * **Alto contraste:** um fundo escuro com texto branco é mais agradável visualmente e melhora a legibilidade. * **Aumentar todas as fontes:** todas as fontes são exibidas em negrito para facilitar a leitura. * **Modo monocromático:** um esquema de cores único melhora a legibilidade para pessoas com deficiência na visão de cores. ### Listagem de templates Na tela inicial do Onboarding Builder, você verá uma lista de todos os templates criados na sua conta. A partir daqui, você pode clicar em um template para ir para a tela de edição ou clicar nos três pontos (...) e escolher entre as seguintes opções: * **Propriedades:** isso permite configurar o favicon, o título do template e a descrição. * **Importar/Exportar:** útil para testar um template em um ambiente de homologação e depois movê-lo para um ambiente de produção após os testes. * **Duplicar:** é útil quando você quer reutilizar personalizações feitas em um template. * **Excluir:** usado para descartar um template criado. * **Design:** essa opção leva você para a seção de personalização do template. ### Como um Template de Onboarding é usado Depois de criado, um template pode ser vinculado a um fluxo de processamento e, quando um link de onboarding é criado com esse template, o usuário final passará por cada etapa configurada no Onboarding Builder, preenchendo as informações para concluir seu onboarding. Para saber como criar um link de onboardin, visite: [Lista de Onboarding](/caf-docs/caf-product-guides-pt-br/guia-do-usuario/trust-platform/onboarding-list.md). E se você quiser relembrar como vincular um template de onboarding a um [Templates de Consulta](/caf-docs/caf-product-guides-pt-br/guia-do-usuario/trust-platform/query-templates.md) e/ou [Workflow Builder](/caf-docs/caf-product-guides-pt-br/guia-do-usuario/trust-platform/workflow-builder.md) acesse os links. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.caf.io/caf-docs/caf-product-guides-pt-br/guia-do-usuario/trust-platform/onboarding-builder.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.