BSG connector для 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–повідомленнях. Щоб використовувати їх, вам потрібно ввести спеціальне ключове слово в текст повідомлення, і воно буде автоматично замінено на актуальні контактні дані.

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

Всі теги нечутливі до регістру, тому всі вони будуть працювати: # 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