asset-description-required#

Code

AM.006

Validator

Compatibility

Tags

Summary#

The default prim must have aif:core:assetDescription and aif:core:connectsToModelDocumentation attributes.

Description#

Human-readable description and a link to external documentation ensure that asset consumers, both human and automated, can understand what the asset represents and find authoritative reference material.

Why is it required?#

  • assetDescription provides a plain-language summary for asset library UIs and search

  • connectsToModelDocumentation links to the manufacturer’s product page or datasheet for authoritative specifications

  • Together they make the digital twin self-documenting

Examples#

def Xform "CW375" {
    string aif:core:assetDescription = "Vertiv CW375 Coolant Distribution Unit, 375kW capacity"
    string aif:core:connectsToModelDocumentation = "https://www.vertiv.com/en-us/products-catalog/cooling/fluid-coolers-and-cdus/vertiv-liebert-cw/"
}

How to comply#

Set both attributes on the default prim. The documentation URL should point to the manufacturer’s product page or technical datasheet.

For More Information#