Описание формата XLSX-файла¶
Файл Excel используется для экспорта записей в Excel и импорта записей из Excel в систему. Причем, для импорта можно либо скачать пустой шаблон, либо использовать результаты экспорта (доступного в пакетных операциях с записями).
Рекомендуется изучать файл Excel на готовом примере. Например, выполнить пакетную операцию экспорта для любого типа актива, либо скачать шаблон для импорта, если данных нет.
Файл Excel может состоять из нескольких листов, каждый из которых содержит описание отдельного объекта. Тип объекта можно определить по первой букве в названии листа:
Основной лист:
A<Имя_типа_актива> – основной лист типа актива (от asset);
E<Имя_справочника> - основной лист справочника (от entity);
Дополнительные листы:
N<Имя_вложенного_объекта> – лист вложенного объекта (от nested);
R<relations> – лист связей (от relation).
Также в названии листа указывается логическое имя объекта (не более 31 символа).
При повторном импорте записей (редактировании существующих данных) при помощи ETALON_ID, вне зависимости от того, какая система-источник указана, записи будут загружаться от имени внутреннего (системного) источника. Для загрузки данных от имени других источников используйте EXTERNAL_ID.
Общие примечания¶
Каждый лист имеет системные атрибуты (столбцы синего цвета) и основные атрибуты объекта.
Каждому атрибуту соответствует отдельный столбец.
Каждая новая строка соответствует отдельной записи.
VIRTUAL_ID, ETALON_ID и EXTERNAL_ID в листах атрибутов и вложенных объектов служат для идентификации записи, к которой они привязываются.
Идентификация происходит по содержимому основного листа. Если запись не найдена, то вставляемый объект (комплексный атрибут или связь) будет проигнорирован.
Нельзя опубликовать запись актива в котором присутствуют атрибуты с длиной строки больше 32 767 символов (включает в себя кириллицу, латиницу и скрытые символы), так как это ограничение ячейки xlsx.
Пакетные операции не являются частью бизнес-процессов и запускаются напрямую.
Наименования заголовков столбцов:
В заголовке столбца массив-атрибута отображается описание ожидаемого значения.
В заголовке атрибута типа "Ссылка на справочник" отображается полный путь + имя кодового атрибута.
В заголовке атрибута типа "Перечисление" записывается путь до атрибута + имя перечисления, отображаемое имя, необходимое поле для ввода.
В заголовке атрибута типа "Локальное перечисление" записывается путь до атрибута, имя, отображаемое имя.
Основной лист типа актива¶
Примечание
Основной лист справочника имеет такую же структуру, но вместо столбца VIRTUAL_ID содержит столбец ID
Столбец |
Описание |
При импорте |
При экспорте |
VIRTUAL_ID |
Виртуальный ключ актива |
Заполняется пользователем произвольным значением. Ключ не сохраняется в Universe DG, а используется для создания связей или вложенных объектов на других листах при импорте актива через XLSX |
Не используется |
ETALON_ID |
Эталонный ключ актива |
Заполняется эталонным ключом существующего в Universe DG актива для обновления атрибутов актива либо его связей через XLSX. В случае если актив с заданным эталонным ключом не найден, то запись, ее связи и вложенные объекты будут пропущены с выводом сообщения в отчет |
Заполняется эталонным ключом экспортируемого актива |
EXTERNAL_ID |
Внешний ключ актива |
Заполняется внешним ключом создаваемого или уже существующего в Universe DG актива. Система источник выбирается в мастере перед запуском импорта через XLSX. Если по указанному внешнему ключу и системе источнику не найден существующий актив, то будет создан новый |
Не используется |
IS_ACTIVE |
Флаг логического удаления актива |
Заполняется только в том случае, если производится обновление уже существующего актива в Universe DG. Значением false (off, n, f, no или 0 без учета регистра), если необходимо логически удалить актив; значением true (on, yes, y, t или 1 без учета регистра), если актив удалять не следует |
Значение = FALSE, если экспортируемый актив удален логически; = TRUE, если активен |
EXTERNAL_KEYS |
Внешние ключи актива |
Не используется |
Заполняется внешними ключами экспортируемого актива по форме: <ИМЯ_СИСТЕМЫ_ИСТОЧНИКА> | <ВНЕШНИЙ_КЛЮЧ> <ИМЯ_СИСТЕМЫ_ИСТОЧНИКА> | <ВНЕШНИЙ_КЛЮЧ> | … |
При импорте через XLSX необходимо заполнять только одну из трех колонок VIRTUAL_ID, ETALON_ID, EXTERNAL_ID.
Лист вложенных объектов¶
Столбец |
Описание |
При импорте |
При экспорте |
|---|---|---|---|
VIRTUAL_ID |
Виртуальный ключ актива, к которому принадлежит вложенный объект |
Заполняется виртуальным ключом импортируемого актива из листа активов, к которому принадлежит вложенный объект |
Не используется |
ETALON_ID |
Эталонный ключ актива, к которому принадлежит вложенный объект |
Заполняется эталонным ключом импортируемого актива из листа активов, к которому принадлежит вложенный объект |
Заполняется эталонным ключом экспортируемого актива, к которому принадлежит вложенный объект |
EXTERNAL_ID |
Внешний ключ актива, к которому принадлежит вложенный объект |
Заполняется внешним ключом импортируемого актива из листа активов, к которому принадлежит вложенный объект |
Не используется |
EXTERNAL_KEYS |
Внешние ключи актива, к которому принадлежит вложенный объект |
Не используется |
Заполняется внешними ключами экспортируемого актива, к которому принадлежит вложенный объект: <ИМЯ_СИСТЕМЫ_ИСТОЧНИКА> | <ВНЕШНИЙ_КЛЮЧ> <ИМЯ_СИСТЕМЫ_ИСТОЧНИКА> | <ВНЕШНИЙ_КЛЮЧ> | ... |
ASSET_TYPE |
Тип актива, к которому принадлежит вложенный объект |
Не используется, так как на данный момент доступен импорт активов только одного типа |
Заполняется именем типа актива, к которому принадлежит вложенный объект |
COMPLEX_ATTRIBUTE |
Комплексный атрибут, к которому принадлежит вложенный объект |
Заполняется именем комплексного атрибута, к которому принадлежит вложенный объект |
Заполняется именем комплексного атрибута, к которому принадлежит вложенный объект |
Лист связей¶
Столбец |
Описание |
При импорте |
При экспорте |
|---|---|---|---|
FROM_VIRTUAL_ID |
Виртуальный ключ исходящего актива |
Заполняется виртуальным ключом импортируемого актива из листа активов, из которого будет создана импортируемая связь |
Не используется |
FROM_ETALON_ID |
Эталонный ключ исходящего актива |
Заполняется эталонным ключом импортируемого актива из листа активов, из которого будет создана импортируемая связь |
Заполняется эталонным ключом исходящего актива экспортируемой связи |
FROM_EXTERNAL_ID |
Внешний ключ исходящего актива |
Заполняется внешним ключом импортируемого актива из листа активов, из которого будет создана импортируемая связь |
Не используется |
FROM_ASSET_TYPE |
Тип исходящего актива |
Не используется, т.к. сейчас доступен импорт активов только одного типа и только исходящих связей |
Заполняется именем типа исходящего актива экспортируемой связи |
FROM_DISPLAY_NAME |
Отображаемое имя исходящего актива |
Не используется |
Заполняется отображаемым именем исходящего актива экспортируемой связи |
TO_ETALON_ID |
Эталонный ключ входящего актива |
Заполняется эталонным ключом существующего актива в Universe DG, к которому будет создана импортируемая связь. Доступно создание связей только к уже существующим в системе Universe DG активам |
Заполняется эталонным ключом входящего актива экспортируемой связи |
TO_EXTERNAL_ID |
Внешний ключ входящего актива |
Заполняется внешним ключом существующего актива в Universe DG, к которому будет создана импортируемая связь. Доступно создание связей только к уже существующим в системе Universe DG активам |
Не используется |
TO_ASSET_TYPE |
Тип входящего актива |
Заполняется именем типа актива существующего актива в Universe DG, к которому будет создана импортируемая связь. Доступно создание связей только к уже существующим в системе Universe DG активам |
Заполняется именем типа входящего актива экспортируемой связи |
TO_DISPLAY_NAME |
Отображаемое имя входящего актива |
Не используется |
Заполняется отображаемым именем входящего актива экспортируемой связи |
RELATION_TYPE |
Тип связи |
Заполняется именем типа импортируемой связи |
Заполняется именем типа экспортируемой связи |
RELATION_ETALON_ID |
Эталонный ключ связи |
Не используется |
Заполняется эталонным ключом экспортируемой связи |
В колонках FROM_VIRTUAL_ID, FROM_ETALON_ID, FROM_EXTERNAL_ID значения ключей активов, которых нет на листе активов, не указываются - такие связи будут пропущены.
Поиск записей по системным атрибутам¶
При заполнении шаблона необходимо учитывать возможные случаи содержания трех главных системных атрибутов записи: VIRTUAL_ID, ETALON_ID и EXTERNAL_ID.
Приоритет колонок при идентификации: VIRTUAL_ID, ETALON_ID, затем EXTERNAL_ID.
Если в основном листе не задан ни один из ключей, она будет вставлена как новая. Привязать объекты к такой записи невозможно.
Если в основном листе VIRTUAL_ID Задан, ETALON_ID Пустой, EXTERNAL_ID Пустой: запись будет вставлена как новая. Только этот ключ будет использоваться для поиска между листами.
Если в основном листе VIRTUAL_ID Пустой, ETALON_ID Задан, EXTERNAL_ID Пустой: для поиска будет использован ETALON_ID. Только этот ключ будет использоваться для поиска между листами.
Если в основном листе VIRTUAL_ID Пустой, ETALON_ID Пустой, EXTERNAL_ID Задан: для поиска будет использован EXTERNAL_ID. Только этот ключ будет использоваться для поиска между листами.
Если в основном листе VIRTUAL_ID Задан, ETALON_ID Задан, EXTERNAL_ID Задан: для поиска будет использован VIRTUAL_ID. Только этот ключ будет использоваться для поиска между листами.
Если в основном листе VIRTUAL_ID Задан, ETALON_ID Задан, EXTERNAL_ID Пустой: для поиска будет использован VIRTUAL_ID. Только этот ключ будет использоваться для поиска между листами.
Если в основном листе VIRTUAL_ID Задан, ETALON_ID Пустой, EXTERNAL_ID Задан: для поиска будет использован VIRTUAL_ID. Только этот ключ будет использоваться для поиска между листами.
Рекомендуется заполнять один тип ключа для всех объектов соответствующей записи (для типа актива, комплексных атрибутов, связей).