Alpha.Community

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

Свойства

Отображаемое имя

Описание объекта (поля объекта). Позволяет указать произвольное (например, русскоязычное) имя для узнаваемости объекта (поля объекта) в проекте. Не мешает использованию базового англоязычного имени объекта (поля объекта) для обращения в коде.

Кардинальное число

Преобразует объект в массив и задает размер массива (количество элементов в массиве).

Значение

1 Одиночный объект.
>1 Массив соответствующей размерности.

Активность

Свойство показывает, есть ли события в очереди.

Доступно только для чтения в режиме рантайма.

bool Active

Значения

true В очереди есть события.
false В очереди нет событий.

Запрос алармов

Query

Источник событий для очереди. Указывается в виде ссылки на объект типа Запрос алармов, существующий в проекте.

Длина очереди

uint4 Length

Текущее количество событий в очереди.

Доступно только для чтения в режиме рантайма.

Режим постановки событий в очередь

uint1 InsertMode

Режим постановки новых событий в очередь.

Значения

0 Вставлять все события из источника (без фильтрации).
1 Игнорировать квитированные события.
2 Игнорировать события, не требующие квитирования.
3 Игнорировать как квитированные, так и события, не требующие квитирования.

Фильтр в JSON-формате

string Filter

Условия фильтрации запрашиваемых от источника (объекта типа Запрос алармов) данных. Условия фильтрации задаются в виде строки - объекта JSON.

Фильтрация возможна только для столбцов c идентификаторами (переменными): severity, message, source, area, acked.

Условие фильтрации представляет собой одиночный ({"ключ": "значение"}) или составной (состоящий из нескольких объектов) объект JSON.

Составной объект формируется с помощью:

  • логических операций:
    • конъюнкция - "and" или "&"
    • дизъюнкция - "or" или "|"
    • инверсия - "not" или "!"
  • операций сравнения:
    • больше - ">"
    • больше либо равно - ">="
    • меньше - "<"
    • меньше либо равно - "<="
    • соответствует - "=="
    • не соответствует - "!="

В зависимости от используемой операции составной объект JSON может иметь вид:

  • {"and": [ARRAY]}
  • {"or": [ARRAY]}
  • { "not": { OBJECT } }
  • { "операция сравнения": { VARIABLE } }(операцию сравнения "==" можно не указывать, т.е. вид объекта - { VARIABLE })

где:

  • VARIABLE - переменная. Обозначается структурой <имя переменной>: <значение переменной>
  • OBJECT - переменная или составной объект JSON любого из указанных выше форматов
  • ARRAY - массив. Может состоять из переменных и составных объектов JSON (любого формата) в различных комбинациях

Примеры

Запросить события с:

  • важностью (столбец severity) больше 10;
  • сообщением (столбец message), содержащим текст поставлен или с именем источника (столбец source), не соответствующим TU_212.
{
  "AND": [
    { ">": { "severity": 10 } },
      {
        "OR": [
          { "message": "*поставлен*" },
          { "NOT": { "source": "TU_212" } }
        ]
      }
    ]
}

Запросить события с важностью 667.

{"==":{"severity":667}}