Status Tile (4.4.4)

This article applies to versions 4.4.4-4.5.3 of P2 Explorer. For the latest, see Status Tile.

Overview

The Status Tile is a plain rectangular shape which conveys four key pieces of information:

  • Title: A title identifying what data the status tile is displaying
  • Value: The current value of the configured data
  • Description: A description supplying more detail on what data the tile is representing
  • Status: The colour of the tile, representing whether the status tile's value is below, above, or equal to the tile's defined limit

The status tile also has a tooltip showing the data that's been displayed, as well as its current value, and can also contain a hyperlink which you can configure to open a page, a URL, or a trend.

Typically, a whole set of related status tiles are grouped together, representing key overview information. If there is a configured hyperlink, the user can click on a status tile to get more detail.

Related: Using the Status Tile in display mode, Adding a Status Tile style


What is the Current Status?

A user can tell immediately whether the value is over, under or equal to the defined limit, just by the colour of the status tile.

Note that the colours here are for the base style; these may vary if a different style is used.

Value Under Limit Value Equal to Limit Value Over Limit Value Unknown
The status tile is BLUE. The status tile is GREEN. The status tile is RED. The status tile is GREY.

In the example below, Gas Production Costs are below budget (value is below limit), while Oil and NGL both have costs above their respective budgets (value exceeds limit).

If there are no available values, the status tiles are coloured in grey.


Status Tile Properties

This section describes the properties of the Status Tile component.

Title: Select a title for the status tile (see Title, Values, Decimals and Limits).
Value: Select the status tile's value data (see Title, Values, Decimals and Limits).
Decimals: Select the decimal places for the status tile's displayed value (see Title, Values, Decimals and Limits).
Limit: Select the status tile's limit (see Title, Values, Decimals and Limits).
Description: Provide a meaningful description to supplement the title's information.
Link Action: The status tile incorporates an optional hyperlink feature. Depending on what type you select, there are different properties to configure. See Link Action and Variable Mapping for details.
Type Select the type of hyperlink you want:
  Open Page Specify a Workspace Name, Page Name.
  Open Trend Specify a Workspace Name, Trend Name.
  New Trend No further details are required; Explorer opens a new, blank trend when a user clicks this type of hyperlink.
  Open URL Specify the URL. You can also specify a Header. Unless the address begins with https the URL opens in a new tab in your web browser, regardless of the selected Tab Type.  
  --Select a Type-- Select this if you choose not to have a hyperlink.
Workspace Name/URL For Open Page and Open Trend hyperlink types, specify in which workspace the page or trend exists; this is because page names/trend names can be duplicated across different workspaces. For a URL hyperlink, specify a URL address; if the address starts with http, then it will open in a new browser tab; if the address starts with https the URL will open in Explorer.  
Trend Name/Page Name/Header For an Open Page/ Open Trend hyperlink, specify which page/trend to open. For a URL hyperlink, optionally specify a header.  
Tab Type This specifies where the page, trend or URL is opened. For Explorer displays (trends and pages) the options are: New Explorer Tab and Same Explorer Tab. For URLs, the options are New Explorer Tab, Same Explorer Tab and New Browser Tab.

Note, for URLs: Unless the address begins with https the URL opens in a new tab in your web browser, regardless of the selected Tab Type.

Variable Mapping Use Variable Mapping to pass variables from the current Explorer page to the page, trend or URL you are linking to.
  Click Add to add a new variable mapping.
  Each variable mapping needs a source (coming from the page you are on) and a target (for the trend/ page/ URL you are opening). The source and the target should have matching data types. See the tutorial for an example.
 
Source This can be a variable (such as a Combo Box's Selected Option, for example), or you can type in text or number (select Variable, Text, Number, List, Entity, or Entities as appropriate, from the drop-down list to the left of Source). You can also pass in a Yes/No value or a datetime value.
Target Type in the variable name for the target page/ trend, or a parameter name for the target URL. This must be an accurate match (case-sensitive). Read more about the names of common variables on pages and trends.
Remove Click Remove to remove the variable mapping. 
Style: You can change the style of the hyperlink font and alignment by selecting a different style from the drop-down list. If you are a Style Administrator, you can add a new Status Tile style.

Title, Value, Decimals and Limit

Configure the Title, Value, its Decimal places and a Limit, using the Data Selector for each limit in the property panel.

There are five separate data categories that you can choose from, for each of these properties: Dataset, Attribute, Ad Hoc Calculation, Tag or Value.


Tutorial: Status Tiles Allowing Entity Selections

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

In this tutorial, we're going to drop a status tile onto a page, configure it to use data, and then make two copies. The three status tiles will all use the same dataset for their respective values and limits, and we'll add a Hierarchy component so that the user can change the entity (region), controlling what is shown.

We'll add a hyperlink to the first tile, to open a new trend. This trend will show the Oil Production attribute of the selected entity.

Related: Link Action and Variable Mapping

Watch the video below to see how the status tiles change in appearance as the regions are selected from the hierarchy. The colour changes are immediately apparent, as values and limits are update for the different periods.

Note how the user opens a new trend by clicking on the hyperlink on the first status tile.

The tutorial describes how to configure the status tiles shown in the video.

Refer to the Status Tiles Tutorial page in the Tutorials workspace, if you have access to this.

There are five steps in the tutorial:

  • Step 1. Prepare the new tutorial page in Grid Layout, and configure the layout.
  • Step 2. Add a default value.
  • Step 3. Add and configure a Hierarchy.
  • Step 4. Add and configure a Status Tile with Hyperlink.
  • Step 5. Make two copies of the status tile, and adjust the configuration of each.

Step 1. Prepare the Tutorial Page

Note: Before you start the tutorial, prepare a page in Studio. Save it to your workspace (My Workspace), giving it a suitable name, such as Status Tiles Tutorial.

1. Configure the grid layout to have two columns and two rows. Allocate a Column Spacing and Row Spacing of 30, each. Resize the first column to 25* and the second to 75*. Resize the first row to 80* and the second to 20*.

2. Drop a second Grid Layout onto the top right cell of the base grid layout. Give this two columns and three rows, with a Row Spacing of 20.

This is how the page should look at this stage:

 

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 Far North Coast in the selectedEntity value text box.

 

Step 3. Drop a Hierarchy onto a grid cell

Related: Hierarchy.

1. Drop a Hierarchy component onto the top left grid cell of the base grid layout, as shown. The Hierarchy component is in the Hierarchy timeicon_sm group.

2. Choose a hierarchy from the drop-down list: P2 Corporate.

Note: The default Selected Entity for the hierarchy component is selectedEntity, so this will use the selectedEntity value you defined in the previous step: Far North Coast.

Step 4. Add and configure a status tile

1. Drop a Status Tile onto the top left grid cell of the secondary grid layout, as shown. The Status Tile is in the Display Display group icon group.

2. Configure the status tile.

a) Title: Click the drop-down list, then use the Data Selector to select Value Data. Type in: Oil Costs.
b) Value: Click the drop-down list, then use the Data Selector to select Dataset Data.

  • Dataset Query: ProductionDataByLevel
  • Dataset Parameters, endDate: select the endTime variable, level: type Region as a fixed text value, startDate: select the startTime variable.
  • Filter Column: Select Asset column
  • Filter Value: Type in the selectedEntity variable (controlled by the Hierarchy component selection)
  • Value Column: Select OilActualSum column
c) Decimals: Click the drop-down list, then use the Data Selector to select Value Data. Type in: 0.
b) Limit: Click the drop-down list, then use the Data Selector to select Dataset Data.

  • Dataset Query: ProductionDataByLevel
  • Dataset Parameters, endDate: Select the endTime variable, level: type Region as a fixed text value, startDate: select the startTime variable.
  • Filter Column: Select Asset column
  • Filter Value: Select selectedEntity variable (controlled by the Hierarchy component selection)
  • Value Column: Select OilPlannedSum column
e) Description: Type in the following description: Oil Actual VS Planned
f) Link Action: Configure a link to a new trend:

  • Type: Select New Trend from the drop-down list
  • Tab Type: Select Options from the first drop-down list, and New Explorer Tab from the second
g) Variable Mapping: Add Variable Mapping (* see note below):

  • Click Add to add the first variable:
  • Select Variable from the first drop-down list
  • Source: Select selectedEntity from the drop-down list
  • Target: Type selectedEntities.
  • Click Add to add the second variable:
  • Select Text from the first drop-down list
  • Source: Type Oil Production.
  • Target: Type attributes.
h) Style: Select the Tutorial Style 1 from the drop-down list. Or select a different style, if this one is unavailable.

* Note: Read more about parameters that can be used when opening a trend, in this Trend URL parameters topic. These parameters can be defined as the Target in Variable Mapping

Try out the New Component

  • Click the Preview preview button on the Studio toolbar to see what your page will look like in run-time.
  • Far North Coast is already selected on the Hierarchy, because of the selectedEntity default variable.

Note how the Status Tile shows a value. It is coloured in blue, indicating the value (oil costs) is lower than the planned amount for this period (colours depend on the status tile's style: for the style used in this tutorial, green indicates equal values, blue indicates a value under the limit, and red indicates a value that is over the limit).

Step 5. Make two copies of the status tile

Status tiles work well in sets, so we're going to add two more. We want these to use the same dataset query, parameter and filter value as the first one. The only difference is that one will use WaterActualSum and WaterPlannedSum, while the other will use GasActualSum and GasPlannedSum for their respective values and limits. We'll also change the Title and Description of each.

Read more: Cut/Copy/Paste

1. Copy (Ctrl+C) the original status tile.

2. First copy: Click the grid cell directly below the original status tile and Paste (Ctrl+V).

3. Second copy: Click the grid cell directly below the new status tile and Paste (Ctrl+V).

4. Adjust the first copied status tile to show Water Costs:

  • a. Title: Click the drop-down list to open. Type Water Costs.
  • b. Value: Click the drop-down list to open. Select WaterActualSum from the Value Column drop-down list.
  • c. Limit: Click the drop-down list to open. Select WaterPlannedSum from the Value Column drop-down list.
  • d. Description: Type Water Actual VS Planned in the description text.

5. Adjust the second copied status tile to show Gas Costs:

  • a. Title: Click the drop-down list to open. Type Gas Costs.
  • b. Value: Click the drop-down list to open. Select GasActualSum from the Value Column drop-down list.
  • c. Limit: Click the drop-down list to open. Select GasPlannedSum from the Value Column drop-down list.
  • d. Description: Type Gas Actual VS Planned in the description text.

Try out the New Component

  • Click the Preview preview button on the Studio toolbar to see what your page will look like in run-time.
  • Select some of the other regions from the hierarchy, such as: Central West, Far North and Barossa.
  • Click on a region that has no data, such as Murray. The status tiles here are coloured in grey.
  • Now click on the first status tile to open the new trend. Note how the Oil Production attribute of the selected entity displays in the trend.

Note how the Status Tiles all show a value. Note the colours indicating whether production costs are equal to, above or below planned costs for Oil, Water, or Gas. Hover over each tile to get the full value, including decimals values (if any).

Comments are closed