Property Reference O-P | Historian 8.1 Documentation

P

PercentGood Property (DataValue Object)

Returns the percentage of time the value was of good quality during the interval the DataValue applies to. Does not apply to RawByNumber and RawByTime sampling modes.

Syntax

object.PercentGood

Parameters

None

Remarks

PercentGood is a read-only property of type Single.

Example

If MyValue.PercentGood < 50 Then   err.Raise 1,, "We do not have enough good data" End If

PerformanceDSStatistics (Archives Object)

Exposes performance statistics for the data store. These statistics are updated periodically.

The Product server and new current values are automatically reported to the client and updated in the PerformanceDSStatistics collection.

Syntax

object.PerformanceDSStatistics

Parameters

None

Remarks

PerformanceDSStatistics is a read-only property of type Collection of Variant.

PerformanceDSStatistics (Archives Object)

Exposes performance statistics for the data stores. These statistics are updated periodically.

The server and new current values are automatically reported to the client and updated in the PerformanceDSStatistics collection.

The following table describes each of the performance statistics and their purpose.

DataStores Performance Statistics

Statistic	Description
ArchiveTotalEvents	Total number of data points received by the data store. This option is specific only to data stores.
ArchiveTotalOutOfOrder	Total number of data points received by the server out of time order with the current value. This option is specific only to data stores.
ArchiveAverageEventRate	Average events processed per minute. This option is specific only to data stores.
ArchiveMinimumEventRate	Minimum events processed per minute. This option is specific only to data stores.
ArchiveMaximumEventRate	Maximum events processed per minute. This option is specific only to data stores.
ArchiveWriteCacheHitRatio	Hit Ratio To Write Cache. This option is specific only to data stores.
ArchiveAverageCompressionRatio	Average compression ratio for all tags. This option is specific only to data stores.
ArchiveMinimumCompressionRatio	Minimum compression ratio for any tag. This option is specific only to data stores.
ArchiveTotalFailedWrites	Total number of refused write attempts by any connection. This option is specific only to data stores.
ArchiveTotalMessages	Total number of non-alert messages generated. This option is specific only to data stores.
ArchiveTotalAlerts	Total number of alert messages generated. This option is specific only to data stores.
ArchiveFreeSpace	Amount of free space (MB) in the current archive. This option is specific only to data stores.
ArchiveSpaceConsumptionRate	Current free space consumption rate (MB/Day). This option is specific only to data stores.
ArchivePredictedDaysToFull	Predicted days to archive full. This option is specific only to data stores.
ArchiveSpaceEfficiency	Efficiency of archive space utilization. This option is specific only to data stores.
ArchiveAverageEventRateArray	An array of archiver received rates used to make the trend. This option is specific only to data stores.
ArchiveAverageAlarmRate	Displays the rate at which Historian is receiving alarm and event data. This option is specific only to data stores.
ArchiveTotalAlarm	The rate at which Historian is receiving data. This option is specific only to data stores.

Syntax

object.PerformanceDSStatistics

Parameters

None

Remarks

PerformanceDSStatistics is a read-only property of type Collection of Variant.

PerformanceStatistics (Archives Object)

Exposes performance statistics for the Product Archiver. These statistics are updated periodically.

The Product server and new current values are automatically reported to the client and updated in the PerformanceStatistics collection.

Syntax

object.PerformanceStatistics

Parameters

None

Remarks

PerformanceStatistics is a read-only property of type Collection of Variant.

PerformanceStatistics Property (Archives Object)

Exposes performance statistics for the Historian Archiver. These statistics are updated periodically. The Historian server and new current values are automatically reported to the client and updated in the PerformanceStatistics collection.

The following table describes each of the performance statistics and their purpose.

Archives Performance Statistics

Statistic	Description
ArchiveTotalOutOfOrder	Total number of data points received by the server out of time order with the current value. This option is specific only to data stores.
ArchiveAverageEventRate	Average events processed per minute. This option is specific only to data stores.
ArchiveMinimumEventRate	Minimum events processed per minute. This option is specific only to data stores.
ArchiveMaximumEventRate	Maximum events processed per minute. This option is specific only to data stores.
ArchiveWriteCacheHitRatio	Hit Ratio To Write Cache. This option is specific only to data stores.
ArchiveAverageCompressionRatio	Average compression ratio for all tags. This option is specific only to data stores.
ArchiveMinimumCompressionRatio	Minimum compression ratio for any tag. This option is specific only to data stores.
ArchiveTotalFailedWrites	Total number of refused write attempts by any connection. This option is specific only to data stores.
ArchiveTotalMessages	Total number of non-alert messages generated. This option is specific only to data stores.
ArchiveTotalAlerts	Total number of alert messages generated. This option is specific only to data stores.
ArchiveFreeSpace	Amount of free space (MB) in the current archive. This option is specific only to data stores.
ArchiveSpaceConsumptionRate	Current free space consumption rate (MB/Day). This option is specific only to data stores.
ArchivePredictedDaysToFull	Predicted days to archive full. This option is specific only to data stores.
ArchiveSpaceEfficiency	Efficiency of archive space utilization. This option is specific only to data stores.
ArchiveAverageEventRateArray	An array of archiver received rates used to make the trend. This option is specific only to data stores.
ArchiveAverageAlarmRate	Displays the rate at which Historian is receiving alarm and event data. This option is specific only to data stores.
ArchiveTotalAlarm	The rate at which Historian is receiving data. This option is specific only to data stores.

Syntax

object.PerformanceStatistics[AsLocalizedString])

Parameters

Name	Data Type	Description
StatisticName	String	Name of the statistic to retrieve (read-only).
AsLocalizedString	Boolean	Whether to return the statistic value(s) as a localized string (optional, default = True, read-only).

Remarks

PerformanceStatistics is a read-only property of type Collection of Variant.

Example

Dim TheStatistic As Variant
' Get The Overall Compression Performance Statistic
TheStatistic = MyArchives.PerformanceStatistics("ArchiveAverageCompressionRatio")

PerformanceStatistics Property (Collector Object)

Exposes performance statistics for the selected collector.

The following table describes each of the performance statistics and their purpose.

Collector Performance Statistics

Statistic Description

CollectorTotalEventsCollected	Total Values Collected
CollectorTotalEventsReported	Total Values Reported To Server.
CollectorOutOfOrderEvents	Total Events Out Of Timestamp Order.
CollectorAverageEventRate	Average Events Reported / Minute.
CollectorMinimumEventRate	Minimum Events Reported / Minute.
CollectorMaximumEventRate	Maximum Events Reported / Minute.
CollectorReportRatio	Ratio Of Events Collected To Events Reported.
CollectorCompressionPercent	The percent of data compressed by the collector.
CollectorMisses	The data that are missed by the collector due to missing scheduled collection times. Also called Overruns.

Syntax

object.PerformanceStatistics(StatisticName,[AsLocalizedString])

Parameters

Name	Data Type	Description
StatisticName	Variant	Name of the statistic to retrieve (read-only).
AsLocalizedString	Boolean	Whether to return the statistic value(s) as a localized string (optional, default = True, read-only).

Example

Dim TheStatistic As Variant
' Get The Overall Compression Performance Statistic
TheStatistic = MyCollector.PerformanceStatistics("CollectorEventRate")

PrimaryUsername Property (DataComments Object)

Returns the user who added the comment to the archive.

Syntax

object.PrimaryUsername

Parameters

None

Remarks

PrimaryUsername is a read-only property of type String.

Example

Debug.Print "Comment added by: " + MyValue.Comments(1).PrimaryUsername

PrincipalCollector Property (Collector Object)

The name of the collector this collector is backing up. If the principal collector is not responding this collector is next in line to become active.

Syntax

object.PrincipalCollector[ = String]

Parameters

None

PropertyList Property (Archives Object)

This function returns a list of the supported Archive properties.

Syntax

object.PropertyList

Parameters

None

PropertyList Property (Collectors Object)

Returns a list of the available collector properties. This is a complete list across all collector types. A given collector may ignore certain properties if they do not apply.

Syntax

object.PropertyList

Parameters

None

PropertyList Property (Data Object)

This function returns a list of the available Properties of a Data value.

Syntax

object.PropertyList([ExcludeRaw], [ExcludeAlarms])

Parameters

Name	Data Type	Description
ExcludeRaw	Boolean	Whether to exclude the PercentGood property (optional, default = False).
ExcludeAlarms	Boolean	Whether to exclude the Alarm Message and Alarm ID properties (optional, default = False).

PropertyList Property (Messages Object)

Returns a list of available Properties for a message.

Syntax

object.PropertyList

Parameters

None

PropertyList Property (Tags Object)

Returns a list of valid Properties for a Tag.

Syntax

object.PropertyList

Parameters

None

QueryModifiers Property (QueryModifiers Object)

Returns or sets the QueryModifiers to be used during the DataRecordset query.

Syntax

object.QueryModifiers

  Set resQueryModifiers ConnectedServer.CriteriaFromStrings(txtQueryModifier.Text)
   .Criteria.QueryModifiers = resQueryModifiers.QueryModifiers