Edit data field labels
- Last UpdatedApr 22, 2024
- 3 minute read
Edit data field labels to create a friendly name for a field that displays in your data view.
Data field labels
A data field label is a friendly name that you can specify directly or using rules. Null, empty, or whitespace is not allowed for a data field label.
When the data view is resolved and data fields produce field mappings, labels are trimmed of whitespace and used as the field mappings' identifier. For example:
| Timestamp | Power In Value | Power Out Value |
In cases where the identifiers are not unique, the identifier is suffixed with an ordinal number, its position. For example:
| Timestamp.0 | Value.1 | Value.2 |
To edit data field labels, enter { to display tokens to use as a data field label. There are a variety of special tokens available for use in field labels. These tokens resolve to a specific value for a field. The following list describes each available token.
|
Token |
Description |
|---|---|
|
{CommunityId} |
The identifier of the community associated with the data field set's query, or empty if a namespace was queried instead. |
|
{CommunityName} |
The name of the community associated with the data field set's query, or empty if a namespace was queried instead. If a community alias is in effect, the alias is used instead of the community name |
|
{IdentifyingValue} |
The value of the identifying field. |
|
{Key} |
The value of the first of the Key objects specified on the field. |
|
{NamespaceId} |
The identifier of the namespace where the corresponding stream/asset originates from. For community queries, this is the owner's namespace from which this stream/asset was shared. |
|
{NamespaceDescription} |
The description of the namespace where the corresponding stream/asset originates from. For community queries, this is the owner's namespace from which this stream/asset was shared. |
|
{QueryId} |
The identifier of the query that produced the field. |
|
{StreamReferenceName} |
The value of the first of the StreamReferenceName objects specified on the field. |
|
{SummaryType} |
The value of the summary type of the field (if defined). |
|
{SummaryDirection} |
The value of the summary direction of the field (if summary type is defined). |
|
{TenantId} |
The identifier of the tenant where the corresponding stream/asset originates from. For community queries, this is the owner's tenant from which this stream/asset was shared. |
|
{TenantName} |
The name of the tenant where the corresponding stream/asset originates from. For community queries, this is owner's tenant from which this stream/asset was shared. |
|
{Uom} |
The value of the unit of measure of the field (if UOM is present in the source). |
If a special parameter fails to resolve, it becomes an empty string, "".
To edit data field labels
-
From the Data Field Label field, enter one or more tokens to use as a label. At the time of data view resolution, the labels resolve to values pulled from the data item (stream or asset). For more information on each available token, see the table above.
-
(Optional) Select the Include UOM as a Column checkbox. This option includes the unit of measure as a column in your data view.
-
(Optional) Select a Summary direction. This option controls whether the start or end index of the summary is used by the data view to calculate the summary values.
-
Review the Data Field Preview. This preview lists each data field and property included within the affected data view queries.
-
Select Apply.