Topic updated on September 17, 2021

Touring the Workbench

The Workbench default window consists of four main areas that includes the Title bar, Menu bar, Left hand pane, and Right hand pane. Click Nodes, to display a Nodes list in the left hand pane and a Nodes table in the right hand pane as seen below.

The parts of the Workbench window for this view are described in the following sections.

Component Description
Title bar The Title bar displays the version of the Workbench, name of the node, and your user name.
User/Setting Menu The User/Settings menu is a part of the Menu bar and has the following entries:
  • Connect to IoT Portal - Allows you to connect to the IoT Portal and retrieve information such as Thing keys and Thing definitions. For more information, see Trigger Thing keys and Thing definitions.
  • Configure Open Tunnel Proxy - Allows you to configure proxy settings for tunnel usages (TR50).
  • Set Gateway Node Credentials - Allows you to set the default User ids and Passwords to use when connecting to nodes. If the credentials are not set, then the default user id of admin and the password of admin is used.
  • Clear Gateway Node Credentials - Allows you to unset the default User id and Password to use when connecting to nodes.
  • Use System Proxy Settings - Allows the Workbench to use system networking proxy settings which are otherwise not used. Requires a Workbench restart to take effect.
  • Preferences - Set visual preferences. Allows you to select a theme or change the size of the icons in the navigation tree.
  • Exit - Shuts down the Workbench. The nodes that are currently in the Nodes list are saved and used the next time the Workbench is started.
Help/Info Menu The Help/Info menu is a part of the Menu bar and has the following entries:
  • Online documentation - Opens the latest online help/knowledge base site.
  • Help for Current Panel - Displays the active panel's help (Context-sensitive help) in your default browser.
  • Getting Support - Provides information on submitting a support case to the Technical Support.
  • Error Lookup - Allows you to look up error codes returned or displayed during when using features. The error codes are negative numbers, so an entry would include the "-" sign. For example, -7002.

  • About - Displays information about the Workbench.
  • Check for Updates - Allows you to check and update Workbench from the Management Portal.
  • Configuration Wizard - Runs the configuration wizard, used to configure the workbench to find local nodes on the network and import licenses.
Left hand pane The Left hand pane displays a tabbed pane with Nodes and Groups, each of which is explained in Managing the Workbench Nodes list and Managing the Workbench Groups list respectively.

The pane displays the Nodes list of all of the nodes that have been saved by the Workbench or within a certain group. If a node's icon is greyed out, click on it to reconnect. Expand a node by clicking its , which displays the features available on that node.

Each node in the Nodes list shows a node icon that is specific to the product installed on the node, the node name, the IP address or TR50 Thing key used to connect to the node, and if applicable the highest level active alert state or the attention bit for the node. The alert state or attention bit is displayed as a small icon overlaid on top of the node icon.

Right hand pane The Right hand pane displays a Nodes table with additional information for each node. The columns are sortable, by selecting the column heading. The columns is reordered by dragging and dropping to a new position in the table.
Filter The Filter option allows you to input filter parameters to reduce the number of items displayed in a table.

While the filter box selected, entering a value in the filter displays the filtered nodes. Hitting enter within the field will force the filter to be applied if the box is not checked. The field will highlight green to indicate it is active. It is possible to enter a single value or a comma separated list of values. Each will match case insensitively on any substring, for example my will match MyProject in any column.To limit a match to one column use plus followed by the column name: +type:mytype will only match in the Type column. Column names also match on substring: +ty:mytypeDeselect the checkbox to turn off the filter without losing your values.
Active help Click help on the lower right corner to display the active panel's help (Context-sensitive help) in your default browser.