Skip to content

Web Application - Admin User Manuals

Configuring Property Schema

4 min readUpdated

In this section, you will learn how to:

Defining property schema allows you to manage additional information to be displayed as part of a component’s metadata in the digital twin model. Once a property schema is created, it must be mapped to a component in the digital twin model for the relevant data to be displayed in the UI. Mapping the property schema involves downloading the metadata file, assigning the property schema to the component(s) as required and then uploading the updated metadata file back to the system.

Note: For more information, refer to Mapping the Metadata Components.

By default, the metadata of a component displays the following:

  • Name: Name of the component
  • Global UID: Unique ID of the component
  • Category: Category to which the component belongs
  • Family: Family to which the component belongs
  • Type: The type of component
  • Parent: Parent component as per the hierarchy

However, if you wish to view additional data as part of the metadata in the digital twin model, you can map certain property schema to the components in the metadata file.

Adding a Property Schema

  1. In the Main Menu, under the ADMIN OPTIONS, in the Digital Twin subsection, click Property Schema.
    ‎The Property Schema page is displayed with a list of property schemas, if any.
  2. Click Add Property Schema.
  3. Enter the Name of the property schema. For example, VAV.
  4. Select the State Schema(s) to be mapped to this property schema.
  5. Under New Property, enter or select the required field information.
    Option Description

    Name*

    Enter the name of the property. For example, Name, State, Length, Width, and so on.

    Data Type

    Select the type of data this property will capture. For example, String for Name, Numeric for Length, and so on.

    Type

    Select the data source for the property:

    • Digital Twin Property: Fetches data from the Digital Twin model’s metadata. For example, Class Title of the VAV.
    • Bluecoin Property: Links data points related to variables, constants, HVAC zones, areas, desks, and any other entities.
    • Fixed: Refers to fixed value data hardcoded into the system. For example, length or width of the VAV unit.
    • Section: Creates a section under which additional properties will be displayed in the UI. For example, Dimensions can be added as a Section, under which fixed properties such as Length and Width can be added.
    • State Schema: Fetches data from the selected state schema. For example, AC alerts schema for VAV.

    Position

    Specify the order at which this property would be displayed in the UI.

    Unit

    Select the unit of the property being added. For example, cm for Length, or CFM for air flow, and so on.

    Value

    Enter the value of the property being added. For example, 150mm for the length of the VAV.

    Note: Values are only added for properties that are of Fixed type. The values for other types of properties are fetched from the specified source.

    Digital Twin Section

    Enter the name of the section under which the defined property will be added. For example, under a section named Dimensions section, you could add the Property as Height.

    Digital Twin Property

    Enter or select the metadata label that will be added under the configured section. For example, Height or Make or Model.

    Flag ID

    Select where to fetch the data for the property. For example, data for Name property is fetched from the Digital Twin Component Name defined in the metadata.

    State Schema

    Select the state schema to retrieve data for this property.

    Hidden

    Select this checkbox to keep this property hidden and not display in the Digital Twin model.

    Under Section

    Select this checkbox if the property is being created under a section. For example, Length property under Dimension section.

  6. Click Add Property.
  7. Repeat steps 5 and 6 to add more properties to the property schema.
  8. Click Save.

Editing Property Schema

  1. In the Main Menu, under the ADMIN OPTIONS, in the Digital Twin subsection, click Property Schema.
    ‎The Property Schema page is displayed with a list of property schemas.
  2. Under the Action column, click the Edit icon icon for the property schema to be edited.
  3. Modify the fields as required. For information on field descriptions, refer Adding a Property Schema.
  4. Click Save.
Was this page helpful?