Словари
Описание параметров
Словари – это ресурсы, в которых хранятся данные, которые могут использоваться другими ресурсами и сервисами KUMA.
Доступные параметры:
- Название (обязательно) – уникальное имя для этого типа ресурса. Должно содержать от 1 до 128 символов Юникода.
- Тенант (обязательно) – название тенанта, которому принадлежит ресурс.
- Описание – вы можете добавить до 256 символов Юникода, описывающих ресурс.
- Тип (обязательно) – тип словаря. От выбранного типа зависит формат данных, которые может содержать словарь:
- В тип Словарь можно добавлять пары ключ–значение.
Не рекомендуется добавлять в словари этого типа более 50 000 записей.
При добавлении в словарь строк с одинаковыми ключами каждая новая строка будет записана поверх уже существующий строки с тем же самым ключом. В итоге в словарь будет добавлена только одна строка.
- В тип Таблица можно добавлять данные в виде сложных таблиц. С этим типом словарей можно взаимодействовать с помощью REST API.
- В тип Словарь можно добавлять пары ключ–значение.
- Блок параметров Значения – содержит таблицу с данными словаря:
- Для типа Словарь в блоке отображается перечень пар Ключ – Значение. Таблицу можно дополнять строками с помощью кнопки
. Удалить строки можно с помощью кнопки
, которая отображается при наведении курсора мыши на нужную строку.
- Для типа Таблица в блоке отображается таблица с данными. Таблицу можно дополнять строками и столбцами с помощью кнопки
. Удалить строки и столбцы можно с помощью кнопок
, которые отображаются при наведении курсора мыши на нужную строку или заголовок нужного столбца. Заголовки столбцов доступны для редактирования.
Если словарь содержит больше 5000 записей, они не отображаются в веб-интерфейсе KUMA. Для просмотра содержимого таких словарей содержимое необходимо экспортировать в формат CSV. Если CSV-файл отредактировать и снова импортировать в KUMA, ресурс словаря будет обновлен.
- Для типа Словарь в блоке отображается перечень пар Ключ – Значение. Таблицу можно дополнять строками с помощью кнопки
Импорт и экспорт словарей
Данные словарей можно импортировать или экспортировать в формате CSV (в кодировке UTF-8) с помощью кнопок Импортировать CSV и Экспортировать CSV.
Формат CSV-файла зависит от типа словаря:
- Тип Словарь:
{КЛЮЧ},{ЗНАЧЕНИЕ}\n
- Тип Таблица:
{Заголовок столбца 1},{Заголовок столбца N},{Заголовок столбца N+1}\n
{Ключ1},{ЗначениеN},{ЗначениеN+1}\n
{Ключ2},{ЗначениеN},{ЗначениеN+1}\n
Ключи должны быть уникальными как для CSV-файла, так и для словаря. В таблицах ключи указываются в первом столбце. Ключ должен содержать от 1 до 128 символов Юникода.
Значения должны содержать от нуля до 256 символов Юникода.
При импорте содержимое словаря перезаписывается загружаемым файлом. При импорте в словарь также изменяется название ресурса, чтобы отразить имя импортированного файла.
При экспорте, если ключ или значение содержат символы запятой или кавычек (, и "), они заключаются в кавычки ("). Кроме того, символ кавычки (") экранируется дополнительной кавычкой (").
Если в импортируемом файле обнаружены некорректные строки (например, неверные разделители), то при импорте в словарь такие строки будут проигнорированы, а при импорте в таблицу процесс импорта будет прерван.
Взаимодействие со словарями через API
С помощью REST API можно считывать содержимое словарей типа Таблица, а также изменять его, даже если эти ресурсы используются активными сервисами. Это позволяет, например, настроить обогащение событий данными из динамически изменяемых таблиц, выгружаемых из сторонних приложений.