Home
Special Functions
Common Name Service (CNS)
The plantmodel editor can be used for building and modifying data structures such as views and trees based on CNS and use them within projects easily.
CNS Control Functions
cnsGetUserData
Returns the user data stored in a node.

Special Functions
- Audit Trail panel
- Authentication via Kerberos, basics
  In a more and more networking world, a WinCC OA system could be exposed to different types of attacks. An unauthorized WinCC OA system could connect to the distribution manager or hackers could try to manipulate WinCC OA messages.
- Common Name Service (CNS)
  The plantmodel editor can be used for building and modifying data structures such as views and trees based on CNS and use them within projects easily.
  - Editor
  - Viewer
  - OPC
  - Modbus
  - MQTT
  - Log
  - Nodetype
  - CNS Control Functions
    - cnsAddNode
      Adds a new node to a tree or sub-tree.
    - cnsAddTree
      Allows to create a tree or sub-tree.
    - cnsAddObserver
      Registers the given function as CNS observer.
    - cnsChangeNodeData
      Changes the data point (element) and type of the given node.
    - cnsChangeNodeDisplayNames
      Changes the display name of the given node.
    - cnsChangeNodeName
      Changes the ID of the given node.
    - cnsChangeTree
      Replaces a tree or sub-tree with a new tree.
    - cnsChangeViewDisplayNames
      Changes the display name of the given tree.
    - cnsChangeViewName
      Changes the ID of the given view.
    - cnsChangeViewSeparators
      Changes the separators of the given view.
    - cnsCreateView
      Allows to create a new view.
    - cnsDeleteTree
      Allows to delete a tree, sub-tree or node.
    - cnsDeleteView
      Allows to delete a view (with all its trees).
    - cnsGetAccessRight
      Returns the AccessRight (value of the defined parameter "propertyKey") as UINT for the given node.
    - cnsGetChildren
      Returns the ID paths of all child element of a node.
    - cnsGetDisplayNames
      Returns the display names of a node.
    - cnsGetDisplayPath
      Returns the display name path of a node
    - cnsGetId
      Returns the linked data point and CNSDataIdentifierType of the given node.
    - cnsGetIdSet()
      Returns the names of data points linked to the matching nodes.
    - cnsGetNodesByData
      Looks for nodes that are linked to the given data point (element).
    - cnsGetNodesByName()
      Looks for ID paths of nodes that match the given criteria.
    - cnsGetOPCAccessRight
      Returns the OPC AccessLevel (value of the key OA:OPC) as UINT for the given node.
    - cnsGetParent
      Returns the path of the parent node.
    - cnsGetProperty
      Retrieves the key value from the property of the defined node.
    - cnsGetPropertyKeys
      Returns a list of all keys which are defined for the given node.
    - cnsGetRoot
      Returns the ID path of the root node of the tree which contains the given node.
    - cnsGetSystemNames
      Returns the display names of the given system.
    - cnsGetTrees
      Returns the ID paths of all trees of the given view.
    - cnsGetUserData
      Returns the user data stored in a node.
    - cnsGetViewDisplayNames
      Returns the display names of the given view.
    - cnsGetViewSeparators
      Returns the separators of the given view.
    - cnsGetViews
      Returns the paths of all views in the given system.
    - cnsRemoveObserver
      De-registers the given observer function.
    - cnsRemoveProperty
      Removes the key from the property of the given node.
    - cnsSetProperty
      Sets the properties for the given node as key/value pair.
    - cnsSetSystemNames
      Changes the display name of the given system.
    - cnsSetUserData
      Stores user data in a node.
    - cnsSubStr
      Extracts parts of a CNS path.
    - cns_checkId
      Checks whether the ID is valid.
    - cns_checkName
      Checks whether the given display name is valid.
    - cns_checkSeparator
      Checks if the separator is valid or not.
    - cns_createNodeType
      Creates a new node type.
    - cns_createTreeOrNode
      Creates a tree or a node and adds it to the given parent element.
    - cns_createView
      Creates a new view.
    - cns_createViewDp
      Creates a internal data point for the given view.
    - cns_deleteNodeType
      Deletes the given node type.
    - cns_deleteTreeOrNode
      Deletes the given tree or node.
    - cns_deleteView
      Deletes the given view.
    - cns_deleteViewDp
      Deletes the internal data point which is linked to the given view.
    - Common Name Service Control Functions
      The following control functions are provided for an easier use of the Common Name Service feature in scripts.
    - cns_getNodeIcon
      Returns the path of the icon defined for the given ID.
    - cns_getNodeTypeDisplayName
      Returns the display name of the given node type.
    - cns_getNodeTypeIcon
      Returns the icon path of the given node type.
    - cns_getNodeTypeValue
      Returns the value of the given node type.
    - cns_getNodeTypes
      Returns all existing node types.
    - cns_getReadableViews
      Returns a list with all views (for which the current permission is sufficient) of the given system.
    - cns_getViewPermission
      Returns the permission bits defined for the given view.
    - cns_isNode
      Checks whether the given ID path is a node.
    - cns_isTree
      Checks whether the given node ID is a tree or not.
    - cns_isView
      Checks whether the given ID is a view.
    - cns_nodeExists
      Checks if the given node exists.
    - cns_setNodeIcon
      Sets an icon for the given node.
    - cns_setNodeTypeDisplayName
      Sets the multilingual display name of a node type.
    - cns_setNodeTypeIcon
      Allows to set an icon for the given node type.
    - cns_setNodeTypeValue
      Sets the value of the given node type.
    - cns_setViewPermission
      Sets the permission for the given view.
    - cns_treeExists
      Checks whether the given tree exists.
    - cns_viewDpToName
      Returns the ID of the view which is linked to the given internal data point.
    - cns_viewExists
      Checks whether the given view exists or not.
    - cns_viewNameToDpName
      Returns the name of the internal data point linked to the given view.
    - cns_changeNodeTypeName
      Changes the ID of a node type.
    - cns_changeViewName
      Changes the ID of the given view.
- COM
  COM - Microsoft Interface stands for Component Object Model, a specification for developing modular software components which can be used by each COM compatible application. COM components can be easily integrated in such applications and can even be removed from an application at run time. COM components can be programmed in various different programming languages although C++ is used mostly. The specifications OLE, ActiveX and DirectX are based on the COM technology.
- OLE DB Provider
  OLE DB is a Microsoft specification for accessing data on different computers. It is based on Microsoft's COM technology and is the successor to the older and limited ODBC technology.
- CtrlExtension
  The CtrlExtension allows the addition of custom C++ code.
- CTRL OA Unit
- DBLogger, basics
- Input Recording
- Generic Dialog Framework
  The Generic Dialog Framework is an easy way to generate your own dialogs by adjusting a set of prefabricated panels.
- HTTP Server
  The HTTP Server integrates Internet technologies directly into WinCC OA . Implemented as an add-on for the Control Manager, possible applications are many and diverse. The HTTP Server can be used as a web server for static HTML pages including download facility or to generate dynamic HTML pages.
- DP Identification
- Insights Hub Connector
  The Insights Hub connector allows you to upload data from WinCC OA to Siemens Industrial Cloud Insights Hub and to process data. WinCC OA supports the integration of SCADA data from WinCC OA to Insights Hub.
- Message Compression
  The message compression compresses WinCC OA messages. Data compression means encoding information using fewer bits than an unencoded representation would use through use of specific encoding schemes.
- Node-RED
  Node-RED is a flow-based programming tool that allows the creation of applications in a graphic environment.
- Panel topology/Group alert facility
  Tree structure for process panels with integrated group alert system
- PM Agent
  The PM Add-ons product portfolio enhances the base functionality of the WinCC product range. Now this is also supported by WinCC OA.
- Redundant network connections
  In order to achieve a better fault tolerance WinCC OA Managers can connect to other WinCC OA Managers running on different computers via redundant network connections (this means connecting through two network connections (= IP connection)).
- Redundancy
  The high availability requirements of plant constructors and operators as well as the process and data security can be covered with the redundancy concept of WinCC OA.
- XML Reporting
  The Reporting feature allows you to create reports in XML format. Therefore, add the WinCC OA Reporting Manager to your project. Historical data can be queried via the Reporting manager by using the SOAP (Simple Object Access Protocol) interface. SOAP is a network protocol which allows sending data in XML format between systems.
- Reporting with Panels (Silent print)
- Recipes, basics
  Recipe Management Systems are used for managing and storing the set points and commands of automated systems defined by numerous data point elements. Even when simulating or testing an application, a relatively large number of set points or input values need to be sent to the peripheral devices by the control system. In these and other situations such a tool represents a great simplification.
- REST Reporting API
  The REST Reporting API is integrated into the Standard web server and can be activated via the config entry [restRporting] enabled.
- Scheduler, basics
  The main task of the scheduler is to allow you to create, configure and administrate a number of schedules of either time or event triggered actions.
- Security
- System Use Notification
  You can use the system use notification panel to display an instruction to the user when logging into the WinCC OA system. The user must confirm the notification before logging into the WinCC OA project.
- System Overview
  A panel for the diagnostics of a WinCC OA system.
- Alive mechanism of manager connections
  The alive mechanism in WinCC OA serves for connection controlling between the single managers. Each manager sends alive messages at definable intervals.
- Encryption
- Distributed systems
  Distributed systems in WinCC OA allow to connect two or more autonomous WinCC OA systems via a network.
- Maintenance package, basics
  Maintenance is a necessity wherever different pieces of equipment are used. For example, drives, valves, motors, where it is necessary to perform maintenance work at specific intervals so as to ensure proper functioning. But prolonging the service life of equipment by means of regular maintenance and cost reduction are also key factors in plant engineering and automation technology.
- Wizard Framework
  Used for easy creation of wizards in a uniform layout style. The key elements "Navigation Bar" and "Bottom Bar" can be customized to fit the needs of the custom wizard.
- XML Panel Format
  The XML (Extensible Markup Language) panel format allows creating WinCC OA panels.
- XML-RPC
  XML-RPC (Extensible Markup Language Remote Procedure Call) allows software on different operating systems to make procedure calls over the internet. XML-RPC uses HTTP for the transport and XML for the encoding. It sends the procedure call to a remote server through HTTP. The call is an XML document and it receives the response as XML.
- XMPP
  XMPP (formerly Jabber) is mostly used in chat (instant messaging) applications and allows near real time communication between two or more parties. It can, e.g., be used to push information from a WinCC_OA project server to one or more persons, even allowing the recipient to send a confirmation back to the server.

cnsGetUserData

Returns the user data stored in a node.

Synopsis

bool cnsGetUserData(string cnsPath, blob &userData);

Parameters


Parameter	Description
cnsPath	ID path of the node
userData	Receives the user data stored in the node

Return value

TRUE or FALSE indicating success or failure of the operation.

Errors

Possible errors:

Wrong ID path

Description

This function returns the user data stored in the given node.

main()
{
  blob userData;
  cnsGetUserData("System1.View3:Node1", userData);
  DebugN(userData);
}

Availability

UI, CTRL