Create and edit worksets

One default workset (named #default) comes with Commerce. Until you create your own worksets, all publishable changes are automatically saved in this default workset.

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

Remember that before you can create worksets, your Commerce user profile must have the Publishing privilege assigned. (See Understand who can create and publish worksets for more information.) All administration interface users who can access the Changes page can see all worksets, no matter who created them.

To create a workset:

1. On the Changes page, click Publishing Schedule.
2. Click Add to Schedule and select New Workset.
3. Enter a name for the workset.

   The name can be up to 25 characters long and can contain only letters, numbers, hyphens (-), and underscores (_).

   Although not required, it is a good idea to assign unique workset names to make them easier to identify.

   Once a workset is created, you cannot change its name in the administration interface, though you can change it with the Admin REST API.

4. Click Create.

   The new workset appears in the publishing schedule, marked as Not Scheduled. Commerce adds a # symbol to the beginning of the name of every workset.

Specify the active workset

Your changes are automatically saved in the active workset. Creating a new workset does not automatically make it the active workset. To make your new workset the active workset, select it from the Active Worksets dropdown list at the top of the Changes page.

Move items to a different workset

You can move items from one workset to another, though you cannot simply remove them from their current workset without specifying a new home for them. If an item has dependencies, they are automatically moved to the other workset. To move items to a different workset:

1. On the Changes page, select a workset from the Active Workset dropdown list.
2. Select individual items to move or click the Select Page icon to select all the items in this workset.

   See View changes in a workset to learn how to sort and filter a workset to more easily find items to select.

3. Click the Move button.
4. Select a workset to move the changes to and then click Move.

Delete a workset

You can delete only empty worksets. If you want to delete a workset that contains items, Commerce lets you select a new workset for them during the delete process. If you delete the active workset, the #default workset automatically becomes the active workset. You cannot delete the #default workset.

1. On the Changes page, click Publishing Schedule.
2. Click the Delete Workset icon for the workset. If the workset is empty, simply confirm that you want to delete it.
3. If the workset contains changes, select a workset to move them to and then click Delete.

Keep in mind that Commerce automatically deletes a workset (except #default, which is never deleted) once its contents have been successfully published.

View the contents of a workset

To see the contents of the active workset, click it in the Changes tracker. Commerce displays the workset on the Changes page. To see the contents of a different workset, select it from the Active Workset dropdown list.

Each item in the workset list displays an icon you can click to see details about when changes were made and who made them:

• If only one author has made changes, the author's avatar appears in the icon.
• If two or more authors have made changes, the icon displays the number of authors.

Click the icon to see the names of authors who saved changes to the item since it was last published, as well as the date and time each change was made.

If an item is a member of more than one workset, the item also displays the number of worksets it belongs to. Click this link to see a list of all the worksets the item belongs to. See Understand worksets for more information about how Commerce publishes items that are in multiple worksets.

Filter and sort items in a workset

The filtering features let you display a subset of a workset's items. Sorting lets you display items by date, from either newest or oldest. Filtering items in a workset is useful for tasks like selecting items to move to a different workset. However, filtering does not select specific items to publish; all items in a workset are published when that workset is published.

Select the Filter By check boxes along the left-hand side of the page to find specific types of items and changes in the workset. Filter By options include:

• Author: The user who made the change.
• Status: The type of change made to the item (edited, imported, new, and deleted).
• Area: The type of item (catalog, design, marketing, media, pricing, and setting).
• Application: The type of storefront application a design item belongs to (Storefront Classic or Open Storefront Framework).

Click Clear Filters to clear all check boxes and display all the items that were filtered out by the Filter By options.

To use the Filter Change List field, begin typing in the field. The list changes to include those items matching your criteria.

To sort the displayed items from newest or oldest, click the Sort dropdown at the top of the page and select a sort order.