Виджеты в домене

Этот раздел описывает виджеты в представлениях сущностей домена.

Ознакомьтесь с правилами нотации в схеме домена. Это позволит присваивать корректные названия создаваемым элементам схемы. Эти названия будут отображаться в интерфейсе системы.

Структура поля `widgets`

Путь в схеме: views[].widgets[]

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

Описание каждого виджета включает следующие поля:

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`id`	Да	Уникальный идентификатор виджета.	View ID
`type`	Да	Тип виджета. Определяет, какие специфические поля будут применяться. Ознакомьтесь со списком доступных типов.	перечисление
`description`	Нет	Описание виджета.	строка

id

Да

Уникальный идентификатор виджета.

View ID

type

Да

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

перечисление

description

Нет

Описание виджета.

строка

Типы виджетов (`type`)

Поле type в записи виджета может принимать следующие значения:

attribute — виджет атрибута, позволяющий отображать и редактировать значение атрибута объекта;
action — виджет действия, позволяющий запускать действие с передачей контекста;
linkage — виджет связи, позволяющий отображать и менять список связанных объектов;
linkage_list — виджет списка связей;
linked_objects_groups — виджет группировки связанных объектов, отображающий таблицу со сгруппированными данными;
join — виджет транзитивных связей;
visualization — виджет графического отображения;
history — виджет истории изменений, отображающий события аудита;
runs_history — виджет со списком запусков плейбуков и скриптов, производивших действия с объектом;
comments — виджет комментариев;
card — виджет для дашбордов;
conversation — виджет переписок.

Виджет атрибута (`type: attribute`)

Определение виджета атрибута включает общие поля для виджетов всех типов, поля, специфические для виджетов атрибутов, и поля, зависящие от типа атрибута.

Общие поля виджетов атрибутов

Описание всех виджетов типа attribute включает следующие поля:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`attribute`	да	Data ID Ref	Ссылка на атрибут сущности, значение которого будет отображаться и редактироваться. Могут использоваться системные атрибуты.
`control`	нет (по умолчанию: определяется автоматически)	объект	Элемент управления для отображения атрибута. Ознакомьтесь с описанием поля `control`.

attribute

да

Data ID Ref

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

control

нет (по умолчанию: определяется автоматически)

объект

Элемент управления для отображения атрибута.

Ознакомьтесь с описанием поля control.

Настройки элемента управления в виджете атрибута (`control`)

Путь в схеме: views[].widgets[].control

Поле имеет следующую структуру:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`type`	нет (по умолчанию — вычисляется автоматически)	перечисление	Тип редактора, используемый в столбце, в соответствии с таблицей.
`text`	нет	строка	Текст в области перетаскивания. Доступно для атрибутов с типом `Attachment` и массивов из элементов с типом `Attachment`, если указан `type: drag_drop_area`.
`trueText`	да (при `type: bool_text`)	строка	Отображаемая строка для значения `True`.
`falseText`	да (при `type: bool_text`)	строка	Отображаемая строка для значения `False`.
`step`	да (при `type: slider`)	число	Шаг при перемещении ползунка.

type

нет (по умолчанию — вычисляется автоматически)

перечисление

Тип редактора, используемый в столбце, в соответствии с таблицей.

text

нет

строка

Текст в области перетаскивания. Доступно для атрибутов с типом Attachment и массивов из элементов с типом Attachment, если указан type: drag_drop_area.

trueText

да (при type: bool_text)

строка

Отображаемая строка для значения True.

falseText

да (при type: bool_text)

строка

Отображаемая строка для значения False.

step

да (при type: slider)

число

Шаг при перемещении ползунка.

Настройки виджета атрибута типа `Array`

Описание виджета атрибута типа Array дополнительно содержит следующее поле:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`rowHeight`	нет	целое число	Высота поля по умолчанию, определенная в количестве текстовых строк.

rowHeight

нет

целое число

Высота поля по умолчанию, определенная в количестве текстовых строк.

Настройки виджета атрибута типа `Counter`

Описание виджета атрибута типа Counter дополнительно содержит следующее поле:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`counterColorPattern`	нет	Data ID Ref или FQDN	Ссылка на правило цветовой схемы счетчика.

counterColorPattern

нет

Data ID Ref или FQDN

Ссылка на правило цветовой схемы счетчика.

Настройки виджета атрибута типа `RQL`

Описание виджета атрибута типа RQL дополнительно содержит следующие поля:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`include`	нет	массив	Список доменов, сущностей, атрибутов и связей, доступных пользователю при составлении RQL-выражения. Доступно, если атрибут имеет тип `RQL` и не указано поле `exclude`. Ознакомьтесь с описанием поля `include`.
`exclude`	нет	массив	Список доменов, сущностей, атрибутов и связей, недоступных пользователю при составлении RQL-выражения. Доступно, если атрибут имеет тип `RQL` и не указано поле `include`. Ознакомьтесь с описанием поля `exclude`.

include

нет

массив

Список доменов, сущностей, атрибутов и связей, доступных пользователю при составлении RQL-выражения. Доступно, если атрибут имеет тип RQL и не указано поле exclude.

Ознакомьтесь с описанием поля include.

exclude

нет

массив

Список доменов, сущностей, атрибутов и связей, недоступных пользователю при составлении RQL-выражения. Доступно, если атрибут имеет тип RQL и не указано поле include.

Ознакомьтесь с описанием поля exclude.

Выбор элементов в редакторе RQL

Путь в схеме:

views[].widgets[].include[];
views[].widgets[].exclude[].

Поля include и exclude определяют выбор пользователем доменов, сущностей, связей и атрибутов в редакторе атрибута типа RQL. В схеме виджета может быть задано только одно из этих полей:

Если задан include, выбор ограничен только указанными элементами.
Если задан exclude, в редакторе можно выбирать все доступные элементы, кроме указанных в поле.

Если в массиве include или exclude для сущности не указаны атрибуты и связи, это равносильно перечислению всех доступных элементов.

Каждый элемент массивов имеет следующую структуру:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`domain`	да	FQID	Домен, доступный в редакторе RQL.
`entities`	нет	массив	Список сущностей, доступных в редакторе RQL. Ознакомьтесь с описанием поля `entities`.

domain

да

FQID

Домен, доступный в редакторе RQL.

entities

нет

массив

Список сущностей, доступных в редакторе RQL.

Ознакомьтесь с описанием поля entities.

Список сущностей в редакторе RQL (`entities`)

Путь в схеме:

views[].widgets[].include[].entities[];
views[].widgets[].exclude[].entities[].

Каждый элемент массива имеет следующую структуру:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`entity`	да	Data ID Ref	Идентификатор сущности домена.
`attributes`	нет (по умолчанию: все атрибуты)	массив	Массив ссылок на атрибуты сущности в формате `attribute: <Data ID Ref или FQID>`.
`linkages`	нет (по умолчанию: все связи и атрибуты связанных сущностей)	массив	Список связей текущей сущности. Ознакомьтесь с описанием поля `linkages`.

entity

да

Data ID Ref

Идентификатор сущности домена.

attributes

нет (по умолчанию: все атрибуты)

массив

Массив ссылок на атрибуты сущности в формате attribute: <Data ID Ref или FQID>.

linkages

нет (по умолчанию: все связи и атрибуты связанных сущностей)

массив

Список связей текущей сущности.

Ознакомьтесь с описанием поля linkages.

Список связей в редакторе RQL (`linkages`)

Путь в схеме:

views[].widgets[].include[].entities[].linkages[];
views[].widgets[].exclude[].entities[].linkages[].

Каждый элемент массива имеет следующую структуру:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`side`	нет (по умолчанию — `1`)	перечисление	Сторона связи.
`linkage`	да	Data ID Ref или FQID	Идентификатор связи.
`EntityAttributes`	нет	массив	Массив атрибутов связанной сущности в формате `attribute: <Data Ref ID или FQID>`.

side

нет (по умолчанию — 1)

перечисление

Сторона связи.

linkage

да

Data ID Ref или FQID

Идентификатор связи.

EntityAttributes

нет

массив

Массив атрибутов связанной сущности в формате attribute: <Data Ref ID или FQID>.

Настройки виджета атрибута типа `Table`

Настройки отображения таблицы задаются в поле view описания пользовательского атрибута-таблицы.

Пример виджетов системных атрибутов

views:
    widgets:
      - id: entity_name_widget
        type: attribute
        # Объявлять системные атрибуты в поле attribute не нужно.
        attribute: entityName

      - id: entity_id_widget
        type: attribute
        attribute: entityId

Пример виджета пользовательского атрибута

views:
    widgets:
        # Идентификатор виджета.
        - id: deviceModelEditor
          # Тип виджета атрибута.
          type: attribute
          # Идентификатор атрибута (должен быть предварительно объявлен).
          attribute: deviceModel
          # Описание виджета
          description: Поле для редактирования наименования модели оборудования

Пример виджета пользовательского атрибута с настройкой элемента управления

views:
    widgets:
        # Идентификатор виджета.
        - id: eNum
          # Тип виджета атрибута.
          type: attribute
          # Идентификатор атрибута уровня критичности.
          attribute: severity
          control:
              # Тип элемента управления.
              type: select
          # Описание виджета.
          description: Поле для редактирования уровня критичности

Пример описания виджета с областью для загрузки

- id: attach_widget
  type: attribute
  attribute: arrayDocuments
  description: Массив документов
  control:
    type: drag_drop_area
    text: Перетащите файлы для загрузки

Виджет действий (`type: action`)

Описание виджета типа action дополнительно включает поля:

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`action`	Да (если `actions` не задано)	Ссылка на одно действие, которое будет выполняться. Нельзя использовать одновременно с `actions`.	View ID Ref
`actions`	Да (если `action` не задано)	Массив ссылок на действия. Формирует выпадающее меню. Нельзя использовать одновременно с `action`.	массив ссылок
`control`	Нет	Элемент управления. Ознакомьтесь с описанием поля `control`.	объект

action

Да (если actions не задано)

Ссылка на одно действие, которое будет выполняться. Нельзя использовать одновременно с actions.

View ID Ref

actions

Да (если action не задано)

Массив ссылок на действия. Формирует выпадающее меню. Нельзя использовать одновременно с action.

массив ссылок

control

Нет

Элемент управления.

Ознакомьтесь с описанием поля control.

объект

Настройки элемента управления в виджете действия (`control`)

Путь в схеме: views[].widgets[].control

Поле имеет следующую структуру:

Поле Обязательное поле Описание Тип данных

Поле	Обязательное поле	Описание	Тип данных
`type`	нет	Тип элемента управления. Допустимые значения: `regular_button` — кнопка; `dropdown` (доступно, если действие имеет `type: bulk` и `operation: edit_attribute`) — выпадающий список; `drag_drop_area` (доступно, если действие имеет тип `type: playbook`) — область перетаскивания для загрузки файлов. При нажатии на кнопку Сохранить в виджете запускается плейбук, куда в качестве контекста передаются загруженные файлы.	перечисление
`icon`	нет	Ссылка на идентификатор медиаресурса (иконки). Доступно, если указан `type: regular_button`.	View ID Ref
`text`	нет	Текст в области перетаскивания. Доступно, если указан `type: drag_drop_area`.	строка

type

нет

Тип элемента управления. Допустимые значения:

regular_button — кнопка;
dropdown (доступно, если действие имеет type: bulk и operation: edit_attribute) — выпадающий список;
drag_drop_area (доступно, если действие имеет тип type: playbook) — область перетаскивания для загрузки файлов.

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

перечисление

icon

нет

Ссылка на идентификатор медиаресурса (иконки). Доступно, если указан type: regular_button.

View ID Ref

text

нет

Текст в области перетаскивания. Доступно, если указан type: drag_drop_area.

строка

Виджет связи (`type: linkage`)

Описание каждого виджета типа linkage дополнительно включает поля:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`linkage`	да	Data ID Ref	Ссылка на связь сущности, состав которой будет отображаться и редактироваться.
`side`	нет (по умолчанию: `2`) да (для внешней связи)	перечисление	Сторона связи. Возможные значения: `1` — виджет отображает сторону 1 (один объект). `2` — виджет отображает сторону 2 (несколько объектов).
`label`	нет (по умолчанию: пустая строка)	строка	Наименование связи, отображаемое в виджете. Ознакомьтесь с описанием поля `label`.
`control`	нет (по умолчанию: вычисляется автоматически)	перечисление	Элемент управления для отображения связи. В зависимости от выбранного редактора описание виджета может включать дополнительные поля. Ознакомьтесь с описанием поля `control`
`attributes`	нет	массив	Атрибуты, отображаемые в виджете связи. Ознакомьтесь с описанием поля `attributes`.

linkage

да

Data ID Ref

Ссылка на связь сущности, состав которой будет отображаться и редактироваться.

side

нет (по умолчанию: 2)

да (для внешней связи)

перечисление

Сторона связи. Возможные значения:

1 — виджет отображает сторону 1 (один объект).
2 — виджет отображает сторону 2 (несколько объектов).

label

нет (по умолчанию: пустая строка)

строка

Наименование связи, отображаемое в виджете.

Ознакомьтесь с описанием поля label.

control

нет (по умолчанию: вычисляется автоматически)

перечисление

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

Ознакомьтесь с описанием поля control

attributes

нет

массив

Атрибуты, отображаемые в виджете связи. Ознакомьтесь с описанием поля attributes.

Редактор связей (`control`)

Путь в схеме: view[].widgets[].control

Доступные значения поля control:

select — для связей 1-1 или 1-N, если указана сторона 1 (side: 1).
multi_select — компактный редактор для связей N-N или 1-N со стороны 2 (side: 2).
table — расширенный редактор для связей N-N или 1-N со стороны 2 (side: 2).

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

Настройки для расширенного редактора связи (`control: table`)

Если в виджете связи указан редактор table, описание виджета дополнительно включает поля:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`addLinksView`	нет	View ID Ref	Ссылка на списочное представление сущности, отображаемое в модальном окне создания связи при работе в расширенном редакторе.
`columns`	да	массив	Массив записей с описанием колонок таблицы. Ознакомьтесь с описанием поля `columns`.
`sortingBy`	нет (по умолчанию: автоматическая сортировка)	массив	Массив ссылок на правила сортировки атрибутов сущности. Если хотя бы одно правило сортировки не определено в схеме домена, система сортирует связи в таблице по времени поступившей о них информации за секундный интервал и далее по идентификатору связи. Ознакомьтесь с описанием сортировки в таблицах.
`paging`	нет	объект	Ознакомьтесь с описанием `пагинации в таблицах`.

addLinksView

нет

View ID Ref

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

columns

да

массив

Массив записей с описанием колонок таблицы.

Ознакомьтесь с описанием поля columns.

sortingBy

нет (по умолчанию: автоматическая сортировка)

массив

Массив ссылок на правила сортировки атрибутов сущности.

Если хотя бы одно правило сортировки не определено в схеме домена, система сортирует связи в таблице по времени поступившей о них информации за секундный интервал и далее по идентификатору связи.

Ознакомьтесь с описанием сортировки в таблицах.

paging

нет

объект

Ознакомьтесь с описанием пагинации в таблицах.

Столбцы таблицы в виджете связей (`columns`)

Путь в схеме: view[].widgets[].columns[]

Каждый элемент массива имеет следующую структуру:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`id`	да	View ID	Идентификатор столбца таблицы, который отображается в его заголовке.
`attribute`	да	Data ID Ref	Ссылка на атрибут, который отображается в столбце таблицы. Допустимые значения: атрибут сущности; системный атрибут сущности; атрибут связи; системный атрибут связи.

id

да

View ID

Идентификатор столбца таблицы, который отображается в его заголовке.

attribute

да

Data ID Ref

Ссылка на атрибут, который отображается в столбце таблицы.

Допустимые значения:

атрибут сущности;
системный атрибут сущности;
атрибут связи;
системный атрибут связи.

Атрибуты связи для отображения в виджете (`attributes`)

Путь в схеме: view[].widgets[].attributes[]

Каждый элемент массива имеет следующую структуру:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`attribute`	да	Data ID Ref	Идентификатор атрибута связи. Допустимые значения: идентификатор атрибута, определенного в поле `linkages`; идентификатор системного атрибута связи.
`label`	нет (по умолчанию: значение `name` атрибута)	строка	Название атрибута в UI Ознакомьтесь с описанием поля `label`.
`control`	нет (по умолчанию: вычисляется автоматически)	объект	Настройки элемента управления. Ознакомьтесь с описанием поля `control`.

attribute

да

Data ID Ref

Идентификатор атрибута связи. Допустимые значения:

идентификатор атрибута, определенного в поле linkages;
идентификатор системного атрибута связи.

label

нет (по умолчанию: значение name атрибута)

строка

Название атрибута в UI

Ознакомьтесь с описанием поля label.

control

нет (по умолчанию: вычисляется автоматически)

объект

Настройки элемента управления. Ознакомьтесь с описанием поля control.

Элемент управления атрибута связи (`control`)

Путь в схеме: view[].widgets[].attributes[].control

Поле имеет следующую структуру:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`type`	нет (по умолчанию: вычисляется автоматически)	перечисление	Элемент управления. Доступны элементы, соответствующие типу данных атрибута при использовании в таблицах и массивах.
`view`	нет	View ID Ref	Представление для выбора сущностей.
`editable`	нет (по умолчанию: `true`)	логическое	Переключатель возможности редактирования.

type

нет (по умолчанию: вычисляется автоматически)

перечисление

Элемент управления. Доступны элементы, соответствующие типу данных атрибута при использовании в таблицах и массивах.

view

нет

View ID Ref

Представление для выбора сущностей.

editable

нет (по умолчанию: true)

логическое

Переключатель возможности редактирования.

Виджет списка связей (`type: linkage_list`)

Описание виджета типа linkage_list дополнительно включает поля:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`entity_lists`	нет	объект	Ссылки на списочные представления сущностей для отображения атрибутов в виджете. Ознакомьтесь с описанием поля `entity_lists`.
`rules`	нет	объект	Правила, определяющие, какие связи доступны для просмотра и редактирования. Если не заполнено, доступны все связи. Может содержать только один из двух массивов: `includes` — правила включения. Ознакомьтесь с описанием поля `includes`; `excludes` — правила исключения. Ознакомьтесь с описанием поля `excludes`.

entity_lists

нет

объект

Ссылки на списочные представления сущностей для отображения атрибутов в виджете.

Ознакомьтесь с описанием поля entity_lists.

rules

нет

объект

Правила, определяющие, какие связи доступны для просмотра и редактирования. Если не заполнено, доступны все связи.

Может содержать только один из двух массивов:

includes — правила включения. Ознакомьтесь с описанием поля includes;
excludes — правила исключения. Ознакомьтесь с описанием поля excludes.

Ссылки на списочное представление сущности (`entity_lists`)

Путь в схеме: views[].widgets[].entity_lists

Поле entity_lists содержит массив ссылок на списочное представление сущности. Каждый элемент массива имеет следующую структуру:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`entity`	да	Data ID Ref	Ссылка на сущность, для которой будут отображаться дополнительны поля.
`list`	да	View ID Ref	Ссылка на списочное представление сущности. Для каждой сущности можно указать только одну ссылку на списочное представление.

entity

да

Data ID Ref

Ссылка на сущность, для которой будут отображаться дополнительны поля.

list

да

View ID Ref

Ссылка на списочное представление сущности.

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

Правила включения связей (`includes`)

Путь в схеме: views[].widgets[].rules.includes[]

Поле includes содержит массив правил включения связей в виджет. Каждый элемент массива имеет следующую структуру:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`id`	да	FQID	Домен, для которого применяются правила включения
`only`	нет	массив Data ID Ref	Список связей домена. Если указано, включаются только эти связи домена. Доступно, если не указано поле `except`.
`except`	нет	массив Data ID Ref	Список связей домена. Если указано, включаются все связи домена, кроме перечисленных. Доступно, если не указано поле `only`.

id

да

FQID

Домен, для которого применяются правила включения

only

нет

массив Data ID Ref

Список связей домена. Если указано, включаются только эти связи домена.

Доступно, если не указано поле except.

except

нет

массив Data ID Ref

Список связей домена. Если указано, включаются все связи домена, кроме перечисленных.

Доступно, если не указано поле only.

Правила исключения связей (`excludes`)

Путь в схеме: views[].widgets[].rules.excludes[]

Поле excludes содержит массив правил исключения связей из виджета. Каждый элемент массива имеет следующую структуру:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`id`	да	FQID	Домен, для которого применяются правила исключения.
`only`	нет	массив Data ID Ref	Список связей домена. Если указано, исключаются только эти связи домена. Доступно, если не указано поле `except`.
`except`	нет	массив Data ID Ref	Список связей домена. Если указано, исключаются все связи домена, кроме перечисленных. Доступно, если не указано поле `only`.

id

да

FQID

Домен, для которого применяются правила исключения.

only

нет

массив Data ID Ref

Список связей домена. Если указано, исключаются только эти связи домена.

Доступно, если не указано поле except.

except

нет

массив Data ID Ref

Список связей домена. Если указано, исключаются все связи домена, кроме перечисленных.

Доступно, если не указано поле only.

Виджет группировки связанных объектов (`type: linked_objects_groups`)

Описание виджета типа linked_objects_groups дополнительно включает поля:

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`linkages`	Да	Массив ссылок на связи, по которым производится выборка объектов. Ознакомьтесь с описанием поля `linkages`.	массив
`groupingBy`	Да	Массив полей `attribute` со ссылками на атрибуты сущностей, по которым будет происходить группировка записей в таблице виджета. Допустимо использовать обычные и системные атрибуты.	массив
`control`	Нет (по умолчанию: `table`)	Элемент управления (редактор) для виджета. Доступное значение: `table`.	строка
`columns`	Да (при `control: table`)	Массив записей с описанием столбцов таблицы. Ознакомьтесь с описанием поля `columns`.	массив
`sortingBy`	Нет (при `control: table`)	Массив ссылок на правила сортировки атрибутов сущности. Ознакомьтесь с описанием поля `sortingBy`.	объект
`paging`	Нет (при `control: table`)	Настройки постраничной навигации. Ознакомьтесь с описанием поля `paging`.	объект

linkages

Да

Массив ссылок на связи, по которым производится выборка объектов. Ознакомьтесь с описанием поля linkages.

массив

groupingBy

Да

Массив полей attribute со ссылками на атрибуты сущностей, по которым будет происходить группировка записей в таблице виджета. Допустимо использовать обычные и системные атрибуты.

массив

control

Нет (по умолчанию: table)

Элемент управления (редактор) для виджета. Доступное значение: table.

строка

columns

Да (при control: table)

Массив записей с описанием столбцов таблицы. Ознакомьтесь с описанием поля columns.

массив

sortingBy

Нет (при control: table)

Массив ссылок на правила сортировки атрибутов сущности. Ознакомьтесь с описанием поля sortingBy.

объект

paging

Нет (при control: table)

Настройки постраничной навигации. Ознакомьтесь с описанием поля paging.

объект

Список связей (`linkages`)

Путь в схеме: views[].widgets[].linkages[]

Поле linkages содержит массив ссылок на связи. Каждый элемент массива имеет следующую структуру:

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`linkage`	Да	Ссылка на связь.	Data ID Ref
`side`	Нет (по умолчанию: `2`)	Сторона связи. Поле игнорируется, если связь симметричная или направленная. Доступные значения: `1` — виджет отображает сторону связи 1, а сам объект представления находится на стороне 2; `2` — виджет отображает сторону связи 2, а сам объект представления находится на стороне 1.	перечисление

linkage

Да

Ссылка на связь.

Data ID Ref

side

Нет (по умолчанию: 2)

Сторона связи. Поле игнорируется, если связь симметричная или направленная. Доступные значения:

1 — виджет отображает сторону связи 1, а сам объект представления находится на стороне 2;
2 — виджет отображает сторону связи 2, а сам объект представления находится на стороне 1.

перечисление

Столбцы (`columns`)

Путь в схеме: views[].widgets[].columns

Поле columns содержит массив записей с описанием столбцов таблицы виджета. Каждый элемент массива имеет следующую структуру:

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`id`	Да	Идентификатор колонки таблицы.	View ID
`attribute`	Да	Ссылка на атрибут, который будет отображен в колонке таблицы. Допустимые значения: атрибут сущности; системный атрибут сущности; `totalCount` — атрибут для вывода общего количества уникальных записей после группировки.	Data ID Ref
`labels`	Нет	Наименование столбца.	строка

id

Да

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

View ID

attribute

Да

Ссылка на атрибут, который будет отображен в колонке таблицы. Допустимые значения:

атрибут сущности;
системный атрибут сущности;
totalCount — атрибут для вывода общего количества уникальных записей после группировки.

Data ID Ref

labels

Нет

Наименование столбца.

строка

Чтобы работал переход из таблицы на списочное представление при нажатии на totalCount, укажите для каждого типа сущности в действии open_list поле widgetId с id текущего виджета.

Структура `sortingBy` (в виджете группировки)

Путь в схеме: views[].widgets[].sortingBy

Поле sortingBy содержит описание сортировки в столбцах таблицы. Поле имеет следующую структуру:

Поле Обязательное поле Значение по умолчанию Описание Тип данных Комментарий

Поле	Обязательное поле	Значение по умолчанию	Описание	Тип данных	Комментарий
`columns`	да		Массив записей столбцов, для которых возможна сортировка в таблице.	массив
`default`	нет		Столбец и направление сортировки по умолчанию.	объект

columns

да

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

массив

default

нет

Столбец и направление сортировки по умолчанию.

объект

Сортировка в столбце

Путь в схеме:

views[].widgets[].columns[]
views[].widgets[].default

Каждый элемент массива columns и поле default имеют следующую структуру:

Поле Обязательное поле Описание Тип данных

Поле	Обязательное поле	Описание	Тип данных
`column`	Да	Столбец, по которому выполняется сортировка	View ID Ref
`direction`	Да	направление сортировки: `asc` — сортировка по возрастанию; `desc` — сортировка по убыванию.	перечисление

column

Да

Столбец, по которому выполняется сортировка

View ID Ref

direction

Да

направление сортировки:

asc — сортировка по возрастанию;
desc — сортировка по убыванию.

перечисление

Настройки количества записей в таблице (`paging`)

Путь в схеме: views[].widgets[].paging

Поле paging содержит настройки количества записей, показываемых в таблице. Поле имеет следующую структуру:

Поле Обязательное поле Значение по умолчанию Описание Тип данных Комментарий

Поле	Обязательное поле	Значение по умолчанию	Описание	Тип данных	Комментарий
`sizes`	да		Количество записей, показываемых в таблице.	массив целых положительных чисел	В этом поле указываются варианты количества записей, доступные для выбора в настройке. Например, `[10, 50, 100]`.
`defaultSize`	да		Количество записей, показываемых по умолчанию.	целое положительное число

sizes

да

Количество записей, показываемых в таблице.

массив целых положительных чисел

В этом поле указываются варианты количества записей, доступные для выбора в настройке. Например, [10, 50, 100].

defaultSize

да

Количество записей, показываемых по умолчанию.

целое положительное число

Виджет транзитивных связей (`type: join`)

Описание виджета типа join дополнительно включает поля:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`joinId`	да	Data ID Ref	Идентификатор присоединения связи.
`attribute`	да	Data ID Ref	Ссылка на атрибут транзитивно связанной сущности, который отображается в виджете. Поддерживаются обычные и системные атрибуты.

joinId

да

Data ID Ref

Идентификатор присоединения связи.

attribute

да

Data ID Ref

Ссылка на атрибут транзитивно связанной сущности, который отображается в виджете. Поддерживаются обычные и системные атрибуты.

Виджет визуализации (`type: visualization`)

Описание виджета типа visualization дополнительно включает поля:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`name`	нет	строка	Название визуализации.
`autoUpdate`	нет	объект	Настройки автоматического обновления данных виджета. Ознакомьтесь с описанием `параметров времени`.
`variables`	да	объект	Параметры запроса данных для виджета. Ознакомьтесь с описанием поля `variables`.

name

нет

строка

Название визуализации.

autoUpdate

нет

объект

Настройки автоматического обновления данных виджета.

Ознакомьтесь с описанием параметров времени.

variables

да

объект

Параметры запроса данных для виджета.

Ознакомьтесь с описанием поля variables.

Параметры построения визуализации (`variables`)

Путь в схеме: views[].widgets[].variables

Поле variables содержит параметры построения визуализации. Поле имеет следующую структуру:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`rql`	да	RQL-запрос	Запрос для построения визуализации. Должен содержать конструкцию вида: `n =%{{n}}%` Здесь поле `n` соответствует `id` сущности домена.
`arguments`	да	массив	Массив атрибутов сущности, используемых как переменные в RQL-запросе.
`last`	да	объект	Временной период отображения данных. Ознакомьтесь с описанием `параметров времени`.
`limit`	да	целое число	Ограничение на количество строк в результате RQL-запроса.
`source`	да	перечисление	Тип источника данных. Устанавливается значение `search`.
`chartType`	да	перечисление	Тип визуализации. Доступные значения: `BAR_CHART` — столбчатая диаграмма; `LINE_CHART` — график; `PIE_CHART` — круговая диаграмма; `STACKED_BAR_CHART` — столбчатая диаграмма с накоплением; `TABLE` — таблица; `TOTAL` — итог.
`searchEntity`	да	массив	Имя переменной, соответствующей хранилищу событий или активному списку. Ознакомьтесь с описанием поля `searchEntity`.
`nameMapping`	да	массив	Сопоставление полей данных с элементами графика (оси, группировка). Ознакомьтесь с описанием поля `nameMapping`.

rql

да

RQL-запрос

Запрос для построения визуализации. Должен содержать конструкцию вида:

n =%{{n}}%

Здесь поле n соответствует id сущности домена.

arguments

да

массив

Массив атрибутов сущности, используемых как переменные в RQL-запросе.

last

да

объект

Временной период отображения данных.

Ознакомьтесь с описанием параметров времени.

limit

да

целое число

Ограничение на количество строк в результате RQL-запроса.

source

да

перечисление

Тип источника данных. Устанавливается значение search.

chartType

да

перечисление

Тип визуализации. Доступные значения:

BAR_CHART — столбчатая диаграмма;
LINE_CHART — график;
PIE_CHART — круговая диаграмма;
STACKED_BAR_CHART — столбчатая диаграмма с накоплением;
TABLE — таблица;
TOTAL — итог.

searchEntity

да

массив

Имя переменной, соответствующей хранилищу событий или активному списку.

Ознакомьтесь с описанием поля searchEntity.

nameMapping

да

массив

Сопоставление полей данных с элементами графика (оси, группировка).

Ознакомьтесь с описанием поля nameMapping.

Источник данных (`searchEntity`)

Путь в схеме: views[].widgets[].variables.searchEntity

Поле имеет следующую структуру:

Поле Описание Тип данных Комментарий

Поле	Описание	Тип данных	Комментарий
`id`	Идентификатор записи источника (активного списка или хранилища событий)	строка
`type`	Тип источника	enum	Доступные значения: `active_list` `event_storage`

id

Идентификатор записи источника (активного списка или хранилища событий)

строка

type

Тип источника

enum

Доступные значения:

active_list
event_storage

Сопоставление полей (`nameMapping`)

Путь в схеме: views[].widgets[].variables.nameMapping[]

Поле nameMapping содержит массив объектов с парами значений key—value, которые зависят от типа визуализации. Поле может содержать несколько пар "ключ — значение". Каждый элемент массива имеет следующую структуру:

Поле Обязательное поле Тип данных Комментарий

Поле	Обязательное поле	Тип данных	Комментарий
`key`	да	строка	Если в поле `chartType` установлено значение `BAR_CHART`, `LINE_CHART` или `STACKED_BAR_CHART`, доступны значения: `x` — ось x; `y` — ось y; `group_by` — группировка. Если `chartType` = `PIE_CHART`, доступны значения: `label` — ось x; `value` — ось y; Если `chartType` = `TOTAL`, устанавливается значение `value`. Если `chartType` = `TABLE`, указывается название столбца таблицы.
`value`	да	строка	Если в поле `chartType` установлено значение `BAR_CHART`, `LINE_CHART`, `STACKED_BAR_CHART` или `PIE_CHART`, указывается поле запроса, из которого берется значение для указанного ключа. Если `chartType` = `TOTAL`, указывается поле запроса, по которому считается общее значение. Если `chartType` = `TABLE`, указывается поле запроса, из которого берется значение для указанного столбца.

key

да

строка

Если в поле chartType установлено значение BAR_CHART, LINE_CHART или STACKED_BAR_CHART, доступны значения:

x — ось x;
y — ось y;
group_by — группировка.

Если chartType = PIE_CHART, доступны значения:

label — ось x;
value — ось y;

Если chartType = TOTAL, устанавливается значение value.

Если chartType = TABLE, указывается название столбца таблицы.

value

да

строка

Если в поле chartType установлено значение BAR_CHART, LINE_CHART, STACKED_BAR_CHART или PIE_CHART, указывается поле запроса, из которого берется значение для указанного ключа.

Если chartType = TOTAL, указывается поле запроса, по которому считается общее значение.

Если chartType = TABLE, указывается поле запроса, из которого берется значение для указанного столбца.

Путь в схеме:

views[].widgets[].autoUpdate
views[].widgets[].variables.last

Поле last содержит настройки периода, за который отображаются данные в виджете, а поле autoUpdate — настройки автоматического обновления данных. Поля имеют следующую структуру:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`unit`	да	перечисление	Единица измерения периода формирования визуализации. Доступные значения: `DAY` — сутки; `HOUR` — час; `MINUTE` — минута; `MONTH` — месяц (30 дней); `YEAR` — год.
`value`	да	целое положительное число	Длительность измерения периода.

unit

да

перечисление

Единица измерения периода формирования визуализации.

Доступные значения:

DAY — сутки;
HOUR — час;
MINUTE — минута;
MONTH — месяц (30 дней);
YEAR — год.

value

да

целое положительное число

Длительность измерения периода.

Виджет истории (`type: history`)

Описание виджета типа history дополнительно включает поля:

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`eventStorageId`	Да	Идентификатор хранилища событий, из которого загружаются события для отображения.	строка

eventStorageId

Да

Идентификатор хранилища событий, из которого загружаются события для отображения.

строка

Виджет истории запусков (`type: run_history`)

Описание виджета типа run_history дополнительно включает поля:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`playbooks`	нет	объект	Настройка списка плейбуков, запуски которых должны отображаться в виджете.

playbooks

нет

объект

Настройка списка плейбуков, запуски которых должны отображаться в виджете.

Если поле playbooks не задано, в виджете будут отображаться все плейбуки и скрипты, производившие действия с объектом, без ограничения.

Поле playbooks может содержать только один из двух блоков:

include — список плейбуков и скриптов, которые нужно отображать;
exclude — список плейбуков и скриптов, которые нужно исключить из отображения.

Каждый из блоков является массивом полей playbook со строкой — идентификатором плейбука или скрипта.

Виджет типа runs_history рекомендуется размещать на панели объекта отдельно:

Блок включает только этот виджет.
На вкладке находится только один блок с виджетом.

Виджет комментариев (`type: comments`)

Виджет типа comments использует только общие поля, описанные в разделе Общие поля для всех типов виджетов. Дополнительных полей для этого типа не требуется.

Виджет дашборда (`type: card`)

Описание виджета типа card дополнительно включает поля:

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`icon`	Нет	Ссылка на идентификатор медиаресурса (иконки).	View ID Ref
`action`	Да	Ссылка на действие, которое будет запускаться при клике на виджет.	View ID Ref

icon

Нет

Ссылка на идентификатор медиаресурса (иконки).

View ID Ref

action

Да

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

View ID Ref

Виджет переписок (`type: conversation`)

Описание виджета типа conversation дополнительно включает поля:

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`linkage`	Да	Ссылка на связь сущности из текущего домена с сущностью `Message`.	Data ID Ref
`conversationTransports`	Нет	Массив для ограничения доступных транспортов (например, только email). Если не указан, доступны все транспорты.	массив

linkage

Да

Ссылка на связь сущности из текущего домена с сущностью Message.

Data ID Ref

conversationTransports

Нет

Массив для ограничения доступных транспортов (например, только email). Если не указан, доступны все транспорты.

массив

Сторонние виджеты

Сторонние виджеты не являются частью ядра системы и не описываются в схеме домена. Сторонний виджет заранее регистрируется в системе через API. Виджету нужно присваивать уникальный идентификатор. При повторной регистрации с тем же идентификатором данные о виджете переопределяются.

После регистрации через API сторонние виджеты можно использовать в представлениях сущностей. Для обращения к ним надо использовать идентификатор, заданный при регистрации: external:<id виджета>.

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

Была ли полезна эта страница?

Обратная связь

Виджеты в домене

Структура поля widgets

Общие поля для всех типов виджетов

Типы виджетов (type)

Виджет атрибута (type: attribute)

Общие поля виджетов атрибутов

Настройки элемента управления в виджете атрибута (control)

Настройки виджета атрибута типа Array

Настройки виджета атрибута типа Counter

Настройки виджета атрибута типа RQL

Выбор элементов в редакторе RQL

Список сущностей в редакторе RQL (entities)

Список связей в редакторе RQL (linkages)

Настройки виджета атрибута типа Table

Примеры виджетов атрибутов

Виджет действий (type: action)

Настройки элемента управления в виджете действия (control)

Виджет связи (type: linkage)

Редактор связей (control)

Настройки для расширенного редактора связи (control: table)

Столбцы таблицы в виджете связей (columns)

Атрибуты связи для отображения в виджете (attributes)

Элемент управления атрибута связи (control)

Виджет списка связей (type: linkage_list)

Ссылки на списочное представление сущности (entity_lists)

Правила включения связей (includes)

Правила исключения связей (excludes)

Виджет группировки связанных объектов (type: linked_objects_groups)

Список связей (linkages)

Столбцы (columns)

Структура sortingBy (в виджете группировки)

Сортировка в столбце

Настройки количества записей в таблице (paging)

Виджет транзитивных связей (type: join)

Виджет визуализации (type: visualization)

Параметры построения визуализации (variables)

Источник данных (searchEntity)

Сопоставление полей (nameMapping)

Параметры времени в виджете визуализации

Виджет истории (type: history)

Виджет истории запусков (type: run_history)

Виджет комментариев (type: comments)

Виджет дашборда (type: card)

Виджет переписок (type: conversation)

Сторонние виджеты

Структура поля `widgets`

Типы виджетов (`type`)

Виджет атрибута (`type: attribute`)

Настройки элемента управления в виджете атрибута (`control`)

Настройки виджета атрибута типа `Array`

Настройки виджета атрибута типа `Counter`

Настройки виджета атрибута типа `RQL`

Список сущностей в редакторе RQL (`entities`)

Список связей в редакторе RQL (`linkages`)

Настройки виджета атрибута типа `Table`

Виджет действий (`type: action`)

Настройки элемента управления в виджете действия (`control`)

Виджет связи (`type: linkage`)

Редактор связей (`control`)

Настройки для расширенного редактора связи (`control: table`)

Столбцы таблицы в виджете связей (`columns`)

Атрибуты связи для отображения в виджете (`attributes`)

Элемент управления атрибута связи (`control`)

Виджет списка связей (`type: linkage_list`)

Ссылки на списочное представление сущности (`entity_lists`)

Правила включения связей (`includes`)

Правила исключения связей (`excludes`)

Виджет группировки связанных объектов (`type: linked_objects_groups`)

Список связей (`linkages`)

Столбцы (`columns`)

Структура `sortingBy` (в виджете группировки)

Настройки количества записей в таблице (`paging`)

Виджет транзитивных связей (`type: join`)

Виджет визуализации (`type: visualization`)

Параметры построения визуализации (`variables`)

Источник данных (`searchEntity`)

Сопоставление полей (`nameMapping`)

Виджет истории (`type: history`)

Виджет истории запусков (`type: run_history`)

Виджет комментариев (`type: comments`)

Виджет дашборда (`type: card`)

Виджет переписок (`type: conversation`)