Обзор бизнес-глоссария
Бизнес-глоссарий — это словарь терминов, связанных с цифровыми данными,
которыми оперирует организация, описанный на понятном языке.
Иерархия бизнес-глоссария
В бизнес-глоссарии ADC существует 2 типа объектов, существующие для поддержания иерархии: Глоссарии и предметные области.

Вы можете создавать несколько отдельных глоссариев для разных подразделений организации или для любых других нужд. По умолчанию в ADC создан один глоссарий с названием «Основной Глоссарий».

Глоссарий содержит второй обязательный уровень иерархии- предметную область. В глоссарии может быть неограниченное количество предметных областей, а сами предметные области поддерживают многоуровневые связи, вы можете создать родительские и дочерние предметные области.

Иерархия бизнес-глоссария

Настройка представления глоссария
Вы можете настраивать представление на странице обзора терминов бизнес-глоссария. Управлять перечнем и порядком столбцов и добавлять фильтры по каждому столбцу.

Чтобы выбрать столбцы для отображения нажмите на иконку Редактирования представления в правом боковом меню. В появившемся окне кликом выберите дополнительные столбцы или снимете выбор с лишних атрибутов. Также с помощью drag-and-drop перетаскивайте столбцы между собой для управления порядком.

Над столбцами таблицы обзора находятся фильтры, по кнопке + вы можете добавить новые фильтры, а по клику на добавленный фильтр указать необходимо значение.

Кнопка Сбросить вернет перечень фильтров по умолчанию: Владелец, Термин, Теги, Тип термина. Значения фильтров также сбрасываются.

Настройка представления бизнес-глоссария

Настройка вкладок типов объектов глоссария
Для удобства навигации вы различные типы объектов разделены по вкладкам, которые находятся на странице обзора глоссария. Вы можете редактировать набор вкладок, в зависимости от того с какими объектами работаете чаще всего.

Ваш выбор набора вкладок сохранится для вашей учетной записи.

Настройка представления бизнес-глоссария

Обзор карточки глоссария
Так как глоссарий- это исключительно иерархичный объект, он не содержит в себе большого атрибутивного состава.

Открыв карточку глоссария, мы можем ознакомиться с данной информацией:

  1. Короткое наименование;
  2. Полное наименование;
  3. Описание глоссария;
  4. Список предметных областей, созданных в этом глоссарии;
  5. Количество терминов, созданных в этом глоссарий;
  6. Владелец глоссария;
  7. Стюарды глоссария;
  8. Теги, добавленные к этом глоссарию.

Чтобы открыть карточку глоссария воспользуйтесь этими шагами:

  1. Авторизуйтесь в системе.
  2. Перейдите на вкладку Глоссарий в шапке страницы.
  3. Выберите необходимый глоссарий в раскрывающемся списке.
  4. Кликните по Названию глоссария в обзоре глоссария.

Как открыть карточку бизнес-глоссария

В карточке глоссария доступна функция редактирования. Вы можете изменить значение атрибутов глоссария.
Обзор карточки предметной области
Атрибутивный состав предметной области (далее- ПО):

  1. Короткое наименование;
  2. Полное наименование;
  3. Описание;
  4. Дочерние предметные области;
  5. Родительская предметная область;
  6. Список терминов, созданных в этой ПО;
  7. Владелец ПО;
  8. Стюарды ПО;
  9. Теги, добавленные к этой ПО.
Чтобы открыть карточку глоссария воспользуйтесь этими шагами:

  1. Авторизуйтесь в системе.
  2. Перейдите на вкладку Глоссарий в шапке страницы.
  3. Выберите необходимый глоссарий в раскрывающемся списке.
  4. Выберите кликом предметную областю в боковом меню глоссария.
  5. Кликните по Названию предметной области в обзоре глоссария.

Как просмотреть карточку предметной области

В карточке предметной области доступна функция редактирования и удаления. Вы можете изменить значения атрибутов предметной области и удалить ее из системы.
Чтобы удалить предметную область, сначала удалите или перенесите термины из этой предметной области.
Обзор карточки термина
Термин это основной элемент для работы с глоссарием.

Атрибутивный состав термина отличается в зависимости от типа термина, но базовый атрибутивный состав присущ любому типу термина:

  1. Краткое наименование;
  2. Полное наименование;
  3. Описание;
  4. Владелец;
  5. Стюарды;
  6. Предметная область;
  7. Дополнительная предметная область;
  8. Теги;
  9. Связи с объектами каталога данных;
  10. Связанные объекты;
  11. Визуализация связей.
Для перехода в карточку термина кликните по его названию в обзоре глоссария.

Как просмотреть карточку термина

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

Функции в карточке термина

Работа с объектами
Все объекты глоссария создаются и редактируются в разделе Глоссарий в хедере приложения.

Чтобы открыть раздел создания объектов воспользуйтесь этими шагами:

  1. Авторизуйтесь в системе.
  2. Перейдите в раздел Глоссарий в хедере приложения.
  3. Нажмите на иконку Добавления в правом верхнем углу.
  4. Выберите необходимый для добавления объект.

Как создать новый термин

Если вы хотите создать термин или предметную область, сначала выберите необходимый для создания глоссарий.
Создание глоссария
Рассмотри процесс создания глоссария. После выбора Новый глоссарий в меню из предыдущей статьи, открывается карточка создания нового глоссария. Она содержит обязательные для заполнения поля: Короткое наименование, Полное наименование, Описание. Опционально можно указать стюардов и владельца глоссария (пользователей или команду) и добавить теги к этому глоссарию.

После заполнения характеристик нового глоссария нажмите кнопку Сохранить, и глоссарий будет создан в системе.

Как создать глоссарий

Наименование глоссария должно быть уникально в системе.
Создание предметной области
После выбора Новая предметная область в меню добавления объектов глоссария открывается карточка создания новой предметной области. Она содержит обязательные для заполнения поля: Короткое наименование, Полное наименование, Описание. Опционально можно указать стюардов и владельца предметной области (пользователей или команду) и добавить теги к этому глоссарию.
Чтобы создать дочернюю предметную область, укажите родительскую предметную область в карточке создания.

После заполнения характеристик новой предметной области нажмите кнопку Сохранить, и предметная область будет создана в системе в выбранном в обзоре глоссарии.

Как создать предметную область

Короткое наименование предметной области должны быть уникально в глоссарии.
Создание термина
После выбора Новый термин в меню добавления объектов глоссария открывается карточка создания нового термина. Она содержит обязательные для заполнения поля: Короткое наименование, Полное наименование, Описание, Тип термин, Предметная область. Опционально доступны все остальные поля термина, которые определяются согласно его типу.
Чтобы создать дочернюю предметную область, укажите родительскую предметную область в карточке создания.

После заполнения характеристик нового термина нажмите кнопку Сохранить, и предметная область будет создана в системе в выбранном в обзоре глоссарии.
Короткое наименование термина должно быть уникально в глоссарии.
Поля, использующие текст с разметкой, такие как «Описание» и «Техническое описание» поддерживают синтаксис Markdown.

С его помощью вы можете вставлять картинки и таблицы прямо в текстовое поле:

  1. Чтобы добавить картинку, перетащите файл с картинкой в поле ввода и нажмите Просмотр для проверки корректного отображения изображения.
  2. Чтобы добавить таблицу используйте пример ниже. Для добавление строки начните новый абзац, для разделения столбцов ставится знак |, для отделения заголовка заполните таким образом все столбцы: | - |
| Заголовок 1 | Заголовок 2 |
| ----------- | ----------- |
| Значение 1.1 | Значение 2.1 |
| Значение 1.2| Значение 2.2 |

Как добавить картинки и таблицы в термин

Групповое удаление
На странице обзора терминов глоссария вам доступны групповые операции с объектами: публикация, удаление и редактирование.
Чтобы удалить несколько терминов, вы можете выделить их множественным выбором и нажать кнопку Удалить в правом боковом меню действий.

Как удалить группу терминов в глоссарии

Группа терминов разделится по маршрутам согласования в зависимости от типа термина и принадлежности к предметной области. Ответственные пользователи получат задачу на согласование удаления
Групповая публикация
Таким же образом, вы можете отправить необходимую группу терминов на согласование. В этом случае, после выделения терминов нажмите кнопку Опубликовать.

Как опубликовать группу терминов в глоссарии

Группа терминов разделится по маршрутам согласования в зависимости от типа термина и принадлежности к предметной области. Ответственные пользователи получат задачу на согласование изменений
Групповое редактирование
Начиная с релиза Arenadata Catalog 0.4.1 доступно редактирование группы терминов. Вы можете изменять основную и дополнительные предметные области, владельцев, стюардов и набор классификаторов у группы терминов.
Выделите нужные термины и нажмите кнопку Редактирование, чтобы перейти в режим группового редактирования терминов. В этом режиме вы можете создавать несколько различных операций для группы терминов. Например, одновременно поменять владельца, обновить набор классификаторов и перенести в другую предметную область.

Как отредактировать группу терминов

В зависимости от атрибута, который вы хотите отредактировать, доступны различные действия. Перечень приведен в таблице ниже:
Пояснение к типам операций:
  • Заменить значение– удаляет предыдущее значение и присваивает новое;
  • Удалить значение
  • удаляет предыдущее значение;
  • Добавить новые значения
  • добавляет к переченю дополнительные значение, старый набор остается без изменений;
  • Удалить все значения
  • очищает значения у выбранных терминов;
  • Удалить выбранные значения– вы можете указать какое значение удалить у группы терминов. Если это значение отсутствует в некоторых терминах из группы, они будут пропущены;
  • Заменить все значения– удаляет предыдущий набор значений и присваивает новый.
Невозможно выполнить групповые операции для терминов в статусе "Кандидат"/"Кандидат на удаление"
Рабочие процессы глоссария
Arenadata Catalog использует BPM-движок Camunda для выполнения действий по согласованию артефактов глоссария. Логические объекты глоссария и термины существуют в следующих состояниях:

  1. Черновик — неопубликованная версия. Создается при создании объекта или внесении изменений в Активную версию.
  2. Кандидат — версия объекта в статусе Черновик, отправленная на публикацию и ожидающая результатов согласования.
  3. Активный — успешно согласованная версия объекта. Если Кандидат был согласован в рабочем процессе создается версия объекта в статусе Активный. Если Кандидат был отклонен, он возвращается в Черновик.
  4. Кандидат на удаление — версия объекта, отправленная на удаление и ожидающая согласования данного действия.
  5. Архив — версия мягко удаленного объекта. Создается, если удаление было утверждено в рабочем процессе.
Если термин не имел Активной версии, он удаляется из глоссария без возможности восстановления.
Конфигурации рабочих процессов
Управление конфигурациями рабочих процессов осуществляется пользователем с правами администратора в интерфейсе ADC. Чтобы перейте в раздел управления рабочими процессами воспользуйтесь следующими шагами:

  1. Авторизуйтесь в системе.
  2. Перейдите в раздел Настройки.
  3. В боковом меню в подразделе Администрирование выберите Конфигурации рабочего потока.

В этом разделе можно создать новую конфигурацию рабочего потока и управлять существующими.
По умолчанию в ADC используется конфигурация Автоматическая публикация, вы можете создать новые конфигурации на основе шаблонов.
Создание конфигурации рабочего процесса
Как создать конфигурацию рабочего потока:

  1. Нажмите на Кнопку новая конфигурация
  2. Выберите один из шаблонов, существующих в вашей системе. Затем заполните наименование и описание конфигурации, и нажмите Сохранить.
  3. Открывается страница редактирования конфигураций. В левом боковом меню осуществляется навигация между шагами рабочего процесса, по умолчанию открывается этап «Условия рабочего потока». Нажмите на кнопку Добавить условие.
  4. В новом окне открывается настройка параметров условия срабатывания рабочего процесса. Выберите Глоссарий и предметную область, для которых настраиваете конфигурацию. Затем заполните матрицу, где строки- это типы объектов глоссария, столбцы- типы событий с этими объектами. Кликом выберите необходимые для конфигурации пересечения строк и столбцов. После настройки нажмите кнопку Добавить.
  5. Если хотите добавить дополнительные условия нажмите кнопку Добавить условие и повторите шаг 4.
  6. После настройки триггеров воркфлоу перейдите в левом боковом меню к следующему этапу конфигурации. Количество этапов отличается в зависимости от выбранного шаблона, но их настройка идентична.
  7. На странице редактирования следующего этапа укажите с помощью ползунка срок выполнения шага рабочего процесса. Срок варьируется от 1 до 31 дней.
  8. Затем пролистните ниже и укажите назначенных для шага рабочего процесса. Можно указать пользователей на основе их роли, выбрав кликом Инициатора, Владельцев или стюардов глоссария, предметных областей, артефактов. Или указать конкретных пользователей/группы пользователей из системы, кликнув по кнопке Добавить пользователей.
  9. Если в выбранном шаблоне присутствуют дополнительные этапы рабочего процесса- заполните их идентично шагам 7−8.
  10. После заполнения всех шагов нажмите кнопку Активировать, если хотите привести конфигурацию в действие с текущего момента, или нажмите кнопку Сохранить, чтобы активировать конфигурацию позднее.
  11. Если вы активировали конфигурацию, необходимо подтвердить это действие, ознакомившись с информацией о зависимых конфигурациях. Триггеры конфигураций должны быть уникальны, пересечение триггеров отредактирует существующие конфигурации при активации новой.

Как создать конфигурацию рабочего потока

В конфигурациях рабочих процессов доступно определение ответственных пользователей на основе дополнительных ролей, созданных с помощью атрибута Сотрудник/Группа в карточках предметных областей и типах объектов глоссария. Дополнительные роли подтянутся автоматические к базовым ролям, если вы указали конкретный глоссарий в условиях конфигурации рабочего процесса.

Если выбран вариант "Все глоссарии|Все предметные области" дополнительные роли невозможно использовать.
Параметр "Автосогласование при отсутствии согласующих" поможет вам не задерживать рабочие процессы, если какие-то закрепленные за объектами лица не были определены.
Если у объекта отсутствует владелец, но он указан в конфигурации рабочего процесса, то при включенном параметре этап завершится автоматически. А при выключенном параметры, пользователи не смогут отправить объект на согласование до указания владельца.
Чтобы отредактировать конфигурацию рабочего потока нажмите в строке конфигурации иконку редактирования в скрытом меню последнего столбца.
Перед тем как удалить конфигурацию необходимо деактивировать ее.
Порядок работы рабочих процессов
После того как публикуются изменения в объектах глоссария, согласно настроенным триггерам рабочих процессов запускается подходящая конфигурация. По каждому шагу указанным в конфигурации ответственным пользователям назначается задача по согласованию изменений объекта.

Ответственный пользователь получает уведомление о назначении задачи. И может просмотреть все назначенные ему задачи в личном кабинете пользователя. После перехода в карточку задачи пользователь может Согласовать, Отклонить или Делегировать данную задачу. Каждое решение сопровождается комментарием ответственного пользователя.

  • Если ответственный согласовал изменения- новая версия объекта публикуется в глоссарии, если нет дальнейших этапов рабочего процесса.
  • Если ответственный отклонил изменения- объект возвращается из статуса Кандидат в предыдущий статус Черновик.
  • Если ответственный делегировал задачу- решение должен принять пользователь, которому задача была делегирована.
Работа с задачами
После того как публикуются изменения в объектах глоссария, согласно настроенным триггерам рабочих процессов запускается подходящая конфигурация. По каждому шагу конфигурации указанным ответственным пользователям назначается задача по согласованию изменений объекта.

Ответственный пользователь получает уведомление о назначении задачи. И может просмотреть все назначенные ему задачи в личном кабинете пользователя. После перехода в карточку задачи пользователь может Согласовать, Отклонить или Делегировать данную задачу. Каждое решение сопровождается комментарием ответственного пользователя.

  • Если ответственный согласовал изменения- новая версия объекта публикуется в глоссарии, если нет дальнейших этапов рабочего процесса.
  • Если ответственный отклонил изменения- объект возвращается из статуса Кандидат в предыдущий статус.
  • Если ответственный делегировал задачу- решение должен принять пользователь, которому задача была делегирована.
Для просмотра своих задач перейдите на вкладку Задачи в личном кабинете пользователя.

Как перейти в задачи пользователя

Управление задачами
Управление задачами– это интерфейс для администратора, в котором он может отслеживать как выполняются пользовательские задачи.

Данный интерфейс отображется в табличном виде со столбцами:

  1. Статус — текущее состояние задачи. Возможные состояния Активная/Исполнена.
  2. В работе — столбец с фильтрами для отслеживания, были ли назначены пользователи на задачу, взял ли кто-то из пользователей задачу в работу.
  3. Наименование задачи — помимо наименования задачи, содержит ссылку на переход в задачу.
  4. Дата создания задачи
  5. Дедлайн — срок, до которого задача должна быть выполнена.
  6. Конфигурация рабочего процесса — какая конфигурация использовалась для создания это задачи.

Администрирование задач

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

История согласования хранится, пока термин существует в системе. Если согласование было выполнено автоматически- это также отобразится в истории.

История согласования содержит столбы:

  • Роль- роль пользователя в соответствии с конфигурацией рабочего процесса. Например, владелец термина
  • Согласующий- пользователь, на которого назначена задача.
  • Задача пользователя- наименование задачи пользователя.
  • Комментарий- отображается комментарий, оставленный пользователем при действии с задачей.
  • Статус задачи- текущее состояние задачи. Принимает значения: Создана, Согласована, Отклонена, Делегирована.
  • Дата- дата действия с задачей.
  • Время- время действия с задачей.

Просмотр истории согласования термина

Шаблоны рабочих процессов
В Arenadata Catalog вы можете загружать собственные bpmn-файлы и строить на их основе маршруты согласования. Чтобы загрузить новый шаблон рабочего процесса необходимо перейти в раздел Файлы шаблонов на странице Настройки. В этом разделе отображаются загруженные в систему шаблоны, их можно удалить или скачать на свой компьютер, чтобы выполнить необходимые доработки и загрузить обратно в систему.

Раздел Файлы шаблонов

Для удаления шаблона из системы сначала удалите все конфигурации, построенные на этом шаблоне, и завершить все активные рабочие процессы.
Создание нового шаблона рабочих процессов
Для создания/редактирования bpmn-файлов рекомендуем использовать open-source программное обеспечение
Camunda Modeler. При появлении вопросов рекомендуем обратиться к документации Camunda.

Рассмотрим пример рабочего процесса, представленный на рисунке ниже.

Пример рабочего процесса с одним согласованием

Процесс содержит одну пользовательскую задачу, одну сервисную задачу и точки входа, старта.

Пользовательские задачи используются для согласования процессов в интерфейсе ADC. Одна пользовательская задача означает необходимость одного согласования. В конфигураторе процессов ADC на одну пользовательскую задачу может быть назначено несколько согласующих пользователей. Для завершения задачи необходимо согласование только одного из назначенных пользователей. Выполненная задача генерирует параметр approved со значение true/false (согласовано/несогласованно). Оно используется в сервисной задаче «Смена статуса» для определения в какой статус необходимо необходимо перевести процесс.


Сервисная задача «Смена статуса» необходима для смены статуса артефакта глоссария. В данный момент поддерживается сервисная задача только с параметром topic — change_status. Данная задача должна содержать два обязательных параметра approved и trigger. Данные параметры используются для вычисления целевого статуса артефакта. После задачи смены статуса должен быть указан терминальный элемент.


Camunda предусматривает возможность мультизадачности для некоторых элементов, в том числе сервисных и пользовательских задач. В данный момент Arenadata Catalog не поддерживает мультизадачность, загрузить такой сценарий в систему не получится.
Общие параметры процесса
В основных настройках процесса (General) должны быть указаны следующие атрибуты:

— Name
— ID
— Executable -
true
— Startable — false

Основные настройки рабочего процесса

Параметры пользовательской задачи
Настройки элемента пользовательской задачи (User Task):

— Name
— ID
— Documentation — описание задачи, отображаемое при конфигурации рабочего процесса в интерфейсе Arenadata Catalog (не обязательное)
— Extension properties:
  • order — порядок отображения задачи при конфигурации рабочего процесса в интерфейсе ADC

Пример рабочего процесса с одним согласованием

Параметры сервисной задачи
Настройки элемента сервисной задачи (Service Task):

— Name
— ID
— Implementation:
  • type = External
  • topic = change_status — запуск процесса смены статуса артефакта.
— Inputs:
  • approved = true/false — согласована смена статуса или нет. Значение данной переменной необходимо установить в ходе выполнения процесса
  • trigger — значение переменной автоматически выставляется при запуске процесса, определяет с каким триггером был запущен процесс и в какой статус необходимо будет перевести артефакт. Не рекомендуется изменять данный атрибут в ходе выполнения процесса.
— Extension properties:
  • order — порядок отображения задачи
  • trackInHistory = true/false отображать/неотображать сервисную задачу в истории согласования (не обязательный параметр)
  • historyComment — комментарий, который будет отображаться в истории, если trackInHistory = true (не обязательный параметр)

Настройки сервисной задачи

Параметры элементов старт/стоп
Настройки элемента старт, как и многих других элементов требуют только обязательного указания ID.

Настройки стартового элемента

Влияние остальных атрибутов и элементов регламентируется работой Camunda и требует обращения к её документации.
Загрузка шаблона в систему
После того как вы подготовили шаблон рабочего процесса- вы можете загрузить его в Arenadata Catalog!

Для этого в разделе Файлы шаблонов нажмите кнопку Загрузить в систему и выберите шаблон в файловом браузере.

Все шаблоны проходят валидацию на соответствие правилам выше. Ошибки приходят последовательно и отображаются в уведомлениях.

Загрузка шаблона в Arenadata Catalog

Кастомизация глоссария
Для терминов глоссария и предметных областей доступно управление набором атрибутов, их отображением, обязательностью заполнения и ограничениями на вводимые значения. Для этого у терминов существуют типы, которыми вы можете управлять на свое усмотрение
Предметные области
Для каждого созданного глоссария в Arenadata Catalog вы можете настроить стандарт карточки предметной области. Для предметной области доступно управление перечнем атрибутов, их порядком и настройками отображения. Отредактированные в рамках глоссария изменения повлияют на все входящие в него предметные области.

Управление этой кастомизацией ведется в разделе Настройка карточек предметных областей на странице Настройки.

Просмотр созданных типов терминов

Типы объектов
Объекты глоссария типизируются.. В Arenadata catalog предусмотрены коробочные типы объектов:

  1. Бизнес-термин
  2. Атрибут данных
  3. Сущность
  4. Показатель (KPI)
  5. Расчетный атрибут данных


И также добавлена возможность создавать собственные типы объектов. В зависимости от типа меняется наполнение карточки, атрибутивный состав, и используются отдельные триггеры рабочих процессов.

Управление типами объектов осуществляется в одноименном разделе на странице Настройки.
В нем вы можете создавать новые типы терминов, редактировать и удалять существующие.

Просмотр созданных типов терминов

Количество пользовательских типов объектов неограничено. Тип термина выбирается при создании термина и позднее его невозможно изменить.

Поддерживаются три состояния:

  1. Активный— тип объекта готовый к использованию.
  2. Блокирован— невозможно создать объекты этого типа. Обязательный этап перед удалением типа термина
  3. Архив— мягко удаленный тип объекта.
Тип объекта невозможно полностью удалить из системы.
Создание и наполнение типа объектов
В разделе Типы терминов по кнопке Новый тип термина открывается окно для создание пользоватескольго типа.

Для типа терминов обязательно ввести наименование и короткое описание.

Карточка типа термина разделена на два сектора, в соответствии с карточкой термина. Первый сектор типа термина- это левая широкая колонка карточки термина, а второй сектор- правая узкая колонка.

Новый тип термин будет заполнен базовыми атрибутами, которые невозможно отредактировать или удалить:

  1. Короткое наименование;
  2. Полное наименование;
  3. Тип термина;
  4. Описание;
  5. Владелец;
  6. Стюарды;
  7. Предметная область;
  8. Дополнительная предметная область;
  9. Теги.


Остальным набором атрибутов вы можете полностью управлять, изменяя их порядок с помощью перетаскивания (drag-and-drop), и указывая обязательность заполнения атрибута в последнем столбце.

По кнопке Выбрать из списка полей вы можете добавить в тип термина атрибуты из реестра атрибутов, а нажав Новое поле вы перейдете в окно создание нового атрибута, который также окажется в реестре.

После добавления всех атрибутов в тип термина и выстывления обязательности заполнения, нажмите кнопку Сохранить и тип термина перейдет в статус Активный.

Создание нового типа терминов

Создание термина пользовательского типа
После того как добавлен новый тип термина, можно создавать термины этого типа. Вы можете посмотреть как обновился набор атрибутов, их расположение и обязательность заполнения.

Создание термина пользовательского типа

Предопределенные типы терминов
Предопределенные типы терминов невозможно удалить из системы и также нельзя уменьшать их набор атрибутов- при необходимости вы можете добавлять дополнительные атрибуты.

Если вы не видите потребности использовать тип термина в вашей организации вы можете заблокировать его, и тогда пользователи не смогут создавать термины этого типа.
Реестр атрибутов
Управление атрибутами централизованно, что позволяет переиспользовать атрибуты в разных типах терминов. Управление атрибутами осуществляется в разделе Реестр атрибутов, который находится в боковом меню на странице Настройки.

Просмотр Реестра атрибутов

В разделе Реестр атрибутов доступно создание новых атрибутов, а также редактирование и удаление существующих.

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

На текущий момент доступны типы данных:

  1. Текст строка.
  2. Текст с разметкой markdown с возможностью вставки таблиц, картинок, списков и стандартной разметки.
  3. Дата в формате ДД.ММ.ГГГГ с выбором из календаря.
  4. Число число в заданном диапазоне.
  5. Логическое значение истина/ложь.
  6. Выбор из списка значений выбор пользователем значения из предопределенного списка.
  7. Предопределенные значения значение, которые пользователь не сможет отредактировать.
  8. Ссылка URL ссылки на любые объекты вне системы.
  9. Математическая формула конструктор формул.
  10. Сотрудник/Группавозможность указания дополнительных ролей для объектов.
  11. Код— вставка элементов кода (SQL-запросов) в объект
При создании атрибутов вы можете управлять отображением поля, ограничивать вводимые пользователем данные и воспользоваться функцией предпросмотра атрибута, чтобы удостовериться, удобен ли он будет пользователю.
Настройки атрибута зависят от его типа данных, управлять ими можно в режиме редактирования или создания атрибута.
Создание атрибута
Чтобы создать новый атрибут, достаточно кликнуть на кнопку Новый атрибут в разделе Реестр Атрибутов.

Обязательными условиями для создания атрибута является заполнение его наименования и выбор типа данных.

Опционально вы можете редактировать настройки отображения и ограничения на ввод, которые описаны ниже. Большинство из этих параметров можно отредактировать позднее.

После заполнения свойств атрибута нажмите кнопку Сохранить и атрибут будет создан в системе, затем вы можете добавить его в необходимые типы терминов.

Создание пользовательского атрибута

Редактирование и удаление пользовательского атрибута
В обзоре реестра атрибутов вы можете кликнуть на свернутое меню в строке необходимого атрибута, где будут развернуты кнопки для редактирования и удаления.

При редактировании атрибута невозможно изменить тип данных и параметр Одно поле/Несколько полей, а остальные свойства доступны для изменения.

Удалить можно только пользовательские атрибуты, которые не используются в предопределенных типах терминов. Для удаления атрибута необходимо сначала исключить его из всех типов терминов, где он используется.

Редактирование и удаление пользовательского атрибута

Отображение атрибута
Это параметр атрибута с двумя вариантами выбора Одно поле/Несколько полей. По умолчанию стоит выбор Одно поле, подразумевается, что данный атрибут будет принимать одно значение, а не массив значений.

Если выбрать Несколько полей, то ниже появится экран с указанием диапазона количество значений.

Используется в следующих типах данных:

  1. Текст
  2. Дата
  3. Число
  4. Выбор из списка значений
  5. Сотрудник | Группа
  6. Код


Данный параметр невозможно отредактировать у существующего атрибута.
Текст подсказки в поле ввода
Текст подсказки в поле (placeholder) — текст в поле ввода, который подсказывает пользователю, какое именно значение нужно вводить. Исчезает после попытки ввести текст.

Используется в следующих типах данных:

  1. Текст
  2. Текст с разметкой
  3. Число

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

Используется в следующих типах данных:

  1. Текст
  2. Текст с разметкой
  3. Дата
  4. Число
  5. Логическое значение
  6. Выбор из списка значения
  7. Предопределенные значения
  8. Ссылка URL
  9. Математическая формула
  10. Сотрудник | Группа
  11. Код

По умолчанию используется пустое значение.
Значение по умолчанию
Вы можете указывать значение по умолчанию, которое будет применяться в атрибуте при создании термина, а при необходимости пользователь может отредактировать это значение.

Используется в следующих типах данных:

  1. Текст
  2. Текст с разметкой
  3. Число
  4. Выбор из списка значения

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

Используется в следующих типах данных: Текст.

По умолчанию используется пустое значение.
Диапазоны значений
Для типа данных Число можно указать диапазон вводимых значений от — 1 000 000 000 000 000 000
до 1 000 000 000 000 000 000, и ограничить количество знаков после запятой от 0 до 5.

Для типа данных Дата можно указать диапазон с временным промежутком, необходимый для атрибута.

Для типа данных Текст можно указать минимамально и максимально количество символов от 0 до 2 147 483 647.
Cписок значений
Для типа данных Список значений необходимо в настройках отображения атрибута ввести весь список значений, из которых пользовать сможет выбрать необходимое при создании термина. Количество значений не ограничено.

Значение по умолчанию выбирается из введенного списка.
Реестр типов связей
Управление типами связей объектов централизованно, в одном разделе вы можете управлять набором типов связей в вашей системе и настройками каждого отдельного типа.

В Arenadata Catalog есть коробочные типы связей:
  1. Родительский объект/Дочерний объект— используйте этот тип связи, для построения иерархии между объектами. В дальнейшем это позволит просматривать объекты глоссария в иерархичной структуре.
  2. Стандартная связь— указание связи между объектами, тип которой невозможно явно сформулировать.
Коробочные типы связей невозможно отредактировать и они доступны между любыми типами объектов.

Открытие реестра типов связей

В реестре атрибутов вы можете управлять дополнительными типами связи. Для каждого типа связи можно указать параметры:
  1. Направленная/Ненаправленная связь— определите как связанные этим типом связи объекты будут относиться друг к другу. Ненаправленная связь (например, «Синонимы») используется когда объекты относятся равноправно друг к другу, а Направленная связь (например, «Состоит из/Включается в») нужно использовать когда связь выстраивает различные отношения между первым и вторым объектом.
  2. Наименование типа связи— в данном поле укажите название связи. Для направленной связи укажите, как будет отображаться связь с исходящим и входящим объектами.
  3. Техническое наименование типа связи— в этом поле укажите техническое наименование, которое будет использоваться при взаимодействии с внешними системами. Если не требуется дополнительных интеграций или необходимости указывать конкретное техническое наименование, включите параметр «Заполнить автоматически», и техническое наименование будет создано на основе обычного названия типа связи.
  4. Описание— вы можете добавить описание для вашего типа связи. Это позволит пользователям получить больше информации о том, как использовать этот тип связи.
  5. Мощность связи—Определите мощность связи, чтобы ограничить количество объектов, участвующих в связи:
  • Один-к-одному (1:1): Один объект может соответствовать только одному другому объекту.
  • Один-ко-многим (1:M): Одному исходному объекту может соответствовать любое количество (M) других входящих объектов. Зеркальным отражением является мощность «многие-к-одному» или M:1 — одному входящему объекту может соответствовать любое количество (M) исходных объектов;
  • Многие-к-многим (M:M): Нескольким объектам может соответствовать несколько других объектов. Этот тип связи не накладывает ограничений на создание связей.
6. Типы объектов для связи— вы можете настроить, какие типы объектов могут использовать ваш тип связи. По умолчанию значения не заполнены, и никакие объекты не видят ваш тип связи. Чтобы добавить новую строку с типами объектов, нажмите кнопку «Добавить пару» и выберите нужный тип объекта.
Советы по настройке типов объекта для связи:
  1. Ненаправленный тип связи: Типы объектов в колонках не зависят от порядка, так как отсутствует направление. Порядок объектов в левой и правой колонке не имеет значения.
  2. Направленная связь: Порядок колонок важен. В левой колонке указывается исходящий объект, а в правой — входящий. Если два типа объектов могут быть и входящими, и исходящими, добавьте две зеркально отраженные пары типов объектов.
  3. Связь объектов одного типа: Строка должна содержать этот тип в обеих колонках для возможности связи.
Управление типами связи
При создании типа связи вы можете указать все параметры, описанные выше. Также после создания вы сможете вернуться и отредактировать ваш тип связи, но для редактирования будут доступны только поля: наименование, описание и перечень доступных для связи типов объектов.

Создание нового типа связи

Созданный тип связи сразу станет доступен в тех типах объектов, которые были указаны в доступных парах типов связи.

Чтобы удалить пару доступных типов объектов или тип связи целиком, необходимо снача очистить все связи этого типа.
Создание связи между объектами глоссария
После настройки в карточке объекта глоссария вы можете создавать новые связи. Для этого в режиме редактирования объекта перейдите на вкладку Связанные объекты,
затем выберите нужный тип связи и связываемые объекты.

В зависимости от мощности связи откроется модальное окно с единичным или множетсвенным выбором связываемых объектов.

Установка связи между объектами

В таблице на вкладке Связанные объекты синим цветом подсвечиваются новые изменения, а связи установленные ранее никак не выделяются
Импорт и Экспорт данных
Для всех объектов бизнес-глоссария добавлена возможность создания и обновления через импорт csv-файла. Импорт доступен для терминов любых типов, предметных областей, глоссариев и загрузки любых атрибутов.

Чтобы перейти в Импорт данных необходимо открыть одноименный подраздел на странице Настройки.

Для корректной работы импорта придерживайтесь правил:

  • Разделитель- запятая;
  • Кодировка- Юникод (UTF-8).

Допускается ввод значений как с использованием кавычек, так и без.
Загрузка шаблона
Для того, чтобы загрузить шаблон импорта, выберите тип термина, чтобы сформировался необходимый перечень атрибутов и нажмите кнопку Скачать шаблон.

Для вашего удобства вы можете управлять перечнем столбцов- удалите из файла те атрибуты, которые не планируете заполнять.

Загрузка шаблона импорта терминов

Импорт поддерживает одновременную загрузку различных типов терминов. После скачивания шаблона вы можете расширить перечень столбцов.
Процесс импорта
Импорт состоит из нескольких этапов:

  1. Загрузка импортируемого файла.
  2. Проверка импортируемого файла — На этом этапе выводятся найденные ошибки. Основываясь на результатах проверки вы можете принять решение о продолжении импорта или отмене. Ошибочные строки пропускаются при продолжении процесса.
  3. Результат импорта — Финальное отображение, где можно проверить какие объекты были созданы в системе, а какие прерваны.

Импорт данных

В таблице проверки и результата импорта существуют дополнительные столбцы:

  1. Статус импорта — принимает значение Создание/Обновление/Ошибка.
  2. Описание ошибки — столбец, в котором отображаются ошибки, которые относятся именно к этой строке.
Правила заполнения файла импорта
Для корректного определения связей и указания атрибутов без ошибок придерживайтесь следующих правил:

  1. Для связи с термином, предметной областью или тегом необходимо указывать полное имя объекта: «Основной глоссарий.Бухглатерия» — для предметных областей и терминов. (Наименование глоссария.Наименование термина/Предметной области) «Tier.Tier1» — для тегов (Категория тегов. Тег)
  2. Указывая стюарда или владельца термина вводите username, а не ФИО пользователя. Например, «i.ivanov»
  3. Для перечесления нескольких значений в одном атрибуте используйте; (точка с запятой)
  4. Для атрибутов типа «Ссылки URL» вводите значения в формате «[название](ссылка)».
  5. При обновлении объектов глоссария требуется минимальный набор столбцов: Наименование, Предметная область, Глоссарий, Тип объекта. Этот набор используется для определения нужного объекта, а остальные столбцы вы можете указывать на свое усмотрение.
Добавление связей с физическими объектами каталога данных
Начиная с релиза Arenadata Catalog 0.4.1 доступно массовое создание связей терминов с физическими объектами средствами импорта. Для этого используется столбец Assets, который вы можете добавить в файл импорта вручную или скачать в шаблоне импорта терминов.
Через импорт доступно создание связей с верхним уровнем объектов:

  1. Table
  2. Pipeline
  3. Dashboard.
  4. Mlmodel
  5. Topic
  6. Container
При заполнении файла импорта необходимо указывать префикс- тип связываемого объекта, который равен наименованию типов из списков выше. После префикса указать FQN физического объекта: сервис.бд.схема.таблица. Например, Table.postgres.postgres.public.table
FQN объекта можно просмотреть в ссылке, когда мы смотрим карточку термина host/table/postgres.postgres.public.table

Чтобы с помощью импорта создать связь с атрибутом физического объекта, например, со столбцом таблицы, необходимо после наименования таблицы через двоеточие указать наименование столбца:
Table.postgres.postgres.public.table:field

Чтобы добавить несколько связей с 1 термином, используйте ; — в качестве разделителя между несколькими значениями
FQN объекта можно просмотреть в ссылке, когда открыта карточка объекта
host/table/postgres.postgres.public.table
Наименование типов объектов нечувствительны к регистру, соответственно, table и Table — это одно и то же.
Экспорт объектов глоссария из карточек объектов
Вы можете экспортировать в формат XLSX объекты глоссария всех типов. Это можно сделать различными способами:
  • Карточка Глоссария— будут экспортированы все объекты всех типов из этого глоссария. В выгрузке будет полный набор атрибутов объектов;
  • Карточка Предметной области— будут экспортированы все объекты всех типов из этой предметной области. В выгрузке будет полный набор атрибутов объектов;
  • Карточка объекта глоссария— будет экспортирован объект, в карточке которого мы выполняем экспорт. В выгрузке будет полный набор атрибутов объектов;

Экспорт объектов из карточек

Экспортированные файлы с объектами глоссария обратно совместимы для импорта.
Экспорт объектов глоссария из интерфейса обзора
На странице обзора объектов глоссария вы можете гибко настраивать какие объекты с каким атрибутивным составом должны попасть в вашу выгрузку.
В данном интерфейсе в экспортированный файл попадут только те столбцы, которы вы вывели на экран обзора глоссария.
Выбор объектов следует следующим правилами:
  1. Если установлены фильтры, то в выгрузку попадут только отфильтрованные объекты.
  2. Если множественным выбором выбраны какие-то объекты, то только они попадут в выгрузку.
  3. Если объекты не выбраны множественным выбором, то экспортируются все отображаемые объекты.

Экспорт объектов на странице обзора глоссария

Атрибуты Наименование, Предметная Область, Глоссарий и Assets будут всегда выгружаться для вашего удобства.