Property Reference C-D
CalcType Property (Tag Object)
Returns or sets the CalcType for the tag. The CalcType is used to determine whether the tag is a Python Expression tag or a Raw tag.
| Name | Description | Value |
|---|---|---|
| RawTag | A tag is not a Python Expression Tag | 0 |
| PythonExprTag | A tag that uses a Python Expression to transform raw data into derived values. | 2 |
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 |
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 Caculation 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 IfCanAdministerConfiguration 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 IfCanAdministerSecurity 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
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 table below lists the available types of collection:
| Name | Description | Value |
|---|---|---|
| Unsolicited | New values are reported by the source. | 1 |
| Polled | New values are polled from the source. | 2 |
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 WithCollectorGeneral2Set 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 WithCollectorGeneral3Set 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 WithCollectorGeneral4Set 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:
Option Description
| Option | Capability |
|---|---|
| CollectorCanBrowseSource | TRUE if the collector supports browse. |
| CollectorMaxMemoryBufferSize | Specifies the size in megabytes of the memory buffer assigned to the store and forward function. |
| Source Address | Yes |
| CollectorMaxDiskBufferSize | Specifies the minimum free disk space that must be available on the computer and cannot be used for store and forward function. |
| CollectorRateOutputAddress | Specifies the address in the source database into which the collector will write the current value of the events per minute output. |
| CollectorStatusOutputAddress | Specifies the address in the source database into which the collector will write the current value of the collector status (running, stopped, unknown, etc.). |
| CollectorAdjustForTimeDifference | TRUE if you want to adjust collector timestamps to match the server clock. |
| CollectorStartDelay | A delay, in seconds, after collector startup before collection starts. |
| CollectorSourceTimesLocal | If you are using source timestamps, set this to TRUE if the source timestamps are in local time. |
| CollectorMakeTagChangesOnline | Set to TRUE if you want tag changes to take effect without restarting collector. |
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.CollectorTypeCollectorType Property (Tag Object)
Returns or sets the type of Collector responsible for collecting data for the Tag. Changes to tag properties are not committed until you call the WriteRecordset method of the TagRecordset object.
Syntax
object.CollectorType[ = String]
Parameters
None
CollectorType Property (TagCriteria Object)
Sets the collector type to search for in the TagRecordset query.
Syntax
object.CollectorType[ = String]
Parameters
None
CollectorType Property (TagFields Object)
Determines whether the CollectorType field should be returned in the TagRecordset query.
Syntax
object.CollectorType[ = Boolean]
Parameters
None
CollectorTypeList Property (Collectors Object)
Returns a list of Collector Types available. These types may be used in other SDK functions.
Syntax
object.CollectorTypeList
Parameters
None
Example
'Get a List of the Available Collector Types Dim ListArray As Variant Dim I As Integer ListArray = MyCollectors.CollectorTypeList For I = LBound(ListArray) To UBound(ListArray) Debug.Print "Historian has a " + ListArray(I, 2) + " collector" Next I
CollectorTypeSet Property (TagCriteria Object)
A flag to indicate whether this property has been set or not.
Syntax
object..CollectorTypeSet[ = Boolean]
Parameters
None
CollectorTypeUpdated Property (Tag Object)
A flag to indicate whether this property has been set or not.
Syntax
object.CollectorTypeUpdated[ = Boolean]
Parameters
None
Examples
Body text goes here.
| Column Header | Column Header |
|---|---|
| Table text | Table text |
| Table text | Hit tab to add rows |
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
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 SubComment 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.CommeCommentSet 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
LongCriteria Property (DataRecordset Object)
Returns the Criteria object used to identify which DataValues the Historian server returns when a DataRecordset query is executed.
- Supply tags for query. You can specify tags in one of two ways:
- Supply a Tagmask that searches for all tags that match the mask and apply the remaining criteria to retrieve data. The mask can include wildcards. or
- Supply an array of strings representing the list of tags to retrieve data for by using the Tags() property of the DataCriteria object.
- Supply time frame for query.
To supply a time frame for the query, set the StartTime and EndTime properties or set the StartTimeShortcut and EndTimeShortcut properties.
- Specify the sampling mode.
A sampling mode must be set to determine how values are retrieved from the Historian archive. Depending on the sampling mode, you may also need to modify the Direction and NumberOfSamples. The following table lists the available Sampling Modes and their explanations.
Name Description Value CurrentValue Retrieves the current value. The time frame criteria are ignored. 1 Interpolated Retrieves evenly spaced interpolated values based on NumberOfSamples and the time frame criteria. 2 Trend Retrieves the raw minimum and raw maximum value for each specified interval. Use the Trend sampling mode to maximize performance when retrieving data points for plotting. A start time, end time, and an interval or number of samples must be specified. 3 RawByTime Retrieves raw archive values (compressed) based on time frame criteria. 4 RawByNumber Retrieves raw archive values (compressed) based on the StartTime criteria, the NumberOfSamples, and Direction criteria.
NOTE: The EndTime criteria is ignored for this Sampling mode.
5 Calculated Retrieves evenly spaced calculated values based on NumberOfSamples, the time frame criteria, and the CalculationMode criteria. 6 - Specify the Calculation Mode.
For the calculated SamplingMode, you must also specify the Calculation Mode.
The following table describes the available calculation modes.
Enumeration: ihCalculationMode
| Name | Description | Value |
|---|---|---|
| Equal | Filter condition is True, when the FilterTag is equal to the comparison value. | 1 |
| NotEqual | Filter condition is True, when the FilterTag is NOT equal to the comparison value. | 2 |
| LessThan | Filter condition is True, when the FilterTag is less than the comparison value. | 3 |
| GreaterThan | Filter condition is True, when the FilterTag is greater than the comparison value. | 4 |
| LessThanEqual | Filter condition is True, when the FilterTag is less than or equal to the comparison value. | 5 |
| GreaterThanEqual | Filter condition is True, when the FilterTag is greater than or equal to the comparison value. | 6 |
The filter eliminates archive data from retrieval or calculations that occur within the time period that the specified filter criterion is True. FilterMode determines exactly how changes in state of the FilterTag are interpreted for retrieval of data.
| Name | Description | Value |
|---|---|---|
| ExactTime | Retrieves data for the exact times that the filter condition is True. | 1 |
| BeforeTime | Retrieves data from the time of the last False filter condition up to the time of the True condition. | 2 |
| AfterTime | Retrieves data from the time of the True filter condition up to the time of next False condition. | 3 |
| BeforeAndAfterTime | Retrieves data from the time of the last False filter condition up to the time of next False condition. | 4 |
Syntax
object.Count
Parameters
None
Remarks
Criteria is a read-only property of type DataCriteria.
Criteria Property (MessageRecordset Object)
Use this property to specify which Messages to return from the Historian server when a MessageRecordset query executes.
A Topic may be optionally supplied to limit the Message queries to specific message topics. The following table provides a list of message topics.
| Name | Description | Value |
|---|---|---|
| Connections | Provides messages about client connections. | 1 |
| Security | Provides messages and alerts about login attempts and attempts to access restricted resources. | 2 |
| ConfigurationAudit | Provides messages about configuration changes and audit trail. | 3 |
| ServiceControl | Provides messages and alerts regarding startup and shutdown of the system and specific services. | 4 |
| Performance | Provides messages and alerts regarding system and archive performance. | 5 |
You can also optionally supply a time frame for the query. To do this, either set the StartTime and EndTime properties or set the StartTimeShortcut and EndTimeShortcut properties, or a combination of both.
All other fields of the MessageCriteria are evaluated by exact match if set.
Syntax
object.Criteria
Parameters
None
Remarks
Criteria is a read-only property of type MessageCriteria.
Criteria Property (TagRecordset Object)
Use this property to specify which Tags to return from the Historian server when a TagRecordset query is executed.
You can supply the Tagname and Description as a mask including wildcards to return all matching tags. All other fields of the TagCriteria object are tested for exact match if they are supplied or set.
Syntax
object.Criteria
Parameters
None
Remarks
Criteria is a read-only property of type TagCriteria.
CurrentValue Property (Tag Object)
Returns the current value of the Tag as a DataValue object. The DataValue object contains properties for the Value, TimeStamp, and DataQuality of the current value.
Syntax
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.ComDataType 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 Returns or sets the Default Collection Type for the given collector. This can be either Polled or Solicited.
Syntaxobject.DefaultCollectionType[ = iHistorian_SDK.ihCollectionType]
ParametersNone
Example
' Print Out The DefaultCollectionType configured for the collectorDebug.Print MyCollector.DefaultCollectorAbsoluteDeadbandReturns 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.
Syntaxobject.DefaultCollectorAbsoluteDeadbanding[ = Boolean]
ParametersNone
Example
' Print Out The DefaultCollectorAbsoluteDeadbanding configured for the collector DebugPrReturns or sets whether the collector uses Compression by default.
Syntaxobject.DefaultCollectorCompression[ = Boolean]
ParametersNone
Example
' Print Out The DefaultCollectorCompression configured for the collector Debug.Print MyCollReturns 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.
Syntaxobject.DefaultCollectorCompressionDeadband[ = Single]
ParametersNone
Example
' Print Out The DefaultCollectorCompressionDeadband configured for the collector Debug.Print MyCReturns 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.
Syntaxobject.DefaultCollectorCompressionTimeout[ = Long]
ParametersNone
Example
' Print Out The DefaultCollectorCompressionTimeout configured for the collector DebugReturns or sets whether the collector uses Load Balancing by default.
Syntaxobject.DefaultLoadBalancing[ = Boolean]
ParametersNone
Example
' Print Out The DefaultLoadBalancing configured for the collector Debug.Print MyCoReturns or sets a reference to the default Server Object.
Syntaxobject.DefaultServer
ParametersNone
Returns or sets the Default Spike Interval property for the Collector.
Syntaxobject.DefaultSpikeInterval[ = Long]
ParametersNone
Example
' Print Out The DefaultSpikeInterval configured for the collector Debug.Print MyCollector.DefaultSpikeInterReturns or sets the Default Collector Spike Logic property for the Collector.
Syntaxobject.DefaultSpikeLogic[ = Boolean]
ParametersNone
Example
' Print Out The DefaultSpikeLogic configured for the collector Debug.Print MyCollector.DefaultSpikeLogicReturns or sets the Default Spike Multiplier property for the Collector.
Syntaxobject.DefaultSpikeMultiplier[ = Double]
ParametersNone
Example
' Print Out The DefaultSpikeMultiplier configured for the collector Debug.PriReturns or sets the Default Tag Prefix property for the Collector.
Syntaxobject.DefaultTagPrefix[ = String]
ParametersNone
Example
' Print Out The DefaultTagPrefix configured for the collector DebugReturns or sets the Default Timestamp Type for the given collector. The Timestamps may be assigned by either the Data Source or the Collector itself.
Syntaxobject.DefaultTimestampType[ = iHistorian_SDK.ihTimeStampType]
ParametersNone
Example
' Print Out The DefaultTimestampType configured for the collector Debug.Print MyCollector.DefaultTimestampTypeReturns the definition of the specified UserCalcFunction.
Syntaxobject.Definition[ = String]
ParametersNone
Returns or sets the description for the given collector.
Syntaxobject.Description[ = String]
ParametersNone
Example
' Print Out The Description configured for the collector Debug.PReturns or sets the description or comments for an enumerated set.
Syntaxobject.Description
ParametersNone
Returns
String
Returns or defines the description or comments for a state.
Syntaxobject.Description
ParametersNone
Remarks
String. Returns the description or comments for each state.
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.
Syntaxobject.Description[ = String]
ParametersNone
Sets the description or description mask to search for in the TagRecordset query. The description may include wildcard characters.
Syntaxobject.Description[ = String]
ParametersNone
Determines whether the Description field should be returned in the TagRecordset query.
Syntaxobject.Description[= Boolean]
ParametersNone
Returns or sets the description or comments for a field in a User Defined Type.
Syntaxobject.Description
ParametersNone
Returns
String
A flag to indicate whether this property has been set or not.
Syntaxobject.DescriptionSet[ = Boolean]
ParametersNone
A flag to indicate whether this property has been set or not.
Syntaxobject.DescriptionUpdated[ = Boolean]
ParametersNone
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 |
object.Direction[ = iHistorian_SDK.ihSamplingDirection]
ParametersNone
A flag to indicate whether this property has been set or not.
Syntaxobject.DescriptionSet[ = Boolean]
ParametersNone