Property Reference E-F | Historian 8.1 Documentation

EndTime Property (Archive Object)

Returns the end time of the specified archive. This represents the latest timestamp for any tag contained in the archive.

Syntax

object.EndTime

Parameters

None

Remarks

EndTime is a read-only property of type Date.

EndTime Property (DataCriteria Object)

Returns or sets the end of the time range to retrieve data for in the DataRecordset query.

Syntax

object.EndTime[ = Date]

Parameters

None

EndTime Property (MessageCriteria Object)

Establishes the end time of the MessageRecordset query.

Syntax

object.EndTime[ = Date]

Parameters

None

EndTimeSet Property (DataCriteria Object)

A flag to indicate whether this property has been set or not.

Syntax

object.EndTimeSet[ = Boolean]

Parameters

None

EndTimeSet Property (MessageCriteria Object)

A flag to indicate whether this property has been set or not.

Syntax

object.EndTimeSet[ = Boolean]

Parameters

None

EndTimeShortcut Property (DataCriteria Object)

Returns or sets the end of the time range to retrieve data for in the DataRecordset query. Shortcuts are strings that define absolute or relative times. The time shortcuts are the following:

Value	Description
(N)ow	The current time (absolute).
(T)oday	Today at midnight (absolute).
(Y)esterday	Yesterday at midnight (absolute).
(D)ays	Number of Days (relative).
(M)in	Number of Minutes (relative).
(H)our	Number of Hours (relative).
(W)eek	Number of Weeks (relative).
(BOM)	Beginning of this month at Midnight (absolute).
(EOM)	Last Day of this month at Midnight (absolute).
(BOY)	First Day of this year at Midnight (absolute).
(EOY)	Last Day of this year at Midnight (absolute).

Syntax

object.EndTimeShortcut[ = String]

Parameters

None

Example

With MyRecordset.Criteria   .Tagmask = "*.F_CV"   ' Start two days Ago at 8am in the morning   
.StartTimeShortcut = "Today-2d+8h"   ' End this morning at 8am   .EndTimeShortcut = "Today+8h" End With

EndTimeShortcut Property (MessageCriteria Object)

Establishes the end time of the MessageRecordset query by specifying a time shortcut string versus a date. The time shortcuts are the following:

Value	Description
(N)ow	The current time (absolute).
(T)oday	Today at midnight (absolute).
(Y)esterday	Yesterday at midnight (absolute).
(D)ays	Number of Days (relative).
(M)in	Number of Minutes (relative).
(H)our	Number of Hours (relative).
(W)eek	Number of Weeks (relative).
(BOM)	Beginning of this month at Midnight (absolute).
(EOM)	Last Day of this month at Midnight (absolute).
(BOY)	First Day of this year at Midnight (absolute).
(EOY)	Last Day of this year at Midnight (absolute).

Syntax

object.EndTimeShortcut[ = String]

Parameters

None

Example

' Set A End Time For Now MyMessages.Criteria.EndTimeShortcut = "Now"

EndTimeShortcutSet Property (MessageCriteria Object)

A flag to indicate whether this property has been set or not.

Syntax

object.EndTimeShortcutSet[ = Boolean]

Parameters

None

EngineeringUnits Property (Tag Object)

Returns or sets the engineering unit description of the Tag. Changes to tag properties are not committed until you call the WriteRecordset method of the TagRecordset object.

Syntax

object.EngineeringUnits[ = String]

Parameters

None

EngineeringUnits Property (TagCriteria Object)

Sets the engineering unit description to search for in the TagRecordset query.

Syntax

object.EngineeringUnits[ = String]

Parameters

None

EngineeringUnits Property (TagFields Object)

Determines whether the EngineeeringUnits field should be returned in the TagRecordset query.

Syntax

object.EngineeringUnits[ = Boolean]

Parameters

None

EngineeringUnitsSet Property (TagCriteria Object)

A flag to indicate whether this property has been set or not.

Syntax

object.EngineeringUnits[ = Boolean]

Parameters

None

EngineeringUnitsUpdated Property (Tag Object)

A flag to indicate whether this property has been set or not.

Syntax

object.EngineeringUnitsUpdated[ = Boolean]

Parameters

None

ErrorList Property (Server Object)

Returns a collection of error messages accumulated during the current session of the Server object. Each message includes a timestamp indicating the time the error was generated and each includes an error message translated into the locale of the client, when possible.

Syntax

object.ErrorList

Parameters

None

Remarks

ErrorList is a read-only property of type Collection of String.

Example

ErrorTrap: Dim I As Long ' Loop through the ErrorList and print to the debug window For I = 1 To MyServer.ErrorList.count Debug.Print MyServer.ErrorList(I) Next I

F

FailoverOnBadQuality Property (Collector Object)

Returns or sets whether the collector should automatically failover when the watchdog tag quality goes to BAD.

Syntax

object.FailoverOnBadQuality[ = Boolean]

Parameters

None

FailoverOnCollectorStatus Property (Collector Object)

Returns or sets whether the collector should automatically failover when the currently active collector status goes to UNKNOWN.

Syntax

object.FailoverOnCollectorStatus[ = Boolean]

Parameters

None

FailoverOnNonZeroValue Property (Collector Object)

Returns or sets whether the collector should automatically failover when the watchdog tag value goes to non-zero.

Syntax

object.FailoverOnNonZeroValue[ = Boolean]

Parameters

None

FailoverOnValue Property (Collector Object)

Returns or sets whether the collector should automatically failover based on the value of the watchdog tag. Set the FailoverOnNonZeroValue property or FailoverOnValueUnchanged property to indicate the exact criteria.

Syntax

object.FailoverOnValue[ = Boolean]

Parameters

None

FailoverOnValueUnchanged Property (Collector Object)

Returns or sets whether the collector should automatically failover when the watchdog tag value remains unchanged. Use the WatchdogValueMaxUnchangedPeriod property to specify the time period.

Syntax

object.FailoverOnValueUnchanged[ = Boolean]

Parameters

None

Fields Property (DataRecordset Object)

Returns the DataFields object which contains the information. on which fields are returned in the DataRecordSet

Syntax

object.Fields

Parameters

None

Fields Property (MessageRecordset Object)

Returns the Fields object that is used to identify which Message fields to return from the Historian server when a MessageRecordset query executes.

Syntax

object.Fields

Parameters

None

Remarks

Fields is a read-only property of type MessageFields.

Fields Property (TagRecordset Object)

Returns the Fields object that is used to identify which Tag fields to return from the Historian server when a TagRecordset query executes.

Syntax

object.Fields

Parameters

None

Remarks

Fields is a read-only property of type TagFields.

FileName Property (Archive Object)

Returns or sets the file name of the specified archive. The filename must be specified in the context of the Historian server drives and directories.

Changing the file name of an archive moves the archive from one file location to another.

Syntax

object.FileName[ = String]

Parameters

None

Example

Dim I As Long ' List The FileName and FileSize Of Each Archive With MyArchives   
For I = 1 To .Item.count     Debug.Print .Item(I).Name, .Item(I).FileName, .Item(I).FileSizeCurrent   
Next I End With ' Move The Archive To A New Directory, 
Path Context Of Server On Error GoTo ErrorTrap MyArchive.FileName = NewArchiveFilename ErrorTrap:   
Debug.Print "

FileSizeCurrent Property (Archive Object)

Returns the number of MB used in the specified archive file. This number is less than or equal to the file size on disk.

Changing the file name of an archive moves the archive from one file location to another.

Syntax

object.FileSizeCurrent

Parameters

None

Remarks

FileSizeCurrent is a read-only property of type Long.

Example

Dim I As Long ' List The FileName and FileSizeCurrent Of Each Archive With MyArchives   
For I = 1 To .Item.count     Debug.Print .Item(I).Name, .Item(I).FileName, .Item(I).FileSizeCurrent   
Next I End With

FileSizeTarget Property (Archive Object)

Returns or sets the target file size for the specified archive file in MB.

Syntax

object.FileSizeTarget[ = Long]

Parameters

None

Remarks

FileSizeCurrent is a read-only property of type Long.

Example

Debug.Print "Target File Size for archive " & MyArchive.FileSizeTarget

FilterComparisonMode Property (DataCriteria Object)

Returns or sets the type of comparison to be made on the FilterComparisonValue to apply appropriate filter to the DataRecordset query. If a FilterTag and FilterComparisonValue are supplied the query attempts to filter out time periods from the results where the filter condition is False. The FilterComparisonMode defines how archive values for the FilterTag should be compared to the FilterComparisonValue to establish the state of the filter condition.

The table below defines the available Filter Comparison Modes:

Value	Description	Value
Equal	Filter condition is True when the FilterTag is equal to the comparison value.	1
NotEqual	Filter condition is True when the FilterTag is NOT equal to the comparison value.	2
LessThan	Filter condition is True when the FilterTag is less than the comparison value.	3
GreaterThan	Filter condition is True when the FilterTag is greater than the comparison value.	4
LessThanEqual	Filter condition is True when the FilterTag is less than or equal to the comparison value.	5
GreaterThanEqual	Filter condition is True when the FilterTag is greater than or equal to the comparison value.	6

Syntax

object.FilterComparisonMode[ = iHistorian_SDK.ihFilterComparisonMode]

Parameters

None

FilterComparisonModeList Property (Data Object)

This function returns a list of the available Filter Comparison modes for a data request.

Syntax

object.FilterComparisonModeList

Parameters

None

FilterComparisonModeSet Property (DataCriteria Object)

A flag to indicate whether this property has been set or not.

Syntax

object.FilterComparisonModeSet[ = Boolean]

Parameters

None

FilterComparisonValue Property (DataCriteria Object)

Sets the value to compare the filter tag with when applying the appropriate filter to the DataRecordset query.

Syntax

object.FilterComparisonValue[ = Variant]

Parameters

None

FilterComparisonValue Property (DataCriteria Object)

Sets the value to compare the filter tag with when applying the appropriate filter to the DataRecordset query.

Syntax

object.FilterComparisonValue[ = Variant]

Parameters

None

FilterComparisonValueSet Property (DataCriteria Object)

A flag to indicate whether this property has been set or not.

Syntax

object.FilterComparisonValueSet[ = Boolean]

Parameters

None

FilterMode Property (DataCriteria Object)

Returns or sets the type of time filter applied to the DataRecordset query. If a FilterTag and FilterComparisonValue are supplied the query attempts to filter time periods from the results where the filter condition equals False. The FilterMode defines how time periods before and after transitions in the filter condition should be handled. For example, "AfterTime" indicates that the filter condition should be True starting at the timestamp of the archive value that triggered the True condition and leading up to the timestamp of the archive value that triggered the False condition.

Use the filter query to directly retrieve data for a particular lot number or batch of material. In this scenerio, you must know whether the batch number was written into the archive at the beginning of the batch or at the end of the batch. If the batch number is written at the beginning of the batch, use the "AfterTime" filter mode. If the batch number is written at the end of the batch, use the "BeforeTime" filter mode.

The table below defines the available Filter Modes:

Name	Description	Value
ExactTime	Retrieves data for the exact times that the filter condition is True.	1
BeforeTime	Retrieves data from the time of the last False filter condition up until the time of the True condition.	2
AfterTime	Retrieves data from the time of the True filter condition up until the time of next False condition	3
BeforeAndAfterTime	Retrieves data from the time of the last False filter condition up until the time of next False condition.	4

Syntax

object.FilterMode[ = iHistorian_SDK.ihFilterMode]

Parameters

None

FilterModeList Property (Data Object)

This function returns a list of the available Filtering modes for a data request.

Syntax

object.FilterModeList

Parameters

None

FilterModeSet Property (DataCriteria Object)

A flag to indicate whether this property has been set or not.

Syntax

object.FilterModeSet[ = Boolean]

Parameters

None

FilterTag Property (DataCriteria Object)

Returns or sets the tagname used to define the filter applied to the DataRecordset query. You can only specify a single tag (no wildcards).

Syntax

object.FilterTag[ = String]

Parameters

None

FilterTagSet Property (DataCriteria Object)

A flag to indicate whether this property has been set or not.

Syntax

object.FilterTagSet[ = Boolean]

Parameters

None

FullAreaNames Property (OPCBrowse Object)

Returns the fully-qualified area name for an AE server. When a browse operation occurs, the server returns all areas and sources under the BrowsePosition. The areas are akin to nodes (they can be set to the next browse position to traverse the tree). Sources are like leaves, and do not have children.

After a browse, the areas and leaves are populated in arrays, and the LeafName and AreaName properties allow you to access those arrays by index. The fully-qualified area name should be used to set the Browse Position. The Areanames property is used to display the individual areas.

Syntax

object.FullAreaNames(Index)

Parameters

Index - Integer - The index into the full area name array.

Remarks

FullAreaNames is a read-only String property returned as a variant for script compatibility.

FullLeafNames Property (OPCBrowse Object)

Returns the fully-qualified leaf name (source) for an AE server. When a browse operation occurs, the server returns all areas and sources under the BrowsePosition. The areas are akin to nodes (they can be set to the next browse position to traverse the tree). Sources are like leaves, and do not have children.

After a browse, the areas and leaves are populated in arrays, and the LeafName and AreaName properties allow you to access those arrays by index.

Syntax

object.FullLeafNames(Index)

Parameters

Index - Integer - The index into the full leaf name array.

Remarks

FullLeafNames is a read-only String property returned as a variant for script compatibility.