Cert++
Close

Page Designer cartridge folder structure and type ID conventions

Key Takeaway

A type's ID is the subdirectory path below its base folder (experience/pages or experience/components) plus the file name without its extension, with periods between levels. For example, experience/components/content/hero/heroimage.json has the ID content.hero.heroimage, and that ID is the value a region's component_type_inclusions entry uses as its type_id.

Page Designer lets developers build reusable page types and component types. Merchants then drag these onto pages in the Business Manager visual editor. Each type is a pair of files in a fixed folder inside a custom cartridge. The folder path and the file name together become the type's ID. If you know the folder layout, you can predict any type's ID and reference it correctly in code and configuration.

Two custom cartridges

A Page Designer implementation typically uses two custom cartridges. One cartridge holds the page types and component types. The other cartridge holds supporting UI artifacts, such as localized names and thumbnail images.

SFRA follows this split. In SFRA, app_storefront_base holds the runtime files: templates, JSON and scripts. The bm_app_storefront_base cartridge holds the design-time files: names, descriptions, icons and custom attribute editors.

B2C Commerce Developer Study Guide

Checklist progress

0/237Learned

Prepare for the Exam

Play Today's Certle

Study Community

Ask questions and get the latest info from other B2C Commerce Developer studiers. 796 members and growing.