Proficy Historian Client Access API
Proficy.Historian.ClientAccess.API Namespace / Collector Class
Properties Methods


In This Topic
    Collector Class Members
    In This Topic

    The following tables list the members exposed by Collector.

    Public Constructors
     NameDescription
    Public ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public Property Whether a collector supports browsing point information in a data source. Browsing enumerates the available data points for optional collection in a Historian server.  
    Public Property Whether data sample times in addition to values are available from a data source.  
    Public Property An optional delay in data collection from initial collector startup, expressed in seconds.  
    Public Property An optional collector comment.  
    Public Property A name of the computer hosting a collector.  
    Public Property Whether extra data queuing is enabled in a collector to support collector redundancy.  
    Public Property An absolute collector compression deadband value applied to newly added collector tags.  
    Public Property Whether collector compression is expressed as an absolute value (true) or percent of engineering units for newly added collector tags.  
    Public Property A collection interval, expressed in milliseconds, applied to newly added collector tags.  
    Public Property A collection type applied to newly added collector tags.  
    Public Property Whether to enable collector compression for newly tags added to a collector.  
    Public Property A collector compression deadband value applied to newly added collector tags.  
    Public Property A collector compression timeout value applied to newly added collector tags.  
    Public Property Whether to enable load balancing for newly added collector tags  
    Public Property A spike interval value applied to newly added collector tags.  
    Public Property Whether to enable spike logic for newly added collector tags.  
    Public Property A spike multiplier value applied to newly added collector tags.  
    Public Property A prefix string applied to newly added collector tags.  
    Public Property A timestamp type applied to newly added collector tags.  
    Public Property An optional collector description.  
    Public Property Whether collector configuration changes require a collector restart to apply (true) or are applied while collector is running (false).  
    Public Property The first generic configuration property - purpose depends on collector type.  
    Public Property A second generic configuration property - purpose depends on collector type.  
    Public Property A third generic configuration property - purpose depends on collector type.  
    Public Property The fourth generic configuration property - purpose depends on collector type.  
    Public Property The fifth generic configuration property - purpose depends on collector type.  
    Public Property A data source address that receives a periodic heartbeat signal from a collector. If configured, a collector will write a value of 1 to this address every 60s.  
    Public Property The time when the collector's configuration was last modified.  
    Public Property The name of the user who last modified the collector's configuration.  
    Public Property An amount of memory, expressed in MB, to allocated for store-and-foward buffering.  
    Public Property An amount of free disk space, expressed in MB, to reserve on a host computer. Constrains store-and-forward buffering so all available disk space is not exhausted.  
    Public Property A collector name. Collector names are unique within a single Historian server.  
    Public Property A data source address that receives periodic rate information from a collector. If configured, a collector will write the current collector status value to this address.  
    Public Property Whether to enable collector redundancy for a collector.  
    Public Property Whether automatic failover occurs based on value quality of a watchdog tag in a collector redundancy configuration. When true, a Historian server will initiate failover to a backup collector if the latest received watchdog tag value has quality equal to DataQuality.StatusType.Bad.  
    Public Property Whether automatic failover occurs based on collector status in a collector redundancy configuration. When true, a Historian server will initiate failover to a backup collector if the status of the currently active collector changes from StatusType.Running.  
    Public Property Whether automatic failover occurs based on value of a watchdog tag in a collector redundancy configuration. When true, a Historian server will initiate failover to a backup collector if the latest received watchdog tag value is non-zero (RedundancyFailoverValueChangeType=false) or unchanged for a period of time (RedundancyFailoverValueChangeType=true).  
    Public Property Whether to monitor a watchdog tag value for non-zero values (false) or absence of change (true).  
    Public Property Whether this is the active collector for purposes of data collection in a collector redundancy configuration.  
    Public Property A name of the collector backed up in a collector redundancy configuration. A collector will be next to become active for purposes of data collection should the system failover it's principal collector.  
    Public Property The maximum number of seconds a watchdog tag value can remain unchanged before failover is initiated.  
    Public Property A collector tag name to control automatic failover in a collector redundancy configuration. Depending on other redundancy properties, the watchdog tag value and/or quality are monitored by a Historian server to gauge the health of the currently active collector.  
    Public Property Whether to adjust data sample times with a Historian server to account for local PC clock drift.  
    Public Property Whether data samples are queued and written as a single batch-write to a Historian server. Queuing data writes more efficiently utilizes network resources at a cost of latency in how promptly current data values are recorded in a server.  
    Public Property Whether data source times are expressed in local time.  
    Public Property An operational status of a collector.  
    Public Property A data source address that receives periodic status information from a collector. If configured, a collector will write the current events-per-minute value to this address.  
    Public Property A collector classification.  
    Public Property  
    Top
    Public Methods
     NameDescription
    Public Method Assign all properties from a source collector.  
    Public Method Converts the value of this instance to a System.String.  
    Top
    See Also