6.3.1 Definition

The SerializationEntityType ObjectType defines the SerializationProcess. It has SerializationProperties which allow the configuration of the SerializationProcess and the SerializationScope.

The SerializationEntityType is formally defined in Table 1 and illustrated in Figure 7.

Figure 7 – SerializationEntityType components
Table 1 – SerializationEntityType definition
Attribute Value
BrowseNameSerializationEntityType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the BaseObjectType defined in OPC 10000-5
HasComponentVariableSerializedDataStructureBaseDataVariableTypeM
Serialization filter Properties
HasPropertyVariableIncludeReferenceTypesNodeId[]PropertyTypeO,R
HasPropertyVariableExcludeReferenceTypesNodeId[]PropertyTypeO,R
HasPropertyVariableSerializationDepthUInt16PropertyTypeO,R
HasPropertyVariableConsiderSubElementSerializationPropertiesBooleanPropertyTypeO,R
HasPropertyVariableCustomMetaDataPropertiesKeyValuePair[]PropertyTypeO,R
HasPropertyVariableCustomMetaDataRefNodeIdPropertyTypeO,R
HasPropertyVariableIncludeStatusBooleanPropertyTypeO,R
HasPropertyVariableIncludeSourceTimestampBooleanPropertyTypeO,R
HasPropertyVariableIncludeDictionaryReferenceBooleanPropertyTypeO,R
Configuration of the SerializationEntity (requires locking)
HasComponentMethodConfigureSerializationsee 6.3.3O
Conformance Units
ObjectSerialization Base

The SerializationProperties are described starting with clause 6.3.4. The default settings in Table 2 apply for Properties that are not provided on a SerializationEntityType instance.

Table 2 – Default values for serialization filter Properties
Property Name Default setting
IncludeReferenceTypes[HasChild]
ExcludeReferenceTypes[] //empty array
SerializationDepth1
ConsiderSubElementSerializationPropertiesFalse
CustomMetaDataProperties[] //empty array
CustomMetaDataRef{0}
IncludeStatusFalse
IncludeSourceTimestampFalse
IncludeDictionaryReferenceFalse