Historian Tags (Reference) define the mapping between data points and their archival storage configuration within the FrameworX Historian module. Historian Tags are the fundamental configuration objects that:
- Link tags to historian tables for organized storage
- Define data collection parameters
- Configure deadband and deviation settings
- Support both internal tags and external assets
- Enable template-based archiving
Each Historian Tag represents a data point tracked and stored over time with specific collection rules.
Table of Contents maxLevel 2 minLevel 2 indent 10px exclude Steps style none
Configuration Properties
| Property | Description | Required | Default |
|---|---|---|---|
| TagName | Unique identifier of tag to archive | Yes | - |
| HistorianTable | Target table for data storage | Yes | - |
| DeadBand | Minimum change in units for SaveOnChange | No | 0 |
| Deviation | Override for TimeDeadBand interval | No | 0 |
| RateOfChange | Units/second threshold for storage | No | 0 |
| DeviationDeadBandType | Absolute or Percentual calculation | No | Absolute |
Creating Historian Tags
Prerequisites
- Configured HistorianTable (or use default Table1)
- Tags defined in Unified Namespace
- Understanding of collection requirements
Configuration Steps
- Navigate to Historian → Historian Tags
- Enter TagName or select from list
- Configure deadband parameters:
- DeadBand for value changes
- Deviation for time overrides
- RateOfChange for velocity triggers
- Select DeviationDeadBandType
- Choose target HistorianTable
Deadband Configuration
DeadBand (Value Change)
Minimum absolute change required for storage:
- Applied with SaveOnChange trigger
- Reduces database writes
- Filters noise and minor fluctuations
Example:
TagName: Tank.Level
DeadBand: 0.5
// Only stores when level changes by ±0.5 unitsDeviation (Time Override)
Overrides TimeDeadBand interval when exceeded:
- Forces storage regardless of time interval
- Captures significant changes immediately
- Works with TimeDeadBand configuration
Example:
TagName: Reactor.Temperature
Deviation: 5.0
TimeDeadBand: 60 seconds
// Stores every 60s OR when temp changes by ±5°RateOfChange (Velocity)
Triggers on rapid value changes:
- Measured in units per second
- Detects process upsets
- Overrides time intervals
Example:
TagName: Pressure.Line1
RateOfChange: 10
// Stores when pressure changes >10 PSI/secondDeviationDeadBandType
Absolute
Fixed unit threshold:
Current Value: 100
Deviation: 5
Triggers at: <95 or >105Percentual
Percentage of current value:
| No Format |
|---|
Current Value: 100
Deviation: 5 (%)
Triggers at: <95 or >105
Current Value: 200
Deviation: 5 (%)
Triggers at: <190 or >210 |
UserType Tags (Template Tags)
Archive entire templates or specific properties:
Full Template
TagName: Pump1
// Archives all properties of Pump1 templateSpecific Property
TagName: Pump1.Motor.Current
// Archives only motor current propertyMultiple Instances
When using template arrays:
TagName: Pumps[1].Flow
TagName: Pumps[2].Flow
// Individual configuration per instanceHistorianTable Assignment
Grouping Strategy
Assign tags to tables based on:
- Update frequency
- Process relationships
- Data types
- Storage requirements
Best Practices
| Update Rate | Table Assignment |
|---|---|
| < 1 second | HighSpeed |
| 1-10 seconds | Process |
| 10-60 seconds | Supervisory |
| > 60 seconds | SlowData |
Runtime Behavior
SaveOnChange Mode
Tag changes → Check DeadBand → Store if exceededTrigger Mode
Trigger fires → Store all table tags → Apply timestampTimeDeadBand Mode
Timer expires → Check Deviation/RateOfChange → Store if exceeded OR timerPerformance Optimization
DeadBand Settings
- Analog signals: 0.1-1% of range
- Digital signals: Usually 0 (all changes)
- Calculated values: Based on significance
Table Organization
- Group similar update rates
- Separate critical from non-critical
- Consider query patterns
- Balance table sizes
Storage Efficiency
- Use Normalized tables for sparse data
- Standard tables for synchronized data
- Enable compression where supported
Common Configurations
Temperature Monitoring
TagName: Furnace.Temperature
DeadBand: 0.5
Deviation: 10
RateOfChange: 5
DeviationDeadBandType: Absolute
HistorianTable: ProcessDataLevel Tracking
TagName: Tank.Level
DeadBand: 0.1
Deviation: 5
DeviationDeadBandType: Percentual
HistorianTable: TankFarmDiscrete Events
TagName: Pump.Status
DeadBand: 0
HistorianTable: Events
// Captures all state changesTroubleshooting
Data not archiving:
- Verify tag name spelling
- Check HistorianTable is active
- Review deadband settings
- Confirm tag has valid quality
Excessive storage:
- Increase deadband values
- Review deviation settings
- Check for oscillating tags
- Enable time deadband
Missing rapid changes:
- Decrease RateOfChange threshold
- Reduce deviation value
- Check scan rates
- Verify trigger configuration
Template tags not working:
- Confirm template structure
- Check property paths
- Verify array indices
- Review instance names
Best Practices Checklist
- Set appropriate deadbands - Balance detail vs storage
- Group related tags - Same table for correlated data
- Document settings - Record why values chosen
- Test configurations - Verify before production
- Monitor performance - Track storage growth
- Use templates efficiently - Archive needed properties only
- Plan for maintenance - Consider future adjustments
In this section...
| Page Tree | ||
|---|---|---|
|
Overview
A HistorianTag represents a specific data point you want to track and store over time. The HistorianTags definition links a Tag to a HistorianTable for organized storage, supporting various data types. When you map the tag to a HistorianTable, it will record the value changes or events associated to that tag over time.
On this page:
Understanding HistorianTags
When a solution Tag, or an external Asset, is mapped to be archived or retrieved from an Historian, that configuration is called a HistorianTag.
When you define HistorianTags, you archive data by associating information with specific tags and HistorianTables in Storage Locations. In other words, you establish a link between Tags and HistorianTables to ensure systematic and organized data storage.
When archiving Tags created using DataTemplates, you don't need to specify all the properties.
The two pieces of Information that are mandatory to define an Historian Tags are:
TagName: variables that will archived, or retrieved.
HistorianTable: logical object that groups data and defines the storage location to which that variable will be connected.
Configuring HistorianTags
Before setting HistorianTags, you need to configure a HistorianTable. To Know more about creating and configuring HistorianTables, click here. You can also use the default one (Table 1).
After configuring the HistorianTables, you can start defining which Tags to archive with the configured HistorianTables. To add and configure a single Tag, follow the steps below:
Access Historian / Historian Tags.
On the TagName column, type the Tag name or select from the available list. Alternatively, copy and paste the Tag's name from Unified Namespace / Tags.
Configure the DeadBand, Deviation, and RateOfChange. The following section describes each of these configurations.
Select if the platform should consider an Absolute or Percentual as the DeviationDeadBandType.
To finish, select the HistorianTable, where the Tags' information will be archived.
The image below illustrates the process described above.
HistorianTags Properties
When configuring a HistorianTag, you need to specify some properties that will define how data will be archived. The following table describes each available property you can configure:
TagName
Specify the unique identifier of the Tag to be archived. To archive Template Tags, specify one of the Template Tag's properties or archive all properties by entering only the primary Tag name.
DeadBand
(Optional feature) Defines how much the value must change (in Units) for the system to store the value. This configuration is considered when you use the SaveOnChange option in the HistorianTable.
Deviation
(Optional feature) Specify how much the value must change (in Units) for the system to store the value. This configuration is considered when you use the TimeDeadBand option in the HistorianTable. If you define this property, its value overrides the TimeDeadband logging interval.
RateOfChange
(Optional feature) Defines how much the value must change (in Units) by second for the system to store the value. This configuration is considered when you use the TimeDeadBand option in the HistorianTable. If you define this property, its value overrides the TimeDeadband logging interval.
DeviationDeadBandType
(Optional feature) Determines the calculation method used to define the Deadband value.
HistorianTable
Select the HistorianTable to use when saving the Tag's value.
In this section: