SiOME MAN V27 en
SiOME MAN V27 en
Siemens OPC UA
Modeling Editor
Functional Description
Siemens
SiOME V2.7 / OPC UA / TIA Portal Industry
Online
https://support.industry.siemens.com/cs/ww/en/view/109755133 Support
Legal information
Legal information
Use of application examples
Application examples illustrate the solution of automation tasks through an interaction of several components in
the form of text, graphics and/or software modules. The application examples are a free service by Siemens AG
and/or a subsidiary of Siemens AG (“Siemens”). They are non-binding and make no claim to completeness or
functionality regarding configuration and equipment. The application examples merely offer help with typical
tasks; they do not constitute customer-specific solutions. You yourself are responsible for the proper and safe
operation of the products in accordance with applicable regulations and must also check the function of the
respective application example and customize it for your system.
Siemens grants you the non-exclusive, non-sublicensable and non-transferable right to have the application
examples used by technically trained personnel. Any change to the application examples is your responsibility.
Sharing the application examples with third parties or copying the application examples or excerpts thereof is
permitted only in combination with your own products. The application examples are not required to undergo the
customary tests and quality inspections of a chargeable product; they may have functional and performance
defects as well as errors. It is your responsibility to use them in such a manner that any malfunctions that may
occur do not result in property damage or injury to persons.
Disclaimer of liability
Siemens shall not assume any liability, for any legal reason whatsoever, including, without limitation, liability for
the usability, availability, completeness and freedom from defects of the application examples as well as for
related information, configuration and performance data and any damage caused thereby. This shall not apply in
cases of mandatory liability, for example under the German Product Liability Act, or in cases of intent, gross
negligence, or culpable loss of life, bodily injury or damage to health, non-compliance with a guarantee,
fraudulent non-disclosure of a defect, or culpable breach of material contractual obligations. Claims for damages
arising from a breach of material contractual obligations shall however be limited to the foreseeable damage
typical of the type of agreement, unless liability arises from intent or gross negligence or is based on loss of life,
bodily injury or damage to health. The foregoing provisions do not imply any change in the burden of proof to
your detriment. You shall indemnify Siemens against existing or future claims of third parties in this connection
© Siemens AG 2023 All rights reserved
Other information
Siemens reserves the right to make changes to the application examples at any time without notice. In case of
discrepancies between the suggestions in the application examples and other Siemens publications such as
catalogs, the content of the other documentation shall have precedence.
The Siemens terms of use (https://support.industry.siemens.com) shall also apply.
Security information
Siemens provides products and solutions with industrial security functions that support the secure operation of
plants, systems, machines and networks.
In order to protect plants, systems, machines and networks against cyber threats, it is necessary to implement –
and continuously maintain – a holistic, state-of-the-art industrial security concept. Siemens’ products and
solutions constitute one element of such a concept.
Customers are responsible for preventing unauthorized access to their plants, systems, machines and networks.
Such systems, machines and components should only be connected to an enterprise network or the internet if
and to the extent such a connection is necessary and only when appropriate security measures (e.g. firewalls
and/or network segmentation) are in place.
For additional information on industrial security measures that may be implemented, please visit
https://www.siemens.com/industrialsecurity.
Siemens’ products and solutions undergo continuous development to make them more secure. Siemens strongly
recommends that product updates are applied as soon as they are available and that the latest product versions
are used. Use of product versions that are no longer supported, and failure to apply the latest updates may
increase customer’s exposure to cyber threats.
To stay informed about product updates, subscribe to the Siemens Industrial Security RSS Feed under
https://www.siemens.com/cert.
Table of contents
Legal information .............................................................................................................................. 2
1 Introduction ............................................................................................................................. 7
1.1 Overview .................................................................................................................... 7
1.2 Use Cases ................................................................................................................. 8
1.3 Change log ..............................................................................................................11
2 General ...................................................................................................................................13
2.1 Execution .................................................................................................................13
2.2 User Interface ..........................................................................................................14
2.3 Layouts ....................................................................................................................17
2.4 Default Settings .......................................................................................................18
3 Modeling of the AddressSpace ...........................................................................................22
3.1 Import of OPC UA Models .......................................................................................22
3.2 Deleting the current Information Model ...................................................................23
3.3 Managing OPC UA Namespaces ............................................................................24
3.4 Displaying the DataTypes in the Information Model ................................................28
© Siemens AG 2023 All rights reserved
1 Introduction
1.1 Overview
The OPC UA communication protocol enables companies and organizations to
create their own standards for an OPC UA Information Model. You can generate a
standardized server interface with these functions. For communication to your
system or system parts, the OPC UA clients only must know the defined standard
without taking into account detailed information on the system and its devices.
The platform-independent OPC UA protocol with the companion specifications
extension offers standardized cross-manufacturer communication and reduces
implementation effort.
Many organizations and associations already have standardized OPC UA
Information Models for your industry-specific systems and solutions. Below you will
find a selection of these industry organizations:
• Euromap
• AIM
• VDMA
• AutomationML
• OMAC
• VDW
© Siemens AG 2023 All rights reserved
With the free "Siemens OPC UA Modelling Editor" (SiOME) tool, we have created
an editor for defining your own OPC UA Information Models or mapping existing
companion specifications on your SIMATIC PLC/SINUMERIK. Using this tool, you
can import and edit Information Models as XML files or generate and export
individualized models.
SiOME also includes a graphical editor for State Machines according to UA Part
16, see chapter 3.12.
Mapping
Create or map an Information model to project or online data of SIEMENS devices.
© Siemens AG 2023 All rights reserved
Profit from efficient Drag&Drop interaction with TIA Portal via Openness API
interface.
Validation
Check Information Model conformity to basic modelling rules or against a
Companion Specification. Detect and repair modeling defects.
PubSub
Create a XML configuration for Publish/Subscribe communication model according
to UA Part 14. See chapter 7.
Data Access
Access process data of an OPC UA Server using Browse, Read and Subscription
via an online connection. See chapter 8.
© Siemens AG 2023 All rights reserved
Server Diagnostic
Display diagnostic information of an OPC UA Server and evaluate error conditions
via an online connection. See chapter 8.5.
Event View
Receive and display events and alarms from an online OPC UA Server via Alarms
and Conditions (A&C) according to UA Part 9. Call methods for Acknowledgement
and Comment. See chapter 9.
GDS Push
Deploy PKI security certificates via Global Discovery Server Push to an OPC UA
Server via an online connection, e.g. to a CPU S7-1500 at runtime. See chapter
10.
© Siemens AG 2023 All rights reserved
Version V2.6
• Support of the Openness-interface to TIA Portal V18
• New function of pushing Webserver certificates of S7-CPUs when using the
feature “GDS Push”
• Extension of available Security Policies when using Client functionalities
• New function for adding hierarchical references to existing parent nodes
• Improvements at modelling and Validation of nested or derived object types
including “Repair references” function
• Extension of mapped SIMATIC data types (e.g. DTL, Date_and_Time and
other data types based on structures or byte arrays)
• New tab “Server Diagnostic“ in layout “DataAccess“
• New possibility for creating or selecting subfolders when creating PLC data
types (UDTs)
• New function of showing all usages of a DataType
• Improvements at displaying AssociatedValues and AlarmConditionType of
OPC UA Alarms and Conditions (A&C)
• Improvements at entering start values and UNECE characteristics
2 General
2.1 Execution
System requirements
The following system requirements apply to SiOME:
• .NET Framework 4.8 or higher (see \3\ for download)
• Windows 7 (x64) / Windows 10 (x64)
• Installation of vc_redist.x64 (see \7\ for download)
The following system requirements also apply for the use of the TIA Openness
function of SiOME:
• TIA Portal Openness installation
• Access for TIA Portal Openness, see chapter 4.1
Run as administrator
It is recommended to execute the SiOME application with administration rights.
© Siemens AG 2023 All rights reserved
This can be achieved by activating the option in the Properties menu of the
application file or the desktop shortcut.
3
13
4 6 17
12 16
5 9
8
18
19 22 23 24
21
20
© Siemens AG 2023 All rights reserved
13. "Show number of nodes" button Shows the number of namespace nodes and
the total number of nodes in the project
14. "OPC UA Attributes" area This section displays the attributes of the
OPC UA nodes. You can add a description
of the nodes or change their value here.
18. "Information model" area This section shows the Information Model
and offers all functions for modifying it.
19. "Information model online" dialog Opens the OPC UA Server online
box connection dialog for browsing the
namespace.
Note If logging is activated, SiOME creates the "Log" folder in the same directory as
the SiOME EXE. In this folder you will find the logs in CSV format.
© Siemens AG 2023 All rights reserved
2.3 Layouts
Selecting a Layout
To switch to another layout, click the drop-down menu and select one of the default
layouts.
You can also create your own layout by selecting "Edit layout".
1 3
2 4
You can then change the default settings in the Edit menu.
2 3 4
1
© Siemens AG 2023 All rights reserved
Option Description
"Sort direction for states in the state Configuration of the sorting in the "State Machine
machine" Editor" for the display of the states.
“Default nodeset directory” Default path for nodeset XML files which are
imported upon the start of SiOME.
Option Description
"License column width" This setting changes the width of the
"License" columns in the "Licenses" view for
the SINUMERIK. The more licenses are
configured, the lower this setting should be.
„Show Instance DBs“ This setting determines whether instance
DBs are displayed when connecting to a
TIA Portal project.
2. In the dialog that appears, select the file that you want to import. SiOME also
offers you the possibility to select and import several NodeSets.
3. Click Open in the dialog.
Note Alternatively, you can drag & drop a NodeSet XML file into the "Information
model" area.
© Siemens AG 2023 All rights reserved
• References
• Publication date
• ParentNodeIds
• Encoding NodeIds
Note In the SiOME settings you can disable the validation of the schema
(Nodeset.xsd) if the import of the Nodeset fails.
CAUTION Permanent!
If you reset the project with "New", all changes are lost. Save your
project/Information Model beforehand by exporting it via the "Export XML"
button. This allows you to import it again later and process it further.
© Siemens AG 2023 All rights reserved
2. Assign a name in the dialog that appears and then confirm with "Ok".
© Siemens AG 2023 All rights reserved
4. All objects created from now on are automatically assigned to the selected
namespace. You can change the assignment subsequently.
Alternatively, you can click the "Namespaces" drop-down menu and select the
namespace you wish to unlock and/or edit.
© Siemens AG 2023 All rights reserved
Locking a namespace
For example, if you have created all objects of a namespace and want to protect
them against further modifications, you can lock the namespace. Proceed as
follows.
1. Import an Information Model or create your own namespace.
2. Right-click on the desired namespace and then click "Lock Namespace" to
select the namespace.
3. A lock symbol indicates that the namespace is locked. From now on, you
cannot create new objects for this namespace. To unlock, use the "Unlock and
Current Namespace" button on the context menu.
2. You can use the arrows to change the sequence of the namespaces created in
the dialog that appears. Confirm with "Ok".
© Siemens AG 2023 All rights reserved
After you have clicked the button, you can expand the individual namespaces to
check their dependencies
The numbers in square brackets show the total number of nodes in each of the
namespaces. The numbers shown behind each element of the Information model
show the total number of nodes hierarchically below that node as well as the
number of contained nodes which belong to the highlighted namespace.
3. Set the check box "Show DataTypes for Variables and VariableTypes” in the
tab “General”.
© Siemens AG 2023 All rights reserved
2. In the "Default NodeId Type" drop-down menu, select whether the node IDs
are to be generated as strings or numerically. With the "STRING" type, you can
predefine a prefix, a postfix, and a separator.
3. Additionally, you have the option to include the “Root”, “Object and Types” or
“None” in the NodeId definition. With the "NUMERIC" type, you can predefine a
starting value for different node classes and instances.
© Siemens AG 2023 All rights reserved
Change a NodeId
The NodeId of a node is part of the section “OPC UA Attributes”. To change the
NodeId format of a single node you can use the selection field “identifierType”.
When switching from one format to another, the default settings apply as shown in
the previous section.
© Siemens AG 2023 All rights reserved
2. In the dialog that appears, enter a name for the object type and confirm with
"OK".
2. Enter a name for the child in the appearing dialog and select the class
"Variable" as "NodeClass". Then select a suitable data type (in the example:
© Siemens AG 2023 All rights reserved
With the shown mouse click on the lock symbol of a derived member you are
offered to execute one of the following options.
To resolve it, the derivation from the original child can be reestablished by
clicking on the lock symbol again and choosing the following option.
© Siemens AG 2023 All rights reserved
The same action is executed when clicking on the red warning icon in the
“References” editor.
This repair function is also part of the options when you click the lock
symbol again instead.
The object type “myObjectType3” contains a variable of the data type “Boolean”.
The object type “myObjectType4” is created by using a “HasSubtype” reference
under “MyObjectType3”.
The second object type is inheriting all members and their modelling rules, for
example the Boolean variable.
The same restrictions and options apply for modifying the children in the context of
the derived object type as mentioned in the previous section.
2. Enter a name for the structure in the dialog that appears and confirm with "Ok".
The active namespace is automatically selected as the namespace in which
the structure definition is to be stored.
© Siemens AG 2023 All rights reserved
3. Fill the structure with items. Right-click on the structure you just created and
select "Add New Structure Item".
4. In the tree view, select the created item with the left mouse button, assign a
name in the "Structure Field Definition" area and select the desired data type.
Decide whether it is an array of the desired data type and whether this item is
optional.
5. Repeat steps 3 and 4 for each required item within your structure.
© Siemens AG 2023 All rights reserved
2. Assign a name for the enumeration type in the appearing dialog and confirm
with "Ok".
© Siemens AG 2023 All rights reserved
3. Navigate to your enumeration type and expand it. Click "+" to create a new
entry and mark the entry.
Then you can find your variable type in the directory VariableTypes >
BaseVariableType > BaseDataVariableType:
Note SiOME offers the possibility to delete the derived variable type if you delete the
corresponding data type.
NOTE To get you started, you can download a sample file in CSV format.
SiOME. empty.
Must not be changed!
Note The CSV file is processed line by line from top to bottom. If you want to use a
structure data type as "DataType" for a field within the structure, you have to fill
the "Namespace" field and then enter the NodeID of the structure (e.g.,
s=myMaterialDataType) in the "DataType" field.
3. Enter a name for your StateMachine type in the "Add New ObjectType" dialog
and confirm with "Ok".
© Siemens AG 2023 All rights reserved
4. Navigate to the created StateMachine type and right-click on it. Click on "Show
State Machine" in the context menu to open the StateMachine Editor and
configure the StateMachine.
Note The availability of the attributes depends on the "NodeClass" of the object.
The following dialogue “Modelling Value” is used to define or reset the values –
also of structured items. Click on a field in the right column to edit the entry (1). If
you want to reset a Value to its default value, click on the symbol at the end of the
line (2). DataTypes like “Guid” receive a new unique value this way. The pen
symbol at the front of a line appears for each item of an abstract DataType, like
“Number” (3). This allows to refine the abstract DataType to any of its non-abstract
variations, like “Int32”. Finally, confirm the dialogue with “OK” (4).
© Siemens AG 2023 All rights reserved
If you want to remove a modelled Value structure, use the trashcan icon at the end
of the top line.
Defining references
In the "References" area, you can define references for the selected node of the
Information Model. If you have generated a child of an object type in the
"Information model" area, SiOME automatically generates the necessary
"Hierarchical" references for you. Under "References", you can manually enter the
references of a node or change existing references. Also important is the
"ModellingRule" option, which you can use to decide whether a reference is
necessary ("Mandatory") or not when instantiating the type.
© Siemens AG 2023 All rights reserved
In the following dialog, select the parent node and adapt the ReferenceType (if
necessary):
© Siemens AG 2023 All rights reserved
The child nodes are then additionally referenced by the chosen parent node:
Creating Add-Ins
Add-ins are used to add additional objects to object types or instances that do not
exist in the original object or instance type definition. To do this, you must first
create an object type with the property "DefaultInstanceBrowseName". This type
can then be used as an add-in for other object types or instances.
2. Enter the desired BorwseName in the dialog that appears and confirm with
"Ok".
2. In the dialog that appears, select the object type that you have already
© Siemens AG 2023 All rights reserved
Creating Interfaces
Similar to add-ins, you must first create an interface (type) and add it to other
objects before you can use interfaces.
To create an interface, proceed as follows:
1. In the "Information model" section, navigate to "Root > Types >
InterfaceTypes".
2. Right-click "BaseInterfaceType" and click "Add New InterfaceType".
3. Assign a name for the interface in the appearing dialog and confirm with "Ok".
© Siemens AG 2023 All rights reserved
Note The interface name should start with "I" in accordance with the specification.
4. Fill the interface with children. Right-click the interface and click "Add Child".
Using an Interface
Proceed as follows to use an existing InterfaceType:
1. Right-click an object type or object instance and click "Add Interface".
2. Select a previously created interface type in the dialog that appears and
confirm with "Ok".
© Siemens AG 2023 All rights reserved
2. In the dialog that appears, select the object to which you want to move the
selected node and confirm with "Ok":
Renaming a node
Select a node in the "Information model" section and edit its name in the
"References" section:
2. In the dialog that appears, enter either the BrowseName or the Node Id with
namespace and click on a proposed node to jump to it:
© Siemens AG 2023 All rights reserved
Bookmark
To navigate quickly in an object model, you can bookmark nodes.
To add a bookmark, use the key combination "<CTRL> + <K>". This allows you to
delete the bookmark again.
To jump from one bookmark to another, use the key combination "<ALT> + <left
arrow>" or "<ALT> + <right arrow>".
You can then right-click anywhere in the context menu to return to the previous
screen:
© Siemens AG 2023 All rights reserved
Then you receive a list with all nodes defined by that DataType:
You can directly jump to one of the instance nodes in the Information Model by
selecting the entry and using the function „Jump To“:
© Siemens AG 2023 All rights reserved
2. In the "Choose the validation settings" dialog box that appears, decide which
rules you want to check your address space for and then confirm with
"Validate".
© Siemens AG 2023 All rights reserved
3. The result is shown as a grouped list of conflicts. By clicking an entry, the focus
will automatically move to the related node in the Information Model.
2. After validation, the rule violations are displayed in the "Validation" area.
© Siemens AG 2023 All rights reserved
This function does not offer any additional options. The resulting XML file is the
same as from Export function according to chapter 3.19 if the default settings are
kept. All available namespaces, mappings and values are included.
1 3 5
6
2 4
2. If TIA Portal is already started and a project is open in TIA Portal, the dialog
"Attach to already opened TIA Portal project" opens. Select the open project
and then click on "Attach to selected project":
© Siemens AG 2023 All rights reserved
3. If you have configured more than one SIMATIC S7-1500 CPU, select the
suitable CPU from the appearing list and confirm with "Ok". Then confirm the
dialog that opens from the TIA Portal.
4. Use Drag & Drop to map the variable defined in TIA Portal to the variable in the
Information Model.
A green icon shows you that the variable has been correctly mapped.
If the mapping is not done correctly, SiOME will show you an exclamation mark
icon. Click on the exclamation mark icon to display the message.
Removing a mapping
To remove a mapping perform a right-mouse click on the mapping entry and select
„Remove Mapping“.
© Siemens AG 2023 All rights reserved
A multiple selection is possible for this action by using the CTRL key.
After a filter has been applied, the list of all nodes with the selected mapping state
can be exported as a *.csv file.
4. Then you can choose whether arrays, structures or UDTs contained in the
block should be created as variable types and whether the node IDs to be
created should be of the type "String".
It is also possible to set these two attributes according to the complete path
structure of the TIA Portal project element. This can ease the distinction of objects
that have been generated from source elements with identical names. The setting
can be found in the Settings menu section „SIMATIC“ > „Additional TIA Portal
options“:
© Siemens AG 2023 All rights reserved
After activating this setting, the name attributes will be built from the global path
structure of TIA Portal project, e.g. “myDB.myVariable”:
Creating OPC UA Methods from instance data blocks of methods in TIA Portal
You can also perform the same procedure for OPC UA methods:
1. Select an instance data block of an OPC UA method programmed in the TIA
Portal project from which you want to create a method in the OPC UA
Information Model.
2. Hold down CTRL + left click and use Drag & Drop to store the method in the
Information Model.
© Siemens AG 2023 All rights reserved
correctly.
The Drag & Drop function also works with individual variables from the OPC UA
NOTE Information Model directly into a data block in TIA Portal.
1. Drag & Drop the variable to an already existing data block in TIA Portal view in
SiOME.
2. In what follows, the variable will be created in the data block of the TIA Portal
Project and will be automatically mapped correctly.
© Siemens AG 2023 All rights reserved
Then edit the name of the new folder and confirm the selection with “Ok”.
The new subfolder and UDT are then placed in the specified folder in TIA Portal
project:
4
© Siemens AG 2023 All rights reserved
Creating function blocks and instance data blocks from methods defined in the
Information Model
The Drag & Drop function also works with OPC UA methods. This creates a
function block and the corresponding instance data block in TIA Portal.
1. Select a method in the OPC UA Information Model and drag & drop this
method into the TIA Portal view under "Program blocks" in SiOME.
2. In the dialog box that appears, select the desired programming language.
© Siemens AG 2023 All rights reserved
3. In what follows, the function block and the corresponding instance data block
are automatically created in the TIA Portal Project. The method is automatically
mapped correctly.
SiOME does not automatically create methods defined within an object. The
NOTE methods must be created separately via drag and drop.
For a detailed description of the reference namespaces in TIA Portal check the
NOTE online help \5\ and \6\.
2. In the "TIA Portal" view, select the PLC data type you want to map. Use Drag &
Drop from "TIA Portal details" to the corresponding data type in the Information
model.
3. In the following pop-up dialog, all sub-elements with an exactly matching name
have been mapped automatically. You can add mappings manually by
Drag&Drop.
If you keep pressed the Ctrl. key during this action, the mapping will be done
recursively for all internal sub-elements of the node (if possible).
It is not allowed to map elements of an OPC UA data type to variables of different
PLC data types at the same time. This is the reason why the dialogue only shows
the one selected PLC data type and its sub-elements for mapping.
Choose an existing target node in the following pop-up dialogue and confirm with
“Ok”.
3. In the following pop-up, you can map the static variables of the FB to the
individual variables of the object type.
© Siemens AG 2023 All rights reserved
If you want to delete a mapping, select “Remove Mapping” in the context menu
instead.
5. Enter a name for the server interface in which the OPC UA nodes are to be
created.
6. When compiling the project, TIA Portal will create the OPC UA nodes in a
server interface with the specified name.
© Siemens AG 2023 All rights reserved
2. In the dialog box that appears, assign an interface name (1) and select the
namespaces you want to export (2). Finally, confirm with "Ok" (3).
After switching to the SINUMERIK layout (1), the selection of one of the three
possible workflows can be chosen via the selection field in the section
“SINUMERIK model” (2).
Note To be able to import the SINUMERIK namespace, it must first be created with
the Access MyMachine /P2P tool.
1. Enter the following information of the connected OPC UA Server on: "Server
IP", "Server Port", "Username", "Password".
2. Define the location where the XML file should be saved under "output file".
3. Click "Start" to create the XML file. The XML file is stored in the specified path.
The saved XML can now be read into SiOME.
The SINUMERIK OPC UA XML also includes the SINUMERIK namespaces. These
are required and may not be deleted or changed.
In addition to the SINUMERIK model, you can see the properties of the selected
SINUMERIK variables from the SINUMERIK model under "SINUMERIK Attributes".
© Siemens AG 2023 All rights reserved
The properties of the variable from your own model can be found under the
"Attributes / References" tab.
Example, R parameters:
There is only one node for the R parameters in the SINUMERIK namespace. When
linked to a variable, the specific percentage must be added.
After linking via drag & drop, the variable is only linked to the object "rpa". To be
able to display a specific value, the parameters must be added manually.
© Siemens AG 2023 All rights reserved
Prerequisites for using the TIAPortal view for mapping SINUMERIK models:
1. Click on "Start" and enter "lusrmgr.msc" and confirm with the enter.
2. Click on "Groups" in the tree view on the left side.
3. In the workspace, double-click on "Siemens TIA Openness".
4. Click on "Add...".
5. In the text box, enter the name of your current user, e.g. "User". Confirm with
"OK".
6. Log out of the current Windows session and then log back in.
1 2 3 4 5 6
2. If TIA Portal has already been started and a project is open in TIA Portal, the
dialog "Attach to already opened TIA Portal project" opens. Select the open
project, and then click on “Attach to selected project”:
3. If you have configured more than one SINUMERIK, select the suitable
SINUMERIK PLC from the appearing list and confirm with "Ok". Then confirm
the dialog that opens from TIA Portal.
A green icon shows you that the variable has been linked correctly.
If the mapping is not done correctly, SiOME shows you an exclamation mark
symbol. Click on the exclamation mark symbol to display the message.
© Siemens AG 2023 All rights reserved
To delete the mapping, right-click on the mapping and choose “Remove Mapping”.
1. In the project tree, navigate to the data block you want to use and select it. On
the right-hand side under the "TIA Portal Details" you will find the variables
defined in the data block.
2. Under "TIA Portal Details", select the data block from which you want to create
an object in the OPC UA Information Model.
3. Hold down CTRL + left-click and use drag & drop to store the data block in the
Information Model. The correct variable types are created and mapped directly.
Afterwards you can of course change the names of the variables in the
OPC UA model.
To do this, click on "Change external TIA Portal options" under "TIA Portal Details"
© Siemens AG 2023 All rights reserved
• In order for the DB to be accessible via OPC UA, the check mark "DB
accessible from OPC UA" must be set.
• For the variables that are to be read or written, the respective check mark must
be set.
To save changes, click on "Save changes". The changes are also transferred to
the TIA Portal project.
2. In the following dialogue, enter the server address in the "OPC UA server
address" field. The definition of the “Session name” can be modified optionally.
Then click the "Find selected server" button.
© Siemens AG 2023 All rights reserved
3. Select one of the endpoints offered by the OPC UA Server (1). If authentication
with username and password is activated, enter the credentials into the
"Username" and "Password" fields (2). Activate the checkbox "Remember
credentials" to save the username and password for further logins. Then click
"Connect" (3).
4. After the connection is established, you can browse the Server model.
online Server structure follows the typical behavior for a Drag&Drop workflow
of this direction:
Execute a Drag&Drop operation with keeping pressed the Ctrl. key to create a
new node including the mapping to the online source (1).
Performing a Drag&Drop without Ctrl. key only allows to set the mapping entry
of an existing node of the Information Model (2).
The mapping entry has the format of a NodeId as the source of the values is a
OPC UA Server itself.
Adding a license
To add a license, you must follow the steps below:
4. The "Add License" window appears. Add the settings as shown in the following
figure.
© Siemens AG 2023 All rights reserved
Note The "Value" for each license should correspond to the value in the variable under
© Siemens AG 2023 All rights reserved
"Path". If this is not the case, nodes and variables of the license are not
displayed in the OPC UA Server.
5. Click "OK".
7. Add the licenses to the variables and nodes according to your requirements.
The variables in the "Default" license namespace are always represented in
the address space.
© Siemens AG 2023 All rights reserved
The variables marked in light green are part of the default namespace.
You can customize the variable configuration by checking or unchecking the
rectangular boxes.
• "Remove License Permissions" disables the license for the selected node.
• "Remove License Permissions Recursive" removes the license for all child
nodes under an object.
• "Activate License Permissions Recursive" adds the license for all child nodes
under an object.
Note After a license has been set, restart the OPC UA Server to update the
namespace.
8. After the licenses have been added, export the CSOM (XML) as described in
the next section.
Use Case
By connecting to TIA Portal via the Openness interface, SiOME supports creating
an XML configuration file for a process station of one of the following types:
• S7-1200/S7-1500
• S7-300/S7-400
The following chart gives you an overview over data workflow (S7, OPC UA) and
configuration transfer.
© Siemens AG 2023 All rights reserved
The gateway can be used as OPC UA server for transferring process data
supporting the following functions:
• Reading and writing variables
• Monitoring variables (MonitoredItems) using Subscriptions
• Hierarchical address browsing
The OPC UA server role is implemented based on the "Micro Embedded Device
2017 Server Profile" of the OPC Foundation.
The gateway and the SIMATIC station communicate over a S7 connection (based
on Ethernet or PROFIBUS). The gateway acts as the active partner during
connection setup.
Firmware Version
Manual
For further and more detailed information about the CloudConnect 7 setup please
refer to the official product manual:
https://support.industry.siemens.com/cs/us/en/view/109767960
© Siemens AG 2023 All rights reserved
SiOME Settings dialogue can be entered via the general user menu.
To enable access via S7 protocol, the following settings are required in the CPU
properties.
Data blocks with enabled optimized block access can’t be used when mapping or
creating an Information Model:
© Siemens AG 2023 All rights reserved
If not set, SiOME displays a user warning at some point. Openness connectivity
from SiOME to TIA Portal is not affected by this setting.
Follow the dialogues for the selection of the TIA Portal project and the PLC.
They must match the absolute addresses in the original DB of the PLC process
station exactly.
© Siemens AG 2023 All rights reserved
7 PubSub
7.1 General
Introduction
OPC 10000-14: UA Part 14 introduces a communication model for OPC UA
applications acting as decoupled Publishers and Subscribers. This coherent and
optimized concept enables new use cases where the service-based Client/Server
communication model does not fit. As all participants are only connected to a
Message Oriented Middleware, the number of Subscribers receiving data from a
Publisher does not influence the Publisher’s performance. This makes PubSub
suitable for scalable infrastructures with a large number of receivers as well as for
high-speed cyclic data distribution.
To cover different use cases, OPC UA PubSub supports two different variants of
Message Oriented Middleware:
• A broker-less form, where the Message Oriented Middleware is the
network infrastructure itself. Publishers and Subscribers use datagram
protocols like UDP.
• A broker-based form, where the Message Oriented Middleware is
represented by a message broker as the core component. Subscribers and
Publishers use messaging protocols like MQTT or AMQP to communicate
with the Broker.
© Siemens AG 2023 All rights reserved
1 2 3 4
UA nodeset version
Some of the important schema elements for OPC UA PubSub have not been
published with the UA nodeset of version 1.04 or older. When going to the PubSub
editor layout, SiOME automatically switches to the UA nodeset of version 1.05.02.
TIA Portal and PLC firmware do not support UA nodeset 1.05 yet. This means that
an exported nodeset may not be used in a TIA Portal project anymore.
NOTICE
Furthermore, SiOME does not return to version 1.04 when moving away from the
“PubSub editor” layout unless a new project is started.
If you click “Cancel”, SiOME will abort the nodeset replacement and return to the
default view “OPC UA modelling” instead.
7.2 Publish
The creation of a Publish configuration requires three important steps:
• creating a Published Dataset (chapter 7.2.1)
• assigning a Connection to it (7.2.2)
• adding Published Variables to it (0)
The other important components, such as DataSetWriter and WriterGroup, can be
accessed using the Advanced View.
It is recommended to keep Publish configuration and Subscribe configuration in
separated Namespaces, as well as separated from a possible Client/Server
configuration.
7.2.2 Connection
The following dialogue guides through the creation of a new Connection for a
broker-less Message Oriented Middleware using UDP.
Show Connections
© Siemens AG 2023 All rights reserved
The tab “Connection” lists all Connections configured for both Publisher and/or
Subscriber role.
Export XML
For exporting the Information Model containing a Publish configuration, use the
export function of the main menu.
The following dialogue can be used to select the namespaces and to define export
settings.
© Siemens AG 2023 All rights reserved
The option “Export additional PubSub Binary” exports the configuration as a file of
the type *.uabinary additionally.
7.3 Subscribe
A Subscribe configuration can only be created with SiOME by importing a Publish
configuration and deriving the Subscribe components from it.
This process requires two important steps:
• subcribing to Published DataSets of a Publisher configuration (chapter 7.3.1)
• mapping Variables of Subscribed DataSets to Target Nodes of the
Subscriber’s Information Model (7.3.3). This can already be done when
subscribing to a Published DataSet, see chapter 7.3.1.
Connections (7.3.2) are taken from the Publish configuration automatically and do
not have to be modified unless later changes in the Publish Configuration must be
adapted on the Subscriber side as well.
The other important components, such as DataSetReader and ReaderGroup, can
be accessed using the Advanced View.
It is recommended to keep Publish configuration and Subscribe configuration in
separated namespaces, as well as separated from a possible Client/Server
configuration.
The following chapters show creating a Subscribe configuration based on the
Publish configuration from chapter 7.2. Modelling a Publish and a Subscribe
configuration for the same Variables into one Information Model is not a typical use
case though.
© Siemens AG 2023 All rights reserved
Import XML
Use the button “Import XML” to load Publish components from a nodeset, e.g. as
generated in chapter 7.2.4.
The selection “Choose how to create the SubscribedDataSet” defines whether the
related SubscribedDataSet is created solely or along with the other typical
instances such as Connection, ReaderGroup and DataSetReader.
The second selection “Choose how to set Target NodeIds” allows to go different
ways for assigning the Target Nodes.
1. Option “Select existing Target NodeIds”:
© Siemens AG 2023 All rights reserved
After you confirm with “Ok”, the selected Node will be entered in the column
“Target NodeId” of the Variable.
The following dialogue “Node Selection” requires you to choose a Node that
© Siemens AG 2023 All rights reserved
will serve as the parent for all Target Nodes to be created, e.g. a Folder.
The chosen Node is then displayed as the defined “Parent node” and the “Ok”
button is now enabled.
SiOME then creates Target Nodes for you in the Information Model of the
Subscriber automatically. The generated BrowseName and DisplayName are a
combination of the name of the DataSet, the name of the Subscribed Variable
and the addition “Target”.
7.3.2 Connection
Show Connections
Subscribing to a Published DataSet adds the linked Connection to the Subscribe
configuration automatically if the related option was chosen (see chapter 7.3.1).
The tab “Connection” lists all existing Connections of Publisher and/or Subscriber.
It is possible to define the Target Nodes of the Subscribed Variables already at the
moment of subscribing to a Published DataSet, see chapter 7.3.1.
Only 1:1 relationships are possible. A Target Node cannot be dropped to more
than one Variable. For example:
An assignment will also be aborted if the DataType of Node and Variable do not
match. For example:
2. Open the dialog "Information model online" in the "Information model" area.
Click "Connect to OPC UA Server" in the appearing dialog box.
3. In the following dialogue, enter the server address in the "OPC UA server
address" field (1). The definition of the “Session name” can be modified
optionally (2). Then click the "Find selected server" button (3).
SiOME offers you the possibility to import your own client certificate or to create a
NOTE self-signed certificate if you have selected a secure endpoint of the OPC UA
server.
It is not possible to model your address space during the online connection. As
NOTE soon as the online connection is deactivated, SiOME returns to the previous state.
As an alternative, you can drag and drop a node to the subscription view.
© Siemens AG 2023 All rights reserved
Validation of StateMachines
During the online connection to the OPC UA Server, you can check running
StateMachines. Navigate to a StateMachine in the address space and open the
StateMachine Editor by right-clicking on the StateMachine.
Additionally, you can use the validation window to check the StateMachine against
the OPC UA rules. Deviations and errors are displayed in SiOME.
It is not possible to test the function of the StateMachine within the actual machine.
NOTE Only the correct function or representation in the OPC UA Server is checked.
2. In the window that appears, click on the value of the input parameter (in this
case speedSetpoint) to set the value, and select "Call method". If the method
call was successful, SiOME returns the StatusCode "Good (0x0):No Error".
Select the event fields that are to be received additionally and accept the setting by
left-clicking the disk icon
3
© Siemens AG 2023 All rights reserved
In the "Alarms" tab, only currently pending conditions and alarms are displayed.
To download certificates, you have to use the endpoint "Sign & Encrypt". In
addition, you must log into the OPC UA Server with a user who has the necessary
permissions for certificate management (for more information on configuring the
OPC UA Server, see the TIA Portal Online Help under the heading "Configuration
GDS").
In addition, a certificate must be selected for the client during the connection. If the
OPC UA Server is in "Provisioning Mode", any certificate is accepted. If the server
has already been configured, only certificates that are in the "Trustlist" will be
accepted.
The certificate and the "private key" for the OPC UA Client can be imported
separately from the file system or from a p12 container archive during the
connection setup.
5 6
10
11
12
13
12. "Add new Revocation List This button can be used to add call-back
Entry" lists. After adding, the new entries appear
in light gray. Only by confirming the
configuration (button 12) is the call-back
list transferred to the OPC UA Server and
made effective, as well as displayed
"black" in SiOME.
13. "Apply Trust list changes" This button downloads the new entries in
the "Trustlist" and the "Certificate
Revocationlist" to the OPC UA Server
and enables them.
14. "Remove TrustList Entry" With a right-click, you can use the context
(not shown in picture) menu to remove entries from the trust list
as well as from the call-back list.
© Siemens AG 2023 All rights reserved
After downloading the OPC UA Server certificate with SiOME, the OPC UA
connection is automatically terminated.
NOTE Therefore, it is recommended to store the OPC UA Client Certificate of SiOME in
the "TrustList" of the OPC UA Server first, so that a reconnection is again possible.
11 Troubleshooting
Error message Potential solution
Warning: The selected TIA project is created with a
SiOME cannot find a proper TIA Portal TIA version that is not installed on the PC.
version to open the project. Install the required TIA Portal version or
Required version: (e.g. 16) convert the project to the TIA version
installed on the PC. Then open the project
again.
Warning: Option 1:
Unable to open the project. The project is either protected with a project
Either the required software is not installed, password. In this case, click OK and enter
or authentication is required. the project password.
Do you want to proceed with authentication? Option 2:
If there is a SINUMERIK in the project, the
corresponding toolbox must be installed so
that the project can be opened. Make sure
that the correct SINUMERIK Toolbox is
installed in the correct version.
Openness error: Follow the instructions in "Grant permission
Security error. for TIA Openness" in Chapter 3.
Can’t access this project to acquire needed
information
© Siemens AG 2023 All rights reserved
Security error.
Owner “domain\user” of this process is not
member of the windows group ‘Siemens TIA
Openess’. Please contact your
administrator.
12 Appendix
12.1 Service and support
Industry Online Support
Do you have any questions or need assistance?
Siemens Industry Online Support offers round the clock access to our entire
service and support know-how and portfolio.
The Industry Online Support is the central address for information about our
products, solutions and services.
Product information, manuals, downloads, FAQs, application examples and videos
– all information is accessible with just a few mouse clicks:
support.industry.siemens.com
Technical Support
The Technical Support of Siemens Industry provides you fast and competent
support regarding all technical queries with numerous tailor-made offers
– ranging from basic support to individual support contracts. Please send queries
to Technical Support via Web form:
siemens.com/SupportRequest
© Siemens AG 2023 All rights reserved
Service offer
Our range of services includes the following:
• Plant data services
• Spare parts services
• Repair services
• On-site and maintenance services
• Retrofitting and modernization services
• Service programs and contracts
You can find detailed information on our range of services in the service catalog
web page:
support.industry.siemens.com/cs/sc
Topic
\1\ Siemens Industry Online Support
https://support.industry.siemens.com
\2\ Download page of this entry
https://support.industry.siemens.com/cs/ww/en/view/109755133