Para obter a melhor experiência, desligue o modo de economia de bateria.

Back

Conexão BSG para Creatio (anteriormente BPM.Online)

Instalação

A instalação pode ser feita através do Creatio (BPM) Marketplace ou através de um arquivo, já que a instalação do Marketplace pode ser concluída com um clique – isso não é abordado neste manual.

Instalação manual

O arquivo com o BSG-Connector pode ser baixado da instalação online do Creatio (BPM)

Para instalar o Conector BSG a partir do arquivo, vá para a seção “Aplicativo instalado” no “Designer de sistema” e selecione “Instalar a partir do arquivo” em uma lista suspensa:

Na próxima tela, selecione o arquivo e faça o upload:

O processo de instalação é iniciado automaticamente se ocorrerem erros. Por favor, mantenha o log de instalação e encaminhe-o para nosso suporte:support@bsg.world

Construção

Você deve configurar o conector BSG antes de usá-lo: Insira a chave API e o nome do remetente padrão.

Para acessar a página de configuração do conector BSG, vá para “Designer de Sistema”.:

Em seguida, clique no link “Configurações do Conector BSG” na seção “Importação e Integração”:

A caixa de diálogo modal com as configurações do conector BSG:

Se você não tem uma chave API para o serviço BSG, clique no link Obter chave BSG e autentique na área BSG:

Clique no botão “Gerar” e copie a chave API recebida:

live_1omLRXzXXXXXXXXXX – para produção

ou

test_1omLRXzXXXXXXXXXX – para teste

Digite a chave recebida no campo de entrada “chave API”:

e clique em “Salvar”.

Se for bem-sucedido, a janela de confirmação aparecerá:

Há também o link direto para a página de configuração do conector direto do formulário principal, mas apenas se o usuário atual for administrador:

Se o conector foi configurado anteriormente, um link para desconectar o serviço BSG será exibido em seu lugar:

Uso

Nosso Conector BSG foi desenvolvido para casos de uso gerais e tem funções importantes:

  • single SMS delivery,
  • mass delivery,
  • message templates,
  • template tags
  • balance check
  • count SMS messages

Se sua empresa precisa de recursos mais específicos ou requer personalização avançada, entre em contato com nossa equipe de suporte support@bsg.world

Entrega de SMS única

O formulário principal de envio de SMS está localizado na guia “BSG” no topo da página do contato selecionado:

Formulário principal em detalhe:

Controles:

  • Selected contact and the phone that SMS message will be send to
  • Dropdown with allowed tags
  • Message text
  • Validation messages
  • Symbol counter with split for actual SMS messages
  • Select pre-defined message template
  • Check balance in BSG Service (if connected)
  • Link/Unlink BSG Account from connector
  • Send SMS action button
  • Encode message into translit

Se a entrega for bem-sucedida, uma janela de notificação aparecerá:

Entrega de SMS em massa

Nossa conexão BSG permite a entrega em massa de mensagens SMS para vários contatos selecionados (ou para todos). Para fazer isso, você precisa ir para a seção “Contatos” e selecionar “Selecionar vários registros” ou “Selecionar tudo” no menu Ações:

Depois de selecionar os contatos necessários, você precisa selecionar a opção “Enviar SMS (BSG)”:

Haverá um diálogo modal com detalhes para entrega de SMS em massa:

Controles:

  • Number of selected contacts
  • SMS message text, supports tags input
  • Selection of pre-defined message template
  • Symbol counter with split for actual SMS messages
  • Action button to start mass delivery
  • Encode message to latin
  • Select tags for SMS message substitutions (see below)

Verifique o saldo da sua conta

Esta opção só está disponível após vincular com sucesso à conta BSG. Para visualizar seu saldo de crédito no BSG, clique no link “Crédito” no formulário de conexão principal:

Haverá uma janela modal com detalhes do saldo:

Modelos de mensagem SMS

Nosso conector permite criar, usar e gerenciar modelos de mensagens SMS. Para usar esta função, clique no link “Modelo” no formulário de conexão principal (ou no formulário de entrega em massa):

Tela principal para modelos de mensagem SMS:

Controles:

  • Select current template from list and back to delivery form
  • Add new template
  • Template search

As ações gerais do dicionário são permitidas na seleção do modelo:

E controle padrão da visualização atual:

Opções de filtro para a pesquisa de modelo:

Para criar o novo modelo, clique no botão “Novo”. Uma janela modal é exibida:

Controles::

  • Action button to Save template
  • Template name
  • SMS message text

A mensagem SMS também permite inserir tags.

Tags de modelo

Nosso conector oferece suporte a tags em mensagens SMS. Para usá-los, você precisa incluir uma palavra-chave especial no corpo da mensagem. Ele é automaticamente substituído pelas informações de contato reais.

Abaixo está uma lista de tags suportadas:

Tag Description
#name# Full name of a contact
#GivenName# First name
#MiddleName# Middle name
#Surname# Surname
#JobTitle# Job Title
#BirthDate# Date of birth
#MobilePhone# Mobile phone
#Phone# Work phone
#HomePhone# Home phone
#Skype# Skype
#Email# Email
#Address# Address
#Zip# Zip

Todas as tags não diferenciam maiúsculas de minúsculas, então todas funcionam: # nome #, # NOME #, # nome #

Substitua o nome do remetente

Nosso conector permite que o nome do remetente padrão seja substituído por um valor que é especificado na conta associada.

Se este campo for preenchido, haverá um campo específico “Nome do remetente (BSG)” que nosso conector adiciona à entidade de conta durante a instalação. O valor é usado para todos os contatos associados a esta entidade de conta.

Para usar este recurso, vá para a página da conta:

Preencha o campo “Nome do Remetente (BSG)” e clique em “Salvar”.

Use no processo de criação (anteriormente BPM)

Nosso conector permite que a entrega do serviço BSG seja usada como uma etapa no processo de criação. Abaixo está um guia passo a passo sobre como adicionar tal etapa ao novo processo de criação.

Vá para “Biblioteca de processos”:

Pressione o botão ‘Novo processo’:

Na lista à esquerda (intitulada ‘Ações do usuário’) selecione a opção ‘Enviar SMS’ e arraste-a para o diagrama BPM:

A linha do início do processo deve estar conectada à nossa etapa, assim como a linha da nossa etapa ao final do processo.

Agora você deve inserir os parâmetros da etapa (à direita):

Esses parâmetros são geralmente preenchidos a partir de etapas anteriores no processo de Creatio, portanto, a etapa de provisionamento os tira do ambiente do processo atual.

Para verificar se o processo foi criado corretamente, clique no botão Executar:

Usando o conector de scripts Creatio BPM

Nosso conector permite o uso por meio da chamada “tarefa de script” – a etapa especial no fluxo do processo Creatio com um script definido pelo usuário.

Abaixo estão as instruções passo a passo sobre como usá-los para entrega de SMS em massa.

  1. Navegue até a seção Biblioteca de Processos e crie um novo processo BPM. Adicione as etapas “Ler dados” e “Tarefa de script” conforme mostrado abaixo:
  2. Clique na etapa “Ler dados” e configure os parâmetros conforme mostrado na tela abaixo:

    O conector espera que os IDs sejam coletados apenas da entidade de contato, portanto, quaisquer outros campos recuperados não são usados.
    Clique na etapa Script Task e cole o seguinte código
    :

    var log = global::Common.Logging.LogManager.GetLogger("BSGConnector");
    var userConnection = this.Get<UserConnection>("UserConnection");
    log.Info("test process has been started " );
    try {
    var colSource = Get<ICompositeObjectList<ICompositeObject>>("ReadDataUserTask1.ResultCompositeObjectList");
    var listIds = new List<Guid>();
    foreach (var parameter in colSource)
    {
    Guid value;
    parameter.TryGetValue("Id",out value);
    listIds.Add(value);
    log.Info(string.Format("parameter {0}",value));
    }
    log.Info(string.Format("total number of records: {0}",listIds.Count));
    var p = new Terrasoft.Configuration.BSGConnector.BSGUserTaskParameters();
    p.ContactIds = listIds;
    p.SmsMessage = "test message for mass delivery check, for #name# !";
    p.SenderName = "Santa-Claus";
    var smsTask = new Terrasoft.Configuration.BSGConnector.BSGUserTask(userConnection);
    smsTask.SendSms(p);
    } catch(Exception e) {
    log.Info("process error: " +e.Message);
    }
    return true;

Deve ser assim:

Durante este processo de teste, os registros de log são gravados no arquivo de log padrão (Common.log). Esses registros de dados também podem ser exibidos em tempo de execução com a extensão “Telemetria” (veja abaixo):

Solução de problemas

Nosso conector oferece suporte a vários níveis de registro. Para investigar a causa do problema, você pode ajustar o nível de log do conector para ver mais detalhes sobre seu funcionamento interno.

Nome do registrador: BSGConnector

Você pode encontrar instruções detalhadas sobre como configurar o registro na instância externa do Creatio Online na documentação do Creatio (anteriormente BPM Online).

Para instâncias de nuvem, você pode tentar esta extensão «Protocolo de telemetria para Creatio»:

https://marketplace.creatio.com/app/telemetry-log-creatio

Isso permite que os registros do conector sejam monitorados em tempo real:

Se você tiver alguma dúvida sobre o conector, entre em contato com nosso suporte técnico: support@bsg.world