The Magento Tweakwise Export extension generates an XML feed that can be imported into Tweakwise.
Set up the settings at default configuration level:
- Go to Stores > Configuration > Catalog > Tweakwise.
- Determine attributes: determine which attributes should be synced to Tweakwise
- Enter the Tweakwise instancekey.
- Finetune the export settings
- Optional: stock & price exports
Determine attributes
Before configuring it's important to make sure the right attributes will be exported to Tweakwise. Think about color, size, SKU and other relevant attributes you want to search, sort by or filter on.
Go to Products > Attributes > Storefront properties.
If one of the settings below is set to yes, the attribute will be added to the feed export:
- Use in search
- Layered navigation: everything but no is included
- Use in search layered
- Use in product listing
- Use for sorting in product listing
- Use in advanced search
Enter Tweakwise instancekey
In the General section, enter the instance key provided by Tweakwise. The field is labelled "Authentication key".
The instancekey is required to run a successful export.
Finetune the export settings
In the Export section you activate feed generation and using this module you can deliver the feed URL to Tweakwise.
| Setting | Value | Description | Recommendation |
|---|---|---|---|
| Store level export | Yes/No | Indicate whether you want to generate the export per storeview (yes) or one export with all storeviews (no). When you generate a separate feed per storeview, these will be separate instances in Tweakwise. This may involve additional costs. Are you in doubt? Then contact your Onboarding Specialist/Customer Success Manager. | No |
| Enabled | Yes/No | Activates the feed generation | Yes |
| Key | Text | This is the key that indicates where the feed can be accessed. You can determine your own key. The default Export url will be /tweakwise/feed/export/key/XXXX where XXXX is the entered key. | Instancekey |
| Allow cache flush | Yes/No | This setting allows you to empty the cache when a publishing task has been running in Tweakwise. This is recommended so that the latest results are seen immediately in your shop. This action must be called from within Tweakwise, this can be done by providing the appropriate URL to your Onboarding Specialist/Customer Success Manager: /tweakwise/cache/flush/key/XXXX where XXXX is the entered key. | Yes |
| Validate | Yes/No | This functionality checks for categories and products after generating the feed, in which case it will not be exported. In the Tweakwise app, such validation is also possible. Note: If you set this functionality to Yes, the generation of the feed will take a little longer. | Yes |
| Archive | Number | Number of feeds to keep in archive | Min. 1 |
| Export in Real Time | Yes/No | Feed is generated in real time as soon as the feed is requested. Note: this is a deprecated settings. | No |
| Tweakwise Import API Url | Text | The URL to the API trigger for the import task. If entered, after a successful feed generation the import task in Tweakwise is automatically started. The URL can be found in the Tweakwise app in the details of the import task. | - |
| Export out of stock combined product children | Yes/No | Yes: if a variant/child is out of stock, the variant will be added to the feed. No: if a variant/child is out of stock, the variant will not be added to the feed. | No |
| Exclude child attributes | Multi | Select which attributes of the child products or configurable products should not be added. | Image, link, description |
| Price field | Select which field is used as "price" in Tweakwise, selection will select each price field in order and return the first nonzero value. Prices are exported from price index table, note that catalogrule prices are available in field "min_price" so it could be that this value is lowed then for example "final_price". If your configurable / bundle products do not have a price attribute filled this will be zero. | ||
| Batch size categories | Number | Batch size for categories during export. If memory is less important than speed, lower the batch size. Is speed more important? Then increase the batch size. | |
| Batch size products | Number | Batch size for products during export. If memory is less important than speed, lower the batch size. Is speed more important? Then increase the batch size. | |
| Batch size products children | Number | Batch size for child products during export. If memory is less important than speed, lower the batch size. Is speed more important? Then increase the batch size. | |
| Schedule full export | Text | Cron notation to generate the feed. Leave empty to disable export by cron. Important: enter the same frequency as agreed upon in the contract with Tweakwise. | |
| State | Text | Displays the status of the last export. | |
| Schedule exports | Action | The export will join the next cron job. |
Optional: stock & price exports
You may want to update stock or price more frequently than the rest of the item data. This can be done using an external attribute in Tweakwise combined with the Stock and Price exports in the extension.
The default URL for this external property feed will be:
- Price:
/tweakwise/feed/export/key/XXXX/type/price - Stock:
/tweakwise/feed/export/key/XXXX/type/stock
Where XXXX is the key entered in the export section.
| Setting | Value | Description | Recommendation |
|---|---|---|---|
| Schedule stock export | Text | Cron notation to generate the feed. Leave empty to disable export by cron. Important: enter the same frequency as agreed upon in the contract with Tweakwise | |
| State | Text | Displays the status of the last export. | |
| Schedule stock export | Action | The export will join the next cron job. | |
| Tweakwise Import API Url for stock feed (external property) | Text | The URL to the API trigger for the import task. If entered, after a successful feed generation the import task in Tweakwise is automatically started. The URL can be found in the Tweakwise app in the details of the import task for this external attribute. | Yes |