Перейти к содержимому
omnismith docs

Шаблоны

Шаблон (Template) — это определение схемы в Omnismith. Он объединяет набор Атрибутов в многоразовый чертеж, определяющий, как Сущности (записи данных) создаются, валидируются, ищутся и визуализируются.

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

1. Структура Шаблона

Заголовок раздела «1. Структура Шаблона»

Шаблон состоит из двух основных областей настройки:

  1. Основная информация:
    • Название: Понятный заголовок шаблона (например, Заявка в поддержку, Серверный узел, Профиль клиента).
    • Описание: Необязательные операционные заметки с пояснением хранимых данных.
    • Визуальное оформление: Кастомизация иконки и цвета для быстрой идентификации в UI.
  2. Состав атрибутов:
    • Список прикрепленных Атрибутов (Измерения, Метрики, Списки, Ссылки), формирующих поля записей этого шаблона.
    • Изменение порядка полей для кастомизации формы ввода.

2. Пошаговое руководство: Создание Шаблона

Заголовок раздела «2. Пошаговое руководство: Создание Шаблона»
  1. Перейдите в Моделирование данных → Шаблоны в боковом меню.
  2. Нажмите + Создать шаблон.
  3. Вкладка Основные данные:
    • Введите Название (например, Серверный узел).
    • Укажите описание и иконку.
  4. Вкладка Атрибуты:
    • Нажмите + Прикрепить атрибут.
    • Выберите атрибуты из библиотеки проекта (например, Hostname, Environment, Status, CPU Usage, Latency).
    • Измените порядок полей перетаскиванием.
  5. Нажмите Сохранить изменения.

Экран параметров шаблона с вкладками Основные и Атрибуты

3. Динамическая эволюция схем (Обновления без простоя)

Заголовок раздела «3. Динамическая эволюция схем (Обновления без простоя)»

Одно из главных преимуществ Omnismith — гибкость схемы во время выполнения (runtime):

  • Добавление полей: Прикрепите новый атрибут к существующему шаблону в любое время. Все существующие сущности шаблона мгновенно получат доступ к новому полю без применения миграций БД.
  • Удаление полей: Открепите атрибут от шаблона, чтобы скрыть его из форм и таблиц поиска без уничтожения исторического журнала метрик.
  • Без простоя: Изменения вступают в силу мгновенно в UI, API и на дашбордах.

💡 Примечание для разработчиков

Заголовок раздела «💡 Примечание для разработчиков»

[!NOTE] Динамические схемы и маппинг сущностей: В традиционных базах данных добавление колонок требует выполнения блокирующих операторов ALTER TABLE. В EAV-движке Omnismith:

  • Шаблоны определяют виртуальные карты полей, хранимые в метаданных JSON.
  • Динамические эндпоинты OpenAPI /api/v1/entity/template/{templateId} автоматически адаптируют валидацию ввода и структуру ответов под активную схему шаблона.

Следующие шаги

Заголовок раздела «Следующие шаги»

[!TIP]