@5minds/node-red-contrib-processcube 0.15.0-fix-error-in-process-instance-query-8fa811-lz054xqa → 1.0.0-develop-243715-lz1qpiwj

package/Dockerfile

@@ -12,6 +12,8 @@ WORKDIR /data
 
 COPY --from=builder /src/node-red-contrib-processcube /src/node-red-contrib-processcube
 
+COPY nodered/static/ProcessCube_Logo.svg /data/static/ProcessCube_Logo.svg
+
 COPY nodered/package.json package.json
 RUN npm install
 

package/endevent-finished-listener.html

@@ -0,0 +1,50 @@
+<script type="text/javascript">
+    RED.nodes.registerType('endevent-finished-listener', {
+        category: 'ProcessCube Events',
+        color: '#02AFD6',
+        defaults: {
+            name: { value: '' },
+            engine: { value: '', type: 'processcube-engine-config' }
+        },
+        inputs: 0,
+        outputs: 1,
+        icon: 'font-awesome/fa-envelope',
+        label: function () {
+            return this.name || 'endevent-finished-listener';
+        },
+    });
+</script>
+
+<script type="text/html" data-template-name="endevent-finished-listener">
+    <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>
+</script>
+
+<script type="text/markdown" data-help-name="endevent-finished-listener">
+Waiting for end events that are finished.
+
+## Outputs
+
+: correlationId (string): The unique identifier for the correlation.
+: processDefinitionId (string): The identifier for the process definition.
+: processModelId (string): The identifier for the process model.
+: processModelName (string): The name of the process model.
+: processInstanceId (string): The unique identifier for the process instance.
+: flowNodeId (string): The identifier for the flow node.
+: flowNodeName (string): The name of the flow node.
+: flowNodeInstanceId (string): The unique identifier for the flow node instance.
+: previousFlowNodeInstanceId (string): The unique identifier for the previous flow node instance.
+: ownerId (string): The identifier of the owner.
+: currentToken (Object): An object representing the current token.
+
+### References
+
+-   [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; Plattform
+-   [Node-RED Integration in ProcessCube&copy;](https://processcube.io/docs/node-red) - Node-RED Integration in ProcessCube&copy;
+</script>

package/endevent-finished-listener.js

@@ -0,0 +1,52 @@
+module.exports = function (RED) {
+    function EndEventFinishedListener(config) {
+        RED.nodes.createNode(this, config);
+        var node = this;
+        node.engine = RED.nodes.getNode(config.engine);
+
+        const register = async () => {
+            const client = node.engine.engineClient;
+
+            if (!client) {
+                node.error('No engine configured.');
+                return;
+            }
+    
+            let currentIdentity = node.engine.identity;
+            let subscription = await client.events.onEndEventFinished(
+                (endEventFinished) => {
+                    node.send({
+                        payload: endEventFinished,
+                    });
+                },
+                { identity: currentIdentity },
+            );
+
+            node.engine.registerOnIdentityChanged(async (identity) => {
+                client.events.removeSubscription(subscription, currentIdentity);
+                
+                currentIdentity = identity;
+
+                subscription = await client.events.onEndEventFinished(
+                    (endEventFinished) => {
+                        node.send({
+                            payload: endEventFinished
+                        });
+                    },
+                    { identity: currentIdentity },
+                );
+            });
+
+            node.on('close', async () => {
+                if (node.engine && node.engine.engineClient && client) {
+                    client.events.removeSubscription(subscription, currentIdentity);
+                }
+            });
+        };
+
+        if (node.engine) {
+            register();
+        }
+    }
+    RED.nodes.registerType('endevent-finished-listener', EndEventFinishedListener);
+};

package/examples/Definition-Query-Sample.json

@@ -0,0 +1,215 @@
+[
+    {
+        "id": "f28ae6aa3a05069e",
+        "type": "tab",
+        "label": "Definition Query Sample",
+        "disabled": false,
+        "info": "",
+        "env": []
+    },
+    {
+        "id": "4c59118134081e05",
+        "type": "group",
+        "z": "f28ae6aa3a05069e",
+        "style": {
+            "stroke": "#999999",
+            "stroke-opacity": "1",
+            "fill": "none",
+            "fill-opacity": "1",
+            "label": true,
+            "label-position": "nw",
+            "color": "#a4a4a4"
+        },
+        "nodes": [
+            "d97caca0ec54a633",
+            "f74139117c9dab27",
+            "5539a5c4c0f9cbe2",
+            "a8e2b5a6ca25c924"
+        ],
+        "x": 14,
+        "y": 39,
+        "w": 592,
+        "h": 142
+    },
+    {
+        "id": "f1d4eaed7570324e",
+        "type": "group",
+        "z": "f28ae6aa3a05069e",
+        "style": {
+            "stroke": "#999999",
+            "stroke-opacity": "1",
+            "fill": "none",
+            "fill-opacity": "1",
+            "label": true,
+            "label-position": "nw",
+            "color": "#a4a4a4"
+        },
+        "nodes": [
+            "bcc97a73cff5a086",
+            "b418463be836efbb",
+            "0633b709dd9c166f",
+            "fbb37831549d41ff"
+        ],
+        "x": 14,
+        "y": 219,
+        "w": 572,
+        "h": 142
+    },
+    {
+        "id": "d97caca0ec54a633",
+        "type": "processdefinition-query",
+        "z": "f28ae6aa3a05069e",
+        "g": "4c59118134081e05",
+        "name": "Query definitions",
+        "engine": "42e6796dddd9d4db",
+        "query": "{\"includeXml\":false}",
+        "query_type": "json",
+        "models_only": false,
+        "x": 310,
+        "y": 140,
+        "wires": [
+            [
+                "5539a5c4c0f9cbe2"
+            ]
+        ]
+    },
+    {
+        "id": "f74139117c9dab27",
+        "type": "inject",
+        "z": "f28ae6aa3a05069e",
+        "g": "4c59118134081e05",
+        "name": "",
+        "props": [
+            {
+                "p": "payload"
+            },
+            {
+                "p": "topic",
+                "vt": "str"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "payload": "",
+        "payloadType": "date",
+        "x": 120,
+        "y": 140,
+        "wires": [
+            [
+                "d97caca0ec54a633"
+            ]
+        ]
+    },
+    {
+        "id": "5539a5c4c0f9cbe2",
+        "type": "debug",
+        "z": "f28ae6aa3a05069e",
+        "g": "4c59118134081e05",
+        "name": "debug 26",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "false",
+        "statusVal": "",
+        "statusType": "auto",
+        "x": 500,
+        "y": 140,
+        "wires": []
+    },
+    {
+        "id": "bcc97a73cff5a086",
+        "type": "processdefinition-query",
+        "z": "f28ae6aa3a05069e",
+        "g": "f1d4eaed7570324e",
+        "name": "Query models",
+        "engine": "42e6796dddd9d4db",
+        "query": "{\"includeXml\":false}",
+        "query_type": "json",
+        "models_only": true,
+        "x": 300,
+        "y": 320,
+        "wires": [
+            [
+                "0633b709dd9c166f"
+            ]
+        ]
+    },
+    {
+        "id": "b418463be836efbb",
+        "type": "inject",
+        "z": "f28ae6aa3a05069e",
+        "g": "f1d4eaed7570324e",
+        "name": "",
+        "props": [
+            {
+                "p": "payload"
+            },
+            {
+                "p": "topic",
+                "vt": "str"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "payload": "",
+        "payloadType": "date",
+        "x": 120,
+        "y": 320,
+        "wires": [
+            [
+                "bcc97a73cff5a086"
+            ]
+        ]
+    },
+    {
+        "id": "0633b709dd9c166f",
+        "type": "debug",
+        "z": "f28ae6aa3a05069e",
+        "g": "f1d4eaed7570324e",
+        "name": "debug 27",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "false",
+        "statusVal": "",
+        "statusType": "auto",
+        "x": 480,
+        "y": 320,
+        "wires": []
+    },
+    {
+        "id": "a8e2b5a6ca25c924",
+        "type": "comment",
+        "z": "f28ae6aa3a05069e",
+        "g": "4c59118134081e05",
+        "name": "Definitions",
+        "info": "",
+        "x": 100,
+        "y": 80,
+        "wires": []
+    },
+    {
+        "id": "fbb37831549d41ff",
+        "type": "comment",
+        "z": "f28ae6aa3a05069e",
+        "g": "f1d4eaed7570324e",
+        "name": "Models",
+        "info": "",
+        "x": 90,
+        "y": 260,
+        "wires": []
+    },
+    {
+        "id": "42e6796dddd9d4db",
+        "type": "processcube-engine-config",
+        "url": "http://engine:8000"
+    }
+]

package/examples/External-Task-Sample.json

@@ -58,6 +58,32 @@
         "w": 812,
         "h": 202
     },
+    {
+        "id": "390ad4a596a3c002",
+        "type": "group",
+        "z": "a23d2e782beb66f4",
+        "style": {
+            "stroke": "#999999",
+            "stroke-opacity": "1",
+            "fill": "none",
+            "fill-opacity": "1",
+            "label": true,
+            "label-position": "nw",
+            "color": "#a4a4a4"
+        },
+        "nodes": [
+            "529b24c862f7039d",
+            "f4011d6a57c6e13f",
+            "fba605329413c78d",
+            "5e5394e458d1de7c",
+            "18e9e15ef645a908",
+            "eb96f3128ece1be8"
+        ],
+        "x": 34,
+        "y": 499,
+        "w": 832,
+        "h": 202
+    },
     {
         "id": "2991a5e6df2b87d2",
         "type": "externaltask-input",
@@ -174,7 +200,7 @@
         "z": "a23d2e782beb66f4",
         "g": "31cb6729aac0ba46",
         "name": "raise Error",
-        "func": "throw Error(\"hello error\");\n\nreturn msg;",
+        "func": "//throw Error(\"hello error\");\n\nreturn msg;",
         "outputs": 1,
         "timeout": 0,
         "noerr": 0,
@@ -244,6 +270,121 @@
         "y": 40,
         "wires": []
     },
+    {
+        "id": "529b24c862f7039d",
+        "type": "endevent-finished-listener",
+        "z": "a23d2e782beb66f4",
+        "d": true,
+        "g": "390ad4a596a3c002",
+        "name": "",
+        "engine": "42e6796dddd9d4db",
+        "x": 170,
+        "y": 600,
+        "wires": [
+            [
+                "f4011d6a57c6e13f"
+            ]
+        ]
+    },
+    {
+        "id": "f4011d6a57c6e13f",
+        "type": "delay",
+        "z": "a23d2e782beb66f4",
+        "g": "390ad4a596a3c002",
+        "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": 400,
+        "y": 600,
+        "wires": [
+            [
+                "18e9e15ef645a908"
+            ]
+        ]
+    },
+    {
+        "id": "fba605329413c78d",
+        "type": "process-start",
+        "z": "a23d2e782beb66f4",
+        "g": "390ad4a596a3c002",
+        "name": "",
+        "engine": "42e6796dddd9d4db",
+        "processmodel": "External-Task-Sample_Process",
+        "startevent": "StartEvent_1",
+        "x": 770,
+        "y": 600,
+        "wires": [
+            []
+        ]
+    },
+    {
+        "id": "5e5394e458d1de7c",
+        "type": "inject",
+        "z": "a23d2e782beb66f4",
+        "g": "390ad4a596a3c002",
+        "name": "",
+        "props": [
+            {
+                "p": "payload"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "payload": "start",
+        "payloadType": "str",
+        "x": 430,
+        "y": 660,
+        "wires": [
+            [
+                "18e9e15ef645a908"
+            ]
+        ]
+    },
+    {
+        "id": "18e9e15ef645a908",
+        "type": "function",
+        "z": "a23d2e782beb66f4",
+        "g": "390ad4a596a3c002",
+        "name": "pre payload",
+        "func": "msg.payload = {\n    \"hello\": \"world\"\n};\n\nreturn msg;",
+        "outputs": 1,
+        "timeout": 0,
+        "noerr": 0,
+        "initialize": "",
+        "finalize": "",
+        "libs": [],
+        "x": 590,
+        "y": 600,
+        "wires": [
+            [
+                "fba605329413c78d"
+            ]
+        ]
+    },
+    {
+        "id": "eb96f3128ece1be8",
+        "type": "comment",
+        "z": "a23d2e782beb66f4",
+        "g": "390ad4a596a3c002",
+        "name": "Start of Process and restart if it is finished",
+        "info": "",
+        "x": 220,
+        "y": 540,
+        "wires": []
+    },
     {
         "id": "42e6796dddd9d4db",
         "type": "processcube-engine-config",

package/examples/Instance-Query-Sample.json

@@ -0,0 +1,110 @@
+[
+    {
+        "id": "5d27ab4d14b947e9",
+        "type": "tab",
+        "label": "Instances Query Sample",
+        "disabled": false,
+        "info": "",
+        "env": []
+    },
+    {
+        "id": "a71a168415778e2c",
+        "type": "group",
+        "z": "5d27ab4d14b947e9",
+        "style": {
+            "stroke": "#999999",
+            "stroke-opacity": "1",
+            "fill": "none",
+            "fill-opacity": "1",
+            "label": true,
+            "label-position": "nw",
+            "color": "#a4a4a4"
+        },
+        "nodes": [
+            "baa5d814f2e1f1d8",
+            "2af2c5031c617e3d",
+            "81af643792f131f0",
+            "2166b0f822b3e71d"
+        ],
+        "x": 34,
+        "y": 39,
+        "w": 652,
+        "h": 142
+    },
+    {
+        "id": "baa5d814f2e1f1d8",
+        "type": "processinstance-query",
+        "z": "5d27ab4d14b947e9",
+        "g": "a71a168415778e2c",
+        "name": "",
+        "engine": "42e6796dddd9d4db",
+        "query": "{\"includeXml\":false}",
+        "query_type": "json",
+        "x": 320,
+        "y": 140,
+        "wires": [
+            [
+                "2af2c5031c617e3d"
+            ]
+        ]
+    },
+    {
+        "id": "2af2c5031c617e3d",
+        "type": "debug",
+        "z": "5d27ab4d14b947e9",
+        "g": "a71a168415778e2c",
+        "name": "debug 25",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "false",
+        "statusVal": "",
+        "statusType": "auto",
+        "x": 520,
+        "y": 140,
+        "wires": []
+    },
+    {
+        "id": "81af643792f131f0",
+        "type": "inject",
+        "z": "5d27ab4d14b947e9",
+        "g": "a71a168415778e2c",
+        "name": "",
+        "props": [
+            {
+                "p": "payload"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "payload": "go",
+        "payloadType": "str",
+        "x": 130,
+        "y": 140,
+        "wires": [
+            [
+                "baa5d814f2e1f1d8"
+            ]
+        ]
+    },
+    {
+        "id": "2166b0f822b3e71d",
+        "type": "comment",
+        "z": "5d27ab4d14b947e9",
+        "g": "a71a168415778e2c",
+        "name": "Query all processinstances from the engine, see the config of `processinstance-query`",
+        "info": "",
+        "x": 360,
+        "y": 80,
+        "wires": []
+    },
+    {
+        "id": "42e6796dddd9d4db",
+        "type": "processcube-engine-config",
+        "url": "http://engine:8000"
+    }
+]