Docs Portal
Expert Center
API ReferenceConsole

Understanding When to Label or Flag

Introduction

Enriching network metadata is about classifying entities (devices and points) and relating them to the real world (i.e., equipment and spaces). Entities often have context embedded in their metadata. The objective is to extract and formally define implied context using only the metadata that's available on the network.

The most critical skill is identifying when an entity does and does not have sufficient context to relate to the real world.


Labeling with Sufficient Context

Network metadata consists of entities that are either devices or points:

  • Devices host points
  • Points represent sensor readings, setpoints, commands, or status values

When context is sufficient for an entity, the objectives are:

  1. Classify the entity: Determine the entity type (e.g., Discharge_Air_Flow_Sensor)
  2. Identify derived entities: Concepts implied in the metadata (e.g., "VAV-101" in the name)
  3. Describe relationships: How derived entities relate to each other or to the source entity

Available Context by Base Type

Things (Devices)

  • The device's own metadata (name, description, entity type, etc.)

Points

  • The point's own metadata
  • The host device's metadata and derived entities (Points can use context from their host device)

Only create derived entities and relationships that are directly supported by available metadata. When multiple derived entities are created, specify relationships between them.


Example 1: Point with Sufficient Context

Metadata:

Copy
1
2
3
4
5
Name:        VAV-101.FLOW
Description: Airflow
Base type:   POINT
Unit:        FT3_PER_MIN
Object type: ANALOG_INPUT

Experts verify that "VAV-101.FLOW" implies the existence of a VAV ("VAV-101") and room ("Room 101"), resulting in labeling 2 derived entities and 2 relations.

Classification: DISCHARGE_AIR_FLOW_SENSOR

Derived Entities:

  • VAV-101 (VARIABLE_AIR_VOLUME_BOX)
  • Room 101 (ROOM)

Relations:

  • VAV-101 HAS_POINT SELF
  • VAV-101 HAS_LOCATION Room 101

Example 2: Device with Sufficient Context

Metadata:

Copy
1
2
3
Name:        VMA-109
Base type:   THING
Entity type: CONTROLLER

Experts confirm that the "VMA-109" implies the existence of a VAV ("VAV-109") and room ("Room 109"), resulting in 2 Derived Entities and one relation.

Derived Entities:

  • VAV-109 (VARIABLE_AIR_VOLUME_BOX)
  • Room 109 (ROOM)

Relations:

  • VAV-109 HAS_LOCATION Room 109

Example 3: Point Using Host Device Context

Point Metadata:

Copy
1
2
3
4
5
Name:        FLOW
Description: Airflow
Base type:   POINT
Unit:        FT3_PER_MIN
Object type: ANALOG_INPUT

The point metadata alone is generic. However, the host device provides context:

Host Device Metadata:

Copy
1
2
3
4
5
Host Name:             VMA-109
Host Base type:        THING
Host Entity type:      CONTROLLER
Host Derived Entities: VAV-109, Room 109
Host Relations:        VAV-109 HAS_LOCATION Room 109

Since host metadata is available to points, this point can reference the host's derived entities.

Relations:

  • VAV-109 HAS_POINT SELF

When Context is Insufficient

Sometimes an entity cannot be related to the real world using the available metadata.

Point Metadata:

Copy
1
2
3
4
5
Name:        FLOW
Description: Airflow
Base type:   POINT
Unit:        FT3_PER_MIN
Object type: ANALOG_INPUT

Host Device Metadata:

Copy
1
2
3
Host Name:        FCB.CG00001
Host Description: General Purpose Controller
Host Base type:   THING

Neither the point nor the host metadata tells us which equipment this point belongs to. When context is insufficient, flag the entity.


How to Flag

  1. Click the flag button dropdown
  2. Select "Insufficient Context" as the flag reason
  3. Optionally describe the reason in the notes (e.g. "This point belongs to VAV-109 based on the controls drawings")

Flagging without a note is acceptable. This implies further investigation is needed.


Why Flag?

Flagging helps Mapped identify where assistance is needed.

Flag ReasonPurpose
Insufficient ContextEntity needs linking using context outside the connector
Entity Type not availableOntology is missing the required entity type

Mapped will review flagged entities and take action.


Key Takeaways

  • Label with sufficient context: Only derive what the metadata supports
  • Flag insufficient context: Surface gaps that require external information