Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Historian

System parameters

  • Last UpdatedOct 20, 2025
  • 5 minute read

A system parameter is a parameter that controls some aspect of the overall AVEVA Historian behavior. The following table describes the default system parameters:

Name

Description

AllowOriginals

Used to allow the insertion of original data for I/O Server tags. You must set this parameter to 1 before importing .lgh original data. For more information, see Import, insert, or update history data.

AllowRenameTags

Allow or disallow tags to be renamed programmatically. 1 = allow tags to be renamed programmatically; 0 = disallow tags to be renamed programmatically.

AnalogSummaryTypeAbbreviation

Abbreviation used when generating analog summary tagnames. For more information, see Specify naming schemes for replication.

AutoSummary

Used for auto-summarization of tag values.

ConfigEditorVersion

(Not editable.) The minimum version number of the Configuration Editor that can edit the Runtime database. Used internally by the system.

CounterDeadband

Percentage (0-100) of the rollover value used to distinguish resets and reversals from rollovers.

DatabaseVersion

(Not editable.) Current version number of the Runtime database.

DataImportPath

Path to the CSV file for an import of external data. For more information, see Import data from CSV files.

DBID

(Not editable.) Identifier for the Runtime database.

EnforceTLS

Indicates whether trusted communication is enforced. 1 = trusted communication is enforced, 0 = trusted communication is not enforced.

EventStorageDuration

Maximum duration, in hours, that event records are stored in the EventHistory table.

EventStorageLogPath

Path for storing logs for event tag data.

Future Time Threshold

Specifies a time threshold in minutes, after which streamed data values will be re-timestamped. If 0, then no future time threshold is applied.

GatewayHTTPSPort

Specifies the TCP port used for encrypted gateway communication.

GatewayTcpPort

Specifies the TCP port used for unencrypted gateway communication.

GroupedPrivateNamespace

Specifies whether domain user accounts can have private namespaces can be created for domain user accounts. 1 = Domain users are used; 0 = Domain users are not used.

HistorianPartner

The computer name of a partner Historian. You can use either the host name, fully qualified name, or an IP address. Leading backslashes are optional. The name/IP used must be one that can be correctly resolved by all of the AppEngine and Historian Client computers that will connect to the partner. For more information, see Use a redundant Historian.

HistorianVersion

(Not editable.) Current version number and build number of the AVEVA Historian. The value for this parameter is automatically supplied when the system starts.

HistoryCacheSize

Allocation of system memory, in MB, of data collected by the Classic Storage subsystem from AVEVA Historian version 11.5 or earlier. The default is 0.

For more information, see Memory management for retrieval of classic storage data.

HistoryDaysAlwaysCached

The duration, in days, for which history block information is always loaded in memory. The default is 0.

Applicable only for tag information of data collected by the Classic Storage subsystem from AVEVA Historian version 11.5 or earlier.

InterpolationTypeInteger

The type of interpolation for data values of type integer. 0=Stair-step; 1=Linear. The default is 0. For more information on interpolation, see Interpolation type (wwInterpolationType) in the AVEVA Historian Retrieval Guide.

InterpolationTypeReal

The type of interpolation for data values of type real. 0=Stair-step; 1=Linear. The default is 1.

LicenseServer

Provides the name and port for the License Servers from which the license is acquired.

LicenseTagCount

(Not editable.) The number of licensed tags allocated to the system, in 500-tag increments.

MaxCyclicStorageTimeout

Controls the amount of time, in seconds, that AVEVA Historian waits for new values of cyclically stored tags before storing the previous one and making it available for retrieval. This parameter is used to balance three things:

  • Source latency -- the difference in the source-supplied timestamp and when the value is received by the Historian

  • Data rate -- the rate at which delta values are reported by the source

  • Storage latency -- the amount of time that the Storage subsystem must wait before it ends a cycle and assigns a value to it

    Setting this parameter to a value other than 0 ensures that the storage subsystem is not waiting indefinitely to confirm a final value for the cycle.

ModLogTrackingStatus

Turns modification tracking on or off. The value you specify will determine what modifications are tracked. For more information, see Turn modification tracking on/off.

OldDataSynchronizationDelay

Time delay, in seconds, between when changes for "old" data (inserts, updates, and store-and-forward data) must be sent from the tier-1 Historian to the tier-2 Historian.

QualityRule

Indicates whether the system should use values having a quality of Good and Uncertain, or having only a quality of Good. 0 = Good and Uncertain; 1 = Good only. The default is 0. For more information on the quality rule, see Quality rule (wwQualityRule) in the AVEVA Historian Retrieval Guide.

RealTimeWindow

The maximum delay, in seconds, for which data is considered real-time data applying the swinging door deadband. The delay is relative to the current time. Valid values are between 30 and 300 milliseconds. The default is 60. For more information, see About the real-time data window.

ReplicationConcurrentOperations

Limits the total number of retrieval client objects performing calculations in a retrieval based calculations for a time cycle.

ReplicationDefaultPrefix

The default prefix for replication tags on the tier-2 Historian. If you change ReplicationDefaultPrefix system parameter, all replication tags that use the old prefix are not updated to use the newer prefix. For more information, see Specify naming schemes for replication.

ReplicationTcpPort

The TCP port number the Historian Client Access Port (HCAP) service listens on for any incoming-connection requests from an HCAL-enabled client. It must match the port number the HCAL-enabled client is using for communication with the Historian. When modifying this system parameter on an Historian node, you must also modify the port number in the Windows Firewall exception list for the Historian replication service or another HCAL-enabled client to the same value. This port number must be unique on the Historian node; that is, no other applications on the Historian node should be listening on this port number.

SimpleReplicationNamingScheme

The default naming scheme used for configuring simple replication tags. For more information, see see Specify naming schemes for replication.

StateSummaryTypeAbbreviation

Abbreviation used when generating state summary tagnames. For more information, see see Specify naming schemes for replication.

SuiteLinkTimeSyncInterval

Frequency, in minutes, that IDASs will attempt to synchronize the timestamping mechanism for associated I/O Servers. If this parameter is set to 0, no time synchronization will occur. For more information, see Time synchronization for data acquisition.

SummaryCalculationTimeout

The maximum expected delay, in minutes, for calculating summary data for replicated tags. Setting this parameter too high will delay associated summary calculations unnecessarily. Setting it too low will cause the system to prematurely calculate summaries and then later require additional processing to correct those calculations.

SummaryReplicationNamingScheme

The default naming scheme used for configuring summary replication tags. For more information, see see Specify naming schemes for replication .

SummaryStorageDuration

Maximum duration, in hours, that summary records will be stored in the legacy SummaryHistory table.

SysPerfTags

Used to turn on performance monitoring tags for the AVEVA Historian system. 0 = Off; 1 = On. The default is 1. For more information, see Performance monitoring tags.

TimeStampRule

Used to determine which timestamp within a retrieval cycle to use for a data value. 0 = Use the timestamp at the start of the cycle; 1 = Use the timestamp at the end of the cycle. The default is 1. For more information, see TimeStamp rule (wwTimeStampRule) in the AVEVA Historian Retrieval Guide.

TimeSyncIODrivers

If enabled, the AVEVA Historian will send time synchronization commands to all associated remote IDASs. For more information, see Time synchronization for data acquisition.

TitleResults for “How to create a CRG?”Also Available in