This article covers
- Item certification rules
- Feature certification rules
- Option certification rules
- Material certification rules
- Catalog version certification rules
Note: Property names and rule codes appear in code formatting because they must match the catalog data.
Item certification rules
Auto Deco bathroom accessory
auto-deco-bathroom-accessory
Bathroom collision box
bathroom-collision-box
geometries/collisionBox. Sets that do not contain top-level geometry (set.showering, set.vanity, set.bathing, set.washbasin) need to provide this information so applications can calculate the initial position of an item when it is placed.
geometries/collisionBox.Built-in component classification
built-in-component
subTypeshapeTypeopeningDirectioninstallationTypematerial
subType or material is invalid. Cabinet primary functions
cabinet-primary-function
primaryFunctions classification characteristic. Auto Design uses primaryFunctions of cabinets (ex: oven, sink, washbasin) to correctly place them in a design.
primaryFunctions value.
primaryFunctions are not a requirement in classification of cabinets, as some have no clear function.Default-locale item names
default-locale
names/main/. This ensures that visible items have a displayable name in the catalog's default language.names, names/main, or the translation for the catalog's default locale. Filler depth configuration
fillers-deepest-cabinet
dimensions/depth with a valid range and a defaultValue within that range. This ensures fillers provide the dimensional flexibility required for width, height, and depth configurationdefaultValue is missing, or the defaultValue is outside the minimum and maximum range.Filler dimension ranges
fillers-dimension-ranges
Initial placement
initial-placement
getCatalogItemsValidityReport check to confirm that an item’s geometry and placement data are valid. This ensures that items pass Content Engine placement checks before the catalog is consumed by applications.Catalog and item resolution
- The item identifier is invalid.
- The catalog version cannot be identified.
- The item cannot be found.
- The available item data is incomplete.
- A database request fails.
Catalog dependencies and access
- Dependency information is invalid.
- A required dependency cannot be found.
- The user is not entitled to access a required dependency.
- No dependency satisfies the required status and version.
Attributes and modifications
- An
attributeRefcannot be found. - An attribute modification does not provide a required value.
- A numeric rule is assigned to an incompatible attribute type.
- The host catalog attempts to redefine an attribute data type supplied by a dependency.
- An override refers to an attribute that does not exist.
- Default item attributes cannot be evaluated.
Features and options
- A
featureRefcannot be found. -
defaultOptionCodedoes not match an available option. - A feature has no available options.
- A feature default cannot be evaluated.
- A dynamic option cannot be resolved.
Restrictions and formulas
- A restriction cannot be found or applied.
- The item has more than 200
restrictionRefs. - A formula cannot be evaluated.
- Formula resolution fails for dynamic content.
- Formula evaluation exceeds the permitted time.
- A formula contains
!FIND!, which is identified as performance-intensive.
Localization and geometry
- Required display content cannot be localized.
- Geometry information cannot be prepared for consumption.
- Another runtime error prevents placement preparation from completing.
Insertion offsets
insertion-offsets
insertionOffsets needed for correct initial placement on a wall or floor.- The required
onWalloronFlooroffset - Position and location values
- The expected z-position for the placement context
onWall or onFloor insertion offset is missing, or the z-position does not match the expected wall or floor convention. Item attribute supported values
item-attribute-supported-values
Item dimensions
item-dimensions-validation
-
defaultValueis greater than zero. -
defaultValueis within the minimum and maximum range. - The increment is not zero.
- Angled cabinets define
width2anddepth2.
defaultValue is 0 or less or is outside the minimum and maximum range, the increment is 0, or an angled cabinet does not define width2 or depth2. Item identity
sfx-item-identity
namesV1/mainimages/mainclassification/baseItemType- Valid UTF-8 text
- Supported text lengths
- Resolvable external image uniform resource identifiers (URIs)
namesV1/main, images/main, or classification/baseItemType is missing, text contains invalid UTF-8 or exceeds the permitted length, or an external image Uniform Resource Identifier (URI) cannot be resolved. Item thumbnails
item-thumbnail
images/main. This ensures visible items provide a primary image that consuming applications can use to visually represent the item. images or images/main is missing from a visible item. Item translations
item-translations
- Main, plan-view, and alternative names
- Long and short descriptions
- Keywords
moreInfoUri
Large geometry files
large-geometry
geometries/main/uri does not exceed the configured MaxGeometrySize. This prevents excessively large geometry assets from being published, protecting geometry consumption from oversized files. The geometry file size limit is 2MB after draco compression. Draco compression is a method that makes 3D files smaller.geometries/main/uri exceeds MaxGeometrySize.Item lifecycle and replacements
lifecycle
itemReplacementRef so consuming applications have a valid replacement path.itemReplacementRef is missing or blank. Molding extrusion profiles
linears-extrusion-profile
geometries/details/extrusionProfile. Design services use this profile to extrude the molding along a path.geometries/details/extrusionProfile is missing; the property check is case-insensitive. Item classification
missing-classification
classification/fullItemTypeclassification/baseItemType
classification/fullItemType or classification/baseItemType is missing from a visible, non-reference item. Molding dimensions
molding-dimensions
defaultValue within each applicable range. These dimensions allow the molding profile to be extruded and represented correctly.defaultValue is missing, or the defaultValue is outside the permitted range. Molding stack geometry
molding-stack-geometry
geometries/details/stack/offset. This provides the offset definition required for stacked moldings.geometries/details/stack/offset is missing for a molding subtype that is not excluded from the rule. Panel dimensions
panel-dimensions
- Frontal panels do not require a depth range.
- Side panels do not require a width range.
- Horizontal panels do not require a height range.
Sink installation types
sink-installation-type
asSubItem insertion offsets match its installation type:topMountunderMountflushMount
asSubItem insertion offsets are missing or the insertion-offset context does not match the sink's topMount, underMount, or flushMount installation type. Maximum number of sub-items
sub-items-max-number
subItems does not exceed LimitOptions.MaxNumberOfSubItems. This prevents items from exceeding the supported number of sub-items and creating excessively complex item structures. An item can have a maximum of 128 sub-items.subItems exceeds LimitOptions.MaxNumberOfSubItems. Feature certification rules
Blind-corner cabinet features
blind-corner-cabinets
Blind corner features need to have specific classification selection and feature options to work on consumption applications. This rule checks that blind-corner cabinet features use the customNumeric selection type and contain exactly one option with valid numeric minimum and maximum validation rules.
- The selection type is not
customNumeric. - The feature contains more or fewer than one option.
- The numeric minimum or maximum validation rules are missing.
Default-locale feature content
feature-default-locale
names or descriptions is missing. Feature identity
sfx-feature-identity
EntityTextLengthOptions.MaxTextLength. This ensures that applications can display feature information correctly.EntityTextLengthOptions.MaxTextLength. Feature translations
feature-translations
Feature classification
missing-feature-classification
classification/baseFeatureType. Consuming applications use feature classification to determine the user interface and feature behavior.classification/baseFeatureType is missing from a visible, non-reference feature. Numeric features
numeric-feature
customNumeric features contain exactly one option with one attribute whose value is numeric or formula-based. Numeric features support a single option where the value is entered by the user.- The feature does not contain exactly one option.
- The expected attribute is missing.
- The value is neither numeric nor a formula.
Option certification rules
Feature option translations
option-translations
names or descriptions. Item modifications
item-modification
itemModification and material references in layers/materialRef. Formula-based references are not included in this check.itemModification cannot be found in the catalog; formula-based references are excluded from this check. Supported option attribute values
option-attribute-supported-values
itemModification exist in the catalog’s attribute definitions or its dependencies.itemModification is not supported by the catalog or its dependencies. Default-locale option content
option-default-locale
Option thumbnails
option-thumbnail
customNumeric features have an image. This ensures features options contains the thumbnails, so they visually represented during configuration. Option thumbnails must have a minimum resolution of 225 x 225 px.customNumeric feature does not define an image. Material certification rules
Large texture files
large-texture
MaxTextureSize, keeping them under the file-size limit. The texture file size limit is 2MB.- Base color
- Normal
- Metallic roughness
- Transmission
- Emissive
baseColor, normal, metallicRoughness, transmission, or emissive texture, including its alternate version, exceeds MaxTextureSize. Texture quality
texture-quality
baseColor texture meets the minimum image resolution configured in TextureQualityOptions.MinimumResolution. This ensures that material textures meet the minimum resolution of 72dpi required for acceptable visual quality.baseColor texture is below TextureQualityOptions.MinimumResolution. Texture dimensions
texture-size
Checks that a baseColor texture has enough pixels for the real-world area the material covers (its sampling size), taking the configured MaximumScaleFactor into account. This keeps the material sharp when it is applied to a 3D shape.
The texture size in pixels must be at least half of the sampling RealWidth or RealHeight of the texture, which are measured in millimeters (mm).
- Minimum width in pixels = sampling
RealWidth(mm) ÷ 2 - Minimum height in pixels = sampling
RealHeight(mm) ÷ 2
Example:
- If the sampling
RealWidthof the texture is 1000 mm (39.37 inches), the texture must be at least 500 pixels wide. - If the sampling
RealHeightof the texture is 1000 mm (39.37 inches), the texture must be at least 500 pixels tall.
baseColor texture is below the calculated minimum based on the material's real-world sampling size and MaximumScaleFactor. Catalog version certification rules
Backward compatibility
backward-compatibility