Работа со Сценариями автоматизации

к сведению

Элементы (шаги) сценария описаны в отдельной статье.

к сведению

Сценариями автоматизации можно управлять по API. Информация доступна по этой ссылке.

Управление сценариями

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

С помощью контекстного меню и иконок в строке сценария доступны следующие действия:

— активировать сценарий.

— запустить сценарий сейчас (если задано расписание активации, можно принудительно запустить сценарий до начала расписания).

— остановить сценарий. Если в сценарии на момент остановки остались профили, их можно сохранить. При следующей активации сценария они «проснутся» и продолжат проходить сценарий с того элемента, на котором остановились.

— отправить профили в сценарий.

— очистить сценарий от профилей (кнопка рядом со счётчиком профилей в строке сценария).

— клонировать сценарий. При клонировании можно указать, какую версию скопировать: опубликованную, черновик или другую версию.

— переместить сценарий в корзину (доступно только для неактивных сценариев).

— перейти в отчет по сценарию.

Начало работы со сценарием

Для добавления нового сценария нажмите + Создать в верхней части страницы.

Предварительные настройки

В открывшемся окне укажите название сценария, выберите базу данных, профили из которой будут захвачены, и режим повторного входа. Затем нажмите Создать.

предупреждение

Выбранную базу данных невозможно будет изменить после создания сценария. Название и режим повторного входа можно изменить позже.

Режим повторного входа определяет поведение сценария при неоднократном захвате профиля клиента:

• Отключить повторный вход в сценарий для профиля клиента — профиль попадает в сценарий только один раз. После выхода повторный вход невозможен.

• Отключить повторный вход для задействованных в сценарии профилей клиента — если профиль уже в сценарии, повторный вход невозможен. После выхода — снова может войти.

• Прекратить существующее задание для профиля при появлении нового — текущее задание завершается и заменяется новым. Все данные (apicontent и т.д.) удаляются, профиль начинает сценарий заново.

• Обрабатывать каждую запись профиля в сценарии отдельно — профиль может войти в сценарий повторно, оба прохождения обрабатываются независимо.

После создания сценария вы попадаете в редактор. В блоке Информация о сценарии можно задать:

• описание;
• теги;
• группы доступа;
• атрибуты (если для сценариев активирован обязательный атрибут, выберите его значение сразу);
• высокий приоритет;
• запрет входа в триггер ноды;
• режим повторного входа.

подсказка

Все изменения в редакторе сохраняются в черновик сценария. Подробнее — Черновик и версии сценария.

Настройка захвата профилей в сценарий

Условия попадания профиля в сценарий определяет триггер. Триггер — это стартовый элемент, который запускает сценарий. В одном сценарии вы можете настроить до 10 триггеров.

Чтобы добавить триггер, нажмите Добавить элемент и выберите нужный элемент из категории Триггеры:

подсказка

Подробную информацию по каждому триггеру можно найти в этой статье.

предупреждение

Чтобы сохранить сценарий, необходимо связать все стартовые элементы с каким-либо элементом.

Захват профилей по умолчанию

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

С помощью элемента «По умолчанию» профили могут попадать в сценарий из разных точек платформы:

1. При отправке профиля в сценарий через API. После сохранения сценария в окне элемента отобразится URL, который можно использовать для запуска сценария. Однако рекомендуется использовать более новую версию API. Подробнее в документации.

2. При добавлении профиля в сценарий вручную:

3. При отправке задействованных профилей одного сценария в другой сценарий:

4. Через узел перехода из другого сценария:

Черновик и версии сценария

Каждый сценарий имеет черновик — рабочую область для внесения изменений без влияния на работающую версию.

Версия — неизменяемый слепок сценария. Новую версию можно создать из черновика или из любой версии в списке — например, отредактировать старую и сохранить как новую.

Опубликованной может быть только одна версия — эта версия будет использована при активации сценария.

Черновик сценария

Черновик — это копия сценария, в которой вы можете свободно добавлять, удалять и изменять узлы, не затрагивая работающую версию.

Изменения в черновике не попадают в работающую версию. Если вы просто закроете редактор, изменения сохранятся, но только для вашего аккаунта — другие пользователи их не увидят. Кнопка Сохранить делает черновик общим: после этого его видят все, у кого есть права на просмотр сценария.

В отличие от публикации и сохранения как версии, при сохранении черновика не проводится проверка на ошибки. Это позволяет:

• сохранить промежуточный результат работы;
• вернуться к настройке сценария позже;
• добавлять узлы без готовых шаблонов для коммуникаций.

Если другой пользователь сохранил черновик, пока вы работали со своей копией, система покажет окно:

• Использовать серверный — перезаписать ваш черновик серверной версией;
• Использовать свой — сохранить вашу копию;
• Открыть сохранённый сценарий в новой вкладке — чтобы сравнить версии.

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

• Сохранить мой — сохранить вашу копию, перезаписав серверную версию;
• Принять чужой — использовать серверную версию черновика;
• Отмена — отменить сохранение.

Сохранение и публикация

На панели черновика доступны кнопки:

• Сохранить — изменения записываются в черновик без публикации. Рабочая версия сценария не меняется, проверка на ошибки не проводится.
• Опубликовать — открывает модальное окно «Публикация версии». Черновик публикуется как новая версия сценария. Перед публикацией система проверяет сценарий на ошибки: все узлы должны быть корректно настроены, у рассылок должны быть шаблоны, ресурсы — подключены. Если ошибки найдены, публикация не состоится.

Остальные действия доступны в меню (кнопка ⋮ на панели):

• Сохранить как версию — создаёт новую версию из черновика. Перед сохранением проводится проверка на ошибки.
• Проверить на ошибки — запускает проверку сценария на ошибки настройки.
• Клонировать в новый сценарий — создаёт копию сценария из открытого черновика или версии.

Окно публикации

При публикации версии можно настроить:

• Название версии — по умолчанию дата и время публикации;
• Описание версии — краткое описание изменений;
• Очистить профили — при наличии профилей в сценарии появляется опция очистки;
• Активировать при публикации — сценарий запустится сразу после публикации;
• Период активности — дата запуска, дата деактивации и часовой пояс.

предупреждение

Если сценарий активен, при публикации новой версии сценарий продолжает работу на ней.

Версии сценария

Каждый раз, когда вы публикуете черновик или сохраняете его как версию, создаётся новая версия: полный набор узлов, связей и настроек на момент публикации или сохранения.

Версии отображаются в боковой панели редактора. Опубликованная версия помечается как «Опубликована».

Система хранит до 100 версий сценария. Когда лимит достигнут, перед сохранением новой версии система спросит подтверждение — самая старая неопубликованная версия будет удалена.

Просмотр версии

Для просмотра версии нажмите на напротив нужной версии. Просматриваемая версия помечается как «Версия просматривается».

Выбранная версия откроется в окне просмотра:

Из меню (кнопка ⋮ на панели) можно:

• Редактировать как черновик — версия копируется в черновик (действующий черновик перезаписывается). Дальнейшие изменения вносятся в черновике;
• Проверить на ошибки — запуск проверки на ошибки;
• Клонировать в новый сценарий — создать копию этой версии в новом сценарии.

Переключение версии

Чтобы сделать другую версию активной:

1. Откройте нужную версию из списка;
2. Выберите «Редактировать как черновик» — версия скопируется в черновик;
3. Опубликуйте черновик.

После публикации выбранная версия станет опубликованной, а предыдущая — неопубликованной. Если сценарий запущен, он продолжит работу на новой версии.

Активация и деактивация сценария

Статусы сценария

Сценарий может находиться в одном из трёх статусов:

• Активный — сценарий запущен и захватывает профили;
• Неактивный — сценарий остановлен;
• В ожидании — сценарий запланирован и ожидает начала периода активности.

Активация

Активировать можно только опубликованную версию сценария. Опубликованной может быть только одна версия. Если у сценария нет опубликованных версий, активация недоступна — сначала опубликуйте черновик (см. Черновик и версии сценария).

Чтобы активировать сценарий, нажмите кнопку на панели инструментов редактора.

В окне активации можно задать период активности — дату запуска и окончания сценария:

• Дата запуска сценария — сценарий начнёт захватывать профили с указанной даты и времени. До этого момента сценарий будет находиться в статусе «В ожидании». Можно выбрать вариант запуска: в определенную дату или сейчас;
• Дата деактивации сценария — сценарий деактивируется по истечении указанного периода (вариант вручную — без автоматической деактивации);
• Использовать часовой пояс — время интерпретируется в указанном часовом поясе;
• Очистить сценарий перед повторной активацией — при включении замороженные профили будут удалены из сценария перед активацией. Опция отображается, если в сценарии есть профили.

Деактивация

Нажмите и сохраните сценарий. Если в сценарии есть профили, откроется окно деактивации с опцией Сохранять в сценарии профили, которые проснутся при его активации:

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

подсказка

Деактивация сценария останавливает захват новых профилей через все триггеры. Если нужно остановить только поступление новых профилей через конкретный триггер, не останавливая сценарий, используйте функцию Запретить вход в триггер ноды — Подробнее.

Также активировать и деактивировать сценарий можно из общего списка:

Блокировка отдельных триггеров

Функция Запретить вход в триггер ноды позволяет остановить поступление новых профилей только через конкретный триггер, не останавливая сценарий в целом.

Например, профили попадают в сценарий через два триггерных узла: «Заполнение формы» и «Импорт через API». Если вы запретите вход через триггер «Заполнение формы», профили, пришедшие через «Импорт через API», продолжат попадать в сценарий, а те, кто заполнил форму, — нет. После того как вы снимете запрет, в сценарий через этот триггер попадут только профили, заполнившие форму после снятия запрета; те, кто заполнил форму во время запрета, в сценарий не попадут.

Чтобы заблокировать триггер:

1. Откройте блок Информация о сценарии;
2. В поле Запретить вход в триггер ноды выберите узел(ы), в которые запрещён вход.

Заблокированный триггер помечается в редакторе. Блокировка действует только на вход — профили, уже находящиеся в сценарии, продолжают прохождение.

Аналитика сценариев

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

Статистика прохождения сценария клиентами

Панель статистики находится в нижней части редактора. На этой панели собрана информация о прохождении сценария профилями.

Просмотр статистики доступен в двух режимах:

— статистика за период

— статистика в реальном времени

Статистика за период

Здесь вы можете просмотреть данные по сценарию за определенный период времени:

— общее количество профилей, вошедших в сценарий.

— количество профилей, завершивших сценарий.

— ошибки, возникшие в процессе работы сценария.

По умолчанию панель отображает данные за последние 7 дней. Чтобы изменить период, введите нужные даты вручную или выберите их в календаре:

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

Статистика в реальном времени

Здесь вы можете получить информацию о профилях, которые сейчас находятся в сценарии.

— количество профилей, вошедших в сценарий, но еще не завершивших его.

Над элементами, где находятся профили, отображается их количество. Обычно это элементы ожидания (Пауза, Лучшее время доставки, Условие с задержкой).

Нажмите на цифру, чтобы:

• перейти в профиль клиента в базе;
• узнать точное время, когда профиль выйдет из элемента;
• скачать файл с API-контентом, если соответствующий параметр был передан в API-запросе.

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

Чтобы удалить из сценария все профили, которые в данный момент находятся в этом элементе, нажмите кнопку Удалить эти профили из сценария.

Расширенная статистика по узлам

Для каждого узла сценария доступна расширенная статистика:

• Входы — количество профилей, вошедших в узел;
• Выходы — количество профилей, успешно прошедших узел;
• Ошибки — количество профилей, завершивших обработку узла с ошибкой.

Разница между входами и выходами показывает, сколько профилей не прошло узел. Причины ошибок можно посмотреть в Менеджере ошибок.

Менеджер ошибок

Менеджер ошибок показывает профили, которые не смогли пройти узлы сценария из-за ошибок. Откройте его через иконку ⚠ на панели инструментов редактора.

Это единый блок по всем опубликованным версиям, где были ошибки профилей. Для каждой группы ошибок отображаются:

• Нода — название и ID узла, в котором произошла ошибка;
• Профилей — количество зависших профилей;
• Ошибки — описание причины (например, «Шаблон недоступен», «Нода удалена»);
• Версия — версия сценария, в которой зафиксирована ошибка. По названию можно открыть вкладку с версией;
• Действия — доступные действия для каждого профиля.

Если ошибок нет, отображается сообщение «Ошибок не найдено».

Действия с профилями в ошибках

Для каждой группы ошибок доступны следующие действия:

• Перенести в ноду — профиль перемещается в указанную ноду текущей опубликованной версии;
• Выход из сценария — профиль завершает прохождение сценария;
• Повторить — система повторно отправляет профили в эту же ноду и повторяет обработку. Кнопка доступна только для опубликованной версии и только если нода в ней присутствует.

Пока профиль находится в статусе ошибки, он не может снова войти в сценарий.

Метрики запуска расписания

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

• дата начала и завершения запуска;
• состояние запуска (успешно, ошибка, ожидание);
• количество захваченных профилей;
• текст ошибки и количество ошибок (при сбое).

По этим данным видно, когда запускался триггер и были ли ошибки при захвате.

подсказка

Чтобы узнать, на каком именно элементе профиль покинул сценарий, откройте карточку профиля, перейдите на вкладку Взаимодействия —> Сценарии и наведите курсор на статус «Вышел». Отобразится идентификатор элемента:

Аналитика рассылок в сценарии

Чтобы просмотреть отчёт о рассылках, которые запускает сценарий, откройте Отчёт по каналам:

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