Компонент Генерация произвольного события

Описание

Осуществляет отправку произвольного события подписчикам на события системы (роль wssubscr).
При наличии соответствующих ассетов описания событий они также попадают в БД.

Table 1. Системные характеристики

Индекс

115

Краткое название

raise_event

Типы сценариев

Все

Стартовый модуль

r_script_component_raise_event

Режим

Асинхронный

Иконка

115

Характер разветвления

Разветвляющий, замыкающий

Свойства

Table 2. Свойства
Спецификация Описание

Название: Направление
Код: destinationType
Усл. видимости: нет
По умолчанию:

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

  • Подписчики (wssubscr, 0) – Событие генерируется в канал подписки клиентам вебсервера (websocket). Для возможности осуществления фильтрации при подписке может быть задан параметр "пользователь".

  • KAFKA mustache (kafka_mustache, 1) – Cобытие генерируется в хранилище KAFKA, заданное в настройках домена 'kafka_mustache', 'kafka_params'. Событие генерируется в объектной обертке, {class, type, ts, data}, где заданное содержимое события размещено в поле 'data'.

  • KAFKA storage (kafka_storage, 2) – Событие в виде сущности отправляется в хранилище типа KAFKA. Параметры подключения заданы в сущности хранилища. Опционально там же задается название топика, который должен уже существовать в брокере. Дополнительно задаются код хранилища для выбора из множества хранилищ, заданных в домене, а также ключ, используемый для определения партиции (например, идентификатор связанной с событием сущности). Событие генерируется без объектной обертки.

Название: Пользователь
Код: user
Усл. видимости: да
По умолчанию: — 

Имя пользователя, по которому производится фильтрация при подписке.
Для роли wssubscr значение представляется в виде структуры {sipuser, User}.
Если не задан, то подставляется пустое значение, что также может являться фильтром.

Используется только при выборе направления 'Подписчики'.

Название: Код хранилища
Код: storageInstance
Усл. видимости: да
По умолчанию: — 

Аргумент, задающий код хранилища (поле 'instance' сущности 'storage' с типом 'kafka').

Используется только при выборе направления 'KAFKA-хранилище домена'. Обязательный параметр при использовании этого направлении.

Название: Ключ партиции
Код: partitionKey
Усл. видимости: да
По умолчанию: — 

Опциональный параметр, используемый для определения номера партиции соответствующего топика в KAFKA.
Может представлять собой идентификатор связанной с генерируемым событием сущности.
Используется только при выборе направления 'KAFKA-хранилище домена'.

Название: Имя события
Код: eventname
Усл. видимости: нет
По умолчанию: — 

Имя события, содержащее класс и тип через точку в формате CLASS_NAME.TYPE_NAME

Название: Тело события
Код: body
Усл. видимости: нет
По умолчанию: — 

Тело отправляемого сообщения в виде JSON-структуры

Название: Переход
Код: transfer
Усл. видимости: нет
По умолчанию: — 

Компонент, которому передается управление при успешном завершении.

Название: Переход, ошибка
Код: transferError
Усл. видимости: нет
По умолчанию: — 

Компонент, которому передается управление при возникновении ошибки.

Название: Причина ошибки в переменную
Код: errorReason
Усл. видимости: нет
По умолчанию: — 

Переменная для сохранения ошибки.

См. также