OPC 11030-1 UA Modelling Best Practices

Description

Guidelines and best practice for information modellers creating OPC UA based information models.

Naming Conventions
1. Naming Conventions for Nodes
2 Naming Conventions for structure Fields
Rules for backward compatibility of Information Models
1. Adding mandatory components to ObjectTypes and VariableTypes
2. Adding optional components to ObjectTypes and VariableTypes
3. Adding Interfaces to ObjectTypes
4. Changing the values of an Enumeration DataType
5. Changing the fields of a Structure DataType
6. Changing the Type Hierarchy of ObjectTypes or VariableTypes
7. Changing the Type Hierarchy of DataTypes
8. Changing the Signature of a Method
9. Changing the DataType of a Variable
10. Changing the TypeDefinition of an InstanceDeclaration
11. Changing the Semantics of ReferenceTypes
12. Changing the Type Hierarchy of ReferenceTypes
Strategies for Breaking Changes
How to define StatusCodes in Companion Specifications
How to return application-specific statuses in Methods

Working Group Information Model Best Practice
Document Type Whitepapers
License Free
Access Level Everyone
Version Status Date
Release 2024-11-13
Topics:
  • Usage of deprecation
  • Update on breaking changes. Not allowed to remove something.
Version Status Date
Deprecated 2024-04-21
Topics:
  • Description on different types of Methods and their ModellingRules
  • Guideline how to handle namespaces and NodeIds
  • Conventions on NamespaceUris
  • Improved text on compliance testing
  • Describe how to use BrowseNames in text
Deprecated 2023-01-16
Topics: Several new sections added:
  • Naming Convention for Enum Names
  • Naming Conventions for NodeSet-Files
  • Added backward compatibility rules for OptionSets and Unions
  • Adding strategies for breaking changes
  • How to create a companion specification. Not defining here but having references to the correct documents, e.g. template, doc with rules, how to test. Referencing the doc describing certification process.
  • Best practice on base modelling concepts
  • Handling NodeSet-Files for dictionary references
  • How to use existing companion specifications
  • How to extend an existing companion specification
  • How to define Conformance Units and Profiles
  • How to model configuration changes effecting the AddressSpace
Deprecated 2020-07-22