Collectible fields
- Last UpdatedApr 24, 2025
- 2 minute read
By default, any numeric and enumerated fields defined in the following tables are collectible periodically and by exception:
-
analog
-
status
-
multistate
-
rate
-
tank
-
virtualflowcomputer
If collection by exception is required for tables that are not in the above list, you can add the missing tables to the %DNADataRoot%\RealTime\config\Settings\RealTime_DataExport_TimeSeriesCollectPlugin.json configuration file.
To add the required tables to the configuration file, use the following example as a template:
{
"RealTime": {
"DataExport": {
"Plugins": {
"TimeSeriesCollectPlugin": {
"Tables": {
"customTable": {
"Enabled": true,
}
}
}
}
}
}
}
Notes: Increasing the number of tables configured for collect by exception may affect the
performance.
The tables configured for collect must include the flag structure.
The following configurations in the %DNADataRoot%\RealTime\config\Settings\RealTime_DataExport_TimeSeriesCollectPlugin_Extension.json configuration file.
The TimeSeriesCollectPlugin uses a cache to propagate collect configuration changes to the plugin. Periodically, an integrity check is performed on the configuration loaded into the plugin. The frequency of this check is defined in the configuration setting CollectCacheTimeout in the RealTime_DataExport_TimeSeriesCollectPlugin_Extension.json configuration file.
Note: AVEVA recommends that no changes are made to the default configuration for CollectCacheTimeout as a faster frequency will result in unnecessary writes to the plugin cache.
The configuration setting ExcludedFields specifies the list of excluded fields defined for each table. In scenarios where a field needs to be excluded from collection by the TimeSeriesCollectPlugin (for example, the field is collected by other means), you can override it. If you need to specify more than one field, the fields must be separated by commas.
The configuration setting KrunchTimeFields specifies that those defined fields will use the krunch time to time stamp the collected value instead of the system time when the collection was performed.
The following is an example configuration file:
{
"RealTime": {
"TimeSeriesCollectPlugin": {
"CollectCacheTimeout": "00:05:00",
"Tables": {
"customTable": {
"ExcludedFields":"customExcludedField",
"KrunchTimeFields":"currentValue"
}
}
}
Note: For information on overriding default configuration settings, refer to Modify configuration settings.