From d66fecb2bea126d3d17dfdbae9d5c1348a667dd1 Mon Sep 17 00:00:00 2001
From: Volodymyr Babak <volodymyr.babak@gmail.com>
Date: Tue, 5 Jan 2021 14:46:49 +0200
Subject: [PATCH] Added documentation details to edge rule nodes

---
 .../engine/edge/TbMsgPushToCloudNode.java     | 23 ++++++++++++++++--
 .../rule/engine/edge/TbMsgPushToEdgeNode.java | 24 +++++++++++++++++--
 2 files changed, 43 insertions(+), 4 deletions(-)

diff --git a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/edge/TbMsgPushToCloudNode.java b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/edge/TbMsgPushToCloudNode.java
index b73a83b06a..6936ef20bb 100644
--- a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/edge/TbMsgPushToCloudNode.java
+++ b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/edge/TbMsgPushToCloudNode.java
@@ -32,8 +32,27 @@ import org.thingsboard.server.common.msg.TbMsg;
         type = ComponentType.ACTION,
         name = "push to cloud",
         configClazz = EmptyNodeConfiguration.class,
-        nodeDescription = "Pushes messages to cloud",
-        nodeDetails = "Pushes messages to cloud. This node is used only on Edge instances to push messages from Edge to Cloud.",
+        nodeDescription = "Pushes messages from edge to cloud",
+        nodeDetails = "Push messages from edge to cloud. " +
+                "This node used only on edge to push messages from edge to cloud. " +
+                "Once message arrived into this node it’s going to be converted into cloud event and saved to the local database. " +
+                "Node doesn't push messages directly to cloud, but stores event(s) in the cloud queue. " +
+                "<br>Supports next originator types:" +
+                "<br><code>DEVICE</code>" +
+                "<br><code>ASSET</code>" +
+                "<br><code>ENTITY_VIEW</code>" +
+                "<br><code>DASHBOARD</code>" +
+                "<br><code>TENANT</code>" +
+                "<br><code>CUSTOMER</code>" +
+                "<br><code>EDGE</code><br><br>" +
+                "As well node supports next message types:" +
+                "<br><code>POST_TELEMETRY_REQUEST</code>" +
+                "<br><code>POST_ATTRIBUTES_REQUEST</code>" +
+                "<br><code>ATTRIBUTES_UPDATED</code>" +
+                "<br><code>ATTRIBUTES_DELETED</code>" +
+                "<br><code>ALARM</code><br><br>" +
+                "Message will be routed via <b>Failure</b> route if node was not able to save cloud event to database or unsupported originator type/message type arrived. " +
+                "In case successful storage cloud event to database message will be routed via <b>Success</b> route.",
         uiResources = {"static/rulenode/rulenode-core-config.js", "static/rulenode/rulenode-core-config.css"},
         configDirective = "tbNodeEmptyConfig",
         icon = "cloud_upload",
diff --git a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/edge/TbMsgPushToEdgeNode.java b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/edge/TbMsgPushToEdgeNode.java
index a920113b4b..4fb396a8f4 100644
--- a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/edge/TbMsgPushToEdgeNode.java
+++ b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/edge/TbMsgPushToEdgeNode.java
@@ -56,8 +56,28 @@ import static org.thingsboard.rule.engine.api.TbRelationTypes.SUCCESS;
         type = ComponentType.ACTION,
         name = "push to edge",
         configClazz = EmptyNodeConfiguration.class,
-        nodeDescription = "Pushes messages to edge",
-        nodeDetails = "Pushes messages to edge, if Message Originator assigned to particular edge or is EDGE entity. This node is used only on Cloud instances to push messages from Cloud to Edge. Supports only DEVICE, ENTITY_VIEW, ASSET, ENTITY_VIEW, DASHBOARD, TENANT, CUSTOMER and EDGE Message Originator(s).",
+        nodeDescription = "Push messages from cloud to edge",
+        nodeDetails = "Push messages from cloud to edge. " +
+                "Message originator must be assigned to particular edge or message originator is <b>EDGE</b> entity itself. " +
+                "This node used only on cloud instances to push messages from cloud to edge. " +
+                "Once message arrived into this node it’s going to be converted into edge event and saved to the database. " +
+                "Node doesn't push messages directly to edge, but stores event(s) in the edge queue. " +
+                "<br>Supports next originator types:" +
+                "<br><code>DEVICE</code>" +
+                "<br><code>ASSET</code>" +
+                "<br><code>ENTITY_VIEW</code>" +
+                "<br><code>DASHBOARD</code>" +
+                "<br><code>TENANT</code>" +
+                "<br><code>CUSTOMER</code>" +
+                "<br><code>EDGE</code><br><br>" +
+                "As well node supports next message types:" +
+                "<br><code>POST_TELEMETRY_REQUEST</code>" +
+                "<br><code>POST_ATTRIBUTES_REQUEST</code>" +
+                "<br><code>ATTRIBUTES_UPDATED</code>" +
+                "<br><code>ATTRIBUTES_DELETED</code>" +
+                "<br><code>ALARM</code><br><br>" +
+                "Message will be routed via <b>Failure</b> route if node was not able to save edge event to database or unsupported originator type/message type arrived. " +
+                "In case successful storage edge event to database message will be routed via <b>Success</b> route.",
         uiResources = {"static/rulenode/rulenode-core-config.js", "static/rulenode/rulenode-core-config.css"},
         configDirective = "tbNodeEmptyConfig",
         icon = "cloud_download",