@5minds/node-red-contrib-processcube 0.14.0-feature-ef048b-lyy1ngi6 → 0.14.0-feature-7cec87-lyytfjz9

package/docker-compose.yml

@@ -5,6 +5,7 @@ services:
       context: .
     ports:
       - "1880:1880"
+      - "9229:9229"
     environment:
       - TZ=Europe/Berlin
       - ENGINE_URL=http://engine:8000

package/externaltask-error.html

@@ -26,6 +26,20 @@
     </div>
 </script>
 
-<script type="text/html" data-help-name="externaltask-error">
-    <p>A node which error response to an External Task of https://processcube.io</p>
+<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*.
+
+## 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
+
+### 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/externaltask-error.js

@@ -16,15 +16,12 @@ module.exports = function(RED) {
                 msgError.message = "An error occurred";
             }
 
+            const error = new Error(msgError.message);
+            error.errorCode = config.error;
+            error.errorDetails = RED.util.encodeObject(msg);
+
             msg.errorCode = config.error;
             msg.errorMessage = msgError.message;
-            //msg.errorDetails = RED.util.encodeObject(msg); // circular structure
-
-            const error = new Error(msg.errorMessage);
-            error.errorCode = config.error;
-            
-            // TODO: hack cause https://github.com/5minds/ProcessCube.Engine.Client.ts/blob/develop/src/ExternalTaskWorker.ts#L180
-            error.stack = RED.util.encodeObject(msg); 
 
             eventEmitter.emit(`handle-${flowNodeInstanceId}`, error, true);
             

package/externaltask-input.html

@@ -31,6 +31,23 @@
     </div>
 </script>
 
-<script type="text/html" data-help-name="externaltask-input">
-    <p>A node which subscribes to an External Task Topic of https://processcube.io</p>
+<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.
+
+## 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
+
+### 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.
+
+### 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/externaltask-input.js

@@ -117,8 +117,6 @@ module.exports = function(RED) {
                         case 'processExternalTask':
                             node.error(`Worker error ${errorType} for *external task flowNodeInstanceId* '${externalTask.flowNodeInstanceId}' and *processInstanceId* '${externalTask.processInstanceId}': ${error.message}`);
                     
-                            externalTaskWorker.stop();
-
                             if (externalTask) {
                                 delete started_external_tasks[externalTask.flowNodeInstanceId];
                             }
@@ -141,11 +139,11 @@ module.exports = function(RED) {
                     try {
                         externalTaskWorker.stop();
                     } catch {
-                        console.warn('Client close failed');
+                        node.error('Client close failed');
                     }
                 });
             }
-        ).error((error) => {
+        ).catch((error) => {
             node.error(`Error in subscribeToExternalTaskTopic: ${error.message}`);
         });
     }

package/externaltask-output.html

@@ -21,6 +21,16 @@
     </div>
 </script>
 
-<script type="text/html" data-help-name="externaltask-output">
-    <p>A node which response to an External Task of https://processcube.io</p>
+<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.
+
+## Inputs
+
+: payload (Object) : Returned to the ProcessCube engine as the result of the external task
+
+### 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/nodered/node-red-contrib-processcube-flows.json

@@ -1,4 +1,12 @@
 [
+    {
+        "id": "3f916448523ed12b",
+        "type": "tab",
+        "label": "Node-Inspector",
+        "disabled": false,
+        "info": "",
+        "env": []
+    },
     {
         "id": "a23d2e782beb66f4",
         "type": "tab",
@@ -130,11 +138,112 @@
         "w": 812,
         "h": 202
     },
+    {
+        "id": "dd43902998ad7630",
+        "type": "group",
+        "z": "3f916448523ed12b",
+        "style": {
+            "stroke": "#999999",
+            "stroke-opacity": "1",
+            "fill": "none",
+            "fill-opacity": "1",
+            "label": true,
+            "label-position": "nw",
+            "color": "#a4a4a4"
+        },
+        "nodes": [
+            "3add02d7.7df60e",
+            "8cf9f9cd.1a6a88",
+            "4b2a8ca1.de70e4",
+            "97dbbfedba44a728"
+        ],
+        "x": 34,
+        "y": 59,
+        "w": 712,
+        "h": 202
+    },
     {
         "id": "42e6796dddd9d4db",
         "type": "processcube-engine-config",
         "url": "http://engine:8000"
     },
+    {
+        "id": "3add02d7.7df60e",
+        "type": "node-inspector",
+        "z": "3f916448523ed12b",
+        "g": "dd43902998ad7630",
+        "inputField": "payload",
+        "host": "0.0.0.0",
+        "portNumber": 9229,
+        "autoStart": false,
+        "name": "",
+        "x": 400,
+        "y": 160,
+        "wires": []
+    },
+    {
+        "id": "8cf9f9cd.1a6a88",
+        "type": "inject",
+        "z": "3f916448523ed12b",
+        "g": "dd43902998ad7630",
+        "name": "",
+        "props": [
+            {
+                "p": "payload"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "payload": "open_inspector",
+        "payloadType": "str",
+        "x": 160,
+        "y": 160,
+        "wires": [
+            [
+                "3add02d7.7df60e"
+            ]
+        ]
+    },
+    {
+        "id": "4b2a8ca1.de70e4",
+        "type": "inject",
+        "z": "3f916448523ed12b",
+        "g": "dd43902998ad7630",
+        "name": "",
+        "props": [
+            {
+                "p": "payload"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "payload": "close_inspector",
+        "payloadType": "str",
+        "x": 160,
+        "y": 220,
+        "wires": [
+            [
+                "3add02d7.7df60e"
+            ]
+        ]
+    },
+    {
+        "id": "97dbbfedba44a728",
+        "type": "comment",
+        "z": "3f916448523ed12b",
+        "g": "dd43902998ad7630",
+        "name": "Start Node-Inspector on Port 9229 - be sure, that you expose the port from the docker-container",
+        "info": "",
+        "x": 390,
+        "y": 100,
+        "wires": []
+    },
     {
         "id": "2991a5e6df2b87d2",
         "type": "externaltask-input",
@@ -210,7 +319,7 @@
         "g": "31cb6729aac0ba46",
         "name": "",
         "pauseType": "delay",
-        "timeout": "15",
+        "timeout": "5",
         "timeoutUnits": "seconds",
         "rate": "1",
         "nbRateUnits": "1",
@@ -221,7 +330,7 @@
         "drop": false,
         "allowrate": false,
         "outputs": 1,
-        "x": 330,
+        "x": 320,
         "y": 360,
         "wires": [
             [

package/nodered/package.json

@@ -8,6 +8,7 @@
     "@5minds/node-red-dashboard-2-processcube-usertask-table": "^1.0.7",
     "@flowfuse/node-red-dashboard": "^1.11.1",
     "node-red": "^3.1.10",
+    "node-red-contrib-inspector": "~1.0.1",
     "node-red-debugger": "^1.1.1",
     "openapi-red": "^1.2.5"
   }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@5minds/node-red-contrib-processcube",
-    "version": "0.14.0-feature-ef048b-lyy1ngi6",
+    "version": "0.14.0-feature-7cec87-lyytfjz9",
     "license": "MIT",
     "description": "Node-RED nodes for ProcessCube",
     "authors": [
@@ -48,7 +48,7 @@
         }
     },
     "dependencies": {
-        "@5minds/processcube_engine_client": "^5.0.0",
+        "@5minds/processcube_engine_client": "5.0.0-hotfix-d834af-lyymqumd",
         "jwt-decode": "^4.0.0",
         "openid-client": "^5.5.0"
     },

package/processes/External-Task-Sample.bpmn

@@ -35,7 +35,7 @@
       <bpmn:errorEventDefinition id="ErrorEventDefinition_1lr8fha" errorRef="Error_3O8wBFQi" />
     </bpmn:boundaryEvent>
   </bpmn:process>
-  <bpmn:error id="Error_3O8wBFQi" errorCode="ExternalTaskWorkerError" />
+  <bpmn:error id="Error_3O8wBFQi" errorCode="MyErrorCode" />
   <bpmndi:BPMNDiagram id="BPMNDiagram_1">
     <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="Collaboration_1cidyxu">
       <bpmndi:BPMNShape id="Participant_0px403d_di" bpmnElement="Participant_0px403d" isHorizontal="true">
@@ -81,14 +81,14 @@
         <di:waypoint x="410" y="290" />
         <di:waypoint x="482" y="290" />
       </bpmndi:BPMNEdge>
-      <bpmndi:BPMNEdge id="Association_0ivfgz1_di" bpmnElement="Association_0ivfgz1">
-        <di:waypoint x="401" y="130" />
-        <di:waypoint x="413" y="90" />
-      </bpmndi:BPMNEdge>
       <bpmndi:BPMNShape id="TextAnnotation_0lbjt7p_di" bpmnElement="TextAnnotation_0lbjt7p">
         <dc:Bounds x="370" y="50" width="169.99387960829492" height="39.99855990783411" />
         <bpmndi:BPMNLabel />
       </bpmndi:BPMNShape>
+      <bpmndi:BPMNEdge id="Association_0ivfgz1_di" bpmnElement="Association_0ivfgz1">
+        <di:waypoint x="401" y="130" />
+        <di:waypoint x="413" y="90" />
+      </bpmndi:BPMNEdge>
     </bpmndi:BPMNPlane>
   </bpmndi:BPMNDiagram>
 </bpmn:definitions>