Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

Historian SDK

TABLE OF CONTENTS

HistorianConnectionArgs Class Members

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL

The following tables list the members exposed by HistorianConnectionArgs.

Public Constructors

 NameDescription
Public ConstructorHistorianConnectionArgs ConstructorOverloaded.   
Top

Public Properties

 NameDescription
Public PropertyAllowUnTrustedConnectionGets or sets whether to check for certificate while connecting to Historian.  
Public PropertyAuthenticationModeGets or sets the Historian Authentication using Single Sign On.  
Public PropertyBandwidthLimitGets or sets the maximum network bandwidth, in Kbps, that the Historian Client Access Layer is allowed to consume for this connection.  
Public PropertyBufferMemoryGets or sets the size of the data buffer, in MB, that Historian Client Access Layer can use for buffering streamed data before it is sent to the server or the store-and-forward cache.  
Public PropertyCompressionGets or sets whether data packets should be compressed during communication with the Historian Server.  
Public PropertyConnectionModeGets or sets whether GRPC connection to the Historian Server.  
Public PropertyConnectionTypeGets or sets the type of the Historian connection, either process or event.  
Public PropertyConsoleAccessGets or sets whether console access to the Historian Server is requested.  
Public PropertyDetailsInternal use only.  
Public PropertyHighLatencyNetworkGets or sets whether network connection to the Historian Server has high latency.  
Public PropertyIntegratedSecurityGets or sets whether to use current process's credentials for the connection. If set to True, the authentication token of the thread making the OpenConnection() call is used for connecting to the historian. If the authentication token has no access to the historian, then the OpenConnection() call fails.  
Public PropertyMinStoreForwardDurationGets or sets the amount of time, in seconds, that the Historian Client Access Layer should remain in store-and-forward mode before it attempts to reconnect to the Historian Server.  
Public PropertyPacketTimeoutGets or sets the amount of time, in milliseconds, that a data packet is held open for additional values before the packet is sent to the Historian Server.  
Public PropertyPasswordGets or sets the password for connecting to the Historian Server.  
Public PropertyProxyServerGets or sets proxy server - e.g. "http://104.129.204.40:9480"  
Public PropertyReadOnlyGets or sets whether read-only access to the Historian Server is requested.  
Public PropertySecurePasswordGets or sets the password for connecting to the Historian Server.  
Public PropertySecurityInfoGets or sets the security mode used to connect to the historian.  
Public PropertyServerNameGets or sets the network name of the AVEVA Historian Server.  
Public PropertyStoreForwardFreeDiskSpaceGets or sets the amount of disk space, in MB, that must be remaining on the disk before the Historian Client Access Layer stops accepting new values.  
Public PropertyStoreForwardPathGets or sets the path where the store-and-forward data is locally stored. In the case of an event connection, an event folder will be automatically added to the existing path, thus creating separate store-and-forward folders from process and event data.  
Public PropertyTcpPortGets or sets the TCP port of the Historian Client Access Point.  
Public PropertyUseArchestrAUserGets or sets whether to use ArchestrA user credentials if this option has been configured on the system.  
Public PropertyUserNameGets or sets the username for connecting to the Historian Server.  
Top

Public Methods

 NameDescription
Public MethodCopyCreates a copy.  
Top

See Also

Reference

HistorianConnectionArgs Class
ArchestrA Namespace

In This Topic