Описание компонента
Компонент «Управление справочной информацией Platform V Dictionaries» входит в состав сервиса «Сервис управления процессами (услуга 1.12)».
Компонент «Управление справочной информацией Platform V Dictionaries» обеспечивает хранение, версионирование, актуализацию и получение справочных данных.
Справочник — зафиксированный на определенный момент именованный набор данных, предназначенный для регулярного использования в неизменном виде в целях классификации данных в соответствии с определенными в справочнике значениями, обогащения данных, а также для реализации отдельных проверок и валидации.
Сервис поддерживает следующие типы справочников:
- внутренние — справочники, владельцами и пользователями которых являются функциональные подсистемы, реализованные на Платформе. Справочники данного типа создаются в рамках клиентских приложений;
- внешние — справочники, владельцами которых являются сторонние автоматизированные системы (АС). Справочники данного типа находятся в открытом доступе. Загрузка справочников из внешних АС осуществляется интеграционными адаптерами.
Компонент предоставляет возможность, используя административный интерфейс компонента, выполнить:
- просмотр списка справочников тенанта;
- поиск справочников тенанта;
- создание справочника;
- поиск и просмотр версий данных справочника;
- добавление новой версии данных внутреннего справочника, в т.ч. путем копирования;
- удаление версии данных внутреннего справочника;
- активацию наполненной данными версии внутреннего справочника;
- поиск и просмотр данных справочника;
- добавление записи созданной версии внутреннего справочника;
- добавление перевода для внутреннего мультиязычного справочника;
- изменение записи внутреннего справочника;
- удаление записей внутреннего справочника;
- импорт данных в созданную версию внутреннего справочника из файла CSV определенного формата;
- экспорт записей справочника в файл CSV;
- просмотр версий структуры справочника;
- добавление версии структуры справочника путем импорта XML-файла определенного формата;
- просмотр описания версии структуры справочника;
- активацию версии структуры справочника;
- поиск и просмотр маршрутов справочника;
- добавление маршрута для справочника;
- изменение маршрута справочника;
- удаление маршрута справочника.
Компонент предоставляет возможность, используя API, выполнить:
- запрос данных активной версии справочника, в т.ч. данных версии мультиязычного справочника для заданного языка;
- импорт модели (структуры) справочника из файла XML определенного формата;
- активацию модели (структуры) справочника;
- удаление неактивированной модели (структуры) справочника;
- создание новой версии внешнего справочника;
- удаление неактивированной версии внешнего справочника;
- загрузку данных, переданных в теле запроса, в созданную версию внешнего справочника;
- активацию наполненной данными версии внешнего справочника, в т.ч.:
- активацию версии внешнего пилотируемого справочника в пилотном блоке;
- активацию версии внешнего пилотируемого справочника в основном блоке;
- отправку уведомления о бизнес-ошибке при обращении к справочнику.
Создание и загрузка справочников производится средствами сервиса загрузки справочников Dictionary import adapter через интерфейс администрирования Dictionary front.
При создании справочника пользователь настраивает профиль, определяющий структуру и источник данных. Подробнее о создании и загрузке справочников см. в разделе Загрузка справочников.
Актуализация внутренних справочников выполняется с помощью загрузки обновленной версии справочника. Для обновления внешних справочников создаётся фоновая задача, в которой указывается источник данных и настраивается периодичность синхронизации справочника с источником. Подробнее о фоновых задачах см. в статье Фоновые задачи.
Взаимодействие со справочниками и получение данных происходит посредством REST API. Таким образом исключается прямое взаимодействие клиентских приложений с базой данных и обеспечивается дополнительный уровень кэширования.
Общая схема загрузки справочников и получения информации по ним представлена ниже:
Увеличить
Для управления справочниками реализован интерфейс администрирования, доступный авторизованному пользователю. Доступ к управлению справочниками предоставляется пользователям с правами бизнес-администратора или системного администратора.
Минимальная конфигурация Сервиса обеспечивает:
- компонент «Интеграция со СМЭВ Platform V SMEV Gateway» предоставляет функциональность обмена данными с Системой межведомственного электронного взаимодействия версии 3 (схемы 1.2 и 1.3);
- размер файлов, принимаемых в обработку компонентом «Интеграция со СМЭВ Platform V SMEV Gateway» — 5242880 байт;
- компонент «Центр уведомлений Platform V Notification Center» поддерживает возможность отправки уведомлений по каналам email, ГосПочта, sms, webhook с производительностью до 60 tps (требуется организация соответствующего канала);
- для компонента «Моделирование и исполнение бизнес-сценариев Tasklist Platform V Flow» максимальный размер запроса (параметр
utsk max.request.size) — 5242880; - для компонента «Моделирование и исполнение бизнес-сценариев Engine Platform V Flow» размер «пачки» job, которые будут исполняться на одном ядре, (параметр
maxAsyncJobsDuePerAcquisition) — 5.
В демопримерах реализованы стандартные сценарии, демонстрирующие работу отдельных сервисов Платформы ГосТех. Отправка тестовых запросов в демопримерах позволит вам ознакомиться с функциями того или иного сервиса. Доступные демопримеры и описания реализованной в них функциональности представлены ниже.
Справочники GET
Получение доступных справочников и данных об их элементах по коду на примере трёх общедоступных классификаторов: ОКЕИ, ОКВЭД, ОКОПФ
Справочники POST
Получение данных из доступных справочников на примере трёх общедоступных классификаторов: ОКЕИ, ОКВЭД, ОКОПФ. Настройка отображаемых столбцов