Publishing

Control the visibility and caching of options on the front end.

Overview

Publishing and Draft states have been added to Catalog items to control what is accessible externally. Now, Catalog Items are created as Drafts by default and can be Published when they are ready.

Items can be Published or Unpublished (set back to Draft state) in bulk:

Note!

Initiating a Publish action will trigger a new thumbnail job, which performs the task of generating a new thumbnail, refreshing the cache keys, and refreshing the manifest file for that item.

Front-End Settings

Using the publishStage:draft or publishStage:published embed parameter for the Classic Player, you can control what Items are accessible client-side, including sub-items of a Product configurator. If no parameter is set, no restrictions will be enforced.

Visit the Player Embedding page for more information.

Note:

For configurators with part references that include unpublished Items, the unpublished Items will not be available as options. To make them available, the unpublished Items need to be published and the top level configurator needs to be re-published.

Caching

Publishing automatically updates cache keys associated with the given item. When embedding the Classic Player with the publishStage:published parameter, the player will automatically serve the cached version of the associated assets based on the current cache key specified by the item.

Important!

Republishing an item will refresh the cache key for that item, so it is very important to republish items whenever changes are made either on the item or on any of its referenced assets.

Migrations

When preparing for a migration, it is important to ensure that you have performed all the necessary republishing prior to the migration. Migrations will migrate the cache keys as well.

Changes made to assets without an accompanying republish will still serve the old cached version of the assets to the front end, until the cache keys are refreshed by a republish.

Republishing:

Simply clicking the Publish button is sufficient to perform a republish. It is not necessary to Unpublish and then Republish.

Bulk Publishing and Republish

The platform UI enables us to bulk publish and republish by simply selecting all items shown on the current page, and clicking the Publish button. If you wish to republish only currently published items, you can filter the list by the Publish State.

The main limitation with this approach is the fact that a page can only show up to 50 items at a time, and the UI does not currently allow us to select more than a single page at a time.

Full Republish: The Republish App enables users to perform bulk publishing and republishing on the entire catalog, regardless of total count, including the ability to republish only currently published items.