Guide

Upgrading to v2

Version 2 introduces a new admin interface, a 3D viewer, global layers and global configurators. It also changes the way configuration data is stored.

This page explains what changes, what you need to do, and how to go back if something goes wrong.

Before you upgrade

  • Back up your database. The storage change described below rewrites the way your configurators are saved. It is reversible, but a backup is still the safest starting point.
  • Update the add-ons too. Several add-ons have matching v2 releases. Running a v1 add-on against v2 of the main plugin is not supported.
  • Test on a staging site first if you have a large catalogue of configurable products.

What changes in the interface

The configurator editor has been reorganised around a sidebar:

  • The layers list has moved into the sidebar, alongside the section navigation.
  • Configurator options now live in their own tab instead of being mixed in with the layers.
  • The save button has moved to the bottom of the sidebar and saves everything at once.
  • The editor is now usable on mobile and tablet, with swipe navigation between panels.

Your existing configurators are not affected by this: the same layers, choices and settings are all still there, in a different place on screen.

The storage change

In v1, all of a product's layers and all of its content were each stored in a single, large meta value. As configurators grew, those values became very large, which made saving slow and could hit server limits.

In v2, that data is split into smaller pieces — one per layer, and one per content block — with an index tying them together. This is referred to as chunked storage.

How the migration runs

The migration is not a one-off site-wide process. Each product is migrated individually, the next time you save it.

When you open a configurator that has not been migrated yet, you will see this notice on the Home tab:

Data migration required Configuration storage will be migrated to the new format the next time you save.

Press save as you normally would. An overlay reports the progress — Migrating layers…, Migrating content…, Finalizing storage migration… — and finishes with Migration complete.

There is nothing else to do. The product now uses the new format.

The Data migration required notice shown on the configurator Home tab
The notice appears on the Home tab of any configurator that has not been migrated yet.

Screenshot needed: the migration progress overlay.

The legacy copy

After a product has been migrated, the old data is deliberately left in place. The configurator reads from the new chunked storage, but the previous copy is still in the database as a safety net.

You will then see a second notice on the Home tab:

Legacy storage data is still present alongside the new format. You can delete it after you have verified everything, or restore it from the current configuration.

It comes with two buttons:

  • Delete legacy data
    Removes the old copy and keeps the new chunked storage. Use this once you have checked that the product still configures correctly in the front end. This is the normal end state.
  • Restore legacy data
    Removes the new chunked storage and goes back to the old copy. Use this only if a migration went wrong while the legacy copy is still intact.

Neither button changes what your customers see while the configurator is working correctly — the front end always reads whichever format is currently active.

Screenshot needed: the legacy-data notice with both buttons.

If a migration goes wrong

As long as you have not pressed Delete legacy data, the migration is fully reversible:

  • Open the product's configurator,
  • Go to the Home tab,
  • Press Restore legacy data and confirm.

The new chunked storage for that product is removed, and the editor loads your original data again. You can then investigate before trying the save a second time.

Once you have deleted the legacy data, restoring is no longer possible for that product and you would need to fall back to your database backup.

  1. Update the main plugin and all add-ons.
  2. Open one configurable product and save it, to run a single migration.
  3. Check that product in the front end.
  4. Press Delete legacy data on that product.
  5. Repeat for the rest of your products, at whatever pace suits you.

Products that have not been migrated yet keep working normally. There is no deadline, and no requirement to migrate everything at once.

New features to explore

Once you are on v2, these become available:

  • 3D configurator — use a 3D model instead of, or alongside, layered images.
  • Global layers — build a layer once and reuse it across many products.
  • Global configurators — share one entire configurator between multiple products.