Step 6: Writing a OPC UA ModelDesign File

Last updated on April 10, 2022

This post shows how to write the model by editing a ModelDesign file with a suitable editor

This Post is part of the OPC UA Information Model Tutorial.

In this tutorial we are using the example files provided in the following repository:
https://github.com/pro/opcua-modeling-tutorial

Especially the file FooFltModel.xml

A more complete example with heavy use of heavy usage of ModelDesign files and dependencies between them is shown in this project (look into subfolders with the name opcua):

https://github.com/opcua-skills/plug-and-produce

Namespaces

Namespaces help to avoid naming conflicts by prefixing them to variable names. Apart from that, they also split the whole address space in the server into multiple groups.

The following code shows the minimum code required for an empty ModelDesign with comments indicating the designated model components. A lot of the boiler-plate code is concerned with namespaces, which are discussed in this section.

<?xml version="1.0" encoding="utf-8"?>

<ModelDesign
  xmlns:uax="http://opcfoundation.org/UA/2008/02/Types.xsd"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:ua="http://opcfoundation.org/UA/"
  xmlns:FooZbrFlt="https://new.foo.com/zebra-compression/flattening-and-subspacefolding/UA/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  TargetNamespace="https://new.foo.com/zebra-compression/flattening-and-subspacefolding/UA/"
  TargetVersion="0.9.0"
  TargetPublicationDate="2020-05-01T00:00:00Z"
  xmlns="http://opcfoundation.org/UA/ModelDesign.xsd">

  <Namespaces>
    <!--No space allowed at the beginning of the namespace URL!
      Prefix sets the filenames of the generated files. -->
    <Namespace Name="FooZbrFlt" Prefix="FooFlt">https://new.foo.com/zebra-compression/flattening-and-subspacefolding/UA/</Namespace>
    <Namespace Name="OpcUa" Version="1.03" PublicationDate="2013-12-02T00:00:00Z">http://opcfoundation.org/UA/</Namespace>
  </Namespaces>
  
  <!-- ObjectType -->
  <!-- ReferenceType -->
  <!-- VariableType -->
  <!-- DataType -->
  <!-- Object -->
  <!-- Variable -->
  <!-- Property -->
  <!-- Dictionary -->
  <!-- Method -->
  <!-- View -->
  
  <!-- Instantiate at least one variable (or object, or view, or ...) in namespace.
    Compiling an empty namespace will fail with error message:
	  Object reference not set to an instance of an object.
	See https://github.com/OPCFoundation/UA-ModelCompiler/issues/68 -->
  
  <View SymbolicName="FooZbrFlt:MyView">
    <Description>Dummy view</Description>
    <References>
      <Reference IsInverse="true">
        <ReferenceType>ua:Organizes</ReferenceType>
        <TargetId>ua:ObjectsFolder</TargetId>
      </Reference>
    </References>
  </View>
  
</ModelDesign>

The XML element ModelDesign has the following attributes:

• xmlns:uax="http://opcfoundation.org/UA/2008/02/Types.xsd"
  • The link leads to a schema file that defines various complexTypes used by OPCFoundation.
• xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  • required
• xmlns:ua="http://opcfoundation.org/UA/"
  • Namespace of all OPCFoundation
• xmlns:FooZbrFlt="https://new.foo.com/zebra-compression/flattening-and-subspacefolding/UA/"
  • this document may use elements of namespace FooZbrFlt. In combination with TargetNamespace this document may define ObjectType elements in that namespace as well as use them from that namespace, as long as their names are correctly prefixed with FooZbrFlt:.
• xmlns:xsd="http://www.w3.org/2001/XMLSchema"
• TargetNamespace="https://new.foo.com/zebra-compression/flattening-and-subspacefolding/UA/"
  • this document defines elements in this namespace
• TargetVersion="0.9.0"
  • optional, used as auxiliary release meta-information
• TargetPublicationDate="2020-05-01T00:00:00Z"
  • optional, used as auxiliary release meta-information
• xmlns="http://opcfoundation.org/UA/ModelDesign.xsd"
  • Default namespace of this document

Methods

Define method types explicitly (grey box) and use them via TypeDefinition for method nodes as shown for method MyMethod. Defining methods in-places like MyMethodInPlace will not expose Input- and OutputArguments to the OPC UA client.

Note: In comparison to Object/ObjectType and Variable/VariableType, Method do not have MethodType.