| Name | Description | |
|---|---|---|
 | Add | Add a collector-entry to a Historian server. Collectors are indentified by a unique name within a Historian server. Note, adding a new collector simply creates a collector record in a Historian server - it does not install, configure and start the remote software implementing a Historian collector. |
| Browse | Initiate a tag browse in a collector via a Historian server. |
| Delete | Delete a collector from a Historian server. |
| DropSubscriptions | Drop all previously established collector subscriptions. |
| Get | Retrieve collector properties for a collector matching the given name from a Historian server. |
| GetCurrentValue | Initiate a request for current values from a collector via a Historian server. |
| GetStatistics | Retrieve statistics for a collector from a Historian server. |
| GetTagsLastModifiedTime | Retrieve the last modification time of tags associated with a collector in a Historian server, expressed in UTC. |
| HierarchicalBrowse | Initiate a hierarchical tag browse in a collector via a Historian server. |
| InitiateFailover | Trigger a manual collector failover in a collector redundancy configuration via a Historian server. After failover a backup collector will take-over data collection for the currently active collector. |
| Query | Retrieve a list of collectors in a Historian server matching a collector-name wildcard expression.
For large servers clients can optionally rely on large message sizes or result-paging or a combination of both to retrieve properties for a large number of collectors. Maximum message size is straight-forward and controlled by ConnectionProperties.MaxReceivedMessageSize - it must be matched on both client and server. Result-paging enables large result sets to be retrieved across multiple server requests with timing and size controlled by the client. The number of results retrieved per request is controlled via the query's PageSize property. To utilize result-paging, specify a non-zero PageSize and continue calling the same query while the return code is true to retrieve all results from a server. To protect the server and limit excessive server-memory utilization initiating a second query without first retrieving all results for a first query generates a fault. |
| Reload | Initiate a reload of a Historian collector which causes one or more tags to be re-calculated for a specific time interval. Only supported by ServerToServer and Calculation collectors. |
| Set | Apply the supplied collector properties to a Historian server. Collectors are uniquely identified by name within a server. |
| SetStatistics | Apply statistics for a collector in a Historian server. |
| Start | Request a collector start data collection via a Historian server. This method cannot start the Windows service implementing a collector - the service must be actively running to receive a stop command. |
| Stop | Request a collector stop data collection via a Historian server. This method cannot start the Windows service implementing a collector - the service must be actively running to receive a stop command. |
| Subscribe | Subscribe to collector changes for a specific collector. Fires with details of the collector change. |
| Unsubscribe | Unsubscribe to collector changes for a specific collector. |
| UnsubscribeAny | Unsubscribe to collector changes for any collector. |
Proficy Historian Client Access API
