F O U N D A T I O N

OPC Unified Architecture

Specification
Part 8: Data Access
Version 1.00
September 25, 2006

OPC Unified Architecture, Part 8

iii

Release 1.00

CONTENTS
Page

FOREWORD.........................................................................................................................v
AGREEMENT OF USE ..........................................................................................................v
1

Scope............................................................................................................................ 1

Reference documents .................................................................................................... 1

Terms, definitions, and abbreviations ............................................................................. 1

3.1
3.2
3.3
3.4

OPC UA Part 1 terms ............................................................................................

OPC UA Part 3 terms ............................................................................................
OPC UA Part 4 terms ............................................................................................
OPC UA Data Access terms ..................................................................................
3.4.1 DataItem ...................................................................................................
3.4.2 AnalogItem ...............................................................................................
3.4.3 DiscreteItem .............................................................................................
3.4.4 EngineeringUnits.......................................................................................
3.5 Abbreviations and symbols ...................................................................................
Concepts .......................................................................................................................

1
1
1
2
2
2
2
2
2
3

Model ............................................................................................................................ 4
5.1
5.2

General ................................................................................................................ 4
Variable Types ..................................................................................................... 4
5.2.1 Optional New ModellingRule for DataAccess Properties........................... 4
5.2.2 DataItemType ........................................................................................... 4
5.2.3 AnalogItemType ........................................................................................ 5
5.2.4 DiscreteItemType ...................................................................................... 6
5.3 Address Space Model ........................................................................................... 8
5.4 Attributes of DataItems ......................................................................................... 8
5.5 Property DataTypes .............................................................................................. 9
5.5.1 Overview .................................................................................................. 9
5.5.2 Range....................................................................................................... 9
5.5.3 EUInformation ..........................................................................................10
Data Access specific usage of Services ........................................................................11
6.1
6.2

PercentDeadband ................................................................................................11
Data Access Status Codes ...................................................................................11
6.2.1 Overview .................................................................................................11
6.2.2 Operation level result codes .....................................................................11
6.2.3 LimitBits...................................................................................................12
6.2.4 SemanticsChanged ..................................................................................13

OPC Unified Architecture, Part 8

Release 1.00

1 Scope
This specification is part of the overall OPC Unified Architecture specification series and
defines the information model associated with Data Access (DA). It particularly includes
additional VariableTypes and complemental descriptions of the NodeClasses and Attributes
needed for Data Access, additional standard Properties and other information and behavior.
The complete address space model, including all NodeClasses and Attributes, is specified in
[UA Part 3]. The services to detect and access data are specified in [UA Part 4].

2 Reference documents
[UA Part 1]

OPC UA Specification: Part 1 Concepts, Version 1.0 or later

http://www.opcfoundation.org/UA/Part1/
[UA Part 3]

OPC UA Specification: Part 3 Address Space Model, Version 1.0 or later

http://www.opcfoundation.org/UA/Part3/
[UA Part 4]

OPC UA Specification: Part 4 Sevices, Version 1.0 or later

http://www.opcfoundation.org/UA/Part4/
[UA Part 5]

OPC UA Specification: Part 5 Information Model, Version 1.0 or later

http://www.opcfoundation.org/UA/Part5/

3 Terms, definitions, and abbreviations

3.1 OPC UA Part 1 terms
The following terms defined in [UA Part 1] apply.

AddressSpace

Node

NodeClass

Reference

Subscription

View

3.2 OPC UA Part 3 terms

The following terms defined in [UA Part 3] apply.

DataVariable

Object

Property

Variable

VariableType

3.3 OPC UA Part 4 terms

The following terms defined in [UA Part 4] apply.

Deadband

OPC Unified Architecture, Part 8

Release 1.00

3.4 OPC UA Data Access terms

3.4.1

DataItem

A DataItem represents a link to arbitrary, live automation data, i.e. data that represents
currently valid information. Examples of such data are
device data (such as temperature sensors)
calculated data
status information (open/closed, moving)
dynamically-changing system data (such as stock quotes)
diagnostic data
3.4.2

AnalogItem

AnalogItems are DataItems that represent continuously-variable physical quantities. Typical

examples are the values provided by temperature sensors or pressure sensors. OPC UA
defines a specific VariableType to identify an AnalogItem. Properties describe the possible
ranges of AnalogItems.
3.4.3

DiscreteItem

DiscreteItems are DataItems that represent data that may take on only a certain number of
possible values. Specific VariableTypes are used to identify DiscreteItems with two states or
with multiple states. Properties specify the string values for these states.
3.4.4

EngineeringUnits

AnalogItems represent continuously-variable physical quantities (e.g., length, mass, time,

temperature) as integer or floating point values. EngineeringUnits specify the units of
measurement for these quantities. This specification defines Properties to inform about the
unit used for the DataItem value and about the highest and lowest value likely to be obtained
in normal operation.

3.5 Abbreviations and symbols

DA
EU
UA

Data Access
Engineering Unit
Unified Architecture

OPC Unified Architecture, Part 8

Release 1.00

Concepts

Data Access deals with the representation and use of automation data in OPC UA Servers.
Automation data can be located inside the UA Server or on I/O cards directly connected to the
UA Server. It can also be located in sub-servers or on other devices such as controllers and
input/output modules, connected by serial links via field buses or other communication links.
UA Data Access Servers provide one or more UA Data Access Clients with transparent
access to their automation data.
The links to automation data instances are called DataItems. Which categories of automation
data are provided is completely vendor-specific. Figure 1 illustrates how the AddressSpace of
a UA server might consist of a broad range of different DataItems.

OPC UA Server

Root

Addressspace
with data items

Figure 1 OPC DataItems are linked to automation data

Clients may read or write DataItems, or monitor them for value changes. The services needed
for these operations are specified in [UA Part 4]. Changes are defined as a change in status
(quality) or a change in value that exceeds a client-defined range called a Deadband. To
detect the value change, the difference between the current value and the last reported value
is compared to the Deadband.

OPC Unified Architecture, Part 8

Release 1.00

5 Model
5.1 General
The DataAccess model extends the variable model by defining VariableTypes. The
DataItemType is the base type. AnalogType and DiscreteType (and its TwoState and
MultiState subtypes) are specializations. Each of these VariableTypes can be further
extended to form domain or server specific DataItems.

Figure 2 DataItem VariableType Hierarchy

5.2 Variable Types

5.2.1

Optional New ModellingRule for DataAccess Properties

ModellingRules are an extendable concept in OPC UA; [UA Part 3] defines the rules None,
Shared and New. Some DataAccess properties, however, are optional and this part
therefore defines the OptionalNew ModellingRule.
OptionalNew indicates that the Node referenced by a TypeDefinitionNode is optional, but
when needed, the ModellingRule New is applied (see [UA Part 3]). This ModellingRule applies
only to Variables referenced with a HasProperty Reference.
5.2.2 DataItemType
This VariableType defines the general characteristics of a DataItem. All other DataItem Types
derive from it. The DataItemType derives from the BaseVariableType and therefore shares the
variable model as described in [UA Part 3] and [UA Part 5]. It is formally defined in Table 1.

OPC Unified Architecture, Part 8

Release 1.00

Table 1 DataItemType Definition

Attribute
Value
BrowseName
DataItemType
IsAbstract
False
References
NodeClass
BrowseName
DataType
Inherit the Properties of the BaseVariableType defined in [UA Part 5]
HasSubtype
VariableType
AnalogItemType
Defined in Clause 5.2.3
HasSubtype
VariableType
DiscreteItemType
Defined in Clause 5.2.4

TypeDefinition

ModellingRule

HasProperty
HasProperty

PropertyType
PropertyType

Optional New
Optional New

Variable
Variable

Definition
ValuePrecision

String
Double

Definition is a vendor-specific, human readable string that specifies how the value of this DataItem is
calculated. Definition is non-localized and will often contain an equation that can be parsed by certain
clients.
Example:
Definition ::= (TempA 25) + TempB

ValuePrecision specifies the maximum precision that the server can maintain for the item
based on restrictions in the target environment.
ValuePrecision can be used for the following DataTypes:
For Float and Double values it specifies the number of digits after the decimal place.

For DateTime values it indicates the minimum time difference in nanoseconds. E.g., a
ValuePrecision of 20.000.000 defines a precision of 20 milliseconds.

The ValuePrecision property is an approximation that is intended to provide guidance to a

client. A server is expected to silently round any value with more precision that it supports.
This implies that a client may encounter cases where the value read back from a server differs
from the value that it wrote to the server. This difference must be no more than the difference
suggested by this property.

5.2.3 AnalogItemType
This VariableType defines the general characteristics of an AnalogItem. All other AnalogItem
Types derive from it. The AnalogItemType derives from the DataItemType. It is formally
defined in Table 2.
Table 2 AnalogItemType Definition
Attribute
Value
BrowseName
AnalogItemType
IsAbstract
False
References
NodeClass
BrowseName
Inherit the Properties of the DataItemType defined in Clause 5.2.2
HasProperty
Variable
InstrumentRange
HasProperty
Variable
EURange
HasProperty
Variable
EngineeringUnits

DataType

TypeDefinition

ModellingRule

Range
Range
EUInformation

PropertyType
PropertyType
PropertyType

OptionalNew
New
OptionalNew

InstrumentRange defines the value range that can be returned by the instrument.
Example:
InstrumentRange ::= {-9999.9, 9999.9}
The Range type is specified in clause 5.5.2.
EURange defines the value range likely to be obtained in normal operation. It is intended for such use
as automatically scaling a bar graph display.
Sensor or instrument failure or deactivation can result in a returned item value which is actually outside
this range. Client software must be prepared to deal with this. Similarly a client may attempt to write a

OPC Unified Architecture, Part 8

Release 1.00

value that is outside this range back to the server. The exact behavior (accept, reject, clamp, etc.) in
this case is server-dependent. However in general servers must be prepared to handle this.
Example:
EURange ::= {-200.0,1400.0}
See also clause 6.1 for a special monitoring filter (PercentDeadband) which is based on the
engineering unit range.
EUInformation specifies the units for the DataItems value (e.g., DEGC, hertz, seconds).
The EUInformation type is specified in clause 5.5.3.
5.2.4 DiscreteItemType
This VariableType is an abstract type. I.e., no instances of this type can exist. However, it
might be used in a filter when browsing or querying. The DiscreteItemType derives from the
DataItemType and therefore shares all of its characteristics. It is formally defined in Table 3.
Table 3 DiscreteItemType Definition
Attribute
Value
BrowseName
DiscreteItemType
IsAbstract
True
References
NodeClass
BrowseName
Inherit the Properties of the DataItemType defined in Clause 5.2.2
HasSubtype
VariableType
TwoStateDiscreteType
HasSubtype
VariableType
MultiStateDiscreteType

DataType

TypeDefinition

ModellingRule

Defined in Clause 5.2.4.1

Defined in Clause 5.2.4.2

5.2.4.1 TwoStateDiscreteType
This VariableType defines the general characteristics of a DiscreteItem that can have two
states. The TwoStateDiscreteType derives from the DiscreteItemType. It is formally defined in
Table 4.
Table 4 TwoStateDiscreteType Definition
Attribute
Value
BrowseName
TwoStateDiscreteType
IsAbstract
False
References
NodeClass
BrowseName
Inherit the Properties of the DiscreteItemType defined in Clause 5.2.4
HasProperty
Variable
FalseState
HasProperty
Variable
TrueState

DataType

TypeDefinition

ModellingRule

LocalizedText
LocalizedText

PropertyType
PropertyType

New
New

TrueState contains a string to be associated with this DataItem when it is TRUE. This is typically used
for a contact when it is in the closed (non-zero) state.
e.g. "RUN", "CLOSE", "ENABLE", "SAFE, etc.
FalseState contains a string to be associated with this DataItem when it is FALSE. This is typically
used for a contact when it is in the open (zero) state.
e.g. "STOP", "OPEN", "DISABLE", "UNSAFE, etc.
5.2.4.2 MultiStateDiscreteType
This VariableType defines the general characteristics of a DiscreteItem that can have more
than two states. The MultiStateDiscreteType derives from the DiscreteItemType. It is formally
defined in Table 5.

OPC Unified Architecture, Part 8

Release 1.00

Table 5 MultiStateDiscreteType Definition

Attribute
Value
BrowseName
MultiStateDiscreteType
IsAbstract
False
References
NodeClass
BrowseName
Inherit the Properties of the DiscreteItemType defined in Clause 5.2.4
HasProperty
Variable
EnumStrings

DataType

TypeDefinition

ModellingRule

LocalizedText[]

New

EnumStrings is a string lookup table corresponding to sequential numeric values (0, 1, 2, etc.)
Example:
OPEN
CLOSE
IN TRANSIT etc.
Here the string OPEN corresponds to 0, Close to 1 and IN TRANSIT to 2.
Clients should be prepared to handle item values outside the range of the list and robust servers
should be prepared to handle writes of illegal values.
If the item contains an array of integer values this lookup table will apply to all elements in the array.

OPC Unified Architecture, Part 8

Release 1.00

5.3 Address Space Model

DataItems are always defined as data components of other Nodes in the AddressSpace. They
are never defined by themselves. A simple example of a container for DataItems would be a
Folder Object but it can be an Object of any other type.
Figure 3 illustrates the basic AddressSpace model of a DataItem in this case an AnalogItem.
DataItemType

Boiler_01 (Object)
Definition

Pressure

(Variable )

Attribute
Value
DataType
AccessLevel
MinimumSamplingInterval

AnalogType

InstrumentRange

EURange

EngineeringUnits
Definition

InstrumentRange

EURange

EngineeringUnits

PropertyType

Figure 3 Representation of DataItems in the AddressSpace

Each DataItem is represented by a DataVariable with a specific set of Attributes. The
TypeDefinition reference indicates the type of the DataItem (in this case the AnalogType).
Additional characteristics of DataItems are defined using Properties. The VariableTypes in
Clause 5.2 specify which properties may exist. These Properties have been found useful for a
wide range of Data Access clients. Servers that want to disclose similar information should
use the OPC-defined Property rather than a vendor-specific one.
The above figure shows only a subset of Attributes and Properties. Other Attributes as defined
for Variables in [UA Part 3] (e.g., Description) may also be available.

5.4 Attributes of DataItems

This section lists the Attributes of Variables that have particular importance for Data Access.
They are specified in detail in [UA Part 3]. The following Attributes are particularly important
for Data Access:

Value

OPC Unified Architecture, Part 8

Release 1.00

DataType
AccessLevel
MinimumSamplingInterval

Value is the most recent value of the Variable that the server has. Its data type is defined by
the DataType Attribute. The AccessLevel Attribute defines the servers basic ability to access
current data and MinimumSamplingInterval defines how current the data are.
When a client requests the Value Attribute for reading or monitoring, the server always returns
a StatusCode (the quality and the servers ability to access/provide the value) and, optionally,
a ServerTimestamp and a SourceTimestamp. See [UA Part 4] for details on StatusCode and
the meaning of the two timestamps. Specific status codes for Data Access are defined in
clause 6.2.

5.5 Property DataTypes

5.5.1 Overview
Following is a description of the data types used for Data Access properties defined in this
part.
Standard DataTypes like String, Boolean, Double or LocalizedText are defined in [UA Part 3].
Their representation is specified in [UA Part 5].
5.5.2 Range
This structure defines the Range for a value. Its elements are defined in Table 6.
Table 6 Range Data Type Structure
Name
Range
low
high

Type
structure
Double
Double

Description
Lowest value in the range.
Highest value in the range.

Its representation in the AddressSpace is defined in Table 7

Table 7 Range Definition
Attributes
BrowseName

Value
Range

OPC Unified Architecture, Part 8

10

Release 1.00

5.5.3 EUInformation
This structure contains information about the EngineeringUnits. Its elements are defined in
Table 8.
The structure has been defined such that standard bodies can incorporate their engineering
unit definitions into OPC UA. Servers will use the namespaceUri in this structure to identify
the proper organization.
Table 8 EUInformation Data Type Structure
Name
EUInformation
namespaceUri

Type
structure
String

unitId

Int32

displayName

LocalizedText

description

LocalizedText

Description
Identifies the organization (company, standard organization) that defines the
EUInformation.
Identifier for programmatic evaluation.
- 1 is used if a unitId is not available.
The displayName of the engineering unit is typically the abbreviation of the
engineering unit, e.g. h for hour or m/s for meter per second.
Contains the full name of the engineering unit such as hour or meter per second.

Its representation in the AddressSpace is defined in Table 9

Table 9 EUInformation Definition
Attributes
BrowseName

Value
EUInformation

OPC Unified Architecture, Part 8

11

Release 1.00

6 Data Access specific usage of Services

[UA Part 4] specifies the complete set of services. Those needed for the purpose of
DataAccess are in particular:

The View service set and Query service set to detect DataItems, and their Properties.

The Attribute service set to read or write Attributes and in particular the value
Attribute.

The MonitoredItem and Subscription service set to set up monitoring of DataItems

and to receive data change notifications.

6.1 PercentDeadband
The DataChangeFilter in [UA Part 4] defines the conditions under which a data change
notification must be reported. This filter contains a deadband which can be of type
AbsoluteDeadband or PercentDeadband. [UA Part 4] already specifies the behavior of the
AbsoluteDeadband. This clause specifies the behavior of the PercentDeadband type.
DeadbandType = PercentDeadband:
For this type of deadband the deadbandValue is defined as the percentage of the EURange.
That is, it applies only to AnalogItems with an EURange Property that defines the typical value
range for the item. This range will be multiplied with the deadbandValue to generate an
exception limit. An exception is determined as follows:
Exception if (absolute value of (last cached value - current value) >
(deadbandValue/100.0) * ((highlow) of EURange)))

If the item is an array of values and any array element exceeds the deadbandValue, the entire
monitored array is returned.
6.2 Data Access Status Codes
6.2.1

Overview

This section defines additional codes and rules that apply to the StatusCode when used for
Data Access values.
The general structure of the StatusCode is specified in [UA Part 4]. It includes a set of
common operational result codes that also apply to Data Access.

6.2.2

Operation level result codes

Certain conditions under which a Variable value was generated are only valid for automation
data and in particular for device data. They are similar, but slightly more generic than the
description of data quality in the various fieldbus specifications.
In the following, Table 10 contains codes with BAD severity, indicating a failure;
Table 11 contains codes with UNCERTAIN severity, indicating that the value has been
generated under sub-normal conditions.
Table 12 contains GOOD (success) codes.
Note again, that these are the codes that are specific for Data Access and supplement the
codes that apply to all types of data and are therefore defined in [UA Part 4].

OPC Unified Architecture, Part 8

12

Release 1.00

Table 10 Bad operation level result codes

Symbolic Id

Description

Bad_ConfigurationError

There is a problem with the configuration that affects the usefulness of the value.

Bad_NotConnected

The variable should receive its value from another variable, but has never been configured to do so.

Bad_DeviceFailure

There has been a failure in the device/data source that generates the value that has affected the
value.

Bad_SensorFailure

There has been a failure in the sensor from which the value is derived by the device/data source.
The limits bits are used to define if the limits of the value have been reached.

Bad_NoCommunication

Communications to the data source is defined, but not established, and there is no last known value
available. This status/substatus is used for cached values before the first value is received.

Bad_OutOfService

The source of the data is not operational.

Bad_DeadbandFilterInvalid

The specified PercentDeadband is not supported, since an EURange is not configured.

Table 11 Uncertain operation level result codes

Symbolic Id

Description

Uncertain_
NoCommunicationLastUsa
ble

Communication to the data source has failed. The variable value is the last value that had a good
quality and it is uncertain whether this value is still current.

Uncertain_
LastUsuableValue

Whatever was updating this value has stopped doing so. This happens when an input variable is
configured to receive its value from another variable and this configuration is cleared after one or
more values have been received.

The server timestamp in this case is the last time that the communication status was checked. The
time at which the value was last verified to be true is no longer available.

This status/substatus is not used to indicate that a value is stale. Stale data can be detected by the
client looking at the timestamps.
Uncertain_SubstituteValue

The value is an operational value that was manually overwritten.

Uncertain_InitialValue

The value is an initial value for a variable that normally receives its value from another variable. This
status/substatus is set only during configuration while the variable is not operational (while it is outof-service).

Uncertain_
SensorNotAccurate

The value is at one of the sensor limits. The Limits bits define which limit has been reached. Also
set if the device can determine that the sensor has reduced accuracy (e.g. degraded analyzer), in
which case the Limits bits indicate that the value is not limited.

Uncertain_
EngineeringUnitsExceeded

The value is outside of the range of values defined for this parameter. The Limits bits indicate which
limit has been reached or exceeded.

Uncertain_SubNormal

The value is derived from multiple sources and has less than the required number of Good sources.

Table 12 Good operation level result codes

Symbolic Id

Description

Good_LocalOverride

The value has been Overridden. Typically this is means the input has been disconnected and a
manually-entered value has been forced.

6.2.3

LimitBits

The bottom 16 bits of the StatusCode are bit flags that contain additional information, but do
not affect the meaning of the StatusCode. Of particular interest for DataItems is the LimitBits
field. In some cases, such as sensor failure it can provide useful diagnostic information.
Servers that do not support Limit have to set this field to 0.

OPC Unified Architecture, Part 8

6.2.4

13

Release 1.00

SemanticsChanged

The StatusCode also contains an informational bit called SemanticsChanged.

UA Servers that implement Data Access must set this Bit in notifications if one or several of
the following Properties changes:
EngineeringUnits (could create problems if the client uses the value to perform
calculations)
EURange (could change the behavior of a Subscription if a PercentDeadband filter is
used)
It should not be changed for any of the other Data Access Properties.
Clients should not process the data value until they re-read the mentioned Properties
associated with the Variable.