Настройка дашбордов

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

• Код — уникальное кодовое обозначение объекта.
• Краткое наименование — краткое название дашборда в интерфейсе.
• Папка — папка, в которой расположен дашборд.
• Пространство — наименование пространства, в котором находится дашборд.
• Макет — макет дашборда в JSON-формате.
• Создал — ФИО пользователя, создавшего перекодировку-фильтр.
• Дата и время создания.
• Изменил — ФИО пользователя, изменившего перекодировку-фильтр.
• Дата и время изменения.

Для создания нового дашборда нажмите кнопку Создать и в появившемся окне заполните поля:

• Код — уникальное кодовое обозначение объекта.
• Краткое наименование — краткое обозначение дашборда в интерфейсе.
• Полное наименование — полное наименование объекта.
• Комментарий — комментарий с дополнительной информацией.
• Папка — папка в структуре папок Навигатора, в которой будет расположен дашборд.
• Пространство — указывается единое пространство по умолчанию.
• Основной — признак основного дашборда. Дашборд, выбранный в качестве основного отображается в Панели навигатора в разделе Домашняя страница.

После заполнения нажмите Создать для завершения создания.

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

• Номер блока — порядковый номер отображения блока в дашборде.
• Краткое наименование — краткое наименование дашборда.
• Полное наименование — полное наименование дашборда.
• Комментарий — комментарий с дополнительной информацией.
• Тип блока — определяет схему расположения виджетов в блоке:
  • Равномерный — используется для простых виджетов, высота столбцов и строк не меняется от содержимого, вставить виджет-куб нельзя, только текст, навигационную ссылку или действие.
  • Адаптивный — используется для виджета типа куб или таблица, высота и ширина виджета адаптируется под размер экрана. Может быть раскрыт в полноэкранном режиме.
• Кол-во строк в блоке.
• Кол-во столбцов в блоке.
• Создал — ФИО пользователя, создавшего перекодировку-фильтр.
• Дата и время создания.
• Изменил — ФИО пользователя, изменившего перекодировку-фильтр.
• Дата и время изменения.

Для создания блока дашборда нажмите кнопку Создать и в появившемся окне заполните поля:

• Номер блока — порядковый номер отображения блока в дашборде (обязательное поле).
• Краткое наименование — краткое наименование дашборда.
• Полное наименование — полное наименование дашборда.
• Комментарий — комментарий с дополнительной информацией.
• Тип блока — определяет схему расположения виджетов в блоке. Выбирается из списка.
• Количество строк в блоке — 1-4 строки для равномерного типа, 1 строка для адаптивного.
• Количество столбцов в блоке — 1-6 столбцов для равномерного типа, 1 столбец для адаптивного.
• Высота строк — задается в % от...
• Ширина столбцов — задается в % от...

После заполнения нажмите Создать для завершения создания.

Для создания нового дашборда заполните поля в форме создания и нажмите кнопку Создать.

В конце каждой строки находится кнопка ••• с одной опцией — Удалить для удаления элемента.

В разделе Представления дашбордов находятся представления выбранного дашборда. Представление — это настройки отображения выбранного дашборда. При переходе в раздел структуры отображается таблица со следующей информацией:

• Код — уникальное кодовое обозначение объекта.
• Краткое наименование — краткое обозначение дашборда в интерфейсе.
• Настройки блока — текущие настройки блока в формате JSON.
• Настройки куба — текущие настройки куба в формате JSON.
• Основной — признак представления по умолчанию.
• Создал — ФИО пользователя, создавшего представление.
• Дата и время создания.
• Изменил — ФИО пользователя, изменившего представление.
• Дата и время изменения.

Для создания представления дашборда нажмите кнопку Создать и в появившемся окне заполните поля:

• Настройка — для настройки отображения таблицы.
• Создать — для создания нового представления дашборда. Нажатие на кнопку вызывает всплывающее окно Создание представления со следующими полями:
  • Код — уникальное кодовое обозначение объекта.
  • Краткое наименование — краткое обозначение дашборда в интерфейсе.
  • Полное наименование — полное наименование объекта.
  • Комментарий — комментарий с дополнительной информацией.
  • Основной — признак основного представления. Представление, выбранное в качестве основного отображается по умолчанию при открытии дашборда.

После заполнения нажмите Создать для завершения создания.

В разделе Настройки блоков находятся текущие настройки отображения блоков дашборда по умолчанию для выбранного представления. При переходе в раздел структуры отображается таблица со следующей информацией:

• Блок дашборда — наименование блока дашборда.
• Свернут — признак свернутого отображения блока по умолчанию.
• Создал — ФИО пользователя, создавшего настройку.
• Дата и время создания.
• Изменил — ФИО пользователя, изменившего настройку.
• Дата и время изменения.

В разделе Настройки кубов находятся текущие настройки отображения кубов дашборда по умолчанию для выбранного представления. При переходе в раздел структуры отображается таблица со следующей информацией:

• Измерение куба виджета — кодовое обозначение измерения куба виджета.
• Фильтр элементов — фильтр, применяемый к элементам по умолчанию.
• Перечень свернутых элементов — ID элементов, отображаемых в свернутом виде по умолчанию.
• Создал — ФИО пользователя, создавшего настройку.
• Дата и время создания.
• Изменил — ФИО пользователя, изменившего настройку.
• Дата и время изменения.

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

• Виджет — наименование виджета.
• Скрытие пустых — скрытие пустых строк в виджете-кубе по умолчанию.
• Создал — ФИО пользователя, создавшего настройку.
• Дата и время создания.
• Изменил — ФИО пользователя, изменившего настройку.
• Дата и время изменения.

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

• Код — уникальное кодовое обозначение объекта.
• Краткое наименование — краткое обозначение виджета в интерфейсе.
• Тип виджета:
  • Навигационная ссылка,
  • Действие,
  • Произвольный текст,
  • Виджет-куб,
  • Табличная форма,
  • Ссылка на внешний ресурс.
• Параметры — текущие параметры виджета.
• Номер блока — порядковый номер блока, в котором находится виджет на дашборде.
• Номер строки — порядковый номер строки в блоке.
• Столбец — порядковый номер столбца в блоке.
• Создал — ФИО пользователя, создавшего перекодировку-фильтр.
• Дата и время создания.
• Изменил — ФИО пользователя, изменившего перекодировку-фильтр.
• Дата и время изменения.

Для создания нового виджета нажмите кнопку Создать и в появившемся окне заполните следующие поля:

• Код — уникальное кодовое обозначение объекта.
• Краткое наименование — краткое обозначение виджета в интерфейсе.
• Полное наименование виджета — полное обозначение виджета.
• Комментарий — комментарий с дополнительной информацией.
• Тип виджета — выбор из списка:
  • Навигационная ссылка,
  • Действие,
  • Произвольный текст,
  • Виджет-куб,
  • Табличная форма,
  • Ссылка на внешний ресурс.
• Блок дашборда — наименование блока, в котором будет расположен виджет.
• Столбец блока — порядковый номер столбца в блоке, в котором будет расположен виджет.
• Строка блока — порядковый номер строки в блоке, в которой будет расположен виджет.

После заполнения нажмите Создать для завершения создания.

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

• Измерение — наименование измерения модели.
• Фильтр элементов — условия фильтрации элементов в измерении в формате JSON.
• Тип отображения — тип отображения измерения в интерфейсе виджета.
• Порядковый номер — порядковый номер отображения.
• Параметры — параметры измерения в формате JSON.
• Создал — ФИО пользователя, создавшего перекодировку-фильтр.
• Дата и время создания.
• Изменил — ФИО пользователя, изменившего перекодировку-фильтр.
• Дата и время изменения.

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

Для экспорта конфигурации дашборда выполните следующие шаги:

1. В интерфейсе VK Budgeting Перейдите в раздел Настройки → Настройка модели.
2. В структуре настройки выберите раздел Дашборды.
3. В списке дашбордов выберите дашборд, конфигурацию которого необходимо перенести и нажмите на него.
4. В блоке Параметры объекта нажмите Дополнительно и выберите пункт Экспорт.
5. На устройстве будет сохранен файл в формате JSON с конфигурацией дашборда. Конфигурация дашборда содержит следующие данные:
   • Метаданные дашборда — код, наименование, комментарий, пространство, папка, признак основного дашборда, код прародителя.
   • Блоки дашборда — структура блоков (строки и колонки) и тип шаблона: равномерный, декларативный, адаптивный.
   • Виджеты дашборда — виджеты в блоках, включая привязки к кубам и табличным формам.
   • Настройки виджета дашборда — параметры виджетов, включая связи с кубами и настройки измерений.
   • Системные представления дашборда (пользовательские представления экспортируются как системные).
   • Настройки блоков представлений — cостояние блоков (свёрнут/развёрнут) в каждом представлении.
   • Настройки виджетов Представлений — cостояние виджетов в каждом представлении.
   • Настройки измерений виджета-куба — настройки измерений, фильтры и выбранные элементы.
   • Версия core-model, в которой выполнен экспорт.

Для импорта конфигурации дашборда выполните следующие шаги:

1. В интерфейсе VK Budgeting Перейдите в раздел Настройки → Настройка модели.
2. В структуре настройки выберите раздел Дашборды.
3. Нажмите Импортировать.
4. Добавьте JSON-файл с конфигурацией дашборда в форму загрузки.
5. Нажмите Создать.

Будет создан новый преднастроенный дашборд.

При импорте система проверяет:

1. Формат файла — файл является корректным JSON.
2. Структуру файла — наличие обязательных полей: protocolVersion, exportTimestamp, messageType, payload.
3. Тип сообщения — messageType равен IEE_DASHBOARD.
4. Версию протокола — версия core-model источника совпадает с версией core-model приёмника.
5. Связность объектов — внутренние связи между объектами в файле не нарушены.
6. Уникальность кода — код дашборда из файла не конфликтует с уже существующими в инсталляции.
7. Наличие кубов — кубы, используемые в виджетах, существуют в приёмнике, и их структуры совпадают.
8. Наличие табличных форм — табличные формы, привязанные к виджетам, существуют в приёмнике.

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

Если в приёмнике отсутствуют некоторые объекты, на которые ссылается конфигурация, система применяет следующие правила:

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

Для обновления текущей конфигурации дашборда новой конфигурацией из файла выполните следующие шаги:

1. В интерфейсе VK Budgeting Перейдите в раздел Настройки → Настройка модели.
2. В структуре настройки выберите раздел Дашборды.
3. В списке дашбордов выберите дашборд, конфигурацию которого необходимо обновить и нажмите на него.
4. В блоке Параметры объекта нажмите Дополнительно и выберите пункт Обновить через импорт.
5. Откроется модальное окно с предупреждением: «Импорт дашборда поверх существующего удалит пользовательские представления. Хотите продолжить?». Нажмите Продолжить.
6. Добавьте JSON-файл с конфигурацией дашборда в форму загрузки.
7. Нажмите Импортировать

Текущая конфигурация дашборда будет заменена конфигурацией из файла.

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

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

Для корректного обновления дашборда используется код прародителя — специальный атрибут, который связывает дашборд-приёмник с дашбордом-источником.

При экспорте в файл записывается код дашборда-источника. При обновлении система проверяет, что код прародителя дашборда-приёмника совпадает с кодом дашборда из файла. Если коды не совпадают, то импорт прекращается с ошибкой.

При обновлении дашборда из файла, заполните поле Код прародителя значением кода дашборда-источника. Это позволит системе однозначно определить соответствие между дашбордами в разных инсталляциях.

Помимо проверок, выполняемых при создании нового дашборда, при обновлении дополнительно проверяется:

• Существование дашборда — дашборд с указанным идентификатором существует в приёмнике.
• Соответствие кода прародителя — код прародителя дашборда-приёмника совпадает с кодом дашборда из файла.