Skip to content
b2c-metadata logo

Metadata Skill

b2c-metadata

Work with B2C Commerce site metadata XML for custom attributes and object types. Use when defining custom attributes on products/orders/customers, creating custom object types, or setting site preferences via XML import. Covers system-objecttype-extensions.xml and custom-objecttype-definitions.xml.

SKILL.md

Full skill instructions

Metadata Skill

This skill guides you through working with site metadata XML for Salesforce B2C Commerce, including custom attributes, custom objects, and site preferences.

Overview

Metadata defines the structure of your B2C Commerce data:

Metadata TypePurpose
System Object ExtensionsAdd custom attributes to Products, Orders, Customers, etc.
Custom ObjectsDefine entirely new data types
Site PreferencesSite-specific configuration values

Site Archive Structure

Metadata is organized in site archives:

/​site-archive
    /​meta
        system-objecttype-extensions.xml    # Custom attributes on system objects
        custom-objecttype-definitions.xml   # Custom object definitions
    /​sites
        /​MySite
            preferences.xml                 # Site preferences

System Object Extensions

Add custom attributes to existing system objects.

Basic Structure

<?xml version="1.0" encoding="UTF-8"?>
<metadata xmlns="http://www.demandware.com/​xml/​impex/​metadata/​2006-10-31">
    <type-extension type-id="Product">
        <custom-attribute-definitions>
            <attribute-definition attribute-id="myCustomAttribute">
                <display-name xml:lang="x-default">My Custom Attribute</​display-name>
                <type>string</​type>
                <mandatory-flag>false</​mandatory-flag>
                <externally-managed-flag>false</​externally-managed-flag>
            </​attribute-definition>
        </​custom-attribute-definitions>
        <group-definitions>
            <attribute-group group-id="MyCustomGroup">
                <display-name xml:lang="x-default">My Custom Group</​display-name>
                <attribute attribute-id="myCustomAttribute"/>
            </​attribute-group>
        </​group-definitions>
    </​type-extension>
</​metadata>

Common System Objects

Object TypeUse Case
ProductProduct attributes
OrderOrder metadata
ProfileCustomer profile data
BasketCart data
SitePreferencesSite configuration
CategoryCategory attributes
ContentContent asset attributes

Attribute Types

TypeDescriptionExample
stringText (max 4000 chars)SKU, descriptions
textLong text (unlimited)Rich content
intIntegerQuantity, rank
doubleDecimalPercentage, weight
booleantrue/​falseFlags
dateDate onlyBirth date
datetimeDate and timeTimestamps
emailEmail addressContact email
passwordEncryptedAPI keys
htmlHTML contentRich text
enum-of-stringSingle selectStatus
enum-of-intNumeric enumPriority level
set-of-stringMulti-selectTags
set-of-intNumeric multi-selectCategories
imageImage referenceThumbnails

Enum Value Definitions

Enum types (enum-of-string, enum-of-int, set-of-string, set-of-int) require value-definitions with value/​display pairs:

<attribute-definition attribute-id="warrantyType">
    <display-name xml:lang="x-default">Warranty Type</​display-name>
    <type>enum-of-string</​type>
    <mandatory-flag>false</​mandatory-flag>
    <value-definitions>
        <value-definition>
            <value>none</​value>
            <display xml:lang="x-default">No Warranty</​display>
        </​value-definition>
        <value-definition>
            <value>limited</​value>
            <display xml:lang="x-default">Limited Warranty</​display>
        </​value-definition>
        <value-definition>
            <value>full</​value>
            <display xml:lang="x-default">Full Warranty</​display>
        </​value-definition>
    </​value-definitions>
</​attribute-definition>
ElementPurpose
<value>The stored/​API value (use lowercase, no spaces)
<display>Human-readable label shown in Business Manager

Product Custom Attribute Example

<?xml version="1.0" encoding="UTF-8"?>
<metadata xmlns="http://www.demandware.com/​xml/​impex/​metadata/​2006-10-31">
    <type-extension type-id="Product">
        <custom-attribute-definitions>
            <!-- Simple string attribute -->
            <attribute-definition attribute-id="vendorSKU">
                <display-name xml:lang="x-default">Vendor SKU</​display-name>
                <type>string</​type>
                <mandatory-flag>false</​mandatory-flag>
                <externally-managed-flag>true</​externally-managed-flag>
            </​attribute-definition>

            <!-- Enum (dropdown) attribute -->
            <attribute-definition attribute-id="productCondition">
                <display-name xml:lang="x-default">Product Condition</​display-name>
                <type>enum-of-string</​type>
                <mandatory-flag>false</​mandatory-flag>
                <value-definitions>
                    <value-definition>
                        <value>new</​value>
                        <display xml:lang="x-default">New</​display>
                    </​value-definition>
                    <value-definition>
                        <value>refurbished</​value>
                        <display xml:lang="x-default">Refurbished</​display>
                    </​value-definition>
                    <value-definition>
                        <value>used</​value>
                        <display xml:lang="x-default">Used</​display>
                    </​value-definition>
                </​value-definitions>
            </​attribute-definition>

            <!-- Boolean attribute -->
            <attribute-definition attribute-id="isHazardous">
                <display-name xml:lang="x-default">Hazardous Material</​display-name>
                <type>boolean</​type>
                <mandatory-flag>false</​mandatory-flag>
                <default-value>false</​default-value>
            </​attribute-definition>

            <!-- Multi-select attribute -->
            <attribute-definition attribute-id="productFeatures">
                <display-name xml:lang="x-default">Product Features</​display-name>
                <type>set-of-string</​type>
                <mandatory-flag>false</​mandatory-flag>
                <value-definitions>
                    <value-definition>
                        <value>waterproof</​value>
                        <display xml:lang="x-default">Waterproof</​display>
                    </​value-definition>
                    <value-definition>
                        <value>recyclable</​value>
                        <display xml:lang="x-default">Recyclable</​display>
                    </​value-definition>
                </​value-definitions>
            </​attribute-definition>
        </​custom-attribute-definitions>

        <group-definitions>
            <attribute-group group-id="CustomProductInfo">
                <display-name xml:lang="x-default">Custom Product Information</​display-name>
                <attribute attribute-id="vendorSKU"/>
                <attribute attribute-id="productCondition"/>
                <attribute attribute-id="isHazardous"/>
                <attribute attribute-id="productFeatures"/>
            </​attribute-group>
        </​group-definitions>
    </​type-extension>
</​metadata>

Custom Object Definitions

Create entirely new data types.

<?xml version="1.0" encoding="UTF-8"?>
<metadata xmlns="http://www.demandware.com/​xml/​impex/​metadata/​2006-10-31">
    <custom-type type-id="StoreLocations">
        <display-name xml:lang="x-default">Store Locations</​display-name>
        <description xml:lang="x-default">Physical store information</​description>
        <staging-mode>source-to-target</​staging-mode>
        <storage-scope>site</​storage-scope>
        <key-definition attribute-id="storeId">
            <display-name xml:lang="x-default">Store ID</​display-name>
            <type>string</​type>
            <min-length>1</​min-length>
        </​key-definition>
        <attribute-definitions>
            <attribute-definition attribute-id="storeName">
                <display-name xml:lang="x-default">Store Name</​display-name>
                <type>string</​type>
                <mandatory-flag>true</​mandatory-flag>
            </​attribute-definition>
            <attribute-definition attribute-id="latitude">
                <display-name xml:lang="x-default">Latitude</​display-name>
                <type>double</​type>
            </​attribute-definition>
            <attribute-definition attribute-id="longitude">
                <display-name xml:lang="x-default">Longitude</​display-name>
                <type>double</​type>
            </​attribute-definition>
            <attribute-definition attribute-id="phone">
                <display-name xml:lang="x-default">Phone</​display-name>
                <type>string</​type>
            </​attribute-definition>
            <attribute-definition attribute-id="isActive">
                <display-name xml:lang="x-default">Active</​display-name>
                <type>boolean</​type>
                <default-value>true</​default-value>
            </​attribute-definition>
        </​attribute-definitions>
        <group-definitions>
            <attribute-group group-id="StoreInfo">
                <display-name xml:lang="x-default">Store Information</​display-name>
                <attribute attribute-id="storeId" system="true"/>
                <attribute attribute-id="storeName"/>
                <attribute attribute-id="latitude"/>
                <attribute attribute-id="longitude"/>
                <attribute attribute-id="phone"/>
                <attribute attribute-id="isActive"/>
            </​attribute-group>
        </​group-definitions>
    </​custom-type>
</​metadata>

Site Preferences

Site-specific configuration via custom attributes on SitePreferences.

Metadata (system-objecttype-extensions.xml)

<?xml version="1.0" encoding="UTF-8"?>
<metadata xmlns="http://www.demandware.com/​xml/​impex/​metadata/​2006-10-31">
    <type-extension type-id="SitePreferences">
        <custom-attribute-definitions>
            <attribute-definition attribute-id="enableFeatureX">
                <display-name xml:lang="x-default">Enable Feature X</​display-name>
                <type>boolean</​type>
                <default-value>false</​default-value>
            </​attribute-definition>
            <attribute-definition attribute-id="apiEndpoint">
                <display-name xml:lang="x-default">API Endpoint</​display-name>
                <type>string</​type>
            </​attribute-definition>
            <attribute-definition attribute-id="maxItemsPerPage">
                <display-name xml:lang="x-default">Max Items Per Page</​display-name>
                <type>int</​type>
                <default-value>20</​default-value>
            </​attribute-definition>
        </​custom-attribute-definitions>
        <group-definitions>
            <attribute-group group-id="CustomSettings">
                <display-name xml:lang="x-default">Custom Settings</​display-name>
                <attribute attribute-id="enableFeatureX"/>
                <attribute attribute-id="apiEndpoint"/>
                <attribute attribute-id="maxItemsPerPage"/>
            </​attribute-group>
        </​group-definitions>
    </​type-extension>
</​metadata>

Values (sites/​MySite/​preferences.xml)

Preferences can be set per instance type (development, staging, production) or for all instances:

<?xml version="1.0" encoding="UTF-8"?>
<preferences xmlns="http://www.demandware.com/​xml/​impex/​preferences/​2007-03-31">
    <custom-preferences>
        <all-instances>
            <!-- Values that apply to all instance types -->
            <preference preference-id="maxItemsPerPage">25</​preference>
        </​all-instances>
        <development>
            <!-- Development-specific values -->
            <preference preference-id="enableFeatureX">true</​preference>
            <preference preference-id="apiEndpoint">https://dev-api.example.com/​v1</​preference>
        </​development>
        <staging>
            <preference preference-id="enableFeatureX">true</​preference>
            <preference preference-id="apiEndpoint">https://staging-api.example.com/​v1</​preference>
        </​staging>
        <production>
            <preference preference-id="enableFeatureX">false</​preference>
            <preference preference-id="apiEndpoint">https://api.example.com/​v1</​preference>
        </​production>
    </​custom-preferences>
</​preferences>

Access in Code

var Site = require('dw/​system/​Site');

var enableFeatureX = Site.current.getCustomPreferenceValue('enableFeatureX');
var apiEndpoint = Site.current.getCustomPreferenceValue('apiEndpoint');
var maxItems = Site.current.getCustomPreferenceValue('maxItemsPerPage');

Attribute Definition Options

<attribute-definition attribute-id="myAttribute">
    <display-name xml:lang="x-default">Display Name</​display-name>
    <description xml:lang="x-default">Description for BM tooltip</​description>
    <type>string</​type>
    <localizable-flag>false</​localizable-flag>
    <mandatory-flag>false</​mandatory-flag>
    <externally-managed-flag>false</​externally-managed-flag>
    <visible-flag>true</​visible-flag>
    <site-specific-flag>false</​site-specific-flag>
    <order-required-flag>false</​order-required-flag>
    <searchable-flag>false</​searchable-flag>
    <min-length>0</​min-length>
    <max-length>256</​max-length>
    <default-value>default</​default-value>
    <select-mode>none</​select-mode>
    <unit>kg</​unit>
</​attribute-definition>
FlagPurpose
localizable-flagCan have different values per locale
mandatory-flagRequired in BM
externally-managed-flagRead-only in BM
visible-flagShown in BM
site-specific-flagDifferent value per site
order-required-flagRequired for order export
searchable-flagIndexed for search

Best Practices

  1. Use attribute groups to organize in Business Manager
  2. Prefix custom attributes with organization name (e.g., acme_myAttribute)
  3. Set externally-managed for data imported from external systems
  4. Use enums over strings for controlled vocabularies
  5. Document with descriptions - they appear as tooltips

Detailed Reference

More skills from majiayu000

xiaohongshu logo
majiayu000/claude-arsenal

xiaohongshu

xiaohongshu

286 148
View
agent-task-conductor logo
majiayu000/claude-skill-registry

agent-task-conductor

Conduct multi-agent task orchestration and workflow coordination.

663 1
View
conductor-setup logo
majiayu000/claude-skill-registry

conductor-setup

Initialize project with Conductor artifacts (product definition,

663 1
View
animation-designer logo
majiayu000/claude-skill-registry

animation-designer

Expert in web animations, transitions, and motion design using Framer Motion and CSS

663 1
View
diagramming logo
majiayu000/claude-skill-registry

diagramming

Creates Mermaid and ASCII diagrams for flowcharts, architecture, ERDs, state machines, mindmaps, and more. Use when user mentions diagram, flowchart, mermaid, ASCII diagram, text diagram, terminal diagram, visualize, C4, mindmap, architecture diagram, sequence diagram, ERD, or needs visual docume...

663 1
View
h3-pg logo
majiayu000/claude-skill-registry-data

h3-pg

PostgreSQL bindings for H3 hexagonal grid system. Use when working with H3 cells in Postgres, including spatial indexing, geometry/geography integration, and raster analysis.

23 1
View
conductor-development logo
majiayu000/claude-skill-registry

conductor-development

Context-Driven Development skill for projects using Conductor. Use this skill when you detect a `conductor/` directory in the project, when working on tasks defined in a `plan.md` file, or when the user asks about tracks, specs, or plans. Automatically applies TDD workflow, tracks task completion...

663 1
View
conductor-status logo
majiayu000/claude-skill-registry

conductor-status

Display project status, active tracks, and next actions

663 1
View
dockerization logo
majiayu000/claude-skill-registry

dockerization

Official Stakpak application containerization standard operating procedure, a step-by-step guidline to properly dockerize applications. This is a rule book curated by the Stakpak Team.

663 1
View

Popular AI tools

Kaiber logo
Video

Kaiber

Generate, edit, and beat-sync AI video with leading models in one workspace.

Paid
View
Vimcal logo
Productivity

Vimcal

The world's fastest calendar for remote work

Free
View

Transform Your Design with AI Designer by ImgCreator.ai

Freemium
View
Akool AI logo
Content & writing

Akool AI

Revolutionizing Video Production with AI-Powered Creativity

Paid
View

Extend an image past the frame and let AI fill the new aspect ratio.

Freemium
View
StarByFace logo
Security

StarByFace

Discover your celebrity doppelgänger with StarByFace!

Free
View
C

ChainClarity explains 700+ crypto whitepapers in plain English, with layered summaries, comparisons, research tools, alerts, and a $4.99 Pro plan.

Freemium
View
Opus Clip logo
Coding & apps

Opus Clip

Opus.ai: Revolutionize Your Web Experience

Free
View