Configure the Magento Tweakwise Frontend Extension

This guide will help you configure the Magento Tweakwise Master Extension. All options depend on the level you purchase from Tweakwise. In addition, you can choose whether you do the settings per storeview or use the default configuration.

Set up the settings at default configuration level:

  • Go to Stores > Configuration > Catalog > Tweakwise.

Step 1: Link Tweakwise instancekey

In the General section, enter the instance key provided by Tweakwise. The field is labelled "Authentication key".

Step 2: Activate Tweakwise for search

In the Search section, activate Tweakwise on your search results page. If you have several languages, set them up separately for each language.

SettingInputDescriptionRecommended
EnabledYes/NoActivate Tweakwise on the search results page.Yes
Searchbanners enabledYes/NoActivate the ability to show decorated Searchbanners in Tweakwise in the shop.Yes
Tweakwise search template to use in search resultsDropdownSelect the filter template that you created in Tweakwise to be used on the search results page, if it differs from the default filter template.* Default template
Search languageDropdownSelect which language should be used for the search function so that the conjugations of the correct language can be included. You can set this for each storeview. Are you missing a language? If so, contact your Onboarding Specialist.Correct language

Step 3: Activate Tweakwise for the search suggestions

In the Autocomplete section, activate Tweakwise for the search suggestions in your shop.

SettingInputDescriptionRecommended
EnabledYes/NoActivate Tweakwise suggestionsYes
Use Suggestions AutocompleteYes/NoUses the latest autocomplete module in Tweakwise.Yes
Show parent categoryDropdownShow parent category to category suggestionsYes
Stay in categoryDropdownOnly show suggestions from the currently viewed category.No

Step 4: Activate Tweakwise on the category pages

💡

Tweakwise Commerce Pages

In the layered navigation section, activate Tweakwise on the category list page. The following settings are recommended:

SettingInputDescriptionRecommended
EnabledYes/NoEnables Tweakwise on category list pages.Yes
Hide facets with only one optionYes/NoDo not display filters once there is only one filter value.Tweakwise has settings to set this per filter, when you set this setting to ‘yes’, Tweakwise settings are ignored.No
Use default Magento filter rendererYes/NoAdopt front-end settings from Magento itself instead of display settings from Tweakwise. This therefore ignores the settings from the Tweakwise app and uses Magento's default settings. When set to ‘yes’, SEO and Ajax do not work.No
Ajax filteringYes/NoFilter actions are performed using Ajax instead of navigation. This means that only the products are updated and not the entire page is refreshed.Yes
Filter formYes/NoProvide a button near the filters that allows you to specify that filter actions are only executed after clicking the button instead of real-time.No
Filter url query argumentsDropdownDetermine whether URL parameters are also added to the requests and thus sent along to Tweakwise. Three options:

- Don't filter: all parameters are sent along to Tweakwise
- Specify: determine which parameters are sent along. When this is selected, an extra option appears in which the parameters you want to exclude can be selected.
- Regex: Do this on the basis of a regex.
Don’t filter
URL StrategyDropdownDefine how you want the URLs to be constructed when using filters. Two options:

- Query params (?colour=Red&size=m): this adds the whole parameter.
- SEO path slugs (color/red/size/m): this adds the selected filter and the selected filter value neatly slash-separated to the url.
SEO path slugs

Step 5: Setting up SEO (optional)

In the SEO section, you decide which filters are and are not indexable. These settings can be configured for the entire shop, but it is also possible to configure them at category level. You will find Tweakwise settings for this under Category > Catalog. The category-level settings overwrite the settings you make here.

SettingInputDescriptionRecommended
EnabledYes/NoSEO enable. Indexing filter values. If you set this module to Yes, all filters are no longer indexable.Yes
Filter WhitelistText fieldSelect the filters that should always be indexed.-
Filter Values WhitelistText fieldSelect the filter values that should always be indexed. Note: The filter must also be between the ‘Filter whitelist’. Entering certain values here will exclude other values from this filter.-
Max allowed selected filterNumericMaximum number of filters allowed to be indexed.2

Step 6: Activate Tweakwise recommendations

💡

Tweakwise Recommendations

Before you can activate this section, it is important that certain things are set up in the Tweakwise app. Contact your Onboarding Specialist to get the additional information through. These settings can be set up for the entire shop, but it is also possible to set them up at category level. Under Category > Catalog you will find the Tweakwise settings for this. The category-level settings overwrite the settings you make here.

SettingInputDescriptionRecommended
Related products enabledYes/NoActivate the related products from within Tweakwise App. From Tweakwise, you can use up-sell and/or cross-sell templates for this. This setting applies to showing related products on every PDP from Tweakwise. This replaces the related products from Magento with those from Tweakwise.Yes
Default related products templateDropdownSelect the desired recommendation template from Tweakwise here. We recommend using the group code here. This ensures that you can make adjustments at category level in Tweakwise.-Group code-
Default related products group codeText fieldEnter the name of the group code in Tweakwise here.-
Upsell enabledYes/NoActivate upsell from the Tweakwise app. This will replace the upsell from Magento with that from Tweakwise.Yes
Default upsell templateDropdownChoose the desired recommendation template from Tweakwise here. Recommend using the group code here. This ensures that you can make adjustments at category level in Tweakwise.-Group code-
Default upsell group codeText fieldEnter the name of the group code in Tweakwise here.-
Featured products enableYes/NoActivate featured products from within the Tweakwise app. In Tweakwise, this is called ‘Featured products’. These products can be deployed anywhere using a widget.Yes
Default featured product templateDropdownChoose the featured recommendation rule created in Tweakwise.-
Only show products from current category for featured productsYes/NoSet this setting to Yes if you only want to show featured products from the current category.Yes
Crosssell enabledYes/NoShows cross-sell product in cart. This overrides the default cross-sell products in the cart.Yes
Default crosssell typeDropdownChoose whether you want to use a cross-sell template or a featured product template from Tweakwise.
Default crosssell templateDropdownChoose the cross-sell rule you want to use for the entire shop. Or choose -Group code- to use group codes (only available when using crosssell template).
Default crosssell groupcodeText fieldEnter the name of the group code in Tweakwise here.-
Limit max number of products for group codesNumericSpecify the maximum number of products to be shown when using a grouping code.-

Step 7: Step 7: Activate Personal Merchandising

💡

Tweakwise Commerce Pages + Merchandising level Expert

SettingInputDescriptionRecommended
EnabledYes/NoActivate personal merchandisingYes
Cookie nameText fieldName of the cookie in which the Tweakwise profile information can be found as entered in the measurement script.-