Alpha.Community

В разделе Документация вы найдете все для уверенного старта и работы с Альфа платформой: от пошаговых инструкций по установке и конфигурированию до подробного описания работы компонентов и подсистем. Для поиска необходимых тем и вопросов в документации, воспользуйтесь поиском и фильтрацией результатов.

Агрегация событий

Агрегация событий – это инструмент, позволяющий собирать обобщенную информацию о событиях по объекту или группе объектов.

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

Агрегацию выполняет объект-агрегатор (далее – агрегатор), вложенный в объект-источник событий (далее – объект). Источником событий может быть любой объект, содержащий параметры и объекты, для которых настроена генерация событий.

Использование агрегации позволяет квитировать одновременно все события по объекту и в ветке, а также определять:

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

Чтобы настроить агрегацию событий, выполните следующие шаги.

  1. Создайте логический тип, описывающий агрегатор.
  2. В созданном типе опишите параметры, которые будут предоставлять результаты агрегации, и с помощью которых можно будет квитировать агрегированные события.
  3. Разместите агрегатор (для агрегации событий по объекту) или агрегаторы (для агрегации событий по ветке) созданного типа в проекте.

Создание логического типа, описывающего агрегатор

Тип агрегатора событий по объекту и тип агрегатора событий по ветке создаются одинаково.

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

Если агрегаторы по ветке должны агрегировать события разных объектов ветки, добавьте созданному типу атрибут Категория агрегатора. Значение можно оставить пустым, либо указать любое значение по умолчанию. Агрегаторам этого типа, находящимся в разных объектах одной ветки, можно будет указать разные названия категорий агрегатора. Тогда агрегаторы разных категорий будут агрегировать события с разных объектов одной ветки.

Предположим, имеются три объекта: A, B и C. C вложен в B, B вложен в A. Эти объекты образуют ветку. Aggregator_A агрегирует события, возникающие в объекте A, Aggregator_B агрегирует события, возникающие в объекте B, Aggregator_C агрегирует события, возникающие в объекте C.

Если все три агрегатора созданы на основе одного и того же типа агрегатора по ветке, то:

  • Aggregator_B будет агрегировать события объекта B и события, агрегированные Aggregator_C;
  • Aggregator_A будет агрегировать события объекта A и события, агрегированные Aggregator_B и Aggregator_C.

Однако, если добавить атрибут Категория агрегатора типу, и для всех агрегаторов этого типа указать разные значения добавленного атрибута, то каждый агрегатор будет агрегировать только события по своему объекту. Если же категории агрегатора совпадут, например, для Aggregator_A и Aggregator_C, то:

  • Aggregator_A будет агрегировать события объекта A и события, агрегированные Aggregator_C;
  • Aggregator_B будет агрегировать только события по объекту B.

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

Результаты агрегации и возможность квитирования агрегированных событий предоставляются в виде параметров (сигналов Alpha.Server). Такие параметры можно создать самостоятельно, либо использовать готовые наборы параметров – сокеты из пространства имен Om.Server.AlarmAndEvent.Aggregation, доступные на Панели элементов.

Использование готовых наборов параметров

  1. Перейдите внутрь созданного типа агрегатора.
  2. Добавьте в него элементы из набора Om.Server.AlarmAndEvent.Aggregation:
    • элемент Result;
    • любой подходящий для вашего проекта сокет. Параметры-результаты агрегации, параметры для выполнения квитирования и сокеты, в которые они объединены, описаны ниже.
  3. Свяжите добавленные элементы служебной связью.

Готовый тип выглядит следующим образом.

Сохраните изменения. Тип агрегатора готов.

Сокеты
Название Назначение параметров сокета (кратко)
Acknowledge_IN Выполнение квитирования всех событий, прошедших агрегацию по объекту
AcknowledgeForeign_IN Выполнение внешнего квитирования всех внешних событий, прошедших агрегацию по объекту
AcknowledgeForeignInBranch_IN Выполнение внешнего квитирования всех внешних событий, прошедших агрегацию по ветке
AcknowledgeInBranch_IN Выполнение квитирования всех событий, прошедших агрегацию по ветке
Result_IN Воздействия на результаты агрегации событий по объекту
Result_OUT Результаты агрегации событий по объекту
ResultAcknowledge_OUT Результаты агрегации по квитированию событий по объекту
ResultAcknowledgeInBranch_OUT Результаты агрегации по квитированию событий по ветке
ResultActive_OUT Результаты агрегации по активности событий по объекту
ResultActiveInBranch_IN Выполнение формирования результатов агрегации событий по активным объектам в ветке
ResultActiveInBranch_OUT Результаты агрегации по активности событий по ветке
ResultForeignAcknowledge_OUT Результаты агрегации по внешнему квитированию внешних событий по объекту
ResultForeignAcknowledgeInBranch_OUT Результаты агрегации по внешнему квитированию внешних событий по ветке
ResultInBranch_IN Воздействия на результаты агрегации событий по ветке
ResultInBranch_OUT Результаты агрегации событий по ветке
Параметры, предоставляющие результаты агрегации
Параметр Тип Описание
ActiveEventsFlag bool Наличие активных событий
MaxSeverity uint2 Максимальная важность среди активных событий
MaxSeverityActual uint2 Максимальная важность среди активных неквитированных событий
MinSeverity uint2 Минимальная важность среди активных событий
MinSeverityInBranch uint2 Минимальная важность среди активных событий в ветке
AllAcknowledged bool Индикатор квитирования всех событий
ActiveCount uint4 Количество активных событий
ForeignUnackedCount uint4 Количество событий не квитированных во внешней модели событий
ActiveEventsFlagInBranch bool Наличие активных событий в ветке
MaxSeverityInBranch uint2 Максимальная важность среди активных событий в ветке
MaxSeverityActualInBranch uint2 Максимальная важность среди активных неквитированных событий в ветке
AllAcknowledgedInBranch bool Индикатор квитирования всех событий в ветке
ActiveCountInBranch uint4 Количество активных событий в ветке
ActiveObjects string Список идентификаторов активных объектов
ForeignUnackedCountInBranch uint4 Количество событий не квитированных во внешней модели событий в ветке
MaxSeverityUnacked uint2 Максимальная важность среди активных неквитированных событий
MaxSeverityUnackedInBrunch uint2 Максимальная важность среди активных неквитированных событий в ветке
MinSeverityUnacked uint2 Минимальная важность среди активных неквитированных событий
MinSeverityUnackedInBrunch uint2 Минимальная важность среди активных неквитированных событий в ветке
ActiveObjects.Build bool Сигнал-триггер для формирования результатов агрегации по активным объектам в ветке
Параметры, предоставляющие возможность квитирования
Параметр Тип Описание
Acknowledge bool Выполнить квитирование событий по объекту
Acknowledge.Comment string Комментарий квитирования событий по объекту
Acknowledge.User string Имя пользователя, выполнившего квитирование по объекту
AcknowledgeInBranch bool Выполнить квитирование событий по ветке
AcknowledgeInBranch.Comment string Комментарий квитирования событий по ветке
AcknowledgeInBranch.User string Имя пользователя, выполнившего квитирование по ветке
AcknowledgeForeign bool Выполнить квитирование внешних событий по объекту
AcknowledgeForeign.User string Имя пользователя, выполнившего квитирование внешних событий по объекту
AcknowledgeForeign.AckInfo string Информация для квитирования во внешней модели
AcknowledgeForeignInBranch bool Выполнить квитирование внешних событий по ветке
AcknowledgeForeignInBranch.User string Имя пользователя, выполнившего квитирование внешних событий по ветке
AcknowledgeForeignInBranch.AckInfo string Информация для квитирования во внешней модели по ветке

Создание собственных наборов параметров

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

  1. Перейдите внутрь созданного типа агрегатора.
  2. Создайте сокет. Укажите произвольное имя и направление (вход – для набора параметров для квитирования событий, выход – для набора параметров, представляющих результаты агрегации).
  3. Добавьте созданному сокету атрибут Служебный элемент. Значение указывать не нужно.
  4. Перейдите внутрь созданного сокета. Добавьте необходимое количество параметров, которые должны описывать результаты агрегации или необходимы для выполнения квитирования. Назначьте созданным параметрам атрибуты:
    • Служебный параметр результатов агрегации – для параметров, описывающих результаты агрегации;
    • Служебный параметр квитирования событий агрегации – для параметров, предназначенных для выполнения квитирования событий.

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

  5. Вернитесь на уровень выше, внутрь создаваемого типа агрегатора. Добавьте в тип элемент Result из набора Om.Server.AlarmAndEvent.Aggregation.
  6. Свяжите добавленный элемент и созданный сокет служебной связью.

Готовый тип выглядит следующим образом.

Сохраните изменения. Тип агрегатора готов.

Элемент Result тоже можно создать самостоятельно, но мы не рекомендуем этого делать. Следует использовать готовый элемент из набора.

Для создания собственного элемента Result следует создать тип, а затем добавить ему атрибут Служебный объект агрегации с единственно возможным значением AggregationResult. Этот атрибут позволяет использовать служебную связь. Объект такого типа может заменить готовый элемент Result из набора, однако в этом нет смысла, так как готовый элемент позволяет создать любой агрегатор.

Размещение агрегатора

Агрегатор созданного типа следует разместить в объекте-источнике событий.

  1. Перейдите к объекту-источнику событий.
  2. Разместите в нем логический объект. Название объекта может быть любым. В качестве типа объекта укажите тип агрегатора, созданный ранее.

Объект A является источником событий, так как для параметров Pressure1, Pressure2 и Pressure3 настроена генерация событий. Логическому объекту Aggregator_A назначен тип Aggregator1, в котором:

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

Оба сокета предоставлены набором элементов Om.Server.AlarmAndEvent.Aggregation.

Если необходима агрегация событий по ветке, то агрегатор должен быть расположен в каждом объекте ветки, события которого должны быть агрегированы.

В результате применения созданной конфигурации в Alpha.Server появятся служебные сигналы, позволяющие квитировать агрегированные события и/или просматривать результаты агрегации событий.

О возможности включения агрегации для параметров

Для параметров в окне События доступна установка флага Агрегировать события. Эта настройка является частью устаревшего механизма агрегации, описанного в более ранних версиях документации Alpha.DevStudio. Для Alpha.DevStudio версии 4.0.0 и новее и Alpha.Server 6.2.0 и новее настройка агрегации должна выполняться согласно описанной в данном разделе инструкции.