Proficy.Historian.ClientAccess.API Namespace

	Class	Description
	AlarmAttribute	Represents details of the Alarm Attributes Object, these are the Vendor Attributes.
	AlarmCriteria
	AlarmField
	AlarmFields
	AlarmInfo	Represents details of the AlarmInfo Object.
	AlarmNotificationInfo	Represents details of the AlarmNotification Object.
	AlarmOpenRecordSetInfo
	Archive	Represents details of individual archive files in a Historian server. Archives are multi-megabyte files containing data between well defined start and end times. A constraint of the server does not allow two or more archives to exist with overlapping start or end times.
	ArchiveQueryParams	Represents an archive file query.
	ArchiveStatistics	Represents the set of statistics maintained for Historian archives.
	ArrayValue	This is the value type for array tags in Historian
	BrowseNode	Represents a single node retrieved during a hierarchical tag browse.
	CalculatedQuality	Represents a computed quality value derived from raw qualities recorded in a Historian server. Calculated quality is a percent value with 100% equivalent to good quality and 0% equivalent to bad quality.
	CalculatedQuery	Represents a calculated data query.
	Calculations	Represents a collection of calculations consisting of a calculation name and it's implementing source code.
	CCriteriaStringModifier	CCriteriaStringModifier - Capable of parsing an input string to sampling modes, calculation modes and query modifiers
	ClientMessageContext
	Collector	Represents the configuration and status information for a collector connected to a Historian server.
	CollectorQueryParams	Represents a collector query.
	CollectorStatistics	Represents the set of statistics maintained for collectors in a Historian server.
	Comment	Represents an individual comment record stored in a Historian server.
	ConnectionProperties	Encapsulates properties for a single Historian server connection. A client and target Historian server must share compatible connection property values. For exmample, a server will reject messages bigger than it's own MaxReceivedMessageSize. In order to configure server parameters create an app.config file matching the server EXE name. For a 64-bit Historian DataArchiver, create a file named "ihDataArchiver_x64.exe.config" in the same location as the EXE. A server restart is required to apply app.config settings. To configure MaxReceivedMessageSize=1MB, MaxItemsInObjectGraph=100K and OpenTimeout=5 minutes, add the following contents to "ihDataArchiver_x64.exe.config": `<configuration> <appSettings> <add key="MaxReceivedMessageSize" value="10485760"/> <add key="MaxItemsInObjectGraph" value="100000"/> <add key="OpenTimeout" value="0:5"/> </appSettings> </configuration>` Similarily, other connection properties can be configured via a server's app.config.
	CurrentValue	Represents details of the most recent data value recorded for a tag in a Historian server.
	CurrentValueQuery	Represents a current value data query.
	DataCriteria	Represents a set of criteria for data queries issued to a Historian server.
	DataQuality	Represents the actual data quality recorded with data samples in a Historian server. A data quality value includes an indication of overall data "goodness" along with substatus information, internal storage flags and optional custom user status bits (aka OPC quality).
	DataQueryParams	Represents a generic data query.
	DataSamples<T>	Represents a typed collection of data samples for exchange with a Historian server. Depending on the selected data fields, these may include one or more of: values, times, qualities and comment records.
	DataSamples.DataSamplesEnumerator<T>	Supports simple iteration over a DataSamples collection.
	DataSet	Represents a set of data samples corresponding to one or more Historian tags. Data samples in the set are keyed by tag name. Tags in a data set may only have one set of data samples of uniform data type.
	DataStore	Represents details of a DataStore.
	DataSubscriptionInfo	Represents data subscription configuration details.
	DataValue<T>	Represents a single, typed, tag value.
	DetailedValue	This class is the individual value contained in the FieldValue.Value
	ElementValue	This class represents the individual element in ArrayValue.Values list.
	EnumeratedSet	Represents details of an Enumerated Set.
	EnumeratedSetState	Represents details of an Enumerated Set State.
	EnumeratedSetStateName	Represents details of an Enumerated Set State Name.
	Field	This represents the individual field within the MultiField class.
	FieldValue	This class represents FieldValue which is used in MultiFieldValue in the Values property. MultiField.Values of a list of FieldValue.
	FloatCriteria
	HistorianConfiguration	Represents the current configuration and status of a Historian server.
	HistorianFault	Represents a
	IntegerCriteria
	InterpolatedQuery	Represents an interpolated data query.
	ItemErrors	Represents a collection of individual tag status errors resulting from a data add, delete or query of a Historian server. Errors are keyed by tag name or optionally by tag name and data sample index for data add.
	Message	Represents an audit message recorded in a Historian server.
	MessageCriteria	Represents a set of criteria for message queries issued to a Historian server.
	MessageQueryParams	Represents a message query.
	MultiField	This is the definition of the object contained in the UserDefinedType class.
	MultiFieldValue	This is the structure of the data written to a tag of type MultiField
	PagedQuery	Abstract base class for queries capable of returning large result sets over several smaller responses.
	QueryModifier	Represents details of a single supported query modifier.
	RawByNumberQuery	Represents a raw-by-number data query.
	RawByTimeQuery	Represents a raw-by-time data query.
	ServerConnection	Encapsulates a client connection to a Historian server. Provides methods for interacting with a server for query, creation, configuration and maintenance of: data, tags, messages, collectors and archive files.
	StringCriteria
	Tag	Represents the configuration for a tag represented in a Historian server.
	TagAlias	Repesents information about previous names of a Historian tag.
	TagCriteria	Represents a set of criteria for tag queries issued to a Historian server.
	TagParameterInspector
	TagQueryParams	Represents a tag query.
	TimeCriteria
	Tracer	Encapsulates the built-in System.Diagnostic.Trace class with functionality for logging individual trace messages to log file or console. Detail level may be configured as Error, Warning, Info, Verbose or Off.
	UserDefinedType	Class definition for the User Defined type
	VersionHeader
	VersionHeaderBehavior
	VersionMessageInspector

	Interface	Description
	IArchives	Defines methods for interacting with archives managed by a Historian server.
	ICollectors	Defines methods for interacting with collectors managed by a Historian server.
	IData	Defines methods for interacting with data stored in a Historian server.
	IDataQuality	Defines methods for manipulating Historian data qualities.
	IDataSamples	Defines methods for interacting with a collection of data samples irrespective of data type.
	IDataStores	Defines methods for interacting with Data Stores managed by a Historian server.
	IEnumeratedSets	Defines methods for interacting with EnumeratedSets managed by a Historian server.
	IMessages	Defines methods for interacting with messages stored in a Historian server.
	IPublish	Defines methods for interacting with Historian collector's publishing interface.
	IQueryModifiers	Defines methods for interacting with QueryModifiers managed by a Historian server.
	IServer	Defines methods for interacting with the global configuration of a Historian server.
	ITags	Defines methods for interacting with tags defined in a Historian server.
	IUserDefinedTypes	Defines methods for interacting with the User Defined Types managed by a Historian server.

	Delegate	Description
	AlarmBackupResponseHandler	A delegate invoked for Alarm/Events Backup Response.
	AlarmQueryResponseHandler	A delegate invoked for Alarm/Events Query Response.
	ArchiveChangedHandler	A delegate invoked for archive subscriptions.
	CollectorBrowseResponseHandler	A delegate invoked for collector tag browse responses.
	CollectorChangedHandler	A delegate invoked for collector subscriptions.
	CollectorControlResponseHandler	A delegate invoked for collector control responses.
	CollectorCurrentValueResponseHandler	A delegate invoked for current collector tag value responses.
	CollectorHierarchicalBrowseResponseHandler	A delegate invoked for collector hierarchical tag browse responses.
	CustomDataTypeChangedHandler	A delegate invoked for custom data type subscriptions.
	DataChangedHandler	A delegate invoked for data subscriptions.
	EnumeratedSetChangedHandler	A delegate invoked for enumerated set subscriptions.
	MessageAddedHandler	A delegate invoked for message subscriptions.
	PublishAddTagHandler	A delegate invoked for responses to adding tags for publishing.
	PublishGetDestinationServerHandler	A delegate invoked for responses to retrieving the destination server name for publishing.
	PublishGetTagPropertiesHandler	A delegate invoked for responses to retrieving a list of published tags.
	PublishRemoveTagHandler	A delegate invoked for responses to removing tags from publishing.
	PublishSetDestinationServerHandler	A delegate invoked for responses to configuring a destination server name for publishing.
	PublishSetTagPropertiesHandler	A delegate invoked for responses to configuring a published tag.
	TagChangedHandler	A delegate invoked for tag subscriptions.

	Enumeration	Description
	AlarmType	Represents details of the Alarm Types supported.
	Archive.ArchiveDurationTypes	Represents all possible archive data storage duration types.
	Archive.ArchiveStatusType	Represents all possible Historian archive statuses.
	CertificateValidationMode	The possible ways of validating a server certificate.
	ChangeType	Represents the possible types of changes communicated via subscriptions.
	Collector.Categories	Represents available categories for selecting a set of collector properties to retrieve from a Historian server.
	Collector.Property	Uniquely identifies Historian collector properties.
	Collector.StatusType	Represents the defined collector statuses.
	Collector.Types	Represents the defined collector types.
	DataCriteria.CalculationModeType	Represents the supported calculation modes.
	DataCriteria.FilterComparisonModeType	Represents the supported filter comparison modes.
	DataCriteria.FilterModeType	Represents the supported filter modes.
	DataCriteria.IntervalTypes
	DataCriteria.SamplingModeType	Represents the supported data sampling modes.
	DataFields	Represents all available Historian data fields.
	DataQuality.StatusType	Represents the high level quality status: good, bad or uncertain.
	DataQuality.SubstatusType	Represents additional sub-status information for DataQuality.StatusType.Bad quality.
	DataStore.DataStorageType	Represents all possible Historian data storage types.
	DataStore.DataStoreState	Represents all possible states of a data store.
	HistorianConfiguration.HistorianType	Represents all possible Historian Product Types.
	HistorianConfiguration.LicensedFeatures	Explicitly licensed server features.
	HistorianGroupMembership	Represents membership in pre-defined Historian security groups. User access rights are dependent on group membership.
	HistorianOption	Represents all supported Historian server options.
	Message.MessageTopic	Represents all available Historian message topics.
	MessageCriteria.PropertyFields	Represents the list of optionally selectable message properties.
	QualityStatus	Represents details of the QualityStatus supported.
	Status	Historian error status codes.
	Tag.Categories	Represents available categories for selecting a set of tag properties to retrieve from a Historian server.
	Tag.ConditionCollectionComparisonType	Represents all supported comparison operators for evaluating condition-based collection.
	Tag.DataCollectionType	Represents all supported data collection modes.
	Tag.DataDensityType
	Tag.NativeDataType	Native Historian tag data types. These are a subset of .NET built-in types.
	Tag.Property	Uniquely identifies Historian tag properties.
	Tag.TagCalcType	This is the enumerated list of calctype that we currently support. AnalyticTag is for CSense Analytic tag. all other tags are RawTag.
	Tag.TimeResolutionType	Represents available timestamp resolutions for tag values recorded in a Historian server.
	Tag.TimeStampDeterminedByType	Represents how times are obtained for tag values.
	TagCriteria.Criteria	Uniquely identifies Historian tag criteria.

Reference

Proficy.Historian.ClientAccess.API Assembly