Skip to content

COBie.Component.Description -- Expected Values

The COBie.Component.Description parameter provides a concise, factual description of the component instance.\ Its purpose is to give Facility Management systems a clear understanding of what the asset is, without relying on the component name or external documentation.

The description shall be short, consistent, and derived from the Type definition, not from ad‑hoc user notes.

Validation Rules (DAQS)

  1. Value must exist where descriptions are required\ Components shall include a description unless explicitly exempted in the Responsibility Matrix.

  2. Description shall be factual and non‑narrative\ No free‑text commentary, usage notes, or design intent.

  3. Allowed characters\ Standard alphanumeric characters and punctuation (commas, hyphens, periods).\ No emojis, symbols, or special characters.

  4. Consistency with Type Information\ The component description shall typically match, or be derived from, the FamilyType description.

  5. Description shall not duplicate the Component Name\ The value must add functional meaning, not repeat identifiers.

  6. Language requirement\ Descriptions shall be provided in the language specified in the BEP or client standard.

Good Examples

Component Type Valid COBie.Component.Description

Internal Door Type A Single-leaf internal door, 930mm

Fan Coil Unit FCU-03 Ceiling-mounted fan coil unit, 3.5 kW

Pump Centrifugal circulation pump, variable speed

Switchboard Low-voltage distribution board, metal enclosure

These examples provide clear functional descriptions without identification codes.

Common Mistakes

Incorrect Value Issue

Door A Identifier, not a description

Nice modern door Subjective and non‑technical

FCU-03 Repeats component name or type code

See drawings for details Incomplete; relies on external documentation

Empty Missing required description

Relationship to Revit

Autodesk's COBie Extension commonly maps COBie.Component.Description from:\ Revit → Type Parameter "Description"\ (or "Type Comments", depending on configuration).

For correct exports: - FamilyType descriptions must be maintained consistently.\ - Instance descriptions should not override Type descriptions unless explicitly required.

Best Practices

  • Maintain descriptions centrally at the FamilyType level.
  • Keep descriptions short, objective, and functional.
  • Use a consistent wording pattern across disciplines.
  • Avoid late changes to terminology---this breaks COBie dataset consistency.
  • Verify that descriptions comply with client vocabulary or classification requirements.