Get Node

Block Group: Data Services
Block Icon:Get Node block icon

The Get Node block returns metadata about a data node.

For information on using dataflow blocks, see Dataflow.


Input/Output Property

The following property of the Get Node block can take input and give output.

  • path (string)

path specifies the absolute location of the node to get metadata for.


Output Properties

The following properties of the Get Node block can give output but cannot take input.

  • name (string)
  • hasChildren (boolean)
  • hasValue (boolean)
  • hasHistory (boolean)
  • type (string)
  • icon (string)
  • unit (string)
  • enum (string)
  • actions (table)
  • error (string)

name returns the name of the node.

hasChildren returns TRUE if the node has children, FALSE if it is terminal.

hasValue returns TRUE if the node is associated with a value, FALSE otherwise.

hasHistory returns TRUE if the node is associated with a value history, FALSE otherwise.

type returns the data type of the node, if applicable.

icon returns the absolute file path to the icon that represents the node.

unit returns the units of the node, if applicable.

enum returns the names of the enum options, if applicable. For a boolean value, this column holds the strings associated with each value, such as "On" and "Off".

actions returns a table of the actions that can be taken on this node, such as setting its value. Each row of this table contains a nested table that lists the parameters of that action. To view a nested table, see How do I view the data in nested tables?

error returns the error string, if applicable.


Example

The following image shows an example of the Get Node block. In this example, the “Training” node is dragged to the path property to populate the Get Node block.

Get Node dataflow model