link"Advanced Product Export (xml and csv formats)" documentation

To create a new upload template follow the steps:

1) Go to the page Administration panel → Add-ons → Downloaded add-ons and at the add-on name AB: Advanced Product Export (xml and csv formats) in the gearwheel menu select the section Templates list. On the opened page click [+] Add a new template button;
2) On the page Add a new template enter template name, select the template by default you want from the dropdown list and press the Load the template button;
3) Edit the template code if necessary and save the template.

For new feed creation follow the steps:

1) Go to the page Administration panel → Add-ons → Downloaded add-ons and at the add-on name AB: Advanced Product Export (xml and csv formats) in the gearwheel menu select the section Feeds list. On the open page press [+] Add a new feed button;

2) On the page Add a new feed fill fields according to hints. In the field Template choose previously created template;

3) On the Data selection conditions tab specify the selection criteria required. There is ability to export hidden entities (products, categories, characteristics). Note that the stoplist is limited to 3000 characters because more characters can cause database errors.

The setting Categories type is used to export products in the feed based on their categories (not to be confused with subcategories). Each product always has one main category and can belong to several additional categories. For example, a product can be listed in multiple categories: "Sound System" would be the main category, while "Multimedia" and "Acoustic Systems" would be additional categories. This setting allows the product to be included in all three categories or filtered by a specific category type.

4) On the Include data objects tab you can do the following actions:

• choose categories, which products you want to add to the feed. Set the Including subcategories checkbox, if you want to upload products of all nested categories.
• specify the selection of an additional product by features. Products selection according to several features conditions and/or by categories works together. For example, at choosing category Tablets, features Brand Samsung and Display 7.0”, in the feed will be selected only those products, which satisfy all conditions — tablets Samsung with display 7.0”.
• add separate products to feed.
• add product selection by vendor (for Multi-Vendor edition only).

5) On the Exclude data objects tab similarly, select the products to exclude from the feed;

6) On the Additional parameters tab you can specify parameters arbitrary values and use them in a template by the variable name. In this example, by using in the code {$abpfe_p1} we will get utf-8.

You can generate the feed file using one of the steps:

1) On the page Administration panel → Add-ons → Downloaded add-ons and at the add-on name AB: Advanced Product Export (xml and csv formats) in the gearwheel menu select the section Feeds list. On the open page in the gearwheel menu select Generate the feed;

2) On the add-on page Feeds listchoose a feed and in the gearwheel menu select the section Generate the feed. You can also see a link to the feed file. If you specify login and password when creating the feed, you will have to use your login and password to view the file;

3) Use Cron command to update out-of-date information;

4) On the add-on page Feeds list choose a feed and set the checkbox Generate before download. Thus, you will automatically generate feed file at each downloading. It helps to keep data in this file alway actualized. But pay attention that time for downloading will include time for feed generation.

To generate files automatically, add feeds you want to generate automatically to the automatic generation list by set the Generate feed by hook checkbox.

Insert the hook fn_set_hook('ab__pfe_autogenerate'); in that PHP code, after which you want to generate files. Example of automatic files generation after the 1C exchange (for this you need to insert hook in exchange ending code app/addons/rus_exim_1c/Tygh/Commerceml/RusEximCommerceml.php):

To restrict access to the feed file, set the login and password to protect the feed file.

For adding to feed specific feature it is necessary to make sure, that parameter get_features in the template is set true:

Further, use variable {$product.features.FEATURE_ID.value} in the template, inserting instead of FEATURE_ID needed feature identifier.

In the extra_fields parameter specify a list of additional fields from the database in the array format ['t1.field1', 't2.field2', 't2.field3'], where:
t1, t2 — tables reduced prefixes (p — products, pd — product_descriptions, pp — product_prices);
field1, field2, field3 — fields in database.

Parameter extra_join — is a string with JOIN-s (tables connection), and extra_condition — string with additional parameters. When these values are added, the corresponding variables $product.field1, $product.field2, $product.field3 will be available in the products block.

A sample of adding a specific field, such as promo text, to the feed is as follows:

For products variations feed set the Export variations checkbox on the Data selection conditions tab:

Without the checkbox set — variations as individual products will be upload, with the checkbox — add variations as one product.

For discount products by promotions — set the Apply promotions checkbox on the General settings tab:

For uploading images with water mark it is necessary to enable native Watermarks add-on on the Administration panel → Add-ons → Downloaded add-ons page, and in the export add-on settings — set the Use watermark for images checkbox in the General settings tab:

For CS-Cart 4.8.2 or lower, for using watermarks for https it is necessary in the file /app/addons/watermarks/func.php add string $image_data['https_image_path'] = Storage::instance('images')→getUrl($prefix . $path . '/' . $image_name, 'https');. As a result must be next:

To replace features names go to the editing category page, open the AB: Feature names in datafeeds tab and press the Add button.

In the appears window, select the property you want to rename and feed in which it will be renamed, enter the desired name.

Addon adds View settings and data and Manage settings and data options to users privileges:

• View settings and data — allows to view data by feeds and templates;
• Manage settings and data — allows to edit this data, create and delete feeds and templates.

If at the addon uninstallation you get message Warning. The add-on cannot be uninstalled because the following add-ons depend on it: …, you must first delete the dependent addon and then delete this. When installing, follow the reverse order, first the main addon, then the dependent.

As feed files aren't in the root, nginx must proxy such requests to the site (bypassing the standard return of static files). For this you can use direct link to the file:
location = /ab__pfe_1_test.xml

But, to not create a separate rule for each upload, it is better to use next mask:
location ~ ^/ab__pfe_[0-9]+_.*$

If at request site file you get 404 server error (don't confuse 404 site page), means the proxying is configured incorrectly.

If at feed generation start you see message like

The generation of datafeed started 01/01/2020 12:00. Loaded 200 from 300 products

it means, feed generation is not completed. If the feed products number does not change when the window is updating, the generation is likely stuck. You can reset it by pressing Reset feed generation gear.

ab__pfe_datafeeds:tabs_content ‒ allows to add its own tabs.

ab__pfe:addons ‒ allows to add information about its own variables on the right bottom sidebar.

Function to delete feed consists of the hook ab__pfe_delete_datafeeds, which gets started at the beginning of the function with the following parameters:

• $datafeed_ids (array) ‒ list of feeds identifiers.

Function to generate feed consists of the hook ab__pfe_extra_vars, which allows to add its own variables to the feed template. Hook parameters are:

• $vars (array) ‒ array of variables.

Function to update/create a customer's template consists of several hook groups.

Hook ab__pfe_update_template_pre gets started at the beginning of the process to update/create the customer's template with the following parameters:

• $data (array) ‒ data of the feed;
• $id (int) ‒ feed identifier (0 during creation process).

Hook ab__pfe_update_template_post gets started after the process to update/create the customer's template with the following parameters:

• $data (array) ‒ data of the feed;
• $id (int) ‒ feed identifier.

Function to get a list of features consists of several hook groups.

Hook ab__pfe_get_features gets started at the beginning of the function with the following parameters:

• $products (array) ‒ product list;
• $params (array) ‒ parameters;
• $lang_code (string) ‒ language code;
• $exclude_ids (array) ‒ feature list, that will be excluded from the fetch.

Hook ab__pfe_get_product_features gets started after the process when the feature list of the product has been gotten with the following parameters:

• $product (array) ‒ product data;
• $features (array) ‒ feature list;
• $params (array) ‒ parameters;
• $lang_code (string) ‒ language code;
• $exclude_ids (array) ‒ feature list, that were excluded from the fetch.

Hook ab__pfe_get_features_post gets started after getting a feature list for all products with the following parameters:

• $products (array) ‒ product list;
• $params (array) ‒ parameters;
• $lang_code (string) ‒ language code;
• $exclude_ids (array) ‒ feature list, that were excluded from the fetch.

Function to delete customers' templates consists of the several hook groups.

Hook ab__pfe_delete_templates_pre gets started from the beginning of the function with the following parameters:

• $template_ids (array) ‒ list of templates identifiers.

Hook ab__pfe_delete_templates_post gets started after successful or failed removal process with the following parameters:

• $template_ids (array) ‒ list of templates identifiers;
• $deleted (bool) ‒ attribute of successful or failed removal process.

Function to get a list of categories consists of the hook ab__pfe_get_categories, which gets started before request elaboration for getting a category list with the following parameters:

• $datafeed (array) ‒ data of the feed;
• $fields (array) ‒ field list for the fetch;
• $join (string) ‒ table list for join in request;
• $conditions (string) ‒ condition list for the fetch.

Function to get a list of product feeds (from the time-line table) consists of several hook groups.

Hook ab__pfe_get_items_pre gets started from the beginning of the function with the following parameters:

• $datafeed (array) ‒ data of the feed;
• $params (array) ‒ parameters.

Hook ab__pfe_get_items_post gets started after getting a list of product feed with the following parameters:

• $datafeed (array) ‒ data of the feed;
• $params (array) ‒ parameters;
• $products (array) ‒ product list.

Function to get a list of feeds consists of several hook groups.

Hook ab__pfe_get_datafeeds_pre gets started at the beginning of the function with the following parameters:

• $params (array) ‒ parameters;
• $items_per_page (int) ‒ number of records, which will be gotten during the query execution.

Hook ab__pfe_get_datafeeds gets started before construction of a request to get a list of feeds with the following parameters:

• $params (array) ‒ parameters;
• $fields (array) ‒ field list for the fetch;
• $sortings (array) ‒ list of possible sorting;
• $join (string) ‒ table list for join in the request;
• $condition (string) ‒ condition list for the fetch;
• $limit (string) ‒ limit of the received records.

Hook ab__pfe_get_datafeeds_post gets started after the process when a list of feeds is received with the following parameters:

• $params (array) ‒ parameters;
• $data (array) ‒ list of feeds.

Function to get a list of customers' templates consists of several hook groups.

Hook ab__pfe_get_templates_pre gets started from the beginning of the function with the following parameters:

• $params (array) ‒ parameters;
• $items_per_page (int) ‒ number of records, which will be gotten during the query execution.

Hook ab__pfe_get_templates gets started before construction of a request to get a list of customers' feeds with the following parameters:

• $params (array) ‒ parameters;
• $fields (array) ‒ field list for the fetch;
• $sortings (array) ‒ list of possible sorting;
• $join (string) ‒ table list for join in the request;
• $condition (string) ‒ condition list for the fetch;
• $limit (string) ‒ limit of the received records.

Hook ab__pfe_get_templates_post gets started after the process when a list of customers' templates is received with the following parameters:

• $params (array) ‒ parameters;
• $data (array) ‒ template list.

Function to construct a time-line table for the feed consists of several hook groups.

Hook ab__pfe_get_items gets started after construction of a request to create the time-line table with the following parameters:

• $datafeed (array) ‒ data of the feed;
• $params (array) ‒ parameters;
• $fields (array) ‒ field list for the fetch;
• $join (string) ‒ table list for join in the request;
• $condition (string) ‒ condition list for the fetch;
• $group (string) ‒ line of the group;
• $limit (string) ‒ limit of the received records.

Hook ab__pfe_get_items_after_table_fill gets started after creating and filling of data into the time-line table with the following parameters:

• $datafeed (array) ‒ data of the feed;
• $params (array) ‒ parameters;
• $table_name (string) ‒ name of the created table.

Function to update/create a feed consists of several hook groups.

Hook ab__pfe_update_datafeed_pre gets started at the beginning of the process to update/create the feed with the following parameters:

• $data (array) ‒ data of the feed;
• $id (int) ‒ feed identifier (0 during creation process).

Hook ab__pfe_update_datafeed_post gets started after the process to update/create the feed with the following parameters:

• $data (array) ‒ data of the feed;
• $id (int) ‒ feed identifier.