Steps to migrate to Tweakwise JS + Plugin Studio
Consider this as a new integration. Remove everything you have.
Here’s a step-by-step plan to migrate safely:
- Audit and remove old Tweakwise JS code
- Enable Plugin Studio
- Implement Tweakwise JS in the recommended order
1. Audit & remove existing Tweakwise JS
- Inventory current integration.
- Identify all Tweakwise-related scripts, initialization code.
- Note any custom local configuration overrides (for example, passing custom filterTemplateId, sortingTemplateId, or other options). These may need to be re-applied or ported later.
- Event Tag events (search, clicks, pageviews, add-to-cart, other events) can be left as-is.
- Remove / comment out old JS.
- Remove classic JS import scripts (for Search, Suggestions, Commerce, Recommendations, etc.).
- Clean up any custom initialization code, but document what you’re removing. Keep a backup or version control branch.
- Deploy a “clean slate” in a staging environment.
- Before proceeding, make sure your staging or test environment no longer loads the old Tweakwise JS components.
- This ensures that when you start fresh with Plugin Studio, there are no conflicts or duplicated behavior.
2. Enable Plugin Studio
- Contact Tweakwise Support / Onboarding Specialist, if Plugin Studio is not already activated for your account. Tweakwise
- Ensure you have a Tweakwise test (sandbox) environment for Plugin Studio configuration changes. You’ll want to preview tile designs and module behavior before going live.
3. Implement Tweakwise JS
- Follow Tweakwise JS - Getting started and implement Tweakwise JS in the recommended order.
4. Test, Deploy & Monitor
- Perform a complete manual validation flow in your staging environment:
- Search bar + Suggestions (typing, navigating, selecting results)
- Search results page (filters, sorting, paging, merchandising behavior)
- Lister page (filters, sorting, paging, merchandising behavior)
- Product tiles (design, data accuracy, responsiveness)
- Recommendations (if used)
- Analytics and events (make sure Event Tag events fire correctly)
- Cross-browser/device checks
- Runtime errors in the console
- Contact Tweakwise Support / Onboarding Specialist to copy the Plugin Studio configuration from the test instance to production.
- Push your staging environment to production, make sure it uses the production Tweakwise instance.
- Perform the same manual validation flow on production.
Tips & Best practices
- Collaborate with Tweakwise Onboarding / Support. Our team can help with optimal configuration and ensure you’re set up correctly.
- Iterate gradually. Don’t try to do everything at once. First implement search + suggestions, then commerce, then recommendations as recommended.
