Mudanças na API do BotFactory – dezembro/2020

Recentemente liberamos a versão 3 do Bot Factory, esta trouxe a nova interface e correções para a caixa de conversação. Sempre que realizamos a distribuição de novas versões é necessário que nossos clientes atualizem de forma manual o script injetado em suas páginas web. Buscando evitar esta situação, muitas vezes complexa dependendo da quantidade de páginas em que o bot é utilizado, realizamos mudanças na maneira que distribuímos versões e essas demandam a ação de alterar a URL utilizada pelo script, no caso de clientes que incorporam o bot em páginas web.

A alteração deve ser realizada até 01 de março de 2021.

Passos para atualizar

Existem duas maneiras de realizar a atualização:

  1. Via interface do Bot Factory
  2. Alteração manual do script

Via interface do Bot Factory

Acesse o Bot Factory pelo menu da Plataforma Senior X, localize o bot que se encontra incorporado em sua página web, gere um novo script e substitua em seu código.

Alteração manual

O código de incorporação gerado pelo Bot Factory contém a informação do local onde o arquivo deve ser baixado (js.src = …), localize e substitua o conteúdo dessa linha por:

https://cdn.tecnologia.senior.com.br/platform/botfactory/conversation/production/bundle.js

Abaixo, exemplo da linha a ser verificada (linha 8):

FAQ

Utilizo o Bot Factory via Plataforma Senior X (através da Sara), preciso realizar alguma ação?

Não! Realizamos a atualização de forma automática.

Utilizo o script gerado via interface do Bot Factory para incorporar o bot em meu site, preciso realizar alguma ação?

Sim! No seu caso será necessário gerar o script novamente e atualizar nas páginas em que o bot é utilizado ou realizar a modificação da URL de forma manual. (Descrito na seção: alteração manual)

Instalei via NPM, o que fazer?

A distribuição via NPMJS não sofreu alterações, dessa forma não haverá impacto após a data limite para migração. De qualquer forma orientamos a atualização para a versão mais recente do pacote, principalmente se estiver utilizando qualquer uma inferior a 3.0.0, assim você receberá as melhorias de interface liberadas recentemente.

Clientes que possuem bots do Bot Factory em suas páginas web deverão realizar a atualização do script de incorporação.

O que acontecerá caso eu não migrar?

Deixamos de realizar a publicação de novas versões na diretório atual, as mesmas passam a ser distribuídas apenas via cdn.tecnologia.senior.com.br.

Após 01 de março de 2021 realizaremos a remoção das versões contidas no host antigo. (cdn.senior.com.br)

Comecei a utilizar o Bot Factory agora e ainda não incorporei bots em páginas web, qual a situação?

Como não há bots incorporados em páginas web, nenhuma ação é necessária.

Não sei o que fazer, como obter auxílio?

Envie um e-mail para aplicativos-arquitetura@senior.com.br solicitando auxílio.

Passos adicionais

Buscando evitar problemas relacionados a bloqueio de firewall, a nova CDN ainda se encontra no domínio senior.com.br, porém como passo adicional recomendamos verificar as regras de acesso, garantindo que não existe bloqueio para o nosso domínio e subdomínios: *.senior.com.br

 

Ainda será possível utilizar versões fixas caso preferir, substitua o /production da URL pelo número da versão. Não recomendamos esta abordagem pois novas atualizações não serão entregues automaticamente, use por conta e risco!


TL;DR;

Implementamos mudanças significativas na maneira que distribuímos as atualizações do Bot Factory e estas podem exigir uma ação por parte de alguns clientes:

  • Quem deve atualizar? — apenas clientes que utilizam o script para incorporar bots nas páginas web.
  • O que mudou? — alteramos o endereço da CDN de https://cdn.senior.com.br/botfactory/conversation/{version}/bundle.js para https://cdn.tecnologia.senior.com.br/platform/botfactory/conversation/production/bundle.js

Utilizações via NPM não sofrerão impacto, mas orientamos a atualizar para a versão mais recente do pacote.


Novidades com a atualização

  • Melhoramos a documentação da API para utilização do botfactory-conversation (caixa de conversação), confira aqui;
  • Criamos a propriedade autoOpen para que a conversa seja iniciada automaticamente assim que o componente for injetado na página;
    • Os bots do Bot Factory abertos na Plataforma Senior X (via Sara) terão este comportamento.
  • Passamos a logar no console da DevTools a mensagem BotFactory conversation started com a versão atual do produto para facilitar suporte;
  • Melhoramos a exibição das imagens incorporadas em respostas do tipo imagem para que se adaptem às dimensões da caixa de conversa e cortes indesejados sejam evitados;
  • Padronizamos a cor das opções de respostas rápidas para conformidade com o novo layout;
  • Corrigimos o estilo visual do botão assumir conversa quando no modo monitor.

Dev frontend na equipe de Arquitetura, time de ECM, BPM, GED e chatbots, estudante de Ciência da Computação, nos tempos vagos jornalista, Youtuber e contribui com projetos open-source.

Leave A Comment