{"id":19024,"date":"2016-08-26T13:57:17","date_gmt":"2016-08-26T05:57:17","guid":{"rendered":"http:\/\/localhost\/help\/?page_id=19024"},"modified":"2017-12-15T11:10:18","modified_gmt":"2017-12-15T03:10:18","slug":"default-value-4-4-2","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/p2-explorer\/explorer-studio\/default-value\/default-value-4-4-2\/","title":{"rendered":"Default Values (4.4.2)"},"content":{"rendered":"\n

This article applies to versions 4.4.2-4.4.6 of P2 Explorer. For the latest, see Default Values<\/a>.<\/p>\n

Overview<\/h2>\n
\"\"<\/a>

Without Default Value<\/p><\/div>\n

You can assign a default value to any variable on an Explorer page.<\/p>\n

These defaults set the context of a page, and give it a finished look at run-time.<\/p>\n

\"\"<\/a>

With a Default Value<\/p><\/div>\n

For example, a Combo Box<\/a> should have a default value assigned to its Selected Option<\/em> variable, otherwise there is no selection when the page opens, and the user has to make the selection. (Unless the page is opened via hyperlink, and the variable is set by variable mapping<\/em>.)<\/p>\n

<\/a>

Some Default Values<\/p><\/div>\n

Default values can also be used for dataset variables, to ensure that queries run with useful variables as soon as a page is opened.<\/p>\n

Trend Default Values<\/h3>\n

Trends also have default values, but these have been predefined and cannot be changed. For more information on trend default values, refer to the Variable Parameters<\/a> section of Link to Trend via a URL<\/a>.<\/p>\n

Overriding Default Values<\/h3>\n

If you open a page or trend from another Explorer page using hyperlinks<\/a>, you can pass values from the calling page, using Variable Mapping<\/em>. If a value is mapped to a variable in this way, the default value is overridden.<\/p>\n

For example, if you have page with a default period of November 2013<\/em>, you can open the same page via a hyperlink, assigning that page's selected period, May 2015<\/em>.<\/p>\n

For a full description of the default value<\/em> properties, refer to the comprehensive reference<\/a> at the end of this article.<\/p>\n

Page Default Values<\/h3>\n

When you add a new page, several page default pairs (Variable Name and Default Value) are added as Page Defaults.<\/p>\n\n\n\n
\n\n\n\n\n\n\n\n
selectedEntity<\/strong><\/p>\n

The Default Value is not supplied with the variable here. The first time you drag an attribute or attribute value onto the page, the entity for that attribute is inserted here as the default value.<\/p>\n<\/td>\n<\/tr>\n

pageSampleMethod<\/strong><\/p>\n

This is applied to the Sample Method<\/a> of any time series data added to the page. The values you can enter here are:<\/p>\n

pageSampleInterval<\/strong><\/p>\n

This is applied to the Sample Interval<\/a> of any time series data added to the page.<\/p>\n<\/td>\n<\/tr>\n

startTime<\/strong><\/p>\n

This is applied to the Start Time<\/a> (where there is a time range) of any time series data added to the page. You can also use this variable for a dataset query Datetime parameter.<\/p>\n

The default Datetime value for startTime<\/em> is the day before current date<\/em> at 12:00:00 AM, and updates when the page is refreshed unless you edit the default value<\/em>.<\/p>\n

If you edit the page default for startTime<\/em>, it updates to this date\/time when the page is refreshed.<\/p>\n

Some of the date\/time components can refresh the startTime, for example the Date Picker.<\/p>\n<\/td>\n<\/tr>\n

endTime<\/strong><\/p>\n

This is applied to the End Time<\/a> of any time series data added to the page. You can also use this variable for a dataset query Datetime parameter.<\/p>\n

The default Datetime value for endTime<\/em> is day current date<\/em> at 12:00:00 AM, and updates when the page is refreshed unless you edit the default value<\/em>.<\/p>\n

If you edit the page default for endTime<\/em>, it updates to this date\/time when the page is refreshed.<\/p>\n

Some of the date\/time components can refresh the endTime, for example the Date Picker.<\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n

\n\n\n\n\n
<\/a><\/td>\n<\/tr>\n
confidenceThreshold<\/strong><\/p>\n

This is typically used as the Confidence Threshold<\/em> variable for meters that have a confidence threshold, such as the Gauge, the Pressure Meter, the Temperature Meter, and the Level Meter.<\/p>\n

For components that use Confidence Threshold<\/em>, a warning is shown if a value's confidence is below<\/em> the threshold.<\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

These default values are commonly used by various components, and related to tags and attributes. When you add new components to the page, these defaults are assigned to the relevant properties, allowing for consistency within the page and across various pages. (Note<\/strong> that if you change a default value for any of the page variables, you lose this consistency across pages).<\/p>\n

For example, when you drop an attribute onto the page, its Sample Method, Sample Interval<\/em> and Time<\/em> properties use the page default variables of pageSampleMethod, pageSampleInterval<\/em> and endTime<\/em>, respectively.<\/p>\n

Similarly, when you configure a chart to use tag data, the page defaults (pageSampleMethod, pageSampleInterval, startTime<\/em> and endTime<\/em>) are applied before you even define which tags to use.<\/p>\n\n\n\n\n
Example 1<\/strong>: Sample Method, Sample Interval and End Time for a data label's attribute.<\/td>\nExample 2<\/strong>: Sample Method, Sample Interval, Start Time and End Time for a data label's tag.<\/td>\n <\/td>\n<\/tr>\n
\n\n <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Updating Default Values<\/h3>\n

You can open the Default Values<\/em> panel and update the Variable Name<\/em> or the Default Value<\/em> for any default. See how this is done, in step 2 of the Tutorial<\/a>.<\/p>\n

Note: Check where the defaults are already being used, before editing.<\/p>\n

 <\/p>\n

\n

Quick Start<\/h2>\n

This section explains how to set up a default value in two steps.<\/p>\n

Open Default Values<\/p>\n

The default value<\/em> panel lists all of the defaults for a page. You can add, remove or change these here.<\/p>\n

Click the Defaults<\/strong> button on the Configuration<\/em> tab group of the Studio<\/strong> ribbon, to open the Default Values<\/em> panel. To close the Defaults Panel<\/em> click any button on the Configuration<\/em> tab group.<\/p>\n

<\/a><\/p>\n

What to Add<\/p>\n

Find out what variables you have on the page, and then assign each of these a default value<\/em>. You need to match the variable name and type (for example, Text<\/em>), and the associated value should come from a set of options for that variable (for example, choose 'Jan' for variable selectedMonth<\/em>).<\/p>\n

Type in the variable name, select a type, and then type in the default value.<\/p>\n

 <\/p>\n

\n

Tutorial: Adding a Default Value<\/h2>\n

In this tutorial, we're going to add Option Links, and then set a Default Value for its Selected Option<\/em>.<\/p>\n

Note: <\/strong>Before you start the tutorial, prepare a page in Studio.<\/a><\/p>\n

Step 1. Add and Configure Option Links<\/strong><\/p>\n

Related: See how to add and configure Option Links<\/a>.<\/p>\n

1. Drag an Option Links component onto the a grid cell.<\/p>\n

2. Add the following Option Values<\/strong>: Q1, Q2, Q3, Q4, using Value<\/em> \"\" data.<\/p>\n

\"\"<\/a><\/p>\n

3. Type selectedQuarter<\/em> in the Selected Option<\/strong> edit box.<\/p>\n

\"\"<\/a><\/p>\n

This is how your Option Links should look in Studio.<\/p>\n

\"\"<\/a><\/p>\n

Note<\/strong> how none of the options is selected yet (there is no underlined option). We're going to change that in the next step, by adding a default value.<\/p>\n

Step 2. Add a Default Value<\/strong><\/p>\n

1. Click the Defaults<\/strong> button on the Configuration<\/em> tab group of the Studio<\/strong> ribbon, to open the Default Values<\/em> panel.<\/p>\n

2. In the Default Values<\/em> panel, click Add<\/strong>, scroll to the bottom of the default values list, then type a variable name, selectedQuarter<\/strong>, into the edit box, keep the Type<\/em> as Text<\/strong>, and type a default value, Q2<\/strong>, in the second edit box.<\/p>\n

Note<\/strong>: You can edit any of the defaults, by typing a new value in the applicable edit box of any default (the variable name<\/em> and\/or the default value<\/em>).<\/p>\n

<\/a><\/p>\n

3. Now look at the option links in preview mode.<\/p>\n

\"\"<\/a><\/p>\n

Note how Q2<\/em> is selected (underlined) in the Option Links. This will be the default value, each time a user opens this page during run-time.<\/p>\n

 <\/p>\n

\n

Comprehensive Reference<\/h2>\n

This section describes the properties of the Default Value panel.<\/p>\n

1. Click the Defaults<\/strong> button on the Configuration<\/em> tab group of the Studio<\/strong> ribbon, to open the Default Values<\/em> panel. To close the Defaults Panel<\/em> click any button on the Configuration<\/em> tab group.<\/p>\n

<\/a><\/p>\n

2. Click Add<\/strong> for every default value you want to add; variables used in the Explorer page, or as dataset parameters, can be referenced here by Variable Name<\/em>.<\/p>\n

3. Type in a variable name, matching a variable used on the page.<\/p>\n

4. The default value should come from a set of valid values; for example, if you use a default value for a Combo Box<\/a>, then the default value should be one the Option Values<\/em> for that Combo Box.<\/p>\n

5. Select a type from the drop-down list. This should suit the variable's use in other components. For example, choose Number<\/em> for a variable that you will use for a threshold on the page.<\/p>\n

6. Click Remove<\/strong> next to a default value that you want to remove.<\/p>\n

<\/a><\/p>\n

Variable Types<\/h3>\n

The table below contains the different variable types you can use for default variables.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Data Type<\/strong><\/td>\nExamples of Usage<\/strong><\/td>\n<\/tr>\n
Text<\/td>\nThe Selected Option<\/em> for a Combo Box component; part of the Content<\/em> for a Text Label component.<\/td>\n<\/tr>\n
List<\/td>\nThe Option Values<\/em> or Option Names<\/em> for a Combo Box or Option Links component.<\/td>\n<\/tr>\n
Entity<\/td>\nThe Selected Entity<\/em> of a Hierarchy component; the Entity<\/em> for a Data Label component's Value<\/em> (if it is using attribute data).<\/td>\n<\/tr>\n
EntityList<\/td>\nThe Selected Entities<\/em> of a Hierarchy component (using Multiple<\/em> Select Mode); the Entities<\/em> of a Data Table component's Data<\/em> (if it is using attribute data).<\/td>\n<\/tr>\n
Template<\/td>\nThe Template<\/em> for a Data Label component's Value<\/em> (if it is using attribute data).<\/td>\n<\/tr>\n
Attribute<\/td>\nThe Attribute<\/em> for a Data Label component's Value<\/em> (if it is using attribute data).<\/td>\n<\/tr>\n
AttributeValue<\/td>\nThe Attribute Value<\/em> for a Data Label component's Value<\/em> (if it is using attribute data).<\/td>\n<\/tr>\n
Tag<\/td>\nThe Tag<\/em> for a Data Label component's Value<\/em> (if it is using tag data); the Tag<\/em> for a Level Meter component's Upper Limit<\/em> (if it is using tag data).<\/td>\n<\/tr>\n
TagList<\/td>\nThe Tags<\/em> for a Data Table's Data<\/em> component (if it is using Tag data).<\/td>\n<\/tr>\n
Calculation<\/td>\nThe Calculation<\/em> for a Data Label component's Value<\/em> (if it is using ad hoc calculation data).<\/td>\n<\/tr>\n
CalculationList<\/td>\nThe Calculations<\/em> for a Data Table component's Data<\/em> (if it is using ad hoc calculation data).<\/td>\n<\/tr>\n
Number<\/td>\nThe default selection (Selected Option<\/em>) for a Combo Box component; the Value<\/em> for a Data Label component's Value<\/em> (if it is using value data).<\/td>\n<\/tr>\n
Yes\/No<\/td>\nThe Hide Config Panel<\/em> of a Pivot Table component.<\/td>\n<\/tr>\n
Datetime<\/td>\nThe Date\/Time<\/em> of a Current Date\/Time Toggle component.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n","protected":false},"excerpt":{"rendered":"

You can assign a default value to any variable on an Explorer page. Trends have pre-defined default values.
\nDefault values affect how combo boxes, option links, date selections etc. appear when a page or trend is first opened.
\nDefault values set the context for a page or trend. A user should have access to relevant information, preferably without having to immediately change the default selections. This article is applicable to versions 4.4.2 and later of P2 Explorer<\/p>\n

Read more<\/i><\/a><\/p>\n","protected":false},"author":8,"featured_media":6863,"parent":27001,"menu_order":3,"comment_status":"open","ping_status":"closed","template":"","meta":{"footnotes":"","_members_access_role":[],"_members_access_error":""},"categories":[4],"tags":[526,437],"class_list":["post-19024","page","type-page","status-publish","has-post-thumbnail","hentry","category-explainer","tag-defaults","tag-variables","Product-ex"],"_links":{"self":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/19024","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/users\/8"}],"replies":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/comments?post=19024"}],"version-history":[{"count":0,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/19024\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/27001"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/media\/6863"}],"wp:attachment":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/media?parent=19024"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/categories?post=19024"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/tags?post=19024"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}