Mapping и ExternalId

НАЧАЛО >> API ИРБИС 64/128 >> Mapping и ExternalId📄 Скачать в DOCX

MappingProfile и ExternalId являются общесистемными настройками модуля API для внешних интеграций. Они позволяют внешней системе однозначно связать свой объект с внутренним object type ИРБИС 128 и проверить payload до фактического применения изменений.

1. ExternalId

ExternalId хранится как отдельная API-запись с типом Внешний идентификатор.

Связь включает:

внешнюю систему;
ключ IntegrationAdapterProfile;
внутренний object type;
внешний object type;
внешний идентификатор;
внутренний recordKey или recordRef;
направление использования;
статус связи;
источник регистрации и даты подтверждения;
правило уникальности.

Lookup выполняется только в области adapterProfileKey + externalSystem + objectType + externalId. Если в этой области найдено несколько активных связей, API возвращает диагностическую ошибку и не выбирает запись случайно.

2. MappingProfile

MappingProfile хранится как отдельная API-запись с типом Профиль mapping внешней интеграции.

Профиль описывает:

связь с IntegrationAdapterProfile и APIContract;
внутренний object type и внешний object type;
направление mapping;
поле payload, в котором находится external id;
required permissions для проверки через Security;
правила mapping полей через stable field keys FieldConfiguration;
правила mapping workflow-статусов и переходов через Workflow*;
правила resolver-а пользователей и организаций через Users и Organisations;
правила ссылок на файлы через FT и TemporaryFiles.

В mapping нельзя указывать физические номера полей, подполей, внутренние пути файлов или значения секретов. API хранит только ссылки на владельцев контрактов.

3. Dry-run

Функция API/DryRunMapping принимает payload и mapping context. Она возвращает normalized result, matched ExternalId, proposed changes, required permissions, warnings и errors.

Dry-run не сохраняет запись, не создает ExternalId, не выполняет workflow-переходы, не запускает post-functions, не отправляет события и не ставит задания в Queue.

Если интеграции нужна проверка конфликтов, source-of-truth, идемпотентность и стандартный SyncApplyRequest для доменного модуля, используется следующий слой - API/DryRunSync и записи SyncPolicy/ConflictPolicy.

4. Where-used

Функция API/GetExternalIdWhereUsed показывает связанные ExternalId, mapping profiles и опубликованные API-методы, которые могут использовать эти настройки. Диагностика не раскрывает закрытые записи, скрытые поля, секреты и персональные данные без прав.

5. Границы ответственности

API владеет реестром ExternalId, mapping profiles, lookup, where-used, dry-run mapping и безопасной диагностикой.

FieldConfiguration владеет stable field keys и семантикой полей.

Workflow* владеет workflow-проектами, статусами, переходами и фактическим применением переходов.

Security владеет правами, grants/denies, masking и безопасными отказами доступа.

Users и Organisations владеют resolver-ами участников.

FT и TemporaryFiles владеют файлами, staging и постоянным хранением.