> For the complete documentation index, see [llms.txt](https://docs.facephi.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.facephi.com/docs.facephi-pt-br/produtos/facephi-intelligence-platform/modulos/configurator.md). # Configurator O Configurator permite criar, configurar e gerenciar os processos executados por meio das soluções da FIP.
Neste módulo você pode: * Consultar os processos disponíveis. * Criar processos de Onboarding e autenticação. * Configurar seus componentes e parâmetros. * Adicionar e configurar challenges. * Salvar processos em rascunho. * Publicar e despublicar processos. * Clonar processos existentes. * Arquivar e excluir processos, de acordo com suas permissões. * Consultar as informações necessárias para integrar um processo. * Testar um processo publicado por meio do modo demo. * Gerenciar outras configurações disponíveis para o seu tenant e a sua função. {% hint style="info" %} As alterações feitas no Configurator não afetam as novas execuções até que a configuração correspondente seja publicada. {% endhint %} *** ## Como é organizado A seção principal do Configurator é **Processos**. A partir dela, você pode acessar a lista de processos e abrir cada um para consultar ou modificar sua configuração. Cada processo é definido, entre outros elementos, por: * Seu tipo. * O ambiente em que é executado. * O template utilizado. * Seus componentes. * Os parâmetros desses componentes. * Os challenges configurados. * Seu estado. Algumas configurações adicionais podem estar disponíveis de acordo com as funcionalidades contratadas e as permissões do seu perfil. *** ## Acesso e permissões As ações disponíveis dependem da sua função e das permissões associadas ao seu perfil. De acordo com suas permissões, você pode: * Consultar processos. * Criar processos. * Editá-los. * Cloná-los. * Publicá-los ou despublicá-los. * Arquivá-los. * Excluí-los. * Executá-los no modo demo. * Acessar configurações adicionais. Quando uma ação não está disponível para o seu usuário, ela pode permanecer oculta ou desativada. {% hint style="info" %} Os processos publicados não podem ser modificados diretamente. Se precisar alterar sua configuração, primeiro você deve retirá-los de publicação quando tiver permissão para isso. {% endhint %} *** ## Consultar processos **Processos** mostra os processos disponíveis no ambiente selecionado.
Cada item da lista permite identificar o processo, conhecer seu estado e acessar as ações disponíveis. ### Buscar e filtrar processos Use a busca para localizar um processo pelo nome. Quando disponíveis, use os filtros para limitar os resultados de acordo com critérios como: * Status. * Tipo de processo. * Ambiente. * Template. Os filtros aplicados são exibidos acima da lista e podem ser removidos individualmente. Selecione **Limpar tudo** para removê-los todos. ### Resultados Cada processo pode exibir informações como: * Nome. * Descrição. * ID do processo. * Tipo de processo. * Ambiente. * Template. * Status. * Versão. * Data de criação ou modificação. Dependendo da visualização, também podem aparecer indicadores relacionados ao seu uso. ### Abrir um processo Selecione o processo ou a ação de visualização disponível. O detalhe com a configuração correspondente será aberto. As ações que você pode realizar a partir do detalhe dependem do estado e das suas permissões. ### Sem processos Quando ainda não existem processos, a lista exibe um estado vazio. Selecione **Criar processo** para configurar o primeiro. Os novos processos aparecerão nesta lista assim que forem criados. *** ## Estados de um processo O estado indica em que ponto do seu ciclo de vida um processo se encontra. ### Rascunho O processo está em configuração e ainda não está disponível para novas execuções. Você pode modificá-lo e salvar as alterações até que esteja pronto para publicação. ### Publicado O processo está publicado e pode ser usado para iniciar novas execuções. A versão publicada é imutável. Para realizar alterações, primeiro você deve retirá-la de publicação quando tiver permissão para isso. ### Arquivado O processo foi retirado do uso habitual, mas permanece armazenado no sistema. De acordo com suas permissões, você pode recuperá-lo ou excluí-lo. *** ## Criar um processo Selecione **Criar processo** a partir da lista. A criação começa definindo as principais características do processo.
### Selecionar o tipo de processo Selecione o tipo de Fluxo que deseja configurar. Pode ser: * **Onboarding** * **Authentication** O tipo selecionado determina os templates e componentes que estarão disponíveis. ### Selecionar o ambiente Selecione onde o processo será executado. As opções disponíveis podem incluir: * Web. * iOS. * Android. O ambiente condiciona os componentes e configurações compatíveis. ### Selecionar um template Selecione o template que servirá como configuração inicial. O template define uma combinação base de: * Componentes. * Validações. * Parâmetros. * Dependências. * Challenges, quando aplicável. Depois, você poderá modificar os elementos que forem configuráveis. {% hint style="info" %} Alguns valores ficam definidos pelo tipo de processo, pelo ambiente ou pelo template e não podem ser modificados posteriormente. {% endhint %} *** ## Configurar um processo A configuração é organizada em diferentes seções de acordo com o tipo de processo e o template selecionado.
Pode incluir: * Informações gerais. * Terms & Conditions. * Componentes. * Parâmetros. * Challenges. * Configuração técnica adicional. ### Campos editáveis Os campos editáveis permitem modificar o valor configurado. Cada campo pode ter: * Um valor inicial. * Um formato determinado. * Uma faixa de valores permitida. * Um comprimento mínimo ou máximo. O sistema valida as informações antes de salvar ou publicar. ### Campos somente leitura Alguns valores são exibidos, mas não podem ser modificados. Esses campos representam configurações determinadas por: * O tipo de componente. * O template. * O ambiente. * O próprio sistema. {% hint style="info" %} O fato de um campo não poder ser editado não significa que ele esteja incompleto. Alguns valores fazem parte da configuração interna do componente e são exibidos apenas como referência. {% endhint %} ### Valores gerenciados pelo sistema Alguns parâmetros necessários para executar o processo podem não aparecer no formulário porque o sistema os gerencia automaticamente. Você não precisa configurá-los manualmente. ### Validação dos valores Os campos aceitam apenas valores compatíveis com sua configuração. Se você inserir um valor fora da faixa permitida ou com um formato incorreto, corrija-o antes de salvar ou publicar. *** ## Terms & Conditions Terms & Conditions permite configurar as informações que o usuário deve aceitar durante o processo. A configuração pode incluir: * Título. * Descrição. * Tempo disponível para concluir a etapa. Só pode existir **um componente de Terms & Conditions dentro do mesmo processo**. Se já existir um, você não poderá adicionar um segundo componente equivalente. *** ## Configurar componentes Os componentes determinam as capturas, verificações e interações que fazem parte do processo. O template incorpora uma configuração inicial que você pode adaptar dentro dos limites permitidos. ### Consultar um componente
Cada componente exibe seu nome, estado e as ações disponíveis. De acordo com o componente, você pode encontrar: * **Editar** * **Desativar** * **Restaurar** As ações disponíveis dependem da configuração e das relações com outros componentes. ### Editar um componente Selecione **Editar** para abrir sua configuração. Modifique os parâmetros disponíveis e salve as alterações. Selecione **Cancelar** para fechar a edição sem aplicá-las. Alguns parâmetros podem ser exibidos como somente leitura porque seu valor é determinado pelo sistema. ### Desativar um componente Selecione **Desativar** quando quiser manter o componente dentro da configuração, mas evitar que ele participe da execução. Antes de desativá-lo, o sistema verifica se existem outros componentes que dependem dele. Se ele puder ser desativado, confirme a ação. O componente permanece visível na configuração como desativado. ### Dependências entre componentes Alguns componentes precisam que outros estejam ativos para funcionar corretamente. Por exemplo, uma validação pode precisar de uma captura anterior para ter as informações que deve analisar. Quando você tenta desativar um componente com dependências, o sistema informa os elementos afetados.
Dependendo da relação entre eles: * A ação pode ficar bloqueada. * Pode ser necessário desativar também outros componentes. * O sistema pode solicitar uma confirmação adicional. {% hint style="warning" %} Sempre revise os componentes afetados antes de confirmar uma desativação. A alteração pode modificar o Fluxo que o usuário experimentará. {% endhint %} ### Restaurar um componente Selecione **Restaurar** para reativar um componente desativado. O sistema verifica suas dependências antes de restaurá-lo. Quando outros componentes relacionados também estão desativados, pode ser necessário restaurá-los para recuperar corretamente a configuração. Conforme o caso, a interface pode permitir: * Restaurar apenas o componente selecionado. * Restaurar também os componentes necessários para concluir suas dependências. Revise as informações exibidas antes de confirmar. Depois de restaurá-lo, o componente volta a participar da execução do processo. ### Componentes obrigatórios Alguns componentes são necessários para que o template funcione corretamente. Quando um componente é obrigatório: * Não pode ser desativado, ou * A ação aparece bloqueada. A interface indica quando uma configuração é necessária para manter o Fluxo válido. *** ## Configurar challenges Os challenges permitem incorporar verificações adicionais ao processo.
Os disponíveis dependem de: * O tipo de processo. * O template. * O ambiente. * As funcionalidades habilitadas. ### Adicionar um challenge Selecione o challenge que deseja incorporar e preencha os parâmetros disponíveis. Cada challenge pode ter seus próprios: * Campos. * Valores iniciais. * Faixas. * Limites. * Dependências. ### Editar um challenge Selecione **Editar** para modificar seus parâmetros. O sistema valida se os novos valores são compatíveis antes de salvar. ### Desativar um challenge Quando essa ação estiver disponível, selecione **Desativar** para manter o challenge configurado sem executá-lo. O challenge permanece visível, mas deixa de participar do processo enquanto estiver desativado. ### Restaurar um challenge Selecione **Restaurar** para voltar a incorporá-lo à execução. O sistema recupera sua configuração e verifica as dependências necessárias. ### Ordem de execução Quando o processo contém vários challenges, a ordem deles determina a sequência em que podem ser executados. Se a interface permitir modificar essa ordem, organize os challenges de acordo com o comportamento esperado antes de publicar. *** ## Salvar um processo Você pode salvar a configuração enquanto trabalha nela sem precisar publicá-la. Selecione a ação de salvamento disponível. O processo permanece no estado **Rascunho** até ser publicado.
### Erros de validação Um processo pode ser salvo como rascunho mesmo que ainda precise de ajustes. No entanto, determinados erros impedem sua publicação. Antes de publicar, revise: * Campos obrigatórios. * Valores fora da faixa. * Componentes obrigatórios. * Dependências. * Configurações incompletas. {% hint style="info" %} Salvar e publicar são ações diferentes. Salvar preserva a configuração; publicar a torna disponível para novas execuções. {% endhint %} *** ## Clonar um processo Selecione **Clonar** quando quiser criar um novo processo a partir de uma configuração existente. O clone é criado como um processo independente do original. Use esta opção quando quiser reutilizar uma configuração como ponto de partida sem modificar o processo existente. Depois de cloná-lo: 1. Abra o novo processo. 2. Revise seus dados identificadores. 3. Verifique os componentes e parâmetros herdados. 4. Revise os challenges e dependências. 5. Faça as alterações necessárias. 6. Publique o novo processo quando estiver pronto. As alterações feitas no clone não afetam o processo original. {% hint style="info" %} Antes de publicar um processo clonado, revise toda a sua configuração. Uma configuração válida para um processo pode precisar de ajustes antes de ser reutilizada em outro contexto. {% endhint %} *** ## Publicar um processo Publicar faz com que uma versão do processo fique disponível para novas execuções. Selecione **Publicar** quando a configuração estiver completa.
### Validações antes de publicar Antes de permitir a publicação, o sistema verifica se o processo é válido. Pode verificar: * Campos obrigatórios. * Componentes necessários. * Dependências. * Valores configurados. * Challenges. * Outros requisitos do template. Se houver algum problema, corrija os elementos indicados antes de tentar novamente. ### Confirmar a publicação Selecione **Publicar** e revise a confirmação. Depois de publicar: * O processo muda para **Publicado**. * É criada uma versão imutável. * Essa versão fica disponível para novas execuções. * A configuração publicada não pode ser editada diretamente. *** ## Versões de um processo Cada publicação gera uma versão da configuração. As operações mantêm a referência à versão com a qual foram executadas. Isso permite que uma operação anterior continue representando exatamente a configuração usada naquele momento, mesmo que o processo mude posteriormente. ### Modificar um processo publicado Para modificar um processo publicado: 1. Retire-o de publicação, quando tiver permissão. 2. Faça as alterações necessárias. 3. Salve a configuração. 4. Valide o processo novamente. 5. Publique-o. A nova publicação gera uma nova versão. As operações anteriores continuam vinculadas às suas versões originais. {% hint style="info" %} O histórico e a comparação visual entre versões não fazem parte da funcionalidade atual. {% endhint %} *** ## Despublicar um processo Selecione **Despublicar** para impedir que o processo continue sendo usado para iniciar novas execuções.
Essa ação pode estar limitada a determinadas funções. Antes de confirmar, revise o impacto de retirar o processo de publicação. Depois de despublicá-lo: * Não é possível iniciar novas execuções com a versão retirada. * A configuração pode voltar a ser modificada quando suas permissões permitirem. * As operações já iniciadas ou registradas mantêm as informações da versão utilizada. Quando você publicar a configuração novamente, uma nova versão será gerada, quando aplicável. *** ## Arquivar um processo Selecione **Arquivar** quando quiser retirar um processo do uso habitual sem excluí-lo definitivamente. O sistema solicita confirmação antes de concluir a ação. Depois de arquivá-lo: * O processo deixa de aparecer entre os processos ativos. * Sua configuração é preservada. * As operações anteriores continuam vinculadas às suas versões. De acordo com suas permissões, você poderá recuperar posteriormente um processo arquivado. *** ## Excluir um processo A exclusão está disponível somente quando o estado e suas permissões permitem realizá-la. Selecione **Excluir** e revise o modal de confirmação. Depois de confirmar, o processo deixa de estar disponível para sua gestão habitual. As evidências e referências necessárias para manter a rastreabilidade de operações anteriores não são alteradas. {% hint style="info" %} Excluir um processo é uma ação irreversível pela interface. Use Arquivar quando precisar retirá-lo sem perder a possibilidade de recuperá-lo. {% endhint %} *** ## Detalhe de um processo O detalhe permite consultar a configuração de um processo e executar as ações disponíveis. Pode mostrar: * Nome. * Descrição. * ID do processo. * Tipo de processo. * Ambiente. * Template. * Status. * Versão. * Componentes. * Challenges. * Informações técnicas associadas. ### Copiar o ID do processo Selecione o ícone de cópia ao lado do ID do processo. Use esse identificador quando precisar referenciar o processo durante uma Integração ou uma consulta técnica. ### Ações disponíveis Dependendo do estado e das suas permissões, no detalhe você pode encontrar ações como: * Editar. * Clonar. * Publicar. * Despublicar. * Arquivar. * Excluir. * Demo. *** ## Testar um processo no modo demo O modo demo permite executar um processo publicado antes de utilizá-lo em uma Integração real.
A ação só está disponível quando: * Existe uma Versão Published. * O modo demo está habilitado. * Seu perfil dispõe das permissões necessárias. ### Abrir a demo Selecione a ação correspondente no processo. Será aberto um modal com: * Informações do processo. * Código QR. * Instruções para iniciar a demo. ### Demo Web Para executar um processo Web: 1. Abra a URL de demo indicada a partir de um dispositivo móvel. 2. Use a câmera para escanear o QR. 3. Conclua o processo. ### Demo Mobile Para um processo Mobile, use o aplicativo de demo correspondente e escaneie o QR quando indicado. ### Validade do QR O QR associado ao processo: * É persistente. * Pode ser reutilizado. * Não expira. * Não é consumido após uma execução. * Não é invalidado ao fechar o modal. * Não precisa ser regenerado. O mesmo QR executa a Versão **Publicado** que estiver ativa naquele momento. Se você publicar uma nova Versão, o QR utiliza essa nova Versão. ### O que acontece ao despublicar Quando o processo não tem uma Versão Published ativa, o QR deixa de iniciar novas demos. Não é necessário gerar outro código. Quando voltar a existir uma Versão Published, o mesmo QR poderá ser usado novamente. {% hint style="info" %} O QR identifica o processo, não uma execução específica. Por isso, pode ser usado várias vezes enquanto existir uma versão publicada. {% endhint %} *** ## Configurações adicionais De acordo com as funcionalidades contratadas e as permissões do seu perfil, Configurator pode incluir outras áreas de configuração. Essas superfícies podem gerenciar elementos que afetam mais de um processo. Consulte apenas as opções disponíveis no seu tenant e evite modificar configurações globais sem revisar previamente o impacto delas. *** ## Criar e publicar um processo Como referência, o Fluxo habitual para preparar um processo é: 1. Abra **Processos**. 2. Selecione **Criar processo**. 3. Escolha o tipo de processo. 4. Selecione o ambiente. 5. Escolha um modelo. 6. Preencha as informações necessárias. 7. Revise os Terms & Conditions. 8. Configure os componentes. 9. Verifique as dependências. 10. Configure os challenges. 11. Salve o processo. 12. Corrija qualquer erro de validação. 13. Selecione **Publicar**. 14. Confirme a publicação. 15. Verifique o processo por meio do modo demo. 16. Utilize o Process ID e as informações técnicas necessárias para realizar a Integração. Antes de publicar, revise o Fluxo completo e verifique se a configuração corresponde à experiência que você quer oferecer ao usuário.