Proficy Historian Client Access API
Inheritance Hierarchy
In This Topic
    Proficy.Historian.ClientAccess.API Namespace
    In This Topic
    Classes
     ClassDescription
    ClassAlarmAttribute Represents details of the Alarm Attributes Object, these are the Vendor Attributes.
    ClassAlarmCriteria
    ClassAlarmField
    ClassAlarmFields
    ClassAlarmInfo Represents details of the AlarmInfo Object.
    ClassAlarmNotificationInfo Represents details of the AlarmNotification Object.
    ClassAlarmOpenRecordSetInfo
    ClassArchive 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.
    ClassArchiveQueryParams Represents an archive file query.
    ClassArchiveStatistics Represents the set of statistics maintained for Historian archives.
    ClassArrayValue This is the value type for array tags in Historian
    ClassBrowseNode Represents a single node retrieved during a hierarchical tag browse.
    ClassCalculatedQuality 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.
    ClassCalculatedQuery Represents a calculated data query.
    ClassCalculations Represents a collection of calculations consisting of a calculation name and it's implementing source code.
    ClassCCriteriaStringModifier CCriteriaStringModifier - Capable of parsing an input string to sampling modes, calculation modes and query modifiers
    ClassClientMessageContext  
    ClassCollector Represents the configuration and status information for a collector connected to a Historian server.
    ClassCollectorQueryParams Represents a collector query.
    ClassCollectorStatistics Represents the set of statistics maintained for collectors in a Historian server.
    ClassComment Represents an individual comment record stored in a Historian server.
    ClassConnectionProperties 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.

    ClassCurrentValue Represents details of the most recent data value recorded for a tag in a Historian server.
    ClassCurrentValueQuery Represents a current value data query.
    ClassDataCriteria Represents a set of criteria for data queries issued to a Historian server.
    ClassDataQuality 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).
    ClassDataQueryParams Represents a generic data query.
    ClassDataSamples<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.
    ClassDataSamples.DataSamplesEnumerator<T> Supports simple iteration over a DataSamples collection.
    ClassDataSet 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.
    ClassDataStore Represents details of a DataStore.
    ClassDataSubscriptionInfo Represents data subscription configuration details.
    ClassDataValue<T> Represents a single, typed, tag value.
    ClassDetailedValue This class is the individual value contained in the FieldValue.Value
    ClassElementValue This class represents the individual element in ArrayValue.Values list.
    ClassEnumeratedSet Represents details of an Enumerated Set.
    ClassEnumeratedSetState Represents details of an Enumerated Set State.
    ClassEnumeratedSetStateName Represents details of an Enumerated Set State Name.
    ClassField This represents the individual field within the MultiField class.
    ClassFieldValue This class represents FieldValue which is used in MultiFieldValue in the Values property. MultiField.Values of a list of FieldValue.
    ClassFloatCriteria
    ClassHistorianConfiguration Represents the current configuration and status of a Historian server.
    ClassHistorianFault Represents a
    ClassIntegerCriteria
    ClassInterpolatedQuery Represents an interpolated data query.
    ClassItemErrors 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.
    ClassMessage Represents an audit message recorded in a Historian server.
    ClassMessageCriteria Represents a set of criteria for message queries issued to a Historian server.
    ClassMessageQueryParams Represents a message query.
    ClassMultiField This is the definition of the object contained in the UserDefinedType class.
    ClassMultiFieldValue This is the structure of the data written to a tag of type MultiField
    ClassPagedQuery Abstract base class for queries capable of returning large result sets over several smaller responses.
    ClassQueryModifier Represents details of a single supported query modifier.
    ClassRawByNumberQuery Represents a raw-by-number data query.
    ClassRawByTimeQuery Represents a raw-by-time data query.
    ClassServerConnection 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.
    ClassStringCriteria
    ClassTag Represents the configuration for a tag represented in a Historian server.
    ClassTagAlias Repesents information about previous names of a Historian tag.
    ClassTagCriteria Represents a set of criteria for tag queries issued to a Historian server.
    ClassTagParameterInspector  
    ClassTagQueryParams Represents a tag query.
    ClassTimeCriteria
    ClassTracer 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.
    ClassUserDefinedType Class definition for the User Defined type
    ClassVersionHeader  
    ClassVersionHeaderBehavior  
    ClassVersionMessageInspector  
    Interfaces
     InterfaceDescription
    InterfaceIAlarms Defines methods for interacting with Alarms managed by a Historian server.
    InterfaceIArchives Defines methods for interacting with archives managed by a Historian server.
    InterfaceICollectors Defines methods for interacting with collectors managed by a Historian server.
    InterfaceIData Defines methods for interacting with data stored in a Historian server.
    InterfaceIDataQuality Defines methods for manipulating Historian data qualities.
    InterfaceIDataSamples Defines methods for interacting with a collection of data samples irrespective of data type.
    InterfaceIDataStores Defines methods for interacting with Data Stores managed by a Historian server.
    InterfaceIEnumeratedSets Defines methods for interacting with EnumeratedSets managed by a Historian server.
    InterfaceIMessages Defines methods for interacting with messages stored in a Historian server.
    InterfaceIPublish Defines methods for interacting with Historian collector's publishing interface.
    InterfaceIQueryModifiers Defines methods for interacting with QueryModifiers managed by a Historian server.
    InterfaceIServer Defines methods for interacting with the global configuration of a Historian server.
    InterfaceITags Defines methods for interacting with tags defined in a Historian server.
    InterfaceIUserDefinedTypes Defines methods for interacting with the User Defined Types managed by a Historian server.
    Delegates
     DelegateDescription
    DelegateAlarmBackupResponseHandler A delegate invoked for Alarm/Events Backup Response.
    DelegateAlarmQueryResponseHandler A delegate invoked for Alarm/Events Query Response.
    DelegateArchiveChangedHandler A delegate invoked for archive subscriptions.
    DelegateCollectorBrowseResponseHandler A delegate invoked for collector tag browse responses.
    DelegateCollectorChangedHandler A delegate invoked for collector subscriptions.
    DelegateCollectorControlResponseHandler A delegate invoked for collector control responses.
    DelegateCollectorCurrentValueResponseHandler A delegate invoked for current collector tag value responses.
    DelegateCollectorHierarchicalBrowseResponseHandler A delegate invoked for collector hierarchical tag browse responses.
    DelegateCustomDataTypeChangedHandler A delegate invoked for custom data type subscriptions.
    DelegateDataChangedHandler A delegate invoked for data subscriptions.
    DelegateEnumeratedSetChangedHandler A delegate invoked for enumerated set subscriptions.
    DelegateMessageAddedHandler A delegate invoked for message subscriptions.
    DelegatePublishAddTagHandler A delegate invoked for responses to adding tags for publishing.
    DelegatePublishGetDestinationServerHandler A delegate invoked for responses to retrieving the destination server name for publishing.
    DelegatePublishGetTagPropertiesHandler A delegate invoked for responses to retrieving a list of published tags.
    DelegatePublishRemoveTagHandler A delegate invoked for responses to removing tags from publishing.
    DelegatePublishSetDestinationServerHandler A delegate invoked for responses to configuring a destination server name for publishing.
    DelegatePublishSetTagPropertiesHandler A delegate invoked for responses to configuring a published tag.
    DelegateTagChangedHandler A delegate invoked for tag subscriptions.
    Enumerations
     EnumerationDescription
    EnumerationAlarmType Represents details of the Alarm Types supported.
    EnumerationArchive.ArchiveDurationTypes Represents all possible archive data storage duration types.
    EnumerationArchive.ArchiveStatusType Represents all possible Historian archive statuses.
    EnumerationCCriteriaStringModifier.QueryModifiers  
    EnumerationCertificateValidationMode The possible ways of validating a server certificate.
    EnumerationChangeType Represents the possible types of changes communicated via subscriptions.
    EnumerationCollector.Categories Represents available categories for selecting a set of collector properties to retrieve from a Historian server.
    EnumerationCollector.Property Uniquely identifies Historian collector properties.
    EnumerationCollector.StatusType Represents the defined collector statuses.
    EnumerationCollector.Types Represents the defined collector types.
    EnumerationDataCriteria.CalculationModeType Represents the supported calculation modes.
    EnumerationDataCriteria.FilterComparisonModeType Represents the supported filter comparison modes.
    EnumerationDataCriteria.FilterModeType Represents the supported filter modes.
    EnumerationDataCriteria.IntervalTypes  
    EnumerationDataCriteria.SamplingModeType Represents the supported data sampling modes.
    EnumerationDataFields Represents all available Historian data fields.
    EnumerationDataQuality.StatusType Represents the high level quality status: good, bad or uncertain.
    EnumerationDataQuality.SubstatusType Represents additional sub-status information for DataQuality.StatusType.Bad quality.
    EnumerationDataStore.DataStorageType Represents all possible Historian data storage types.
    EnumerationDataStore.DataStoreState Represents all possible states of a data store.
    EnumerationHistorianConfiguration.HistorianType Represents all possible Historian Product Types.
    EnumerationHistorianConfiguration.LicensedFeatures Explicitly licensed server features.
    EnumerationHistorianGroupMembership Represents membership in pre-defined Historian security groups. User access rights are dependent on group membership.
    EnumerationHistorianOption Represents all supported Historian server options.
    EnumerationMessage.MessageTopic Represents all available Historian message topics.
    EnumerationMessageCriteria.PropertyFields Represents the list of optionally selectable message properties.
    EnumerationQualityStatus Represents details of the QualityStatus supported.
    EnumerationStatus Historian error status codes.
    EnumerationTag.Categories Represents available categories for selecting a set of tag properties to retrieve from a Historian server.
    EnumerationTag.ConditionCollectionComparisonType Represents all supported comparison operators for evaluating condition-based collection.
    EnumerationTag.DataCollectionType Represents all supported data collection modes.
    EnumerationTag.DataDensityType
    EnumerationTag.NativeDataType Native Historian tag data types. These are a subset of .NET built-in types.
    EnumerationTag.Property Uniquely identifies Historian tag properties.
    EnumerationTag.TagCalcType This is the enumerated list of calctype that we currently support. AnalyticTag is for CSense Analytic tag. all other tags are RawTag.
    EnumerationTag.TimeResolutionType Represents available timestamp resolutions for tag values recorded in a Historian server.
    EnumerationTag.TimeStampDeterminedByType Represents how times are obtained for tag values.
    EnumerationTagCriteria.Criteria Uniquely identifies Historian tag criteria.
    See Also

    Reference

    Proficy.Historian.ClientAccess.API Assembly