@5minds/node-red-contrib-processcube 1.2.3 → 1.3.0-feature-92414d-m21x3yqt

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@5minds/node-red-contrib-processcube",
-    "version": "1.2.3",
+    "version": "1.3.0-feature-92414d-m21x3yqt",
     "license": "MIT",
     "description": "Node-RED nodes for ProcessCube",
     "scripts": {
@@ -52,7 +52,8 @@
             "UserTaskNewListener": "usertask-new-listener.js",
             "UserTaskFinishedListener": "usertask-finished-listener.js",
             "UserTaskInput": "usertask-input.js",
-            "UserTaskOutput": "usertask-output.js"
+            "UserTaskOutput": "usertask-output.js",
+            "WaitForUsertask": "wait-for-usertask.js"
         },
         "examples": "examples"
     },

package/wait-for-usertask.html

@@ -0,0 +1,77 @@
+<script type="text/javascript">
+    RED.nodes.registerType('wait-for-usertask',{
+        category: 'ProcessCube',
+        color: '#02AFD6',
+        defaults: {
+            name: {value: ""},
+            engine: {value: "", type: "processcube-engine-config"},
+            query: {value: "payload"},
+            query_type: {value: "msg"},
+            only_for_new: {value: false}
+        },
+        inputs: 1,
+        outputs: 1,
+        icon: "font-awesome/fa-envelope-open",
+        label: function() {
+            return this.name || "wait-for-usertask";
+        },
+        oneditprepare: function() {
+            $("#node-input-query").typedInput({
+                default: 'msg',
+                types: ['msg', 'json']
+            });
+
+            $("#node-input-query").typedInput('value', this.query);
+            $("#node-input-query").typedInput('type', this.query_type);
+        },
+        oneditsave: function() {
+            this.query = $("#node-input-query").typedInput('value'),
+            this.query_type = $("#node-input-query").typedInput('type')
+
+        }
+    });
+</script>
+
+<script type="text/html" data-template-name="wait-for-usertask">
+    <div class="form-row">
+        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+    <div class="form-row">
+        <label for="node-input-engine"><i class="fa fa-tag"></i> Engine-URL</label>
+        <input type="text" id="node-input-engine" placeholder="http://engine:8000">
+    </div>
+    <div class="form-row">
+        <label for="node-input-query"><i class="fa fa-tag"></i> Query</label>
+        <input type="text" id="node-input-query">
+    </div>
+    <div class="form-row" style="display:flex; margin-bottom: 3px;">
+        <label for="node-input-only_for_new" style="vertical-align:top"><i class="fa fa-list-alt"></i> Only for new</label>
+        <div>
+            <input type="checkbox" checked id="node-input-only_for_new" style="display: inline-block; width: auto; margin: 0px 0px 0px 4px;">
+            <label style="width:auto" for="node-input-multisend">Trigger only for new user task or *checked* also for old ones?</label>
+        </div>
+    </div>
+</script>
+
+<script type="text/markdown" data-help-name="wait-for-usertask">
+Waiting for Usertasks of the connected ProcessCube Engine.
+
+### Inputs
+
+: payload (json)            :  the query to filter the usertasks.
+
+## Outputs
+
+: payload.userTask (string) : The filtered UserTask
+
+### Details
+
+- `msg.payload` or a constant json to filter the UserTasks for Waiting for
+- `Only for new` will trigger only for new UserTasks if checked and also for old ones if not checked.
+
+### References
+
+-  [The ProcessCube&copy; Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
+-  [ProcessCube&copy; LowCode Integration](https://processcube.io/docs/node-red) - LowCode integration in ProcessCube&copy;
+</script>

package/wait-for-usertask.js

@@ -0,0 +1,91 @@
+module.exports = function (RED) {
+    function WaitForUsertask(config) {
+        RED.nodes.createNode(this, config);
+        var node = this;
+
+        const engine = RED.nodes.getNode(config.engine);
+
+        const client = engine.engineClient;
+
+        let subscription = null;
+        let currentIdentity = engine.identity;
+        let subscribe = null;
+
+        node.on('input', async function (msg) {
+            subscribe = async () => {
+                if (!client) {
+                    node.error('No engine configured.');
+                    return;
+                }
+
+                const query = RED.util.evaluateNodeProperty(config.query, config.query_type, node, msg);
+
+                subscription = await client.userTasks.onUserTaskWaiting(async (userTaskWaitingNotification) => {
+
+                    const newQuery = {
+                        'flowNodeInstanceId': userTaskWaitingNotification.flowNodeInstanceId,
+                        ...query
+                    };
+
+                    const matchingFlowNodes = await client.userTasks.query(newQuery, { identity: currentIdentity });
+
+                    if (matchingFlowNodes.userTasks && matchingFlowNodes.userTasks.length == 1) {
+                        const userTask = matchingFlowNodes.userTasks[0];
+
+                        msg.payload = { userTask: userTask };
+                        node.send(msg);
+                    } else {
+                        // nothing todo - wait for next notification
+                    }
+
+                    // remove subscription
+                    client.userTasks.removeSubscription(subscription, currentIdentity);
+                }, { identity: currentIdentity });
+
+                node.log({"Handling old userTasks config.only_for_new": config.only_for_new});
+
+                if (config.only_for_new === false) {
+                    // only check suspended user tasks
+                    const suspendedQuery = {
+                        'state': 'suspended',
+                        ...query
+                    };
+
+                    const matchingFlowNodes = await client.userTasks.query(suspendedQuery, { identity: currentIdentity });
+
+                    if (matchingFlowNodes.userTasks && matchingFlowNodes.userTasks.length >= 1) {
+                        const userTask = matchingFlowNodes.userTasks[0];
+
+                        msg.payload = { userTask: userTask };
+                        node.send(msg);
+
+                        // remove subscription
+                        client.userTasks.removeSubscription(subscription, currentIdentity);
+                    } else {
+                        // let the *currentIdentity* be active
+                    }
+                }
+            };
+
+            subscribe();
+        });
+
+        node.engine.registerOnIdentityChanged(async (identity) => {
+
+            if (subscription) {
+                client.userTasks.removeSubscription(subscription, currentIdentity);
+                currentIdentity = identity;
+                subscribe();
+            } else {
+                currentIdentity = identity;
+            }
+        });
+
+        node.on("close", async () => {
+            if (client != null && subscription != null) {
+                client.userTasks.removeSubscription(subscription, currentIdentity);                
+            }
+        });
+    }
+    RED.nodes.registerType("wait-for-usertask", WaitForUsertask);
+}