Configuration tag reference for OPC data sources

tagName

The unique name of the tag within the AVEVA Insight system.

description

(Optional.) The description of the tag, with a default of an empty string.

tagType

The type of tag.

For a discrete tag, the tag type is "boolean".

For an analog tag, the tag type may be:

• "int2" - a 2-byte signed integer

• "uint2" - a 2-byte unsigned integer

• "int4" - a 4-byte signed integer

• "uint4" - a 4-byte unsigned integer

• "float" - a single-precision floating point

engineeringUnit

(Optional.) The name of the engineering unit used to measure values for this tag. Examples are mph, grams, and pounds. The default is an empty string.

minEU

The minimum value of the tag, measured in engineering units.

This value is used for default scaling on charts when auto-scaling is not used.

This value is required, but ignored, for discrete/Boolean and string tags.

Note about scaling: When the EU and Raw do not match, then scaling is automatically initialized. If they are the same-- that is, MinEU=MinRaw and MaxEU=MaxRaw -- then scaling is set to "not scaled".

maxEU

The maximum value of the tag, measured in engineering units.This value is used for default scaling on charts when auto-scaling is not used.

This value is required, but ignored, for discrete/Boolean and string tags.

The note about scaling (see minEU) also applies to this element.

minRaw

(Optional) The minimum value of the raw acquired value, with a default of 0.

Omit this value except in cases where you want to store values differently than the engineering units. For example, EU values from the OPC server in the range 0.0 -100.0 can be stored with a precision of 0.001526 as a scaled "uint2" value by specifying a raw range of 0-65535.

The note about scaling (see minEU) also applies to this element.

maxRaw

(Optional) The maximum value of the raw acquired value, with a default of 100.

Omit this value except in cases where you want to store values differently than the engineering units. For example, EU values from the OPC server in the range 0.0 -100.0 can be stored with a precision of 0.001526 as a scaled "uint2" value by specifying a raw range of 0-65535.

The note about scaling (see minEU) also applies to this element.

messageOff

(Optional.) The message associated with the FALSE state of a discrete (boolean) tag. The maximum number of characters is 64. A discrete tag set to 0 is in the FALSE state.

Ignored for other tag types.

messageOn

(Optional.) The message associated with the TRUE state of the discrete (boolean) tag. The maximum number of characters is 64. A discrete tag set to 1 is in the TRUE state.

Ignored for other tag types.

computerName

(Optional.) The name of the computer on which the server runs.

applicationName

The application name of the OI Server. This name is usually the same as the executable file name.

Use "gateway" for OPC servers.

topicName

The name of the topic used to configure the gateway. (See Configure the gateway.)

itemName

The name of the OPC item as supported by the OPC server. Or, in the case of a FactorySuite gateway, an alias configured in the FactorySuite Gateway for the associated topic.

storageRateSecs

(Optional.) Sets a minimum storage frequency for new data values, with a default of 0 (stored only on changes).

For example, if this rate is set to 120, a data value will be recorded every two minutes, even if the value has not changed.

storageType

(Optional.) The type of storage defined for the tag: "delta", "cyclic", or "forced", with a default of "delta".

rolloverValue

(Optional.) The first value that causes the counter to "roll over." This rollover value is used by the "counter" retrieval mode. For example, a counter that counts from 0 to 9999, the counter rolls over back to 0 for the 10,000th value it receives. Therefore, set the rollover value to 10,000.

interpolation

(Optional.) The interpolation type for retrieval: "linear", "stairstep", or "systemdefault".

This setting impacts Interpolated, Average, and Integral retrieval modes.It also impacts plotting on line charts.

The system default interpolation type is to use the system default for the analog type, either integer or real. The system default interpolation type for an analog type is determined by the setting of the InterpolationTypeInteger and InterpolationTypeReal system parameters.

deadbandType

(Optional.) The type of delta storage deadband to be applied for the tag: "value", "rate", or "none".

This setting is only in effect if delta storage is configured for the tag.

valueDeadband

(Optional.) The percentage of the difference between the minimum and maximum engineering units for the tag, with a default of 0.

Any data values that change less than the specified deadband are not stored. The value deadband applies to delta storage only. A value of 0 indicates that a value deadband will not be applied.

Applies only to analog tags.

timeDeadbandMSecs

(Optional.) The minimum time, in milliseconds, between stored values for a single tag, with a default of 0.

Any value changes that occur within the time deadband are not stored. The time deadband applies to delta storage only.
0 indicates that the system will store the value of the tag each time it changes.

rateDeadband

(Optional.) The percentage of deviation in the full-scale value range for an analog tag, with a default of 0.

The swinging door (rate) deadband applies to delta storage only. Time and/or value deadbands can be used in addition to the swinging door deadband. Any value greater than 0 can be used for the deadband. A value of 0 indicates that a swinging door deadband will not be applied.

Applies only to analog tags.

serverTimeStamp

(Optional.) Used to indicate whether timestamps are supplied by toe source or by the AVEVA Insight service.

0 = (Default) Uses the timestamp supplied by the source (OPC server, etc.), if available, and otherwise uses the system time from the Publisher.

1 = Uses the time that the value is received by AVEVA Insight (except for store-forward data, which is always treated as "0").

If a fast-changing tag is configured to use server timestamping, the packet of data that is sent to the storage subsystem may contain multiple data values with the same timestamp, which may affect deadband calculations, such as for swinging door storage.

lateData

(Deprecated in Historian Publisher 4.7) Formerly used to specify how disconnects between these sources and AVEVA Insight reflected in the data until the disconnect period can be backfilled with store-and-forward data, if store-and-forward is enabled.

This parameter no longer has an effect. By default, NULL values are not injected and no gap is shown in client-side trends.

timeOutMSecs

(Optional.) The time span, in milliseconds, in which a data point must be received on the topic, with a default of 60000.

This value applies at the topic level, rather than to individual items. As long as any item for the topic is receiving values at least this often, the timeout will not expire.

publisherBufferMemory

(Optional.) The number of 64 KB buffers pre-allocated for buffering data. This number may need to be increased to accommodate high data rates.

publisherLatePackets

(Optional.)

publisherStoreForwardThresholdMB

(Optional.) The minimum amount of free disk space, in megabytes, at which the Publisher stops collecting data in the store-and-forward buffer.

publisherStoreForwardSecs

(Optional.) The minimum duration, in seconds, for the Publisher to function in store-and-forward mode. The Publisher functions in store-and-forward mode for this length of time even if the condition that caused the Publisher to function in store-and-forward mode no longer exists. The maximum duration is 3600 seconds, and the minimum is 0 seconds.

publisherStoreForwardPath

(Optional.) Used to specify the path for the Publisher data buffer on the local hard drive of the Publisher computer. The path should be absolute (for example, c:\IDASBuffer). Data is written to this path until the minimum threshold for the buffer is reached. Remote buffer paths are not supported.

When the store-and-forward path specified for the Publisher is invalid, the default path picked by the system is:

<public folder>\ArchestrA\Historian\IDAS\SF

where the <public folder> is dependent on the operating system.

For example, for the Windows 2008 operating system, the path is C:\ProgramData\ArchestrA\Historian\IDAS\SF

When the store-and-forward path specified for the Publisher is just a folder name (without any path characters like \ and :), the default path picked by the system is:

<Windows system path>\<folder name specified by the user>

For example, for the Windows Server 2008 32-bit operating system, the path is C:\WINDOWS\system32\<folder name>.

publisherProcessingSecs

(Optional.) Used for late data only. The amount of time, in seconds, after which late data is processed, regardless of the idle duration. If the nature of the data is such that the idle duration is never satisfied, the historian storage engine processes data from the topic at least one time every processing interval. The processing interval defaults to twice the idle duration and cannot be set to a value less than the idle duration.

publisherIdleSecs

(Optional.) The amount of time, in seconds, before data is processed. For example, if you set this value to 60 seconds, data is cached and only processed after no more data has been received for at least 60 seconds.

suiteLinkTimeSyncSecs

(Optional.) Frequency, in seconds, that Publisher will attempt to synchronize the timestamping mechanism. If this parameter is set to 0, no time synchronization will occur. This helps improve system time consistency across nodes used by the Publisher, such as when the Publisher connects to a gateway running on a different computer.

suiteLinkTimeSyncEnabled

(Optional.) Specified whether time synchronization is enabled (1) or disabled (0).