aaAddAnalogSummaryTag

TagName

The unique name of the tag within the AVEVA Historian system. This value is of data type nvarchar(256), with no default.

TagId

The unique tag ID of the tag within the AVEVA Historian system. The value is of data type uniqueidentifier, with a default of NULL.

Description

The description of the analog summary tag. This value is of data type nvarchar(512), with a default of an empty string.

SourceTag

The name of the source tag to create the analog summary tag from. This value is of data type nvarchar(256), with a default of an empty string.

SourceServer

The name of the source server for the source tag. This value is of data type nvarchar(256), with a default of an empty string.

SourceTagScaling

Used to specify whether the value is scaled.

0 = Not scaled.

1 = scaled. This value is of data type int, with a default of NULL.

SourceTagRawType

The numeric type for the raw value.

1 = Euro Float, an outdated data type (4 bytes)

2 = MS Float (4 bytes)

3 = Integer (2 or 4 bytes)

4 = MS Double (reserved for future use) (8 bytes)

This value is of data type int, with a default of 3.

SourceTagIntegerSize

The bit size of the analog tag.

12 = 12-bit

15 = 15-bit

16 = 16-bit

32 = 32-bit

64 = 64-bit (reserved for future use)

This value is of data type tinyint, with a default of 16.

SourceTagSignedInteger

Used to specify whether an integer is a signed number (positive or negative) or an unsigned number (positive only).

0 = Unsigned

1 = Signed

This value is of data type bit, with a default of 0.

CreatedBy

The name of the user or application that created the tag. This value is of data type nvarchar(256), with a default of an empty string.

DateCreated

The date that the tag was created. This value is of data type datetime2(7), with a default of NULL.

StructureId

The unique identifier for the structure. The value is of data type uniqueidentifier, with a default of NULL.

AcquisitionType

The method by which the tag's value is acquired. If the tag value is acquired from an I/O Server, specify the name of the I/O Server, topic, and item.

0 = Not acquired

1 = Acquired via an I/O Server

2 = Acquired via HCAL or MDAS or a manual update

3 = System driver

This value is of data type tinyint, with a default of 1.

StorageNodeKey

The unique numerical identifier for the storage node. This value is of data type int, with a default of 1.

IOServerKey

The unique numerical identifier for the I/O Server. This value is of data type int, with a default of NULL.

TopicKey

The unique numerical identifier for the topic. This value is of data type int, with a default of NULL.

StorageType

The type of storage defined for the tag.

0 = Not stored.

1 = Cyclic.

2 = Delta.

3 = Forced storage.

17 = The storage type has been changed from cyclic to "not stored."

18 = The storage type has been changed from delta to "not stored."

19 = The storage type has been changed from "forced" to "not stored."

This value is of data type smallint, with a default of 2.

EngineeringUnit

The unit of measure. Examples are mph, grams, and pounds. This value is of data type nvarchar(32), with a default of an empty string.

IntegralDivisor

The factor to be applied when integrating a rate with the units [EngUnits/TimeUnit] to a quantity with units [EngUnits]. This factor is called the integral divisor. The default value of 1 assumes a time unit of seconds and ensures that a rate of [Unit/second] is correctly integrated to [Unit]. For a time unit of minutes, set the integral divisor value to 60; for a unit of hours, set the integral divisor value to 3600. The integral divisor is applied similarly to rates or quantities that are not expressed in terms of a time unit. For example, to convert watts to watt-hours, the integral divisor is 1/3600. To convert watts to kilowatt-hours, the integral divisor is 1/3600000. This value is of data type float(25), with a default of 1.

MinEU

The minimum value of the tag, measured in engineering units. This value is of data type float, with a default of 0.

MaxEU

The maximum value of the tag, measured in engineering units. This value is of data type float, with a default of 100.

MinRaw

The minimum value of the raw acquired value. This value is of data type float, with a default of 0.

MaxRaw

The maximum value of the raw acquired value. This value is of data type float, with a default of 4095.

DeadbandType

The type of delta storage deadband to be applied for the tag. This setting is only in effect if delta storage is configured for the tag.

1= Time and/or value deadband

2 = Rate (swinging door) deadband

This value is of data type smallint, with a default of 1.

TimeDeadband

The minimum time, in milliseconds, between stored values for a single tag. Any value changes that occur within the time deadband are not stored. The time deadband applies to delta storage only. A time deadband of 0 indicates that the system will store the value of the tag each time it changes. This value is of data type int, with a default of 0.

CurrentEditor

Used to specify which application or editing environment controls the tag definition. Tags imported from the InTouch HMI software use InTouch as the current editor. If modifications are made to an imported tag in the historian Configuration Editor, then the current editor for the tag is changed to AVEVA Historian. If a re-import is performed, any modifications made using the Configuration Editor are preserved. You can manually maintain InTouch as the current editor for re-importing; however, all changes made to the tag using the Configuration Editor are lost during the re-import. Tags (attributes) that are initially configured using AVEVA Application Server use the ArchestrA Integrated Development Environment (IDE) as the current editor. If you modify an Application Server tag using the historian Configuration Editor, then the current editor for the tag is changed to AVEVA Historian. However, the next time you redeploy the engine, the changes are not preserved.

0 = AVEVA Historian

1 = InTouch

2 = AVEVA Application Server

This value is of data type int, with a default of 0.

wwTagKey

The unique numerical identifier of a tag within a single AVEVA Historian. This value is of data type int.

ChannelStatus

Used for tags from AVEVA Application Server 2012 R2 or later or the AVEVA Historian SDK 2012 R2 or later. Used to specify how disconnects between these sources and the AVEVA Historian are reflected in the data until the disconnect period can be backfilled with store-and-forward data, if store-and-forward is enabled.

1 = Enabled. NULL values are injected into the data stream for the disconnect period. For a trend, this means that a line gap appears during the period of NULL values. The tag remains in store-and-forward mode until the timestamps become greater than the startup time of the server or the time that the connection was restored.

0 = Disabled. NULL values are not injected and no gap is shown in client-side trends. The channel status value is ignored for tags that use classic storage.

This value is of data type tinyint, with a default of 1.