linkДокументация по модулю "Универсальный товарный экспорт для CS-Cart и Multi-Vendor (xml, csv, yml, txt форматы)"

Для создания нового шаблона выгрузки выполните следующие действия:

1) Перейдите на страницу Панель администратора → Модули → Скачанные модули и у названия модуля AB: Универсальный товарный экспорт (xml и csv форматы) в меню шестерёнки выберите раздел Список шаблонов. В открывшейся странице нажмите кнопку [+] Добавить новый шаблон;
2) На странице Добавить новый шаблон введите название шаблона, выберите нужный шаблон по умолчанию из выпадающего списка и нажмите кнопку Загрузить шаблон;
3) Внесите правки в код шаблона, если это необходимо, и сохраните шаблон.

Для создания новой выгрузки выполните следующие действия:

1) Перейдите на страницу Панель администратора → Модули → Скачанные модули и у названия модуля AB: Универсальный товарный экспорт (xml и csv форматы) в меню шестерёнки выберите раздел Список выгрузок. В открывшейся странице нажмите кнопку [+] Добавить новую выгрузку;

2) На странице Добавить новую выгрузку заполните поля, следуя подсказкам. В поле Шаблон выберите созданный ранее шаблон;

3) На вкладке Условия выборки данных укажите необходимые критерии подбора товаров. Присутствует возможность выгружать скрытые сущности (товары, категории, характеристики). Обратите внимание, что список стоп-слов ограничен 3000-ми символов, так как большее количество символов может вызвать ошибки базы данных.

Настройка Тип категорий используется для выбора товаров в выгрузке на основе их категорий (не путать с подкатегориями). Каждый товар всегда имеет одну главную категорию и может принадлежать нескольким дополнительным категориям. Например, товар может находиться в нескольких категориях: "Звуковая система" будет главной категорией, а "Мультимедиа" и "Акустические системы" — дополнительными. Таким образом настройка может выводить товар как для всех трёх категорий, так и для одного конкретного типа категории.

4) На вкладке Включить объекты данных можно выполнить следующие действия:

• выбрать категории, товары которых хотите добавить в выгрузку. Установите чекбокс Включая подкатегории, если хотите выгружать товары всех вложенных категорий.
• задать дополнительный отбор товаров по характеристикам. Отбор товаров по нескольким условиям характеристик и/или по категориям работает совместно. К примеру, при выборе категории Планшеты, характеристик Бренд Samsung и Дисплей 7.0”, в выгрузку будут отобраны только те товары, которые удовлетворяют все условия — планшеты Samsung с дисплеем 7.0”.
• добавить товары в выгрузку поштучно.
• выполнить отбор товаров по продавцам (только для редакции Multi-Vendor).

Схема обьединения условий позволяет комбинирировать условия отбора товаров. Вариант И - будут выбраны товары, которые удовлетворяют оба условия (верхнее и нижнее) одновременно. Вариант ИЛИ - будут выбраны товары, которые удовлетворяют хоть одно из условий (верхнее или нижнее).

5) На вкладке Исключить объекты данных аналогично выберите элементы, которые нужно исключить из выгрузки;

6) На вкладке Дополнительные параметры можно задать произвольные значения параметрам и использовать их в шаблоне по названию переменной. В данном примере, используя в коде {$abpfe_p1} мы получим значение utf-8.

Для генерации файла выгрузки одним из способов:

1) Перейдите на страницу Панель администратора → Модули → Скачанные модули и у названия модуля AB: Универсальный товарный экспорт (xml и csv форматы) в меню шестерёнки выберите раздел Список выгрузок. В открывшейся странице в меню шестерёнки выберите раздел Сгенерировать выгрузку;

2) На странице модуля Список выгрузок откройте выгрузку на редактирование и в меню шестерёнки нажмите Сгенерировать выгрузку. Также тут можно увидеть ссылку на файл выгрузки. Если Вы указали логин и пароль при создании выгрузки - то они потребуются для просмотра файла;

3) Используйте Cron-команду для обновления устаревшей информации;

4) На странице модуля Список выгрузок откройте выгрузку на редактирование и установите чекбокс Генерировать перед загрузкой. Таким образом, при каждом скачивании файла выгрузки вы будете его перегенерировать. Это позволит держать данные файла всегда актуальными, но обратите внимание, что время скачивания файла будет включать в себя время на генерацию выгрузки.

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

Вставьте hook fn_set_hook('ab__pfe_autogenerate'); в тот участок PHP-кода, после выполнения которого Вы хотите перегенерировать файлы. Пример автоматической перегенерации файлов после обмена 1С (для этого нужно вставить hook в коде завершения обмена app/addons/rus_exim_1c/Tygh/Commerceml/RusEximCommerceml.php):

Для ограничения доступа к файлу выгрузки — установите логин и пароль для защиты файла выгрузки.

Для добавления в выгрузку конкретной характеристики необходимо убедиться, что параметр get_features в шаблоне установлен true:

Далее, в шаблоне используйте переменную {$product.features.FEATURE_ID.value}, вставляя вместо FEATURE_ID идентификатор нужной характеристики.

В параметре extra_fields указываете список дополнительных полей из базы данных в формате массива ['t1.field1', 't2.field2', 't2.field3'], где:
t1, t2 — сокращенные префиксы таблиц (p — products, pd — product_descriptions, pp — product_prices);
field1, field2, field3 — поля в базе данных.

Параметр extra_join — являет собой строку с JOIN-ами (подключение таблиц), а extra_condition — строка с дополнительными условиями соответственно. После добавления этих значений, в блоке товаров будут доступны соответствующие переменные $product.field1, $product.field2, $product.field3.

Образец добавления в выгрузку конкретного поля, например, промо-текста, происходит следующим способом:

Для выгрузки вариаций товаров установите чекбокс Выгружать вариации на вкладке Условия выгрузки данных:

Без установки чекбокса — будут выгружены вариации как отдельные товары, а с чекбоксом — добавятся вариации как один товар.

Для учёта скидок товаров по промо-акциям — установите чекбокс Применять акции на вкладке Общие настройки:

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

Для версии CS-Cart 4.8.2 и ниже, для использования водяных знаков при https необходимо в файл /app/addons/watermarks/func.php добавить строку $image_data['https_image_path'] = Storage::instance('images')→getUrl($prefix . $path . '/' . $image_name, 'https');. Результат должен выглядеть так:

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

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

Модуль добавляет опции Просмотр настроек и данных модуля и Управление настройками и данными модуля в права пользователей:

• Просмотр настроек и данных модуля — разрешает просматривать данные по выгрузкам и шаблонам;
• Управление настройками и данными модуля — позволяет редактировать эти данные, создавать и удалять выгрузки и шаблоны.

Если при попытке удалить модуль Вы получаете сообщение Предупреждение. Этот модуль не может быть удален, потому что работа следующих модулей зависит от него: …, то необходимо для начала удалить зависимый модуль, а уже затем — данный. При установке следуйте в обратном порядке: сначала основной модуль, затем зависимые.

Так как файлы выгрузок не находятся в корне сайта, nginx должен проксировать такие запросы на сайт (в обход стандартной отдачи статических файлов). Вы можете для этого использовать прямую ссылку на файл:
location = /ab__pfe_1_test.xml

Но, чтобы не создавать отдельное правило для каждой выгрузки, лучше использовать следующую маску:
location ~ ^/ab__pfe_[0-9]+_.*$

Если при запросе файла сайта Вы получаете 404 ошибку сервера (не путать с 404 страницей сайта), значит проксирование настроено некорректно.

Если при запуске генерации Вы видите сообщение вида

Генерация фида начата 01/01/2020 12:00. Выгружено 200 из 300 товаров

значит, генерация фида не завершена. Если при обновлении окна число выгруженных товаров не меняется, вероятно что генерация зависла. Вы можете сбросить её по нажатию шестерёнки Сброс генерации фида.

ab__pfe_datafeeds:tabs_content ‒ позволяет добавлять свои вкладки.

ab__pfe:addons ‒ повзоляет добавить информацию о своих переменных в правом нижнем сайдбаре.

Функция удаления выгрузок имеет хук ab__pfe_delete_datafeeds, который запускается в самом начале выполнения функции со следующими параметрами:

• $datafeed_ids (array) ‒ список идентификаторов выгрузок.

Функция генерации выгрузки имеет хук ab__pfe_extra_vars, который позволяет добавить свои переменные в шаблон вызрузки. Параметры хука:

• $vars (array) ‒ массив переменных.

Функция получающая список характеристик товаров для вызрузки имеет ряд хуков.

Хук ab__pfe_get_features запускается в самом начале выполнения функции со следующими параметрами:

• $products (array) ‒ список товаров;
• $params (array) ‒ параметры;
• $lang_code (string) ‒ код языка;
• $exclude_ids (array) ‒ список характеристик, которые будут исключены из выборки.

Хук ab__pfe_get_product_features запускается после получения списка характеристик товара со следующими параметрами:

• $product (array) ‒ данные товара;
• $features (array) ‒ список характеристик;
• $params (array) ‒ параметры;
• $lang_code (string) ‒ код языка;
• $exclude_ids (array) ‒ список характеристик, которые были исключены из выборки.

Хук ab__pfe_get_features_post запускается после получения списка характеристик для всех товаров со следующими параметрами:

• $products (array) ‒ список товаров;
• $params (array) ‒ параметры;
• $lang_code (string) ‒ код языка;
• $exclude_ids (array) ‒ список характеристик, которые были исключены из выборки.

Функция удаления пользовательских шаблонов имеет ряд хуков.

Хук ab__pfe_delete_templates_pre запускается в самом начале выполнения функции со следующими параметрами:

• $template_ids (array) ‒ список идентификаторов шаблонов.

Хук ab__pfe_delete_templates_post запускается после успешного или не успешного процеса удаления со следующими параметрами:

• $template_ids (array) ‒ список идентификаторов шаблонов;
• $deleted (bool) ‒ признак успешного или не успешного удаления.

Функция получения списка категорий выгрузки имеет хук ab__pfe_get_categories, который запускается перед построением запроса получения списка категорий со следующими параметрами:

• $datafeed (array) ‒ данные выгрузки;
• $fields (array) ‒ список полей для выборки;
• $join (string) ‒ список таблиц для join-a в запросе;
• $conditions (string) ‒ список условий для выборки.

Функция получающая список товаров вызрузки (со временной таблицы) имеет ряд хуков.

Хук ab__pfe_get_items_pre запускается в самом начале выполнения функции со следующими параметрами:

• $datafeed (array) ‒ данные выгрузки;
• $params (array) ‒ параметры.

Хук ab__pfe_get_items_post запускается после получения списка товаров выгрузки со следующими параметрами:

• $datafeed (array) ‒ данные выгрузки;
• $params (array) ‒ параметры;
• $products (array) ‒ список товаров.

Функция получающая список выгрузок имеет ряд хуков.

Хук ab__pfe_get_datafeeds_pre запускается в самом начале выполнения функции со следующими параметрами:

• $params (array) ‒ параметры;
• $items_per_page (int) ‒ количество записей, которые будут полученны во время выполнения запроса.

Хук ab__pfe_get_datafeeds запускается перед построением запроса получения списка выгрузок со следующими параметрами:

• $params (array) ‒ параметры;
• $fields (array) ‒ список полей для выборки;
• $sortings (array) ‒ список возможных сортировок;
• $join (string) ‒ список таблиц для join-a в запросе;
• $condition (string) ‒ список условий для выборки;
• $limit (string) ‒ лимит получаемых записей.

Хук ab__pfe_get_datafeeds_post запускается после получения списка выгрузок со следующими параметрами:

• $params (array) ‒ параметры;
• $data (array) ‒ список выгрузок.

Функция получающая список пользовательских шаблонов имеет ряд хуков.

Хук ab__pfe_get_templates_pre запускается в самом начале выполнения функции со следующими параметрами:

• $params (array) ‒ параметры;
• $items_per_page (int) ‒ количество записей, которые будут полученны во время выполнения запроса.

Хук ab__pfe_get_templates запускается перед построением запроса получения списка пользовательских шаблонов со следующими параметрами:

• $params (array) ‒ параметры;
• $fields (array) ‒ список полей для выборки;
• $sortings (array) ‒ список возможных сортировок;
• $join (string) ‒ список таблиц для join-a в запросе;
• $condition (string) ‒ список условий для выборки;
• $limit (string) ‒ лимит получаемых записей.

Хук ab__pfe_get_templates_post запускается после получения списка пользовательских шаблонов со следующими параметрами:

• $params (array) ‒ параметры;
• $data (array) ‒ список шаблонов.

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

Хук ab__pfe_get_items запускается перед построением запроса создания временной таблицы со следующими параметрами:

• $datafeed (array) ‒ данные выгрузки;
• $params (array) ‒ параметры;
• $fields (array) ‒ список полей для выборки;
• $join (string) ‒ список таблиц для join-a в запросе;
• $condition (string) ‒ список условий для выборки;
• $group (string) ‒ строка группировки;
• $limit (string) ‒ лимит получаемых записей.

Хук ab__pfe_get_items_after_table_fill запускается после создания и наполнения данными временной таблицы со следующими параметрами:

• $datafeed (array) ‒ данные выгрузки;
• $params (array) ‒ параметры;
• $table_name (string) ‒ имя созданой таблицы.

Функция обновления/создания выгрузки имеет ряд хуков.

Хук ab__pfe_update_datafeed_pre запускается в самом начале процеса обновления/создания выгрузки со следующими параметрами:

• $data (array) ‒ данные выгрузки;
• $id (int) ‒ идентификатор выгрузки (0 при создании).

Хук ab__pfe_update_datafeed_post запускается после процеса обновления/создания выгрузки со следующими параметрами:

• $data (array) ‒ данные выгрузки;
• $id (int) ‒ идентификатор выгрузки.

Функция обновления/создания пользовательского шаблона имеет ряд хуков.

Хук ab__pfe_update_template_pre запускается в самом начале процеса обновления/создания пользовательского шаблона со следующими параметрами:

• $data (array) ‒ данные шаблона;
• $id (int) ‒ идентификатор шаблона (0 при создании).

Хук ab__pfe_update_template_post запускается после процеса обновления/создания пользовательского шаблона со следующими параметрами:

• $data (array) ‒ данные шаблона;
• $id (int) ‒ идентификатор шаблона.