Alpha.Community

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

SetAdvancedRequestFilterAsJson

bool SetAdvancedRequestFilterAsJson(string StringJSON)

Применяет фильтр запроса (в формате JSON) исторических данных.

Параметры

StringJSON string Условия фильтрации. Задаются в виде строки - объекта JSON. Правила формирования условий фильтрации описаны ниже.

Возвращаемое значение

true Фильтр запроса успешно установлен.
false Неудачный разбор выражения фильтрации, фильтр не установлен.

Правила формирования условий фильтрации

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

Когда вы составляете логическое выражение, помните, что внутри каждого столбца содержатся данные определенного типа (в столбце Сообщение - строковые данные, в столбце Важность - число и т.д.), поэтому подбирайте операторы, работающие с этим типом. Ниже для всех операторов сказано с какими столбцами они работают.

Операторы сравнения

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

< меньше
> больше
<= меньше или равно
>= больше или равно
== равно
!= не равно

Логические операторы

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

Символьное написание Англоязычное написание Описание Для столбцов
& AND, and логическое "и" Можно использовать для фильтрации по любому столбцу.
| OR, or логическое "или" Можно использовать для фильтрации по любому столбцу.
! NOT, not логическое "не" Можно использовать только для столбцов, содержащих строку.

Логические выражения в формате JSON

Форматы составного объекта JSON

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

  • {"and": [ARRAY]}
  • {"or": [ARRAY]}
  • { "not": { OBJECT } }
  • { "операция сравнения": { VARIABLE } }
VARIABLE

Переменная. Имеет структуру: <имя переменной>: <значение переменной>. В имени переменной вы можете написать text и тогда в качестве значения такой переменной укажите значение, которое вы видите в таблице. Либо можете написать data и тогда в имени переменной укажите внутреннее значение, хранящееся в источнике данных.

Например, для столбца Квитировано (ack) переменная text имеет значение Да, а переменная data - значение true.

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

Правила составления логических выражений в формате JSON

  • Операцию сравнения == можно не указывать. В таком случае объект будет иметь формат { VARIABLE }.
  • В столбцах с датой и временем значение нужно указывать в формате UTC. Для начала переведите ваше строковое значение даты в метку времени формата uint8, а затем полученное значение переведите в формат UTC. Для перевода вы можете использовать функции Parse и ToUtc языка Alpha.Om.

  • Для столбцов с текстом:
    • Условия фильтрации для столбцов с текстом можно записывать без учета регистра.
    • Чтобы записать условие фильтрации, при котором столбец с текстом фильтруется по нескольким находящимся не рядом словам, используйте оператор and (&).
  • Условие фильтрации записывается в виде строки в кавычках, поэтому для правильной работы фильтра в языке OM экранируйте все остальные кавычки в строке символом \. В языке JavaScript этого делать не нужно.

Примеры

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

  • важностью (столбец severity) больше 10,
  • сообщением (столбец message), содержащим текст поставлен или с именем источника (столбец source), не соответствующим TU_212. Записать результат выполнения функции в текстовое поле.
Filter: string = "{ "AND": [ { ">": { "severity": 10 } }, { "OR": [ { "message": "*поставлен*" }, { "NOT": { "source": "TU_212" } } ] } ] }";
Result: bool = Alarms_1.SetAdvancedRequestFilterAsJson(Filter);
TextEdit_1.Text = Str.ToString(Result);