{"id":34311,"date":"2017-12-15T11:21:48","date_gmt":"2017-12-15T03:21:48","guid":{"rendered":"http:\/\/localhost\/help\/?page_id=34311"},"modified":"2018-10-12T16:14:46","modified_gmt":"2018-10-12T08:14:46","slug":"default-values-4-5-0","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/p2-explorer\/explorer-studio\/default-value\/default-values-4-5-0\/","title":{"rendered":"Default Values (4.5.0)"},"content":{"rendered":"\n

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

Overview<\/h2>\n

Default values set the context of a page when it is opened in Display Mode, by supplying the initial<\/em> values to the page's variables.<\/p>\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 select something.<\/p>\n

Defaults values also set the times (start time and end time) that are used on your page by various components. You can use the standard default value variables, or update these (see Page Times<\/a>).<\/p>\n\n\n\n\n\n\n
\n

Examples of components without a default value:<\/p>\n<\/td>\n

\n

Examples of those components with a default value:<\/p>\n<\/td>\n<\/tr>\n

\n

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

\n

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

\n

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

\n

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

\n

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

\n

\"\"<\/a><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Default values are also used for dataset parameter variables, to ensure that queries run with useful values as soon as a page is opened. Example:<\/strong> On page open, a query runs where 'Oil' is the default value for the selectedProduct<\/em> variable, which is used as a parameter for the dataset query.<\/p>\n

Some default values, Page Default Values<\/em>, come standard with all pages; others need to be added, as required.<\/p>\n

Related:<\/strong> Read about variables<\/a> and how these change in Display Mode, through the use of interoperative controls.<\/p>\n

Trend Default Values<\/h2>\n

Trends also have default values, but these have been predefined and cannot be changed when you save a new, blank trend. If you open a trend through a URL or using one of the links from a page (using hyperlink, hotspot, status tiles or charts), you can override the default values. 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<\/h2>\n

If you open a page or trend from another Explorer page using hyperlinks<\/a>, hotspots<\/a>, status tiles<\/a>, or charts<\/a> that have an X Axis Link Action, you can pass values from the calling page, using Variable Mapping<\/em>. If a default variable is mapped in this way, its 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

Read more about Variable Mapping<\/a> as a way of passing values to a page or trend as it opens.<\/p>\n

Defaults with Relative Values<\/h2>\n

Some defaults, such as startTime<\/strong> and endTime<\/strong>, have values that vary relative to the current time when you open the page, for example an endTime of 'yesterday', or a startTime that is always five days before the endTime. These settings, and others, are described in the Page Times<\/a> section below.<\/p>\n

Page Default Values<\/h2>\n

When you add a new page, several page defaults (with a Variable Name, Default Value, and sometimes Data Type) are inserted in the Default Values<\/strong> panel. These cannot be removed.<\/p>\n\n\n\n\n\n\n\n\n\n
\n

Variable Name<\/strong><\/p>\n<\/td>\n

\n

Default Value<\/strong><\/p>\n<\/td>\n

\n

Data Type<\/strong><\/p>\n<\/td>\n<\/tr>\n

endTime<\/a><\/td>\nthe start (12:00 AM) of the day after you create the page<\/em><\/td>\nFixed Datetime<\/td>\n<\/tr>\n
startTime<\/a><\/td>\nthe start (12:00 AM) of the day you create the page<\/em><\/td>\nFixed Datetime<\/td>\n<\/tr>\n
confidenceThreshhold<\/a><\/td>\n80<\/td>\n\u00a0<\/td>\n<\/tr>\n
pageSampleMethod<\/a><\/td>\nAverage<\/td>\n\u00a0<\/td>\n<\/tr>\n
pageSampleInterval<\/a><\/td>\n3600<\/td>\n\u00a0<\/td>\n<\/tr>\n
selectedEntity<\/a><\/td>\n-<\/td>\n\u00a0<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Note that selectedEntity<\/em> does not come with a default value.<\/p>\n

The page default values (with the exception of the selectedEntity<\/em> default) start out the same for all pages, bringing a measure of uniformity across the 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

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

The page defaults are used by many of the components. When you add a new component to the page, many of its properties have page defaults already assigned to them.<\/p>\n

For example, when you drop an attribute onto the page, this uses a data label component, whose 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.<\/p>\n\n\n\n\n
Example 1<\/strong>: Sample Method, Sample Interval<\/em> and End Time<\/em> for a data label's attribute.<\/td>\nExample 2<\/strong>: Sample Method, Sample Interval, Start Time<\/em> and End Time<\/em> for a chart's tag data.<\/td>\n <\/td>\n<\/tr>\n
\n

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

\n

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

 <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Page Times: startTime and endTime<\/h3>\n

Setting the start time and end time defaults for your page determines the data collection periods, when the page is opened, and also how date time controls will operate.<\/p>\n

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

Similarly, startTime is applied to the Start Time (where there is a time range) of any time series data added to the page, or for dataset query parameters.<\/p>\n

The date\/time components are preconfigured to use endTime and startTime (where applicable).<\/p>\n

Example:<\/em> The Date Time Range Picker uses startTime and endTime from the page defaults.<\/p>\n\n\n\n\n
The Date\/Time Range Picker is preconfigured to use the startTime and endTime page defaults.<\/td>\nThe page defaults for startTime and endTime, as they appear for a new page.<\/td>\nIn Display Mode, the Date\/Time Range Picker shows the startTime (From) and the endTime (To).<\/td>\n<\/tr>\n
\n

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

\n

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

\n

\"\"<\/a><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

There are various ways to set the start and end date and time:<\/p>\n

Automatic Page Refresh<\/strong><\/p>\n

Your page can be configured to refresh automatically. The page refresh interval can be anything from one minute to 12 hours, depending on the configuration in Design Mode.<\/p>\n

To set an automatic refresh for the page, click Defaults<\/strong> on the Studio ribbon tab to open the Default Values<\/strong> panel. Select an endTime<\/strong> of Current Datetime,<\/strong> then select a Refresh interval<\/strong> from the drop-down list.<\/p>\n

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

 <\/p>\n

Start Time Relative to the End Time<\/strong><\/p>\n

A page can be configured to have a set interval between its start time (startTime) and end time (endTime), for example 24 hours, or one week; this is useful if you want to view a seven days report, for example. Every time the endTime<\/strong> page variable updates (whether through an interoperating control such as a Date\/Time Picker, or when the page refreshes), the startTime<\/strong> updates to maintain the relative date time interval.<\/p>\n

To set startTime relative to endTime, click Defaults<\/strong> on the Studio ribbon tab to open the Default Values<\/strong> panel. Select a startTime<\/strong> of Relative Datetime,<\/strong> then capture minutes in the Minutes before endTime<\/strong> edit box.<\/p>\n

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

Start Time or End Time as Text<\/strong><\/p>\n

You can also set the start time and end time as Text times. These could be relative to the current date and time (for example, \u2018Yesterday\u2019), or they could be fixed date times, for example \u2018start of 2016\u2019.<\/p>\n

To set an end time as text, click Defaults<\/strong> on the Studio ribbon tab to open the Default Values<\/strong> panel. Select an endTime<\/strong> of Text<\/strong>, then type in a date string, such as \u2018yesterday\u2019, \u2018last week\u2019 (a week ago), \u2018next month\u2019 (a month from now).<\/p>\n

Setting an endTime relative to the current time:<\/em><\/p>\n

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

The same applies for setting a start time to text. Select a startTime<\/strong> of Text,<\/strong> then type in a date string, such as \u2018yesterday\u2019, \u2018last week\u2019 (a week ago), \u2018end of 2017\u2019.<\/p>\n

Setting a startTime relative to the current time:<\/em><\/p>\n

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

Fixed Start Time and End Time<\/strong><\/p>\n

When you create a new page, the default for startTime<\/strong> is 12:00:00 AM of the current date, and the default for endTime<\/strong> is 24 hours later.<\/p>\n

Both of them are Fixed Datetime<\/strong>, which means that this is always the start time and end time every time the page is reloaded.<\/p>\n

To change the endTime<\/strong>, select a new date and time from the DateTime Picker<\/a>. You can update the startTime<\/strong> in the same way.<\/p>\n

Changing the Fixed Datetime for endTime:<\/em><\/p>\n

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

confidenceThreshold<\/h3>\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

Example:<\/em> Here the measured data's confidence<\/em>, which is returned with the data, is lower than the gauge's defined confidence threshold, so the data indicator shows the Low Confidence symbol.<\/p>\n

Note:<\/em> Data confidence threshold is measured as a percentage, so it must be a value between 1 and 100.<\/p>\n

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

pageSampleMethod<\/h3>\n

This is applied to the Sample Method<\/a> of any time series data added to the page. This is the method (for example, average<\/em>) that P2 Server uses to collect the data. You can select any of these from the drop-down list:<\/p>\n