Александр Зимин
54 lines
3.6 KiB
Markdown
54 lines
3.6 KiB
Markdown
# Руководство оператора Ordinis НСИ
|
||
|
||
Это руководство — для **операторов справочников**: тех, кто заводит и
|
||
поддерживает данные в Ordinis (космические аппараты, наземные станции,
|
||
типы антенн, операторов спутниковой связи и т.д.).
|
||
|
||
Если ты **разработчик-интегратор** (Альтум, BI, геопортал) — смотри
|
||
[интеграцию по API](../integration/api/index.md).
|
||
|
||
Если ты **ревьюер** schema drafts — смотри
|
||
[руководство ревьюера](../reviewer/index.md).
|
||
|
||
## Что внутри
|
||
|
||
- [Создание справочника](create-dictionary.md) — как добавить новый
|
||
справочник (например, «типы антенн») и описать его поля
|
||
- [Работа с записями](edit-record.md) — как добавлять, редактировать,
|
||
искать записи внутри справочника
|
||
- [Закрытие записи](close-record.md) — как корректно «удалить» запись,
|
||
сохранив историю (bitemporal модель)
|
||
- [Журнал аудита](audit-log.md) — как посмотреть, кто и когда что менял
|
||
- [Разбор ошибок](errors.md) — типичные ошибки валидации и как их понять
|
||
|
||
## Базовые понятия
|
||
|
||
**Справочник** — таблица с однородными записями (например, «спутники»,
|
||
«наземные станции», «частотные диапазоны»). У каждого справочника есть
|
||
**схема** — описание полей: какие поля, какого типа, обязательные или
|
||
нет, ссылаются ли на другие справочники.
|
||
|
||
**Запись** — одна строка в справочнике. У каждой записи есть **бизнес-ключ**
|
||
(уникальный код) и **данные** (значения полей по схеме). Также есть
|
||
**период действия** — `valid_from` / `valid_to`, в течение которого
|
||
запись считается актуальной.
|
||
|
||
**Scope** — уровень доступа к данным:
|
||
- `PUBLIC` — открыто всем
|
||
- `INTERNAL` — для внутренних потребителей
|
||
- `RESTRICTED` — только для администраторов
|
||
|
||
**Schema draft** — предложение изменить схему справочника (добавить поле,
|
||
изменить тип). Не применяется автоматически — проходит ревью, затем
|
||
публикуется.
|
||
|
||
## Какую роль ты выполняешь
|
||
|
||
| Если ты... | Иди в раздел |
|
||
|---|---|
|
||
| Создаёшь новый справочник | [Создание справочника](create-dictionary.md) |
|
||
| Добавляешь запись в существующий справочник | [Работа с записями](edit-record.md) |
|
||
| Хочешь «удалить» устаревшую запись | [Закрытие записи](close-record.md) |
|
||
| Видишь ошибку валидации, не понимаешь | [Разбор ошибок](errors.md) |
|
||
| Проверяешь, кто менял запись | [Журнал аудита](audit-log.md) |
|