Настройка справочников

Блок для работы со справочниками доступен в разделе Справочники в модуле «Настройки системы» (Рисунок 1)

Рисунок 1 – Переход в блок для работы со справочниками

В разделе «Справочники» доступны поля и фильтры для поиска справочников (Рисунок 2).

Рисунок 2 – Раздел «Справочники»

После перехода в искомый справочник доступно создание (кнопка «Новый элемент (1)) и редактирование записи (2) (Рисунок 3)

Рисунок 3 – Переход к созданию новой записи/редактированию записи

 

Настройки справочников

В разделе «Настройки справочников» доступны функции создания (1), редактирования (2) и настройки справочников, которая будет доступна после перехода в режим редактирования справочника (Рисунок 4)

Рисунок 4– Раздел «Настройки справочников»

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

Создание справочника

Для создания справочника в модуле «Настройки системы» необходимо слева на панели выбрать пункт меню Справочники раздел «Настройки справочников» и в сером поле меню нажать кнопку «Новый справочник» (Рисунок 5)

Рисунок 5 – Кнопка «Новый справочник» в модуле «Настройки системы»

После нажатия на кнопку «Новый справочник» откроется экранная форма для создания справочника с типом «Локальный» (Рисунок 6)

Рисунок 6 – Форма для создания справочника с типом «Локальный»

Форма создания справочника

В экранной форме создания справочника необходимо будет заполнить обязательные поля (Рисунок 7):

- Код справочника

- Наименование справочника

В поле Тип справочника указан доступный для создания пользователем тип справочника «Локальный»

Рисунок 7 – Обязательные поля формы создания справочника

Поле Код справочника состоит их трех частей (Рисунок 7):

- первая часть (не меняется пользователем) nsi – часть кода, обозначающая принадлежность структуры данных к системе справочников в Системе

- вторая часть (не меняется пользователем) - мнемоника (Local) – часть кода, обозначающая тип справочника

- третья часть — это код, вводимый пользователем для идентификации справочника

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

Код справочника должен быть уникальным. Если ввести уже существующий код, то система выведет предупреждение и не позволит создать такой справочник (Рисунок 8)

Рисунок 8 – Заполнение поля «Код справочника»

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

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

При необходимости в форме создания справочника можно отметить чек-боксы:

- Иерархический справочник

- Версионируемый

- Возможна настройка доп.полей на элементы справочника

- Формировать код элемента автоматически

При отметке чек-бокса «Иерархический справочник» в справочник становится возможно добавить дочерние элементы и просматривать структуру в виде иерархии. Описание работы с иерархическими справочниками подробно рассмотрено в пункте Иерархический справочник

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

При отметке чек-бокса «Возможна настройка дополнительных полей на элементы справочника» появляется возможность настраивать дополнительные поля для каждого элемента справочника в отдельности

При отметке чек-бокса «Формировать код элемента автоматически» появляется раздел «Параметры автоматического формирования кода», в котором необходимо указать параметры для настройки автоматического формирования элемента:

- префикс

- длина номерной части

- начать нумерацию с «___»

При нажатии на кнопку «настроить» рядом с текстом «Дополнительные поля для справочника не настроены» осуществляется переход к форме «Настройка дополнительных полей» (Рисунок 9)

Рисунок 9– Настройка дополнительный полей справочника

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

Если дополнительные поля не настроены, то в справочнике при создании элемента отображаются поля «Код» и «Значение элемента» по умолчанию (Рисунок 10)

Рисунок 10 – Поля в справочнике по умолчанию при отсутствии настроенных дополнительных полей

После заполнения обязательных полей, отметке необходимых чек-боксов и настройки (при необходимости) дополнительных полей необходимо нажать кнопку «Сохранить» (Рисунок 11)

Рисунок 11 – Сохранение нового справочника

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

Удаление элемента справочника

При необходимости удаления элемента справочника его следует выбрать на панели просмотра элементов, после чего нажать на кнопку «Удалить» (1) (Рисунок 12). Появляется подтверждающее сообщение «Удаление элемента. Вы действительно хотите удалить элемент?» (2). После подтверждения происходит удаление элемента справочника

Примечание – Удаление элементов доступно для справочников с типом «Локальный», «Единый» и «Региональный»

Рисунок 12 – Удаление элемента справочника

Ручное наполнение справочника

После создания справочника переходим к наполнению справочника элементами. Для этого необходимо перейти в раздел «Справочники» (Рисунок 13)

Рисунок 13 – Раздел «Справочники»

В модуле «Настройки системы» доступны функции редактирования, добавления и удаления записей в справочниках с типами «Распределенный», «Единый», «Региональный» и «Локальный»

Для выбора справочника, в который необходимо добавить элементы можно воспользоваться поиском по наименованию или коду справочника (Рисунок 14)

Рисунок 14 – Поиск по наименованию или коду справочника

Выбираем справочник и переходим к нему посредством двойного клика по элементу списка или нажатия на кнопку редактировать в правом верхнем углу в окна предпросмотра (Рисунок 15)

Рисунок 15 – Выбор справочника

Для создания нового элемента в справочнике нажимаем на кнопку «Новый элемент» (Рисунок 16)

Рисунок 16 – Новый элемент

Переходим к форме создания элемента, которая была заранее настроена (Рисунок 17)

Рисунок 17 – Форма создания элемента

Заполняем поля и нажимаем кнопку «Сохранить» (Рисунок 18)

Рисунок 18 – Сохранение элемента справочника

Для возвращения к просмотру элементов справочника нажимаем на кнопку «вернуться» (Рисунок 19)

Рисунок 19 – Кнопка «Вернуться»

В справочнике отображается созданный нами элемент (Рисунок 20).

Рисунок 20 – Созданный элемент

Наполнение справочника из файла

В Системе реализован функционал наполнения справочника (импорта) из файлов с типами csv, json, xml, xlsx. Данный функционал позволяет автоматизировать процесс заполнения справочника

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

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

Экспорт справочника

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

Для экспорта ограничения по выбору справочников отсутствуют

Для экспорта справочника необходимо перейти в пункт меню «Запросы» в раздел «Служебные задачи» в модуле «Настройки системы» (Рисунок 21)

Рисунок 21 – Служебные задачи

Для экспорта справочника нажимаем на кнопку «Новая задача» (Рисунок 22)

Рисунок 22 – Новая задача

На форме создания задачи выбираем тип задачи «Экспорт справочника» (Рисунок 23)

Рисунок 23 – Тип задачи «Экспорт справочника»

Далее заполняем поле «Справочник», в котором указываем код справочника, и поле «Формат файла» и нажимаем кнопку «Запустить» (Рисунок 24)

Рисунок 24 – Тип задачи «Экспорт справочника»

Задача переходит в статус «Завершено» и появляется вкладка «Результаты задачи» в которой отображается экспортированный файл в формате архива (Рисунок 25)

Рисунок 25 – Результаты задачи экспорта

Нажимаем на файл, и он скачивается на компьютер (Рисунок 26)

Рисунок 26 – Сохранение файла

В архиве содержится экспортированный файл выбранного нами формата. Извлекаем файл из архива (Рисунок 27)

Рисунок 27 – Файл в архиве

Открываем файл. В файле содержится информация из справочника. В первой строке таблицы указаны коды полей справочника. Остальные строки соответствуют элементам справочника (Рисунок 28).

Рисунок 28 – Экспортированный файл в виде таблицы

Импорт справочника

Для добавления элементов справочника необходимо подготовить файл для импорта. Файл возможно подготовить самостоятельно или на основе экспортированного файла.

Для импорта доступны только справочники с типами «Распределенный», «Единый» и «Локальный», «Региональный», причем локальный и региональный, доступные в кабинете организации.

При подготовке файла для импорта (на основе экспортируемого файла) необходимо:

1. Оставить следующие столбцы:

a. Столбцы dictionaryType и dictionaryUnitId, значения которых одинаковы для всех записей справочника

b. Столбцы, наименования которых соответствуют системным наименованиям текущего справочника. Например, на Рисунке 29 такими полями являются: code, name, description

2.               Удалить следующие столбцы: guid, auid, parentEntries, dateCreation, userCreation, dateLastModification, userLastModification, entityType, parentId (Рисунок 28)

Пример подготовленного файла (Рисунок 29):

Рисунок 29 – Пример подготовленного файла для импорта

Далее переходим в раздел «Служебные задачи» в модуле «Настройки системы» (Рисунок 30)

Рисунок 30 – Служебные задачи

Нажимаем на кнопку «Новая задача» (Рисунок 31)

Рисунок 31 – Новая задача

На форме создания задачи выбираем тип задачи «Импорт справочника» (Рисунок 32)

Рисунок 32 – Тип задачи «Импорт справочника»

Выбираем нужный справочник (Рисунок 33).

Рисунок 33 – Выбор справочника

Для загрузки файла нажимаем на кнопку «Выбрать файл» (Рисунок 34)

Рисунок 34 – Кнопка «Выбрать файл»

Выбираем файл для импорта (Рисунок 35)

Рисунок 35 – Выбор файла

После выбора справочника и загрузки файла нажимаем кнопку «Запустить» (Рисунок 36).

Рисунок 36 – Запустить импорт справочника

Задача переходит в статус «Завершено» и появляется вкладка «Результаты задачи» в которой отображается статистика по импорту файла (Рисунок 37).

Рисунок 37 – Результаты задачи

Для проверки импорта переходим к нужному справочнику (Рисунок 38)

Рисунок 38 – Проверка импорта

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

Иерархический справочник

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

Рисунок 39 – Чек-бокс «Иерархический справочник»

Переходим к справочнику. Для этого в модуле «Настройки системы» в разделе «Справочники» необходимо кликнуть два раза левой кнопкой мыши по наименованию справочника. При открытии иерархического справочника будут отображаться только элементы первого уровня иерархии (Рисунок 40)

Рисунок 40 – Элементы первого уровня иерархии

Для отображения всех элементов необходимо проставить чек-бокс «Не фильтровать» в фильтре «Дочерние элементы» (Рисунок 41)

Рисунок 41 – Выбрано значение «Не фильтровать» в фильтре «Дочерние элементы»

Создание элементов первого уровня иерархии

При нажатии на кнопку «Новый элемент» создаются элементы первого уровня иерархии (Рисунок 42).

Рисунок 42 – Новый элемент

Расположение создаваемого элемента иерархии отображается сверху (Рисунок 43)

Рисунок 43 – Отображение иерархии

Заполняем форму создания справочника и нажимаем кнопку «Сохранить» (Рисунок 44)

Рисунок 44 – Сохранение элемента

После сохранения элемента появляется вкладка «Дочерние элементы» (Рисунок 45)

Рисунок 45 – Вкладка «Дочерние элементы»

Нажимаем на вкладку «Дочерние элементы и переходим в раздел «Редактирования элемента», далее нажмите на кнопку «Создать дочерний элемент» (Рисунок 46)

Рисунок 46 – Переход в раздел «Дочерние элементы»

В разделе «Редактирования элемента» возможно создать элементы второго уровня. Нажимаем кнопку «Создать дочерний элемент» и переходим к форме создания элемента, на которой отражено, что элемент находится на втором уровне иерархии (Рисунок 47)

Рисунок 47 – Форма создания элемента и его иерархия

Заполняем форму создания элемента (Рисунок 48)

Рисунок 48 - Заполнение формы создания элемента

Нажимаем кнопку «Сохранить» (Рисунок 49)

Рисунок 49 – Сохранить

У дочернего элемента появляется вкладка «Дочерние элементы» (Рисунок 50).

Рисунок 50 – Вкладка «Дочерние элементы»

Далее создание дочерних элементов происходит таким же образом.

Вернемся к элементу первого уровня. Для этого воспользуемся ссылкой на него в отображении иерархии (Рисунок 51).

Рисунок 51 – Возврат к элементу первого уровня

Осуществился переход к форме редактирования элементов. Перейдем на вкладку «Дочерние элементы» (Рисунок 52

Рисунок 52 – Вкладка «Дочерние элементы»

На форме отобразился созданный нами дочерний элемент (Рисунок 53)

Рисунок 53 – Дочерний элемент

При большем количестве дочерних элементов структура может выглядеть следующим образом (Рисунок 54):

Рисунок 54 – Отображение дочерних элементов

Если воспользоваться поиском, то отобразятся не только элементы, подходящие под условие, но и их родительские элементы (Рисунок 55)

Рисунок 55 – Поиск по дочерним элементам

Импорт иерархического справочника

Для добавления элементов иерархического справочника необходимо подготовить файл для импорта. Файл возможно подготовить самостоятельно или на основе экспортированного файла

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

Рисунок 56 – Столбец parentId

При подготовке файла для импорта (на основе экспортируемого файла) необходимо:

1. Оставить следующие столбцы:

a. Столбцы dictionaryType и dictionaryUnitId, значения которых являются одинаковыми для всех записей справочника

b. Столбец parentId, значение которого должно соответствовать значениюиз колонки _id родительской записи. Например, для загрузки новых департаментов с наименованиями «Департамент» 5 и «Департамент 6» значение в колонке parentId соответствует значению из колонки _id родительской записи «Департаменты» и равняется значению 636bbcf60fa7c80007be2b1e

c. Столбцы, наименования которых соответствуют системным наименованиям текущей структуры уровня иерархии справочника. Например, на Рисунок 57 такими полями являются: code, name

2. Удалить следующие столбцы: id, structureType, guid, auid, parentEntries, dateCreation, userCreation, dateLastModification, userLastModification, entityType, actual, dictionaryDatasource (Рисунок 57)

 

Рисунок 57 –Пример подготовленного файла для импорта

Версионирование записей справочника

Версии записи отображаются при переходе к редактированию элемента справочника в разделе «Версии объекта» (Рисунок 58)

Рисунок 58 – Раздел «Версии объекта»

Перейдя в раздел «Версии объекта», можно увидеть информацию о версиях записи справочника: дата и время изменения, а также пользователь, внесший изменения (Рисунок 59)

Рисунок 59 – Информация о версиях записи справочника

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

Рисунок 60 – Кнопки «просмотреть» и «восстановить»

При необходимости можно просмотреть запись справочника в предыдущей версии, нажав на кнопку «просмотреть»

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

Отображение признака информационной системы

При получении справочников из ИС и сохранении в записи справочника информации о том, откуда запись получена, рядом с записью присутствует отметка о принадлежности элемента к информационной системе (Рисунок 61)

Рисунок 61 – Отображение признака информационной системы

После перехода в раздел «Справочники», подраздел «Справочники» (Рисунок 62) открывается интерфейс для просмотра справочников, а также создания и редактирования элементов справочников

Основные элементы экранной формы:

панель поиска (1)

панель фильтрации справочников по:

– наименованию (2)

– коду (3)

– типу (4)

панель перечня справочников (5)

элемент справочник:

- наименование справочника (6)

- код справочника (7)

Рисунок 62 – Раздел «Справочники»

 

Поиск элементов справочника

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

Фильтры позволяют осуществлять отбор элементов по следующим значениям:

- «Код» (2)

- «Наименование» (3)

- «Сортировка по алфавиту»

Рисунок 63 – Поиск значений в справочнике

Использование и настройка Справочников в ФГИС ПГС подробно описаны в Инструкции о конструкторе ФГИС ПГС. Инструкция доступна по ссылке