UNS OpenHubDocumentation

Schema administration

Understand and create an object type

An object type is a reusable schema template, such as a furnace or a material. Use this guide when inspecting an existing definition or creating one; neither action creates an Asset, ObjectId, or live namespace path by itself.

Applies to
Schema · Object type · View, Edit, and New
Guide version
1.0

Worked example

Example: furnace

Use this when several furnaces share the same meaning and attributes, even when they live at different paths in the namespace.

Key furnace

Stable template identifier. Use a new key if the meaning changes.

Label Furnace

Readable name shown to administrators.

Description Industrial heating furnace.

Explains the common purpose of objects that use this type.

Status Draft

Keep the template in draft while its meaning is still being curated.

Attributes temperature, state

Ordered attribute definitions that are meaningful for this object type.

Aliases heating-oven

Optional alternate term that helps search and later curation.

Procedure

Follow the task in order

  1. 1
    Choose a stable template keyUse a concise, lowercase business term. Do not use a site, asset path, or a single physical furnace identifier.
  2. 2
    Add a label and descriptionWrite for another administrator who must understand the type without inspecting the live namespace.
  3. 3
    Link the meaningful attributesAdd only attributes that belong to this type across its instances. A type can be created before every attribute is known.
  4. 4
    Use aliases only for real alternate termsAliases improve search and curation. They are not additional object types or asset names.
  5. 5
    Save as draft firstReview the template with the people who publish or use the data, then set it active when the common meaning is ready.

Expected result

What you should have

A reusable object-type template. Assets and ObjectId records can reference or be discovered with this type later; this action does not create any live objects.

Boundaries

Important boundaries

  • Do not use this form to create a concrete asset path or a single machine instance.
  • Check the existing catalog before creating a near-duplicate type with a different spelling.
  • For a package-owned object type, choose Edit package definition from Schema. The change remains a package candidate until it is reviewed and applied.

This versioned public guide is maintained with the UNS OpenHub website and linked directly from the controller where the task applies.