Relation Id Structure
A Relation Id contains different parts that, together, make the ID useful as additional information on objects in a station.
The following diagram shows the basic parts of a Relation Id.
Figure 1. Parts of a Relation Id
- Relation Id
- Tag Dictionary
- Tag Name
- Tag Value
The following table provides definitions of the different parts of a Relation Id:
| Relation Element | Description |
|---|---|
| Relation Id | The Relation Id is comprised of a dictionary and name, generally displayed as two pieces of text separated by a colon (:),
as shown in the following example: <dictionaryNamespace>:<name>.
|
| Tag Dictionary | The dictionary string is used to link or assign a tag to a particular "namespace" (tag dictionary). This is typically a very short string of one or two characters. |
| Tag Name | The name string provides the semantic information and is often paired with the Tag Value. |
| Tag Value | A string value assigned to the tag for more information, for example: building name, device name, location, or other. |