Глава 7. Реестры

Ревизия VCS: 8198

Дата сборки документа: 2017.07.27 14:48:09

Содержание

Список реестров
Создание новой записи
Изменение записи
Удаление записи
Поиск по реестру
Навигатор реестров

Список реестров

Экран со списком реестров представлен на илл. «Список реестров».

Рисунок 7.1. Список реестров

Список реестров

Рисунок 7.2. Окно «Реестры» (вид по умолчанию)

Окно «Реестры» (вид по умолчанию)

Элементы управления экрана со списком записей реестра.

Элемент управления Расположение на экране Описание

Верхняя панель

/

Слева

«Навигатор» - кнопка перехода к навигатору реестров

«Реестры»

По центру

Выпадающий список для переключения между модулями

/

Справа

Системное меню - выпадающий список с пунктами:

  • «Полный», если отображаются краткие плашки записей реестра, или «Краткий», если отображаются полные плашки;

  • Сортировка;

  • Поиск

Элемент не отображается, если выбрана группа реестров

/

Левее кнопки «Меню»

«Создать» - кнопка добавления новой записи реестра и создания документа

Элемент не отображается, если выбрана группа реестров

Компонент «Путь»

Ниже верхней панели

Компонент, отображающий путь до выбранного реестра

Рабочая область

Вся рабочая область ниже пути

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

Примечание

Метод получения доступных реестров и прав пользователя на них: rest/api/registry/list

Метод получения записей реестра: rest/api/registry/getRegistryData

По нажатию на «Реестры» на верхней панели не отображаются все кнопки, под панелью открывается выпадающий список с модулями (илл. «Переключение между модулями»):

Рисунок 7.3. Переключение между модулями

Переключение между модулями

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

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

Компонент «Путь» содержит полный путь до выбранного элемента навигатора. Содержимое компонента:

  • для выбранной группы реестра - полные названия групп реестров от корневой родительской до текущей открытой, включая её саму;

  • для выбранного реестра - полные названия групп реестров, крайний элемент в списке - непосредственно реестр.

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

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

  • переход в любую группу реестров / реестр, используя навигатор;

  • переход только в дочерние группы реестров / реестры из общего списка групп реестров / реестров;

  • переход в родительские группы реестров, используя компонент «Путь».

Список в основной области содержит:

  • для выбранной группы реестра - дочерние группы реестров и реестры;

  • для выбранного реестра - непосредственно записи реестра.

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

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

Плашка реестра, записи реестра.

Плашка записи реестра/ группы реестров - это компонент, отображающий информацию об элементе реестра или название группы.

При выборе группы реестров отображаемый список содержит сведения о реестрах и группах реестрах, входящих в выбранную группу:

  • для группы реестра отображается иконка группы и название группы (параметр regGroupName);

  • для реестра отображается иконка реестра и название реестра (параметр registryName).

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

Пиктограммы статусов записи реестра:

Пиктограмма Статус

пиктограмма отсутствует

Подготовка

/

В процессе

/

Активная

/

Неуспешная

Данные записи реестра отображаются в следующем формате:

%Название_столбца%: %значение%

Количество данных в плашке зависит от того, какой используется вид просмотра:

  • Краткий (по умолчанию): плашка отображает только те отображаемые столбцы, которые помечены как значащее содержимое. При отображении краткого списка пункт меню принимает значение «Полный» для переключения в полный вид.

  • Полный: плашка отображает все отображаемые столбцы. При отображении краткого списка пункт меню принимает значение «Краткий» для переключения в краткий вид.

Примечание

Если в реестре отсутствуют столбцы, помеченные как значащее содержимое, плашка всегда отображается в полном виде. При этом пункт «Краткий» не отображается в меню .

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

Рисунок 7.4. Окно «Реестры» (полные плашки)

Окно «Реестры» (полные плашки)

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

Возможные действия на экране.

По нажатию на кнопку «Навигатор», а также проведя пальцем от левой стороны экрана к правой, раскрывается левая панель навигатора по реестру.

По нажатию на кнопку «+» вызывается меню «Создать» (аналогичное в модуле «Работы»), в построении которого участвуют пункты параметра register_items:

  • favorite_documents;

  • all_documents;

  • new_record.

Функциональность пунктов favorite_documents и all_documents аналогична описанной в разделе «Создание работы / документов».

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

Примечание:

Метод получения настроек пунктов создания записей реестров описан в javadoc:

kz.arta.synergy.server.api.rest.common.RegistryService#getRegisterItems

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

Если список создания записи / документов пуст, то кнопку «+» отрисовывать не нужно. Если же меню содержит только один пункт, то по нажатию кнопки «+», исключая его, должно выполняться соответствующее действие и вызываться соответствующий экран. При формировании списка элементов в меню «Создать» необходимо учитывать, что если у авторизованного пользователя нет права на создание записи в текущем реестре, то пункт new_record не должен отображаться.

По нажатию на кнопку «Назад» происходит закрытие приложения.

Примечение:

Метод получения сведений о настроенных событиях реестра описан в javadoc:

kz.arta.synergy.server.api.rest.common.RegistryService#getRoute

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

  1. При выделении папки (tap) обновляется список: в нем должны отображаться реестры, входящие в данную группу.

Примечание:

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

  1. Обработка долгого нажатия отсутствует.

Возможные действия с плашкой реестра:

  1. При выделении реестра (tap) открывается список записей реестра.

  2. Обработка долгого нажатия отсутствует.

Возможные действия с плашкой записи реестра

  1. При выделении записи реестра (tap) открывается проигрыватель форм (при условии наличия у авторизованного пользователя права «Просмотр данных» для текущего реестра).

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

Создание новой записи

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

Примечание:

Метод создания новой записи реестра:

kz.arta.synergy.api.rest.registry.RegistryService#createRegistryDocument

Нажатие на кнопку «Назад» возвращает пользователя в список элементов реестра.

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

Примечание:

Метод активации записи реестра (в случае отсутствия маршрута активации):

kz.arta.synergy.api.rest.registry.RegistryService#activateRegistryDocument

Метод запуска маршрута реестра (с активацией новой записи):

kz.arta.synergy.api.rest.registry.RegistryService#startRoute

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

Изменение записи

Находясь в проигрывателе форм, пользователь нажимает на кнопку меню и выбирает пункт «Режим редактирования».

Примечание:

Отображение пункта «Режим редактирования» зависит от прав авторизованного пользователя на текущий реестр и статуса записи реестра:

  • «Изменение» - изменение записи со статусом «активная»;

  • «Редактирование» - изменение файлов по форме реестра (для всех статусов, кроме «активная»).

По нажатию на иконку «Сохранить» и при переключении между режимами основного представления происходит валидация формы:

  • для мобильного представления - на заполненность обязательных полей (только среди отображаемых);

  • для основного представления - на заполненность обязательных полей и корректность заполнения других (определяется настройками компонентов).

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

Заполните обязательные поля

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

В случае же успешного сохранения (вне зависимости от того, по нажатию на какую кнопку оно было выполнено) выдается сообщение «Данные сохранены», документ сохраняется, и происходит проверка наличия у текущего реестра маршрута изменения. В случае, если он указан, то выполняется его запуск. Если маршрут изменения не указан, то пользователь остается на текущем экране.

Если текущая версия данных уже была сохранена, то кнопка «Сохранить» должна быть недоступна для нажатия.

По нажатию на кнопку «Готово» происходит сохранение формы (если это не было сделано). В случае успешного сохранения открывается список элементов реестра.

Если после внесения изменений в форме пользователь нажимает на кнопку «Назад», выдается системное предупреждающее диалоговое окно с текстом:

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

и кнопками:

  • «Да» - происходит сохранение формы и, при успешном сохранении, переход к списку элементов реестра;

  • «Нет» - последние изменения отменяются, открывается список элементов реестра;

  • «Отмена» - окно закрывается, пользователь остается в проигрывателе формы.

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

Примечание:

Метод изменения записи реестра (без запуска маршрута):

kz.arta.synergy.api.rest.registry.RegistryService#modifyRegistryDocument

Метод запуска маршрута реестра (с изменением записи):

kz.arta.synergy.api.rest.registry.RegistryService#startRoute

Нажатие на кнопку «Назад» возвращает пользователя в список элементов реестра.

Удаление записи

Пользователь нажимает на пункт меню «Удалить», приложение запрашивает подтверждение выполнения действия с сообщением:

Вы действительно хотите удалить запись?

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

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

Если маршрута удаления нет, то запись реестра удаляется. Плашка записи реестра также удаляется из списка.

Примечание:

Метод удаления записи реестра (без запуска маршрута):

kz.arta.synergy.api.rest.registry.RegistryService#deleteRegistryDocument

Метод запуска маршрута реестра (с последующим удалением):

kz.arta.synergy.api.rest.registry.RegistryService#startRoute

Поиск по реестру

При выборе пункта меню «Поиск» открывается окно поиска по реестру (илл. «Окно поиска по реестру»):

Рисунок 7.5. Окно поиска по реестру

Окно поиска по реестру

Рисунок 7.6. Окно поиска по реестру

Окно поиска по реестру

При переходе к экрану поиска отображается пустой запрос поиска.

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

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

Пример результатов поиска по запросу «038» приведен на рисунке «Результаты поиска по реестру»:

Рисунок 7.7. Результаты поиска по реестру

Результаты поиска по реестру

Рисунок 7.8. Результаты поиска по реестру

Результаты поиска по реестру

Возможные действия с плашкой записи реестра в окне поиска

  1. При выделении записи реестра (tap) открывается проигрыватель форм.

  2. Обработка долгого нажатия отсутствует.

По нажатию на кнопку «Назад» открывается список записей текущего реестра.