bsg коннектор для платформы creatio€¦ · Коннектор...

BSG коннектор для платформы

Creatio

Руководство пользователя

BSG,2018

2 BSG,2019

1 СОДЕРЖАНИЕ

2 Настройка ..................................................................................................................................... 3

3 Использование ............................................................................................................................. 7

3.1 Одиночная отправка смс ...................................................................................................... 7

3.2 Массовая отправка ............................................................................................................... 9

3.3 Проверка баланса ............................................................................................................... 12

3.4 Шаблоны СМС ..................................................................................................................... 13

3.5 Подстановки ....................................................................................................................... 18

3.6 Имя отправителя ................................................................................................................ 19

3.7 Использование в бизнес-процессах .................................................................................. 20

3.8 Использование коннектора в пользовательских сценариях ............................................. 24

4 Устранение проблем .................................................................................................................. 28

3 BSG,2019

2 НАСТРОЙКА

Сразу после успешной установки коннектора в систему, необходимо произвести начальную

настройку: ввести ключ API предоставляемый сервисом BSG и указать имя отправителя.

Для перехода к окну настроек коннектора, перейдите в режим «Дизайнер системы»:

И в разделе «Импорт и интеграции» выберите «Интеграция с BSG»

Будет открыто модальное окно для ввода настроек:

Если у вас еще нет ключа API – пройдите по ссылке «Получить ключ BSG» , после

авторизации появится страница с настройками ключей для API :

4 BSG,2019

Нажмите «Генерировать» и скопируйте полученный ключ вида:

live_1omLRXzXXXXXXXXXX либо

test_1omLRXzXXXXXXXXXX

Вставьте данный ключ в поле «Ключ API» :

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

В случае успешного подключения появится окно с сообщением:

5 BSG,2019

Также переход в окно настроек возможен из окна отправки СМС сообщения, при наличии

у текущего пользователя прав администратора:

Если аккаунт BSG был успешно подключен ранее – появится ссылка на его отключение:

6 BSG,2019

3 ИСПОЛЬЗОВАНИЕ

Коннектор реализует типовые варианты использования: одиночная отправка СМС, массовая

отправка, шаблоны СМС, подстановки значений.

Также доступна проверка баланса подключенной учетной записи BSG и подсчет количества

отправляемых СМС .

3.1 ОДИНОЧНАЯ ОТПРАВКА СМС

Основная форма отправки СМС с использованием коннектора находится в закладке «BSG»

на странице выбранного контакта:

Внешний вид формы отправки СМС сообщения для выбранного контакта:

7 BSG,2019

Управляющие элементы:

1. Выбранный контакт и телефон, на который будет отправлено СМС

2. Выпадающее меню с вариантами подстановок в сообщении

3. Текст сообщения

4. Сообщение валидации

5. Счетчик символов и примерная разбивка на количество сообщений

6. Выбор заготовленного СМС шаблона

7. Проверка баланса

8. Подключение/Отключение аккаунта

9. Кнопка отправки СМС

10. Перекодирование текста сообщения в транслит

После заполнения всех необходимых полей и нажатия кнопки «Отправить СМС», в случае

успешной отправки будет показано сообщение:

3.2 МАССОВАЯ ОТПРАВКА

8 BSG,2019

Данный коннектор поддерживает массовую отправку СМС для набора контактов. Для

использования, необходимо перейти в раздел «Контакты» и в меню «Действия» нажать «Выбрать

несколько записей» либо «Выбрать все» :

Далее после выбора нужных контактов необходимо в этом же меню «Действия» выбрать

пункт «Отправить СМС (BSG)»:

9 BSG,2019

Появится диалог для массовой отправки СМС для выбранных контактов:

10 BSG,2019

Управляющие элементы:

1. Количество выбранных контактов

2. Текст СМС сообщения, с поддержкой подстановок

3. Выбор заготовленного шаблона СМС

4. Счетчик символов с примерной разбивкой на СМС

5. Кнопка запуска массовой отправки

6. Перекодирование текста в транслит

7. Выбор подстановок для текста СМС сообщения

11 BSG,2019

3.3 ПРОВЕРКА БАЛАНСА

После подключения учетной записи BSG будет доступна опция проверки баланса. Для

просмотра баланса необходимо нажать кнопку «Баланс» в основной форме отправки СМС:

Баланс отобразится в валюте вашей учетной записи BSG:

12 BSG,2019

3.4 ШАБЛОНЫ СМС

В данном коннекторе также реализовано управление СМС шаблонами. Для перехода в

диалог управления шаблонами, нажмите на кнопку «Шаблоны» в основной либо массовой формах

отправки:

Основная форма управления шаблонами СМС:

13 BSG,2019

Управляющие элементы:

1. Выбрать указанный шаблон из списка и вернуться в форму отправки

2. Добавить новый шаблон

3. Поиск шаблона

При выборе шаблона из списка доступны стандартные действия справочника:

Также доступна настройка представления:

14 BSG,2019

Варианты фильтрации для поиска шаблона:

После нажатия кнопки «Добавить» появится форма добавления нового шаблона:

15 BSG,2019

Управляющие элементы:

1. Кнопка сохранения

2. Ввод названия шаблона

3. Ввод текста шаблона

В тексте шаблона также допускаются подстановки.

3.5 ПОДСТАНОВКИ

Коннектор поддерживает работу с подстановками в тексте отправляемых СМС сообщений.

Для их использования достаточно вставить в сообщение специальные теги, которые перед

отправкой будут заменены на данные контакта.

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

Тег Описание

#name# Полное имя контакта

#GivenName# Имя контакта

#MiddleName# Отчество

#Surname# Фамилия

#JobTitle# Должность

#BirthDate# Дата рождения

#MobilePhone# Номер мобильного телефона

#Phone# Рабочий телефон

#HomePhone# Домашний телефон

#Skype# Скайп

#Email# Адрес почты

#Address# Адрес

#Zip# Почтовый индекс

Все теги обрабатываются без учета регистра, поэтому сработает как #name# так и #Name#

или #NAME#.

16 BSG,2019

3.6 ИМЯ ОТПРАВИТЕЛЯ

Коннектор позволяет переопределять имя отправителя на уровне настройки контрагента.

Если для контрагента указан параметр «Имя отправителя (BSG)», то он будет использован вместо

стандартного для отправки СМС по всем контактам данного контрагента.

Для ввода данной настройки зайдите в форму контрагента:

17 BSG,2019

3.7 ИСПОЛЬЗОВАНИЕ В БИЗНЕС-ПРОЦЕССАХ

Коннектор позволяет использовать сервис BSG как шаг бизнес-процесса. Ниже пошаговая

инструкция для добавления такого шага в новый бизнес-процесс Creatio.

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

Нажмите «Добавить процесс»

Слева в списке «Действия пользователя» выберите «Отправить СМС (BSG)» и перетащите на схему

процесса:

18 BSG,2019

В панели настройки слева необходимо задать параметры шага.

Эти же параметры задаются при автоматическом запуске шага (например, из других шагов).

В качестве контакта задается уникальный идентификатор сущности «Контакт», в данном

случае будет подставлено значение идентификатора текущего пользователя.

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

19 BSG,2019

В случае успешного запуска – появится сообщение «Процесс успешно запущен»

3.8 ИСПОЛЬЗОВАНИЕ КОННЕКТОРА В ПОЛЬЗОВАТЕЛЬСКИХ СЦЕНАРИЯХ

Наш коннектор возможно использоваться из пользовательского сценария, ниже приведен

пример такого использования для автоматической массовой отправки СМС по выбранным

контактам.

1. Зайдите в раздел «Библиотека процессов» и создайте новый бизнес-процесс, добавьте

два шага «Чтение данных» и «Задание сценарий»:

20 BSG,2019

2. Выберите шаг «Чтение данных» и произведите настройку выборки согласно снимку ниже:

Коннектор расчитан на работу с типом коллекции «Контакт» и только с набором Id записей.

21 BSG,2019

3. Выберите шаг «Задание сценарий» и введите код примера:

var log = global::Common.Logging.LogManager.GetLogger("BSGConnector");

var userConnection = this.Get<UserConnection>("UserConnection");

log.Info("процесс массовой отправки запущен " );

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("параметр {0}",value));

}

log.Info(string.Format("количество записей {0}",listIds.Count));

var p = new Terrasoft.Configuration.BSGConnector.BSGUserTaskParameters(); p.ContactIds

= listIds;

p.SmsMessage = "тестовое сообщение массовой отправки для #name# !";

p.SenderName = "Санта-Клаус";

var smsTask = new Terrasoft.Configuration.BSGConnector.BSGUserTask(userConnection);

smsTask.SendSms(p);

} catch(Exception e) {

log.Info("ошибка в процессе: " +e.Message);

}

return true;

22 BSG,2019

Должно получиться как на снимке ниже:

Процесс должен записать отладочную информацию в стандартный журнал системы, эти

записи также будут видны через установленный модуль телеметрии ( см. ниже ):

23 BSG,2019

4 УСТРАНЕНИЕ ПРОБЛЕМ

Для детального анализа работы коннектора и определения причины сбоя можно

использовать расширенное логирование сообщений.

Название логгера: BSGConnector

Детальная настройка для локальной инсталляции Creatio описана в руководстве

https://academy.terrasoft.ru/documents/technic-sdk/7-13/logirovanie-v-creatio-log4net

Для облачной исталляции возможно использовать плагин «Telemetry log for bpm’online»

https://marketplace.creatio.com/app/telemetry-log-creatio который позволит в реальном

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

Техподдержка: support@bsg.world