{"id":45240,"date":"2020-02-03T12:19:24","date_gmt":"2020-02-03T04:19:24","guid":{"rendered":"https:\/\/oihelp.corporate.ifs.com\/help\/?page_id=45240"},"modified":"2024-07-05T12:31:12","modified_gmt":"2024-07-05T04:31:12","slug":"fetch-parameters","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/p2-server\/xla\/fetch-parameters\/","title":{"rendered":"Fetch Parameters"},"content":{"rendered":"\n<p class=\"intro-text\">When you add entities to a worksheet, the data that is fetched is based on the parameters that have been set on the <strong>Fetch Parameters<\/strong> pane. From here, you can set start and end times, sample type, and interval. Once you save the fetch parameters, they are then available in the <strong>Fetch Parameters<\/strong> drop-down list.<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" width=\"361\" height=\"744\" class=\"wp-image-45308\" src=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2020\/02\/word-image-14.png\" srcset=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2020\/02\/word-image-14.png 361w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2020\/02\/word-image-14-73x150.png 73w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2020\/02\/word-image-14-23x48.png 23w\" sizes=\"auto, (max-width: 361px) 100vw, 361px\" \/><\/p>\n<p class=\"intro-text\">The Fetch Parameters pane allows you to define the parameters that are used when IFS OI Excel Add-in retrieves data from IFS OI Explorer. Once you have defined a set of parameters, you can save them for future fetches.<\/p>\n<p class=\"intro-text\">For ad-hoc queries, the currently selected parameters can be used in a data fetch. To use these, make sure that you have selected <strong>Current Fetch Parameters<\/strong> from the <strong>Fetch Parameters<\/strong> drop-down list on the Entities Pane.<\/p>\n<p class=\"intro-text\">Available parameters are listed in the following sections.<\/p>\n<p>&nbsp;<\/p>\n<hr \/>\n<h2 class=\"page-subheading\">Fetch Type<\/h2>\n<p class=\"intro-text\">The type of fetch that you would like to do:<\/p>\n<ul>\n<li class=\"intro-text\">Average<\/li>\n<li class=\"intro-text\">Last Known Value<\/li>\n<li class=\"intro-text\">Linear Interpolate<\/li>\n<li class=\"intro-text\">Raw<\/li>\n<\/ul>\n<p class=\"intro-text\"><strong>Fetch entity properties with data<\/strong>: Whether to include the core properties (Entity Name, Description, Type, Measurement Type, Units, and Location ) in the spreadsheet when the data is retrieved. If this check box is cleared, then IFS OI Excel Add-in does not include the above properties in the spreadsheet.<\/p>\n<p class=\"intro-text\"><strong>Display confidence data<\/strong>: Whether to display the confidence values of the entities on the worksheet. This displays the confidence values in a separate column next to the entity value.<\/p>\n<p class=\"intro-text\"><strong>Confidence Warning<\/strong>: Displays a comment on the value cell when the confidence value of an entity is below the specified limit, and showing the confidence value of the entity at that point in time. The default is 50.<\/p>\n<p>&nbsp;<\/p>\n<hr \/>\n<h2 class=\"page-subheading\">Start Time and End Time<\/h2>\n<p class=\"intro-text\">You can specify the Start Time and End Time in one of three ways: Fixed value, defined value in a cell, or normalised time.<\/p>\n<h3>Fixed Value<\/h3>\n<p class=\"intro-text\">A fixed value is an absolute time in ISO-8601 format. The start and end times will default to the current time of your machine when you open this task pane.<\/p>\n<p class=\"intro-text\">To select a different start or end time, click the <strong>Time <\/strong><strong><img loading=\"lazy\" decoding=\"async\" width=\"16\" height=\"16\" class=\"wp-image-45309\" src=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2020\/02\/word-image-29.png\" \/><\/strong> icon. This invokes a date\/time picker you can use to select a different date or time. The date\/time picker shows the time entered into the Start Time and End Time fields, or the current time if NOW is specified or if the value in the field is not valid. If a time is selected using the picker, then it will overwrite any existing times in the Start Time and End Time field. However, the selected time zone will remain unchanged. The time zone is set to the local time zone by default.<\/p>\n<h3>Defined in Cell<\/h3>\n<p class=\"intro-text\">You can select a Start Time and End Time which is specified in a cell of the spreadsheet. To do this, click the <strong>Define Cell <\/strong><strong><img loading=\"lazy\" decoding=\"async\" width=\"21\" height=\"18\" class=\"wp-image-45310\" src=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2020\/02\/word-image-30.png\" \/><\/strong> button. This disables the fixed time controls and enables the controls that allow you to type in the cell name (such as A1 or $A$1 or $A1 or 'Sheet'!A1) or click on a cell.<\/p>\n<p class=\"intro-text\">Excel Date\/Time values can be used in cell references as can normalised time and string-based time formats as defined in the Fixed Value.<\/p>\n<h3>Normalised Time<\/h3>\n<p class=\"intro-text\">Normalised Time allows you to use special time keywords such as NOW, MN, and MIDNIGHT, and an offset to specify the date and time. A Normalised Time string takes the form of:<\/p>\n<p class=\"intro-text\"><span style=\"color: #008000;\"><strong>Keyword [Offset] [Offset].<\/strong><\/span><\/p>\n<p class=\"intro-text\">Each of the offsets must be provided as a set of three values: a sign (+\/-), a number (7,3,12), and a type (y,m,d,h,mi,s).<\/p>\n<p class=\"intro-text\">Examples:<\/p>\n<table>\n<tbody>\n<tr>\n<td>\n<p><span style=\"color: #008000;\">NOW -2d<\/span><\/p>\n<p><span style=\"color: #008000;\">NOW<\/span><\/p>\n<p><span style=\"color: #008000;\">NOW -1h<\/span><\/p>\n<p><span style=\"color: #008000;\">MIDNIGHT -7d +6h<\/span><\/p>\n<p><span style=\"color: #008000;\">MN+6h<\/span><\/p>\n<\/td>\n<td>\n<p>Two days prior to the current date\/time of the client machine.<\/p>\n<p>The current date\/time of the client machine.<\/p>\n<p>One hour prior to the current time.<\/p>\n<p>One week prior to the current date at midnight plus six hours; this equates to 6am seven days ago.<\/p>\n<p>6am this morning.<\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p class=\"left-bar\"><strong>Note<\/strong>: You may add spaces between the offsets, but not within the offsets themselves. As an example, let's use the symbol (\u02c6) to indicate a space. You may specify NOW\u02c6-2d but NOW -2\u02c6d would be invalid.<\/p>\n<p class=\"dl-def\">Additionally, if you omit the sign, it will be interpreted as a plus (+).<\/p>\n<h4>Keywords<\/h4>\n<table style=\"width: 100%;\">\n<tbody>\n<tr>\n<td style=\"width: 20.9375%;\">\n<p><span style=\"color: #008000;\">NOW<\/span><\/p>\n<p><span style=\"color: #008000;\">MN<\/span><\/p>\n<p><span style=\"color: #008000;\">MIDNIGHT<\/span><\/p>\n<\/td>\n<td style=\"width: 78.9583%;\">\n<p>Current Time<\/p>\n<p>Midnight prior to current time<\/p>\n<p>Midnight prior to current time<\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4>Offset Types<\/h4>\n<table style=\"width: 100%;\">\n<tbody>\n<tr>\n<td style=\"width: 20.9375%;\">\n<p><span style=\"color: #008000;\">y<\/span><\/p>\n<p><span style=\"color: #008000;\">m<\/span><\/p>\n<p><span style=\"color: #008000;\">d<\/span><\/p>\n<p><span style=\"color: #008000;\">h<\/span><\/p>\n<p><span style=\"color: #008000;\">mi<\/span><\/p>\n<p><span style=\"color: #008000;\">s<\/span><\/p>\n<\/td>\n<td style=\"width: 78.9583%;\">\n<p>Year<\/p>\n<p>Month<\/p>\n<p>Day<\/p>\n<p>Hour<\/p>\n<p>Minute<\/p>\n<p>Second<\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p class=\"intro-text\">If the time you have entered is valid, each text box is marked with a green success symbol <a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2020\/02\/word-image-12.png\" rel=\"lightbox-0\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-45260\" src=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2020\/02\/word-image-12.png\" alt=\"\" width=\"16\" height=\"16\" \/><\/a>\u00a0indicating that the value entered is valid.<\/p>\n<p>&nbsp;<\/p>\n<hr \/>\n<h2 class=\"page-subheading\">Interval<\/h2>\n<p class=\"intro-text\">The Interval parameter is the length of time (in seconds, minutes, hours, or days) between each data point retrieved. For example, with a start time of 2003-01-28T8:00:00 and an interval of 5 minutes, data points will be retrieved at 2003-01-28T8:00:00 and then five minutes later at 2003-01-28T8:05:00, and so on.<\/p>\n<p class=\"intro-text\">If the end time is an exact integer multiple of intervals after the start time, then the last value retrieved will be at the end time. Otherwise, the last value retrieved will be before the end time. For example, if the end time is 2003-01-28T8:10:00 then values will be retrieved at 8:00, 8:05, and 8: 10 (the end time). If the end time is 2003-01-28T8:12:00 then the same values will be retrieved.<\/p>\n<p class=\"intro-text\">The interval can be entered as:<\/p>\n<p class=\"intro-text\"><span style=\"color: #008000;\"><strong>[Offset] [offset]...<\/strong><\/span><\/p>\n<table>\n<tbody>\n<tr>\n<td><span style=\"color: #008000;\">5mi<\/span><\/td>\n<td>5 minute interval<\/td>\n<\/tr>\n<tr>\n<td><span style=\"color: #008000;\">1h+5mi<\/span><\/td>\n<td>1 hour and 5 minutes = 65 minutes<\/td>\n<\/tr>\n<tr>\n<td><span style=\"color: #008000;\">300<\/span><\/td>\n<td>System defaults to seconds in no offset provided.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<hr \/>\n<h2 class=\"page-subheading\">Saved Fetch Parameters<\/h2>\n<p class=\"intro-text\">Parameters can be saved for use at a later time. For example, it may be useful to have a set of fetch parameters that defines a fetch for the last week's values.<\/p>\n<p class=\"intro-text\">To save a fetch, enter a descriptive name for the fetch and click the <strong>Add Fetch<\/strong> icon <img loading=\"lazy\" decoding=\"async\" width=\"16\" height=\"16\" class=\"wp-image-45312\" src=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2020\/02\/word-image-32.png\" \/> . If a fetch with that name already exists you will be prompted to overwrite it.<\/p>\n<p class=\"intro-text\">Click <strong>Yes <\/strong>if you want to overwrite the existing fetch, or click <strong>No<\/strong> and choose another name to continue.<\/p>\n<p>&nbsp;<\/p>\n<hr \/>\n<h2 class=\"page-subheading\">Deleting a Saved Fetch<\/h2>\n<p class=\"intro-text\">You can delete a saved fetch by selecting the fetch and then clicking the <strong>Delete<\/strong> <a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2020\/02\/word-image-13.png\" rel=\"lightbox-1\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-45261\" src=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2020\/02\/word-image-13.png\" alt=\"\" width=\"16\" height=\"16\" \/><\/a>\u00a0icon.<\/p>\n<p class=\"note\">Note: Use this with caution, as you are not prompted to confirm the deletion and the action is not reversible.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>When you add entities to a worksheet, the data that is fetched is based on the parameters that have been set on the Fetch Parameters pane. From here, you can set start and end times, sample type, and interval. Once you save the fetch parameters, they are then available in the Fetch Parameters drop-down list.<\/p>\n<p class=\"continue-reading-button\"> <a class=\"continue-reading-link\" href=\"https:\/\/oihelp.corporate.ifs.com\/help\/p2-server\/xla\/fetch-parameters\/\">Read more<i class=\"crycon-right-dir\"><\/i><\/a><\/p>\n","protected":false},"author":1,"featured_media":45282,"parent":45233,"menu_order":5,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":"","_members_access_role":[],"_members_access_error":""},"categories":[11],"tags":[859],"class_list":["post-45240","page","type-page","status-publish","has-post-thumbnail","hentry","category-tutorial","tag-excel","Product-srv"],"_links":{"self":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/45240","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\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/comments?post=45240"}],"version-history":[{"count":14,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/45240\/revisions"}],"predecessor-version":[{"id":67858,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/45240\/revisions\/67858"}],"up":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/45233"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/media\/45282"}],"wp:attachment":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/media?parent=45240"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/categories?post=45240"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/tags?post=45240"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}