Overview¶

The "Industrial IoT" nodes and their respective functions are described in the following sections:

Read file node¶

The "read file" node reads files from Industrial IoT and outputs the file contents. This node is used to send the file contents as a message (only for non-binary files).

Write file node¶

The "write file" node writes a file and links it to a certain asset.

This node is used to:

• Write the received message as file contents to a file.
• Define the mime type of the file using "Predefined type" element.
• Overwrite to replace the existing file using "Overwrite" element.

List file node¶

The "list files" node reads all file names for one asset as an array. This node is used to list all files of an asset.

The following table shows "list files" node configuration properties:

Properties	Description
Asset	Select the asset to list the files.
Limit	Set the limit for the files of the list. Note: The maximum number of items being returned (default is 200)
Offset	Enter the offset number to skip the specified number of the files from the list.
Filter	Apply the filter to the files from the list. Click to add the filter. Files can be filtered by name, path and updated field. The updated field will be converted into an ISO date string. For more information on filtering IoT file services, see IoT File Service.

Delete file node¶

The "delete file" node deletes the file of an asset from Industrial IoT. This node is used to delete the file of an asset.

Read aggregates node¶

The "read aggregates" node reads aggregates by using the aggregate or time series API from Industrial IoT.

You use this node to:

• Read aggregated interval data for specific interval.
• Create statistical values
• Allows applications to retrieve smaller data sets that cover a longer period of time with much better performance than processing all of the raw time series data.

Requirements:

• Asset, aspect, variable must exist in Industrial IoT.
• Entity Id, the property set name, a time range, and a requested aggregation interval of the application.

For more information on API specifications, refer to IoT Times Series Aggregates Service API.

Read timeseries node¶

The "read timeseries" node reads time series data from Industrial IoT.

You use this node to:

• Further process or convert data using a function or analytic node.
• Specifically evaluate or validate the time series data.
• Process multiple time series data together (using a "combine" node).
• Select different types of variables from different aspects.
• Read values of aspects defined for assets.

Requirements:

• Asset, aspect and a variable must exist in Industrial IoT.

Write timeseries node¶

The "write timeseries" node writes time series data to Industrial IoT.

You use this node to:

• Write unprocessed data to Industrial IoT.
• Update the existing time series data by activating "Use merging" option. For example, you can update the aspect value without changing the variables.

Requirements:

• Asset, aspect and a variable must already exist in Industrial IoT.

Subscribe timeseries node¶

The "subscribe timeseries" node subscribes time series data from Industrial IoT.

You use this node to:

• Get notifications of new incoming time series data in order to perform tasks.
• Get updates on the new timeseries data which is posted in IOT.

Requirements:

• Asset, aspect and a variable must exist in Industrial IoT.

Once the subscription is created, it can take up to 15 minutes for the service to start working.

Asset type node¶

The "asset type" node makes it possible to read data from multiple assets which belong to the same asset type.

You use this node to:

• Get multiple messages with topic properties defining assets which belong to a particular asset type. The topic property messages can be directly forwarded on the input pin of read timeseries node.

Requirements:

• Asset type, asset, aspect and a variable must exist in Industrial IoT.

Read aspect static node¶

The "read aspect static" node reads the static variables from the aspects.

Requirements:

• Asset, aspect and a variable must already exist in Industrial IoT.

Write aspect static node¶

The "write aspect static" node updates the static variables in the aspects.

Requirements:

• Asset and aspect must already exist in Industrial IoT.

Read asset static node¶

The "read asset static" node reads the static variables from the asset.

Write asset static node¶

The "write asset static" node updates the static variables in the asset.

Asset status node¶

The "asset health" node updates the status of the asset health. The asset health status can be viewed in the info tab of Insights Hub Monitor.

Requirements:

• Aspect in the asset must already exist in Industrial IoT.

Read oee node¶

The "read oee" node reads OEE KPIs.

Requirements:

• Aspect in the asset must already exist in Industrial IoT.

Rules trigger node¶

The "rules trigger" node gets triggered by the Insights hub rules engine.

Create event node¶

Read events node¶

The "read events" node reads event data from Industrial IoT. This node is used to evaluate existing events for an asset, enable statistical analyses, and check the status of events. The dates can be passed as an ISO string or as a date object formats.

Send email node¶

The "send email" node sends an email to one or more recipients. This node is used to send notifications to the user about important events and attach files stored in an asset.

Using send email node¶

To send an email from Visual Flow Creator, follow these steps:

1. From the node palette, drag and drop the "inject" node from input palette, "read file" node from Industrial IoT palette, "function" node from function palette and "send email" node from Industrial IoT palette to the working area. Connect the nodes in a flow as shown below:

   

2. Double click on "inject" node to edit the properties. For more information, refer to Editing nodes.

3. Double click on "read file" node to edit the properties.

   • Select the asset type.
   • Enter the file path.
   • Click "Done".

4. Double click on "function" node to edit the properties.

   • Enter the code.

      msg.attachments = {
      content: msg.payload, filename: 'example.zip'
      };
      return msg;
     

   • Click "Done".

5. Double click on "send email" node to edit the properties.

   • Enter the "Name".
   • Enter the "Recipients".
   • Click "Done".

   Info

   The email address must be valid.

6.Save and execute the flow.

The email is successfully received with the attachment.

Send SMS node¶

The "send SMS" node sends a message to receive the notification directly on the mobile phone.

Using send SMS node¶

To send a message to your mobile phone from Visual Flow Creator, follow these steps:

1. From the node palette, drag and drop the "inject" node from the input palette and "send SMS" node from Industrial IoT palette to the working area. Connect the nodes in a flow as shown below:

   

2. Double click on "inject" node to edit the properties. For more information, refer to Editing nodes.

   • Enter the "Payload (string)" as "Dear Customer, Welcome to VFC".

3. Double click on "send SMS" node to edit the properties.

   • Enter the "Name".
   • Enter the "Message".
   • Click "Done".

   

4. Save and execute the flow.

The message is successfully received on your mobile phone.

Generate node¶

The "generate" node generates basic time series data and combines them. The "generate" node supports the creation of complex signals.

You use this node to:

• Simulate cyclical time series data for test purposes.
• Set signal type, amplitude, offset, etc. for the signal
• Use signal type "walk" to generate a continuous signal path.