Data Label (4.4.5)

This article applies to versions 4.4.5 and later of P2 Explorer. See Release History for more. For the latest help, see Data Label.

Overview

The data label is one of the most useful of Explorer’s components, as it is used to show time-aware tag and attribute values on Explorer pages.

The data label displays a single data value, and is often used on schematics to display the value of a single entity attribute. There is also a link to trend data and a point details page for the tag or attribute, respectively. Tags and attribute values that can be overwritten have a write option.

As well as being able to display a tag or an attribute, a data label can be configured to display: a column value from a tabular dataset, a single value defined in Studio, or an ad hoc calculation using tag and/or attribute values (see the section Options for Configuring a Data Label Component at the end of this article). Data labels configured to use an ad hoc calculation have a link to a trend.

Jump to: Options for Configuring a Data Label Component

The diagram below shows a configured data label on a grid, in Studio mode.

Value:	The data displayed in the data label.
Decimals:	Decimal points for the data.
Units Location:	If there is a unit configured for a tag (or an attribute value that uses a tag with a unit), then this can be displayed as a prefix or a suffix to the value.
Style:	The label style (options may vary). If you are a Style Administrator, you can add a new Data Label style.

Hover over the Data label to read the tooltip:

• Open Value Trend
• Open Value Detail
• Write Value

And this is how the same data label looks in run-time when you click on it (with a slightly changed value, as this is data for a different time):

Related: Using the Data Label in display mode, Adding a new Data Label style

 

---

Choosing a Value for the Data Label

There are two ways you can assign a value to a data label:

• Drop an attribute or a tag onto the page: Tutorial 1.
• Drop a data label onto the page, and configure it: Tutorial 2.

We’ll explore these two methods in the following tutorials.

---

Tutorial 1: Dragging Data onto a Page

If you're unfamiliar with the process of building pages, read the article Building an Explorer Page.

This is a quick way to add a data label to a page.

Read about dragging tags and attributes onto a page: Tag Search and Hierarchy Navigation

Note: Before you start the tutorial, prepare a page in Studio.

Note: This configuration uses the Sample Data table and datasets that can be optionally made available during initial installation and setup. If you don't have access to this data, you will need to adjust the configuration to suit your data at your site.

We’re going to search for an attribute and a tag to drop onto two separate grids on the page.

If you don't have access to the training environment, search for attributes or tags within your own environment to follow this exercise.

1. Search for Entity: Search for Herbert in the P2 Corporate hierarchy.

2. Click the Entity: This opens the Attributes Panel.

3. Drag an Attribute Onto the Page: Locate the Choke!CurrentPosition attribute, in the Gas Producing Well template, and drag it onto a grid cell.

4. Search for a Tag: Search for the LowLimit tag.

5. Drag the Tag Onto the Page: Locate the LowLimit tag from the search results, and drag it onto a grid cell.

 

Your data label is ready. Tutorial 2 has instructions for configuring Decimals and Style (see steps 3 and 4).

Help: For help with tag search and hierarchy search and navigation, read Tag Search and Hierarchy Navigation, or watch this short video, where we search for a tag to drop on the page, and then search for an attribute to drop on the page.

---

Tutorial 2: Configuring a Data Label Component

In this tutorial, we'll drop a data label component onto a page, and then configure it to show data.

Note: Before you start the tutorial, prepare a page in Studio. Or use the same page that you used in Tutorial 1.

1. Add a Data Label: Drag and drop a Data Label component onto a grid cell. The Data Label is in the Display group.

In this example, we'll configure the data label to show a column from a dataset.

Note that there are other data options available. See: Options for Configuring a Data Label Component.

Follow the instructions in the Data Selector article, in the section: Using Dataset Data.

• Dataset Query: OilDowntimeByReason
• Filter Column: DowntimeReason
• Filter Value: No Truck
• Value Column: SumDowntimeHours
• EndDate: 04/30/2016
• Entities List: Brumby, Big Red, Archer
• StartDate: 04/01/2016

Read Supplementary: Dataset Query Syntax to see how the OilDowntimeByReason query looks in Server.

3. Configure the Decimals: We're going to configure to three decimal places.

Note: If decimal places are un-configured, the default is 2. If the data comes from a tag, and this has a configured decimal value, then this overrides the default.

Follow the instructions in the Data Selector article, in the section: Using Dataset Data.

4. Update the Style: The data label has a default style. To choose another style, click the Style drop-down list, and click on the style you want.

That's all - your data label is configured.

 

---

Tutorial 3: Configuring a Templated Calculation

In this tutorial, we'll drop a data label component onto a page, and then configure it to show data using a templated calculation. We'll also add an entity selector, for updating the Entity Context in the data label's calculation.

Note that there are other data options available. See: Options for Configuring a Data Label Component.

Note: Before you start the tutorial, prepare a page in Studio. Or use the same page that you used in Tutorials 1 and 2.

1. Add an Entity Selector: Drag and drop an Entity Selector component onto a grid cell.

2. Configure the Entity Selector:

• Select Mode: Single
• Selected Entity: Selected Entity
• Hierarchy Name (Hierarchy): Test Time Series Hierarchy
• Template Filter (Text): Oil Producing Well

3. Add a Data Label: Drag and drop a Data Label component onto a grid cell. The Data Label is in the Display group.

4. Configure the Data: In this example, we'll configure the data label to show a templated calculation value. This is an Ad Hoc Calculation which uses an entity variable.

Follow the instructions in the Data Selector article, in the section: Using Adhoc Calculation Data.

In the Value edit box, click and select the Ad Hoc Calculation option.

In the Ad Hoc Calulation editor, configure the calculation:

• Calculation: Type {entity[Oil Producing Well]:Tubing Head Pressure!Actual} * 2
• Sample Method: Select PageSampleMethod from the variables drop-down list
• Sample Interval: Select PageSampleInterval from the variables drop-down list
• Time: Select endTime from the variables drop-down list
• Item: Select Value from the drop-down list
• Entity Context: Select selectedEntity from the variables drop-down list

Note that the entity keyword has been used in the calculation. This is set by the Entity Context variable.

Try out the New Component

First, let's see what data is being used in the calculation.

Each template calculation uses the entity keyword, followed by a template name and an attribute value. This is then incorporated in the calculation.

• entity: the entity selected from the entity selector on the page.
• Template: [Oil Producing Well]
• Attribute Value: Tubing Head Pressure!Actual

The keyword entity is substituted by the value of the chosen Entity Context variable, during run-time.

In this tutorial, we've selected selectedEntity for our Entity Context.

This variable is updated when the end user selects an entity from the entity selector on the page. The selected entity's attribute value is used in the calculation.

Note that we have already filtered the entity selector to use entities with the Oil Producing Well template, which means that any entity you click will work for the calculation.

• Click the Preview button on the Studio toolbar to see what your page will look like in run-time.
• Click an entity in the entity selector (for example, Earl).
• Now click another entity (for example, Beardy).

Note how the data updates when you select a different entity from the entity selector.

 

---

Options for Configuring a Data Label Component

There are five separate categories of data that you can select for your data label Value. Likewise, you can configure Decimals to use any of the five categories.

Here is the full reference (including the categories already covered in this tutorial) to the different data categories you can choose, for either of these properties of the data label component.

Important Note: You can tab through the different data categories, to configure them. The one that is selected when you save the page remains the configured option. Any other configurations will be lost.

Design Mode			Run Mode
Select a Data Category	See How	The Configured Data Label's Value	In Run Mode, Click then Hover over the Data Label
Dataset Column: Configure your data label's Value to use a column from a dataset.	Using Dataset Data
Ad hoc Calculation: Configure your data label's Value to use an ad hoc calculation.	Using Ad hoc Calculation Data
Attribute: Configure your data label's Value to use an attribute.	Using Attribute Data
Tag: Configure your data label's Value to use a tag.	Using Tag Data
Value: Configure your data label's Value to use a value.	Using Value Data

 

---

Supplementary: Dataset Query Syntax

This is the syntax of the query on P2 Server, that is used in Tutorial 2: OilDowntimeByReason.

select sum(downtimehours) as SumDowntimeHours, 
            downtimereason
       from sampledata
      where startdate between PARAM(StartDate, datetime) and PARAM(EndDate, datetime)
        and entity in (PARAMS(EntitiesList, entity))
      group by downtimereason

 

For more information, read this Server article on how to write a dataset query.

 

---

Release History

• Data Label 4.4.5 (this release):
  • The Ad Hoc Calculation editor has an additional option, for configuring an entity variable, called Entity Context. This article contains a tutorial showing how to use Entity Context for configuring templated calculations.
  • Tags can have units configured and stored in P2 Server. These can be displayed in the Data Label, using the new Units Location property.
  • Tag decimals are configured and stored in P2 Server, which means they don't need to be configured for the component.

• Data Label 4.4
• Data Label 4.3.2