Instant messaging processor (im)

Содержание

Описание
Возможности
Ограничения
Параметры
Пример конфигурации
См. также

Описание

Процессор обмена быстрыми сообщениями с мессенджерами.

Обеспечивает коммуникацию с мессенджерами. Поступающие из мессенджеров абонентские сообщения размещает в коллекции модели данных `/rest/v1/model/im/Messages`, а создаваемые в ней сообщения `sending` отправляет абонентам мессенджеров.

Формирует коллекции/классы: im/Accounts, im/RemoteParties, im/Messages. Допускает их дальнейшую модификацию в сторону расширения состава свойств и вариантов значений перечислимых полей.

Использует коллекцию доменного центра `imchannels` (API, cущность).

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

Код	`im`
Режим работы	`Сервис`
Режим резервирования	`Active-Passive.`
Типы сайтов	`Любые`
Слой	`Адаптер/процессор`
Размещение	`Внутренний`
Сохранение и восстановление состояния при перезагрузке	`Нет`
Приложение	`era_im`

Возможности

Сообщения могут быть текстовыми, в виде картинок, звуковых файлов и пр. Текст сообщения размещается в поле сущности `/im/Message`, а прочие варианты сохраняются в виде вложений (поле `file`) и доступны через `/rest/v1/model/im/Messages/ID_MESSAGE/file`.
Поддерживает добавление адаптеров к разным типам мессенджеров через создание плагинов (erlang) или реализацию стратегий в сценариях.

Ограничения

Каждый отдельный мессенджер требует уникальных параметров, которые могут быть установлены в опциях аккаунта (поле `options` сущности im/Accounts). В частности для Telegram там обязательно должен быть указан `token`, а также опционально `disable_notification` (`true` | `false`) и `parse_mode` (`none`, `markDown`, `HTML`).
В составе платформы присутствует коннектор к Telegram. Прочие коннекторы требуют проектной разработки, могут быть реализованы в виде сценариев (отдельно сценарий получения сообщений и размещения в коллекциях, отдельно сценарий отправки одного конкретного сообщения).

Параметры

Описание столбцов в таблице

Table 2. Параметры
Имя	Тип	Умолчание	Описание
`name`	`str`	required	Имя. Может состоять из латинских букв и цифр, должно начинаться с буквы.
`roletype`	`str`	required	Тип роли. Возможные значения: `"im"`.
`iface`	`str`	required	Алиас сетевого интерфейса сервера, на котором будет происходить внутреннее взаимодействие ролей между собой.
`ext`	`json`	empty	Дополнительные опции роли. Содержит json объект или список.
`enabled`	`bool`	empty	Флаг активности роли. При установке в false роль не участвует в валидации и не запускается.
`group`	`int`	required	Номер группы. В рамках горизонтального масштабирования роль может быть разделена на несколько групп на сайте, в каждой из которых активен только один экземпляр, а остальные зарезервированы. Ответственность между группами разделяется по доменным множествам. Вместе все группы обслуживают полное доменное множество. Все роли одной группы должны иметь одинаковую ответственность. Целое число от `1` до `9999999`.
`order`	`int`	required	Порядок экземпляра роли в рамках группы. Определяет в каком порядке будет происходить перетекание в режиме Active-Passive.
`include_domains`	`array<str>`	empty	Список имен доменов, которые обслуживает данная группа. Может быть указан любой домен любого уровня. Указание домена приводит к тому, что дерево его поддоменов будет обслуживаться на этой группе и не будет обслуживаться на других группах роли, исключая только те ветви, которые упомянуты в других группах. В совокупности все группы роли на сайте обслуживают полное дерево доменов.

Пример конфигурации

Управление конфигурацией производится в приложении, доступном для администраторов мастер-домена. Приложение скрывает полное содержание конфигурации, однако тем не менее оно доступно через API.

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

Пример узла

{
  "name": "im1",
  "roletype": "im",
  "iface": "eth0",

  "group": 11330,
  "order": 1
}

См. также

imchannel