Gauge

This article applies to versions 4.4.2 and later of IFS OI Explorer. For more, see Release History.

Overview

The gauge is used for displaying rates or speeds against defined limits, called alarm thresholds.

The component changes in appearance when limits/alarm thresholds are exceeded.

The measured value and any of the limits can be fixed or variable, using tags, attribute values, dataset values or a fixed or variable value defined in Studio.

For example, you can configure a gauge to compare the actual value of the selected well's flowrate against limits defined for that well, or against tags that contain fixed values for the various limits.

Related: Pressure Meter, Level Meter, Temperature Meter, Using the Process Controls for users in display mode, Styling the Gauge

---

Properties of the Gauge

This section describes what needs to be configured in the Gauge, in three main sections:

• Minimum, Maximum and Limit Thresholds
• Measured Data
• Appearance

1. Limits Set limits from Minimum to Low through to High High and finishing with a Maximum value (following the direction of the dotted arrow). 2. Measured Data Configure the data to measure against the different thresholds. 3. Appearance This section has a number of options for configuring the gauge's appearance in Display Mode. 4. Position in Precision Layout This section is available if the component is on a Precision Layout. 5. Position in Grid Layout This section is available if the component is on a Grid Layout.

As well as defining the measured values and limits, you can define a label and units, and you can configure whether to show the alarm indicator and the limits.

Minimum, Maximum and Limits

Choose values that range from low to high, using the Data Selector for each limit in the property panel.

There are five separate categories of data that you can select for the minimum, the maximum and for each limit: Dataset Column, Ad hoc Calulation, Attribute, Tag, and Value.

Measured Data

Use the Data Selector to configure the data to measure. There are five separate categories of data that you can choose from: Dataset Column, Ad hoc Calulation, Attribute, Tag, and Value.

Appearance

Each of the configuration options can be selected from the five different data categories: Dataset Column, Ad hoc Calulation, Attribute, Tag, and Value, using the Data Selector.

To simplify the explanation, we'll just look at using fixed values.

Label Text: Type a label for the component, which appears on the page in display mode. This should describe the rate you are measuring.

Units Text: Type the unit of measure here. In display mode, the unit of measure (for example, cubic m/s) is displayed next to the value.

Decimals: Type in an integer for the number of decimal places for the measured value.

Confidence Threshold: The confidence value of the measured data is measured against this threshold. Both are percentage values. If the confidence value is below the threshold, the Low Confidence Data Indicator appears in display mode.

Show Value: Select this option (set to true) if you want to the measured value and label displayed on the control.

Show Alarm Indicator: Select this option (set to true) if you want alarm indicators on the control.

Show Limits on Hover: Select this option (set to true) if you want limits to appear when the user hovers the mouse over the gauge.

Style: The style you want to apply to the Gauge component. If you are a Style Administrator, you can add a new Gauge style.

The Gauge in Display Mode

The gauge's appearance is partially based on the configured in the design mode, and partially based on the measured data and the alarm limits.

1. Low Confidence Data Indicator Here, the measured data's confidence is lower than the configured confidence threshold for the gauge component. 2. Alarm Indicator This particular alarm indicator is a triangle, because the measured data is in the High High band. 3. Limit Values The values for Minimum, Maximum and the different limits can be seen when you hover over the gauge (if Show Limits on Hover is selected). 4. Segments Background colours mark the different segments between the thresholds. High High in the first segment, matches Low Low at the last segment. High matches Low, and in the style used here, Outside Target matches the Target band. As shown in this example, the band (High)containing the Measured Value is coloured to match the Alarm Indicator. 5. The measured value position The measured value is depicted by a needle, positioned within its segment, according to its value. 6. Measured value The measured value. The decimal points are configured in the Decimals property. 7. Units This is the text in Units Text. 8. Label This is the text in Label Text.

Alarm Indicator

The Alarm Indicator only appears if Show Alarm Indicator is selected.

The Alarm Indicator is a coloured symbol representing the current state of the measurement, such as the blue triangle on the screenshot below.

Note: The size, colour and position of the Alarm Indicator may vary, depending on the Gauge's selected Style.

Hover over the alarm indicator to see the tooltip.

The symbol depends on what segment the measured value falls into. From segments left to right, here is the key:

	Band	Alarm Indicator	Symbol	Tooltip
	High High	Red Triangle		High High Alarm
	High	Yellow Square		High Alarm
	Outside Target	Blue Triangle		Outside Target
	Target	No Indicator
	Low	Yellow Square		Low Alarm
	Low Low	Red Triangle		Low Low Alarm

Data Indicator

The Data Indicator is a symbol that appears alongside the gauge if there is either Low Confidence Data or No Data.

The data indicator appears in a square background, as a cross if there is No Data, or as an exclamation mark if there is Low Confidence Data.

Note: The size, colours and positioning of the Data Indicator may vary, depending on the gauge's Style.

Sometimes there is no data to measure, for example, if the gauge is configured to measure the actual flowrate of the selected entity, and this attribute value is missing from the selected entity. In this instance, the data indicator shows the No Data symbol, and three Xs mark the place where the value would normally appear.

If the measured data's confidence is lower than the gauge's defined confidence threshold, the data indicator shows the Low Confidence symbol. Data confidence threshold is measured as a percentage.

Note: You need to select a Confidence Threshold in design mode, for this to work.

---

Tutorial: Gauge Updating with Selected Entity

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

Watch the video below to see how the gauge's appearance changes as the value is updated.

Note how the value updates after the date/time toggle is selected. When the entities Hottes and Derby are selected, the No Data indicator appears. This is because neither of these entities have the attribute used in the measured data.

The tutorial describes how to configure the gauge shown in the video.

Refer to the Gauge page in the Tutorials workspace, if you have access to this.

There are four steps in the tutorial:

• Step 1. Prepare the new tutorial page.
• Step 2. Update the selectedEntity default value.
• Step 3. Add hierarchy, labels and a current date/time toggle.
• Step 4. Add and configure a gauge.

Note: If you have already completed any of the tutorials listed below, you can skip the first three steps and go straight to Step 4.

• Pressure Meter tutorial
• Level Meter tutorial
• Temperature Meter tutorial

 

Step 1. Prepare the Tutorial Page

Note: Before you start the tutorial, prepare a precision layout page in Studio and save it with a suitable name, such as Gauge.

 

Step 2. Update the selectedEntity Default Value

In this step we're going to assign a value to the selectedEntity page default.

Related: See how to add and configure a Default Value.

1. Open the Default Values panel.

2. Type Beardy in the selectedEntity value text box.

 

Step 3. Add Hierarchy, Labels and a Current Date/Time Toggle

The hierarchy is for selecting a new entity, and the current date/time toggle is to refresh the data on the page. The labels are just for providing context to the page and can be left out, if you prefer.

Related: Hierarchy, Current Date/Time Toggle, Text Label.

1. Drag a Hierarchy onto the page. Resize it to fit the full height of the page.

2. In the Hierarchy component's property panel, select P2 Corporate from the drop-down list of available hierarchies for the Hierarchy Name.

3. Drag a Current Date/Time Toggle onto the page.

4. In the Current Date/Time Toggle component's property panel, type 3 in the Refresh Rate edit box, so that the page's endTime default is refreshed every three seconds.

5. Drag a Text Label onto the page, to the right of the hierarchy. Widen the label slightly.

6. In the Text Label component's property panel, add data to the label's Content: the selectedEntity variable.

7. Drag another Text Label onto the page, above the current date/time toggle. Widen the label slightly.

8. In the Text Label component's property panel, type Date/Time Toggle in the Content.

 

Step 4. Add and Configure a Gauge

If you have already completed any of the tutorials listed below, open that tutorial page (for example, Pressure Meter), and save a copy to a new page called Gauge.

• Pressure Meter tutorial
• Level Meter tutorial
• Temperature Meter tutorial

Related: See how to select data for a component using the Data Selector.

1. Drag a Gauge component to the right of the hierarchy. (If you are using the saved copy of the Pressure Meter/Level Meter/Temperature Meter page, first remove the Pressure Meter/Level Meter/Temperature Meter component, then move the date/time toggle and its label over to the right, to provide more space for the Gauge component.)

2. Click and drag the edges to widen and lengthen the component.

3. Click on the Gauge so that the properties appear in the component's panel on the right.

4. Assign tags to the maximum, limits and the minimum of the component. For each separate property, use the Data Selector to select Tag Data.

a) Minimum: Click the drop-down list, select tag MinValue. Click the drop-down list again to close it. b) Low Low Limit: Click the drop-down list, select tag LowLowLimit. Click the drop-down list again to close it. c) Low Limit: Click the drop-down list, select tag LowLimit. Click the drop-down list again to close it. d) Outside Target (lower): Click the drop-down list, select tag TargetRangeLow. Click the drop-down list again to close it. e) Outside Target (upper): Click the drop-down list, select tag TargetRangeHigh. Click the drop-down list again to close it. f) High Limit: Click the drop-down list, select tag HighLimit. Click the drop-down list again to close it. g) High High Limit: Click the drop-down list, select tag HighHighLimit. Click the drop-down list again to close it. h) Maximum: Click the drop-down list, select tag MaxValue. Click the drop-down list again to close it.

 

5. Now use the Data Selector to select the selectedEntity's Oil Flowrate!Current Flowrate attribute value, from the Oil Producing Well template, to the measured value's Attribute Data.

This assigns the selectedEntity's Oil Flowrate!Current Flowrate attribute value to the measured value: selectedEntity[Oil Producing Well]:Oil Flowrate!Current Flowrate. selectedEntity is a variable, which the end-user can change by selecting different entities from the hierarchy on the page.

6. Configure the appearance of the gauge. For each separate property, use the Data Selector to select Value Data.

• Label Text: Type in a Value of Oil Flowrate.
• Units Text: Type in a Value of Cubic m/s.
• Decimals: Type in a Value of 2.
• Confidence Threshold: Select the variable Value of confidenceThreshold (this is a page default) .
• Show Value: Select the Value to set it to true.
• Show Alarm Indicator: Select the Value to set it to true.
• Show Limits on Hover: Select the Value to set it to true.

You now have a functioning gauge.

 

Try out the New Component

• Click the Preview button on the Studio toolbar to see what your page will look like in display mode.
• Select the current date/time toggle so that the data can refresh at the configured refresh rate.
• Select a different entity from the hierarchy, to see how the flowrate changes.

Note how the data updates every three seconds, because of the current date/time toggle.

---

Release History

• Gauge 4.4.1