Search

User Manual

GETTING STARTED


MODULES AND PLATFORM


APPENDIX


TUTORIALS & HELPFUL TRICKS


GLOSSARY


STRATEGIC PARTNER LINKS

Sepasoft - MES Modules
Cirrus Link - MQTT Modules

RESOURCES

Inductive University
Ignition Demo Project
Knowledge Base Articles
Forum
IA Support
SDK Documentation
SDK Examples

ALL MANUAL VERSIONS

Ignition 8
Ignition 7.9
Ignition 7.8

Deprecated Pages

Skip to end of metadata
Go to start of metadata


Tag History Binding

Tag History Bindings allow you to pull Tag History data that is stored in the database into a component through a binding.  The binding type, which is only available for Dataset type properties, runs a query against the Tag Historian. 

On this page ...

IULocgo


Tag History Binding


IULocgo


Tag History Binding - Expression

Configuration PropertyDescription
Return Format

Allows you to select the return format of the data. Possible options are:

PropertyDescription
WideEvery column is a different tag, and each row is their values at different times.
TallThere are columns for Value, Quality, Timestamp, and Path, and each row is a new tag value at a specific time.
CalculationsWill perform a calculation on the returned data, and return the calculated values instead. For example, using the Average calculation will generate an average of each tags value over the time range selected.
Query Mode

How you want to query out the data. Possible options are:

PropertyDescription
PointCountWill return the number of records defined in the Point Count property.
PeriodicWill return records separated by an amount of time specified in the Period property.
AsStoredWill return the records as stored in the database. While querying data with this mode, multiple value changes at the same timestamp will result in multiple rows, one row for each unique value.



Time Range

The time range to pull data values from. Possible options are:

PropertyDescription
Realtime

The start date will go back as far from the current time as the Most Recent property specified and the end date will be the current time when the binding evaluates. Options are MS, SEC, MIN, HOUR, DAY, WEEK, MONTH, or YEAR.

Polling: You can specify a Polling rate to determine how often to update the times. Click the Functions icon to use operators, expressions, Tags, or properties.


Historical
You can specify the Start and End Date in an expression. Click the Functions icon to use operators, expressions, Tags, or properties. No polling; times only changed if bound to something that changes.

Select TagsAn area to select the Tags to trend. Tag Paths can be defined directly or using an expression. See Using Dynamic Tag Paths below about Expression mode.
Aggregation Mode

The aggregation mode that will be used, unless a more specific aggregation mode is defined on a Tag Path.

Aggregation ModeDescription
(default)Use the mode set in the Default Aggregation Mode field.
AverageThe values are averaged together, weighted for the amount of time they cover in the interval.
MinMaxThe minimum and maximum values will be returned for the window. In other words, two rows will be returned. If only one value is seen in the interval, only one row will be returned.
LastValueThe value closest to the ending time of the interval will be returned.
SimpleAverageThe values are summed together and divided by the number of values.
Sum

The values in the interval are summed together.

Minimum

The minimum value in the interval.

MaximumThe maximum value in the interval.
DurationOn

Returns the number of seconds that the value was recorded as non-zero.

DurationOff

Returns the number of seconds that the value recorded as zero.

CountOn

Returns the number of times the tag's value went from a zero value to non-zero.

CountOff

Returns the number of times the tag's value changed from a non-zero value to zero.

Count

Returns the number of times a value was recorded 

RangeReturns the range between the highest and lowest value for the period.
VarianceReturns the variance of values. Similar in concept to standard deviation. Only good quality values are used when calculating.
StdDev

Returns the standard deviation of values, or how much spread is present in the data; low standard deviation shows the values are close to the mean, and high standard deviation shows that the data points are spread out over a large range of values. Only good quality values are used when calculating

PctGoodTime-weighted percentage of good values over the date range. 
PctBad

Time-weighted percentage of bad values over the date range.

Default Aggregation ModeAggregation mode to use as a default if the Select Tags are set to Default Aggregation mode.
Options

Allows you to specify various options that will apply to the binding.

OptionDescription
EnabledEnable these options.
Overlay Opt-OutOpt out of displaying the Tag quality overlay.
Ignore Bad QualityOnly data with "good" quality will be loaded from the data source.
Prevent InterpolationRequests that values not be interpolated, if the row would normally require it. Also instructs the system to not write result rows that would only contain interpolated values. In other words, if the raw data does not provide any new values for a certain window, that window will not be included in the result dataset.
Value FormatCan be Dataset or Document.


Tag History Binding Example

In this example, we'll use a Table component to show the records from some Tags that have Tag History enabled.

  1. Drag a Table component onto a view. Select the Table component. 
  2. In the Property Editor, click on the Binding  icon next to the data property.  The Edit Binding screen is displayed.



  3. Select Tag History as the binding type.
  4. In the Time Range section, select Realtime and the last 1 minute of data. 



  5. Under the Select Tags section, click on the Tag icon. Navigate to the first Tag and click OK. Repeat for additional Tags. In our example, we chose the Sine0 and Sine2 Tags.



  6. Notice the Binding Preview at the bottom of the screen. Click OK to save the Tag History binding.
  7. Back in the view, the Table component now contains a column for the timestamp and one for each Tag. Notice how the timestamp does not have a date format. 




  8. In order to change the t-stamp values into a date format, in the Property Editor under columns, click Add Array Element...



  9. You'll notice that once the Array Element is added, the other two columns (Sine0 and Sine2) disappeared. We'll add them back in Step 10.
    1. In the field property, enter t_stamp (which is the column name).
    2. For the render property, select date from the dropdown.
    3. Select a dateFormat from the dropdown. In this example, we used the date time format.




  10. Now, let's add the Sine0 and Sine2 columns back into our table by clicking on Add Array Elements... 2 times (refer to the yellow highlights in the image above). There is no need to change any of the Sine0 or Sine2 column properties unless you want to change the default settings or rearrange columns.  

    Notice that columns 1 and 2 (Sine0 and Sine2, respectively) are collapsed in this image. To see all the columns properties, expand the columns. 



Using Dynamic Tag Paths

Tag History bindings have the option to list out Tag paths, or to use an expression to build a Tag path. It is common to create a dynamic path or set of paths as a component property, that you then reference in other places. You can use as many Tag paths as you want, but they must all follow this format: 

  • key [array] 
    • [0] {object}

      • aggregate value
      • alias value
      • path value
    • [1]{object}
      • aggregate value
      • alias value
      • path value
    • ...

 For an example, you can create a custom property on a chart and use it to fuel the historical data.

  1. Create a custom property named Key on a chart component that is an Array type.
  2. Copy and paste the JSON below into this Key property.

    JSON for Key Array
    [
      {
        "aggregate": "Average",
        "alias": "tank_temp",
        "path": "[default]Tank/03/Temperature"
      },
      {
        "aggregate": "Average",
        "alias": "setpoint",
        "path": "[default]Tank/03/Setpoint"
      }
    ]
  3. Open the property binding on your chart and select the Tag History binding type. 
  4. Select the Expression radio button to create your own tag structure.
  5. Click on the property selector button on the right and find your new custom property. 
  6. Click OK in the lower right. 



 

  • No labels