POC - OPCUA Server - UserManual 1 04.utexa
POC - OPCUA Server - UserManual 1 04.utexa
POC - OPCUA Server - UserManual 1 04.utexa
User Manual
Version 1.04
Oerlikon Barmag Software Solutions (SWS)
Customer Actual Version Last Version
Utexa DTY 4
Project Date
May 17, 2023
Author Document
Dept. SWS, GH POC.OPCUA_Server.UserManual_1_04.utexa.docx
Product
POC OPCUA Server
Application
OMF POC
Module
OPC UA Server Host Interface
Distribution List
Page 2 of 16 © Oerlikon Textile GmbH & Co.KG – Alle Rechte vorbehalten / All Rights Reserved
Version 1.04 POC.OPCUA_Server.UserManual_1_04.utexa.docx
POC OPCUA Server
User Manual
History
1.00 2021-07-30
1.01 2021-08-16
1.02 2021-10-05
1.03 2022-05-09
1.04 2023-05-16
Page 3 of 16 © Oerlikon Textile GmbH & Co.KG – Alle Rechte vorbehalten / All Rights Reserved
Version 1.04 POC.OPCUA_Server.UserManual_1_04.utexa.docx
POC OPCUA Server
User Manual
Table of Contents
1 Introduction ...................................................................................................................... 5
1.1 Prerequisites ...................................................................................................................... 5
1.2 Objective ............................................................................................................................ 5
1.3 General Architecture .......................................................................................................... 5
1.4 Comments and Questions.................................................................................................. 5
Page 4 of 16 © Oerlikon Textile GmbH & Co.KG – Alle Rechte vorbehalten / All Rights Reserved
Version 1.04 POC.OPCUA_Server.UserManual_1_04.utexa.docx
POC OPCUA Server
User Manual
1 Introduction
1.1 Prerequisites
A good understanding of OPC UA and the underlying technologies is required to use this
document and the software it describes (see https://opcfoundation.org/ for further information).
1.2 Objective
In order to provide access to machine and production data by customer-side host IT systems,
the ‘Plant Operation Center’ (POC) provides the 'POC OPC UA Server'. This interface layer
enables the ERP or similar software on the customer side to retrieve data from POC. The
underlying technology of this layer is OPC UA.
Note: some graphics in this document have been created using the OPC UA client software
'UaExpert', copyright of the company Unified Automation GmbH.
Page 5 of 16 © Oerlikon Textile GmbH & Co.KG – Alle Rechte vorbehalten / All Rights Reserved
Version 1.04 POC.OPCUA_Server.UserManual_1_04.utexa.docx
POC OPCUA Server
User Manual
OPC UA communication supports integrated security. The OPC UA interfaces of POC support
authentication with user name and password. The login is:
User Name POC-HostIF
Password <will be given directly to the customer>
Upon customer request a connection as 'Anonymous' can be enabled; in that case user name
and password do not have to be provided.
The actually accessible endpoints may differ from the exemplary list show above.
In a typical OPC UA client the objects can be found under the 'Root -> Objects' path.
The Server object is a general object to access status information of the OPC UA server.
The POC specific OPC UA elements are in namespace '2' unless stated otherwise. This index
refers to the URL 'http://oerlikon.com/poc'.
Page 6 of 16 © Oerlikon Textile GmbH & Co.KG – Alle Rechte vorbehalten / All Rights Reserved
Version 1.04 POC.OPCUA_Server.UserManual_1_04.utexa.docx
POC OPCUA Server
User Manual
Record-based data is provided via different OPCUA objects, each for a different kind of data.
The object itself does not hold any data, but provides a method, with which the data can be
retrieved.
Details on how to request data can be found in section '3.2 Requesting new Records'.
The client passes the ID of the last record retrieved as input parameter to the next call. The
customer-side system can however also retrieve previous records by providing a lower record
ID or can pass 0 as record ID to obtain the oldest record still existing in POC storage.
Note: records, for which the maximum storage duration in POC has expired, are
automatically deleted and can no longer be accessed.
The process to fetch records via the OPC UA interface is independent of the type of data to be
retrieved. The data contents are determined by the referenced object and method name.
Page 7 of 16 © Oerlikon Textile GmbH & Co.KG – Alle Rechte vorbehalten / All Rights Reserved
Version 1.04 POC.OPCUA_Server.UserManual_1_04.utexa.docx
POC OPCUA Server
User Manual
connect re to to
connect rsp
lo in ( )
lo in con ir ed
disconnect re
disconnect rsp
Note:
- Internal queues may cause certain latency times until the records are passed to
the POC server and inserted into the POC database.
The method returns a JSON-encoded string for each data record. The possible JSON
properties are listed specifically for the type of data in the following sections.
The method should be continuously called by the customer's host system in order to check for
new data.
Page 8 of 16 © Oerlikon Textile GmbH & Co.KG – Alle Rechte vorbehalten / All Rights Reserved
Version 1.04 POC.OPCUA_Server.UserManual_1_04.utexa.docx
POC OPCUA Server
User Manual
The parameters are identical for all methods, which retrieve record-based data. The data is
returned as JSON-coded strings in the 'records' parameter. Contents and structure of the data
returned are however specific to the method called.
prevRecordId Int64 IN ID of last record read, i.e. any entries newer than
given ID are requested
records Array of OUT Array with each element containing the JSON-
String encoded data
Page 9 of 16 © Oerlikon Textile GmbH & Co.KG – Alle Rechte vorbehalten / All Rights Reserved
Version 1.04 POC.OPCUA_Server.UserManual_1_04.utexa.docx
POC OPCUA Server
User Manual
lastRecordId Int64 OUT ID of the last record returned; this value should be
passed as input parameter with the next sub-
sequent call
The 'GetNextRecords' method of each object returns an OPC UA array of strings with each item
in the array consisting of the JSON-encoded data of the corresponding dataset. A record is
identified by the ID of the record, which is a sequential unique index.
Page 10 of 16 © Oerlikon Textile GmbH & Co.KG – Alle Rechte vorbehalten / All Rights Reserved
Version 1.04 POC.OPCUA_Server.UserManual_1_04.utexa.docx
POC OPCUA Server
User Manual
Page 11 of 16 © Oerlikon Textile GmbH & Co.KG – Alle Rechte vorbehalten / All Rights Reserved
Version 1.04 POC.OPCUA_Server.UserManual_1_04.utexa.docx
POC OPCUA Server
User Manual
Page 12 of 16 © Oerlikon Textile GmbH & Co.KG – Alle Rechte vorbehalten / All Rights Reserved
Version 1.04 POC.OPCUA_Server.UserManual_1_04.utexa.docx
POC OPCUA Server
User Manual
Page 13 of 16 © Oerlikon Textile GmbH & Co.KG – Alle Rechte vorbehalten / All Rights Reserved
Version 1.04 POC.OPCUA_Server.UserManual_1_04.utexa.docx
POC OPCUA Server
User Manual
Page 14 of 16 © Oerlikon Textile GmbH & Co.KG – Alle Rechte vorbehalten / All Rights Reserved
Version 1.04 POC.OPCUA_Server.UserManual_1_04.utexa.docx
POC OPCUA Server
User Manual
Page 15 of 16 © Oerlikon Textile GmbH & Co.KG – Alle Rechte vorbehalten / All Rights Reserved
Version 1.04 POC.OPCUA_Server.UserManual_1_04.utexa.docx
POC OPCUA Server
User Manual
Page 16 of 16 © Oerlikon Textile GmbH & Co.KG – Alle Rechte vorbehalten / All Rights Reserved
Version 1.04 POC.OPCUA_Server.UserManual_1_04.utexa.docx