system.historian.updateRegisteredNodePath
This function is used in Python Scripting.
Description​
Updates the existing historical path for a stored historian node to the newly specific path.
Client Permission Restrictions​
This scripting function has no Client Permission restrictions.
Syntax​
system.historian.updateRegisteredNodePath(previousPath, currentPath, [blockForResult])
Parameters​
| Type | Parameter | Description |
|---|---|---|
| String | previousPath | The previous path for the historian node. |
| String | currentPath | The new current path for the historian node. If null, then the historian node will be retired. |
| Boolean | blockForResult | A flag indicating whether the result should be blocked until confirmation that the update has been attempted. [optional] |
Returns​
List - A list of QualityCode objects. The quality code will indicate success or failure, and if successful, the path will be updated.
Scope​
Gateway, Vision Client, Perspective Session
Code Examples​
Code Snippet
# Update a previously stored path.
previousPath = "histprov:Core_Historian:/sys:gw1:/prov:default:/tag:updateNode1"
currentPath = "histprov:Core_Historian:/sys:gw1:/prov:default:/tag:updateNode2"
system.historian.updateRegisteredNodePath(previousPath, currentPath, True)