Описание сервиса загрузки
Сервис загрузки справочников предназначен для ведения актуальных справочников с целью последующей их передачи клиентам.
Сервис предоставляет REST интерфейс c набором инструментов для подготовки справочников к загрузке:
- поддержка описаний метаданных справочников и правил загрузки данных в справочник (профиль справочника);
- создание нового профиля справочника с возможностью редактирования;
- загрузка актуальных данных в справочник из разных источников;
- возможность настройки расписания для автоматической загрузки справочников.
Адрес сервиса: http://<адрес виртуальной машины>:8083/nsi-adapters/api/import-adapter/swagger-ui.html
Узнать адрес виртуальной машины можно в паспорте стенда вашего проекта. Дополнительную информацию можно получить у аккаунт-менеджера.
Справочники описываются через сущность "Профиль". Именно через профиль справочника определяется структура таблицы и источник данных.
Описание структуры таблицы включает в себя:
- тип профиля загрузки - определяет расширение файла источника данных. Для каждого расширения предлагается выполнить соответствующие настройки (см. раздел Создание профиля справочника);
- спецификация колонок справочника - является конструктором справочника, в рамках которого определяется именование колонок, их описание, а также правила формирования значений для полей справочника. Построение правил зависит от расширения файла источника. Помимо специфичных для каждого расширения характеристик, для построения правил могут быть использованы дополнительные инструменты (типы правил). Они служат для выполнения преобразований данных из разных колонок:
- калькуляции (
CALCULATED_FIELD) - помещение вычисленного значения в поле (колонку таблицы); - чекеры (
CHEKER) - сравнение полей (данный тип правил возвращает boolean-значение).
- калькуляции (
Подробнее про построение правил см. в разделе Создание профиля справочника.
При настройке источника данных указывается файл с данными справочника для загрузки.
Основная задача сервиса - обеспечить загрузку справочника в платформу для поддержки в ней актуальных данных. Для этого необходимо выполнить следующее:
- Создайте (или выберите ранее созданный) профиль справочника.
- Загрузите файл с актуальными данными справочника в сервис.
- Выполните загрузку справочника вручную или настройте загрузку по расписанию.
Загрузка справочника вручную выполняется из карточки профиля. Для загрузки по расписанию необходимо настроить фоновую задачу.
В демопримерах реализованы стандартные сценарии, демонстрирующие работу отдельных сервисов Платформы ГосТех. Отправка тестовых запросов в демопримерах позволит вам ознакомиться с функциями того или иного сервиса. Доступные демопримеры и описания реализованной в них функциональности представлены ниже.
Справочники GET
Получение доступных справочников и данных об их элементах по коду на примере трёх общедоступных классификаторов: ОКЕИ, ОКВЭД, ОКОПФ
Справочники POST
Получение данных из доступных справочников на примере трёх общедоступных классификаторов: ОКЕИ, ОКВЭД, ОКОПФ. Настройка отображаемых столбцов