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


Configuring Tag History Settings

Tag History storage is easy to set up quickly, but there are also some settings that can be adjusted to allow for differences in database storage space and performance needs.

Table Partitioning

Ignition has the ability to automatically break up data into different tables of fixed duration. This can help make data maintenance easier by preventing tables from becoming too large. Tables can easily be deleted in order to prune old data, and the database is able to better optimize access to frequently retrieved rows. The built-in partitioning feature can be used with any database.

It is important to note the difference between this feature and any partitioning options that the database might provide. Most modern databases offer their own faculties for defining "partitions", offering similar and greater benefits. While Ignition cannot use these features directly, advanced users may choose to apply these features on top of what Ignition currently offers.

Data Compression

Ignition does not perform any binary compression on the data. That is, values are stored directly in standard database tables. However, to reduce the number of values stored, Ignition offers two different algorithms for pre-compressing the data (trimming unnecessary values). The two modes correspond to the value mode property of the Tag. The value mode (Discrete or Analog) dictates the type of value that the Tag represents, affects how the deadband is applied to values, and how interpolation is performed when querying.

  • Discrete 
    The value uses a simple deadband and is only stored when a new value is + /- the deadband value away from the previously stored value.
     
  • Analog 
    The deadband is used to form a corridor along the trajectory of the value. A new value is only stored when it falls outside the previous corridor. When this occurs, the trajectory is recalculated and a new corridor is formed.

Typically, Discrete is used for boolean or integers that represent state, and Analog is used for floats or integers that change more often (which is why you want to perform compression).While advanced users can change the table according to their database to be more efficient (for example, using a compressed engine), Ignition does not perform binary compression or encrypt the data in any way. See Deadband Style, in Tag Properties Table for more information about the difference between Discrete and Analog values.

On this page ...


IULocgo


Discrete vs. Analog Mode


Datasource History Providers

Datasource History Providers can not be created or deleted, but are instead tied to a database connection. They are automatically added when connecting to a new database and removed after the database connection is removed. It comes pre-configured to partition every month, but the provider can be edited to change its behavior.

There are two other major options to configure on the provider: pre-processed partitions and data pruning. With pre-processed partitions, the data that is stored is summarized and then placed into another table in the database. While this takes up more space in the database, it can improve query speed by reducing the amount of data points that must be loaded. Data pruning will automatically remove old data from your system after it reaches an age that you set. It will only remove whole tables though. If each partitioned table represents a month and the pruning system removes data that is three months old, it will wait until all the data in the oldest table is three months old before pruning it.

Editing Datasource History Providers

The following table lists the settings for the Datasource History Providers. To access these settings, go to the Config tab of the Gateway Webpage and select Tags > History.  Then click the Edit button for the provider you want to update.

Main

Provider NameName of the Tag History Provider. By default, this will match up with the name of the database connection.
Enabled

If the check box is selected (enabled), the provider is turned on and accepts tag history data.

If disabled, the database is not shown in the list of history providers when configuring tag history from the Designer. Also, any data logged to the provider, will error out and be quarantined by the store and forward engine, if possible.

DescriptionA description of the provider.

Data Partitioning

Enable PartitioningTo improve query performance, Tag Historian can partition the data based on time. Partitions will only be queried if the query time range includes their data, thereby avoiding partitions that aren't applicable and reducing database processing. On the other hand, the system must execute a query per partition. It is therefore best to avoid both very large partitions, and partitions that are too small and fragment the data too much. When choosing a partition size, it is also useful to examine the most common time span of queries.

Partition Length and Units

The size of each partition, the default is one month. Many systems whose primary goal is to show only recent data might use smaller values, such as a week, or even a day.

Enabled Pre-processed PartitionsPre-processed partitions will use more space in the database, but can improve query speed by summarizing data, reducing the amount that must be loaded.
Pre-processed Window Size (seconds)When pre-processing is turned on, the data will be summarized into blocks of this size.

Data Pruning

Enable Data Pruning

Partitions with data older than a specific age are deleted. The check box is not selected/enabled by default.

Data pruning works by deleting old partitions. Therefore, data will only be removed when a partition has no data younger than the prune age.

Prune Age and Units

The maximum age of data. As mentioned, the data is deleted by the partition, and could therefore surpass this threshold by quite a bit before all of the data in the partition is old enough to be dropped.

Advanced

Enable Stale Data DetectionIf enabled, tracks scan class executions to determine the difference between unchanging values, and values that are flat due to the system not running.
Stale Detection MultiplierThe multiplier for scan class rate used to determine when values are stale. If scan class execution is not recorded within this amount of time, values will be considered bad on query.

OPC-HDA Provider

Establishes a connection to an OPC-HDA Server to read history data that may be stored there from a third party. Ignition can not write to this type of history provider.

This requires the OPC COM to be installed.


This feature is new in Ignition version 8.0.4
Click here to check out the other new features

Internal History Provider

As of version 8.0.4, the Edge Historian, an internal history provider, is available on standard Ignition Gateways.

To set up an Edge history provider, do the steps the follow: 

  1. Go to the Config section of the Gateway Webpage and select Tags > History
  2. Click Create New Historical Tag Provider.
  3. Select the Internal Historian radio button and click Next.

  4. Fill in the properties in the table.

    Main

    Provider NameName of the Edge History Provider.
    Enabled

    If the check box is selected (enabled), the provider is turned on and accepts tag history data. Default is true.

    DescriptionA description of the provider.

    Limits (Requires Tag Historian Module License)

    Time Limited Enabled?Whether or not time limit is enabled. Default is true.
    Time Limit SizeSize of the time limit. Unit (seconds, weeks, etc) is set in the Time Limit UnitsDefault is 1.
    Time Limit Units?Options are milliseconds, seconds, minutes, hours, days, weeks, months, or years. Default is WEEK.
    Point Limit Enabled? Whether or not time limit is enabled. Default is true.
    Point Limit Size Maximum number of data points the historian will store. Default is 10,000,000.
    Sync Frequency The frequency with which data will be sent to the remote gateway. This setting will be used in conjunction with the sync schedule, if enabled. Default is 10.
    Sync Frequency UnitsThe unit of time that will be used with the Sync Frequency. Options are milliseconds, seconds, minutes, hours, days, weeks, months, or years. Default is SEC.
    Max Batch SizeThe maximum number of data points that will be sent per batch to the remote Gateway. (Default is 10,000.)
    Enable Schedule

    If enabled, the data will only be synchronized during the times specified by the pattern provided. Default is false.

    Schedule Pattern

    A comma separated list of time ranges. Examples:

    • 9:00-15:00
    • 9pm-5am
    • 20.30-04.30

    Sync Settings (Requires EAM Module Licensing)

    Remote Sync EnabledAllows you to turn  Tag History Synchronization on or off. Default is false.
    Remote Gateway Name

    The Gateway to target for remote synchronization. Must have the Tag Historian module installed, and allow remote storage. The Ignition Gateway's  security settings will also need to be configured to allow remote storage.

    Remote Provider NameThe remote history provider to sync data to.
  5. After filling in the properties in the table as desired, click Create New Historical Tag Provider.

Once an Edge History Provider is set up, you can select it as the storage provider for your tags. For example, in the following image, and Edge History Provider named "Internal Historian Test" is selected for storing history on a memory tag. 


Remote History Provider

A Remote History Provider is a link to a historical provider on another gateway. Since it is grabbing historical tag data from another provider, its only configuration is to ensure it is pointed at the correct tag provider. You can't change any of the settings like partition length and prune age, but would instead have to change those settings on the original history provider on the remote gateway. By default, the remote history provider will fall under the Default Security Zone and be read only.


IULocgo


Remote History Provider

To set up a Remote History Provider, do the steps that follow:

  1. Go to the Config section of the Gateway Webpage and select Tags > History.  
  2. Select the Remote History Provider radio button.



  3. A list of known Gateways appears.  If the Gateway is not currently available or displayed here, you can specify its name manually. 



  4. Select a Gateway and click Next.
  5. Fill in the properties in the table.

    Main

    Provider NameName of the Tag History Provider.
    Enabled

    If the check box is selected (enabled), the provider is turned on and accepts tag history data. Default is true.

    If disabled, the database is not shown in the list of history providers when configuring tag history from the Designer. Also, any data logged to the provider, will error out and be quarantined by the store and forward engine, if possible.

    DescriptionA description of the provider.

    Remote Gateway

    Remote Gateway NameThe name of the remote Gateway.
    Remote History ProviderThe name of the provider on the remote Gateway. This does not have to match the provider name on the local Gateway.

    Storage

    Allow StorageIf false, the provider will only be used for querying historical data. If true, the provider will create a store and forward pipeline for sending data to a remote gateway. Default is true.
    Max Bundle SizeThe maximum number of data points that can be sent per request. This value is used in conjunction with the store and forward settings to dictate how much data is sent at once. 0=unlimited
  6. After filling in the properties in the table, click Create New Historical Tag Provider.


Tag History Splitter

This provider combines two separate providers into a single new provider. When setting up a Tag to store history, selecting this provider will write the same data to both providers that it has selected. The Tag History Splitter is useful for automatically creating a backup of your data, or for reading history from two separate providers. Learn more about setting up the Tag History Splitter here. 



Related Topics ...


  • No labels