Defining Tunnels

The Tunnels tab is used to define tunnels for the thing definition. A tunnel is a communication mechanism supported by the IoT Portal that allows a client application to connect to a server application on a gateway. A tunnel is used when the client application needs to remotely access the server application, and does not have the ability to directly connect to the server application. For example, a client application running on a computer in your company's office location needs to connect to a server application on a gateway installed at a remote field location, and the two computers do not have direct LAN connectivity. To define a Tunnel, do the following:

  1. While Creating a Thing definitionor Editing a Thing definition, click on the Tunnels tab
  2. Click  to add a New Tunnel Definition
  3. Enter the following field to define the Tunnel:
    KeyThe key for the tunnel definition. For more information on limitations while defining a key, see Field Formats and Limitations
    NameThe name of the tunnel definition that is displayed on Management Portal pages.
    DescAn optional description for the tunnel definition.
    PortThe server application port that listens for new client application connection requests.
    ProtocolSelect the connection protocol for connecting the tunnel.
    Security tagsEnter any number of tags to the tunnel that control whether a user can use the tunnel. The user must have a role that has the same <update> security tag associated with it in order to use the tunnel.

  4. (optional)Click on the to list all the tunnels from all the Thing definitions. You will be able to select the tunnel you want and copy it to your Thing definition.    
  5. Click Add.

For Things that are gateways a tunnel definition for the Workbench, named deviceWISE Workbench, is automatically defined for the gateway's Thing definition by the IoT Portal.

Related Topics Link IconRelated Topics