All Products
Search
Document Center

IoT Platform:Data parsing console

Last Updated:Nov 01, 2024

This topic outlines the navigation bar, canvas, and toolbar functionalities within the data parsing console.

Background information

The data parsing console allows you to set up data parsing tasks for analyzing and processing data sources accessed through DataService Studio.

Access the data parsing console

  1. In the IoT Platform console, click Overview. On the Overview tab, find the instance that you want to manage and click the instance ID or the instance name.

  2. In the left-side navigation pane, select DataService Studio > Data Parsing.

  3. On the Data Parsing page, locate the data parsing task you wish to configure and single click View in the Actions column.

    • Left-Side Navigation Pane: Displays various feature nodes.

    • Middle Canvas: Here you can configure feature nodes. A Source Node is added by default.

      To configure a node, single click it on the middle canvas, which will open the configuration panel on the right side. Once you've configured the current node, single click the add icon following the current node on the canvas. In the pop-up node list, single click the next node you want to add. The new node will be automatically added and connected to the current node.

      Note

      Dragging nodes from the left-side navigation pane to the canvas is not supported.

    • Top Toolbar: Provides overall management of parsing tasks.

    Note
    • A data parsing task can include one input node, multiple processing nodes, and one output node.

    • Data configured in a preceding node is accessible in subsequent nodes.

    • Data filtering can be set up either before or after data computation.

Left-side navigation pane

Feature

Node

Description

References

Input

Source Node

Choose the data source to be processed.

Customize

Only when the Topic Format of the data source in the Source Node is Raw Data, a Customize node will be automatically added and connected after the Source Node to configure custom script parsing of raw data.

Processing

Data Computing

Automatically displays related field data based on the Source Node configuration.

Configure expressions to compute existing field data and generate new field data.

Data Filtering

Set filter conditions to ensure only data meeting specific criteria is output.

Value Transformation

Configure conditional expressions to transform field values in the message stream, outputting to either the original or a new field.

Data Aggregation

Aggregate fields in the message stream, similar to the window function in Flink SQL.

Timeout Interpolation

Configure a policy to fill in values during data reporting interruptions to prevent data gaps.

Adjacent Message Calculation

Calculate the value of a numeric field from the current and previous messages (supports BIGINT and DOUBLE types) and output the result to a defined field.

Outputs

Target Node

Send the parsed data to the IoT instance Topic, or store it in a custom storage table within the IoT instance.

When storing in a custom table, the output configuration of the processing node automatically displays fields that can be output. Modify or remove fields as needed to finalize the output configuration.

Middle canvas

Feature

Description

Situated at the top left corner of the canvas.

After finalizing the parsing configuration, single click this icon to initiate a test run of the parsing task.

  • Upon a successful test run, single click Data Structure at the bottom of the canvas to review the parsed output.

  • If the test run encounters errors, follow the prompts to adjust the configuration before attempting another test run.

Located at the bottom left corner of the canvas. Single click this icon to enlarge the canvas view.

Found at the bottom left corner of the canvas. Single click this icon to reduce the canvas view.

Positioned at the bottom left corner of the canvas. Single click this icon to auto-arrange all nodes on the canvas.

This icon indicates that the canvas is unlocked and editable, located at the bottom left corner.

Important

To update the parsing configuration, you must first stop the task and unlock the canvas.

Located at the lower left corner of the canvas, this icon indicates the canvas is locked and nodes are not editable. The canvas locks automatically once the data parsing task is published.

Data Preview

Situated below the canvas, this feature enables you to preview the configured data.

Data Preview

Found at the bottom of the canvas, allowing for a preview of the configured data.

Top toolbar

The toolbar features, from left to right, are as follows:

Feature

Description

Single click to return to the list of data parsing tasks.

The name of the current parsing task is displayed to the right of this icon.

Edit the Task Name and Description.

Running Online

This status is displayed once the task is published and running.

Last Saved At

Indicates the most recent save timestamp.

Save

Click this button to save the current configuration.

Start

Initiate the current data parsing task. For more details, see the referenced document.

Note

Note that once the parsing task is running, editing of feature nodes is disabled.

Stop

Cease the current data parsing task.

Click this icon to access additional options, such as Help.