Property Reference A-B
The following list contains the Historian properties that are available in the Historian Software Development Kit in the alphabetical order.
A
ActualDataStores Property (Server Object)
Returns the actual data stores currently configured on the Historian Server.
Syntax
object.ActualDataStores
Parameters
None
Remarks
ActualDataStores is a read-only property of type Long.
ActualTags Property (Server Object)
Returns the number of tags currently configured on the Server. This number is less than or equal to the number of licensed tags.
Syntax
object.ActualTags
Parameters
None
Remarks
ActualTags is a read-only property of type Long.
ActualUsers Property (Server Object)
Returns the number of users currently connected to the Server. This number is less than or equal to the number of licensed users.
Syntax
object.ActualUsers
Parameters
None
Remarks
ActualUsers is a read-only property of type Long.
AdministratorSecurityGroup Property (Tag Object)
Returns or sets the name of the security group controlling configuration changes for the Tag. Changes to tag properties are not committed until you call the WriteRecordset method of the TagRecordset object.
Syntax
object.AdministratorSecurityGroup[ = String]
Parameters
None
AdministratorSecurityGroup Property (TagCriteria Object)
Sets the administrator security group for which the TagRecordset query searches.
Syntax
object.AdministratorSecurityGroup[ = String]
Parameters
None
AdministratorSecurityGroup Property (TagFields Object)
Determines whether the TagRecordset query returns the AdministratorSecurityGroup field.
Parameters
object.AdministratorSecurityGroup[ = Boolean]
Parameters
None
AdministratorSecurityGroup Property (UserDefinedType Object)
Returns or sets the name of the Administrator Security Group that controls the definition of a User Defined Type. You can create, modify or delete types if you have Administration Security Group permission to do so. If there is no assigned group then the name will be empty.
Syntax
object.MyAdministratorSecurityGroup
Parameters
None
Returns
String
AdministratorSecurityGroupSet Property (TagCriteria Object)
A flag to indicate whether this property has been set or not.
Syntax
object.AdministratorSecurityGroupSet[ = Boolean]
Parameters
None
AdministratorSecurityGroupUpdated Property (Tag Object)
A flag to indicate whether this property has been set or not.
Syntax
object.AdministratorSecurityGroupUpdated[ = Boolean]
Parameters
None
Alarms Property (Server Object)
Returns the Alarms object for the current server. Use the Alarms object to query Alarm and Event data of the server.
Syntax
object.Alarms
Parameters
None
Remarks
Alarms is a read-only property of type Alarms.
AllAlerts Property (MessageCriteria Object)
Causes the MessageRecordset query to include all alert topic messages.
Syntax
object.AllAlerts[ = Boolean]
Parameters
None.
Example
MyMessages.Criteria.AllAlerts = True
AllMessages Property (MessageCriteria Object)
Specifies that all message topic messages (non-alerts) should be returned by the MessageRecordset query.
Syntax
object.AllMessages[ = Boolean]
Parameters
None
Example
MyMessages.Criteria.AllMessages = True
ArchiveAbsoluteDeadband Property (Tag Object)
Returns or sets the Absolute Deadband value for this tag to be used in the Archiver.
Syntax
object.ArchiveAbsoluteDeadband[ = Double]
Parameters
None
ArchiveAbsoluteDeadband Property (TagCriteria Object)
Sets the ArchiveAbsoluteDeadband to search for in the TagRecordset query.
Syntax
object.ArchiveAbsoluteDeadband[ = Double]
Parameters
None
ArchiveAbsoluteDeadband Property (TagFields Object)
Determines whether the ArchiveAbsoluteDeadband field should be returned in the TagRecordset query.
Syntax
object.ArchiveAbsoluteDeadband[ = Boolean]
Parameters
None
ArchiveAbsoluteDeadbandSet Property (TagCriteria Object)
A flag to indicate whether this property has been set or not.
Syntax
object.ArchiveAbsoluteDeadbandSet[ = Boolean]
Parameters
None
ArchiveAbsoluteDeadbandUpdated Property (Tag Object)
A flag to indicate whether this property has been set or not.
Syntax
object.ArchiveAbsoluteDeadbandUpdatedSet[ = Boolean]
Parameters
None
ArchiveAbsoluteDeadbanding Property (Tag Object)
Returns or sets whether this tag is using Absolute Deadbanding in the Archiver or not.
Syntax
object.ArchiveAbsoluteDeadbandingSet[ = Boolean]
Parameters
None
ArchiveAbsoluteDeadbanding Property (TagCriteria Object)
Sets the ArchiveAbsoluteDeadbanding to search for in the TagRecordset query.
Syntax
object.ArchiveAbsoluteDeadbandingSet[ = Boolean]
Parameters
None
ArchiveAbsoluteDeadbandSet Property (TagCriteria Object)
A flag to indicate whether this property has been set or not.
Syntax
object.ArchiveAbsoluteDeadbandsetSet[ = Boolean]
Parameters
None
ArchiveAbsoluteDeadbandUpdated Property (Tag Object)
A flag to indicate whether this property has been set or not.
Syntax
object.ArchiveAbsoluteDeadbandupdated[ = Boolean]
Parameters
None
ArchiveAbsoluteDeadbanding Property (Tag Object)
Returns or sets whether this tag is using Absolute Deadbanding in the Archiver or not.
Syntax
object.ArchiveAbsoluteDeadbanding[ = Boolean]
Parameters
None
ArchiveAbsoluteDeadbanding Property (TagCriteria Object)
Sets the ArchiveAbsoluteDeadbanding to search for in the TagRecordset query.
Syntax
object.ArchiveAbsoluteDeadbanding[ = Boolean]
Parameters
None
ArchiveAbsoluteDeadbanding Property (TagFields Object)
Determines whether the ArchiveAbsoluteDeadbanding field should be returned in the TagRecordset query.
Syntax
object.ArchiveAbsoluteDeadbanding[ = Boolean]
Parameters
None
ArchiveAbsoluteDeadbandingSet Property (TagCriteria Object)
A flag to indicate whether this property has been set or not.
Syntax
object.ArchiveAbsoluteDeadbandingSet[ = Boolean]
Parameters
None
ArchiveAbsoluteDeadbandingUpdated Property (Tag Object)
A flag to indicate whether this property has been set or not.
Syntax
object.ArchiveAbsoluteDeadbandingUpdated[ = Boolean]
Parameters
None
ArchiveAllowDataOverwrites Property (Archives Object)
Returns whether or not a Data Archiver should allow overwriting of an existing data.
ArchiveBaseFileName Property (Archives Object)
Returns a default string that an archive file names must be based on.
ArchiveCompression Property (Tag Object)
Returns or sets the archive compression for the Tag. Changes to tag properties are not committed until you call the WriteRecordset method of the TagRecordset object.
Syntax
object.ArchiveCompression[ = Boolean]
Parameters
None
ArchiveCompression Property (TagCriteria Object)
Sets the archive compression value for which the TagRecordset query searches.
Syntax
object.ArchiveCompression[ = Byte]
Parameters
None
ArchiveCompression Property (TagFields Object)
Determines whether the TagRecordset query returns the ArchiveCompression field.
Syntax
object.ArchiveCompression[ = Boolean]
Parameters
None
ArchiveCompressionSet Property (TagCriteria Object)
A flag to indicate whether this property has been set or not.
Syntax
object.ArchiveCompressionSet[ = Boolean]
Parameters
None
ArchiveCompressionTimeout Property (Tag Object)
Gets or sets the value of the Archive Compression Timeout. This is the amount of time after which a value will be written to the archive regardless of compression.
Syntax
object.ArchiveCompressionTimeout[ = Long]
Parameters
None
ArchiveCompressionTimeout Property (TagCriteria Object)
Sets the Archive Compression Timeout value to search for in the TagRecordset query.
Syntax
object.ArchiveCompressionTimeout[ = Long]
Parameters
None
ArchiveCompressionTimeout Property (TagFields Object)
Determines whether the TagRecordset query returns the ArchiveCompressionTimeout field.
Syntax
object.ArchiveCompressionTimeout[ = Boolean]
Parameters
None
ArchiveCompressionTimeoutSet Property (TagCriteria Object)
A flag to indicate whether this property has been set or not.
Syntax
object.ArchiveCompressionTimeoutSet[ = Boolean]
Parameters
None
ArchiveCompressionTimeoutUpdated Property (Tag Object)
A flag to indicate whether this property has been set or not.
Syntax
object.ArchiveCompressionTimeoutUpdated[ = Boolean]
Parameters
None
ArchiveCompressionUpdated Property (Tag Object)
A flag to indicate whether this property has been set or not.
Syntax
object.ArchiveCompressionUpdated[ = Boolean]
Parameters
None
ArchiveCreateOfflineArchives Property (Archives Object)
Returns whether a Data Archiver should accept data before starting an old archive.
ArchiveDeadbandPercentRange Property (Tag Object)
Returns or sets the deadband in percent of engineering unit range for archive compression for the Tag. Changes to tag properties are not committed until you call the WriteRecordset method of the TagRecordset object.
Syntax
object.ArchiveDeadbandPercentRange[ = Single]
Parameters
None
ArchiveDeadbandPercentRange Property (TagCriteria Object)
Sets the archive compression deadband for which the TagRecordset query searches.
Syntax
object.ArchiveDeadbandPercentRange[ = Single]
Parameters
None
ArchiveDeadbandPercentRange Property (TagFields Object)
Determines whether the TagRecordset query returns the ArchiveDeadbandPercentRange field.
Syntax
object.ArchiveDeadbandPercentRange[ = Boolean]
Parameters
None
ArchiveDeadbandPercentRangeSet Property (TagCriteria Object)
A flag to indicate whether this property has been set or not.
Syntax
object.ArchiveDeadbandPercentRangeSet[ = Boolean]
Parameters
None
ArchiveDeadbandPercentRangeUpdated Property (Tag Object)
A flag to indicate whether this property has been set or not.
Syntax
object.ArchiveDeadbandPercentRangeUpdated[ = Boolean]
Parameters
None
ArchiveMaxMemoryBufferSize Property (Archives Object)
Returns memory size of Data Archiver queues.
ArchiveUseClientLoginUser Property (Archives Object)
Returns whether a Data Archiver requires users to enter a user name and password details in the client application.
Remarks
Set to FALSE to require a username and password.
ArchiverClustered Property (Server Object)
A flag to indicate whether this property has been set or not.
Syntax
object.ArchiverClustered
Parameters
None
Remarks
ArchiverClustered is a read-only property of type Boolean.
ArchiverDemoMode Property (Server Object)
Returns whether the server is currently running in demo-license mode. Demo mode is restricted to 100 tags and a single user connection.
Syntax
object.ArchiverDemoMode
Parameters
None
Remarks
ArchiverDemoMode is a read-only property of type Boolean.
Archives Property (Server Object)
Returns the Archives Object for the current server. The Archives Property does not return the Archives Object unless the authenticated user is a member of the Historian archive Administrators group.
Syntax
object.Archives
Parameters
None
Remarks
Archives is a read-only property of type Archives.
Example
Dim MyServer As New iHistorian_SDK.Server
Dim MyArchives As iHistorian_SDK.Archives ' Connect to the local server
If Not MyServer.Connect("", "", "")
Then err.Raise 1, , "Failed to connect to the local server" End If
' We are connected, try to instantiate the Archives object Set MyArchives = MyServer.Archives
If MyArchives Is Nothing Then err.Raise 1, , "User is not able to manage archives" End IfArchiving Property (Archives Object)
Returns the Archiving status of the current archive.
Syntax
object.Archiving[ = Boolean]
Parameters
None
ArchivingOptions Property (Archives Object)
Exposes the ArchivingOptions collection to control the behavior of the Historian Archiver.
The following table describes each of the archiving options:
Option Description
| Option | Description |
|---|---|
| ArchiveSizeIncrement | Sets the size increments of the archive file (Default=100MB). This option is specific to a data store. |
| ArchiveDefaultPath | Specifies the default path that the archives are created in. This option is specific to a data store. |
| ArchiveActiveHours | Specifies the hours before now that the data becomes Read-Only. This option is specific to data store. |
| ArchiveDefaultSize | Specifies the create archive default size in MB. This option is specific to a data store. |
| ArchiveAutomaticCreate | Specifies whether the system automatically creates archives when all empty archives are filled. This option is specific to a data store. |
| ArchiveAutomaticFreeSpace | The amount of free space required on the drive of the default path after creating an archive of default size. This option is specific to a data store. |
| ArchiveOverwriteOld | Determines whether or not old archives are cleared and re-used when no other empty space is available. This option is specific to a data store. |
| ArchiveBackupPath | Specifies the default path for backup archives. This option is specific to a data store. |
| ArchiveBaseName | Specifies the default string archive names should be based on. This option is specific only to a data store. |
| ArchiveBaseFileName | Returns a default string that an archive file names must be based on. This option is specific to a data store. |
| ArchiveCreateOfflineArchives | Returns whether a Data Archiver should accept data before starting an old archive. This option is specific to a data store. |
| ArchiveUseClientLoginUser | Returns whether a Data Archiver requires users to enter a user name and password details in the client application. This option is specific to a data store. |
| ArchiveAllowDataOverwrites | Returns whether or not a Data Archiver should allow overwriting of an existing data. This option is specific to a data store. |
| ArchiveDuration | Number of Units of time an archive can hold. Defined by ArchiveDurationType. This option is specific to a data store. |
| ArchiveTotalDuration | Number of Hours that the archives for a DataStore can span. (This is only meaningful for ScadaBuffer DataStores) This option is specific to a data store. |
| ArchiveDurationType | The type of archive duration.
|
| ArchiveUseCaching | Indicates whether the archive should use caching or not. Set it to 1 to use caching and to 0 if you do not want to use caching. This option is specific to a data store. |
| ArchiveCacheSize | This is for internal use. |
| ArchiverServerMemoryLoad | How much server memory the Historian Data Archive is consuming. This option is specific to the data archiver. |
| ArchiverEquipmentDelimiter | This is for internal use. |
| ArchiverServerMemoryLoad | How much server memory the Historian Data Archive is consuming. This option is specific to the data archiver. |
| ArchiverEquipmentDelimiter | This is for internal use. |
| MessageOnDataUpdate | How much server memory the Historian Data Archive is consuming. This option is specific to the data archiver. |
| ArchiveMaxMemoryBufferSize | The maximum buffer memory (MB). This option is specific to the data archiver. |
| ArchiverTargetPrivateBytes | The memory size of the archiver. If it is 0, it means that it is managed by server. Otherwise, enter a number in megabytes of memory. This option is specific to the data archiver. |
| CollectorIdleTime | The number of seconds before a collector is considered idle. If this number is set to 270 seconds and no data for any tags is received for 270 seconds then the collector is considered idle. This option is specific to the data archiver. |
| MaximumQueryIntervals | Specifies the maximum number of samples per tag that Historian can return from a non-raw data query. Use this setting to throttle query results for non-raw data queries. This setting does not apply to filtered data queries or raw data queries. This option is specific to the data archiver. |
| MaximumQueryTime | Specifies the maximum time that a data or message query can take before it is terminated. Use this setting to limit query time and provide balanced read access to the archiver. This applies to all query types. This option is specific to the data archiver. |
Syntax
object.ArchivingOptions(OptionName) [ = Variant]
Parameters
Name OptionName Data type String Description The name of an archiving option.
Example
MyServer.DataStores.DataStoreUpdate("MYDATASTORE", True, "", "") Then
maintain auto recovery files
MyServer.MaintainAutoRecoveryFiles =TRUEAreaCount Property (OPCBrowse Object)
Returns the number of Areas under a browse position. When a browse operation occurs, the server returns all areas and sources under the BrowsePosition. AreaCount gives you the number of Areas, which you can use to iterate the AreaNames and FullAreaNames arrays.
Syntax
object.AreaCount
Parameters
None
Remarks
AreaCount is a read-only property returned as type Long.
AreaNames Property (OPCBrowse Object)
Returns an area name for an AE server. See FullAreanames property for details.
Syntax
object.AreaNames(Index)
Parameters
Index. Integer. The index into the area nae array
Remarks
AreaNames is a read-only String property returned as a variant for script compatibility.
Areas Property (OPCFilters Object)
Returns a list of the Areas selected for collection. This list is only applied when isAreaFiltering (true) has been called.
Syntax
object.Areas
Parameters
None
AuditMessage Property (Server Object)
Returns or sets the E-signature audit message. Setting the audit message to an empty string will use the system default message.
Syntax
object.AuditMessage[ = String]
Parameters
None
AutoReconnectRateSeconds Property (OPCFilters Object)
If AutoReconnect logic is enabled (isAutoReconnectOn(true)) this property represents the rate in seconds that the Alarm Collector with attempt to determine if the server is still alive.
Syntax
object.AutoReconnectRateSeconds[ = Long]
Parameters
None
B
BrowsePosition Property (OPCBrowse Object)
Returns the current value of the browse position in the hierarchy.
Syntax
object.BrowsePosition[ = Variant]
Parameters
None
Remarks
This is used for subsequent browse calls to get the leaf under the current position.
BrowseRoot Property (OPCBrowse Object)
Returns the root name of the OPC area hierarchy.
Syntax
object.BrowseRoot
Parameters
None
Remarks
BrowseRoot is a read-only property of type String.