Описания интерфейса

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

В описаниях интерфейса используются ссылки на действия, меню домена, меню панелей, а также иконки для виджетов представлений и элементов меню.

Структура actions

Поле actions представляет собой массив записей действий. Это необязательное поле.

Запись действия включает следующие поля:

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

id

да

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

View ID

name

нет

Пустая строка

Наименование действия.

строка

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

description

нет

Пустая строка

Описание действия.

строка

Не выводится в представлениях. Отображается в схеме домена.

type

да

Тип действия.

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

См. список доступных действий.

modal

да

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

строка

Доступно только для действия с типом open_modal

panel

да

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

строка

Доступно только для действия с типом open_panel

view

да

Ссылка на списочное представление объектов, зависимых от контекста.

View ID Ref

Доступно только для действия с типом open_list

entity

да

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

Data ID Ref или FQID

Доступно только для действий с типами:

  • remove;

  • workflow;

  • open_panel;

  • open_modal;

  • open_graph_view;

  • bulk.

operation

да

Тип операции над объектом.

Для типа действия open_modal доступны следующие типы операций:

  • create — добавление объекта;

  • edit — изменение выбранного объекта.

Для типа действия bulk доступны следующие типы операций:

  • remove — удаление выбранных объектов;

  • edit_attribute — изменение атрибута в выбранных объектах с типом данных workflow.

playbook

нет

Ссылка на плейбук или скрипт.

строка

Уникальное наименование плейбука или скрипта в рамках текущей экспертизы.

Доступно только для действия с типом playbook.

contextPin

нет

Запрет удаления контекста из фильтра списка объектов.

булево

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

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

  • true;

  • false.

Доступно только для действия с типом open_list.

page

нет

Окно, в котором будет отображен список.

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

Открываемый список может быть отображен как в новом окне, так и в текущем.

Возможные значения:

  • blank — показать список в новом окне;

  • current — показать список в текущем окне.

Доступно только для действия с типом open_list.

attribute

нет

Ссылка на атрибут-ссылку, для которого будет применен контекст.

Список объектов можно отфильтровать по значению атрибута-ссылки сущности этих объектов. Значение устанавливается из контекста при открытии списка.

Указывать одновременно атрибут-ссылку и связь в описании действия нельзя.

Доступно только для действий с типом open_list и bulk.

linkage

нет

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

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

Указывать одновременно атрибут-ссылку и связь в описании действия нельзя.

Доступно только для действия с типом open_list.

side

нет

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

Data ID Ref или FQID

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

  • 1 — первая сторона связи;

  • 2 — вторая сторона связи.

В списочном представлении отобразятся объекты указанной стороны связи.

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

Доступные типы действий

Доступны следующие типы действий:

  • open_panel — открыть панель деталей объекта (только для панели);

  • open_modal — открыть модальное окно для создания или редактирования объекта (только для модального окна);

  • open_list — открыть списочное представление объектов с заполненным контекстом на основании выбранного объекта в текущем списке;

  • open_graph_view — открыть граф связей, позволяющий создавать, изменять и удалять экземпляры связей, а также просматривать связи объекта на разных уровнях;

  • remove — удалить объект;

  • bulk — массовое действие;

  • playbook — запуск выполнения указанного плейбука или скрипта;

  • generate_qr_code — открыть модальное окно со сгенерированным QR-кодом, содержащим ссылку на компактное представление сущности.

Поле menus представляет собой массив записей элементов меню.

Запись включает следующие поля:

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

id

да

Идентификатор элемента меню.

View ID

route

да

Компонент адреса текущего пункта меню, отображаемый в строке веб-браузера.

URL path

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

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

label

да

Отображаемое в меню системы название раздела домена.

строка

icon

нет

Ссылка на медиа-ресурс.

строка

View ID Ref

type

да

Тип элемента меню.

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

Тип root_group используется для отображения в меню системы корневой группы элементов меню, включающей названия раздела домена и подразделов сущностей.

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

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

view

да

Ссылка на представление.

View ID Ref

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

Поле доступно только для типов элементов меню:

  • root_menu;

  • menu

description

нет

Описание меню.

строка

Не выводится в представлениях. Отображается в схеме домена

placement

да

Настройки расположения меню в левой панели.

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

Определяет, в каком меню разместить указанный элемент или группу.

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

  • top — меню будет отображаться в главном меню системы;

  • settings — меню будет отображаться в разделе Настройки главного меню системы.

items

да

Дочерние элементы для корневой группы меню.

массив

Массив записей меню с подразделами типов сущностей. Используется для типа элементов меню root_menu.

См. описание поля items.

Структура items

Поле items используется для создания массива записей пунктов меню в разделе домена.

Запись включает следующие поля:

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

id

да

Идентификатор элемента меню.

View ID

route

да

Компонент адреса текущего пункта меню, отображаемый в строке веб-браузера.

URL path

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

label

да

Отображаемое в меню системы название пункта меню.

строка

type

да

Тип элемента меню.

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

Устанавливается значение menu — дочерний элемент меню, который может быть задан только в рамках массива подэлементов корневой группы.

view

да

Ссылка на представление.

View ID Ref

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

description

нет

Описание меню.

строка

Не выводится в представлениях. Отображается в схеме домена.

Структура medias

Поле medias представляет собой массив записей элементов иконок.

Запись включает следующие поля:

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

id

да

Идентификатор иконки, которая будет использоваться в виджетах представлений и элементах меню.

View ID

description

нет

Пустая строка

Описание элемента домена.

строка

Не выводится в представлениях. Отображается в схеме домена

type

да

Тип иконки.

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

Определяет тип медиа ресурса и его возможности.

В текущей реализации поддерживается один тип иконки icon_name — именованная иконка из дизайн-системы.

iconName

да

Идентификатор медиаресурса в библиотеке

строка

Структура views

Описание интерфейса указывается в поле views и содержит следующие разделы:

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

id

да

Идентификатор интерфейса объекта.

View ID

type

да

Описание интерфейса объекта.

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

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

См. список доступных типов.

label

нет

Пустая строка

Наименование.

строка

Наименование представления для заголовка представления и при переиспользовании в смешанном представлении.

description

нет

Пустая строка

Описание элемента домена.

строка

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

entity

да (для объектов)

Ссылка на идентификатор объекта.

строка

Доступно для интерфейса объектов.

widgets

да (для объектов)

Массив записей виджетов.

массив

Доступно для интерфейсов объектов и дашбордов.

groups

да (для объектов)

Массив записей групп.

массив

Доступно для интерфейса объектов.

views

да (для объектов)

Массив записей панелей и модальных окон.

массив

Доступно для интерфейса объектов.

source

да (для списка объектов)

Источник списка объектов.

источник списка объектов

Доступно для интерфейса списка объектов. См. описание поля source.

actionPanel

нет

Пустой массив

Содержит ссылки на виджеты, используемые в описании (описываются в настройках интерфейса объекта).

массив ссылок на виджеты

Доступно для интерфейса списка объектов. Ссылки могут указывать на виджеты действий, которые могут работать в любом контексте. Если действие может работать только в контексте одного объекта, такие виджеты будут недоступны, пока не будет выбран объект в списке.

table

да (для списка объектов)

Настройки табличного отображения в интерфейсе списка объектов.

таблица списка объектов

Доступно для интерфейса списка объектов. См. описание поля table.

defaultTab

нет

Первая указанная вкладка

Вкладка, отображаемая открытой по умолчанию.

View ID Ref

Доступно для группы вкладок со списками объектов.

tabs

да (для группы вкладок)

Массив ссылок на идентификаторы описаний интерфейсов списков.

Формат поля:

tabs:
  - view: <ссылка на описание интерфейса списка 1>
  - view: <ссылка на описание интерфейса списка 2>

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

Доступно для группы вкладок со списками объектов. Каждая ссылка должна указывать на группу представлений только с типом tab.

layout

нет (для интерфейса виджетов дашбордов)

Настройки взаимного расположения компонентов в представлении.

размещение виджетов представления

См. описание поля layout.

Доступные типы интерфейсов

В схеме домена доступны следующие типы интерфейсов:

  • entity — представления одного объекта указанной сущности для различных операций и контекста.

  • list — представление списка объектов для различных контекстов.

  • tabs_list — группа вкладок, в каждой из которых отображается независимое представление списка объектов.

  • dashboard — группа плиток на странице, позволяющая запускать выполнение определенных действий.

  • tree — представление древовидных связей.

Структура source

Поле source представляет собой параметры источника объектов для списка.

Запись включает следующие поля:

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

type

да

operational

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

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

Определяет метод запроса данных, поведение и возможности интерфейса. Всегда устанавливается значение operational (база данных системы).

entity

да

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

Data ID Ref, FQID

joins

нет

Описание связей с сущностями, данные которых отображаются в списке.

массив

См. описание поля joins.

Структура joins в параметрах источника объектов для списка

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

Запись включает следующие поля:

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

id

да

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

Data ID

linkage

да

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

Data ID Ref

side

нет

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

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

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

  • side 1

  • side 2

Сторона определяется только для симметричной направленной связи.

description

нет

Пустая строка.

Описание связи.

строка

Структура widgets

Поле widgets представляет собой массив записей виджетов.

Доступные типы виджетов

В схеме домена доступны следующие типы виджетов:

  • attribute — виджет атрибута, позволяющий отображать и редактировать значение атрибута объекта.

  • action — виджет действия, позволяющий запускать действие с передачей на сторону исполнения текущего контекста.

  • linkage — виджет связи, позволяющий отображать и менять список связанных объектов.

  • visualization — виджет графического отображения, позволяющий отображать графики.

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

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

  • linkage_list — виджет списка связей, позволяющий отображать связи объекта для просмотра и редактирования согласно заданным правилам доступности связей в доменах.

  • card — виджет дашбордов, позволяющий запускать в дашбордах действия над сущностями домена, описанные в поле actions.

Запись виджета включает следующие поля:

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

id

да

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

View ID

type

да

Тип виджета

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

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

См. раздел Доступные типы виджетов.

attribute

да (для виджетов атрибутов)

Ссылка на атрибут

Data ID Ref

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

action

да (для виджетов действий)

Ссылка на действие над объектом

View ID Ref

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

В описании действия нельзя одновременно использовать поля action и actions.

actions

да (для виджетов действий)

Список ссылок на действия

массив ссылок на действия

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

В описании действия нельзя одновременно использовать поля action и actions.

См. описание поля actions.

linkage

да (для виджетов связей)

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

Data ID Ref

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

side

нет

2

Сторона связи для виджета

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

Доступно для виджетов связей, сторона определяется только для симметричной направленной связи. В других случаях сторону определять не нужно: ее значение будет игнорироваться.

Возможные значения:

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

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

label

нет

Пустая строка

Наименование

строка

Доступно для виджетов связей, наименование связи, отображаемое в виджете.

description

нет

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

строка

control

нет

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

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

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

Для виджетов атрибутов и связей можно задать свой элемент управления. Элемент должен соответствовать типу атрибута или типу и направленности связи.

Для виджетов действий можно задать иконку (кроме случаев, когда в описании действия указаны значения полей type = bulk и operation = edit_attribute).

См. описание поля control.

name

нет

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

строка

Доступно для виджетов визуализации.

rql

да (для виджетов визуализации)

Запрос для построения визуализации

RQL-запрос

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

n =%{{n}}%

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

arguments

да (для виджетов визуализации)

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

массив

Доступно для виджетов визуализации. Содержит пары полей key и type:

  • key — поле сущности домена, значение которого будет передаваться в переменную %{{n}}%.

  • type — тип поля, указанного в key (например, string, datetime)

last

да (для виджетов визуализации)

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

объект

Доступно для виджетов визуализации. См. описание поля last.

limit

да (для виджетов визуализации)

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

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

Доступно для виджетов визуализации.

source

да (для виджетов визуализации)

Тип источника данных (виджета) для построения визуализации.

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

Доступно для виджетов визуализации. Устанавливается значение search — поиск по хранилищам и активным спискам.

chartType

да (для виджетов визуализации)

Тип визуализации.

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

Доступно для виджетов визуализации.

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

  • BAR_CHART — столбчатая диаграмма;

  • LINE_CHART — график;

  • PIE_CHART — круговая диаграмма;

  • STACKED_BAR_CHART — столбчатая диаграмма с накоплением;

  • TABLE — таблица;

  • TOTAL — итог.

searchEntity

да (для виджетов визуализации)

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

массив

Доступно для виджетов визуализации. См. описание поля searchEntity.

nameMapping

да (для виджетов визуализации)

Cопоставление полей данных с отображаемыми элементами.

массив

Доступно для виджетов визуализации. См. описание поля nameMapping.

eventStorageId

да (для виджетов истории изменений)

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

строка

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

rules

да (для виджетов списка связей)

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

объект

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

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

См. описание rules.

icon

нет (для виджетов дашбордов)

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

View ID Ref

Иконка действия, связанного с виджетом.
Схема записи виджета атрибута 
widgets:
# Идентификатор виджета.
- id:
     # Тип виджета атрибута.
     type: attribute
     # Идентификатор атрибута (должен быть предварительно объявлен).
     attribute:
     # Настройки типа данных для виджета.
     control:
        # Элемент управления.
        type:
        # Настройки отображения и стиля.
     # Описание виджета.
     description:
Схема записи виджета системного атрибута 
widgets:
# Идентификатор виджета.
- id:
     # Тип виджета атрибута.
     type: attribute
     # Идентификатор атрибута (его не нужно объявлять предварительно).
     attribute:
     # Описание виджета.
     description:
Схема записи виджета действия над объектом 
widget:
# Идентификатор виджета.
- id:
     # Тип действия виджета действия.
     type: action
     # Ссылка на действие.
     action:
     # Элемент управления виджетом.
     control:
         # Элемент управления виджетом (стандартная кнопка).
         type: regular_button
         # Ссылка на идентификатор медиаресурса для иконки виджета.
         icon:
     # Описание виджета.
     description:
Схема записи виджета связи сущностей (компактный редактор) 
widgets:
# Идентификатор виджета.
- id:
  # Тип виджета связи.
  type: linkage
  # Ссылка на связь.
  linkage:
  # Элемент управления виджетом.
  label:
Схема записи виджета истории изменений 
widgets:
# Идентификатор виджета
- id:
  # Тип виджета истории изменений
  type: history
  # Отображаемое название виджета
  label:
  # Описание виджета
  description:
  # Ссылка на хранилище событий
  eventStorageId:
Схема записи виджета комментариев 
widgets:
# Идентификатор виджета
- id:
  # Тип виджета комментариев
  type: comments
  # Отображаемое название виджета
  label:
  # Описание виджета
  description:
Схема записи виджета комментариев 
widgets:
# Идентификатор виджета
- id:
  # Тип виджета списка связей
  type:
  # Отображаемое название виджета
  label:
  # Список объектов - записей правил доступности связей
  rules:
    # Список объектов - записей включения связей из определенных доменов
    includes:
      # ИД домена
      - id:
        # Массив ИД связей, которые будут включены в список (только они будут включены)
        only:
        # Массив ИД связей, которые будут исключены из списка (а все прочие будут включены)
        except:
    # Список объектов - записей исключения связей из определенных доменов
    excludes:
      # ИД домена
      - id:
        # Массив ИД связей, которые будут исключены из списка (только они будут исключены)
        only:
        # Массив ИД связей, которые будут включены в список (а все прочие будут исключены)
        except:

Структура actions (в виджетах действий)

Поле actions представляет собой массив ссылок на действия, связанные с сущностями в цепочке наследования — родителем и его потомками. Это позволяет описать в виджете действия родителя кнопку для действий, содержащую раскрывающийся список. Если ссылка на эту кнопку указана в интерфейсе списка объектов родителя, при нажатии на нее отображается список действий над объектами родителя и потомков, приведенный в поле actions. В списке можно выбрать объект требуемого потомка для выполнения указанного действия.

Запись включает следующие поля:

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

action

да

Ссылка на описание действия над объектом родителя или потомка.

View ID

Структура rules (в виджетах списка связей)

Поле rules содержит правила доступности связей для просмотра и редактирования.

Запись включает следующие поля:

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

includes

нет

Правила включения связей.

массив объектов

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

См. описание поля includes.

excludes

нет

Правила исключения связей.

массив объектов

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

См. описание поля excludes.

Структура includes (в правилах доступности)

Поле includes содержит ссылку на домен и критерии доступности связей этого домена для просмотра и редактирования в рамках этого виджета.

Запись включает следующие поля:

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

id

да

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

Data ID Ref или FQID

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

only

нет

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

массив строк

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

except

нет

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

массив строк

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

Структура excludes (в правилах доступности)

Поле excludes содержит ссылку на домен и критерии недоступности связей этого домена для просмотра и редактирования в рамках этого виджета.

Запись включает следующие поля:

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

id

да

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

Data ID Ref или FQID

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

only

нет

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

массив строк

Из списка доступных связей исключаются только перечисленные в этом поле связи домена.

except

нет

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

массив строк

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

Структура control (в виджете)

В поле control задаются элементы управления виджетом.

Поле control не задается в схеме домена для виджетов действий, если в описании действия, на которое ссылается виджет, указаны значения полей:

  • type = bulk;

  • operation = edit_attribute.

В этом случае система автоматически подставляет для действия элемент управления dropdown — выпадающий список значений, которые можно присвоить атрибуту объектов. Ссылка на атрибут указывается в описании действия.
Поле Обязательное поле Значение по умолчанию Описание Тип данных Комментарий

type

да

Тип элемента управления для виджета

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

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

Для виджета действия всегда устанавливается значение regular_button (стандартная кнопка).

Возможные значения для виджета связи:

  • select — для выбора связи типа 1-1:

  • multi_select — для выбора связи типа 1-N или N-N (вы находитесь на стороне 1);

  • table — для выбора связи типа 1-N или N-N (вы находитесь на стороне 1).

    См. описание поля table.

falseText

да (для виджетов атрибутов)

Наименование для значения false

строка

Поле доступно только в виджетах атрибутов для элемента управления bool_text.

trueText

да (для виджетов атрибутов)

Наименование для значения true

строка

Поле доступно только в виджетах атрибутов для элемента управления bool_text.

icon

нет

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

строка

Структура table (в редакторе связей)

Поле table описывается только для элемента управления типа table. В этом поле описываются настройки расширенного редактора связей.

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

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

addLinksView

да

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

объект

columns

да

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

массив

См. описание поля columns.

sortingBy

нет

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

объект

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

См. описание поля sortingBy.

paging

нет

Пагинация данных.

объект

См. описание поля paging.

Структура columns (в таблице виджета связи)

Поле columns содержит массив записей столбцов таблицы.

Столбец включает следующие поля:

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

id

да

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

массив

attribute

да

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

строка

Структура last (в виджетах визуализации)

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

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

unit

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

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

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

  • DAY — день (24 часа);

  • HOUR — час;

  • MINUTE — минута;

  • MONTH — месяц (30 дней);

  • YEAR — год;

value

Количество единиц измерения.

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

Структура searchEntity (в виджетах визуализации)

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

id

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

строка

type

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

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

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

  • active_list

  • event_storage

Структура 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, указывается поле запроса, из которого берется значение для указанного столбца.

Структура groups

Поле groups представляет собой массив записей визуальных элементов, на которые ссылается представление.

Поле groups включает следующие поля:

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

id

да

Уникальный идентификатор группы представления.

View ID

description

нет

Пустая строка

Описание группы представления.

строка

type

да

Тип группы.

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

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

  • block — блок;

  • tab — вкладка;

  • form — форма создания или редактирования объекта.

Блоки, вкладки и формы описаны ниже.

layout

нет

Настройки взаимного расположения компонентов в группе.

размещение компонентов группы представлений

См. описание поля layout.

Доступно только для типа block.

components

да

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

массив

См. описание поля components.

menu

нет

Меню группы представления.

массив

Доступно только для типа tab

label

нет

Пустая строка

Наименование группы представления.

строка

Доступно только для типов:

  • block;

  • tab.

Структура layout (в группе представления)

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

Запись включает следующие поля:

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

direction

да

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

строка

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

Возможные значения:

  • column — вертикальное размещение. Используется по умолчанию, если элемент размещения не был указан для группы.

  • row — горизонтальное размещение.

expandable

нет

false

Возможность развернуть элемент

булево

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

  • true — элемент можно развернуть;

  • false — элемент нельзя развернуть.

Структура components

Поле components используется для перечисления компонентов элемента поля groups. Такими компонентами могут быть:

  • блоки (для элемента tab);

  • виджеты.

Поле components включает следующие поля:

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

block

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

строка

Блоки перечисляются только для типа tab

widget

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

строка

showLabel

Отображение название компонента.

булево

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

  • true — отображать название;

  • false — не отображать название.

Структура views (панели и модальные окна)

Конфигурация интерфейса объекта включает следующие поля:

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

id

да

Уникальный идентификатор представления одного объекта.

View ID

description

нет

Пустая строка

Описание элемента домена.

строка

type

да

Тип представления одного объекта.

строка

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

Возможные значения:

  • panel — информационная панель, которая может отображать вкладки (группы представлений с типом tab);

  • modal — модальное окно, которое может отображать форму (группу представлений с типом form).

label

нет

Пустая строка

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

строка

menu

нет

Действия, отображаемые в меню панели.

массив

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

См. описание поля.

tabs

да

Вкладки, отображаемые в панели.

массив

См. описание поля.

form

Ссылка на группу с типом form.

ссылка на форму

buttons

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

массив

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

См. описание поля buttons.
Схема записи панели 
 views:
      # Уникальный идентификатор.
      - id:
        # Описание.
        description:
        # Тип представления (панель).
        type: panel
        # Название панели.
        label:
       # Меню панели.
       menu:
          # Действие.
          - action:
            # Параметры управления.
            control:
              # Тип управления.
              type:
                 # Идентификатор медиаресурса для кнопки.
                 icon:
      # Массив записей вкладок панели.
      tabs:
          # Идентификатор вкладки.
          - tab:
Схема записи модального окна 
views:
 # Уникальный идентификатор.
 id:
 # Описание.
 description:
 # Тип представления (модальное окно).
 type: modal
 # Ссылка на форму (описывается в поле groups с типом form).
 form:
 # Название модального окна.
 label:

Поле menu представляет собой массив записей элементов меню.

Запись включает следующие поля:

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

action

да

Ссылка на действие, вызываемое в меню.

View ID Ref

Действие, которое будет вызвано при нажатии на элемент меню.

Действия, которые работают с контекстом списка, могут быть недоступны, если в списке не выбраны нужные данные. Например, действие массового удаления объектов не будет работать, если в списке не выбран ни один объект.

control

нет

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

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

Система по умолчанию подставляет элемент regular_button, для которого можно опционально указать ссылку на медиа-ресурс — иконку (поле icon).

См. описание поля control.

Структура control (в меню)

В поле control задаются элементы управления виджетом или кнопками.

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

type

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

строка

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

В этом поле для него всегда устанавливается значение regular_button (стандартная кнопка).

icon

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

строка

Структура buttons

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

Запись включает следующие поля:

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

type

Идентификатор модального окна.

строка

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

  • submit — при нажатии на кнопку данные отправляются в систему;

  • close — при нажатии на кнопку окно закрывается, а данные не отправляются.

Содержит поле control.

label

Название кнопки.

строка

Необязательное поле. Если значение не указано, система добавляет название по умолчанию.
Схема записи кнопки 
buttons:
    # Название кнопки.
    label:
     # Описание типа кнопки.
     - type:
        # Описание настроек параметров управления.
        control:
            # Тип параметра управления (кнопка).
            type: regular_button
            # Идентификатор медиаресурса для иконки кнопки.
            icon:

Структура layout (в интерфейсе дашбордов)

В поле layout задаются настройки взаимного расположения компонентов в интерфейсе.

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

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

type

нет

grid

Тип взаимного расположения виджетов в интерфейсе.

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

Значение grid позволяет расположить виджеты в виде сетки

columns

нет

3

Количество столбцов в интерфейсе виджетов.

число

Значение указывается, если в поле type указано значение grid.

Структура table (список объектов)

Поле table содержит настройки табличного отображения сведений о списке объектов.

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

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

columns

да

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

массив столбцов таблицы

См. описание поля columns.

filter

нет

Настройки фильтрации столбцов.

объект

См. описание поля filter.

sortingBy

нет

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

объект

См. описание поля sortingBy.

paging

нет

Пагинация данных.

объект

См. описание поля paging.

refresh

нет

Обновление данных.

объект

См. описание поля refresh.

selection

нет

false

Возможность выбора строки таблицы.

булево

См. описание поля selection.

actions

нет

Пустой массив

Действие при нажатии на строку таблицы.

массив действий на события таблицы

См. описание поля actions.

empty

нет

Информация, отображаемая в таблице, если данные отсутствуют.

сообщение при отсутствии строк в таблице

См. описание поля empty.

Структура columns (в таблице списка объектов)

Поле columns содержит массив записей столбцов таблицы.

Столбец включает следующие поля:

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

id

да

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

массив

attribute

да

Атрибут столбца.

строка

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

join

нет

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

Data ID Ref

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

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

type

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

строка

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

Допустимые типы для разных контекстов представлены в таблице.

control

Значения строк.

массив

Допустимо только для столбца типа "булево".

В полях trueText и falseText указываются отображаемые строки для значений True и False:

  • trueText: <строка>

  • falseText: <строка>

layout

нет

Массив настроек размера и видимости столбца.

массив

См. описание поля layout.

label

нет

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

строка

Если значение этого поля не задано, в качестве наименования берется id столбца.

Структура layout (в столбце списка объектов)

Поле layout содержит массив настроек размера и видимости.

Настройка включает следующие поля:

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

visible

нет

true

Видимость столбца.

строка

В этом поле доступны следующие значения:

  • true — столбец отображается (значение по умолчанию).

  • false — столбец скрыт.

width

нет

Ширина столбца в пикселях.

объект

См. описание поля width.
Схема использования столбца 
table:
  columns:
    # Идентификатор столбца.
    - id:
      # Атрибут столбца.
      attribute:
      # Тип данных в столбце.
      type
      # Массив настроек столбца.
      layout:
        # Параметр видимости столбца.
        visible:
        # Ширина столбца (по умолчанию, минимальная, максимальная).
        width:
          default:
          min:
          max:

Настройки ширины столбца (width)

Поле width содержит массив настроек ширины столбца.

Настройка включает следующие поля:

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

default

да

Ширина столбца по умолчанию, в пикселях.

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

min

да

Максимальная ширина столбца в пикселях.

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

max

да

Минимальная ширина столбца в пикселях.

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

Структура filter

Данные, по которым осуществляется фильтрация, должны быть описаны в настройках фильтрации. Фильтрация по этим данным в системе доступна независимо от того, отображаются ли они в интерфейсе списка объектов (таблице).

Фильтровать данные можно:

  • по атрибутам сущности;

  • по лейблу и атрибутам связанного объекта.

    Фильтрация по атрибутам связанного объекта типа Reference не поддерживается.
    Для ссылки на атрибут в настройках фильтрации используйте значение поля id в описании атрибута сущности.

Поле filter содержит массив настроек фильтрации столбцов таблицы.

Фильтр включает следующие поля:

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

attributes

нет

Массив ссылок на атрибуты сущности, по которым производится фильтрация.

См. описание поля attributes.

linkages

нет

Массив ссылок на связи сущности, по которым производится фильтрация.

См. описание поля linkages.

Структура attributes (в фильтре списка объектов)

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

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

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

type

да

Тип фильтрации

В этом поле можно указать следующие типы фильтрации:

  • specific — фильтрация осуществляется по атрибутам сущности, ссылки на которые приведены в поле use.

  • all — фильтрация осуществляется по всем атрибутам. При использовании этого типа ссылки на атрибуты в поле use приводить не нужно.

use

да

Массив ссылок на атрибуты, по которым производится фильтрация

Задается, если в поле type указано значение specific.

В этом поле перечисляются атрибуты, по которым осуществляется фильтрация в таблице, см. схему.

Структура linkages (в фильтре списка объектов)

Поле linkages используется:

  • для задания ссылок на связи сущности, по которым производится фильтрация;

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

Структура включает следующие поля:

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

type

да (при ссылках на связи)

Тип фильтрации.

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

  • specific — фильтрация осуществляется по связям, ссылки на которые приведены в поле use.

  • all — фильтрация осуществляется по всем связям. При использовании этого типа ссылки на связи в поле use приводить не нужно.

use

да (при ссылках на связи)

Массив ссылок на связи, по которым производится фильтрация.

Задается, если в поле type указано значение specific.

В этом поле перечисляются связи, по которым осуществляется фильтрация в таблице, см. схему.

linkage

да (при ссылках на атрибуты)

Ссылка на связь с другой сущностью.

Заполняется при задании ссылок на атрибуты связанных сущностей. Поле linkedEntity этой связи содержит атрибуты связанной сущности, по которым будет доступна фильтрация.
Схема фильтрации по отдельным атрибутам и связям 
table:
  # Поле фильтрации.
  filter:
    # Тип фильтрации по отдельным атрибутам, перечисленным в поле use.
    attributes:
      type: specific
      use:
        - attribute: <attribute_1>
        - attribute: <attribute_2>
        ...
    # Тип фильтрации по отдельным связям, перечисленным в поле use.
    linkages:
      type: specific
      use:
          # Ссылка на связь с сущностью.
          - linkage: <entity_1>
            linkedEntity:
              # Ссылки на атрибуты связанной сущности, по которым будет производиться фильтрация.
              - attribute: <attribute_3>
              - attribute: <attribute_4>
              ...
          - linkage: <entity_2>
          ...

Сортировка в столбцах таблицы (sortingBy)

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

Настройки включают следующие поля:

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

columns

да

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

массив привязок правил сортировки к столбцам

В этом поле указывается:

  • в поле column — столбец, по которому выполняется сортировка;

  • в поле sorting — правило, в соответствии с которым она выполняется.

defaults

нет

Массив записей столбцов с указанием направления сортировки по умолчанию.

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

В этом поле указывается:

  • в поле column — столбец для направления сортировки;

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

    • asc — сортировка по возрастанию;

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

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

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

Настройка включает следующие поля:

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

sizes

да

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

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

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

defaultSize

да

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

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

Структура refresh

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

Настройка включает следующие поля:

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

mode

да

Режимы обновления.

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

В этом поле указываются режимы обновления записей:

  • manual — обновление производится вручную;

  • auto — обновление производится автоматически с заданным интервалом;

  • all — обновление производится вручную и автоматически.

defaults

да

Настройки автообновления.

объект

Поле доступно только для настроек фильтров таблиц с типами:

  • all;

  • auto.

См. описание поля defaults.

Структура defaults

Поле defaults содержит настройки автообновления записей, показываемых в таблице. Используется, если в поле mode установлено значение auto или all.

Настройка включает следующие поля:

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

enabled

Включение и выключение автообновления.

булево

unit

Единица измерения интервала автообновления.

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

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

  • second — секунды;

  • minute — минуты;

  • hour — часы.

interval

Количество единиц измерения интервала автообновления.

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

Структура selection

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

Настройка включает следующие поля:

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

selection

Возможность выбора записей.

булево

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

  • true — выбор записей возможен;

  • false — выбор записей невозможен (значение по умолчанию).

Структура actions (в списке объектов)

Поле actions содержит настройки действий в таблице.

Настройка включает следующие поля:

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

type

Тип действия.

строка

Устанавливается значение row_click — действие при нажатии на строку.

action

Ссылка на идентификатор действия.

строка

Структура empty

Поле empty содержит настройки отображения сообщения в таблице, если данные отсутствуют.

Настройка включает следующие поля:

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

message

Отображение сообщения в таблице, если данные отсутствуют.

строка

Необходимо указать отображаемое сообщение в поле message.
+7 (499) 755 55 70 sales@rvision.ru

О компании Пользовательское соглашение Политика cookies