Localizing page and component types and visual editor thumbnails
Key Takeaway
Put Page Designer resource bundles and thumbnail images in a custom cartridge and upload it to the Business Manager site. Without them, the visual editor shows the meta definition file text and generic images.
Page Designer lets a developer show translated names and descriptions, plus preview images, for page types and component types. Merchants see these in the visual editor, which they use in Business Manager to build pages. The translated text lives in .properties resource bundles. The preview images are thumbnail image files. Both go in a separate custom cartridge.
The UI artifacts cartridge
To localize page and component types or to show thumbnail images, create a custom cartridge that holds the resource bundles and thumbnail image files. Then upload the cartridge to the Business Manager site. Merchants use the visual editor in Business Manager, so the visual editor reads these files from the Business Manager site. Uploading the cartridge only to the storefront site isn't enough.
A typical Page Designer implementation uses two custom cartridges. One holds the page and component types. The other one, the UI artifacts cartridge, holds the supporting UI artifacts: the resource bundles and thumbnail images.
SFRA follows the same split. app_storefront_base holds the runtime files: templates, JSON, and scripts. bm_app_storefront_base holds the design time files, such as names, descriptions, icons, and custom attribute editors.
Resource bundles and thumbnails are both optional, because the visual editor has fallbacks:
If a page type or component type has no resource bundle...
The visual editor uses the information in the meta definition file instead.
If a page type or component type has no thumbnail image...
The visual editor shows a generic image.
If the UI artifacts cartridge is on the storefront site but not on the Business Manager site...
The visual editor doesn't get the bundles or thumbnails. The visual editor shows the meta definition file text and generic images, as if the files didn't exist.