Special Functions
- Audit Trail panel
- Authentication via Kerberos, basics
- Common Name Service (CNS)
  - Editor
  - Viewer
  - OPC
  - Modbus
  - MQTT
  - Log
  - Nodetype
  - CNS Control Functions
    - cnsGetChildren
      Returns the ID paths of all child element of a node.
    - cns_getNodeTypeValue
      Returns the value of the given node type.
    - cns_setNodeTypeIcon
      Allows to set an icon for the given node type.
    - cns_deleteViewDp
      Deletes the internal data point which is linked to the given view.
    - cnsRemoveProperty
      Removes the key from the property of the given node.
    - cnsGetUserData
      Returns the user data stored in a node.
    - cnsGetNodesByName()
      Looks for ID paths of nodes that match the given criteria.
    - cns_isNode
      Checks whether the given ID path is a node.
    - cnsAddNode
      Adds a new node to a tree or sub-tree.
    - cns_getNodeTypes
      Returns all existing node types.
    - cns_checkId
      Checks whether the ID is valid.
    - cns_getReadableViews
      Returns a list with all views (for which the current permission is sufficient) of the given system.
    - cnsChangeViewName
      Changes the ID of the given view.
    - cns_getViewPermission
      Returns the permission bits defined for the given view.
    - cns_isView
      Checks whether the given ID is a view.
    - cns_createView
      Creates a new view.
    - cns_createTreeOrNode
      Creates a tree or a node and adds it to the given parent element.
    - cnsGetAccessRight
      Returns the AccessRight (value of the defined parameter "propertyKey") as UINT for the given node.
    - cnsGetTrees
      Returns the ID paths of all trees of the given view.
    - cns_createNodeType
      Creates a new node type.
    - cns_viewNameToDpName
      Returns the name of the internal data point linked to the given view.
    - cns_deleteView
      Deletes the given view.
    - cns_setViewPermission
      Sets the permission for the given view.
    - cnsChangeViewDisplayNames
      Changes the display name of the given tree.
    - cnsSetProperty
      Sets the properties for the given node as key/value pair.
    - cnsGetDisplayPath
      Returns the display name path of a node
    - cnsAddTree
      Allows to create a tree or sub-tree.
    - cns_nodeExists
      Checks if the given node exists.
    - cns_checkName
      Checks whether the given display name is valid.
    - cnsGetSystemNames
      Returns the display names of the given system.
    - cns_getNodeTypeIcon
      Returns the icon path of the given node type.
    - cnsChangeNodeName
      Changes the ID of the given node.
    - cnsGetProperty
      Retrieves the key value from the property of the defined node.
    - cns_treeExists
      Checks whether the given tree exists.
    - cnsChangeNodeData
      Changes the data point (element) and type of the given node.
    - cnsGetViews
      Returns the paths of all views in the given system.
    - cnsSetUserData
      Stores user data in a node.
    - cnsGetDisplayNames
      Returns the display names of a node.
    - Common Name Service Control Functions
      The following control functions are provided for an easier use of the Common Name Service feature in scripts.
    - cnsGetId
      Returns the linked data point and CNSDataIdentifierType of the given node.
    - cnsGetIdSet()
      Returns the names of data points linked to the matching nodes.
    - cns_setNodeTypeDisplayName
      Sets the multilingual display name of a node type.
    - cnsChangeNodeDisplayNames
      Changes the display name of the given node.
    - cnsSubStr
      Extracts parts of a CNS path.
    - cns_changeViewName
      Changes the ID of the given view.
    - cnsRemoveObserver
      De-registers the given observer function.
    - cnsGetViewDisplayNames
      Returns the display names of the given view.
    - cnsGetViewSeparators
      Returns the separators of the given view.
    - cnsAddObserver
      Registers the given function as CNS observer.
    - cns_viewDpToName
      Returns the ID of the view which is linked to the given internal data point.
    - cns_setNodeTypeValue
      Sets the value of the given node type.
    - cnsChangeTree
      Replaces a tree or sub-tree with a new tree.
    - cnsDeleteTree
      Allows to delete a tree, sub-tree or node.
    - cnsSetSystemNames
      Changes the display name of the given system.
    - cns_setNodeIcon
      Sets an icon for the given node.
    - cnsGetNodesByData
      Looks for nodes that are linked to the given data point (element).
    - cns_deleteTreeOrNode
      Deletes the given tree or node.
    - cns_checkSeparator
      Checks if the separator is valid or not.
    - cnsCreateView
      Allows to create a new view.
    - cns_getNodeTypeDisplayName
      Returns the display name of the given node type.
    - cns_viewExists
      Checks whether the given view exists or not.
    - cns_isTree
      Checks whether the given node ID is a tree or not.
    - cns_getNodeIcon
      Returns the path of the icon defined for the given ID.
    - cnsGetRoot
      Returns the ID path of the root node of the tree which contains the given node.
    - cnsGetParent
      Returns the path of the parent node.
    - cnsGetOPCAccessRight
      Returns the OPC AccessLevel (value of the key OA:OPC) as UINT for the given node.
    - cns_changeNodeTypeName
      Changes the ID of a node type.
    - cnsChangeViewSeparators
      Changes the separators of the given view.
    - cns_deleteNodeType
      Deletes the given node type.
    - cnsDeleteView
      Allows to delete a view (with all its trees).
    - cns_createViewDp
      Creates a internal data point for the given view.
    - cnsGetPropertyKeys
      Returns a list of all keys which are defined for the given node.
- COM in WinCC OA, basics
- OLE DB Provider
- CtrlExtension, basics
- CTRL OA Unit
- DBLogger, basics
- Input Recording
- Generic Dialog Framework
- HTTP Server
- DP Identification
- Insights Hub Connector
- Message Compression
- Node-RED
- Panel topology/Group alert facility
- PM Agent
- Redundant network connections
- Redundancy, basics
- XML Reporting
- Reporting with Panels (Silent print)
- Recipes, basics
- REST Reporting API
- Scheduler, basics
- Security
- System Use Notification
- System Overview
- Alive mechanism of manager connections
- Basics on Encryption
- Distributed systems, basics
- Maintenance package, basics
- Wizard Framework
- XML panel format, basics
- XML-RPC, Basics
- XMPP Basics

cnsSetProperty

Sets the properties for the given node as key/value pair.

Synopsis

bool cnsSetProperty(string cnsPath, string key, anytype value);

Parameters


Parameter	Description
cnsPath	ID path of the node
key	Key name
value	Key value

Return value

TRUE or FALSE indicating success or failure of the operation.

Errors

Possible errors:

Wrong or missing parameters
The defined node could not be found
The key/value pair exceeds the maximum length for node properties (256 bytes). Therefore, the pair cannot be added.

Description

It is possible to save properties as key/value pairs for CNS nodes. This function sets the property for the defined node. If the specified key does not exist, it is created with the given value. If the key already exists only the value is updated. A maximum of 256 byte (sum of length of key, value and internal control characters) can be stored per node.

The following keys are already used by WinCC OA internally:


Key	Value
OA:ICON	Name of the icon (including the path relative to the pictures folder) that shall be set for the node.
OA:OPC	Appropriate bit pattern to define the AccessLevel. E.g. 3 to set the bits for read & write. Refer to the CNS chapter of the respective OPC server for further information on the AccessLevel.
OA:MOD	Number of used registers (refer to Modbus/TCP server details or Plantmodel Editor - Modbus
OA:DMOD	Number of dyn elements (refer to Modbus/TCP server details or Plantmodel Editor - Modbus

OPC

main()
{
  cnsSetProperty("System1.View1:Node3.Node1", "OA:OPC", 5);
}

Availability

UI, CTRL