For the best experience turn off the battery saving mode.

Назад

Разъем BSG для Creatio (ранее BPM.Online)

Установка

Установка может быть произведена либо из Creatio (BPM) Marketplace, либо из архивного файла, поскольку установка из Marketplace может быть завершена одним щелчком мыши — это не рассматривается в данном руководстве.

Ручная установка

Архив с коннектором BSG можно скачать с сайта Creatio (BPM) Online install

Чтобы установить BSG Connector из архива, перейдите в раздел «Установленное приложение» в «Дизайнере системы» и выберите «Установить из файла» из раскрывающегося списка:

На следующем экране выберите файл архива и загрузите его:

Процесс установки начнется автоматически, в случае возникновения ошибок — ведите журнал установки и отправляйте в нашу службу поддержки.: support@bsg.world

Конфигурация

Перед использованием BSG Connector необходимо настроить: укажите ключ API и имя отправителя по умолчанию.

Чтобы перейти на страницу конфигурации BSG Connector, перейдите в «System Designer».:

Затем в разделе «Импорт и интеграция» нажмите ссылку «Настройки коннектора BSG»:

Модальный диалог с настройками BSG Connector:

Если у вас нет ключа API для службы BSG — нажмите ссылку «Получить ключ BSG» и авторизуйтесь в панели BSG:

Press ‘Generate’ button and copy received API key:

live_1omLRXzXXXXXXXXXX – for production

or

test_1omLRXzXXXXXXXXXX – for testing

Введите полученный ключ в поле ввода «API Key»:

и нажмите кнопку «Сохранить».

В случае успеха вы увидите окно подтверждения:

Также есть прямая ссылка на страницу конфигурации коннектора прямо из главной формы, но только если текущий пользователь является администратором:

Если коннектор был настроен ранее — вместо него будет ссылка для отключения от службы BSG:

Применение

Наш соединитель BSG разработан для обычных случаев использования и имеет следующие ключевые особенности:

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

Если вашему бизнесу требуются более специфические функции или вам нужна расширенная настройка — не стесняйтесь обращаться в нашу службу поддержки support@bsg.world

Доставка одного СМС

Основная форма для отправки SMS находится на вкладке «BSG», в верхнем разделе выбранной страницы контактов:

Подробнее об основной форме:

Элементы управления:

  • 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

При успешной доставке вы увидите окно с уведомлением:

Массовая рассылка SMS

Наш соединитель BSG позволяет массовую доставку SMS-сообщений нескольким выбранным контактам (или всем). Для этого вам нужно перейти в раздел «Контакты» и в меню «Действия» выбрать «Выбрать несколько записей» или «Выбрать все».:

Далее, после завершения выбора необходимых контактов, вам нужно будет выбрать опцию «Отправить SMS (BSG)»:

Появится модальный диалог с деталями для массовой рассылки SMS:

Элементы управления:

  • 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)

Проверить баланс

Эта опция будет доступна только после успешной привязки к учетной записи BSG. Чтобы увидеть свой баланс в BSG, нажмите ссылку «Баланс» в основной форме коннектора:

Появится модальное окно с деталями баланса:

Шаблоны SMS-сообщений

Наш коннектор позволяет создавать, использовать и управлять шаблонами SMS-сообщений. Чтобы использовать эту функцию, нажмите ссылку «Шаблон» в основной форме коннектора (или в форме массовой доставки):

Главный экран для шаблонов SMS-сообщений:

Элементы управления:

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

При выборе шаблона разрешены стандартные действия со словарем:

И управление по умолчанию для текущего вида:

Параметры фильтра для поиска по шаблону:

Для создания нового шаблона нажмите кнопку «Новый», появится модальное окно:

Элементы управления:

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

SMS-сообщение также позволяет вводить теги.

Теги шаблона

Наш коннектор поддерживает теги в SMS-сообщениях. Чтобы использовать их, вам нужно ввести специальное ключевое слово в текст сообщения, и оно будет автоматически заменено на актуальные контактные данные.

Ниже приведен список поддерживаемых тегов:

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

Все теги нечувствительны к регистру, поэтому все они будут работать: # name #, # NAME #, # Name #

Заменить имя отправителя

Наш соединитель позволяет переопределить имя отправителя по умолчанию для значения, указанного в связанной учетной записи.

Существует специальное поле «Имя отправителя (BSG)», которое наш коннектор добавляет при установке в сущность «Учетная запись». Если это поле заполнено — значение будет использоваться для всех контактов, связанных с этой сущностью «Учетная запись».

Чтобы использовать эту функцию, перейдите на страницу учетной записи:

Заполните поле «Имя отправителя (BSG)», затем нажмите кнопку «Сохранить».

Использование в процессе Creatio (ранее BPM)

Наш коннектор позволяет использовать доставку услуги BSG как шаг в процессе Creatio. Ниже приведен пошаговый пример того, как добавить такой шаг в новый процесс Creatio.

Перейдите в «Библиотеку процессов»:

Нажмите кнопку «Новый процесс»:

В списке слева (под названием «Действия пользователя») выберите опцию «Отправить SMS» и перетащите ее на диаграмму BPM:

Линия от начала процесса должна быть соединена с нашим шагом, так же, как линия от нашего шага до точки «конец процесса».

Теперь вам нужно будет заполнить параметры шага из (справа):

Эти параметры обычно заполняются из предыдущих шагов процесса Creatio, поэтому шаг доставки берет их из среды текущего процесса.

Чтобы проверить, правильно ли мы создали процесс, нажмите кнопку «Выполнить»:

Использование коннектора из скриптов Creatio BPM

Наш коннектор позволяет использовать так называемую «задачу сценария» — специальный шаг в потоке процесса Creatio с настраиваемым скриптом внутри.

Ниже приведен пошаговый пример того, как использовать это для массовой рассылки SMS.

  1. Перейдите в раздел «Библиотека процессов» и создайте новый процесс BPM, добавьте шаги «Чтение данных» и «Задача сценария», как на экране ниже.:
  2. Нажмите на шаг «Прочитать данные» и настройте параметры, как на экране ниже.:

    Коннектор ожидает получение идентификаторов от контакта только сущность, поэтому все другие выбранные поля использоваться не будут.
  3. Нажмите на шаг «Задача сценария» и вставьте приведенный ниже код:
    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;

Должно выглядеть как на экране ниже:

Этот тестовый процесс будет записывать записи журнала в файл журнала по умолчанию (Common.log), также эти записи можно просмотреть во время выполнения с помощью «Расширения телеметрии» (см. Ниже):

Исправление проблем

Наш коннектор поддерживает несколько уровней ведения журнала, поэтому для исследования источника проблемы вы можете настроить уровень журнала коннектора, чтобы увидеть более подробную информацию о его внутренней работе.

Имя регистратора: BSGConnector

Подробное руководство по настройке ведения журнала в автономном экземпляре Creatio Online можно найти в документации Creatio (ранее BPM Online).

Для облачных экземпляров вы можете попробовать это расширение «Журнал телеметрии для Creatio»:

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

что позволит наблюдать логи коннектора в реальном времени:

По всем вопросам, связанным с разъемом, обращайтесь в нашу техподдержку.: support@bsg.world