Bracket - как составлять фильтры с помощью 011 бракетов?
012 013014
В этой статье мы рассмотрим.
015 016-
017
- Структура бракета
018
019
-
020
- Пример бракета 021
023
024 - Структура dynamicFilters
025
026
-
027
- Пример бракета с динамичным фильтром для текстового поля 028
030
031 - Структура nativeFilters
032
033
-
034
- Пример бракетом с нативным фильтром для автора 035
037
040
Структура бракета:
041 042Бракеты используется для получения данных с определённым 043 фильтром
044 045 049 050
051 var JSON = {
052 "brackets": [
053 {
054 "id": "iCNZfgb0",
055 "parentId": null,
056 "parentTreeIds": [{"..."}],
057 "connectionType": "",
058 "brackets": [{"..."}],
059 "dynamicFilters": [{"..."}],
060 "nativeFilters": [{"..."}],
061 }]
062 }
063
064
065
066 | Атрибут входного JSON | 070Описание | 071
|---|---|
| id | 077(String): Уникальный идентификатор бракета. | 078
| parentId | 082(String или null): Идентификатор родительского бракета, если 083 таковой имеется. Если бракет является верхним уровнем, то это поле 084 может быть null. | 085
| parentTreeIds | 089(Массив String): Массив идентификаторов родительских бракетов 090 данного бракета в дереве. Простыми словами это массив хранящий id 091 родительского бракета, родителя родительского и т.д пока они 092 имеются. | 093
| connectionType | 097(String): Тип соединения между условиями внутри бракета. 098 Например, "AND" или "OR". Этот тип определяет, какие условия должны 099 выполняться внутри бракета. | 100
| brackets | 104(Массив объектов): Массив вложенных бракетов, которые содержат 105 дополнительные сложные фильтры. Это позволяет строить сложные 106 логические выражения из бракетов. | 107
| dynamicFilters | 111(Массив объектов): Массив фильтров, которые выполняют 112 фильтрацию по динамичным полям бизнес-объекта. Подробнее об структуре 114 dynamicFilters | 115
| nativeFilters | 119(Массив объектов): Массив фильтров, которые могут быть 120 применены к нативным данным (полям) бизнес-объекта. Подробнее об структуре nativeFilters | 122
Как вы возможно уже поняли dynamicFilters и nativeFilters 127 фильтруют по полям бизнес-объекта, а Бракеты содержат эти фильтры в 128 себе, соединяя их через булеву логику (И / ИЛИ). Также бракеты 129 содержат другие бракеты, создавая структуру где все выполняется 130 постепенно по приоритету.
131 132Например, чтобы было наглядно создадим БО 133 "Задачи" в системе MyBPM, и сделаем следующий фильтр:
134 135
Простое объяснение:
138 139-
140
- Внутри оранжевого бракета ищем задачи, где автор либо текущий 141 пользователь, либо Цыпленков Денис, но статус задачи In Work или 142 Автор последнего изменения задачи Темирлан Жумагулов 143 144
- Затем смотрим чтобы данные проходящие оранжевый бракет имели 145 дату создания с 01.09 - 30.09 146
Техническое объяснение:
149 150Предупреждение: Может быть изначально 151 непонятным если вы не ознакомились со структурами dynamicFilters и 152 nativeFilters (Прочитайте их сперва)
153 154-
155
- У нас есть один начальный, главный массив brackets, который
156 содержит в себе два бракета: оранжевый бракет и
157 прозрачный бракет с нативным фильтром "Дата
158 создания", соединенные через условие И. В итоге будут отображаться
159 данные которые прошли через фильтры оранжевого бракета И чья дата
160 создания попадает в указанный период.
161
162
163
199{ 164 "boCode": "TEST", // поле описано в таблице внутри "Получение списка инстанций бизнес-объектов" 165 "paging": { // поле описано в таблице внутри "Получение списка инстанций бизнес-объектов" 166 "offset": 0, 167 "limit": 20 168 }, 169 "brackets" : [ // ВНИМАНИЕ! Вот здесь наши бракеты будут расположены: 170 { 171 "id": "id_1", // Это id оранжевого бракета (Так как фильтров нет можем не указывать их) 172 "parentId": null, 173 "parentTreeIds": [], 174 "connectionType": "AND", // Связь со следующим соседним бракетом в списке 175 "brackets": [ 176 {...}, // Рассмотрим ниже 177 {...}, // Рассмотрим ниже 178 {...} // Рассмотрим ниже 179 ] 180 }, 181 { 182 "id": "id_2", // Это id прозрачного бракета с нативным фильтром 183 "parentId": null, 184 "parentTreeIds": [], 185 "nativeFilters": [{ // Нативный фильтр на дату создания задачи с "dateFrom" по "dateTo" 186 "id": "n1", 187 "type": "CREATED_AT", 188 "dateFrom": "2023-09-01T00:00:00.000Z", 189 "dateTo": "2023-09-30T00:00:00.000Z" 190 }], 191 "connectionType": "AND", 192 "brackets": [] 193 } 194 ], 195 "state": "ALL", // поле описано в таблице внутри "Получение списка инстанций бизнес-объектов" 196 } 197198
200
201 - Внутри оранжевого бракета у нас есть: прозрачный
202 бракет с нативным фильтром "Автор", фиолетовый
203 бракет и прозрачный бракет с фильтром
204 нативным фильтром "Автор последнего изменения", соединенные через
205 условие ИЛИ. Бракет будет фильтровать задачи (данные) по Автору
206 "Текущий пользователь" ИЛИ по фильтрам фиолетового бракета ИЛИ по
207 Автору последнего изменения "Темирлан Жумагулов".
208
209
210
252{ 211 "id": "id_1", // Это id оранжевого бракета (Так как фильтров нет можем не указывать их) 212 "parentId": null, 213 "parentTreeIds": [], 214 "connectionType": "AND", // Связь со следующим соседним бракетом в списке 215 "brackets": [ 216 { 217 "id": "id_1_1", // Это id первого бракета вунтри оранжевого бракета 218 "parentId": "id_1", 219 "parentTreeIds": ["id_1"], 220 "nativeFilters": [{ // С фильтром на нативное поле Автор 221 "id": "n2", 222 "type": "CREATED_BY", 223 "isCurrentUser": true // По текущему пользователю 224 }], 225 "connectionType": "OR" // Связь со следующим соседним бракетом в списке 226 }, 227 { 228 "id": "id_1_2", // Это id фиолетвого бракета нужного для группировки и порядка выполнения 229 "parentId": "id_1", 230 "parentTreeIds": ["id_1"], 231 "brackets": [ 232 {...}, // Рассмотрим ниже 233 {...} // Рассмотрим ниже 234 ], 235 "connectionType": "OR" // Связь со следующим соседним бракетом в списке 236 }, 237 { 238 "id": "id_1_3", 239 "parentId": "id_1", 240 "parentTreeIds": ["id_1"], 241 "nativeFilters": [{ // С фильтром на нативное поле Автор 242 "id": "n3", 243 "type": "CREATED_BY", 244 "isCurrentUser": true // По текущему пользователю 245 }], 246 "connectionType": "AND" // Дефолтная связь (Нужно ли вообще ставить тогда?) 247 } 248 ] 249 } 250251
253
254 - Внутри фиолетового бракета у нас есть два прозрачных
255 бракета: первый с нативным фильтром на
256 поле "Автор", а второй с динамичным фильтром на
257 динамическое поле "Статус" созданного внутри БО "Задачи",
258 соединенные через условие И. Бракет будет фильтровать данные по
259 Авторам "Денис Цыпленков" и "qwe qwe" И чей Статус задачи в работе
260 "In work".
261
262
263
301{ 264 "id": "id_1_2", // Это id фиолетвого бракета нужного для группировки и порядка выполнения 265 "parentId": "id_1", 266 "parentTreeIds": ["id_1"], 267 "brackets": [ 268 { 269 "id": "id_1_2_1", // Это id первого бракета внутри фиолетеового бракета 270 "parentId": "id_1_2", 271 "parentTreeIds": ["id_1", "id_1_2"], 272 "nativeFilters": [{ // С нативным фильтром на поле "Автор" 273 "id": "n3", 274 "type": "CREATED_BY", 275 "orgUnitRecords": [ 276 { 277 "id":"dPLgJxgojYu2Q0OR", // Для пользователя с этим id 278 "type":"PERSON" 279 } 280 ] 281 }], 282 "connectionType": "AND" 283 }, 284 { 285 "id": "id_1_2_2", // Это id второго бракета внутри фиолетового бракета 286 "parentId": "id_1_2", 287 "parentTreeIds": ["id_1", "id_1_2"], 288 "dynamicFilters": [{ // С фильтром на динамичное поле Статус 289 "id": "n2", 290 "fieldId": "sn4jBFXH9SSinZEZ", // С этим id поля 291 "type": "RADIO_BUTTON_GROUP", // С типос "Единичный список" 292 "value": "TYmt8hUli27oCoP4" // Где значения идентификатор option-а 293 }], 294 "connectionType": "AND" 295 }, 296 ], 297 "connectionType": "OR" // Связь со следующим соседним бракетом в списке 298 } 299300
302
305
Структура dynamicFilters
306 307dynamicFilters используется для динамичных полей, такие 308 как текстовое поле, их структура объясняется ниже: дата, число, 309 время и тд.
310 311
312 var dynamicFieldFilter = {
313 {
314 "id": "",
315 "fieldId": "",
316 "type": "",
317 "value": "",
318 "numberFrom": null,
319 "numberTo": null,
320 "dateFrom": null,
321 "dateTo": null,
322 "isCurrentUser": false,
323 "businessObjectId": "",
324 "boiIds": [{"..."}],
325 "fromFields": [{"..."}],
326 "label": "",
327 "options": [{"..."}],
328 "businessFields": [{"..."}],
329 "selectedBois": [{"..."}],
330 "topLeftLat": 0,
331 "topLeftLon": 0,
332 "bottomRightLat": 0,
333 "bottomRightLon": 0
334 }
335 }
336
337
338
339
340 | Атрибут входного JSON | 344Описание | 345
|---|---|
| id | 351(String): Уникальный идентификатор фильтра. | 352
| fieldId | 356(String или null): Идентификатор поле для который применяется 357 данный фильтр (Как получить id 358 поля?) | 359
| type | 363(String): Тип поле, пример INPUT_TEXT. Подробнее о всех типах полей и какие
365 значения им передавать. |
366
| value | 370(String или null): Искомое значение для данного поле. 371 Работает только для текстовых полей или для пойска по 372 id. |
373
| numberFrom | 377(Number): Начальное числовое значение, связанное с
378 бракетом. 379 Работает только для числового поля. |
380
| numberTo | 384(Number): Конечное числовое значение, связанное с
385 бракетом. 386 Работает только для числового поля. |
387
| dateFrom | 391(Date или null): Начальная дата, связанная с бракетом. 392 Работает только для полей с датой. |
393
| dateTo | 397(Date или null): Конечная дата, связанная с бракетом. 398 Работает только для полей с датой. |
399
| isCurrentUser | 403(Boolean): Признак того, нужно ли составлять фильтр еще и по
404 текущему пользователю помимо других пользователей. 405 Работает только для полей с пользователями (Organization 406 Units). |
407
| businessObjectId | 411(String или null): Идентификатор вложенного БО внутри вашего 412 БО. При указании будут показываться его . | 413
| boiIds | 417(Массив String): Идентификаторы инстанций (вложенного)
418 бизнес-объекта, который является полем внутри вашего
419 бизнес-объекта. 420 Работает только с вложенными бизнес-объектами. Проверяет id БО 421 поля у всех инстанции вашего БО на содержание хотя бы одного 422 значения из массива boiIds. |
423
| fromFields | 427(Массив объектов): Составление для вложенных бизнес 428 объектов | 429
| label | 433(String): Текстовое обозначение поле (название) | 434
| options | 438(Массив объектов): Текстовое обозначение поле (название) | 439
| businessFields | 443(Массив объектов): Массив бизнес-полей, которые могут быть 444 связаны с бракетом. | 445
| selectedBois | 449(Массив объектов): Массив выбранных инстанций бизнес-объектов, 450 связанных с этим бракетом. | 451
| topLeftLat | 455(Double): Широта верхнего левого угла квадрата (1/4 поле, 456 для работы фильтра по карте должны быть все 4 поля) | 457
| topLeftLon | 461(Double): Долгота верхнего левого угла квадрата (2/4 поле, 462 для работы фильтра по карте должны быть все 4 поля) | 463
| bottomRightLat | 467(Double): Широта нижнего правого угла квадрата. Это 468 поле должно быть меньше чем topLeftLat. (3/4 поле, для 469 работы фильтра по карте должны быть все 4 поля) | 470
| bottomRightLon | 474(Double): Долгота нижнего правого угла квадрата. Это 475 поле должно быть меньше чем topLeftLon. (4/4 поле, для 476 работы фильтра по карте должны быть все 4 поля) | 477
Пример бракета с динамичным фильтром для текстового 482 поля
483 4841) Для того чтобы составить фильтр по текстовому полю, сперва мы 485 должны присвоить идентификатор бракету, идентификаторам будет 486 "DTb445uu".
487 488
489 var bracketJson = {
490 "id" : "DTb445uu"
491 }
492
493
494
495 2) Так как это простой фильтр (не вложенный) "parentId" 496 и "parentTreeIds" можем присвойть null.
497 498
499 var bracketJson = {
500 "id" : "DTb445uu",
501 "parentId": null,
502 "parentTreeIds": []
503 }
504
505
506
507 3) Третьем этапом мы должны определить тип связи "AND", 508 "OR".
509 510
511 var bracketJson = {
512 "id" : "DTb445uu",
513 "parentId": null,
514 "parentTreeIds": [],
515 "connectionType": "AND"
516 }
517
518
519
520 4) Объявление вложенных бракетов, мы пишем простой фильтр 521 поэтому он нам не нужен.
522 523
524 var bracketJson = {
525 "id" : "DTb445uu",
526 "parentId": null,
527 "parentTreeIds": [],
528 "connectionType": "AND",
529 "brackets": []
530 }
531
532
533
534 5) Определяем dynamicFilters:
535 536id уникальное строковое значение будет 537 "nl4Fcy3Z"
538 539fieldId нужно взять из редактора БО:
540 541
Нажимает на шестиугольник.
545 546
Как мы видим идентификатор данного поле равен 550 "nTCVOX8zaetMLFZF", а типом является INPUT_TEXT.
551 552Зная всю эту информацию, можем составить фильтр.
553 554Результат:
555 556
557 var bracketJson = {
558 {
559 "id": "DTb445uu",
560 "parentId": null,
561 "parentTreeIds": [],
562 "connectionType": "AND",
563 "brackets": [],
564 "dynamicFilters": [
565 {
566 "id": "nl4Fcy3Z",
567 "fieldId": "nTCVOX8zaetMLFZF",
568 "type": "INPUT_TEXT",
569 "value": "qwe"
570 }]
571 }
572 }
573
574
575
576 Объяснение простыми словами: Ищем у БО с 577 текстовым полем который ровняется к qwe.
578 579Внимание! Полученный JSON вставляем в массив brackets в 580 запросе для получения списка. 581 Пример:
582 583
584 {
585 "boCode": "TEST", // Код БО
586 "headCodes": ["NUMBER", "TEXT"], // Поле описано в таблице внутри "Получения списка"
587 "orderingFieldCode": "NUMBER", // Код Поля
588 "orderState": "ASC", // Поле описано в таблице внутри "Получения списка"
589 "paging": { // Поле описано в таблице для "Получения списка"
590 "offset": 0,
591 "limit": 20
592 },
593 // "filters": [{...}] // Поле описано в таблице внутри "Получения списка"
594 // "search": "1", // Поле описано в таблице внутри "Получения списка"
595 "state": "ALL",
596 "brackets" : [{ // Вставляем сделанный запрос сюда
597 "id": "DTb445uu",
598 "parentId": null,
599 "parentTreeIds": [],
600 "connectionType": "AND",
601 "brackets": [],
602 "dynamicFilters": [
603 {
604 "id": "nl4Fcy3Z",
605 "fieldId": "kUVz8yNpVG@NuISC",
606 "type": "INPUT_TEXT",
607 "value": "123"
608 }]
609 }]
610 }
611
612
613
614 Структура nativeFilters
615 616
617 var nativeFieldFilter = {
618 "id": "",
619 "type": "",
620 "value": "",
621 "dateFrom": null,
622 "dateTo": null,
623 "isCurrentUser": false,
624 "orgUnitRecords": [
625 {
626 "id": "user_id",
627 "type": "PERSON" // Другие: DEPARTMENT (Департамент), GROUP (Рабочая группа)
628 }
629 ],
630 }
631
632
633
634
635 | Атрибут входного JSON | 639Описание | 640
|---|---|
| id | 646(String): Уникальный идентификатор фильтра. | 647
| type | 651(String): Тип навтивного поле, пример
652 CREATED_BY. Подробнее о всех типах
654 нативных полей. |
655
| dateFrom | 659(Date или null): Начальная дата, связанная с бракетом. 660 Работает только для полей с датой. |
661
| dateTo | 665(Date или null): Конечная дата, связанная с бракетом. 666 Работает только для полей с датой. |
667
| isCurrentUser | 671(Boolean): Признак того, нужно ли составлять фильтр еще и по
672 текущему пользователю помимо других пользователей. 673 Работает если только в type PARTICIPANTS или 674 CREATED_BY |
675
| orgUnitRecords | 679(Массив Объектов): Организационные единицы (Пользователи,
680 Департаменты, Рабочие группы) по которым нужно сделать фильтрацию
681 на авторов или участников инстанций. 682 Работает если только в type PARTICIPANTS или 683 CREATED_BY |
684
| orgUnitRecords.id* | 688(String): Идентификатор из 24 символов конкретного 689 пользователя, департамента или рабочей группы. Подробнее 690 о том, как получить данные идентификаторы. | 691
| orgUnitRecords.type* | 695(String): Перечисление, указывающая к чему относится id: PERSON 696 (Пользователь), DEPARTMENT (Департамент), GROUP (Рабочая 697 группа) | 698
Пример бракета с нативным фильтром на поле Автор
703 7041) Для того чтобы составить фильтр по полю Автор, сперва мы 705 должны присвоить идентификатор бракету, идентификаторам будет 706 "DTb445uu".
707 708
709 var bracketJson = {
710 "id" : "DTb445uu"
711 }
712
713
714
715 2) Так как это простой фильтр (не вложенный) "parentId" 716 и "parentTreeIds" можем присвойть null.
717 718
719 var bracketJson = {
720 "id" : "DTb445uu",
721 "parentId": null,
722 "parentTreeIds": []
723 }
724
725
726
727 3) Третьем этапом мы должны определить тип связи "AND", 728 "OR".
729 730
731 var bracketJson = {
732 "id" : "DTb445uu",
733 "parentId": null,
734 "parentTreeIds": [],
735 "connectionType": "AND"
736 }
737
738
739
740 4) Объявление вложенных бракетов, мы пишем простой фильтр 741 поэтому он нам не нужен.
742 743
744 var bracketJson = {
745 "id" : "DTb445uu",
746 "parentId": null,
747 "parentTreeIds": [],
748 "connectionType": "AND",
749 "brackets": []
750 }
751
752
753
754 5) Определяем nativeFilters:
755 756id уникальное строковое значение будет 757 "nl4Fcy3Z"
758 759type будет CREATED_BY (Это вы можете узнать 760 в таблице выше)
761 762orgUnitRecords будет содержать пользователя, но 763 как вариант возможно взять целый департамент или рабочую группу. 764 Но, мы берем одного конкретного автора и не текущего, поэтому нам 765 нужно получить его 766 id и type будет Person
767 768Зная всю эту информацию, можем составить фильтр:
769 770
771 var bracketJson = {
772 {
773 "id": "DTb445uu",
774 "parentId": null,
775 "parentTreeIds": [],
776 "connectionType": "AND",
777 "brackets": [],
778 "nativeFilters": [{ // Нативный фильтр на поле "Автор"
779 "id": "nl4Fcy3Z",
780 "type": "CREATED_BY",
781 "orgUnitRecords": [
782 {
783 "id":"dPLgJxgojYu2Q0OR", // id нашего пользователя
784 "type":"PERSON"
785 }
786 ]
787 }]
788 }
789 }
790
791
792
793 Объяснение простыми словами: Ищем у БО 794 инстанцию, которую создал пользователь с id "dPLgJxgojYu2Q0OR".
795 796Внимание! Полученный JSON вставляем в массив brackets в 797 запросе для получения списка. 798 Пример:
799 800
801 {
802 "boCode": "TEST", // Код БО
803 "headCodes": ["NUMBER", "TEXT"], // Поле описано в таблице внутри "Получения списка"
804 "orderingFieldCode": "NUMBER", // Код Поля
805 "orderState": "ASC", // Поле описано в таблице внутри "Получения списка"
806 "paging": { // Поле описано в таблице для "Получения списка"
807 "offset": 0,
808 "limit": 20
809 },
810 // "filters": [{...}] // Поле описано в таблице внутри "Получения списка"
811 // "search": "1", // Поле описано в таблице внутри "Получения списка"
812 "state": "ALL",
813 "brackets" : [{ // Вставляем сделанный запрос сюда
814 "id": "DTb445uu",
815 "parentId": null,
816 "parentTreeIds": [],
817 "connectionType": "AND",
818 "brackets": [],
819 "nativeFilters": [{ // С нативным фильтром на поле "Автор"
820 "id": "nl4Fcy3Z",
821 "type": "CREATED_BY",
822 "orgUnitRecords": [
823 {
824 "id":"dPLgJxgojYu2Q0OR", // Для пользователя с этим id
825 "type":"PERSON"
826 }
827 ]
828 }]
829 }]
830 }
831
832
833