Настроить cookie
Настройки cookie
Выберите данные которые вы бы хотели передавать на сайте
Версия от 29.05.2026г.
Руководство по модулю Каталоги
Содержание
- Руководство по модулю Каталоги
- Введение в Catalog Manager
- Словарь терминов
- Как войти в Catalog Manager
- Предсозданные каталоги
- Создание каталога
- Типы полей записи
- Настройка и редактирование каталога
- Ограничение числа записей
- Очистка каталога
- Удаление каталога
- Создание записи вручную
- Редактирование и удаление записи
- Пакетная загрузка записей
- Поддерживаемые форматы файлов
- Настройка загрузки
- Статусы выполнения загрузки
- Отмена запланированной загрузки
- Настройка удаления записей через файл
- Настройка выгрузки записей
- Использование каталогов
- В сегментации (DMPQL-выражения)
- Синтаксис
- Пример условия сегмента
- Использование в UI сегментации
- Работа с несколькими значениями
- В шаблонах сообщений
- Синтаксис
- Получение полей записи
- Пример вставки списка купленных товаров в письмо
- В сценариях триггерных коммуникаций
- При выгрузке в аналитическое хранилище
- Синтаксис
- Пример маппинга
- Роли и права доступа
Введение в Catalog Manager
Catalog Manager — это место, где вы можете хранить и использовать свои собственные списки данных: каталог товаров с ценами и описаниями, перечень категорий, справочник услуг или филиалов компании и многое другое.
Раньше система работала только с данными о клиентах. Теперь вы можете загрузить в неё и свои внутренние справочники, чтобы сделать коммуникации с клиентами ещё умнее и персонализированнее.
Раньше система работала только с данными о клиентах. Теперь вы можете загрузить в неё и свои внутренние справочники, чтобы сделать коммуникации с клиентами ещё умнее и персонализированнее.
Словарь терминов
Для упрощения понимания дальнейших инструкций необходимо ознакомиться с несколькими терминами, которые будут встречаться дальше.
Каталог — это ваш список данных. Как таблица в Excel: у неё есть название, и в ней хранятся однотипные записи (например, только товары или только список магазинов).
Запись каталога — одна строчка в вашем списке. Если каталог — это «Товары», то запись — это конкретный товар: «Кроссовки Nike Air Jordan».
Поле записи — характеристика записи. Например: «Цена», «Название», «Артикул», «Категория». У каждого поля есть название и тип (число, строка, дата и т.д.).
Логическое имя (slug) — техническое имя поля или каталога на латинице. Оно нужно системе, чтобы понимать, к какому полю вы хотите обратиться. Например, поле «Артикул» может иметь логическое имя sku. Вы будете встречать его в настройках сегментов и шаблонов писем. Логическое имя может содержать только строчные латинские буквы, цифры, дефис и нижнее подчёркивание (_).
Business ID — уникальный номер записи, который придумываете вы. Для товара это может быть артикул, для сотрудника — табельный номер. Система использует его, чтобы точно найти нужную запись. Значение должно быть уникальным в рамках каталога.
Название (Name) — понятное человеку имя записи. Именно его система будет показывать в интерфейсе и может подставлять в письма. Например, «Кроссовки Nike Air Jordan».
Ссылка на запись другого каталога — поле, значение которого является Business ID записи из другого каталога. Например, у товара поле «Категория» может ссылаться на запись из каталога «Категории товаров».
Каталог — это ваш список данных. Как таблица в Excel: у неё есть название, и в ней хранятся однотипные записи (например, только товары или только список магазинов).
Запись каталога — одна строчка в вашем списке. Если каталог — это «Товары», то запись — это конкретный товар: «Кроссовки Nike Air Jordan».
Поле записи — характеристика записи. Например: «Цена», «Название», «Артикул», «Категория». У каждого поля есть название и тип (число, строка, дата и т.д.).
Логическое имя (slug) — техническое имя поля или каталога на латинице. Оно нужно системе, чтобы понимать, к какому полю вы хотите обратиться. Например, поле «Артикул» может иметь логическое имя sku. Вы будете встречать его в настройках сегментов и шаблонов писем. Логическое имя может содержать только строчные латинские буквы, цифры, дефис и нижнее подчёркивание (_).
Business ID — уникальный номер записи, который придумываете вы. Для товара это может быть артикул, для сотрудника — табельный номер. Система использует его, чтобы точно найти нужную запись. Значение должно быть уникальным в рамках каталога.
Название (Name) — понятное человеку имя записи. Именно его система будет показывать в интерфейсе и может подставлять в письма. Например, «Кроссовки Nike Air Jordan».
Ссылка на запись другого каталога — поле, значение которого является Business ID записи из другого каталога. Например, у товара поле «Категория» может ссылаться на запись из каталога «Категории товаров».
Как войти в Catalog Manager
В этой процедуре предполагается, что вы знаете адрес (или URL) веб-сайта вашего сервера CD Join и у вас есть присвоенное вам имя пользователя и пароль. Если вам потребуется помощь, обращайтесь к администратору CD Join.
- Откройте ваш браузер и введите URL сервера CD Join.
- На странице входа в систему введите ваше имя пользователя и пароль. Далее нажмите кнопку Войти в аккаунт.
- Выберите Catalog Manager (Каталоги) в списке доступных модулей.
- Откроется домашняя страница Catalog Manager.
Предсозданные каталоги
При первом открытии Catalog Manager система автоматически создаёт для вашей организации четыре готовых каталога:
Предсозданные каталоги служат примером и отправной точкой для работы. Вы можете переименовывать их, изменять состав полей, загружать и удалять записи, а также полностью удалять их — точно так же, как и созданные вами каталоги.
Создание каталога
Для создания каталога выполните следующие действия:
Справа появится информация о корректности заполненных полей.
- Перейдите на главный экран Catalog Manager и нажмите Создать каталог.
- Появится окно для создания каталога.
- Укажите информацию о создаваемом каталоге:
- Название каталога — напишите понятное название, например «Товары» или «Филиалы».
- Логическое имя — укажите техническое имя на латинице (slug). Используется в DMPQL-выражениях и шаблонах сообщений. Например: goods, filials. Допустимы строчные латинские буквы, цифры, дефис и нижнее подчёркивание.
- Описание — опционально, напишите описание каталога для удобства команды.
- Идентификатор записи — укажите название и логическое имя поля, которое будет служить уникальным Business ID записи (например, «Артикул» / sku).
- Название записи — укажите название и логическое имя поля, которое будет отображаться как имя записи в интерфейсе и сообщениях (например, «Название товара» / name).
- Поля записи — опционально, добавьте дополнительные поля записи (например, «Цена» / price типа «Число», «Категория» / category типа «Ссылка на каталог»).
Справа появится информация о корректности заполненных полей.
- Появится окно для создания каталога.
- Укажите информацию о создаваемом каталоге:
- Название каталога — напишите понятное название, например «Товары» или «Филиалы».
- Логическое имя — укажите техническое имя на латинице (slug). Используется в DMPQL-выражениях и шаблонах сообщений. Например: goods, filials. Допустимы строчные латинские буквы, цифры, дефис и нижнее подчёркивание.
- Описание — опционально, напишите описание каталога для удобства команды.
- Идентификатор записи — укажите название и логическое имя поля, которое будет служить уникальным Business ID записи (например, «Артикул» / sku).
- Название записи — укажите название и логическое имя поля, которое будет отображаться как имя записи в интерфейсе и сообщениях (например, «Название товара» / name).
- Поля записи — опционально, добавьте дополнительные поля записи (например, «Цена» / price типа «Число», «Категория» / category типа «Ссылка на каталог»).
Справа появится информация о корректности заполненных полей.
Типы полей записи
При добавлении поля укажите его тип данных:
Настройка и редактирование каталога
Для редактирования или настройки каталога перейдите в нужный каталог и нажмите Настройки каталога.
Откроется окно с редактированием полей, заданных при создании каталога.
Вы можете: - изменить название, логическое имя и описание каталога; - добавить, переименовать или удалить поля записи; - изменить тип поля (применяется к последующим загрузкам данных).
Важно: изменение логического имени каталога или полей потребует обновления всех DMPQL-выражений и шаблонов сообщений, которые к ним обращаются.
Важно: изменение логического имени каталога или полей потребует обновления всех DMPQL-выражений и шаблонов сообщений, которые к ним обращаются.
Ограничение числа записей
Система ограничивает суммарное число записей во всех каталогах вашей организации. При достижении лимита новые записи не будут сохраняться, а при попытке добавить их вручную вы увидите сообщение об ошибке в интерфейсе.
При пакетной загрузке через файл записи, не попавшие в каталог из-за превышения лимита, будут отражены в файле с логом ошибок.
Если вы получаете подобные ошибки — обратитесь к администратору системы для увеличения лимита.
При пакетной загрузке через файл записи, не попавшие в каталог из-за превышения лимита, будут отражены в файле с логом ошибок.
Если вы получаете подобные ошибки — обратитесь к администратору системы для увеличения лимита.
Очистка каталога
Внутри каталога можно нажать на кнопку Очистить. Это позволит удалить все записи каталога, сохранив его настройки и структуру полей.
Внимание: операция необратима. Все записи будут удалены без возможности восстановления.
Удаление каталога
Для удаления каталога воспользуйтесь соответствующей кнопкой в настройках каталога.
Внимание: при удалении каталога удаляются все его записи и настройки загрузки/выгрузки/удаления. DMPQL-выражения и шаблоны сообщений, использующие этот каталог, перестанут работать корректно.
Создание записи вручную
Чтобы добавить запись вручную, откройте нужный каталог и нажмите кнопку Создать запись.
Откроется форма для заполнения полей записи.
Заполните поля: - Идентификатор записи (Business ID) — уникальное значение в рамках каталога, например артикул товара. - Название — отображаемое имя записи. - Дополнительные поля — значения остальных полей, заданных в настройках каталога.
После заполнения нажмите Сохранить.
После заполнения нажмите Сохранить.
Созданная запись появится в списке каталога.
Редактирование и удаление записи
Для редактирования записи нажмите на неё в списке — откроется форма редактирования.
Для удаления конкретной записи воспользуйтесь кнопкой Удалить в форме редактирования.
Пакетная загрузка записей
Вместо ручного ввода вы можете загрузить записи из файла. Это удобно при работе с большими объёмами данных.
Поддерживаемые форматы файлов
Поддерживается чтение архивов GZIP и ZIP.
Настройка загрузки
Чтобы осуществить загрузку данных, нажмите Настройка загрузки.
Отобразится окно с настройками для загрузки.
Заполните следующие поля:
После заполнения настроек нажмите Сохранить. Загрузка запустится в соответствии с выбранным расписанием.
- Путь к файлу — укажите путь к файлу в File Manager, из которого будут загружаться записи.
- Формат, кодировка и сжатие — укажите формат файла (CSV, JSON, XML, YML), кодировку (UTF-8 или Windows-1251) и тип сжатия (нет / ZIP / GZIP).
- Расписание — выберите режим запуска:
- Разовый — укажите дату и время однократного запуска.
- Периодический — укажите расписание в формате cron для регулярной загрузки.
- Удалить файл после загрузки — активируйте переключатель, если необходимо удалить исходный файл после выполнения задачи.
- Настройки CSV — если выбрали формат CSV, укажите разделитель, символ кавычек и наличие строки заголовков.
- Идентификатор записи — укажите, в каком поле файла находится Business ID записи (путь к значению для JSON/XML или номер столбца для CSV).
- Название записи — укажите, в каком поле файла находится название записи.
- Дополнительные поля — задайте маппинг остальных полей файла в поля каталога.
После заполнения настроек нажмите Сохранить. Загрузка запустится в соответствии с выбранным расписанием.
Статусы выполнения загрузки
После запуска задачи загрузки вы можете отслеживать её статус в интерфейсе каталога:
Отмена запланированной загрузки
Если загрузка ещё не запустилась, вы можете её отменить, сняв флажок Активна в настройках загрузки. Это отключит регулярную загрузку, не изменяя заданное расписание.
Настройка удаления записей через файл
Помимо ручного удаления, можно настроить удаление записей по списку из файла.
Для настройки нажмите Настройка удаления.
Для настройки нажмите Настройка удаления.
Откроется окно, в котором можно указать параметры удаления.
Заполните поля:
- Путь к файлу — укажите путь к файлу в File Manager, который содержит идентификаторы записей для удаления.
- Формат, кодировка и сжатие — укажите настройки файла (аналогично загрузке).
- Расписание — выберите режим запуска: разовый или периодический.
- Удалить файл после загрузки — активируйте, если необходимо удалить файл после выполнения задачи.
- Настройки CSV — если файл в формате CSV, укажите разделитель, символ кавычек и наличие заголовков.
- Путь к идентификатору — укажите маппинг Business ID: по этому значению система найдёт запись для удаления.
Настройка выгрузки записей
Чтобы выгрузить записи каталога в файл, нажмите Настройки выгрузки.
Откроется окно настроек выгрузки.
Заполните следующие настройки:
- Путь к директории — укажите путь к директории в File Manager, куда будут выгружаться файлы.
- Префикс названия файла — укажите префикс, который будет добавляться к имени выгружаемого файла.
- Формат, кодировка и сжатие — для выгрузки поддерживаются форматы CSV и JSON.
- Расписание — выберите режим: разовый запуск или периодический по расписанию.
- Настройки CSV — если выбрали CSV, укажите разделитель, символ кавычек и нужно ли добавлять строку заголовков.
- Идентификатор записи — укажите, в какое поле выходного файла выгружать Business ID.
- Название записи — укажите, в какое поле выходного файла выгружать название записи.
- Дополнительные поля — задайте маппинг дополнительных полей каталога в поля выходного файла.
Использование каталогов
В сегментации (DMPQL-выражения)
Данные каталогов можно использовать в условиях сегментов. Для этого применяется функция catalog() в языке DMPQL.
Синтаксис
catalog("логическое_имя_каталога", id_записи)
Функция принимает логическое имя каталога и Business ID записи (или выражение, возвращающее ID). После получения записи можно обратиться к любому её полю через точку.
Примеры:
// Получить цену товара с businessId = 10
catalog("goods", 10).price
// Получить имя категории через цепочку ссылок
catalog("goods", 10).category.name
// Использовать ID из атрибута события (атрибут №1)
catalog("goods", attr(1)).price > 5000
Для предсозданных каталогов доступны сокращённые функции:
Функция принимает логическое имя каталога и Business ID записи (или выражение, возвращающее ID). После получения записи можно обратиться к любому её полю через точку.
Примеры:
// Получить цену товара с businessId = 10
catalog("goods", 10).price
// Получить имя категории через цепочку ссылок
catalog("goods", 10).category.name
// Использовать ID из атрибута события (атрибут №1)
catalog("goods", attr(1)).price > 5000
Для предсозданных каталогов доступны сокращённые функции:
Пример условия сегмента
Следующее выражение найдёт всех клиентов, которые покупали товар стоимостью больше 5 000 из категории «Промо товары» (id купленного товара хранится в атрибуте события №1):
audience from customer_journey(
TM[catalog("goods", attr(1)).price > 5000 AND catalog("goods", attr(1)).category.name = "Промо товары"]
)
audience from customer_journey(
TM[catalog("goods", attr(1)).price > 5000 AND catalog("goods", attr(1)).category.name = "Промо товары"]
)
Использование в UI сегментации
Работа с несколькими значениями
Если атрибут содержит несколько ID записей (например, несколько купленных товаров в одном событии), функция catalog() вернёт несколько записей. Условие будет выполняться, если оно истинно хотя бы для одной из них:
// true, если хотя бы один купленный товар стоил больше 5000
catalog("goods", attr(1)).price > 5000
Аналогично работают поля-массивы. Например, если у товара несколько тегов:
// true, если хотя бы один тег = "sale"
catalog("goods", attr(1)).tags = "sale"
// true, если хотя бы один купленный товар стоил больше 5000
catalog("goods", attr(1)).price > 5000
Аналогично работают поля-массивы. Например, если у товара несколько тегов:
// true, если хотя бы один тег = "sale"
catalog("goods", attr(1)).tags = "sale"
В шаблонах сообщений
Данные каталогов можно вставлять в тексты email-рассылок, push-уведомлений и других сообщений в Campaign Manager.
Синтаксис
catalog.record("логическое_имя_каталога", profile.attr(id_атрибута, -1))
Для предсозданных каталогов — сокращённые функции:
catalog.goods(profile.attr(20001, -1))
catalog.category(profile.attr(20001, -1))
catalog.service(profile.attr(20001, -1))
catalog.filial(profile.attr(20001, -1))
Для предсозданных каталогов — сокращённые функции:
catalog.goods(profile.attr(20001, -1))
catalog.category(profile.attr(20001, -1))
catalog.service(profile.attr(20001, -1))
catalog.filial(profile.attr(20001, -1))
Получение полей записи
Важно: в шаблонах нельзя обратиться к полю записи через точку (как в DMPQL). Для получения значения поля используйте функцию .field("имя_поля").
Пример вставки списка купленных товаров в письмо
{% set items = catalog.record("goods", profile.attr(1, -1)) %}
{% for item in items %}
Артикул: {{ item.id() }}
Название: {{ item.name() }}
Цена: {{ item.field("price") }}
{% endfor %}
{% for item in items %}
Артикул: {{ item.id() }}
Название: {{ item.name() }}
Цена: {{ item.field("price") }}
{% endfor %}
В сценариях триггерных коммуникаций
Каталоги можно использовать в Campaign Manager в сценариях триггерных рассылок:
- В условиях шагов сценария — аналогично использованию в сегментации, через DMPQL-выражения.
- При вычислении переменных контекста — чтобы подготовить данные для подстановки в шаблоны сообщений.
При выгрузке в аналитическое хранилище
Если вы используете выгрузку профилей или событий в аналитическое хранилище (Clickhouse), в маппинге полей можно обращаться к данным каталогов.
Синтаксис
catalog(id_атрибута, 'логическое_имя_каталога').метод()
Доступные методы:
Доступные методы:
Пример маппинга
insert {
catalog(10001, 'goods').id() into 'good_id'
catalog(10001, 'goods').name() into 'good_name'
catalog(10001, 'goods').fields('category', 'price') into 'good_category_and_price'
catalog(10001, 'goods').fieldsAsJson('category', 'price') into 'good_category_and_price_json'
}
Результат выгрузки (значения записываются в виде массива, т.к. функция catalog может вернуть несколько записей):
good_id: ["1"]
good_name: ["Nike Air Jordan"]
good_category_and_price: [5, 100.0]
good_category_and_price_json: [{"category": "5", "price": 100.0}]
catalog(10001, 'goods').id() into 'good_id'
catalog(10001, 'goods').name() into 'good_name'
catalog(10001, 'goods').fields('category', 'price') into 'good_category_and_price'
catalog(10001, 'goods').fieldsAsJson('category', 'price') into 'good_category_and_price_json'
}
Результат выгрузки (значения записываются в виде массива, т.к. функция catalog может вернуть несколько записей):
good_id: ["1"]
good_name: ["Nike Air Jordan"]
good_category_and_price: [5, 100.0]
good_category_and_price_json: [{"category": "5", "price": 100.0}]
Роли и права доступа
Доступ к разделу Catalog Manager разграничивается следующими ролями:
Для получения или изменения прав доступа обратитесь к администратору системы.