Perguntas Frequentes

Erro 403 ao tentar acessar alguma ferramenta do Serprobots

O que fazer?

Verifique se o acesso aos sistemas na rede do SERPRO está ok. No caso de estar atrás de uma VPN, certifique-se que a VPN esteja funcionando.

Alteração no fluxo ou nos componentes não foi salva (Gerenciador)

O usuário informa que realizou mudanças no fluxo do chatbot, especificamente na tela de componentes, mas que ao publicá-lo, essas mudanças não surtiram efeito;

Ou, o usuário informa que realizou mudanças no fluxo do chatbot, especificamente na tela de componentes, mas que ao navegar para editar outras informações e voltar para o fluxo, as alterações realizadas não foram salvas.

O que fazer?

Possivelmente o usuário não solicitou o salvamento das informações ao Serprobots. Os botões de confirmação e cancelamento ficam ao final da página e os usuários as vezes esquecem de salvar as informações digitadas em cada tela.

1. Solicite ao usuário para editar o chatbot que está ocorrendo o problema;

2. Navegue até a aba 2 – Componentes;

3. Faça as alterações que deseja realizar;

4. Desça a página até o final, até avistar os botões Confirmar (em azul) e Cancelar (em vermelho);

5. Clique no botão Confirmar para que as alterações sejam efetivadas.

Atualização de stack tecnológica (Gerenciador)

Ao entrar na página de edição de fluxos (Componentes), é exibida a mensagem Atenção! Há uma versão mais atual do stack tecnológico que corrige problemas.

O que fazer?

Periodicamente, são disponibilizadas novas versões de Stacks no Serprobots. Uma Stack é a engrenagem que permite o chatbot do usuário funcionar. Quando uma nova versão dessa engrenagem é lançada, o Serprobots avisa ao usuário que ele pode atualizar para esta nova versão, pois isto só trará benefícios para o seu chatbot.

1. Informe ao usuário que a atualização da Stack é altamente indicada, embora não seja obrigatória;

2. Caso o usuário esteja convencido de que deve atualiza-la, solicite que navegue até a página de edição de fluxos, a mesma onde a mensagem foi exibida pela primeira vez;

3. Peça ao usuário que clique no link Inicie a atualização. Uma janela irá explicar como será feita a atualização.

4. Quando se tratar de uma atualização compatível, o fluxo corrente será alterado para usar a nova versão. O usuário deve lembrar de clicar em Confirmar na página Componentes para salvar o fluxo alterado para a nova versão. Na próxima publicação do fluxo ele já estará usando a stack mais recente.

5. Quando se tratar de uma atualização não compatível, será informando ao usuário que será criado um novo fluxo cópia do atual porém usando a nova versão de stack. Peça ao usuário que clique em Prosseguir;

6. Solicite que o usuário informe um nome para este novo fluxo;

7. Em seguida, solicite ao usuário para descer a página até o final e que clique no botão Confirmar;

8. Informe-o de que este novo fluxo contém as MESMAS configurações do fluxo anterior;

9. Informe-o de que este novo fluxo precisa ser publicado para que ele perceba as mudanças na prática;

10. Para realizar uma nova publicação, solicite ao usuário que vá até a página Publicar;

11. Peça que sejam selecionados o fluxo e o ambiente no qual deseja publicar;

12. Solicite que o usuário clique no botão Prosseguir;

13. Logo em seguida, surgirá um botão em vermelho, escrito Publicar. Peça que o usuário clique neste botão;

14. Uma nova janela abrirá, solicitando a confirmação da publicação. Solicite que o usuário clique no botão Confirmar, em vermelho;

15. Informe ao usuário que agora o novo fluxo foi publicado e que basta aguardar o processo de publicação.

Webhook não funciona / sem conectividade

O usuário informa que criou um webhook na tela de Componentes mas que ao clicar no botão Testar conectividade, aparece a mensagem O endereço base na porta informada não foi alcançado. Solicite abertura da regra para a equipe **Serprobots**.

O que fazer?

No teste de conectividade, o Serprobots tenta acessar o endereço do Webhook para verificar se ele está alcançável a partir da infraestrutura da plataforma. A falha no teste pode indicar algum erro no cadastro do webhook ou ainda a falta de uma regra de rede que deve ser solicitada.

1. Solicite ao usuário para entrar na página de edição de fluxos;

2. Peça ao usuário para editar o webhook que está apresentando problemas;

3. Peça que verifique se os dados digitados no formulário estão corretos. Informe que qualquer dado digitado incorretamente neste formulário pode ocasionar este problema. Caso todos os dados estejam corretos, continue:

4. Pergunte se o endereço base do webhook, informado no formulário, é um endereço de um serviço hospedado dentro do SERPRO ou não;

5. Caso seja um endereço base que NÃO está hospedado no SERPRO, informe ao usuário que a opção Externo do formulário deve estar selecionada;

6. Solicite que o usuário realize o teste novamente. Caso o erro persista:

7. Pergunte ao usuário se ele já solicitou à equipe do Serprobots a liberação da regra de acesso a um serviço hospedado fora do SERPRO. Em caso de resposta negativa, informe que ele deve enviar uma mensagem para <> solicitando a liberação desta regra.

Componentes estão diferentes do esperado (Gerenciador)

O usuário informa que o fluxo do chatbot está diferente do que foi configurado, por exemplo:

• Ordem dos componentes diferente;
• Algum componente está faltando;
• A configuração de um componente está diferente da esperada;

O que fazer?

Primeiramente o usuário deve verificar junto à equipe se outra pessoa não realizou alterações que justifiquem a mudança.

No entanto, é importante lembrar que o Serprobots permite que existam múltiplos fluxos dentro de um chatbot, possivelmente o usuário pode estar editando um fluxo diferente daquele que realmente deseja.

1. Peça ao usuário para editar o chatbot que está com o problema informado;

2. Solicite que entre na tela de Componentes;

3. Peça ao usuário que verifique se o campo Nome do fluxo de componentes contém o nome do fluxo que ele realmente deseja editar;

4. Caso o campo contenha um nome diferente, solicite ao usuário para clicar na opção Trocar e selecione o fluxo que deseja editar;

5. Lembre ao usuário que ao realizar qualquer alteração no fluxo, sempre deve clicar no botão Confirmar.

Vale destacar ainda que alguns componentes podem ter configurações diferentes para Desenvolvimento e Produção, caso essa opção tenha sido ativada em algum momento.

Configuração do componente Watson Assistant não está funcionando (Gerenciador)

Ao tentar conversar com um chatbot que possui IBM Watson Assistant a resposta demora e em seguida ocorre erro (Ex: Tivemos problemas no nosso sistema ao tentar responder sua pergunta. Pode tentar de novo?), ou então a resposta do Watson Assistant nunca é oferecida.

O que fazer?

Ao utilizar o componente Watson Assistant para conectar o chatbot ao motor de inteligência artificial da IBM, é preciso informar uma série de informações sensíveis de conectividade. Qualquer valor errado leva a falha na conexão com o Watson durante a conversa. É preciso orientar o usuário sobre onde obter essas informações corretamente e a fazer o teste de conectividade no Serprobots. Além disso, mesmo que a conexão esteja correta, é preciso observar o nível de confiança configurado.

1. Na tela Componentes escolha o fluxo desejado e edite o componente do tipo Watson Assistant.

2. No campo watson.assistant.version informe: 2020-04-01 (valor padrão).

3. No campo watson.assistant.endpoint informe a URL de conexão com o serviço IBM Watson e no campo watson.assistant.apikey informe a API Key. Essas informações constam na tela de entrada do assistente na IBM Cloud na caixa Credentials. É importante usar o formato de URL enxuto que possui como caminho relativo apenas o trecho /instances/<ID_INSTANCIA> (Ex: https://api.us-south.assistant.watson.cloud.ibm.com/instances/1eda010c-3a3f-48eb-bc3c-f27256509223). Remova qualquer excesso da URL se necessário.

1. No campo watson.assistant.id informe o ID do assistente, que pode ser observado clicando no botão com três pontinhos no canto superior da tela interna do assistente e indo no menu Assistant Settings.

1. No campo watson.skill.id informe o ID do skill, que pode ser observado clicando no botão com três pontinho do canto superior da caixa específica daquele skill e indo no meu View API Details.

1. Após ter preenchido todas as informações de conectividade clique no botão amarelo Testar Conectividade no canto inferior direito da janela do componente Watson Assistant no Serprobots. É preciso revisar as configurações até que esse teste tenha êxito.

2. Uma vez ok, salve as informações do componente e salve as informações do fluxo. Publique o fluxo novamente para que a mudança de configuração seja contemplada. Aguarde a publicação encerrar e faça o teste conversando com o chatbot.

3. Se o teste de conectividade está OK mas ainda sim o chatbot parece não comunicar com o Watson Assistant, é preciso revisar o projeto do Watson Assistant. Uma dica é deixar a propriedade watson.minimumLevelConfidence no Serprobots com valor 0 (zero), desse modo serão aceitas todas as respostas vindas do Watson, ainda que tenham um nível de confiança muito baixo.

A interface do chatbot não carrega na página web

Inclui o trecho HTML informado pelo Serprobots no meu portal web mas o chatbot não está aparecendo lá.

O que fazer?

Para disponibilizar o chatbot em um portal web é preciso configurar corretamente o canal de configuração Web, publicar o chatbot e também incluir um trecho de HTML no código do seu portal para que o botão de acionamento (trigger) e/ou a janela de chat fique flutuando na parte inferior direita da tela. Algumas coisas podem impedir que isso funcione.

1. Primeiramente, verifique que o chatbot está de fato publicado e tente acessar o endereço web de teste dele. Isso pode ser feito indo na tela Acompanhar, clicando no ícone do canal Web e acionando o link lá informado e tentando abrir a janela e conversar com o chatbot efetivamente.

2. Se ele foi publicado e o teste do canal Web deu certo, é preciso agora verificar se o seu portal de incluiu o script corretamente no código fonte da página em que você esperava ver o chatbot. Peça para ver o código fonte da página através do navegador, analise-o e confirme que foi incluída a referência ao script do Serprobots para aquele chatbot. Ex:

   <script src="https://serprobots.estaleiro.serpro.gov.br/web/bot-meu-chatbot-p/trigger.js"></script>

3. Você pode clicar no endereço do script e ver se ele está alcançável e não houve nenhum erro de digitação nesse endereço.

4. Se o script foi incluído, é preciso conferir se o canal web não foi restringido para funcionar no domínio do seu portal. Na tela Canais de Comunicação no canal Web verifique o valor da propriedade Domínios Permitidos, ela é uma lista de endereços web que podem referenciar o script do chatbot bem como ser a origem de conversas. Inclua o endereço base do seu site nessa lista se ele não estiver por lá. Lembre-se de publicar o chatbot novamente se essa configuração for alterada.

5. Em último caso, vale tentar uma nova publicação do chatbot para que ele seja reconfigurado e refrescado.

Mudanças na configuração não estão sendo refletidas na publicação (Gerenciador)

O usuário alega que está definindo alguma configuração no fluxo correto, salvando corretamente, mas após publicar o chatbot a configuração não é aplicada.

O que fazer?

Se realmente a configuração não foi feita em outro fluxo, uma das hipóteses é que o componente pode ter configurações específicas por ambientes. Alguns componentes precisam de valores diferentes entre Desenvolvimento e Produção, e se essa opção for acionada pode gerar confusão.

1. Vá na tela de Acompanhar no gerenciador do Serprobots e verifique o nome do fluxo que foi publicado. Confira na tabela de publicações se o fluxo recém publicado é mesmo o fluxo alvo das alterações. Se o chatbot tiver muitos fluxos sem uso, uma sugestão é excluí-los para evitar esse tipo de confusão.

2. Ainda na tela Acompanhar clique no botão Detalhes na linha da publicação mais recente. Uma janela irá mostrar todos os valores das configurações que foram contempladas naquela publicação. Analise se a configuração alvo do problema está de fato com o valor esperado.

3. Revise também na tela de componentes, no fluxo em questão, se o componente configurado não teve a opção Usar configurações diferentes em Produção acionada. Nesse caso, a janela de configuração do componente vai ter duas abas, uma com o conjunto de configuração de Desenvolvimento e outra com o mesmo conjunto de configurações para a Produção. Isso é útil quando algum componente precisa funcionar diferente nesses dois ambientes (Ex: conectar em projetos diferentes de Watson Assistant), mas pode gerar confusão se for acionado indevidamente. Lembre-se de salvar as mudanças no componente e salvar o fluxo novamente, publicando o chatbot para verificar a mudança.

4. Se a configuração não refletida for de algum canal de comunicação, verifique também se não foi acionada a opção Usar configurações diferentes em Produção o que também vai levar à presença de duas abas de configurações, uma para cada ambiente, e logo, pode gerar confusão ao alterar um ambiente e publicar outro. Lembre-se de salvar as mudanças e publicar o chatbot novamente para verificar a mudança.

5. Mudanças visuais na janela do webchat podem demandar alguns refrescos forçados no navegador (CTRL+F5 ou CTRL+SHIFT+R em alguns navegadores) para que o cache seja limpo. Uma opção é tentar abrir o webchat numa aba anônima para confirmar essa questão.

Como faço para configurar o Whatsapp?

Usuário não sabe como conectar seu chatbot no Whatsapp, ou usuário não sabe onde obter as informações solicitadas para configuração do canal Whatsapp.

O que fazer?

Para conectar um chatbot do Serprobots em um número de telefone do Whatsapp, primeiramente é preciso que seja configurada uma instância da Whatsapp Business API para aquele número. O SERPRO é um Whatsapp Business Solution Provider, autorizado pela Meta a oferecer essa integração, seja para uso no Serprobots ou não. Esse processo é gerenciado por uma área específica na empresa.

1. Procure a área de negócio responsável pelo seu projeto e solicite a criação de uma Whatsapp Business API para o número de telefone desejado para futura integração com o Serprobots.

2. Como a Meta tem um processo rigoroso de aceite dos projetos que usem a integração com Whatsapp, é provável que sejam necessárias algumas reuniões para que o SERPRO possa entender a necessidade e solicite o cadastro e a validação do número de telefone a ser usado.

3. Ao final do processo, a equipe do projeto deverá receber um email contendo as informações de conectividade do Serprobots com aquele número.

Publicação não finaliza (Gerenciador)

Após públicar um chatbot, a tela acompanhamento fica aguardando o fim da publicação mas ela nunca ocorre.

O que fazer?

Após publicar o chatbot, o gerenciador do Serprobots irá monitorar se aquela publicação já está no ar com os recursos disponíveis para acesso. Geralmente não leva mais que 1 minuto até a publicação obter sucesso. Em alguns casos esporádicos pode gastar até 10 minutos, mas nunca mais que isso.

1. Em alguns casos a percepção do fim da publicação bem sucedido pode estar sendo impedido simplesmente por questões como falta de internet momentânea ou sessão expirada no Serprobots. Para tirar essa dúivida, refresque a tela do Serprobots no seu navegador para que ele volte a carregar a tela de acompanhamento novamente.

2. Se a publicação não foi finalizada e já se passaram mais de 15 minutos desde o horário de sua realização, será preciso que a equipe Serprobots investigue a causa do problema.

Sessão autenticada – perdeu/esqueceu token

O usuário informa que esqueceu ou perdeu o Token da Sessão Autenticada e que precisa utilizá-lo mas não sabe onde obter este token.

O que fazer?

1. Informe ao usuário que caso ele não tenha mais o token, será necessário criar um novo, pois o Serprobots não fornece, de nenhuma forma, o token anterior por questões de segurança;

2. Peça ao usuário que edite o chatbot do qual ele precisa do novo token;

3. Peça que entre na tela de Sessão Autenticada;

4. Nesta tela, peça que o usuário clique no botão Criar para o ambiente do qual ele quer criar um novo token;

5. Peça que o usuário copie o token imediatamente e guarde-o em um local seguro, pois o token que está aparecendo na tela sumirá em 1 minuto e ele não terá como tê-lo novamente;

6. Informe que caso não precise mais do token, ele também pode revogá-lo clicando no botão Revogar.

Chatbot está acessível mas não responde

Ao conversar com o chatbot não são obtidas respostas, ou no caso do canal webchat, volta uma mensagem de erro.

O que fazer?

Possivelmente o serviço por trás do chatbot que responde as mensagens pode não estar mais disponível ou estar com falha após uma publicação que não foi bem sucedida.

1. Verifique na tela Acompanhar do gerenciador do Serprobots se há de fato uma publicação ativa para aquele ambiente. Alguém da equipe pode ter desativado, ou uma nova publicação pode ter ocorrido e é preciso aguardar ela ser finalizada. Caso seja uma publicação com problemas que não finaliza, verificar o script de atendimento desse caso específico.

2. Se houver uma publicação ativa, revise a configuração e a ordem dos componentes do fluxo publicado e veja se faz sentido. Se nenhum componente for capaz de responder uma pergunta, oe feito final é de fato o chatbot não responder nada.

3. Se estiver usando componente Watson Assistant, certifique de usar um nível de confiança baixo o suficiente para aceitar as respostas.

4. Se tudo estiver ok, e ainda sim o chatbot não responde, será preciso acionar a equipe Serprobots para investigar questões de infraestrutura relativas ao chatbot.

Não visualizo nenhum chatbot na página inicial (Gerenciador ou Curadoria)

O usuário informa que não visualiza nenhum chatbot na tela inicial da interface de curadoria ou da interface do gerenciador.

O que fazer?

O usuário não faz parte de nenhuma equipe de nenhum chatbot no Serprobots.

1. O usuário deve encontrar algum outro usuário que participa do chatbot desejado e descobrir quem são os administradores (papel de Manager) daquele projeto no Serprobots.

2. Usuário deve solicitar a algum Manager que ele seja adicionado à equipe do Chatbot.

Talvez o projeto ainda não tenha sido criado. Na interface do Gerenciador o próprio usuário pode criar o projeto. Na interface de Curadoria, deve-se entrar em contato com a equipe responsável no SERPRO para que o projeto seja criado.

Fluxo visualizado na Curadoria é diferente do fluxo configurado no Gerenciador

O usuário informa que o fluxo do chatbot está diferente do que foi configurado no Gerenciador, por exemplo:

• Ordem dos componentes diferentes;
• Presença ou ausência de um componente;
• Configuração de um componente diferente.

O que fazer?

É possível que o chatbot tenha mais de um fluxo. O fluxo cuja as configurações foram alteradas no Gerenciador, pode não ser o fluxo selecionado por padrão na Curadoria.

O usuário deve :

1. Clicar no botão "engrenagem" localizado na parte "superior direita" da interface logo depois do nome do Fluxo em Edição

2. Selecionar o fluxo que deseja realizar a Curadoria.

O chatbot publicado não responde conforme a configuração realizada no fluxo (Curadoria)

O usuário informa que ao clicar no botão experimente o chatbot (posição superior esquerda) na interface de Curadoria, o chatbot publicado não responde conforme a configuração realizada no fluxo , por exemplo:

A mensagem inicial do chatbot é diferente do que foi configurador no componente Onboarding.

O que fazer?

Uma possibilidade é que o usuário realizou alterações na configuração do fluxo e ainda não publicou esse fluxo alterado. Ou então o usuário está usando o chatbot publicado em produção, ao passo que o experimente publica as alterações em desenvolvimento.

O usuário deve :

1. Clicar no botão Publicar e confirmar a publicação na caixa de diálogo

2. Aguardar a publicação do fluxo

3. Clicar novamente no Botão experimente o chatbot

4. Testar o chatbot novamente

5. Estar ciente que o chatbot testado está no ambiente de Desenvolvimento, uma vez que a Curadoria só permite publicar o fluxo no ambiente de Desenvolvimento.

Não consigo publicar o chatbot no ambiente de produção pela interface de Curadoria

O usuário informa que não consegue publicar o chatbot no ambiente de produção pela interface de Curadoria.

O que fazer?

Por questões de segurança, a interface de Curadoria só permite ao curador publicar um fluxo no ambiente de Desenvolvimento.

O usuário deve :

1. Se tiver perfil para isso, acessar o Gerenciador, ou solicitar alguém com acesso ao Gerenciador que o acesse e navegar até o chatbot em questão.

2. Deve ser acessada a guia "Publicar"

3. Deve ser selecionado o fluxo cuja curadoria foi realizada

4. Deve ser selecionado o Ambiente "Produção"

5. Clicar em "Prosseguir" e depois em "Publicar"

Não sei como acessar Dashboard de Acompanhamento

O usuário informa que não sabe como acessar o Dashboard de Acompanhamento (Kibana) para acompanhar as conversas e consultar métricas como quantidade de conversas e mensagens em diferentes janelas do tempo.

O que fazer?

1. O link e a credencial para acessar o Dashboard de Acompanhamento está na interface do Gerenciador na página de acompanhamento de publicações, acessível através da opção "Publicações" do menu lateral, ou no passo 5 - Acompanhar da edição de um chatbot.

2. Na documentação o usuário encontrará outras informações sobre esse dashboard e seu acesso.

Usuário e senha não permitem acessar o Dashboard de Acompanhamento

O usuário informa que não consegue acessar o Dashboard de Acompanhamento, utilizando o usuário e senha inicial disponíveis na seção "Dashboard" da tela Acompanhar da interface do Gerenciador.

O que fazer?

Possivelmente o procedimento automatizado do Serprobots de geração das credenciais de acesso teve com problemas.

Nesse caso é preciso pedir suporte à equipe Serprobots.

Os dados do Dashboard de Acompanhamento não estão de acordo com o esperado

O usuário informa que dados dos dashboard não estão de acordo com o esperado. Por exemplo:

• A quantidade de mensagens esperadas não está condizente com o esperado;
• Não estão sendo encontradas na seção "Detalhe da Conversa" as mensagens que acabaram de ser trocadas com o chatbot;
• As informações apresentadas no geral não parecem ser do chatbot.

O que fazer?

1. Primeiramente é preciso certificar que o usuário está visualizando o Dashboard do chatbot desejado. Aconselha-se a realizar o logout do Kibana e a logar novamente, utilizando o link e as credenciais disponíveis na tela Acompanhar da interface do Gerenciador.

2. Uma vez verificado que o acesso está correto, é preciso ainda certificar que está sendo consultado o dashboard do respectivo ambiente (Desenvolvimento ou Produção), pois é comum interagir com o bot em um ambiente mas estar consultando o dashboard de outro.

3. Certifique-se ainda de que o período no tempo consultado envolve o horário da conversa. No canto superior direito do Kibana é possível definir o intervalo de datas. Lembre-se de atualizar a consulta após definir o novo intervalo. Se estiver buscando conversas que acabaram de acontecer, é prudente esperar alguns segundos e refrescar até que elas constem nos detalhes e entrem para as estatísticas do dashboard.