Skip to content

Latest commit

 

History

History
1057 lines (667 loc) · 40.1 KB

widgets.rst

File metadata and controls

1057 lines (667 loc) · 40.1 KB

Виджеты

Для некоторых виджетов доступна настройка. Настройка отмечена следующей иконкой:

_static/widgets/widget_1.png

Note

При включенном конфиге restrict-access-to-edit-dashboard-widgets (true) настройка виджетов запрещена пользователю.

В системе для пользователй можно разграничить права на настройку дашборда (restrict-access-to-edit-dashboard) и настройку виджетов (restrict-access-to-edit-dashboard-widgets).

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

Конфиги хранятся в разделе Управление системой – Конфигурация ECOS:

_static/widgets/dashboards_widgets_settings.png

Включение настройки:

_static/widgets/dashboards_widgets_settings_1.png

Ключ journal

Виджет для настройки отображения журнала.

Настройка

_static/widgets/journal_1.png

_static/widgets/journal_2.png
Настроенный вид

_static/widgets/journal_3.png

Ключ web-page

Виджет отображает любую web-страницу, заданную в его настройках.

Настройка

_static/widgets/web_1.png
Настроенный вид

_static/widgets/web_2.png

Ключ doc-preview

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

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

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

_static/widgets/Preview_2.png

Первым отображается основной контент cm:content, затем дочерние элементы с типом idocs:doc.

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

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

_static/widgets/Preview_1.png

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

Ключ comments

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

Введенные комментарии

_static/widgets/comment_1.png
Форма ввода комментария:
Для ввода текста используется визуальный редактор, в котором помимо форматирования текста доступно добавление таблицы (1), кода (2), ссылки (3), файла (4):
_static/widgets/comment_2.png

Для включения транслированная комментария при выполнении задачи в виджет комментариев необходимо к типу данных добавить аспект task-comments-broadcastable.

Important

Инпут комментария на форме задачи должен быть добавлен с id comment.

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

_static/widgets/comment_3.png

Если необходимо выключить добавление комментария из задачи для конкретного рекорда, можно у рекорда выставить свойство task-comments-broadcastable:broadcastComments в false.

Ключ properties

Виджет для отображения атрибутов карточки формы и их значений. Предоставляет возможность inline редактирования значений атрибутов или редактирование в режиме "формы" (с учетом статуса кейса, наличия прав у просматривающего кейс пользователя).

Список для выбора - формы из журнала форм.

Настройка
Список для выбора - формы из журнала форм.

_static/widgets/Properties_1.png

_static/widgets/Properties_2.png
Настроенный вид
Для типа дашборда :ref:`Case-details<dashboard_types>` реализовано 2 режима (см. настройки ниже)
- просмотр с возможностью inline редактирования значений атрибутов:
_static/widgets/Properties_3.png
- редактирование в режиме "формы":
_static/widgets/Properties_4.png
Для типа дашборда :ref:`Site-dashboard<dashboard_types>`
_static/widgets/Properties_5.png
При выборе свойства Электронная подпись отображаются данные о сертификате ЭЦП и времени подписания:
_static/widgets/Properties_6.png

Для виджета так же доступен переход в конструктор формы для дополнительной настройки полей. См. подробную статью :ref:`Формы<forms>`


_static/widgets/form_builder_icon.png

_static/widgets/form_builder_form.png

Для типа дашборда Case-details доступна настройка режима просмотра с возможностью inline редактирования значений атрибутов или редактирования в режиме "формы". По умолчанию выставлен режим просмотра.

Для изменения режима необходимо в карточке нажать шестеренку- > «Настроить страницу»:

_static/widgets/case_edit_1.png

В настройке карточки перейти в раздел "Виджеты", и у виджета "Свойства" нажать:

_static/widgets/case_edit_2.png

В настройках выбрать "Режим редактирования" и нажать "Применить":

_static/widgets/case_edit_3.png

В настройке карточки нажать "Применить".

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

_static/widgets/case_edit_4.png

Если пользователь вносит изменения, то в шапке виджета становятся доступны кнопки "Отмена" и "Сохранить".

Если изменений нет - кнопки в шапке виджета отсутствуют.

Если поля при редактировании не проходят валидацию - кнопка "Сохранить" становится не доступна для нажатия:

_static/widgets/case_edit_5.png

Ключ current-tasks

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

_static/widgets/task.png

Ключ tasks

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

Настройка

_static/widgets/all_tasks_1.png
Настроенный вид

_static/widgets/all_tasks_2.png

При нажатии на:

_static/widgets/all_tasks_3.png

отображается схема выбранного бизнес-процесса с выделенной текущей задачей:

_static/widgets/all_tasks_4.png

Note

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

Ключ doc-status

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

_static/widgets/status.png

Ключ events-history

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

Виджет представлен в виде таблицы.

_static/widgets/History_1.png

Для каждого столбца можно настроить фильтрацию и поиск событий:

_static/widgets/History_2.png

Если в типе данных поля заданы как мультиязычные, то показываются мультиязычные значения:

_static/widgets/History_4.png

Для bpmn-процесса:

_static/widgets/History_3.png

В виджет добавлены события по сущности процесса:

  • Создании процесса
  • Обновлении версии. Так же с указанием исходной версии.
  • Публикации версии в движок

Ключ versions-journal

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

Служит для загрузки новой версии документа, а также для сравнения файлов.

_static/widgets/version_1.png

Версии документов можно сравнить - выбрать версии и нажать Сравнить. Различия будут подсвечены:

_static/widgets/version_2.png

Для bpmn-процесса:

_static/widgets/version_3.png

В виджете реализован функционал "тегов". Для версии процесса, которая была опубликована, будет показываться тег "Опубликовано", для процесса, сохраненного как черновик - "Черновик" (1).

Добавлена кнопка редактирования (2), при нажатии на которую, открывается bpmn-редактор процесса конкретной версии.

При нажатии на кнопку скачать (3) происходит скачивание конкретной версии процесса.

При сохранении процесса в редакторе, если есть различия, происходит сохранение инкремента версии.

Cравнение версий процесса - выберите версии и нажмите "Сравнить" (4):

_static/widgets/version_4.png

Для загрузки новой версии нажмите (5):

_static/widgets/version_5.png

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

Добавленная версия станет актуальной.

Ключ doc-associations

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

_static/widgets/doc-associations.png

и отображения установленных связей.

_static/widgets/doc-associations_1.png

Настройки производятся на вкладке :ref:`Связи<datatypes_associations>` типа данных. Связь может быть настроена с любой ассоциацией.

Ключ record-actions

Виджет содержит перечень доступных действий с кейсом на данном статусе.

Настройки подтягиваются из :ref:`типа данных<data_types_main>`. См. подробную статью :ref:`Действия<ui_actions>`

_static/widgets/actions.png

Ключ barcode

Виджет отображает отображает сгенерированный штрих-код документа, основанный на числовом поле документа.

По умолчанию используется поле idocs:barcode.

Если нужно другое поле, то следует зарегистрировать это поле по типу ECOS в бине core.barcode-attribute.type-to-property.mappingRegistry Пример:

<bean id="records.contracts.barcode-attribute.type-to-property.mapping"
    class="ru.citeck.ecos.spring.registry.MappingRegistrar">
    <constructor-arg ref="core.barcode-attribute.type-to-property.mappingRegistry"/>
    <property name="mapping">
        <map>
            <entry key="contracts-cat-doctype-contract" value="contracts:barcode"/>
        </map>
    </property>
</bean>
Настройка

_static/widgets/barcode_1.png
Условие отображения кнопки:
Если отсутствует условие, то кнопка отображается. Иначе для отображения, API по заданному условию должно возвращать true.
В текущей версии сохраняется как json строка.
Написание условия в соответствии статье :ref:`Язык предикатов <ecos-predicate_main>`
Настроенный вид
Для типа дашборда Case-details
_static/widgets/barcode_2.png

Ключ documents

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

Настройка
Если корневой уровень (на скриншоте Базовый тип) один, то он раскрывается по умолчанию:
Документы
_static/widgets/documents_01.png
Синхронизация пользователей
_static/widgets/documents_02.png
Доступно отображение только выбранных типов по соответстующему чекбоксу:
_static/widgets/documents_03.png
При выборе типа чекбоксом и наведении мышки на строку:
_static/widgets/documents_04.png
становится доступна настройка выбранного типа документа:
_static/widgets/documents_05.png
При поиске типа раскрываются все вложенности и подсвечиваются совпадения:
_static/widgets/documents_06.png
Настроенный вид
Документы:
_static/widgets/documents_07.png
В списке типов документов может встречаться одинаковое название, поэтому при наведении на тултип дополнительно отображается порядок вложенности:
_static/widgets/documents_08.png
По кнопке Скачать все документы скачивается zip-архив со всеми загруженными файлами.
Для всех типов доступен фильтр Все статусы, в котором представлены системные статусы для документа:
_static/widgets/documents_10.png

Синхронизация пользователей:
_static/widgets/documents_09.png

Ключ doc-constructor

Виджет для использования конструктора документов Doc.one.

Doc.one - программа по составлению документов, с помощью которой можно преобразовать любые типовые документы, в умные шаблоны Doc.one.

Настройка

_static/widgets/doc_one_1.png
Настроенный вид

_static/widgets/doc_one_2.png

Note

Доступно только в enterprise версии.

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

Ключ process-statistics

Виджет визуализирует статистику по бизнес-процессу с отображением тепловой карты (heatmap).

Тепловая карта (heat map) — инструмент, который визуализирует данные при помощи разных цветов. Данные отображаются в виде цветных пятен.

У виджета возможны 2 представления:

Упрощенный режим – отображается только бизнес-процесс:

_static/widgets/Process_statistics_01.png

Расширенный режим:

_static/widgets/Process_statistics_02.png

При максимальных настройках по умолчанию в расширенном режиме доступны:

  • Процесс (1)

  • Тепловая карта (2) - Более активным элементам соответствуют тёплые тона, чем меньше показатели — тем холоднее цвет.

  • Счетчики (3) - Для каждого шага процесса отображает количество инстансов процесса, находящихся на данном шаге. Отображение счетчиков можно включить/выключить, отображение самого бизнес-процесса останется.

    • А – активные инстансы
    • В – завершенные инстансы
  • Панель тепловой карты (4) – настройка прозрачности, отображение активных и завершенных инстансов

  • Журнал (5) - В журнале для каждого столбца можно настроить фильтрацию и поиск событий. Визуализация будет перерисована в соответствии с выбранными фильтрами.

    _static/widgets/Process_statistics_03.png

Для масштабирования используйте сочетание ctrl и скролл мыши.

Для перемещения по heatmap влево- вправо - сочетание shift и скролл мыши.

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

В настройках виджета выбираются:

  • режим отображения;

  • отображаемые по умолчанию элементы виджета, и отображение цветовой панели тепловой карты.

    _static/widgets/Process_statistics_04.png

Note

Доступно только в enterprise версии.

Ключ stages

Виджет визуализирует прохождение :ref:`ECOS стадий<stages>` документа:

_static/widgets/stages_1.png
Настройка

_static/widgets/stages_2.png
Если снять чекбокс, то будет показана только текущая стадия:
Настроенный вид

_static/widgets/stages_3.png

Ключ report

Виджет отображает статистику по задачам.

_static/widgets/statistics.png

Ключ birthdays

Виджет отображает ближайшие дни рождения .

_static/widgets/bday.png

Ключ user-profile

Виджет профиля пользователя

_static/widgets/profile.png

Ключ kanban-board

Note

Доступно только в Enterprise версии.

Виджет добавляет в карточку :ref:`канбан доску<kanban_board>` с настраиваемым журналом, связанным атрибутам и шаблонами для удобства пользователя и быстрым взаимодействием со статусами через карточку.

Виджет доступен только для следующего :ref:`представления дашборда<dashboard_view>`:

_static/widgets/kanban_1.png
Настройка

_static/widgets/kanban_2.png
Заголовок виджета.
Выбор журнала по типу.
По чекбоксу "Отображать только связанные записи" можно выбрать связанные атрибуты, которые будут использоваться для фильтрации записей на канбан доске. Виджет будет отображать только те записи, которые имеют выбранные связанные атрибуты или на них есть ссылки.
_static/widgets/kanban_4.png
Выбор сохраненных шаблонов журнала и созданных канбан досок.
_static/widgets/kanban_5.png
Настроенный вид
Виджет используется в модуле "Офферы". В карточке заявки, по которой уже идет подбор кандидата, доступна вкладка Канбан-доска, на которой отображены кандидаты по данной заявке в различных статусах:
_static/widgets/kanban_3.png

Note

Доступно только в enterprise версии.

Ключ charts

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

_static/widgets/chart_1.png

При разработке использована библиотека Chart.js

Виджет поддерживает различные типы графиков: линейные, столбчатые, круговые.

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

Графики конфигурируемые - пользователи могут настраивать оси, масштабирование и т.д.

_static/widgets/chart_2.png

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

_static/widgets/chart_3.png

Для всех типов графиков:

_static/widgets/chart_4.png
Название виджета Укажите наименование представления.
Тип графика
Выберите тип из списка:
- Столбчатый
- Круговой
- Линейный
Настройки журнала  
Журнал
Выберите журнал, по данным которого необходимо построить график.
В выбранном журнале должны быть заранее настроены колонки для группировки. Действие доступно для администратора.
Для разрешения группировки перейдите в журнале к необходимому столбцу, нажмите Дополнительно:
_static/widgets/chart_sett_01.png
Выставите чекбокс Можно ли группировать:
_static/widgets/chart_sett_02.png
Шаблон журнала Выберите шаблон журнала.
Атрибуты группировки
Группировка - операция объединения данных в группы таким образом, чтобы у элементов в каждой группе был общий атрибут.
Нажмите "Добавить" и выберите из списка атрибуты, по которым производить группировку данных.
В списке представлены атрибуты, у которых в настройках разрешена группировка.
Атрибут агрегации Выберите атрибут из представленых в списке, по которому возвращать сводные данные.
_static/widgets/chart_8.png

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

_static/widgets/chart_5.png
Минимальное вертикальное значение Минимальное значение, отображаемое на вертикальной шкале
Максимальное вертикальное значение Максимальное значение, отображаемое на вертикальной шкале
Соотношение сторон x/y Дробное. Масштабирования оси - отношение единицы X к единице Y. По умолчанию 2.

Примеры различных соотношений сторон:

2:

_static/widgets/chart_6.png

4:

_static/widgets/chart_7.png
_static/widgets/chart_10.png

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

_static/widgets/chart_9.png
Минимальное вертикальное значение Минимальное значение, отображаемое на вертикальной шкале
Максимальное вертикальное значение Максимальное значение, отображаемое на вертикальной шкале
Соотношение сторон x/y Дробное. Масштабирования оси - отношение единицы X к единице Y. По умолчанию 2.
Растяжение Уровень плавности линии графика. По умолчанию 0.
_static/widgets/chart_12.png

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

_static/widgets/chart_11.png
Радиус середины Радиус центрального круга, в процентах от радиуса основного. По умолчанию 50 %.