Оформление
Словарь терминов
Объект · Object
Запись системы: заявка, задача, сотрудник или другой поддерживаемый объект.
Класс · Class
Общая модель семейства объектов. Тип уточняет её поля, формы и процесс.
Метаданные · Metadata
Описание того, какие данные может хранить система: типы, поля и правила. Например, поле «Тема» и его обязательность — метаданные, а текст «Не работает принтер» в конкретной заявке — рабочие данные.
Поле · Field
Отдельное значение объекта. Скрытие на форме не равно запрету доступа.
Форма · Form
Состав и расположение элементов для создания, редактирования или просмотра.
Жизненный цикл · Workflow
Настроенные состояния и правила перехода между ними.
Настроить жизненный цикл · Условия и действия перехода.
Статус · State
Текущее состояние записи. Одинаковые названия могут иметь разные коды.
Переход · Transition
Разрешённое действие смены состояния с проверками и дополнительными действиями.
Условие · Condition
Проверка, разрешающая или блокирующая действие.
Действие · Action
Операция, выполняемая процессом или автоматизацией.
Услуга · Service
То, за чем пользователь обращается через доступное соглашение.
Заявка · Request
Запись о потребности пользователя. Основной термин в инструкциях — заявка. «Обращение» и «тикет» используют как синонимы; это не дополнительные типы записей. Инцидент — один из типов заявок, а не название всех записей.
Создать заявку · Следить за её решением.
Задача · Task
Отдельная единица работы; может быть связана с обращением.
Согласование · Approval
Зафиксированное решение участников по предусмотренному сценарию.
Уровень обслуживания · SLA
Правила и сроки реакции/решения с учётом настроенного календаря и отсчёта.
Трудозатраты · Worklog
Запись потраченного времени, а не таймер SLA.
ИТ-актив · CI / CMDB
Учтённый объект ИТ-инфраструктуры и его связи в системе. В отраслевой документации встречается название «конфигурационная единица» (CI); в интерфейсе NGENSIA — «ИТ-актив».
Работать с ИТ-активами · Настроить связи.
Связь · Relation
Типизированная связь между доступными объектами.
Автоматизация · Automation
Сценарий из триггера, условий и действий. Сохранение не означает включение.
Webhook
Исходящая передача события внешней системе; возможна повторная доставка.
Фоновый обработчик · Worker
Процесс, исполняющий очередь или периодическую работу вне запроса пользователя.
Развёртывание · Deployment
Подготовка и запуск выпуска в конкретном окружении.
Выпуск · Release
Зафиксированная версия приложения и соответствующий комплект установки.
Резервная копия · Backup
Согласованный набор базы, файлов и необходимых секретов для восстановления.
Сделать резервную копию · Настроить копирование по расписанию.
Восстановление · Restore
Возврат данных из копии в отдельную подготовленную установку.
Откат · Rollback
Возврат приложения к совместимой ранее работавшей версии; не автоматическая отмена миграций.
Архив
Состояние записей в системе. Не заменяет резервную копию.
Tenant
Изолированная область данных организации; API-ключ определяет свой tenant.
ALLOW / DENY / Scope
Разрешение, явный запрет и область действия правила доступа.
Настроить роли и права доступа. Английское permission означает разрешение на действие.
В API слово scope означает разрешённую операцию ключа, например objects:read — читать записи. Это не выдаёт владельцу ключа новых прав на сами записи. Нужны и подходящий scope, и доступ владельца. Ключи API.
Идентификатор · ID
Однозначное обозначение записи для ссылок и API. Название человек может поменять, а интеграция обычно обращается к записи по ID. Не путайте его с видимым номером заявки: у них разные назначения.
Версия записи · Revision
Номер изменения конкретной записи. При сохранении API может требовать expectedRevision, чтобы не затереть чужие правки. Если версия устарела, сначала перечитайте запись и сравните изменения. Это не версия приложения NGENSIA. Изменение объекта.
Идентификатор запроса · Correlation ID
Код, по которому сопровождающий может найти конкретный запрос в журнале. Его полезно передать вместе со временем ошибки. Это не API-ключ и не пароль. Ошибки API.
Связанные статьи
Права · Жизненный цикл · SLA · API · Эксплуатация