This tutorial will help you configure the Magento Tweakwise Export Extension. This module generates an XML feed to be read into the Tweakwise app. Set up the settings at default configuration level.
Step 1: Determine which attributes should be brought to Tweakwise
Before you start activating your feed for Tweakwise, 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
Step 2: Link Tweakwise instancekey
Go to the General module of the Magento Tweakwise Master Extension and enter the instance key provided by Tweakwise at Authentication key. Without setting up this key, it is not possible to run a successful export.
Step 3: Configure Tweakwise feed
In the module Export you activate feed generation and using this module you can deliver the feed URL to Tweakwise.
|
Instelling |
Invoer |
Beschrijving |
Aanbevolen |
|
Enabled |
Yes/No |
Activates the feed generation |
Yes |
|
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 |
|
Key |
Text field |
Determine your own key. This is the key that indicates where the feed can be accessed. The default Export url will be www.example.com/tweakwise/feed/export/key/XXXX. At this last spot you will then find the key entered. |
- |
|
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: |
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 |
Numeric |
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. So when clicking Import Feed from Tweakwise, the feed is first re-generated from Magento before being read into Tweakwise.
|
No |
|
Tweakwise Import API Url |
Tekst field |
Here the URL of the import task in Tweakwise can be entered. If this is filled in, after successful feed generation, the import task in Tweakwise is automatically triggered and started. Receive this URL from your Onboarding Specialist/Customer Success Manager. |
- |
|
Export out of stock combined product children |
Yes/No |
When this is set to no it looks at the stock of the child products, if a particular size is out of stock then this size will no longer be added to the feed. When set to yes, this size will still be added to the feed |
No |
|
Exclude child attributes |
Select |
Here you can select which attributes of the child products should not be added and only the attributes of configurable products. |
Image, link, description |
|
Price field |
Dropdown |
Determine how the price field is determined. This involves the price field on the general tab in Tweakwise. |
|
|
Batch size categories |
Numeric |
Set the 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 |
Numeric |
Set the 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 |
Numeric |
Set the 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 field |
Select the time when the feed will be exported by a cron job here. You can specify here whether the feed should be generated daily or several times a day. It is important that you enter here the same frequency as agreed upon in the contract with Tweakwise.
|
|
|
State |
Text |
Displays the status of the last export. |
|
|
Schedule exports |
Button |
The export will join the next cron job. |
|
Step 4: Configuring external property [Optional]
The use of these external properties is not included by default at the Standard and Medium level.
You may want to update stock or price more frequently than the rest of the item data. This can be done using an external property: What is an external property? – Tweakwise .
Using the Export for Stock and Price you can accomplish this.
Export Stock
The default URL for this external property feed will be: www.example.com/tweakwise/feed/export/key/XXXX/type/stock
The same key as the full feed is used.
|
Setting |
Input |
Description |
Recommended |
|
Schedule stock export |
Text field |
Select the time when the feed will be exported by cron job here. |
|
|
State |
Text |
Displays the status of the last export. |
- |
|
Schedule stock export |
Button |
The export goes along with the next cron job. |
|
|
Tweakwise Import API Url for stock feed (external property) |
Tekst field |
Url for stock feed (external property) Text field Here the URL of the import job in Tweakwise can be entered. If this is filled in, after a successful feed generation the import task in Tweakwise is automatically triggered and started. Receive this URL from your Onboarding Specialist/Customer Success Manager. |
Yes |
Export price
The default URL for this external property feed will be: www.example.com/tweakwise/feed/export/key/XXXX/type/price
Where the key of the full feed is used.
|
Setting |
Input |
Description |
Recommended |
|
Schedule price export |
Text field |
Select the time when the feed will be exported by cron job here. |
|
|
State |
Text |
Displays the status of the last export. |
- |
|
Schedule price export |
Button |
The export goes along with the next cron job. |
|
|
Tweakwise Import API Url for price feed (external property) |
Text field |
Url for price feed (external property) Text field Here the URL of the import job in Tweakwise can be entered. If this is filled in, after a successful feed generation the import task in Tweakwise is automatically triggered and started. Receive this URL from your Onboarding Specialist/Customer Success Manager. |
Yes |