SDK Reference

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.CalcType [=ihTagCalcType]

Parameters

None

CalcType Property (TagFields Object)

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

Syntax

object.CalcType [ = Boolean]

Parameters

None

CalcTypeList Property (Tags Object)

Returns a list of valid calculation types available on a tag in Historian.

Syntax

object.CalcType

Parameters

None

CalcTypeSet Property (TagCriteria Object)

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

Syntax

object.CalcTypeSet [ = Boolean]

Parameters

None

CalcTypeUpdated Property (Tag Object)

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

Syntax

object.CalcTypeUpdated [ = Boolean]

Parameters

None

Calculation Property (Tag Object)

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

Syntax

object.Calculation[ = String]

Parameters

None

Calculation Property (TagCriteria Object)

Sets the calculation to search for in the TagRecordset query.

Syntax

object.Calculation[ = String]

Parameters

None

Calculation Property (TagFields Object)

Determines whether the TagRecordset query returns the Calculation field.

Syntax

object.Calculation[ = Boolean]

Parameters

None

CalculationDependencies Property (Tag Object)

Returns a collection of tagnames that the calculation is dependent upon. Use the CalculationDependencies property with unsolicited tags only.

Syntax

object.CalculationDependencies

Parameters

None

Remarks

CalculationDependencies is a read-only property of type TagDependencies.

CalculationDependencies Property (TagFields Object)

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

Syntax

object.CalculationDependencies[ = Boolean]

Parameters

None

CalculationDependenciesUpdated Property (Tag Object)

Returns whether or not the Calculation Dependencies have been updated. & Boolean true if the dependencies have been updated, false otherwise.

Syntax

object.CalculationDependenciesUpdated

Parameters

None

CalculationExecutionTime Property (Tag Object)

Returns the average time, in milliseconds, it takes to execute a calculation formula for the tag.

Syntax

object.CalculationExecutionTime

Parameters

None

Remarks

CalculationExecutionTime is a read-only property of type Long.

CalculationExecutionTime Property (TagFields Object)

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

Syntax

object.CalculationExecutionTime[ = Boolean]

Parameters

None

CalculationMode Property (DataCriteria Object)

Returns or sets the type of calculation to perform on archive data retrieved in the DataRecordset query. CalculationMode only applies to a Calculated SamplingMode.

The table below defines the available Calculation Modes:

Name	Description	Value
Average	Retrieves the time-weighted average for each calculation interval.	1
StandardDeviation	Retrieves the time-weighted standard deviation for each calculation interval.	2
Total	Retrieves the time- weighted rate total for each calculation interval. A rate total would be appropriate for totalizing a continuous measurement. Time weighting is necessary due to the fact that compressed data is not evenly spaced in time. A factor must be applied to the totalized value to convert into the appropriate engineering units. Given the fact that this is a rate total, a base rate of Units/Day is assumed. If the actual units of the continuous measurement were Units/Minute, it would be necessary to multiply the results by 1440 Minutes / Day to convert the totalized number into the appropriate engineering units.	3
Minimum	Retrieves the minimum value for each calculation interval.	4
Maximum	Retrieves the maximum value for each calculation interval.	5
Count	Retrieves the count of archive values found within each calculation interval.	6
RawAverage	Retrieves the arithmetic average of archive values for each calculation interval.	7
RawStandardDeviation	Retrieves the arithmetic standard deviation of archive values for each calculation interval.	8
RawTotal	Retrieves the arithmetic total of archive values for each calculation interval.	9
MinimumTime	Retrieves the timestamp of the minimum value found within each calculation interval. It may be a raw or an interpolated value. The minimum must be a good data quality sample.	10
MaximumTime	Retrieves the timestamp of the maximum value found within each calculation interval. It may be a raw or an interpolated value. The maximum must be a good data quality sample.	11
TimeGood	Retrieves the amount of time (in milliseconds) during the interval when the data is of good quality and the filter condition is met.	12
StateCount	Retrieves the amount of time a tag has transitioned to another state from a previous state during a time interval.	13
OPCAnd	Retrieves the OROPCQAND, bit-wise AND operation of all the 16-bit OPC qualities of the raw samples stored in the specified interval.	16
OPCOr	Retrieves the OPCQOR, bit-wise OR operation of all the 16-bit OPC qualities of the raw samples stored in the specified interval.	16

Syntax

object.CalculationMode[ = iHistorian_SDK.ihCalculationMode]

Parameters

None

CalculationModeList Property (Data Object)

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

Syntax

object.CalculationModeList

Parameters

None

CalculationModeSet Property (DataCriteria Object)

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

Syntax

object.CalculationModeSet[ = Boolean]

Parameters

None

CalculationSet Property (TagCriteria Object)

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

Syntax

object.CalculationSet[ = Boolean]

Parameters

None

CalculationUpdated Property (Tag Object)

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

Syntax

object.CalculationUpdated[ = Boolean]

Parameters

None

CanAdministerConfiguration Property (Archives Object)

Returns whether the current user is authorized to perform configuration changes to Archives or Archiving options.

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

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

CanReplicate is a read-only property of type Boolean.

CanSupportRedundantCollectors Property (Server Object)

Returns whether Collector Redundancy is enabled on the hardware key.

Syntax

object.CanSupportRedundantCollectors

Parameters

None

Remarks

CanSupportRedundantCollectors is a read-only property of type Boolean.

CanWrite Property (Data Object)

Returns whether the current user is authorized to write data to the server.

Syntax

object.CanWrite

Parameters

None

Remarks

CanWrite is a read-only property of type Boolean.

Example

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

CanWrite Property (Messages Object)

Returns whether the current user is authorized to write messages to the Server.

Syntax

object.CanWrite

Parameters

None

Remarks

CanWrite is a read-only property of type Boolean.

Example

' Check Security If Not MyMessages.CanWrite Then err.Raise 1, , "You are not authorized to write data to this server" End If

CollectionDisabled Property (Tag Object)

Gets or sets whether the collection status of this tag.

Syntax

object.CollectionDisabled[ = Boolean]

Parameters

None

CollectionDisabled Property (TagFields Object)

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

Syntax

object.CollectionDisabled[ = Boolean]

Parameters

None

CollectionDisabledUpdated Property (Tag Object)

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

Syntax

object.CollectionDisabledUpdated[ = Boolean]

Parameters

None

CollectionInterval Property (Tag Object)

Returns or sets the collection interval (in milliseconds) for a Tag. For polled collection, the interval schedules evenly spaced samples of the data from the data source. For unsolicited collection, the collection interval establishes the MINIMUM time allowed in between reports of unsolicited values from the data source. Changes to tag properties are not committed until you call the WriteRecordset method of the TagRecordset object.

Syntax

object.CollectionInterval[ = Long]

Parameters

None

CollectionInterval Property (TagCriteria Object)

Sets the collection interval to search for in the TagRecordset Query.

Syntax

object.CollectionInterval[ = Long]

Parameters

None

CollectionInterval Property (TagFields Object)

Determines whether the TagRecordset query returns the CollectionInterval field.

Syntax

object.CollectionInterval[ = Boolean]

Parameters

None

CollectionIntervalSet Property (TagCriteria Object)

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

Syntax

object.CollectionIntervalSet[ = Boolean]

Parameters

None

CollectionIntervalUpdated Property (Tag Object)

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

Syntax

object.CollectionIntervalUpdated[ = Boolean]

Parameters

None

CollectionOffset Property (Tag Object)

Returns or sets the collection offset (in milliseconds) for a tag. The collection offset only applies to polled type collection as used to schedule sampling of data at a specific time of day. The collection offset is applied from midnight to determine the time of the first sample. The collection interval is then used to schedule subsequent samples.

For example, with a collection interval of 60,000ms and a collection offset of 30,000ms, data would be collected one per minute on the half minute. To collect data once per day at a specific time, the collection interval should be set to one day, 1440 * 60 * 1000 = 86,400,000ms, and the collection offset should be set to the time in milliseconds from midnight (for example, 6am = 6 * 3600 * 1000 = 21,600,000 ms).

Changes to tag properties are not committed until you call the WriteRecordset method of the TagRecordset object.

Syntax

object.CollectionOffset[ = Long]

Parameters

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 following table 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

Syntax

object.CollectionType[ = ihCollectionType]

Parameters

None

CollectionType Property (TagCriteria Object)

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

Syntax

object.CollectionType[ = ihCollectionType]

Parameters

None

CollectionType Property (TagFields Object)

Determines whether the TagRecordset query returns the CollectionType field.

Syntax

object.CollectionType[ = Boolean]

Parameters

None

CollectionTypeList Property (Tags Object)

Returns a list of the valid Collection types available in Historian.

Syntax

object.CollectionTypeList

Parameters

None

CollectionTypeSet Property (TagCriteria Object)

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

Syntax

object.CollectionTypeSet[ = Boolean]

Parameters

None

CollectionTypeUpdated Property (Tag Object)

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

Syntax

object.CollectionTypeUpdated[ = Boolean]

Parameters

None

CollectorCompression Property (Tag Object)

Returns or sets whether collector compression is enabled for the Tag. Specify the deadband in the CollectorDeadbandPercentRange property.

Changes to tag properties are not committed until you call the WriteRecordset method of the TagRecordset object.

Syntax

object.CollectorCompression[ = Boolean]

Parameters

None

CollectorCompression Property (TagCriteria Object)

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

Changes to tag properties are not committed until you call the WriteRecordset method of the TagRecordset object.

Syntax

object.CollectorCompression[ = Boolean]

Parameters

None

CollectorCompression Property (TagFields Object)

Determines whether the TagRecordset query returns the CollectorCompression field.

Syntax

object.CollectorCompression[ = Boolean]

Parameters

None

CollectorCompressionSet Property (TagCriteria Object)

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

Syntax

object.CollectorCompressionSet[ = Boolean]

Parameters

None

CollectorCompressionTimeout Property (Tag Object)

Gets or sets the value of the Collector Compression Timeout. This is the amount of time after which a value will be sent to the Archiver regardless of compression.

Syntax

object.CollectorCompressionTimeout[ = Long]

Parameters

None

CollectorCompressionTimeout Property (TagCriteria Object)

Sets the Collector Compression Timeout value to search for in the TagRecordset query.

Syntax

object.CollectorCompressionTimeout[ = Long]

Parameters

None

CollectorCompressionTimeout Property (TagFields Object)

Determines whether the TagRecordset query returns the CollectorCompressionTimeout field.

Syntax

object.CollectorCompressionTimeout[ = Boolean]

Parameters

None

CollectorCompressionTimeoutSet Property (TagCriteria Object)

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

Syntax

object.CollectorCompressionTimeoutSet[ = Boolean]

Parameters

None

CollectorCompressionTimeoutUpdated Property (Tag Object)

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

Syntax

object.CollectorCompressionTimeoutUpdated[ = Boolean]

Parameters

None

CollectorCompressionUpdated Property (Tag Object)

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

Syntax

object.CollectorCompressionTimeoutUpdated[ = Boolean]

Parameters

None

CollectorCompressionUpdated Property (Tag Object)

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

Syntax

object.CollectorCompressionTimeoutUpdated[ = Boolean]

Parameters

None

CollectorConditionEventList Property (OPCFilters Object)

Returns a list of the Condition Event Categories available for filtering on the Alarm Collector.

Syntax

object.CollectorConditionEventList

Parameters

None

CollectorDeadbandPercentRange Property (Tag Object)

Returns or sets the deadband in percent of engineering unit range for collector compression for the Tag. You must enable CollectorCompression before setting the CollectorDeadbandPercentRange.

Changes to tag properties are not committed until you call the WriteRecordset method of the TagRecordset object.

Syntax

object.CollectorDeadbandPercentRange[ = Single]

Parameters

None

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

None

CollectorDeadbandPercentRangeUpdated Property (Tag Object)

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

Syntax

object.CollectorDeadbandPercentRangeUpdated[ = Boolean]

Parameters

None

CollectorGeneral1 Property (Tag Object)

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

Syntax

object.CollectorGeneral1[ = String]

Parameters

None

Example

MyTag.CollectorGeneral1 = "Model2:123"

CollectorGeneral1 Property (TagCriteria Object)

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

Syntax

object.CollectorGeneral1[ = String]

Parameters

None

Example

With MyRecordset.Criteria .TagName = "*.F_CV" .CollectorGeneral1 = "Model" End With

CollectorGeneral1 Property (TagFields Object)

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

Syntax

object.CollectorGeneral1[ = Boolean]

Parameters

None

Example

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

CollectorGeneral1Set Property (TagCriteria Object)

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

CollectorGeneral4Set Property (TagCriteria Object)

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

Syntax

object.CollectorGeneral4Set[ = Boolean]

Parameters

None

CollectorGeneral4Updated Property (Tag Object)

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

Syntax

object.CollectorGeneral4Updated[ = Boolean]

Parameters

None

CollectorGeneral5 Property (Tag Object)

Returns or sets the general5 (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.CollectorGeneral5[ = String]

Parameters

None

CollectorGeneral5 Property (TagCriteria Object)

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

Syntax

object.CollectorGeneral5[ = String]

Parameters

None

CollectorGeneral5 Property (TagFields Object)

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

Syntax

object.CollectorGeneral5[ = Boolean]

Parameters

None

CollectorGeneral5Set Property (TagCriteria Object)

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

Syntax

object.CollectorGeneral5Set[ = Boolean]

Parameters

None

CollectorName Property (Tag Object)

Returns or sets the name of the 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.CollectorName[ = String]

Parameters

None

CollectorName Property (TagFields Object)

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

Syntax

object.CollectorName[ = Boolean]

Parameters

None

CollectorNameSet Property (TagCriteria Object)

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

Syntax

object.CollectorNameSet[ = Boolean]

Parameters

None

CollectorNameUpdated Property (Tag Object)

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

Syntax

object.CollectorNameUpdated[ = Boolean]

Parameters

None

CollectorOptions Property (Collector Object)

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

The following table describes each of the options:

Table 2. Options

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.CollectorOptions(OptionName) [ = Variant]

Parameters

OptionName - Variant - The name of a collection

CollectorSimpleEventList Property (OPCFilters Object)

Returns a list of the Simple Event Categories available for filtering on the Alarm Collector.

Syntax

object.CollectorSimpleEventList

Parameters

None

CollectorSupportsAreaFiltering Property (OPCFilters Object)

Returns whether or not Area Filtering is supported by the Alarm Collector. This can only be determined if the collector is connected to the Alarm Server.

Syntax

object.CollectorSupportsAreaFiltering

Parameters

None

CollectorSupportsCategoryFiltering Property (OPCFilters Object)

Returns whether or not Category Filtering is supported by the Alarm Collector. This can only be determined if the collector is connected to the Alarm Server.

Syntax

object.CollectorSupportsCategoryFiltering

Parameters

None

CollectorSupportsCategoryFiltering Property (OPCFilters Object)

Returns whether or not Category Filtering is supported by the Alarm Collector. This can only be determined if the collector is connected to the Alarm Server.

Syntax

object.CollectorSupportsCategoryFiltering

Parameters

None

CollectorSupportsEventFiltering Property (OPCFilters Object)

Returns whether or not Event Filtering is supported by the Alarm Collector. This can only be determined if the collector is connected to the Alarm Server.

Syntax

object.CollectorSupportsEventFiltering

Parameters

None

CollectorSupportsSeverityFiltering Property (OPCFilters Object)

Returns whether or not Severity Filtering is supported by the Alarm Collector. This can only be determined if the collector is connected to the Alarm Server.

Syntax

object.CollectorSupportsSeverityFiltering

Parameters

None

CollectorSupportsSourceFiltering Property (OPCFilters Object)

Returns whether or not Source Filtering is supported by the Alarm Collector. This can only be determined if the collector is connected to the Alarm Server.

Syntax

object.CollectorSupportsSourceFiltering

Parameters

None

CollectorTrackingEventList Property (OPCFilters Object)

Returns a list of the Tracking Event Categories available for filtering on the Alarm 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	Press Tab to add rows.

CollectorVersion Property (Collector Object)

Returns the collector version. This version information is available for collectors of version 5.0 and later

Syntax

Object.CollectorVersion

Parameters

None

Sample Code

Public ConnectedServer As iHistorian_SDK.Server
Dim MyCollector As iHistorian_SDK.Collector
Dim CollectorName As String
Dim ServerName As String
Private Sub BTNGetVersion_Click()
On Error GoTo errc
    If Not ConnectedServer Is Nothing Then
        ConnectedServer.Disconnect
        Set ConnectedServer = Nothing
        Set ConnectedServer = CreateObject("iHistorian_SDK.Server")
    Else
        Set ConnectedServer = CreateObject("iHistorian_SDK.Server")
    End If
    If Not ConnectedServer.Connect(ServerName, "", "") Then
        MsgBox "Connect To Server: " + ServerName + " Failed."
    Else
         Set MyCollector = ConnectedServer.Collectors.Item(CollectorName)    
        If MyCollector.Running = True Then
            MsgBox "Collector version: " + MyCollector.CollectorVersion
        Else
            MsgBox "Collector version: Unknown"
        End If
    End If    
Exit Sub
errc:
    MsgBox Err.Number
End Sub

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

object.Comment

Parameters

None

Remarks

Comment is a read-only property of type Variant.

Comment Property (Tag Object)

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

Syntax

object.Comment[ = String]

Parameters

None

Comment Property (TagCriteria Object)

Sets the comment to search for in the TagRecordset query.

Syntax

object.Comment[ = String]

Parameters

None

Comment Property (TagFields Object)

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

Syntax

object.Comment[ = Boolean]

Parameters

None

CommentSet Property (TagCriteria Object)

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

Syntax

object.CommentSet[ = Boolean]

Parameters

None

CommentTimestamp Property (DataComments Object)

Returns the time that the comment was added to the archive.

Syntax

object.CommentTimestamp

Parameters

None

Remarks

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

None

CommentUpdated Property (Tag Object)

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

Syntax

object.CommentUpdated[ = Boolean]

Parameters

None

Comments Property (DataFields Object)

Determines whether the Comments field should be returned in the DataRecordset query.

Syntax

object.Comments[ = Boolean]

Parameters

None

Comments Property (DataValue Object)

Returns the collection of comments that applies to the DataValue.

Syntax

object.Comments

Parameters

None

Remarks

Comments is a read-only property of type Collection.

CommentsUpdated Property (DataValue Object)

This property is for internal use only.

Syntax

object.CommentsUpdated

Parameters

None

ComputerName Property (Collector Object)

Returns or sets the name of the computer that the collector executes on.

Syntax

object.ComputerName[ = String]

Parameters

None

Remarks

ComputerName is a read-only property of type String.

ConditionCollectionCompareValue Property

Returns or Contains compare value against the value of the triggertag.

Syntax

object.ConditionCollectionCompareValue [ = String]

Parameters

None

ConditionCollectionCompareValue Property

Returns or Contains compare value against the value of the triggertag.

Syntax

object.ConditionCollectionCompareValue [ = String]

Parameters

None

ConditionCollectionComparison Property

Contains the condition collection for a tag.

Syntax

object.ConditionCollectionComparison [ = Enum]

Parameters

None

ConditionCollectionEnabled Property

Sets the condition collection for a tag.

Syntax

object.ConditionCollectionEnabled [ = Boolean]

Parameters

None

ConditionCollectionMarkers Property

Returns or Sets if the end of the markers to be stored when the condition becomes FALSE. If FALSE, a bad data marker is not inserted when the condition becomes false.

Syntax

object.ConditionCollectionMarkers [ = Boolean]

Parameters

None

ConditionCollectionTriggertag Property

Contains a trigger tag from the list of tags associated with the collector.

Syntax

object.ConditionCollectionTriggertag [ = String]

Parameters

None

Connected Property (Server Object)

Returns the authentication status of the current server connection. True means you are connected to the server.

Syntax

object.Connected

Parameters

None

Remarks

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

ConnectionOptions is a read-only property of type Collection of Options.

Count Property (TagDependencies Object)

This function returns the current number of Dependent Tags configured.

Syntax

object.Count

Parameters

None

Count Property (DataStores Object)

Gets the number of items in the collection.

Syntax

object.Count

Parameters

None

Remarks

Count is a read-only property of type Collection.

Count Property (EnumeratedStates Object)

Returns the number of items in the EnumeratedStates collection.

Syntax

object.Count

Parameters

None

Remarks

Long

Criteria Property (DataRecordset Object)

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.

1. 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

2. 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.
   2. Supply an array of strings representing the list of tags to retrieve data for by using the Tags() property of the DataCriteria object.
   1. 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.

3. Specify the Calculation Mode.

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

The following table describes the available calculation modes.

Table 3. 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

object.CurrentValue

Parameters

None

Remarks

CurrentValue is a read-only property of type DataValue.

D

Data Property (Server Object)

Returns the Data object for the current server. Use the Data object to build queries for collected data.

Syntax

object.Data

Parameters

None

DataStores Property (Server Object)

Returns the collection of the available data stores.

Syntax

object.DataStores

Parameters

None

Remarks

DataStores

DataQuality Property (DataFields Object)

Determines whether the DataQuality field should be returned in the DataRecordset query.

Syntax

object.DataQuality[ = Boolean]

Parameters

None

DataQuality Property (DataValue Object)

Returns or sets the quality of the DataValue.

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

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)

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.General2[ = String]

Parameters

None

General3 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.General3[ = String]

Parameters

None

General4 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.General4[ = String]

Parameters

None

General5 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.General4[ = String]

Parameters

None

H

Handle Property (Server Object)

Returns the internal identifier for the current server.

Syntax

object.Handle

Parameters

None

Remarks

Handle is a read-only property of type Long.

HeartbeatOutputAddress Property (Collector Object)

Returns or sets the address in the data source that the collector sends heartbeat information to. The collector will write a 1 to this address once per minute.

Syntax

object.HeartbeatOutputAddress[ = String]

Parameters

None

Example

'Print Out The Heartbeat Output Address configured for the collector DebugPrint MyCollector.HeartbeatOutputAddress

HiEngineeringUnits Property (Tag Object)

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

Syntax

object.HiEngineeringUnits[ = Double]

Parameters

None

HiEngineeringUnits Property (TagCriteria Object)

Sets the high engineering unit range to search for in the TagRecordset query.

Syntax

object.HiEngineeringUnits[ = Double]

Parameters

None

HiEngineeringUnits Property (TagFields Object)

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

Syntax

object.HiEngineeringUnits[ = Boolean]

Parameters

None

HiEngineeringUnitsSet Property (TagCriteria Object)

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

Syntax

object.HiEngineeringUnitsSet[ = Boolean]

Parameters

None

HiEngineeringUnitsUpdated Property (Tag Object)

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

Syntax

object.HiEngineeringUnitsUpdated[ = Boolean]

Parameters

None

HiScale Property (Tag Object)

Sets the high scale value used for input scaling on the Tag. Changes to tag properties are not committed until you call the WriteRecordset method of the TagRecordset object.

Syntax

object.HiScale[ = String]

Parameters

None

HiScale Property (TagCriteria Object)

Sets the high input scale range value to search for in the TagRecordset query.

Syntax

object.HiScale[ = String]

Parameters

None

HiScale Property (TagFields Object)

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

Syntax

object.HiScale[ = Boolean]

Parameters

None

HiScaleSet Property (TagCriteria Object)

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

Syntax

object.HiScaleSet[ = Boolean]

Parameters

None

HiScaleUpdated Property (Tag Object)

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

Syntax

object.HiScaleUpdated[ = Boolean]

Parameters

None

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

I

Id Property (DataStore Object)

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

Syntax

object.Id

Parameters

None

Remarks

String. This is a read-only property.

ImportErrors Property (Alarms Object)

Returns a list of Import Error messages.

Syntax

object.ImportErrors

Parameters

None

ImportErrors Property (DataRecordset Object)

Returns a list of Import Error messages.

Syntax

object.ImportErrors

Parameters

None

ImportErrors Property (MessageRecordset Object)

Returns a list of Import Errors.

Syntax

object.ImportErrors

Parameters

None

ImportErrors Property (TagRecordset Object)

Returns a list of tag import errors.

Syntax

object.ImportErrors

Parameters

None

InputScaling Property (Tag Object)

Returns or sets whether input scaling is enabled for the Tag. Changes to tag properties are not committed until you call the WriteRecordset method of the TagRecordset object.

Syntax

object.InputScaling[ = Boolean]

Parameters

None

InputScaling Property (TagCriteria Object)

Sets the input scaling to search for in the TagRecordset query.

Syntax

object.InputScaling[ = Boolean]

Parameters

None

InputScaling Property (TagFields Object)

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

Syntax

object.InputScaling[ = Boolean]

Parameters

None

InputScalingSet Property (TagCriteria Object)

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

Syntax

object.InputScalingSet[ = Boolean]

Parameters

None

InputScalingUpdated Property (Tag Object)

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

Syntax

object.InputScalingUpdated[ = Boolean]

Parameters

None

IsSystem Property (DataStore Object)

Indicates or sets that data store is the single-system data store and therefore, cannot be modified.

Syntax

object.IsSystem

Parameters

None

InterfaceAbsoluteDeadband Property (Tag Object)

Returns or sets the Absolute Deadband value for this tag to be used in the Collector.

Syntax

object.InterfaceAbsoluteDeadband[ = Double]

Parameters

None

InterfaceAbsoluteDeadband Property (TagCriteria Object)

Sets the InterfaceAbsoluteDeadband to search for in the TagRecordset query.

Syntax

object.InterfaceAbsoluteDeadband[ = Double]

Parameters

None

InterfaceAbsoluteDeadband Property (TagFields Object)

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

Syntax

object.InterfaceAbsoluteDeadband[ = Double]

Parameters

None

InterfaceAbsoluteDeadbandSet Property (TagCriteria Object)

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

Syntax

object.InterfaceAbsoluteDeadbandSet[ = Boolean]

Parameters

None

InterfaceAbsoluteDeadbandUpdated Property (Tag Object)

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

Syntax

object.InterfaceAbsoluteDeadbandUpdated[ = Boolean]

Parameters

None

InterfaceAbsoluteDeadbanding Property (Tag Object)

Returns or sets whether this tag is using Absolute Deadbanding in the Collector or not.

Syntax

object.InterfaceAbsoluteDeadbanding[ = Boolean]

Parameters

None

InterfaceAbsoluteDeadbanding Property (TagCriteria Object)

Sets the InterfaceAbsoluteDeadbanding to search for in the TagRecordset query.

Syntax

object.InterfaceAbsoluteDeadbanding[ = Boolean]

Parameters

None

InterfaceAbsoluteDeadbanding Property (TagFields Object)

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

Syntax

object.InterfaceAbsoluteDeadbanding[ = Boolean]

Parameters

None

InterfaceAbsoluteDeadbandingSet Property (TagCriteria Object)

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

Syntax

object.InterfaceAbsoluteDeadbandingSet[ = Boolean]

Parameters

None

InterfaceAbsoluteDeadbandingUpdated Property (Tag Object)

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

Syntax

object.InterfaceAbsoluteDeadbandingUpdated[ = Boolean]

Parameters

None

IsActiveRedundantCollector Property (Collector Object)

Returns whether this collector is currently the active collector in a redundant set of collectors.

Syntax

object.IsActiveRedundantCollector

Parameters

None

Remarks

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

IsDefaultServer Property (Server Object)

Returns and/or determines if the current server is the default server. You can create an instance of the Server object and connect it without supplying a server name, username, or password. In this case, the default server and associated user information establishes the default connection.

Syntax

object.IsDefaultServer

Parameters

None

IsDeleted Property (DataValue Object)

This function returns a Boolean which indicates whether or not this DataValue has been deleted or not.

Syntax

object.IsDeleted

Parameters

None

IsDeleted Property (Tag Object)

Returns whether or not this tag has been deleted.

Syntax

object.IsDeleted

Parameters

None

Modified Property (DataValue Object)

This function returns Boolean which indicates whether or not any of this DataValue's fields have been modified.

Syntax

object.IsModified

Parameters

None

IsModified Property (Tag Object)

Returns whether or not this tag has been modified.

Syntax

object.IsModified

Parameters

None

IsNew Property (DataComments Object)

Returns whether or not this Comment is new or not.

Syntax

object.IsNew

Parameters

None

IsNew Property (DataValue Object)

This function returns a Boolean which indicates whether or not this DataValue is new.

Syntax

object.IsNew

Parameters

None

IsNew Property (Message Object)

Returns whether this is a new message or not.

Syntax

object.IsNew

Parameters

None

IsNew Property (Tag Object)

Tag.IsNew indicates whether this is a newly created tag. Returns true if the tag???s name does not exist in the server.

Syntax

object.IsNew

Parameters

None

Item Property (Archives Object)

Returns a specific Archive object contained in the Archives object. The Item collection can loop through all Archives, or reference a specific Archive object directly by archive name.

The Archive Item collection automatically populates when the Archives object is instantiated.

Syntax

object.Item

Parameters

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.

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)

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 (Messages 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

LastError is a read-only property of type String.

LastError Property (Messages 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

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

LastError is a read-only property of type String.

LastError Property (Tag Object)

Contains the last error string generated.

Syntax

object.LastError[ = String]

Parameters

None

LastError Property (TagRecordset Object)

Returns the last error message encountered by the TagRecordset 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 (Tags Object)

Returns the last error message encountered by the Tags 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.

LastModified Property (Tag Object)

Returns the time the tag configuration of this Tag was last modified.

Syntax

object.LastModified

Parameters

None

Remarks

LastModified is a read-only property of type Date.

LastModified Property (TagCriteria Object)

Sets the last modified time to search for in the TagRecordset query.

Syntax

object.LastModified[ = Date]

Parameters

None

LastModified Property (TagFields Object)

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

Syntax

object.LastModified[ = Boolean]

Parameters

None

LastModified Property (UserDefinedTypes Object)

Returns the time when the User Defined Type was last modified.

Syntax

object.LastModified

Parameters

None

Returns

LastModified is a read-only property of type Date.

LastModifiedSet Property (TagCriteria Object)

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

Syntax

object.LastModified[ = Boolean]

Parameters

None

LastModifiedUser Property (Tag Object)

Returns the user who last modified this Tag configuration.

Syntax

object.LastModifiedUser

Parameters

None

Remarks

LastModifiedUser is a read-only property of type Date.

LastModifiedUser Property (TagCriteria Object)

Sets the last modified user to search for in the TagRecordset query.

Syntax

object.LastModifiedUser[=string]

Parameters

None

LastModifiedUser Property (TagFields Object)

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

Syntax

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

LastModifiedUser is a read-only property of type String.

LastModifiedUserSet Property (TagCriteria Object)

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

Syntax

object.LastModifiedUser[=Boolean]

Parameters

None

LeafCount Property (OPCBrowse Object)

Returns the number of leaves under a browse position. When a browse operation occurs, the server returns all areas and sources under the BrowsePosition. LeafCount gives you the number of leaves, which you can use to iterate the LeafNames and FullLeafNames arrays.

Syntax

object.LeafCount

Parameters

None

Returns

LeafCount is a read-only property of type String.

LeafNames Property (OPCBrowse Object)

Returns the display leaf name (source) for an AE server. See "FullLeafnames" property for more information.

Syntax

object.LeafNames(Index)

Parameters

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

Returns

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

LicensedTags Property (Server Object)

Returns the maximum number of tags that you can configure on the Server.

Syntax

object.LicensedTags(Index)

Parameters

None

Remarks

LicensedTags is a read-only property of type Long.

LicensedUsers Property (Server Object)

Returns the maximum number of users that may be connected to the Server at one time.

Syntax

object.LicensedUsers

Parameters

None

Remarks

LicensedUser is a read-only property of type Long.

LoEngineeringUnits Property (Tag Object)

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

Syntax

object.LoEngineeringUnits[ = Double]

Parameters

None

LoEngineeringUnits Property (TagCriteria Object)

Sets the low engineering unit range to search for in the TagRecordset query.

Syntax

object.LoEngineeringUnits[ = Double]

Parameters

None

LoEngineeringUnits Property (TagFields Object)

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

Syntax

object.LoEngineeringUnits[ = Boolean]

Parameters

None

LoEngineeringUnitsSet Property (TagCriteria Object)

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

Syntax

object.LoEngineeringUnitsSet[ = Boolean]

Parameters

None

LoEngineeringUnitsUpdated Property (Tag Object)

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

Syntax

object.LoEngineeringUnitsUpdated[ = Boolean]

Parameters

None

LoScale Property (Tag Object)

Returns or sets the low scale value used for input scaling on the Tag. Changes to tag properties are not committed until you call the WriteRecordset method of the TagRecordset object.

Syntax

object.LoScale[ = String]

Parameters

None

LoScale Property (TagCriteria Object)

Sets the low input scale range value to search for in the TagRecordset query.

Syntax

object.LoScale[ = String]

Parameters

None

LoScale Property (TagFields Object)

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

Syntax

object.LoScale[ = Boolean]

Parameters

None

LoScale Property (TagCriteria Object)

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

Syntax

object.LoScaleSet[ = Boolean]

Parameters

None

LoScaleUpdated (Tag Object)

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

Syntax

object.LoScaleUpdated[ = Boolean]

Parameters

None

LoadBalancing Property (Tag Object)

Returns or sets the status of data collection load balancing for the Tag. Load balancing is used for polled type collection to evenly distribute data collection load over available sampling times. This is sometimes called "Phase Shifting". Changes to tag properties are not committed until you call the WriteRecordset method of the TagRecordset object.

Syntax

object.LoadBalancing[ = Boolean]

Parameters

None

LoadBalancing Property (TagCriteria Object)

Sets the load balancing to search for in the TagRecordset query.

Syntax

object.LoadBalancing[ = Boolean]

Parameters

None

LoadBalancing Property (TagFields Object)

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

Syntax

object.LoadBalancing[ = Boolean]

Parameters

None

LoadBalancingSet Property (TagCriteria Object)

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

Syntax

object.LoadBalancingSet[ = Boolean]

Parameters

None

LoadBalancingUpdated Property (Tag Object)

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

Syntax

object.LoadBalancingUpdated[ = Boolean]

Parameters

None

LowPart Property (QueryModifiers Object)

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

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 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 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

MessageString Property (Message Object)

Returns the translated text of the message, including any substitutions. Messages generally include translated fixed text and variable substitutions such as timestamps, usernames, and tagnames.

Syntax

object.MessageString[String]

Parameters

None

MessageString Property (MessageCriteria Object)

Establishes text search criteria the MessageRecordset query filters by. The MessageString may be any sub-string of the message. You should not include wildcard characters.

Syntax

object.MessageString[=String]

Parameters

None

MessageString Property (MessageFields Object)

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

Syntax

object.MessageString[=Boolean]

Parameters

None

MessageStringSet Property (MessageCriteria Object)

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

Syntax

object.MessageStringSet[=Boolean]

Parameters

None

Messages Property (Server Object)

Returns the Messages Object for the current Server. Use the Messages Object to build queries for message data.

Syntax

object.Messages

Parameters

None

MessageOptions Property (Server Object)

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

Syntax

object.MessageVersion([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

MinorVersion is a read-only property of type Long.

N

Name Property (Archive Object)

Returns the name of the specified Archive.

Syntax

object.Name

Parameters

None

Name Property (Collector Object)

Returns the name of the specified Collector.

Syntax

object.Name

Parameters

None

Remarks

Name is a read-only property of type String.

Name Property (DataStore Object)

Returns the name of data store.

Syntax

object.Name

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

object.NodeFilter[ = Variant]

Parameters

None

Remarks

Nodefilter is a read/write property of type Variant for script compatibility.

NumberOfElements Property (Tag Object)

Returns or sets the number of elements of a tag to specify if it is an array. If the value of the NumberOfElements is -1 then it is an array tag. Changes to tag properties are not committed until you call the WriteRecordset method of the TagRecordset object.

Syntax

object.NumberOfElements[ = Long]

Parameters

None

NumberOfElements Property (TagCriteria Object)

Sets the NumberOfElements property to search for in the TagRecordset query. For example you can set to -1 if you want only array tags to be returned or set to 0 if you want non-array tags.

Syntax

object.NumberOfElements[ = Long]

Parameters

None

NumberOfElements Property (TagFields Object)

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

Syntax

object.NumberOfElements[ = Boolean]

Parameters

None

NumberOfFields Property (UserDefinedType Object)

Returns the number of fields in the User Defined Type.

Syntax

object.NumberOfFields

Parameters

Integer

NumberOfSamples Property (DataCriteria Object)

Returns or sets the number of samples to retrieve from the archive in the DataRecordset query. Samples will be evenly spaced within the time range defined by start time and end time for most sampling modes. For the "RawByNumber" sampling mode the NumberOfSamples determines the maximum number of values to retrieve. For the "RawByTime" sampling mode, the NumberOfSamples is ignored.

Syntax

object.NumberOfFields[ = Long]

Parameters

None

NumberOfSamplesSet Property (DataCriteria Object)

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

Syntax

object.NumberOfSamplesSet[ = Long]

Parameters

None

NumStateNames Property (EnumeratedState Object)

Returns the number of states in the set.

Syntax

object.NumStateNames

Parameters

None

Remarks

Long

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 alarms and events 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 alarms and events data. This option is specific only to data stores.
ArchiveTotalAlarm	The rate at which Historian is receiving data. This option is specific only to data stores.

Syntax

object.PerformanceStatistics[AsLocalizedString])

Parameters

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

Remarks

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

Example

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

PerformanceStatistics Property (Collector Object)

Exposes performance statistics for the selected collector.

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

Collector Performance Statistics

Statistic Description

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

Syntax

object.PerformanceStatistics(StatisticName,[AsLocalizedString])

Parameters

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

Example

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

PrimaryUsername Property (DataComments Object)

Returns the user who added the comment to the archive.

Syntax

object.PrimaryUsername

Parameters

None

Remarks

PrimaryUsername is a read-only property of type String.

Example

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

PrincipalCollector Property (Collector Object)

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

Syntax

object.PrincipalCollector[ = String]

Parameters

None

PropertyList Property (Archives Object)

This function returns a list of the supported Archive properties.

Syntax

object.PropertyList

Parameters

None

PropertyList Property (Collectors Object)

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

Syntax

object.PropertyList

Parameters

None

PropertyList Property (Data Object)

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

Syntax

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

Parameters

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

PropertyList Property (Messages Object)

Returns a list of available Properties for a message.

Syntax

object.PropertyList

Parameters

None

PropertyList Property (Tags Object)

Returns a list of valid Properties for a Tag.

Syntax

object.PropertyList

Parameters

None

QueryModifiers Property (QueryModifiers Object)

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

Syntax

object.QueryModifiers

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

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

S

SamplingDirectionList Property (Data Object)

This function returns a list of the available Sampling directions for a data request.

Syntax

object.SamplingDirectionList

Parameters

None

SamplingInterval Property (DataCriteria Object)

Returns or sets the interval (in milliseconds) between samples from the archive in the DataRecordset query. For the "RawByNumber" and "RawByTime" sampling modes, the SamplingInterval is ignored. This property can be used in place of the NumberofSamples property.

Syntax

object.SamplingInterval[=Long]

Parameters

None

SamplingIntervalSet Property (DataCriteria Object)

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

Syntax

object.SamplingIntervalSet[=Boolean]

Parameters

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

object.SetName

Parameters

None

Returns

String

SimpleEvents Property (OPCFilters Object)

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

Syntax

object.SimpleEvents

Parameters

None

SourceAddress Property (Tag Object)

Returns or sets the address used to identify the Tag in the data source. Changes to tag properties are not committed until you call the WriteRecordset method of the TagRecordset object.

Syntax

object.SourceAddress[ = String]

Parameters

None

SourceAddress Property (TagCriteria Object)

Sets the tag source address to search for in the TagRecordset query.

Syntax

object.SourceAddress[ = String]

Parameters

None

SourceAddress Property (TagFields Object)

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

Syntax

object.SourceAddress[ = Boolean]

Parameters

None

SourceAddressSet Property (TagCriteria Object)

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

Syntax

object.SourceAddressSet[ = Boolean]

Parameters

None

SourceAddressUpdated Property (Tag Object)

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

Syntax

object.SourceAddressUpdated[ = Boolean]

Parameters

None

Sources Property (OPCFilters Object)

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

Syntax

object.Sources[ = Boolean]

Parameters

None

SpikeLogic Property (Tag Object)

Returns or sets whether this tag uses the spike logic compression algorithm.

Syntax

object.SpikeLogic[ = Boolean]

Parameters

None

SpikeLogic Property (TagCriteria Object)

Sets the spike logic to search for in the TagRecordset query.

Syntax

object.SpikeLogic[ = Boolean]

Parameters

None

SpikeLogic Property (TagFields Object)

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

Syntax

object.SpikeLogic[ = Boolean]

Parameters

None

SpikeLogicOverride Property (Tag Object)

Returns or sets whether this tag should use the its own Spike Logic setting or the default Collectors setting.

Syntax

object.SpikeLogicOverride[ = Boolean]

Parameters

None

SpikeLogicOverride Property (TagCriteria Object)

Sets the spike logic override to search for in the TagRecordset query.

Syntax

object.SpikeLogicOverride[ = Boolean]

Parameters

None

SpikeLogicOverride Property (TagFields Object)

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

Syntax

object.SpikeLogicOverride[ = Boolean]

Parameters

None

SpikeLogicOverrideSet Property (TagCriteria Object)

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

Syntax

object.SpikeLogicOverrideSet[ = Boolean]

Parameters

None

SpikeLogicOverrideUpdated Property (Tag Object)

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

Syntax

object.SpikeLogicOverrideUpdated[ = Boolean]

Parameters

None

SpikeLogicSet Property (TagCriteria Object)

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

Syntax

object.SpikeLogicSet[ = Boolean]

Parameters

None

SpikeLogicUpdated Property (Tag Object)

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

Syntax

object.SpikeLogicUpdated[ = Boolean]

Parameters

None

StartTime Property (Archive Object)

Returns the start time of the specified archive. This represents the earliest timestamp for any sample contained in the archive.

Syntax

object.StartTime

Parameters

None

StartTime Property (DataCriteria Object)

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

Syntax

object.StartTime[ = Date]

Parameters

None

StartTime Property (MessageCriteria Object)

Establishes the start time of the MessageRecordset query.

Syntax

object.StartTime[ = Date]

Parameters

None

StartTimeSet Property (DataCriteria Object)

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

Syntax

object.StartTimeSet[ = Boolean]

Parameters

None

StartTimeSet Property (MessageCriteria Object)

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"

StartTimeShortcutSet Property (MessageCriteria Object)

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

Syntax

object.StartTimeShortcutSet[ = Boolean]

Parameters

None

State Property (DataStore Object)

Returns or sets the state of data store. For example, Running.

Syntax

object.State

Parameters

None

Remarks

ihDataStoreState

State Property (DataStore Object)

Returns or sets the state of data store. For example, Running.

Syntax

object.State

Parameters

None

Remarks

ihDataStoreState

State Property (DataStore Object)

Returns or sets the state of data store. For example, Running.

Syntax

object.State

Parameters

None

Remarks

ihDataStoreState

StateLowRawValue Property (EnumeratedState Object)

Returns or defines the minimum value of a state when you are using a range of values for a state. For example, if your state value is from 0 to 5 and it is defined as ON, then this would be 0.

Syntax

object.StateLowRawValue

Parameters

None

Remarks

Variant. Returns the low raw value of the state.

StateValue Property (QueryModifiers Object)

Returns or sets the state value to be used when querying data with the StateCount and StateTime calculation modes.

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

StepValue Property (Tag Object)

Returns or sets whether this tag is using Step Value or not.

Syntax

object.StepValue[ = Boolean]

Parameters

None

StepValue Property (TagCriteria Object)

Sets the Step Value value to search for in the TagRecordset query.

Syntax

object.StepValue[ = Boolean]

Parameters

None

StepValue Property (TagFields Object)

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

Syntax

object.StepValue[ = Boolean]

Parameters

None

StepValueSet Property (TagCriteria Object)

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

Syntax

object.StepValueSet[ = Boolean]

Parameters

None

StepValueUpdated Property (Tag Object)

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

Syntax

object.StepValueUpdated[ = Boolean]

Parameters

None

StorageType Property (DataStore Object)

Returns the type of data store. For example, ScadaBufferStore or Historical data store.

Syntax

object.StorageType

Parameters

None

Remarks

ihDataStorageType

StoreMilliseconds Property (Tag Object)

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

Syntax

object.StoreMilliseconds[ = Boolean]

Parameters

None

StoreMilliseconds Property (TagCriteria Object)

Sets the time resolution to search for in the TagRecordset query.

Syntax

object.StoreMilliseconds[ = Boolean]

Parameters

None

StoreMilliseconds Property (TagFields Object)

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

Syntax

object.StoreMilliseconds[ = Boolean]

Parameters

None

StoreMillisecondsSet Property (TagCriteria Object)

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

Syntax

object.StoreMilliseconds[ = Boolean]

Parameters

None

StoreMillisecondsUpdated Property (Tag Object)

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

Syntax

object.StoreMillisecondsUpdated[ = Boolean]

Parameters

None

StoreOPCQuality Property (Server Object)

Returns or sets whether the server stores the raw (16-bit) OPC quality flags.

Syntax

object.StoreOPCQuality[ = Boolean]

Parameters

None

Strict Client Authentication Property

Returns or sets whether to enforce strict client authentication. Setting this value to TRUE will disallow connections from clients older than version 4.7.

Syntax

object.StrictClientAuthentication

Parameters

None

Strict Collector Authentication (Archives Object)

Returns or sets whether to enforce strict client authentication. Setting this value to TRUE will disallow connections from clients older than version 4.7.

Syntax

object.StrictCollectorAuthentication

Parameters

None

StringLength Property (Tag Object)

Returns or sets the fixed string length associated with a fixed string type Tag. Changes to tag properties are not committed until you call the WriteRecordset method of the TagRecordset object.

Syntax

object.StringLength[ = Byte]

Parameters

None

StringLength Property (TagFields Object)

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

Syntax

object.StringLength[ = Boolean]

Parameters

None

StringLengthSet Property (TagCriteria Object)

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

Syntax

object.StringLengthSet[ = Boolean]

Parameters

None

StringLengthUpdated Property (Tag Object)

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

Syntax

object.StringLengthUpdated[ = Boolean]

Parameters

None

SubscribeStatus Property (Archives Object)

Subscribes to changes in Archive status and configuration. The Historian server publishes messages to any client signed up for Archive status changes as modifications are committed to the Archive Database. Setting the SubscribeStatus to True signs up for status and configuration changes on all archives.

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

Syntax

object.SubscribeStatus[ = Boolean]

Parameters

None

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