ANSI C Based OPC UA Client/Server/PubSub SDK  1.9.1.442
Object Types

HistoryServerCapabilitiesType

Reference NodeClass BrowseName DataType ValueRank TypeDefinition ModellingRule
HasSupertype ObjectType BaseObjectType  
HasProperty Variable AccessHistoryDataCapability Boolean Scalar PropertyType Mandatory
HasProperty Variable AccessHistoryEventsCapability Boolean Scalar PropertyType Mandatory
HasComponent Object AggregateFunctions FolderType Mandatory
HasProperty Variable DeleteAtTimeCapability Boolean Scalar PropertyType Mandatory
HasProperty Variable DeleteEventCapability Boolean Scalar PropertyType Mandatory
HasProperty Variable DeleteRawCapability Boolean Scalar PropertyType Mandatory
HasProperty Variable InsertAnnotationCapability Boolean Scalar PropertyType Mandatory
HasProperty Variable InsertDataCapability Boolean Scalar PropertyType Mandatory
HasProperty Variable InsertEventCapability Boolean Scalar PropertyType Mandatory
HasProperty Variable MaxReturnDataValues UInt32 Scalar PropertyType Mandatory
HasProperty Variable MaxReturnEventValues UInt32 Scalar PropertyType Mandatory
HasProperty Variable ReplaceDataCapability Boolean Scalar PropertyType Mandatory
HasProperty Variable ReplaceEventCapability Boolean Scalar PropertyType Mandatory
HasProperty Variable UpdateDataCapability Boolean Scalar PropertyType Mandatory
HasProperty Variable UpdateEventCapability Boolean Scalar PropertyType Mandatory

The ServerCapabilitiesType objects for any OPC UA Server supporting Historical Access shall contain a Reference to a HistoryServerCapabilitiesType object.

The content of this BaseObjectType is already defined by its type definition in Part 5 of the OPC UA Specification.

The object extensions are intended to inform a Client of the general capabilities of the server. They do not guarantee that all capabilities will be available for all Nodes. For example, not all Nodes will support Events, or in the case of an aggregating server where underlying servers may not support Insert or a particular Aggregate. In such cases, the HistoryServerCapabilities Property would indicate the capability is supported, and the server would return appropriate StatusCodes for situations where the capability does not apply.

All UA servers that support Historical access shall include the HistoryServerCapabilities as part of its ServerCapabilities.

Variable AccessHistoryDataCapability

Defines if the server supports access to historical data values.

A value of True indicates the server supports access to history for HistoricalNodes, a value of False indicates the server does not support access to history for HistoricalNodes. The default value is False. At least one of AccessHistoryDataCapability or AccessHistoryEventsCapability shall have a value of True for the server to be a valid OPC UA Server supporting Historical Access.

Variable AccessHistoryEventsCapability

Defines if the server supports access to historical Events.

A value of True indicates the server supports access to history of Events, a value of False indicates the server does not support access to history of Events. The default value is False. At least one of AccessHistoryDataCapability or AccessHistoryEventsCapability shall have a value of True for the server to be a valid OPC UA Server supporting Historical Access.

Variable InsertDataCapability

Indicates support for the Insert capability.

A value of True indicates the server supports the capability to insert new data values in history, but not overwrite existing values. The default value is False.

Variable ReplaceDataCapability

Indicates support for the Replace capability.

A value of True indicates the server supports the capability to replace existing data values in history, but will not insert new values. The default value is False.

Variable UpdateDataCapability

Indicates support for the Update capability.

A value of True indicates the server supports the capability to insert new data values into history if none exists, and replace values that currently exist. The default value is False.

Variable DeleteRawCapability

Indicates support for the delete raw values capability.

A value of True indicates the server supports the capability to delete raw data values in history. The default value is False.

Variable DeleteAtTimeCapability

Indicates support for the delete raw values capability.

A value of True indicates the server supports the capability to delete raw data values in history. The default value is False.

Object AggregateFunctions

An entry point to browse to all Aggregate capabilities supported by the server for Historical Access.

All HistoryAggregates supported by the Server should be able to be browsed starting from this object. Aggregates are defined in Part 13 of the OPC UA Specification. If the Server does not support Aggregates the Folder is left empty.

Variable MaxReturnDataValues

Defines maximum number of values that can be returned by the server for each HistoricalNode accessed during a request.

A value of 0 indicates that the server forces no limit on the number of values it can return. It is valid for a server to limit the number of returned values and return a continuation point even if MaxReturnValues = 0. For example, it is possible that although the server does not impose any restrictions, the underlying system may impose a limit that the server is not aware of. The default value is 0.

Variable MaxReturnEventValues

Specifies the maximum number of Events that a server can return for a HistoricalEventNode.

A value of 0 indicates that the server forces no limit on the number of values it can return. It is valid for a server to limit the number of returned values and return a continuation point even if MaxReturnValues = 0. For example, it is possible that although the server does not impose any restrictions, the underlying system may impose a limit that the server is not aware of. The default value is 0.

Variable InsertAnnotationCapability

Indicates support for Annotations.

A value of True indicates the server supports the capability to insert Annotations. Some Servers that support Inserting of Annotations will also support editing and deleting of Annotations. The default value is False.

Variable InsertEventCapability

Indicates support for the Insert capability.

A value of True indicates the server supports the capability to insert new Events in history. An insert is not a replace. The default value is False.

Variable ReplaceEventCapability

Indicates support for the Replace capability.

A value of True indicates the server supports the capability to replace existing Events in history. A replace is not an insert. The default value is False.

Variable UpdateEventCapability

Indicates support for the Update capability.

A value of True indicates the server supports the capability to insert new Events into history if none exists, and replace values that currently exist. The default value is False.

Variable DeleteEventCapability

Indicates support for the deletion of Events capability.

A value of True indicates the server supports the capability to delete Events in history. The default value is False.