Alpha.Community

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

SetAdvancedFilterAsJson

bool SetAdvancedFilterAsJson(string ColumnID, string FilterExpr)

Работает аналогично SetAdvancedFilter. Единственное отличие в том, что условие фильтрации задается в формате JSON.

Параметры

ColumnID string

Идентификатор столбца таблицы сообщений.

За каждым столбцом закреплен собственный идентификатор, менять который нельзя.

столбец идентификатор тип данных в столбце
Время генерации time время
Время срабатывания active_time время
Время деактивации deactive_time время
Сообщение message строка
Источник события source строка
Важность severity число
Квитировано ack строка
Время квитирования ack_time время
Пользователь actor_id строка
Комментарий ack_comment строка
Активность active строка
Квитировать ack_required строка
Качество сигнала quality число
Значение сигнала value число
Группа важности group строка
FilterExpr string Условие фильтрации в виде логического выражения в формате JSON. Чтобы фильтрация сработала, вам нужно правильно составить условие фильтрации. Ниже описаны операторы, которые можно использовать в условиях фильтрации и правила, которые помогут вам составить работающее условие.

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

true Расширенный фильтр отображения установлен.
false Расширенный фильтр отображения не установлен, т.к. условие фильтрации сформировано неверно.

Ниже показаны примеры, как вывести результат выполнения функции в текстовое поле и в журнал времени исполнения.

//Вывод результата в текстовое поле.
filter: string = "условие фильтрации";
column: string = "идентификатор столбца";
if (!Alarms_1.SetAdvancedFilterAsJson(column, filter))
Text_3 = ("Фильтр: {" + filter + "} для столбца с идентификатором " + column + " не установлен");
else
Text_3 = ("Фильтр: {" + filter + "} для столбца с идентификатором " + column + " установлен");
//Вывод результата в журнал времени исполнения.
if (!Alarms_1.SetAdvancedFilterAsJson("идентификатор", "условие фильтрации"))
DebugTool_1.Log("Не удалось установить фильтр пользователя для идентификатор: условие фильтрации");
else
DebugTool_1.Log("Фильтр пользователя для идентификатор: условие фильтрации");

Операторы и правила формирования условий фильтрации

Условие фильтрации для столбца нужно записывать в виде объекта 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 этого делать не нужно.

Примеры

Фильтрация по столбцу с текстом

Показать сообщения о событиях, в тексте которых есть слово поставлен или слово снят.

 

Условие фильтрации нужно применить к столбцу Сообщение, поэтому в первом параметре функции укажите идентификатор столбца - message. Само условие фильтрации (второй параметр функции) составьте в виде составного объекта JSON с оператором or.

Формат составного объекта JSON в данном случае будет таким: {"or": [ARRAY]}, где ARRAY (массив ) состоит из двух VARIABLE (переменных): data: поставлен и data:снят.

 

В итоге, параметры функции выглядят так:

//язык OM
Alarms_1.SetAdvancedFilterAsJson("message","{\"or\":[{\"data\":\"*поставлен*\"},{\"data\":\"*снят*\"}]}");
//язык JavaScript
Alarms_1.SetAdvancedFilterAsJson("message",'{"or":[{"data":"*поставлен*"},{"data":"*снят*"}]}');
//язык OM (выводим результат выполнения функции в текстовое поле)
Filter: string = "{\"or\":[{\"data\":\"*поставлен*\"},{\"data\":\"*снят*\"}]}";
Result: bool = Alarms_1.SetAdvancedFilterAsJson("message", Filter);
TextEdit_1.Text = Str.ToString(Result);

Показать сообщения о событиях, содержащие точную фразу выше аварийного.

 

Условие фильтрации нужно применить к столбцу Сообщение, поэтому в первом параметре функции укажите идентификатор столбца - message. Само условие фильтрации составьте по формату { "операция сравнения": { VARIABLE } }, где VARIABLE (переменная) - data: выше аварийного. Операцию сравнения в данном случае можно не ставить.

 

В итоге, параметры функции выглядят так:

//язык OM
Alarms_1.SetAdvancedFilterAsJson("message","{\"data\":\"*выше аварийного*\"}");
//язык JavaScript
Alarms_1.SetAdvancedFilterAsJson("message",'{"data":"*выше аварийного*"}');

Показать сообщения о событиях, в комментариях к которым есть слова IGNATIEV и отправлено.

 

Условие фильтрации нужно применить к столбцу Комментарий, поэтому в первом параметре функции укажите идентификатор столбца - ack_comment. Само условие фильтрации (второй параметр функции) составьте в виде составного объекта JSON с оператором AND.

 

Формат составного объекта JSON в данном случае будет таким: {"and": [ARRAY]}, где ARRAY (массив ) состоит из двух VARIABLE (переменных): data: IGNATIEV и data:отправлено.

 

В итоге, параметры функции выглядят так:

//язык OM
Alarms_1.SetAdvancedFilterAsJson("ack_comment","{\"AND\":[{\"data\":\"*IGNATIEV*\"},{\"data\":\"*отправлено*\"}]}");
//язык JavaScript
Alarms_1.SetAdvancedFilterAsJson("ack_comment",'{"AND":[{"data":"*IGNATIEV*"},{"data":"*отправлено*"}]}');

Показать только квитированные сообщения о событиях.

 

Условие фильтрации нужно применить к столбцу Квитировано, поэтому в первом параметре функции укажите идентификатор столбца - ack. Само условие фильтрации (второй параметр функции) составьте по формату { "операция сравнения": { VARIABLE } }, где VARIABLE (переменная) - text: Да. Операцию сравнения в данном случае можно не ставить.

 

В итоге, параметры функции выглядят так:

 

//язык OM
Alarms_1.SetAdvancedFilterAsJson("ack", "{\"text\":\"Да\"}");
//язык JavaScript
Alarms_1.SetAdvancedFilterAsJson("ack", '{"text":"Да"}');

Фильтрация по столбцу с числом

Показать сообщения о событиях, важность которых равна 100.

 

Условие фильтрации нужно применить к столбцу Важность, поэтому в первом параметре функции укажите идентификатор столбца - severity. Само условие фильтрации (второй параметр функции) составьте по формату { "операция сравнения": { VARIABLE } }, где VARIABLE (переменная) - data: 100. Операцию сравнения в данном случае можно не ставить.

 

В итоге, параметры функции выглядят так:

//язык OM
Alarms_1.SetAdvancedFilterAsJson("severity","{\"data\":100}");
//язык JavaScript
Alarms_1.SetAdvancedFilterAsJson("severity",'{"data":100}');

Показать сообщения о событиях, важность которых больше или равна 100 и меньше или равна 667.

 

Условие фильтрации нужно применить к столбцу Важность, поэтому в первом параметре функции укажите идентификатор столбца - severity. Само условие фильтрации (второй параметр функции) составьте в виде составного объекта JSON с оператором and.

 

Формат составного объекта JSON в данном случае будет таким: {"and": [ARRAY]}, где ARRAY (массив ) состоит из двух конструкций формата { "операция сравнения": { VARIABLE } }: >={data:100} и <={data:667}.

 

В итоге, параметры функции выглядят так:

//язык OM
Alarms_1.SetAdvancedFilterAsJson("severity","{\"and\":[{\">=\":{\"data\":100}},{\"<=\":{\"data\":667}}]}");
//язык JavaScript
Alarms_1.SetAdvancedFilterAsJson("severity",'{"and":[{">=":{"data":100}},{"<=":{"data":667}}]}');

Показать сообщения о событиях, значение сигнала в которых равно -58 или 59.

 

Условие фильтрации нужно применить к столбцу Значение сигнала, поэтому в первом параметре функции укажите идентификатор столбца - value. Само условие фильтрации (второй параметр функции) составьте в виде составного объекта JSON с оператором or.

 

Формат составного объекта JSON в данном случае будет таким: {"or": [ARRAY]}, где ARRAY (массив ) состоит из двух VARIABLE (переменных): data: -58 и data:-59.

 

В итоге, параметры функции выглядят так:

//язык OM
Alarms_1.SetAdvancedFilterAsJson("value","{\"or\":[{\"data\":-58},{\"data\":-59}]}");
//язык JavaScript
Alarms_1.SetAdvancedFilterAsJson("value",'{"or":[{"data":-58},{"data":-59}]}');

Фильтрация по столбцу с временем

Показать сообщения о событиях, возникших 09.02.2024.

 

Условие фильтрации нужно применить к столбцу Время срабатывания, поэтому в первом параметре функции укажите идентификатор столбца - active_time.

 

Для удобства работы с датой 09.02.2024 её нужно представить в таком виде: >= 09.02.2024 00:00:00.000 И < 10.02.2024 00:00:00.000. Далее две полученные даты нужно перевести в формат UTC и преобразовать в строки, чтобы была возможность записать их во второй строковый параметр функции.

 

Чтобы сформировать условие фильтрации (второй параметр функции), выполните:

  1. Переведите первую дату 09.02.2024 в формат UTC с помощью функций Parse и ToUtc языка Alpha.Om.

    date1:uint8 = DateTime.Parse("09.02.2024");
    date1UTC: uint8 = DateTime.ToUtc(date1);
    
  2. Преобразуйте полученное значение в строку.

    stringDate1UTC:string = String.ToString(date1UTC);
    
  3. Переведите первую дату 10.02.2024 в формат UTC с помощью функций Parse и ToUtc языка Alpha.Om.

    date2:uint8 = DateTime.Parse("10.02.2024");
    date2UTC: uint8 = DateTime.ToUtc(date2);
    
  4. Преобразуйте полученное значение в строку.

    stringDate2UTC:string = String.ToString(date2UTC);
    
  5. Сформируйте составной объект JSON. Формат составного объекта JSON в данном случае будет таким: {"and": [ARRAY]}, где ARRAY (массив ) состоит из двух конструкций формата { "операция сравнения": { VARIABLE } }. Чтобы логическое выражение правильно считалось функцией, обе переменные должны объединяться с помощью конкатенации, поэтому нужно записать каждую переменную (VARIABLE) со знаками +:

    >={data:+stringDate1UTC+} и <{data:+stringDate2UTC+}.

    В итоге, второй параметр функции выглядит так:

    {\"AND\":[{\">=\":{\"data\":"+stringDate1UTC+"}},{\"<\":{\"data\":"+stringDate2UTC+"}}]}

 

Вся конструкция фильтра выглядит так:

//язык OM
date1:uint8 = DateTime.Parse("09.02.2024");
ddate1UTC: uint8 = DateTime.ToUtc(date1);
stringDate1UTC:string = String.ToString(date1UTC);
date2:uint8 = DateTime.Parse("10.02.2024");
date2UTC: uint8 = DateTime.ToUtc(date2);
stringDate2UTC:string = String.ToString(date2UTC);
Alarms_1.SetAdvancedFilterAsJson("active_time", "{\"AND\":[{\">=\":{\"data\":"+stringDate1UTC+"}},{\"<\":{\"data\":"+stringDate2UTC+"}}]}");

Фильтрация по нескольким столбцам одновременно

Показать все сообщения о событиях с важностью 750, содержащие слово уровень.

 

Отдельными строками запишите условия для столбца Важность (идентификатор severity) и столбца Сообщение (идентификатор message). В каждом случае условие фильтрации (второй параметр функции) составьте по формату { "операция сравнения": { VARIABLE } }. В первом случае VARIABLE (переменная) - data: уровень, во втором - data: 750. Операцию сравнения в данных случаях можно не ставить.

 

В итоге, вся конструкция фильтра выглядит так:

//язык OM
Alarms_1.SetAdvancedFilterAsJson("message", "{\"data\":\"*уровень*\"}");
Alarms_1.SetAdvancedFilterAsJson("severity","{\"data\":750}");