@5minds/node-red-contrib-processcube 0.10.3 → 0.11.0-feature-34fec2-lydislpd

package/nodered/node-red-contrib-processcube-flows.json

@@ -39,6 +39,14 @@
         "info": "",
         "env": []
     },
+    {
+        "id": "0825fee24edbf04b",
+        "type": "tab",
+        "label": "Wait for Usertask",
+        "disabled": false,
+        "info": "",
+        "env": []
+    },
     {
         "id": "09cdc14cfb8ad687",
         "type": "group",
@@ -1528,6 +1536,7 @@
         "id": "3e89be46a437d93c",
         "type": "usertask-finished-listener",
         "z": "fd3c725340de4f74",
+        "d": true,
         "g": "f29182f397cab86b",
         "name": "",
         "engine": "d042a4c68f51d6ab",
@@ -1563,6 +1572,7 @@
         "id": "3011d9be5207350a",
         "type": "usertask-new-listener",
         "z": "fd3c725340de4f74",
+        "d": true,
         "g": "f29182f397cab86b",
         "name": "",
         "engine": "d042a4c68f51d6ab",
@@ -2766,5 +2776,93 @@
         "x": 90,
         "y": 260,
         "wires": []
+    },
+    {
+        "id": "22a41b4678ae316d",
+        "type": "wait-for-usertask",
+        "z": "0825fee24edbf04b",
+        "name": "",
+        "engine": "d042a4c68f51d6ab",
+        "query": "{\"flowNodeId\":\"PlaceAnOrderUserTask\"}",
+        "query_type": "json",
+        "only_for_new": true,
+        "x": 350,
+        "y": 160,
+        "wires": [
+            [
+                "fdd00e4099ca2ff6",
+                "f7c378cc51a6244d"
+            ]
+        ]
+    },
+    {
+        "id": "d1336102e406b91c",
+        "type": "inject",
+        "z": "0825fee24edbf04b",
+        "name": "",
+        "props": [
+            {
+                "p": "payload"
+            },
+            {
+                "p": "topic",
+                "vt": "str"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "payload": "",
+        "payloadType": "date",
+        "x": 100,
+        "y": 160,
+        "wires": [
+            [
+                "22a41b4678ae316d"
+            ]
+        ]
+    },
+    {
+        "id": "fdd00e4099ca2ff6",
+        "type": "debug",
+        "z": "0825fee24edbf04b",
+        "name": "debug 28",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "false",
+        "statusVal": "",
+        "statusType": "auto",
+        "x": 570,
+        "y": 160,
+        "wires": []
+    },
+    {
+        "id": "f7c378cc51a6244d",
+        "type": "delay",
+        "z": "0825fee24edbf04b",
+        "name": "",
+        "pauseType": "delay",
+        "timeout": "5",
+        "timeoutUnits": "seconds",
+        "rate": "1",
+        "nbRateUnits": "1",
+        "rateUnits": "second",
+        "randomFirst": "1",
+        "randomLast": "5",
+        "randomUnits": "seconds",
+        "drop": false,
+        "allowrate": false,
+        "outputs": 1,
+        "x": 340,
+        "y": 240,
+        "wires": [
+            [
+                "22a41b4678ae316d"
+            ]
+        ]
     }
 ]

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@5minds/node-red-contrib-processcube",
-    "version": "0.10.3",
+    "version": "0.11.0-feature-34fec2-lydislpd",
     "license": "MIT",
     "description": "Node-RED nodes for ProcessCube",
     "authors": [
@@ -44,7 +44,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"
         }
     },
     "dependencies": {

package/usertask-input.js

@@ -15,7 +15,6 @@ module.exports = function(RED) {
     function UserTaskInput(config) {
         RED.nodes.createNode(this,config);
         var node = this;
-        var msgCounter = 0;
         var flowContext = node.context().flow;
         var nodeContext = node.context();
 

package/wait-for-usertask.html

@@ -0,0 +1,76 @@
+<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 Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; Plattform
+</script>

package/wait-for-usertask.js

@@ -0,0 +1,82 @@
+const process = require('process');
+
+const engine_client = require('@5minds/processcube_engine_client');
+const { userInfo } = require('os');
+
+module.exports = function (RED) {
+    function WaitForUsertask(config) {
+        RED.nodes.createNode(this, config);
+        var node = this;
+        var nodeContext = node.context();
+
+        this.engine = this.server = RED.nodes.getNode(config.engine);
+
+        const engineUrl = this.engine?.url || process.env.ENGINE_URL || 'http://engine:8000';
+
+        var client = nodeContext.get('client');
+
+        if (!client) {
+            nodeContext.set('client', new engine_client.EngineClient(engineUrl));
+            client = nodeContext.get('client');
+        }
+
+        node.on("close", async () => {
+            if (client != null) {
+                client.dispose();
+                client = null;
+            }
+        });
+
+        node.on('input', async function (msg) {
+
+            const query = RED.util.evaluateNodeProperty(config.query, config.query_type, node, msg)
+
+            const sub = await client.userTasks.onUserTaskWaiting(async (userTaskWaitingNotification) => {
+
+                const newQuery = {
+                    'flowNodeInstanceId': userTaskWaitingNotification.flowNodeInstanceId,
+                    ...query
+                };
+
+                const matchingFlowNodes = await client.userTasks.query(newQuery);
+
+                if (matchingFlowNodes.userTasks && matchingFlowNodes.userTasks.length == 1) {
+                    const userTask = matchingFlowNodes.userTasks[0];
+
+                    msg.payload = { userTask: userTask };
+                    node.send(msg);
+                } else {
+                }
+
+                // remove subscription
+                client.userTasks.removeSubscription(sub);
+            });
+
+            console.debug('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);
+
+                if (matchingFlowNodes.userTasks && matchingFlowNodes.userTasks.length >= 1) {
+                    const userTask = matchingFlowNodes.userTasks[0];
+
+                    msg.payload = { userTask: userTask };
+                    node.send(msg);
+
+                    // remove subscription
+                    client.userTasks.removeSubscription(sub);
+                } else {
+                    // let the *sub* be active
+
+                }
+            }
+        });
+    }
+    RED.nodes.registerType("wait-for-usertask", WaitForUsertask);
+}