Property Reference

Important: You do not have the latest version of Historian! You are missing out on the newest capabilities and enhanced security. For information on all the latest features, see the Historian product page. For more information on upgrades, contact your GE Digital sales agent or e-mail GE Digital Sales Support. For the most up-to-date documentation, go here.

Property Reference A-B

AdministratorSecurityGroup Property (TagCriteria Object)

Sets the administrator security group for which the TagRecordset query searches.

Syntax

object.AdministratorSecurityGroup[ = String]

Parameters

None

AdministratorSecurityGroup Property (TagFields Object)

Determines whether the TagRecordset query returns the AdministratorSecurityGroup field.

Parameters

object.AdministratorSecurityGroup[ = Boolean]

Parameters

None

AdministratorSecurityGroup Property (UserDefinedType Object)

Returns or sets the name of the Administrator Security Group that controls the definition of a User Defined Type. You can create, modify or delete types if you have Administration Security Group permission to do so. If there is no assigned group then the name will be empty.

Syntax

object.MyAdministratorSecurityGroup

Parameters

None

Returns

String

AdministratorSecurityGroupSet Property (TagCriteria Object)

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

Syntax

object.AdministratorSecurityGroupSet[ = Boolean]

Parameters

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

Syntax

object.ArchiveAbsoluteDeadbandingUpdated[ = Boolean]

Parameters

None

ArchiveAllowDataOverwrites Property (Archives Object)

object.Archives

Parameters

None

Remarks

Archives is a read-only property of type Archives.

Example

Dim MyServer As New iHistorian_SDK.Server 
            Dim MyArchives As iHistorian_SDK.Archives ' Connect to the local server 
            If Not MyServer.Connect("", "", "") 
            Then   err.Raise 1, , "Failed to connect to the local server" End If 
            ' We are connected, try to instantiate the Archives object Set MyArchives = MyServer.Archives 
            If MyArchives Is Nothing Then   err.Raise 1, , "User is not able to manage archives" End If

Archiving Property (Archives Object)

Returns the Archiving status of the current archive.

Syntax

object.Archiving[ = Boolean]

Parameters

None

ArchivingOptions Property (Archives Object)

Exposes the ArchivingOptions collection to control the behavior of the Historian Archiver.

The following table describes each of the archiving options:

Option Description

Option	Description
ArchiveSizeIncrement	Sets the size increments of the archive file (Default=100MB). This option is specific to a data store.
ArchiveDefaultPath	Specifies the default path that the archives are created in. This option is specific to a data store.
ArchiveActiveHours	Specifies the hours before now that the data becomes Read-Only. This option is specific to data store.
ArchiveDefaultSize	Specifies the create archive default size in MB. This option is specific to a data store.
ArchiveAutomaticCreate	Specifies whether the system automatically creates archives when all empty archives are filled. This option is specific to a data store.
ArchiveAutomaticFreeSpace	The amount of free space required on the drive of the default path after creating an archive of default size. This option is specific to a data store.
ArchiveOverwriteOld	Determines whether or not old archives are cleared and re-used when no other empty space is available. This option is specific to a data store.
ArchiveBackupPath	Specifies the default path for backup archives. This option is specific to a data store.
ArchiveBaseName	Specifies the default string archive names should be based on. This option is specific only to a data store.
ArchiveBaseFileName	Returns a default string that an archive file names must be based on. This option is specific to a data store.
ArchiveCreateOfflineArchives	Returns whether a Data Archiver should accept data before starting an old archive. This option is specific to a data store.
ArchiveUseClientLoginUser	Returns whether a Data Archiver requires users to enter a user name and password details in the client application. This option is specific to a data store.
ArchiveAllowDataOverwrites	Returns whether or not a Data Archiver should allow overwriting of an existing data. This option is specific to a data store.
ArchiveDuration	Number of Units of time an archive can hold. Defined by ArchiveDurationType. This option is specific to a data store.
ArchiveTotalDuration	Number of Hours that the archives for a DataStore can span. (This is only meaningful for ScadaBuffer DataStores) This option is specific to a data store.
ArchiveDurationType	The type of archive duration. ArchiveDurationBySize ArchiveDurationDaily ArchiveDurationHourly This option is specific to a data store.
ArchiveUseCaching	Indicates whether the archive should use caching or not. Set it to 1 to use caching and to 0 if you do not want to use caching. This option is specific to a data store.
ArchiveCacheSize	This is for internal use.
ArchiverServerMemoryLoad	How much server memory the Historian Data Archive is consuming. This option is specific to the data archiver.
ArchiverEquipmentDelimiter	This is for internal use.
ArchiverServerMemoryLoad	How much server memory the Historian Data Archive is consuming. This option is specific to the data archiver.
ArchiverEquipmentDelimiter	This is for internal use.
MessageOnDataUpdate	How much server memory the Historian Data Archive is consuming. This option is specific to the data archiver.
ArchiveMaxMemoryBufferSize	The maximum buffer memory (MB). This option is specific to the data archiver.
ArchiverTargetPrivateBytes	The memory size of the archiver. If it is 0, it means that it is managed by server. Otherwise, enter a number in megabytes of memory. This option is specific to the data archiver.
CollectorIdleTime	The number of seconds before a collector is considered idle. If this number is set to 270 seconds and no data for any tags is received for 270 seconds then the collector is considered idle. This option is specific to the data archiver.
MaximumQueryIntervals	Specifies the maximum number of samples per tag that Historian can return from a non-raw data query. Use this setting to throttle query results for non-raw data queries. This setting does not apply to filtered data queries or raw data queries. This option is specific to the data archiver.
MaximumQueryTime	Specifies the maximum time that a data or message query can take before it is terminated. Use this setting to limit query time and provide balanced read access to the archiver. This applies to all query types. This option is specific to the data archiver.

Syntax

object.ArchivingOptions(OptionName) [ = Variant]

Parameters

Name OptionName Data type String Description The name of an archiving option.

Example

MyServer.DataStores.DataStoreUpdate("MYDATASTORE", True, "", "") Then

maintain auto recovery files

MyServer.MaintainAutoRecoveryFiles =TRUE

AreaCount Property (OPCBrowse Object)

Returns the number of Areas under a browse position. When a browse operation occurs, the server returns all areas and sources under the BrowsePosition. AreaCount gives you the number of Areas, which you can use to iterate the AreaNames and FullAreaNames arrays.

Syntax

object.AreaCount

Parameters

None

Remarks

AreaCount is a read-only property returned as type Long.

AreaNames Property (OPCBrowse Object)

Returns an area name for an AE server. See FullAreanames property for details.

Syntax

object.AreaNames(Index)

Parameters

Index. Integer. The index into the area nae array

Remarks

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

Areas Property (OPCFilters Object)

Returns a list of the Areas selected for collection. This list is only applied when isAreaFiltering (true) has been called.

Syntax

object.Areas

Parameters

None

AuditMessage Property (Server Object)

Returns or sets the E-signature audit message. Setting the audit message to an empty string will use the system default message.

Syntax

object.AuditMessage[ = String]

Parameters

None

AutoReconnectRateSeconds Property (OPCFilters Object)

If AutoReconnect logic is enabled (isAutoReconnectOn(true)) this property represents the rate in seconds that the Alarm Collector with attempt to determine if the server is still alive.

Syntax

object.AutoReconnectRateSeconds[ = Long]

Parameters

None

B

BrowsePosition Property (OPCBrowse Object)

Returns the current value of the browse position in the hierarchy.

Syntax

object.BrowsePosition[ = Variant]

Parameters

None

Remarks

This is used for subsequent browse calls to get the leaf under the current position.

BrowseRoot Property (OPCBrowse Object)

Returns the root name of the OPC area hierarchy.

Syntax

object.BrowseRoot

Parameters

None

Remarks

BrowseRoot is a read-only property of type String.

Property Reference C-D

CalcType Property (Tag Object)

Returns or sets the CalcType for the tag. The CalcType is used to determine whether the tag is a Python Expression tag or a Raw tag.

Name	Description	Value
RawTag	A tag is not a Python Expression Tag	0
PythonExprTag	A tag that uses a Python Expression to transform raw data into derived values.	2

Syntax

object.CalcType [=ihTagCalcType]

Parameters

None

CalcType Property (TagCriteria Object)

Returns or sets the CalcType for the tag. The CalcType is used to determine whether the tag is a Python Expression tag or a Raw tag.

Name	Description	Value
RawTag	A tag is not a Python Expression Tag	0
PythonExprTag	A tag that uses a Python Expression to transform raw data into derived values.	2

Syntax

object.CalculationDependencies

Parameters

None

Remarks

CalculationDependencies is a read-only property of type TagDependencies.

CalculationDependencies Property (TagFields Object)

Example

' Check Security If Not MyServer.Archives.CanAdministerConfiguration Then   err.Raise 1, "Security", 
"You Are Not Authorized To Make Configuration Changes" End If

CanAdministerConfiguration Property (Collectors Object)

Returns whether the current user is authorized to perform configuration changes to Collectors.

Syntax

object.CanAdministerConfiguration

Parameters

None

Remarks

CanAdministerConfiguration is a read-only property of type Boolean.

Example

' Check Security If Not MyServer.Archives.CanAdministerConfiguration Then   err.Raise 1, "Security", 
                    "You Are Not Authorized To Make Configuration Changes" End If

CanAdministerSecurity Property (Server Object)

Returns whether the current user is authorized to perform tag security changes.

Syntax

object.CanAdministerSecurity

Parameters

None

Remarks

CanAdministerSecurity is a read-only property of type Boolean.

Example

Dim MyServer As New iHistorian_SDK.Server ' Connect to the local server If Not MyServer.Connect("", "", "") Then   
err.Raise 1, , "Failed to connect to local server" End If If Not MyServer.Tags.CanAdministerConfiguration Then   
err.Raise 1, , "Cannot administer security" End If

CanAdministerSecurity Property (Tags Object)

Returns whether the current user is authorized to security configuration changes.

Syntax

object.CanAdministerSecurity

Parameters

None

Remarks

CanAdministerSecurity is a read-only property of type Boolean.

CanAudit Property (Server Object)

Returns whether E-signatures are enabled on the hardware key.

Syntax

object.CanAudit

Parameters

None

Remarks

CanAudit is a read-only property of type Boolean.

CanCalculate Property (Server Object)

Returns whether the Calculation collector is enabled on the hardware key.

Syntax

object.CanCalculate

Parameters

None

Remarks

CanCalute is a read-only property of type Boolean.

CanRead Property (Data Object)

Returns whether the current user is authorized to read data from the server.

Syntax

object.CanRead

Parameters

None

Remarks

CanRead is a read-only property of type Boolean.

Example

' Check Security If Not MyData.CanRead Then   err.Raise 1, , "You are not authorized to read data from this server" End If

CanRead Property (Messages Object)

Returns whether the current user is authorized to read messages from the server.

Syntax

object.CanRead

Parameters

None

Remarks

CanRead is a read-only property of type Boolean.

Example

' Check Security If Not MyData.CanRead Then   err.Raise 1, , "You are not authorized to read messages from this server" End If

CanReplicate Property (Server Object)

Returns whether ServerToServer collector is enabled on the hardware key.

Syntax

object.CanRelpicate

Parameters

None

Remarks

None

CollectionOffset Property (TagCriteria Object)

Sets the collection offset to search for in the TagRecordset query.

Syntax

object.CollectionOffset[ = Long]

Parameters

None

CollectionOffset Property (TagFields Object)

Sets Determines whether the TagRecordset query returns the CollectionOffset field.

Syntax

object.CollectionOffset[ = Boolean]

Parameters

None

CollectionOffsetSet Property (TagCriteria Object)

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

Syntax

object.CollectionOffset[ = Boolean]

Parameters

None

CollectionOffsetUpdated Property (Tag Object)

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

Syntax

object.CollectionOffsetupdated[ = Boolean]

Parameters

None

CollectionType Property (Tag Object)

Returns or sets the type of collection used to acquire data for the Tag. Changes to tag properties are not committed until you call the WriteRecordset method of the TagRecordset object.

The table below lists the available types of collection:

Name	Description	Value
Unsolicited	New values are reported by the source.	1
Polled	New values are polled from the source.	2

CollectorDeadbandPercentRange Property (TagCriteria Object)

Sets the collector compression deadband to search for in the TagRecordset query.

Syntax

object.CollectorDeadbandPercentRange[ = Single]

Parameters

None

CollectorDeadbandPercentRange Property (TagFields Object)

Determines whether the TagRecordset query returns the CollectorDeadbandPercentRange field.

Syntax

object.CollectorDeadbandPercentRange[ = Boolean]

Parameters

None

CollectorDeadbandPercentRangeSet Property (TagCriteria Object)

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

Syntax

object.CollectorDeadbandPercentRangeSet[ = Boolean]

Parameters

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

Syntax

object.CollectorGeneral1Set[ = Boolean]

Parameters

None

CollectorGeneral1Updated Property (Tag Object)

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

Syntax

object.CollectorGeneral1Updated[ = Boolean]

Parameters

None

CollectorGeneral2 Property (Tag Object)

Returns or sets the general2 (or spare) configuration field for the tag. Changes to tag properties are not committed until you call the WriteRecordset method of the TagRecordset object.

Syntax

object.CollectorGeneral2[ = String]

Parameters

None

CollectorGeneral2 Property (Tagcriteria Object)

Sets the general2 (spare) field value to search for in the TagRecordset query.

Syntax

object.CollectorGeneral2[ = String]

Parameters

None

CollectorGeneral2 Property (TagFields Object)

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

Syntax

object.CollectorGeneral2[ = Boolean]

Parameters

None

Example

With MyRecordset.Fields .Clear .TagName = True .Description = True .CollectorGeneral1 = True .CollectorGeneral2 = True 
.CollectorGeneral3 = True .CollectorGeneral4 = True .CollectorGeneral5 = True End With

CollectorGeneral2Set Property (TagCriteria Object)

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

Syntax

object.CollectorGeneral2[ = Boolean]

Parameters

None

CollectorGeneral2Updated Property (Tag Object)

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

Syntax

object.CollectorGeneral2Updated[ = Boolean]

Parameters

None

CollectorGeneral3Updated Property (Tag Object)

Returns or sets the general3 (or spare) configuration field for the tag. Changes to tag properties are not committed until you call the WriteRecordset method of the TagRecordset object.

Syntax

object.CollectorGeneral3[ = String]

Parameters

None

CollectorGeneral3 Property (TagCriteria Object)

Sets the general3 (spare) field value to search for in the TagRecordset query.

Syntax

object.CollectorGeneral3[ = String]

Parameters

None

CollectorGeneral3 Property (TagFields Object)

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

Syntax

object.CollectorGeneral3[ = Boolean]

Parameters

None

Example

With MyRecordset.Fields .Clear .TagName = True .Description = True .CollectorGeneral1 = True 
.CollectorGeneral2 = True .CollectorGeneral3 = True .CollectorGeneral4 = True .CollectorGeneral5 = True End With

CollectorGeneral3Set Property (TagCriteria Object)

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

Syntax

object.CollectorGeneral3Set[ = Boolean]

Parameters

None

CollectorGeneral3Updated Property (Tag Object)

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

Syntax

object.CollectorGeneral3Updated[ = Boolean]

Parameters

None

CollectorGeneral4 Property (Tag Object)

Returns or sets the general4 (or spare) configuration field for the tag. Changes to tag properties are not committed until you call the WriteRecordset method of the TagRecordset object.

Syntax

object.CollectorGeneral4[ = String]

Parameters

None

CollectorGeneral4 Property (TagCriteria Object)

Sets the general4 (spare) field value to search for in the TagRecordset query.

Syntax

object.CollectorGeneral4[ = String]

Parameters

None

CollectorGeneral4 Property (TagFields Object)

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

Syntax

object.CollectorGeneral4[ = Boolean]

Parameters

None

Example

With MyRecordset.Fields .Clear .TagName = True .Description = True .CollectorGeneral1 = True 
.CollectorGeneral2 = True .CollectorGeneral3 = True .CollectorGeneral4 = True .CollectorGeneral5 = True End With

CollectorOptions Property (Collector Object)

Exposes the CollectorOptions collection to control the behavior of a specific collector.

The following table describes each of the options:

Option Description

Option	Capability
CollectorCanBrowseSource	TRUE if the collector supports browse.
CollectorMaxMemoryBufferSize	Specifies the size in megabytes of the memory buffer assigned to the store and forward function.
Source Address	Yes
CollectorMaxDiskBufferSize	Specifies the minimum free disk space that must be available on the computer and cannot be used for store and forward function.
CollectorRateOutputAddress	Specifies the address in the source database into which the collector will write the current value of the events per minute output.
CollectorStatusOutputAddress	Specifies the address in the source database into which the collector will write the current value of the collector status (running, stopped, unknown, etc.).
CollectorAdjustForTimeDifference	TRUE if you want to adjust collector timestamps to match the server clock.
CollectorStartDelay	A delay, in seconds, after collector startup before collection starts.
CollectorSourceTimesLocal	If you are using source timestamps, set this to TRUE if the source timestamps are in local time.
CollectorMakeTagChangesOnline	Set to TRUE if you want tag changes to take effect without restarting collector.

Syntax

object.CollectorTrackingEventList

Parameters

None

CollectorType Property (Collector Object)

Returns or sets Collector Type property for the Collector.

Syntax

object.CollectorType[ = String]

Parameters

None

Example

' Print Out The CollectorType configured for the collector
 Debug.Print MyCollector.CollectorType

CollectorType Property (Tag Object)

Returns or sets the type of Collector responsible for collecting data for the Tag. Changes to tag properties are not committed until you call the WriteRecordset method of the TagRecordset object.

Syntax

object.CollectorType[ = String]

Parameters

None

CollectorType Property (TagCriteria Object)

Sets the collector type to search for in the TagRecordset query.

Syntax

object.CollectorType[ = String]

Parameters

None

CollectorType Property (TagFields Object)

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

Syntax

object.CollectorType[ = Boolean]

Parameters

None

CollectorTypeList Property (Collectors Object)

Returns a list of Collector Types available. These types may be used in other SDK functions.

Syntax

object.CollectorTypeList

Parameters

None

Example

'Get a List of the Available Collector Types Dim ListArray As Variant Dim I As Integer ListArray = MyCollectors.CollectorTypeList For I = LBound(ListArray) To UBound(ListArray) Debug.Print "Historian has a " + ListArray(I, 2) + " collector" Next I

CollectorTypeSet Property (TagCriteria Object)

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

Syntax

object..CollectorTypeSet[ = Boolean]

Parameters

None

CollectorTypeUpdated Property (Tag Object)

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

Syntax

object.CollectorTypeUpdated[ = Boolean]

Parameters

None

Examples

Body text goes here.

Column Header	Column Header
Table text	Table text
Table text	Hit tab to add rows

Comment Property (Collector Object)

Returns or sets the Comment property for this collector.

Syntax

object.Comment[ = String]

Parameters

None

Comment Property (DataComments Object)

Returns the comment associated with the DataValue.

Syntax

CommentTimestamp is a read-only property of type Date.

Example

Debug.Print "Comment added at: " + _   Format$(MyValue.Comme

CommentSet Property (TagCriteria Object)

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

Syntax

object.CommentSet[ = Boolean]

Parameters

Connected is a read-only property of type Boolean.

ConnectionOptions Property (Server Object)

Returns the collection of options for the current connection. To set individual options refer to the following table.

TimeOption	Converts timestamps to and from the local time zone	String = Local
	Converts timestamps to and from the server time zone.	String = Server

	Converts Timestamps To/From Explicit. The timezone is specified in the TimeZoneBias option.	String = Explicit
TimeZoneBias	Converts timestamps to and from a specific offset from GMT (minutes)	Long
AdjustDayLightSavings	Converts timestamps by adjusting for daylight savings	Boolean

Syntax

object.ConnectionOptions(OptionName) [ = Variant]

Parameters

Name	Data Type	Description
OptionName	Variant	The name of a connection option

None

Remarks

Returns the Criteria object used to identify which DataValues the Historian server returns when a DataRecordset query is executed.

The following procedure describes the steps involved in specifying criteria of a DataRecordset Query.

Supply tags for query. You can specify tags in one of two ways:
1. Supply a Tagmask that searches for all tags that match the mask and apply the remaining criteria to retrieve data. The mask can include wildcards. or
2. Supply an array of strings representing the list of tags to retrieve data for by using the Tags() property of the DataCriteria object.
Supply time frame for query.
To supply a time frame for the query, set the StartTime and EndTime properties or set the StartTimeShortcut and EndTimeShortcut properties.

Specify the sampling mode.

A sampling mode must be set to determine how values are retrieved from the Historian archive. Depending on the sampling mode, you may also need to modify the Direction and NumberOfSamples. The following table lists the available Sampling Modes and their explanations.

Name	Description	Value
CurrentValue	Retrieves the current value. The time frame criteria are ignored.	1
Interpolated	Retrieves evenly spaced interpolated values based on NumberOfSamples and the time frame criteria.	2
Trend	Retrieves the raw minimum and raw maximum value for each specified interval. Use the Trend sampling mode to maximize performance when retrieving data points for plotting. A start time, end time, and an interval or number of samples must be specified.	3
RawByTime	Retrieves raw archive values (compressed) based on time frame criteria.	4
RawByNumber	Retrieves raw archive values (compressed) based on the StartTime criteria, the NumberOfSamples, and Direction criteria. NOTE: The EndTime criteria is ignored for this Sampling mode.	5
Calculated	Retrieves evenly spaced calculated values based on NumberOfSamples, the time frame criteria, and the CalculationMode criteria.	6

Specify the Calculation Mode.

For the calculated SamplingMode, you must also specify the Calculation Mode.

The following table describes the available calculation modes.

Enumeration: ihCalculationMode

Name	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

The filter eliminates archive data from retrieval or calculations that occur within the time period that the specified filter criterion is True. FilterMode determines exactly how changes in state of the FilterTag are interpreted for retrieval of data.

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 to the time of the True condition.	2
AfterTime	Retrieves data from the time of the True filter condition up to the time of next False condition.	3
BeforeAndAfterTime	Retrieves data from the time of the last False filter condition up to the time of next False condition.	4

Syntax

object.Count

Parameters

None

Remarks

Criteria is a read-only property of type DataCriteria.

Criteria Property (MessageRecordset Object)

Use this property to specify which Messages to return from the Historian server when a MessageRecordset query executes.

A Topic may be optionally supplied to limit the Message queries to specific message topics. The following table provides a list of message topics.

Name	Description	Value
Connections	Provides messages about client connections.	1
Security	Provides messages and alerts about login attempts and attempts to access restricted resources.	2
ConfigurationAudit	Provides messages about configuration changes and audit trail.	3
ServiceControl	Provides messages and alerts regarding startup and shutdown of the system and specific services.	4
Performance	Provides messages and alerts regarding system and archive performance.	5

You can also optionally supply a time frame for the query. To do this, either set the StartTime and EndTime properties or set the StartTimeShortcut and EndTimeShortcut properties, or a combination of both.

All other fields of the MessageCriteria are evaluated by exact match if set.

Syntax

object.Criteria

Parameters

None

Remarks

Criteria is a read-only property of type MessageCriteria.

Criteria Property (TagRecordset Object)

Use this property to specify which Tags to return from the Historian server when a TagRecordset query is executed.

You can supply the Tagname and Description as a mask including wildcards to return all matching tags. All other fields of the TagCriteria object are tested for exact match if they are supplied or set.

Syntax

object.Criteria

Parameters

None

Remarks

Criteria is a read-only property of type TagCriteria.

CurrentValue Property (Tag Object)

Returns the current value of the Tag as a DataValue object. The DataValue object contains properties for the Value, TimeStamp, and DataQuality of the current value.

Syntax

The table below defines the possible values for DataQuality:

Name	Data Type	Description
Good	The quality of the value is GOOD.	1
Bad	The quality of the value is BAD.	2
Unknown	The quality of the value is UNKNOWN.	3

Syntax

object.DataQuality[ = ihDataQuality]

Parameters

None

DataQualityUpdated Property (DataValue Object)

This property is for internal use only.

Syntax

object.DataQualityUpdated[ = Boolean]

Parameters

None

DataStore Property (Archive Object)

Returns the data store name of the specified Archive.

Syntax

object.DataStore

Parameters

None

Remarks

String

DataQualityUpdated Property (DataValue Object)

This property is for internal use only.

Syntax

object.DataQualityUpdated[ = Boolean]

Parameters

None

DataTimestamp Property (DataComments Object)

Returns the timestamp of the DataValue the comment is associated with.

Syntax

object.DataTimestamp

Parameters

None

Remarks

DataTimeStamp is a read-only property of type Date.

Example

Debug.Print "Commented point at: " + _ Format$(MyValue.Com

DataType Property (DataComments Object)

Returns the data type of the associated data.

Syntax

object.DataType

Parameters

None

DataType Property (Tag Object)

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

The table below lists the available data types.

Name	Description	Value
Scaled	Tag scaled between high engineering units and low engineering units.	1
Float	Tag stored as single precision floating point.	2
DoubleFloat	Tag stored as double precision floating point.	3
Integer	Tag stored as 2-byte integer.	4
DoubleInteger	Tag stored as 4-byte integer.	5
FixedString	Tag stored as fixed length UNICODE string.	6
VariableString	Tag stored as variable length UNICODE string.	7
Blob	Tag stored as binary large object.	8

Syntax

object.DataType[ = ihDataType]

Parameters

None

DataType Property (DataComments Object)

Sets the data type to search for in the TagRecordset query.

Syntax

object.DataType[ = ihDataType]

Parameters

None

DataType Property (TagFields Object)

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

Syntax

object.DataType = Boolean]

Parameters

None

DataTypeList Property (Tags Object)

Returns the list of Historian data types.

Syntax

object.DataTypeList

Parameters

None

Remarks

DataTypeList is a read-only property of type Variant.

DataTypeSet Property (TagCriteria Object)

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

Syntax

object.DataTypeSet[ = Boolean]

Parameters

None

DataTypeUpdated Property (Tag Object)

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

Syntax

object.DataTypeUpdated[ = Boolean]

Parameters

None

DefaultCollectionInterval Property (Collector Object)

Returns or sets the Default Collection Interval property for the Collector.

Syntax

object.DefaultCollectionInterval[ = Long]

Parameters

None

Example

' Print Out The DefaultCollectionInterval configured for the collector Debug.Print

DefaultCollectionInterval Property (Collector Object)

Returns or sets the Default Collection Interval property for the Collector.

Syntax

object.DefaultCollectionInterval[ = Long]

Parameters

None

Example

' Print Out The DefaultCollectionInterval configured for the collector Debug.Print

DefaultCollectionType Property (Collector Object)

Returns or sets the Default Collection Type for the given collector. This can be either Polled or Solicited.

Syntax

object.DefaultCollectionType[ = iHistorian_SDK.ihCollectionType]

Parameters

None

Example

 ' Print Out The DefaultCollectionType configured for the collectorDebug.Print MyCollector.DefaultCollectorAbsoluteDeadband

DefaultCollectorAbsoluteDeadbanding Property (Collector Object)

Returns or sets the Default Collector Absolute Deadbanding for the Collector. This specifies if the compression applied to newly added tags from the collector use absolute or relative compression.

Syntax

object.DefaultCollectorAbsoluteDeadbanding[ = Boolean]

Parameters

None

Example

' Print Out The DefaultCollectorAbsoluteDeadbanding configured for the collector DebugPr

DefaultCollectorCompression Property (Collector Object)

Returns or sets whether the collector uses Compression by default.

Syntax

object.DefaultCollectorCompression[ = Boolean]

Parameters

None

Example

' Print Out The DefaultCollectorCompression configured for the collector Debug.Print MyColl

DefaultCollectorCompressionDeadband Property (Collector Object)

Returns or sets the Default Collector Compression Deadband for the given collector. This is default compression value to be applied to newly added tags from the collector.

Syntax

object.DefaultCollectorCompressionDeadband[ = Single]

Parameters

None

Example

' Print Out The DefaultCollectorCompressionDeadband configured for the collector Debug.Print MyC

DefaultCollectorCompressionTimeout Property (Collector Object)

Returns or sets the Default Collector Compression Timeout for the Collector. This specifies the amount of time after which a value will be sent to the archiver by the collector even if it would have been compressed.

Syntax

object.DefaultCollectorCompressionTimeout[ = Long]

Parameters

None

Example

' Print Out The DefaultCollectorCompressionTimeout configured for the collector Debug

DefaultLoadBalancing Property (Collector Object)

Returns or sets whether the collector uses Load Balancing by default.

Syntax

object.DefaultLoadBalancing[ = Boolean]

Parameters

None

Example

' Print Out The DefaultLoadBalancing configured for the collector Debug.Print MyCo

DefaultServer Property (ServerManager Object)

Returns or sets a reference to the default Server Object.

Syntax

object.DefaultServer

Parameters

None

DefaultSpikeInterval Property (Collector Object)

Returns or sets the Default Spike Interval property for the Collector.

Syntax

object.DefaultSpikeInterval[ = Long]

Parameters

None

Example

' Print Out The DefaultSpikeInterval configured for the collector Debug.Print MyCollector.DefaultSpikeInter

DefaultSpikeLogic Property (Collector Object)

Returns or sets the Default Collector Spike Logic property for the Collector.

Syntax

object.DefaultSpikeLogic[ = Boolean]

Parameters

None

Example

' Print Out The DefaultSpikeLogic configured for the collector Debug.Print MyCollector.DefaultSpikeLogic

DefaultSpikeMultiplier Property (Collector Object)

Returns or sets the Default Spike Multiplier property for the Collector.

Syntax

object.DefaultSpikeMultiplier[ = Double]

Parameters

None

Example

' Print Out The DefaultSpikeMultiplier configured for the collector Debug.Pri

DefaultTagPrefix Property (Collector Object)

Returns or sets the Default Tag Prefix property for the Collector.

Syntax

object.DefaultTagPrefix[ = String]

Parameters

None

Example

' Print Out The DefaultTagPrefix configured for the collector Debug

DefaultTimestampType Property (Collector Object)

Returns or sets the Default Timestamp Type for the given collector. The Timestamps may be assigned by either the Data Source or the Collector itself.

Syntax

object.DefaultTimestampType[ = iHistorian_SDK.ihTimeStampType]

Parameters

None

Example

' Print Out The DefaultTimestampType configured for the collector Debug.Print MyCollector.DefaultTimestampType

Definition Property (UserCalcFunction Object)

Returns the definition of the specified UserCalcFunction.

Syntax

object.Definition[ = String]

Parameters

None

Description Property (Collector Object)

Returns or sets the description for the given collector.

Syntax

object.Description[ = String]

Parameters

None

Example

' Print Out The Description configured for the collector Debug.P

Description Property (EnumeratedSets Object)

Returns or sets the description or comments for an enumerated set.

Syntax

object.Description

Parameters

None

Returns

String

Description Property (EnumeratedState Object)

Returns or defines the description or comments for a state.

Syntax

object.Description

Parameters

None

Remarks

String. Returns the description or comments for each state.

Description Property (Tag Object)

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

Syntax

object.Description[ = String]

Parameters

None

Description Property (TagCriteria Object)

Sets the description or description mask to search for in the TagRecordset query. The description may include wildcard characters.

Syntax

object.Description[ = String]

Parameters

None

Description Property (TagFields Object)

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

Syntax

object.Description[= Boolean]

Parameters

None

Description Property (UserDefinedTypeFields Object)

Returns or sets the description or comments for a field in a User Defined Type.

Syntax

object.Description

Parameters

None

Returns

String

DescriptionSet Property (TagCriteria Object)

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

Syntax

object.DescriptionSet[ = Boolean]

Parameters

None

DescriptionUpdated Property (Tag Object)

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

Syntax

object.DescriptionUpdated[ = Boolean]

Parameters

None

Direction Property (DataCriteria Object))

Sets the direction (forward or backward) of sampling data from the archive by the DataRecordset query. This parameter is only used for "RawByNumber" Sampling Mode.

The following table details the available sampling directions.

Name	Description	Value
Forward	Data sampled from the start time forward in time.	1
Backward	Data sampled from the start time backwards in time.	2

Syntax

object.Direction[ = iHistorian_SDK.ihSamplingDirection]

Parameters

None

DirectionSet Property (DataCriteria Object)

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

Syntax

object.DescriptionSet[ = Boolean]

Parameters

None

Property Reference E-F

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"

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

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

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]

G

General1 Property (Collector Object)

Returns or sets the general fields of the specified collector. The general fields control the behavior of specific collector types. Refer to the documentation of a specific collector type to interpret the meaning of the general collector fields for that collector type.

Syntax

object.General1[ = String]

Parameters

None

Example

MyCollector.General1 = "CanUseOPCTime=True"

General2 Property (Collector Object)

Syntax

object.General2[ = String]

Parameters

None

General3 Property (Collector Object)

Syntax

object.General3[ = String]

Parameters

None

General4 Property (Collector Object)

Syntax

object.General4[ = String]

Parameters

None

General5 Property (Collector Object)

HighPart Property (QueryModifiers Object)

Returns or sets the HighPart of the query modifier. Use the Server.CriteriaFromStrings method to determine the HighPart and LowPart of a query modifier.

Syntax

object.HighPart

Parameters

None

Remarks

Long

HighSeverity Property (OPCFilters Object)

Gets/Sets the High Severity filter in the Alarm Collector. Only events with a severity less than or equal to HighSeverity will be collected.

Syntax

object.HighSeverity[ = Long]

Parameters

None

Property Reference I-J

I

Id Property (DataStore Object)

Returns or sets the ID (GUID) of a data store. This is a read-only property.

Syntax

IsActiveRedundantCollector is a read-only property of type Boolean.

IsAudited Property (Data Object)

Returns whether or not this data has an Audit Trail associated with it.

Syntax

object.IsAudited

Parameters

None

IsAudited Property (Server Object)

Returns or sets whether the point verification feature is enabled. With point verification enabled, the system will prompt for a username and password upon any request to change data or configuration.

Syntax

object.IsAudited[ = Boolean]

Parameters

None

IsCurrent Property (Archive Object)

Returns whether or not the specified archive is the newest archive where new data currently flows into.

Syntax

object.IsCurrent

Parameters

None

Remarks

IsCurrent is a read-only property of type Boolean.

Example

'Find The Current Archive, Then Initiate A Backup With MyArchives   
For I = 1 To .Item.count If .Item(I).IsCurrent Then       
If Not .Item(I).Backup(BackupFilename) Then err.Raise 1, "Backup", "Backup Failed" End If
End If   Next I End With

None

Remarks

Item is a read-only property of type Collection of Archives.

Item Property (Collectors Object)

Returns a specific Collector object contained in the Collectors Object collection. The Item collection can loop through all Collectors, or reference a specific Collector object directly by Collector name.

The Collector Item collection automatically populates when the Collectors object is instantiated.

Syntax

object.Item

Parameters

None

Remarks

Item is a read-only property of type Collection.

Item Property (DataRecordset Object)

Returns a specific DataValue object contained in the DataRecordset object. The Item collection can loop through all DataValues, or reference a specific DataValue object directly by Tagname and Timestamp.

The DataRecordset (and thus the Item collection) is populated with DataValues in three ways. The first is to set up query criteria and call the QueryRecordset method. The second is to import a list of DataValues using the Import method. The last way is to use the Add method to add new DataValues.

Syntax

object.Item(Tagname)

Parameters

Tagname - Variant - The name of the tag whose values to retrieve.

Remarks

Item is a read-only property of type Collection of DataValue.

Item Property (DataStores Object)

Returns a specific data store object contained in the DataStores Object collection. The Item collection can loop through all DataStores, or reference a specific DataStore object directly by DataStore name.

Syntax

object.Item() As Collection

Parameters

None

Remarks

Item is a read-only property of type Collection.

Item Property (EnumeratedStates Object)

Returns an individual item from the EnumeratedStates collection.

Parameters

None

Remarks

Enumerated State.

Item Property (MessageRecordset Object)

Returns a specific Message object contained in the MessageRecordset object. The Item collection can loop through all Messages or reference a specific Message object directly by the timestamp.

The MessageRecordset (and thus the Item collection) populates with the Message in two ways: set up query criteria and call the QueryRecordset method, or use the Add method to add new Messages. Item is a read-only property of type Collection of Message.

Syntax

object.Item

Parameters

None

Item Property (TagDependencies Object)

This function attempts to find the given Tagname within the collection of currently configured tags.

Syntax

object.Item(Tagname)

Parameters

Tagname - Variant - Name of the tag to locate.

Item Property (TagRecordset Object)

Returns a specific Tag object contained in the TagRecordset object. The Item collection can loop through all Tags, or reference a specific Tag object directly by the tag name.

The TagRecordset (and thus the Item collection) populates with Tags in three ways:

The first is to set up query criteria and call the QueryRecordset method. The second is to import a list of Tags using the Import method. The last way is to use the Add method to add new Tags.

Syntax

object.Item

Parameters

None

Remarks

Item is a read-only property of type Collection of Tag.

Item Property (UserDefinedTypeFields Object)

Returns an individual item from the multiple fields of the User Defined Type.

Syntax

object.item(Index)

Parameters

Index - Variant - The index has to be returned.

Remarks

UserDefinedTypeField.

Property Reference K-L

L

LastBackup Property (Archive Object)

Returns the date and time of the last archive backup.

Syntax

object.LastBackup

Parameters

None

Remarks

LastBackup is a read-only property of the type Date.

Example

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

LastBackupUser Property (Archive Object)

Returns username of the person who performed the last backup of the archive.

Syntax

object.LastBackupUser

Parameters

None

Remarks

LastBackupUser is a read-only property of type String.

Example

Debug.Print "Modified By: " + MyArchive.LastBackupUser

LastError Property (Archive Object)

Returns the last error message encountered by the Archive object. To see a complete list of messages, refer to the ErrorList property. When possible, the system translates messages into the locale of the client.

Syntax

object.LastError

Parameters

None

Remarks

LastError is a read-only property of type String.

LastError Property (Archives Object)

Returns the last error message encountered by the Archives object. To see a complete list of messages, refer to the ErrorList property. When possible, the system translates messages into the locale of the client.

Syntax

object.LastError

Parameters

None

Remarks

LastError is a read-only property of type String.

LastError Property (Collector Object)

Returns the last error message encountered by the Collector object. To see a complete list of messages, refer to the ErrorList property. When possible, the system translates messages into the locale of the client.

Syntax

object.LastError

Parameters

None

Remarks

LastError is a read-only property of type String.

LastError Property (Collectors Object)

Returns the last error message encountered by the Collectors Object. To see a complete list of messages, refer to the ErrorList property. When possible, the system translates messages into the locale of the client.

Syntax

object.LastError

Parameters

None

Remarks

LastError is a read-only property of type String.

LastError Property (DataRecordset Object)

Returns the last error message encountered by the DataRecordset object. To see a complete list of messages, refer to the ErrorList property. When possible, the system translates messages into the locale of the client.

Syntax

object.LastError

Parameters

None

Remarks

LastError is a read-only property of type String.

LastError Property (DataStores Object)

Returns the last error message encountered by the Collectors Object.

Syntax

object.LastError

Parameters

None

Remarks

LastError is a read-only property of type String.

LastError Property (EnumeratedSets Object)

Returns the last error message encountered by the EnumeratedSets object. To see a complete list of messages, refer to the ErrorList Property. When possible, the system translates messages into the locale of the client.

Syntax

object.LastError()

Parameters

None

Remarks

String. Indicates whether the string contains an error or not. This is a read-only property.

LastError Property (EnumeratedSets Object)

Syntax

object.LastError()

Parameters

None

Remarks

String. Indicates whether the string contains an error or not. This is a read-only property.

LastError Property (Messages Object)

Syntax

object.LastError()

Parameters

None

Remarks

LastError is a read-only property of type String.

LastError Property (Messages Object)

Syntax

object.LastError

Parameters

None

Remarks

LastError is a read-only property of type String.

LastError Property (Server Object)

Returns the last error message encountered by the Server object. To see a complete list of messages, refer to the ErrorList property. When possible, the system translates messages into the locale of the client.

Syntax

object.LastError[ = String]

Parameters

None

LastError Property (ServerManager Object)

Returns a text description of the last error encountered by the ServerManager object.

Syntax

object.LastError

Parameters

None

Remarks

object.LastModifiedUser[=Boolean]

Parameters

None

LastModifiedUser Property (UserDefinedType Object)

Returns the last user that modified the User Defined Type.

Syntax

object.LastModifiedUser

Parameters

None

Returns

Returns or sets the LowPart of query modifier. Use the Server.CriteriaFromStrings method to determine the HighPart and LowPart of a query modifier.

Syntax

object.LowPart

Parameters

None

Remarks

Long

LowSeverity Property (OPCFilters Object)

Gets/Sets the Low Severity filter in the Alarm Collector. Only events with a severity higher than or equal to LowSeverity will be collected.

Syntax

object.LowSeverity[ = Long]

Parameters

None

Property Reference M-N

M

MaintainAutoRecoveryFiles Property (Server Object)

Returns or sets whether auto recovery files are maintained by the server. Auto recovery files are periodic backups of the the current .IHA and .IHC and protect against data loss due to ungraceful server shutdown.

Syntax

object.MaintainAutoRecoveryFiles[ = Boolean]

Parameters

None

MajorVersion Property (Server Object)

Returns the server or client major version number (1, 2, 3, and so on).

Syntax

object.MajorVersion([API])

Parameters

Name	Data Type	Description
API	Boolean	When True, the server version is returned. When False, the client version is returned. The default is False.

Remarks

MajorVersion is a read-only property of type Long.

Master Property (TagRecordset Object)

Returns the Master tag upon which bulk changes to tag configuration may be performed. When calling the WriteRecordset method, and supplying the "UserMasterTag" parameter, all changes made to the Master tag will be replicated to each tag in the TagRecordset whose Selected property is set to True.

Syntax

object.Master([ClearUpdates])

Parameters

Name	Data Type	Description
ClearUpdates	Boolean	Whether to clear all pending updates in the master tag (optional, default = False).

Remarks

Master is a read-only property of type Tag.

Example

Dim Recordset As TagRecordset Dim Master As Tag ' Get a new TagRecordset Set Recordset = MyServer.Tags.NewRecordset ' 
Fill in criteria, get all tags with collector compression on With Recordset.Criteria  
 .Tagname = "*"   .CollectorCompression = True End With Recordset.QueryRecordset 
Set Master = Recordset.Master ' Set Compression Percent to 0.5% Master.CollectorDeadbandPercentRange = 0.5 ' 
Select all tags in the recordset Recordset.SelectAll ' Commit Changes If Not Recordset.WriteRecordset(True) 
Then   MsgBox "Failed To Commit Tag Changes" End If

MaxReturnCells Property (DataRecordset Object)

Sets the Maximum number of cells to return in the DataRecordSet.

Syntax

object.MaxReturnCells([size])

Parameters

Name	Data Type	Description
Size	Long	Number of cells to return.

MaximumQueryIntervals Property (Server Object)

Returns or sets the maximum query intervals enforced by the server. This property restricts the maximum number of samples per tag that the server can return for non-raw data queries. Filtered and raw data queries are not throttled.

Syntax

object.MaximumQueryIntervals([Long])

Parameters

None

MaximumQueryTime Property (Server Object)

Returns or sets the maximum query time enforced by the server. The property restrict query times and provides balanced access to the server.

Syntax

object.MaximumQueryTime([Long])

Parameters

None

MessageNumber Property (Message Object)

Returns the message number of the Message. A message number is a unique identifier for each Message required for national language support.

Syntax

object.MessageNumber[Long]

Parameters

None

Remarks

MessageNumber is a read-only property of type Long.

MessageNumber Property (MessageCriteria Object)

Establishes which message number the MessageRecordset query will filter by. A message number is a unique identifier for each Message required for national language support.

Syntax

object.MessageNumber[Long]

Parameters

None

MessageNumber Property (MessageFields Object)

Determines whether the MessageNumber field should be returned in the MessageRecordset query.

Syntax

object.MessageNumber[=Boolean]

Parameters

None

MessageNumberSet Property (MessageCriteria Object)

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

Syntax

object.MessageNumberSet[=Boolean]

Parameters

Option	Description
MessageOnDataUpdate	Determines whether data updates generate a message.

MessageOptions Property (Messages Object)

Exposes the MessageOptions collection to control the behavior of the Historian message generation and archiving.

If the property is set to True, all applications connected to the archiver will cause the archiver to generate a message on a data update, not just the application that set the property. For instance, if you set the property with the SDK and the File Collector updates data (a single value) a message will be generated by the archiver.

An example of a message that appears in the Historian Administrator after you change a specified tag property through the SDK would be:

bsmith(MY_DOMAIN\bsmith) wrote 96 to tag aa at 01/10/2003 04:13:49.861 PM, Replaced 94.000

The message topic type would be Security.

The following table describes each of the messaging options:

Syntax

object.MessageOptions(OptionName)[=Variant]

Parameters

Name	Data Type	Description
OptionName	String	The name of the message option.

Remarks

MessageOptions is a read-only property of type Collection of options.

Example

 ConnectedServer.Messages.MessageOptions("MessageOnDataUpdate") = True

Parameters

None

Remarks

String.

Name Property (Option Object)

The name parameter of this option.

Syntax

object.Name[ = String]

Parameters

None

Name Property (UserCalcFunction Object)

Returns the name of the specified UserCalcFunction.

Syntax

object.Name[ = String]

Parameters

None

NodeFilter Property (OPCBrowse Object)

Some OPCAE Servers allow you to set a filter for the browse. The Areas Returned by the Browse operation will be only those that match the filter criterion. If this property is not set, no filtering takes place.

Syntax

Long

Property Reference O-P

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

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

Property Reference Q-R

R

RawValue Property (Option Object)

The raw numeric value of this option.

Syntax

object.RawValue[ = Double]

Parameters

None

ReadOnly Property (Archive Object)

Returns or sets the ReadOnly status of the specified archive. If you attempt to set the current archive to ReadOnly (the archive receiving newest data), an error is generated.

Syntax

object.ReadOnly[ = Boolean]

Parameters

None

Example ' Set Archive To ReadOnly MyArchive.ReadOnly = True ' Reset Archive ReadOnly Status MyArchive.ReadOnly = False

ReadSecurityGroup Property (Tag Object)

RReturns or sets the name of the security group controlling the reading of data for the Tag. Changes to tag properties are not committed until you call the WriteRecordset method of the TagRecordset object.

Syntax

object.ReadSecurityGroup[ = String]

Parameters

None

ReadSecurityGroup Property (TagCriteria Object)

Returns or sets the ReadOnly status of the specified archive. If you attempt to set the current archive to ReadOnly (the archive receiving newest data), an error is generated.

Syntax

object.ReadSecurityGroup[ = String]

Parameters

None

Example With MyRecordset.Criteria .TagName = "*.F_CV" .ReadSecurityGroup = "Power Users" End With

ReadSecurityGroup Property (TagFields Object)

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

Syntax

object.ReadSecurityGroup[ = Boolean]

Parameters

None

Example

 With MyRecordset.Fields   .Clear   .TagName = True   .Description = True   .ReadSecurityGroup = True   .WriteSecurityGroup = True   .AdministratorSecurityGroup = True End With

ReadSecurityGroupSet Property (TagCriteria Object)

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

Syntax

object.ReadSecurityGroup[ = Boolean]

Parameters

None

ReadSecurityGroupUpdated Property (Tag Object)

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

Syntax

object.ReadSecurityGroupUpdated[ = Boolean]

Parameters

None

RedundancyEnabled Property (Collector Object)

Returns or sets whether the collector is part of a redundant configuration.

Syntax

object.RedundancyEnabled[ = Boolean]

Parameters

None

Running Property (Collector Object)

Returns or sets the running state of the specified Collector. Use this property to pause and resume collection without restarting and stopping the collector.

Syntax

object.Running[ = Boolean]

Parameters

None

Example

  ' Resume the collector MyCollector.Running = True
            ' Pause the collector MyCollector.Running = False

Property Reference S-T

None

SamplingMode Property (DataCriteria Object)

Returns or sets the mode of sampling data from the archive by the DataRecordset query.

The following table details the available sampling modes:

Name	Description	Value
CurrentValue	Retrieves the current value, the time frame criteria are ignored.	1
Interpolated	Retrieves evenly spaced interpolated values based on NumberOfSamples and the time frame criteria.	2
Trend	Retrieves the raw minimum and raw maximum value for each specified interval. Use the Trend sampling mode to maximize performance when retrieving data points for plotting. A start time, end time, and an interval or number of samples must be specified.	3
RawByTime	Retrieves raw archive values (compressed) based on time frame criteria.	4
RawByNumber	Retrieves raw archive values (compressed) based on the StartTime criteria, the NumberOfSamples, and Direction criteria. Note the EndTime criteria is ignored for this Sampling mode.	5
Calculated	Retrieves evenly spaced calculated values based on NumberOfSamples, the time frame criteria, and the CalculationMode criteria.	6
Lab	The Lab sampling mode only returns the collected values, without any interpolation of the value. The collected value is repeated for each interval until there is a change in the raw data sample's value. Lab sampling is most often used to create a step chart rather than a smooth curve. Use Lab sampling instead of interpolated if you only want true collected values returned. The Lab sampling mode is generally not useful on highly compressed data. Use interpolated sampling instead.	7
InterpolatedtoRaw	When you request interpolated data, you specify an interval or number of samples. If the actual stored number of raw samples is greater than required, you will get interpolated data as described above. If the actual number of stored samples are less than the required, then you will get the raw samples. In this way, the needs of trending detail and application load are balanced. This mode is best used when querying compressed data because the Data Archiver can switch to the more efficient raw data query.	8
TrendtoRaw	TrendtoRaw retrieves raw data between a given intervals when the actual data samples are fewer than the requested number of samples.	9
LabtoRaw	LabtoRaw is an extension to Lab mode of sampling and similar to InterpolatedtoRaw mode where you will be switched to raw data or lab when the actual data samples are fewer than the requested samples.	10
RawByFilterToggle	RawByFilterToggle returns filtered time ranges. The values returned are 0 and 1. If the value is 1, then the condition is true and 0 means false. This sampling mode is used with the time range and filter tag condition. The result starts with a starting time stamp and ends with an ending timestamp.	11

Syntax

object.SamplingMode[=iHistorian_SDK.ihSamplingMode]

Parameters

None

SamplingModeList Property (Data Object)

This function returns a list of the available Sampling Modes for Data.

Syntax

object.SamplingModeList([ExcludeRaw])

Parameters

Name	Data Type	Description
ExcludeRaw	Boolean	Whether to exclude raw sampling modes (optional, default = False).

SamplingModeSet Property (DataCriteria Object)

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

Syntax

object.SamplingModeSet[ = Boolean]

Parameters

None

SecondaryUsername Property (DataComments Object)

Returns the user who signed the comment when it was added to the archive.

Syntax

object.SecondaryUsername

Parameters

None

Remarks

SecondaryUserName is a read-only property of type String.

Example

  Debug.Print "Comment signed by:"+MyValue.Comments(1).SecondaryUsername

SecurityGroupList Property (Server Object)

Returns the list of security groups from the current server. Security groups determine the system functions permitted by users within the group.

Syntax

object.SecurityGroupList

Parameters

None

Remarks

SecurityGroupList is a read-only property of type Variant.

SecurityGroupLocation Property (Server Object)

Returns or sets the location of the security groups used by the server. The Historian server can either use security groups assigned to the local server computer ("Local" location) or groups configured for the domain ("Domain" location). Note, changing the SecurityGroupLocation requires a server restart to take effect.

Syntax

object.SecurityGroupLocation[ = String]

Parameters

None

Selected Property (Tag Object)

Returns whether or not this tag is selected.

Syntax

object.Selected[ = Boolean]

Parameters

None

Server Property (Archive Object)

Returns the server associated with the Archive object.

Syntax

object.Server

Parameters

None

Remarks

Server is a read-only property of type Server.

Example

  Dim ServerName As String ' Get The Name Of The Server ServerName = MyArchive.Server.ServerName

Server Property (Archives Object)

Returns the Server associated with the Archives object.

Syntax

object.Server

Parameters

None

Remarks

Server is a read-only property of type Server.

Example

  Dim ServerName As String ' Get The Name Of The Server ServerName = MyArchives.Server.ServerName

Server Property (Collector Object)

Returns the Server associated with the Collector Object.

Syntax

object.Server

Parameters

None

Remarks

Server is a read-only property of type Server.

Example

  Dim ServerName As String ' Get The Name Of The Server ServerName = MyCollector.Server.ServerName

Server Property (Collectors Object)

Returns the Server associated with the Collectors object.

Syntax

object.Server

Parameters

None

Remarks

Server is a read-only property of type Server.

Example

  Dim ServerName As String ' Get The Name Of The Server ServerName = MyCollectors.Server.ServerName

Server Property (Data Object)

Returns the server associated with the Data object.

Syntax

object.Server

Parameters

None

Remarks

Server is a read-only property of type Server.

Example

  Dim ServerName As String ' Get The Name Of The Server ServerName = MyDataServer.Server.ServerName

Server Property (DataRecordset Object)

Returns the Server associated with the DataRecordset object.

Syntax

object.Server

Parameters

None

Remarks

Server is a read-only property of type Server.

Example

  Dim ServerName As String ' Get The Name Of The Server ServerName = MyRecordset.Server.ServerName

Server Property (DataStores Object)

Returns the Server associated with the DataRecordset object.

Syntax

object.Server() As Server

Parameters

None

Remarks

Server is a read-only property of type Server.

Server Property (MessageRecordset Object)

Returns the Server associated with the DataRecordset object.

Syntax

object.Server

Parameters

None

Remarks

Server is a read-only property of type Server.

Example

  Dim ServerName As String
                ' Get the name of the server
                ServerName = MyRecordset.Server.ServerName

Server Property (Messages Object)

Returns the Server associated with the Messages object.

Syntax

object.Server

Parameters

None

Remarks

Server is a read-only property of type Server.

Example

  Dim ServerName As String
                ' Get The Name Of The Server
                ServerName = MyMessages.Server.ServerName

Server Property (TagRecordset Object)

Returns the Server associated with the TagRecordset object.

Syntax

object.Server

Parameters

None

Remarks

Server is a read-only property of type Server.

Example

  Dim ServerName As String
                ' Get the name of the server
                ServerName = MyRecordset.Server.ServerName

Server Property (Tags Object)

Returns the Server associated with the Tags Object.

Syntax

object.Server

Parameters

None

Remarks

Server is a read-only property of type Server.

Example

  Dim ServerName As String
                ' Get the name of the server
                ServerName = MyTags.Server.ServerName

ServerName Property (Server Object)

Returns the name of the computer that the server is running on.

Syntax

object.ServerName[ = String]

Parameters

None

Remarks

Server is a read-only property of type String.

ServerName Property (Server Object)

Returns the name of the computer that the server is running on.

Syntax

object.ServerName[ = String]

Parameters

None

Remarks

Server is a read-only property of type String.

ServerTime Property (Server Object)

Returns the current time on the connected server. The system then converts the time from UTC into formatted time based on the ConnectionOptions (TimeOption) setting.

Syntax

object.ServerTime

Parameters

None

Servers Property (ServerManager Object)

Maintains a list of registered servers on the client. To connect a listed server, use the Connect Method of a selected Server Object.

Syntax

object.Servers

Parameters

None

SetName Property (EnumeratedSets Object)

Returns or defines the name of an Enumerated Set.

Syntax

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

Syntax

object.StartTimeSet[ = Boolean]

Parameters

None

StartTimeShortcut Property (DataCriteria Object)

Returns or sets the start 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.StartTimeShortcut[ = 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

StartTimeShortcut Property (MessageCriteria Object)

Establishes the start 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.StartTimeShortcut[ = String]

Parameters

None

Example

'Set A Start Time For Two Days Ago
MyMessages.Criteria.StartTimeShortcut = "-2d"

Syntax

object.StateValue = value

Status Property (Archive Object)

Returns the status of the specified Archive. This status is typically Current or Active.

Syntax

object.Status

Parameters

None

Remarks

Status is a read-only property of type String.

Example

     ' Print Out The Archive Status Debug.Print MyArchive.Status

Status Property (Collector Object)

Returns the status of the specified Collector. This status is typically Running or Stopped.

Syntax

object.Status

Parameters

None

Remarks

Status is a read-only property of type String.

Example

    ' Print Out The Collector Status Debug.Print MyCollector.Status

Example

  ' Subscribe To Archive Status Updates
            MyArchives.SubscribeStatus = True
            ' Unsubscribe To Archive Status Updates
            MyArchives.SubscribeStatus = False

SubscribeStatus Property (Collectors Object)

Subscribes to changes in Collector status and configuration. The Historian server publishes messages to any client signed up for Collector status changes as modifications are committed to the Collector database. Setting the SubscribeStatus to True will sign up for status and configuration changes on all Collectors.

Status and configuration changes are reported asynchronously to the client through the Status_Received event of the Collectors object.

Syntax

object.SubscribeStatus[ = Boolean]

Parameters

None

Example

  ' Subscribe To Collector Status Updates
                MyCollectors.SubscribeStatus = True
                ' Unsubscribe To Collector Status Updates
                MyCollectors.SubscribeStatus = False

Substitutions Property (Message Object)

Returns the variable text of a message such as timestamps, usernames, and tagnames.

Syntax

object.Substitutions

Parameters

None

Remarks

Substitutions is a read-only property of type String.

Example

  Dim MySubstitutions As Collection Dim I As Integer Set MySubstitutions = MyMessage.Substitutions 
For I = 1 To MySubstitutions.count   Debug.Print MySubstitutions(I) Next I

Substitutions Property (MessageFields Object)

Determines whether the Substitutions should be returned in the MessageRecordset query.

Syntax

object.Substitutions[ = Boolean]

Parameters

None

Example

  Dim MyMessages As iHistorian_SDK.MessageRecordset Set MyMessages = GetServer.Messages.NewRecordset With 
MyMessages.Fields   .Topic = True   .TimeStamp = True   .MessageString = True   .Substitutions = True End With

T

Tagmask Property (DataCriteria Object)

Returns or sets a mask of tags to retrieve data for in the DataRecordset query. The tag mask may include wildcard characters including the "*" and "?".

Syntax

object.Tagmask[ = String]

Parameters

None

T

TagmaskSet Property (DataCriteria Object)

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

Syntax

object.TagmaskSet[ = Boolean]

Parameters

None

Tagname Property (Tag Object)

Returns the Tagname property of the Tag. Tagname is a read-only property.

Syntax

object.Tagname[ = String]

Parameters

None

Remarks

Tagname is a read-only property of type String.

Tagname Property (Tag Object)

Returns the Tagname property of the Tag. Tagname is a read-only property.

Syntax

Exposes the list of Tagnames associated with the collection of DataValue results maintained in the DataRecordset object. The Item property takes a tagname or tag index as a parameter to expose the collection of DataValues for that tag. The first collection of DataValues in the Item property.

Syntax

object.Tags

Parameters

None

Remarks

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

Tags Property (Server Object)

Returns the Tags object for the current server, but only if the authenticated user is a member of the Historian tag administrators group.

Syntax

object.Tags

Parameters

None

TagsSet Property (DataCriteria Object)

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

Syntax

object.TagsSet[ = Boolean]

Parameters

Determines whether the TimeStamp field should be returned in the MessageRecordset query.

Syntax

object.TimeStamp[ = Boolean]

Parameters

None

TimeStampType Property (Tag Object)

Returns or sets the type of time stamping applied to data at collection time.

Name	Description	Value
Source	New values take timestamp from data source.	1
Collector	New values are timestamped by Collector.	2

Topic is a writeable property of type ihMessageTopic.

Example

    If MyMessage.Topic = ihMessageTopic.General Then   Debug.Print "This is a General Message" End If

Topic Property (MessageCriteria Object)

Establishes which Topic the MessageRecordset query will filter by.

Syntax

object.Topic[ = ihMessageTopic]

Parameters

None

Remarks

Topic is a writeable property of type ihMessageTopic.

Example

   MyMessages.Criteria.Topic = ihMessageTopic.General

Topic Property (MessageFields Object)

Determines whether the Topic field should be returned in the MessageRecordset query.

Syntax

object.Topic[ = Boolean]

Parameters

None

Remarks

Topic is a writeable property of type ihMessageTopic.

Example

Dim MyMessages As iHistorian_SDK.MessageRecordset Set MyMessages = GetServer.Messages.NewRecordset With MyMessages.Fields   .Topic = True End With

TopicList Property (Messages Object)

Returns a list of available Topics.

Syntax

object.TopicList([IncludeMessages], [IncludeAlerts])

Parameters

Name	Data Type	Description
IncludeMessages	Boolean	Indicates whether Message topics should be included in the returned list
IncludeAlerts	Boolean	Indicates whether Alert topics should be included in the returned list

TopicName Property (Message Object)

Returns the Topic Name of the Message.

Syntax

object.TopicName

Parameters

None

Remarks

Topic is a writeable property of type String.

Example

Debug.Print "This is a " + MyMessage.TopicName + " message."

TopicSet Property (MessageCriteria Object)

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

Syntax

object.TopicSet[ = Boolean]

Parameters

None

TrackingEvents Property (OPCFilters Object)

Returns the list of Tracking Event Categories being filtered on the Alarm Collector. This list is only applied if isTrackingEventsOn(true) has been called.

Syntax

object.TrackingEvents

Parameters

None

Property Reference U-V

U

UserName Property (Message Object)

Returns the username who generated the message, or who the message is associated with.

Syntax

object.UserName[ = String]

Parameters

None

Remarks

UserName is a writeable property of type String.

UserName Property (MessageFields Object)

Determines whether the UserName field should be returned in the MessageRecordset query.

Syntax

object.UserName[ = Boolean]

Parameters

None

UserName Property (Server Object)

Returns the name of the currently authenticated user for the server.

Syntax

object.UserName

Parameters

None

UsernameSet Property (MessageCriteria Object)

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

Returns the server or client version number.

Syntax

object.Version([API])

Parameters

Name	Data Type	Description
API	Boolean	When True, the server version is returned. When False, the client version is returned. The default is False. ' When connecting to an Historian v1.0 server and passing True, Historian returns "Unknown" for the version number.

Name

Data Type

Description

API

Boolean

When True, the server version is returned. When False, the client version is returned. The default is False. '

When connecting to an Historian v1.0 server and passing True, Historian returns "Unknown" for the version number.

Remarks

Version is a read-only property of type String.

Property Reference W-Z

None