Understand worksets

A workset is a named group of changes that are published together. When you want to publish changes, you publish the workset that contains them. You can publish the changes in all worksets at once, or you can pick specific worksets to publish.

This section applies to Open Storefront Framework (OSF) and Storefront Classic.

Worksets help you organize changes so you can more easily track and publish related items together. For example, suppose you are working on a holiday campaign that you want to go live at the end of November. You can create a workset called #holidayPromotions. Then, users who work on Commerce items that support the campaign, like promotions, and SKUs, collections, and layouts, can save their changes to this workset. Then, the workset can be published at a pre-scheduled time.

Commerce includes one workset, named #default. If you do not create any other worksets, Commerce automatically saves all publishable changes to #default.

When you save a change to a publishable item, Commerce automatically saves it to the active workset. If your Commerce environment includes multiple worksets, you can save your changes to a different workset or move saved changes from one workset to another, but all changes that require publishing are saved in at least one workset. There is no way to publish items outside of a workset.

Some Commerce items must be published together to maintain the integrity of their relationships. For example, if you update the description of a shipping method, Commerce must also publish the method’s associated shipping regions, even if you did not make any changes to them. When you look at the workset that includes the shipping method, you will notice that it also contains the associated shipping regions. If you move the shipping method to a different workset, Commerce automatically moves the associated shipping regions.

Understand who can create and publish worksets

Commerce administrators control each internal user's access to specific administration interface pages and tasks with roles and privileges. Only users who have the Publishing privilege assigned can create and publish worksets.

Any user who can edit Commerce items, such as catalogs, can view their changes in the workset that contains them, and can move their changes to a different existing workset.

For more information about privileges, see Understand role-based access control.