@5minds/node-red-contrib-processcube 0.15.0 → 1.0.0-feature-b9c700-lz1po3cl

package/examples/User-Task-Sample.json

@@ -0,0 +1,231 @@
+[
+    {
+        "id": "fd3c725340de4f74",
+        "type": "tab",
+        "label": "UserTasks",
+        "disabled": false,
+        "info": "",
+        "env": []
+    },
+    {
+        "id": "887f3fb69ad1d1fb",
+        "type": "group",
+        "z": "fd3c725340de4f74",
+        "style": {
+            "stroke": "#999999",
+            "stroke-opacity": "1",
+            "fill": "none",
+            "fill-opacity": "1",
+            "label": true,
+            "label-position": "nw",
+            "color": "#a4a4a4"
+        },
+        "nodes": [
+            "f7a9604a17188737",
+            "020d34cd4ab43900",
+            "1db0ae57c1b8486b",
+            "127bc6e092c5724e"
+        ],
+        "x": 34,
+        "y": 19,
+        "w": 452,
+        "h": 202
+    },
+    {
+        "id": "72d3db13edc2486b",
+        "type": "group",
+        "z": "fd3c725340de4f74",
+        "style": {
+            "stroke": "#999999",
+            "stroke-opacity": "1",
+            "fill": "none",
+            "fill-opacity": "1",
+            "label": true,
+            "label-position": "nw",
+            "color": "#a4a4a4"
+        },
+        "nodes": [
+            "ae0583e83c762956",
+            "f7c7682e3a6adaaa",
+            "a2fb6369b16c12fa",
+            "8ef39e83173d41e3",
+            "f524b8cc35d56849",
+            "9fb4017c1d0ac7c9"
+        ],
+        "x": 34,
+        "y": 259,
+        "w": 652,
+        "h": 262
+    },
+    {
+        "id": "f7a9604a17188737",
+        "type": "usertask-new-listener",
+        "z": "fd3c725340de4f74",
+        "d": true,
+        "g": "887f3fb69ad1d1fb",
+        "name": "New User Task",
+        "engine": "42e6796dddd9d4db",
+        "multisend": false,
+        "x": 160,
+        "y": 120,
+        "wires": [
+            [
+                "020d34cd4ab43900"
+            ]
+        ]
+    },
+    {
+        "id": "020d34cd4ab43900",
+        "type": "debug",
+        "z": "fd3c725340de4f74",
+        "g": "887f3fb69ad1d1fb",
+        "name": "Show User Task",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "payload",
+        "targetType": "msg",
+        "statusVal": "",
+        "statusType": "auto",
+        "x": 360,
+        "y": 120,
+        "wires": []
+    },
+    {
+        "id": "1db0ae57c1b8486b",
+        "type": "usertask-finished-listener",
+        "z": "fd3c725340de4f74",
+        "g": "887f3fb69ad1d1fb",
+        "name": "Finished User Task",
+        "engine": "42e6796dddd9d4db",
+        "multisend": false,
+        "x": 150,
+        "y": 180,
+        "wires": [
+            [
+                "020d34cd4ab43900"
+            ]
+        ]
+    },
+    {
+        "id": "127bc6e092c5724e",
+        "type": "comment",
+        "z": "fd3c725340de4f74",
+        "g": "887f3fb69ad1d1fb",
+        "name": "User Task Events",
+        "info": "",
+        "x": 140,
+        "y": 60,
+        "wires": []
+    },
+    {
+        "id": "ae0583e83c762956",
+        "type": "usertask-new-listener",
+        "z": "fd3c725340de4f74",
+        "d": true,
+        "g": "72d3db13edc2486b",
+        "name": "",
+        "engine": "42e6796dddd9d4db",
+        "multisend": true,
+        "x": 160,
+        "y": 360,
+        "wires": [
+            [
+                "a2fb6369b16c12fa"
+            ]
+        ]
+    },
+    {
+        "id": "f7c7682e3a6adaaa",
+        "type": "usertask-input",
+        "z": "fd3c725340de4f74",
+        "g": "72d3db13edc2486b",
+        "name": "",
+        "engine": "42e6796dddd9d4db",
+        "query": "payload",
+        "query_type": "msg",
+        "force_send_array": false,
+        "multisend": false,
+        "x": 380,
+        "y": 420,
+        "wires": [
+            [
+                "8ef39e83173d41e3"
+            ]
+        ]
+    },
+    {
+        "id": "a2fb6369b16c12fa",
+        "type": "function",
+        "z": "fd3c725340de4f74",
+        "g": "72d3db13edc2486b",
+        "name": "query",
+        "func": "msg.payload = {\n    flowNodeInstanceId: msg.payload.flowNodeInstanceId,\n    flowNodeId: \"user_task\"\n};\n\nreturn msg;",
+        "outputs": 1,
+        "timeout": 0,
+        "noerr": 0,
+        "initialize": "",
+        "finalize": "",
+        "libs": [],
+        "x": 210,
+        "y": 420,
+        "wires": [
+            [
+                "f7c7682e3a6adaaa"
+            ]
+        ]
+    },
+    {
+        "id": "8ef39e83173d41e3",
+        "type": "function",
+        "z": "fd3c725340de4f74",
+        "g": "72d3db13edc2486b",
+        "name": "build result",
+        "func": "msg.payload.result = {\n    \"field_01\": \"value 01\",\n    \"field_02\": \"value 02\"\n}\nreturn msg;",
+        "outputs": 1,
+        "timeout": 0,
+        "noerr": 0,
+        "initialize": "",
+        "finalize": "",
+        "libs": [],
+        "x": 390,
+        "y": 480,
+        "wires": [
+            [
+                "f524b8cc35d56849"
+            ]
+        ]
+    },
+    {
+        "id": "f524b8cc35d56849",
+        "type": "usertask-output",
+        "z": "fd3c725340de4f74",
+        "g": "72d3db13edc2486b",
+        "name": "",
+        "engine": "42e6796dddd9d4db",
+        "result": "payload.result",
+        "result_type": "msg",
+        "x": 580,
+        "y": 480,
+        "wires": [
+            []
+        ]
+    },
+    {
+        "id": "9fb4017c1d0ac7c9",
+        "type": "comment",
+        "z": "fd3c725340de4f74",
+        "g": "72d3db13edc2486b",
+        "name": "Demo to listen on a new usertask an finish them",
+        "info": "",
+        "x": 240,
+        "y": 300,
+        "wires": []
+    },
+    {
+        "id": "42e6796dddd9d4db",
+        "type": "processcube-engine-config",
+        "url": "http://engine:8000"
+    }
+]

package/externaltask-error.html

@@ -27,19 +27,19 @@
 </script>
 
 <script type="text/markdown" data-help-name="externaltask-error">
-    Used for reporting errors in the processing of external tasks. The error
-    code `Error` in the configuration is forwarded to the ProcessCube engine for
-    handling within _Error-Boundary-Events_.
+Used for reporting errors in the processing of external tasks. The error
+code `Error` in the configuration is forwarded to the ProcessCube engine for
+handling within _Error-Boundary-Events_.
 
-    ## Inputs
+## Inputs
 
-    : msg (Object) : Passed as `ErrorDetails` to the engine
-    : Error (string) : From the configuration
-    : Message (string) : The caught exception message
-    : StackTrace (string) : The stack trace of the exception
+: msg (Object) : Passed as `ErrorDetails` to the engine
+: Error (string) : From the configuration
+: Message (string) : The caught exception message
+: StackTrace (string) : The stack trace of the exception
 
-    ### References
+### References
 
-    -   [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
-    -   [Node-RED Integration in ProcessCube&copy;](https://processcube.io/docs/node-red) - Node-RED integration in ProcessCube&copy;
+-   [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
+-   [Node-RED Integration in ProcessCube&copy;](https://processcube.io/docs/node-red) - Node-RED integration in ProcessCube&copy;
 </script>

package/externaltask-input.html

@@ -32,22 +32,22 @@
 </script>
 
 <script type="text/markdown" data-help-name="externaltask-input">
-    Waiting for external tasks that correspond to the `Topic` configured in
-    the connected ProcessCube Engine for processing.
+Waiting for external tasks that correspond to the `Topic` configured in
+the connected ProcessCube Engine for processing.
 
-    ## Outputs
+## Outputs
 
-    : payload (string) : Defines the input of the external task token
-    : task (object) : The external task object
-    : flowNodeInstanceId : The Id of the external task, which is needed to complete the task
+: payload (string) : Defines the input of the external task token
+: task (object) : The external task object
+: flowNodeInstanceId : The Id of the external task, which is needed to complete the task
 
-    ### Details
+### Details
 
-    -   To finish the external task the `externaltask-output` node is required.
-    -   For handling a error while executing a flow as external task the `externaltask-error` node is required.
+-   To finish the external task the `externaltask-output` node is required.
+-   For handling a error while executing a flow as external task the `externaltask-error` node is required.
 
-    ### References
+### 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;
+-   [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/externaltask-input.js

@@ -16,9 +16,14 @@ module.exports = function (RED) {
         var node = this;
         var flowContext = node.context().flow;
 
-        this.engine = this.server = RED.nodes.getNode(config.engine);
+        const engine =  RED.nodes.getNode(config.engine);
 
-        const client = this.engine.getEngineClient();
+        const client = engine.engineClient;
+
+        if (!client) {
+            node.error('No engine configured.');
+            return;
+        }
 
         var eventEmitter = flowContext.get('emitter');
 
@@ -106,8 +111,8 @@ module.exports = function (RED) {
             .then(async (externalTaskWorker) => {
                 node.status({ fill: 'blue', shape: 'ring', text: 'subcribed' });
 
-                externalTaskWorker.identity = node.server.identity;
-                node.server.registerOnIdentityChanged((identity) => {
+                externalTaskWorker.identity = engine.identity;
+                engine.registerOnIdentityChanged((identity) => {
                     externalTaskWorker.identity = identity;
                 });
 
@@ -118,7 +123,7 @@ module.exports = function (RED) {
                         case 'finishExternalTask':
                         case 'processExternalTask':
                             node.error(
-                                `Worker error ${errorType} for *external task flowNodeInstanceId* '${externalTask.flowNodeInstanceId}' and *processInstanceId* '${externalTask.processInstanceId}': ${error.message}`,
+                                `Worker error ${errorType} for *external task flowNodeInstanceId* '${externalTask.flowNodeInstanceId}' and *processInstanceId* '${externalTask.processInstanceId}': ${error.message}`
                             );
 
                             if (externalTask) {

package/externaltask-output.html

@@ -22,15 +22,15 @@
 </script>
 
 <script type="text/markdown" data-help-name="externaltask-output">
-    Used to complete the external task. The `msg.payload` is returned to the ProcessCube
-    engine as the result of the external task.
+Used to complete the external task. The `msg.payload` is returned to the ProcessCube
+engine as the result of the external task.
 
-    ## Inputs
+## Inputs
 
-    : payload (Object) : Returned to the ProcessCube engine as the result of the external task
+: payload (Object) : Returned to the ProcessCube engine as the result of the external task
 
-    ### References
+### References
 
-    -   [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
-    -   [Node-RED Integration in ProcessCube&copy;](https://processcube.io/docs/node-red) - Node-RED integration in ProcessCube&copy;
+-   [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
+-   [Node-RED Integration in ProcessCube&copy;](https://processcube.io/docs/node-red) - Node-RED integration in ProcessCube&copy;
 </script>

package/message-event-trigger.html

@@ -36,6 +36,18 @@
     </div>
 </script>
 
-<script type="text/html" data-help-name="externaltask-input">
-    <p>A node which emmits an message event to the Engine.</p>
+<script type="text/markdown" data-help-name="externaltask-input">
+A Message event to an intermediate message event can be triggert.
+
+From the config the `messagename` and the `processInstanceId` must be set.
+
+## Inputs
+
+: payload (Object) : Will sent to the event and used an new token payload.
+
+### References
+
+-   [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
+-   [Node-RED Integration in ProcessCube&copy;](https://processcube.io/docs/node-red) - Node-RED integration in ProcessCube&copy;
+    
 </script>

package/message-event-trigger.js

@@ -1,22 +1,23 @@
-const process = require('process');
-
-const engine_client = require('@5minds/processcube_engine_client');
-
 module.exports = function (RED) {
     function MessageEventTrigger(config) {
         RED.nodes.createNode(this, config);
         var node = this;
 
-        this.engine = this.server = RED.nodes.getNode(config.engine);
+        node.on('input', function (msg) {
 
-        const client = this.engine.getEngineClient();
+            const engine = RED.nodes.getNode(config.engine);
+            const client = engine.engineClient;
 
-        node.on('input', function (msg) {
-            client.events
+            if (!client) {
+                node.error('No engine configured.');
+                return;
+            }
+
+            engine.engineClient.events
                 .triggerMessageEvent(config.messagename, {
                     processInstanceId: config.processinstanceid,
                     payload: msg.payload,
-                    identity: node.server.identity,
+                    identity: engine.identity,
                 })
                 .then((result) => {
                     msg.payload = result;