Рассылка отчётов с аналитического портала через шаги сценария - Публичная база знаний Modus
Показать оглавление
Общая информация
Рассылка отчетов — это функциональная возможность, позволяющая автоматически получать отчеты с Аналитического портала (Modus BI), сохранять их в PDF, отправлять в Telegram и на электронную почту. Рассылка выполняется с помощью настроенного шаблона шага сценария на языке 1С. Шаг может быть встроен в любое место сценария — в начало, в середину или после конкретного шага. Это позволяет, например, отправлять уведомление после обновления витрины данных.
Поддерживаемые каналы рассылки:
- Telegram (отправка файла в чат через бота);
- Email (отправка письма со вложением по списку рассылки).

Предварительная настройка
Перед созданием шаблона шага сценария необходимо настроить несколько объектов в Modus ETL.
Справочник «Аналитические порталы»
Примечание.
- Настройка справочника «Аналитические порталы» выполняется администратором Modus ETL через «Функции технического специалиста».
- Пользователям без прав администратора через строку поиска доступны только уже настроенные порталы — для выбора в списке.
Перейдите в справочник «Аналитические порталы» или воспользуйтесь строкой поиска.

Рабочий процесс:
- В диалоговом окне справочника «Аналитические порталы» нажмите кнопку «Создать».

- В диалоговом окне «Аналитический портал (создание)» заполните:
- «Наименование:» — название портала;
- «Адрес:» — адрес портала, по умолчанию
https://demo.modusbi.ru/; - «Путь к API:» — адрес программного интерфейса портала для обращения к данным, по умолчанию
/v1/api; - «Имя пользователя:» — логин для подключения;
- «Пароль:» — пароль логина.

- После заполнения нажмите кнопку «Проверить подключение», чтобы убедиться в корректности настроек.
Примечание. Наименование портала в дальнейшем указывается в параметрах шага в поле «НаименованиеПортала» и должно точно совпадать, так как поиск выполняется по значению из поля «Наименование».
Справочник «Списки рассылок»
Перейдите «Главное/ Настройки/ Списки рассылок» или воспользуйтесь строкой поиска.

Рабочий процесс:
- В диалоговом окне справочника «Списки рассылок» нажмите кнопку «Создать».

- В диалоговом окне «Список рассылок (создание)» заполните:
- «Наименование:» — название списка (например, «Отправка отчётов АП на почту»);
- «Электронная почта:» — адреса получателей. При необходимости добавить еще адреса для рассылки нажмите кнопку «@ Электронная подпись»;
- Корректность настроек можно проверить нажав иконку «Конверт» (Написать письмо на указанный адрес);
- Поле «Примечание» заполните при необходимости.
- После заполнения нажмите кнопку «Записать и закрыть».

Создание новой учетной записи электронной почты (для отправки на Email)
Перейдите «Администрирование/ Органайзер/ Настройка почты» или воспользуйтесь строкой поиска.
Примечание. Настройка почтового сервера выполняется администратором. Если почтовый сервер не настроен, обратитесь к системному администратору.

Рабочий процесс:
- В диалоговом окне «Настройка почты» нажмите кнопку «Создать», заполните:
- «Адрес почты» — адрес, откуда будут поступать уведомления;
- «Пароль почты» — введите пароль;
- Установите галочки «Для отправки писем» и/или «Для получения писем»;
- Установите фокус «Всеми пользователями (общая почта)» или «Только мной»;
- Заполните поле «Имя отправителя»;
- Нажмите кнопку «Создать».

- Система запустит процесс проверки настроек. В случае если настройки почты нестандартные, перейдите к ручным настройкам, нажав на кнопку «Пропустить проверку».

- В диалоговом окне «Настройка почты» заполните параметры электронной почты и нажмите на кнопку «Далее». Для получения настроек обратитесь
к администратору почтового сервера.

- Система запустит проверку.

- Если настройки верны, появится уведомление и будет отправлено тестовое сообщение.

- Пример заполнения настроек.

Настройка почты для рассылки уведомлений
Для настройки установленной электронной почты перейдите «Администрирование/ Органайзер/ Настройка почты для рассылок уведомлений» или воспользуйтесь строкой поиска.

Рабочий процесс:
- В диалоговом окне установленной почты, измените необходимые настройки, нажмите кнопку «Проверить настройки».

- Система запустит процесс проверки настроек. Если настройки верны, появится уведомление и будет отправлено тестовое сообщение.
- Нажмите кнопку «Записать и закрыть».
Подробнее о настройках сервисе рассылки отчетов см. стаью «Настройка почты и рассылка отчетов».
Создание шаблона шага сценария
Шаблон шага — это заготовка, в которой хранится скрипт и набор параметров. Создав шаблон один раз, он используется в сценариях, при необходимости изменяются только значения параметров скрипта.
Основные настройки
Перейдите «Главное/ Настройки/ Шаблоны шагов сценария» или воспользуйтесь строкой поиска.

Рабочий процесс:
- В диалоговом окне «Шаблоны шагов сценариев» нажмите кнопку «Создать».

- В диалоговом окне «Шаблон шага сценария (создание)» заполните:
- «Наименование» — название шаблона (будет отображаться в сценарии). Например, «Скрипт по отправке отчётов АП в Telegram» или «Скрипт по отправке отчётов АП на почту»;
- «Тип шага» — из выпадающего списка выберите «EXEC»;
- «Вид шага» — из выпадающего списка выберите «Произвольный код на языке 1С»;
- Установите флаг «Показать» (в списке шаблонов)
- Перейдите на вкладку «Тексты запросов»:
- Нажмите кнопку «Добавить»;
- Из выпадающего списка в поле «Тип БД» выберите тип базы данных, соответствующий базе, которая используется в сценарии.
- Вставьте текст скрипта в поле для кода:
- Перейдите на вкладку «Параметры запроса» и нажмите кнопку «Дозаполнить параметры». Система проанализирует скрипт и автоматически заполнит имена параметров, которые были указаны в формате
{!ИмяПараметра!}. Нажмите кнопку «Записать и закрыть».
- После сохранения поместите созданный шаблон в подходящую группу, например «Сервисные операции».

Использование шаблона в сценарии
Добавление шага
Перейдите «Главное/ Сценарии обработки данных» или воспользуйтесь строкой поиска.

Рабочий процесс:
Примечание. Тип базы данных сценария должен совпадать с типом БД, указанным в созданном вами шаблоне!
- В диалоговом окне «Сценарии обработки данных» создайте новый сценарий или откройте существующий.
- Перейдите в «Шаги сценария».
- Найдите созданный шаблон в списке (он находится в той группе, куда вы его поместили) и перетащите его на рабочую область.

- Нажмите на иконку «карандаш» на шаге, чтобы открыть настройки. Заполните параметры — их состав и имена возьмите из шаблона:
- Для Telegram:
- «ХостПортала» — адрес портала Modus BI;
- «ТокенTelegramБота» — токен бота, полученный в Telegram;
- «ЧастьПутиURLОтчета» — адрес отчёта (например, report/1384);
- «ИдентификаторЧатаTelegram» — идентификатор чата для отправки;
- «НаименованиеПортала» — наименование элемента справочника «Аналитические порталы».

- Для почты:
- «ХостПортала» — адрес портала;
- «ЧастьПутиURLОтчета» — часть пути к отчёту;
- «НаименованиеПортала» — наименование элемента справочника «Аналитические порталы»;
- «НаименованиеСпискаРассылки» — наименование элемента справочника «Списки рассылок».

- Для Telegram:
- Нажмите кнопку «Готово».
Ограничения и особенности
- Хост портала указывается отдельно, даже если портал уже выбран в справочнике «Аналитические порталы». Это особенность текущей реализации скрипта.
- Таймауты и задержки (например, таймаут экспорта 120 секунд, задержка 1000 мс) предустановлены в шаблоне. При необходимости их можно изменить в шаблоне шага, после чего обновите шаг в сценарии.
- Пустые отчёты — функция не проверяет, пустой ли отчёт. Если отчёт пустой, он всё равно будет отправлен.
- Рассылка статусов — текущий скрипт отправляет содержимое отчёта, а не статус выполнения шага или пакета.
- Шаг не привязан к месту — его можно вставить в любое место сценария.
- Настройка почтового сервера выполняется администратором. Если почтовый сервер не настроен, обратитесь к системному администратору. Подробнее см. раздел «Создание новой учетной записи электронной почты (для отправки на Email)» и статью «Настройка почты и рассылка отчетов».
- Если данные на портале Modus BI кэшируются, перед вызовом шага может потребоваться сброс кэша набора данных. Подробнее см. статью «Кэширование аналитического портала».
Примечание. Если требуется создать собственный шаблон шага (например, для нового канала рассылки или другой логики), подробнее см. статью «Разработка шаблонов шагов сценария в Modus ETL. Руководство для 1С-разработчика».
