При оформлении необходимо руководствоваться шаблоном оформления UI.
Общие требования к оформлению технических (проектных) решений и построению UI отражены здесь.
Описанные ниже требования должны применяться во всех формах UI в случае если в описании конкретного UI не уточнены иные требования.
Общие требования по отображению списковых форм.
В рамках описания любой списковой формы при проектировании должны быть определены:
- перечень выводимых полей-атрибутов;
- требования к режимам просмотра списка (отображение по умолчанию, группировка, сортировка);
- требования к подчиненной форме, связанной с элементом списка (карточка (таблица) оперативного просмотра);
- требования к панели фильтров (выборка записей по заданному перечню атрибутов);
- описание групповых операций (одновременные действия над несколькими элементами списка, например: сравнение элементов списка, изменение атрибутов для нескольких элементов списка, изменение прав доступа для нескольких элементов списка);
- описание форм (панелей) оперативных статистических отчетов (мониторинга) по результатам выборки списка;
- описание требований к отчетам для вывода на печать и алгоритм их формирования;
- требования по оповещению пользователей (внешних систем) при изменении объектов.
При проектировании списковых форм хорошо зарекомендовали себя следующие правила:
- Все элементы управления формой должны располагаться в верхней части в форме панели инструментов — при этом вероятность того, что пользователь «потеряет» их, сводится практически к нулю. При этом практика показала целесообразность отказа от строки иерархического меню в пользу ленточного интерфейса (ribbon).
-
Для всех списков, как правило, на ленте должны присутствовать четыре группы элементов управления:
- действия с одной записью из списка — как правило, эти действия сводятся к аббревиатуре CRUD: добавление, просмотр, редактирование, удаление;
- режимы просмотра (как правило, здесь располагаются элементы управления группировкой и фильтрацией списка);
- групповые операции;
- сервисные функции (вызов справки, пользовательская настройка списка, сбор предложений по доработке).
- При формировании статистических отчетов (в т.ч. и для вывода на печать) желательно не создавать специализированные формы для предварительной настройки этих отчетов. Сама списковая форма с ее возможностями выборки, сортировки и отображения объектов должна обеспечивать предварительную настройку требуемых отчетов. Другими словами по возможности отчеты должны формироваться на основе выбранных критериев при формировании списков.
Сортировка
Столбцы таблиц должны обеспечивать сортировку данных при нажатии на заголовок. Алгоритм сортировки по умолчанию должен соответствовать типу данных выводимых в столбце (текстовый, числовой, дата).
В случае если выводится комплексное значение (например перечень наименований объектов) - алгоритм сортировки по умолчанию должен соответствовать текстовому типу данных.
Данные условия должны применяться при сортировке записей во всех списковых формах , в случае если в описании списковой формы не уточнены иные условия сортировки.
Фильтрация
Требования для механизмов фильтрации:
- значения фильтров по умолчанию для списковых форм должны обеспечивать вывод всех возможных записей для отображения в списке;
- поиск по тексту осуществляется на основании совпадения значения введенного в поле фильтра с частью значения соответствующего текстового атрибута (регистр букв не учитывается);
- при задании нескольких условий отбора в разных полях панели фильтра, эти условия объединяются на основании логической операции «И»;
- при задании нескольких условий отбора в одном поле множественного выбора панели фильтра, эти условия объединяются на основании логической операции «ИЛИ»;
- в фильтрах множественного выбора значение по умолчанию «Все записи» - при этом ограничения выбора по данному атрибуту не применяются (в случае, если фильтр относится к необязательному атрибуту, в перечень опций выбора должна быть добавлена опция «Не указано»). В случае если в фильтре множественного выбора пользователь не выбрал ни одну из опций, в списке не будет выведено ни одной записи.
Данные условия должны применяться при фильтрации записей во всех списковых формах , в случае если в описании списковой формы не уточнены иные условия фильтрации.
Общие требования по отображению карточек объектов.
В рамках описания карточки объекта при проектировании должны быть определены:
- макет карточки просмотра;
- перечень действий, которые можно произвести с объектом учета (CRUD, изменение статуса, согласование и т.п.) и требуемые для этих действий полномочия доступа;
- описание правил валидации атрибутов при добавлении/редактировании;
- перечень возможных информационных сообщений;
- способы просмотра истории изменений объекта.
Общие требования по первичному учету.
Требования по регистрации и отображению значений календарных дат и времени.
При регистрации связанных дат, всегда необходимо обеспечить контроль корректности регистрации этих дат. Например если в форме указываются даты начала и окончания действия, дата окончания не может быть раньше даты начала.
При регистрации дат рождения людей необходимо обеспечить контроль, чтобы регистрируемая дата не была более ранней чем текущая дата.
В случае, если в БД для хранения неизвестной даты используется значение "31.12.2099", то такое значение не выводится в UI.
Время в UI выводится по шаблону hh.mm.ss
Даты в UI выводится по шаблону dd.mm.уу
Требования по регистрации текстовых полей.
При регистрации фамилии, имени и отчества, необходимо обеспечить контроль ввода только кириллических символов. Так же допускается ввод символов дефиса и апострофа.