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

package/processcube-engine-config.js

@@ -11,6 +11,7 @@ module.exports = function (RED) {
         const identityChangedCallbacks = [];
         this.url = n.url;
         this.identity = null;
+        
         this.registerOnIdentityChanged = function (callback) {
             identityChangedCallbacks.push(callback);
         };
@@ -23,22 +24,15 @@ module.exports = function (RED) {
             }
         };
 
-        var nodeContext = node.context();
-
-        this.getEngineClient = () => {
-            const engineUrl = this.url || process.env.ENGINE_URL || 'http://engine:8000';
-            let client = nodeContext.get('client');
-
-            if (!client) {
-                nodeContext.set('client', new engine_client.EngineClient(engineUrl));
-                client = nodeContext.get('client');
+        node.on('close', async () => {
+            if (this.engineClient) {
+                this.engineClient.dispose();
+                this.engineClient = null;
             }
-
-            return client;
-        };
+        });
 
         if (this.credentials.clientId && this.credentials.clientSecret) {
-            const engineClient = new engine_client.EngineClient(this.url);
+            this.engineClient = new engine_client.EngineClient(this.url);
 
             engineClient.applicationInfo
                 .getAuthorityAddress()
@@ -57,6 +51,8 @@ module.exports = function (RED) {
                     console.error(reason);
                     node.error(reason);
                 });
+        } else {
+            this.engineClient = new engine_client.EngineClient(this.url);
         }
     }
     RED.nodes.registerType('processcube-engine-config', ProcessCubeEngineNode, {

package/processdefinition-query.html

@@ -60,6 +60,20 @@
     </div>
 </script>
 
-<script type="text/html" data-help-name="processdefinition-query">
-    <p>A node which queries to Process Definitions of https://processcube.io</p>
+<script type="text/markdown" data-help-name="processdefinition-query">
+Query process definitions or process models from the ProcessCube engine.
+
+The `query` can be given a direkt query field from the configutation or a message property.
+
+Only models can be queried by setting the `models_only` flag.
+
+## Inputs
+
+: payload (Object | JSON) : Will be used as the input for the query or can be directly set as JSON.
+
+### 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/processdefinition-query.js

@@ -1,38 +1,27 @@
-const process = require('process');
-const EventEmitter = require('node:events');
-
-const engine_client = require('@5minds/processcube_engine_client');
-
 module.exports = function (RED) {
     function ProcessdefinitionQuery(config) {
         RED.nodes.createNode(this, config);
         var node = this;
-        var flowContext = node.context().flow;
-
-        this.engine = this.server = RED.nodes.getNode(config.engine);
-
-        const client = this.engine.getEngineClient();
 
-        var eventEmitter = flowContext.get('emitter');
+        node.on('input', function (msg) {
 
-        if (!eventEmitter) {
-            flowContext.set('emitter', new EventEmitter());
-            eventEmitter = flowContext.get('emitter');
-        }
+            const engine = RED.nodes.getNode(config.engine);
+            const client = engine.engineClient;
 
-        node.on('close', async () => {
-            client.dispose();
-            client = null;
-        });
+            if (!client) {
+                node.error('No engine configured.');
+                return;
+            }
 
-        node.on('input', function (msg) {
             let query = RED.util.evaluateNodeProperty(config.query, config.query_type, node, msg);
+            
             query = {
                 ...query,
-                identity: node.server.identity,
+                identity: engine.identity,
             };
 
             client.processDefinitions.getAll(query).then((matchingProcessDefinitions) => {
+
                 if (config.models_only && matchingProcessDefinitions.totalCount > 0) {
                     let models = [];
 

package/processes/User-Task-Sample.bpmn

@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<bpmn:definitions xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:camunda="http://camunda.org/schema/1.0/bpmn" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" id="User-Task-Sample_Definition" targetNamespace="http://bpmn.io/schema/bpmn" exporter="5Minds Studio" exporterVersion="1">
+  <bpmn:collaboration id="Collaboration_1cidyxu" name="">
+    <bpmn:participant id="Participant_0px403d" name="User-Task-Sample" processRef="User-Task-Sample_Process" />
+  </bpmn:collaboration>
+  <bpmn:process id="User-Task-Sample_Process" name="User-Task-Sample" isExecutable="true">
+    <bpmn:laneSet />
+    <bpmn:startEvent id="StartEvent_1" name="Start">
+      <bpmn:outgoing>Flow_142awo6</bpmn:outgoing>
+    </bpmn:startEvent>
+    <bpmn:sequenceFlow id="Flow_142awo6" sourceRef="StartEvent_1" targetRef="user_task" />
+    <bpmn:endEvent id="Event_07hak5r" name="End">
+      <bpmn:incoming>Flow_0i7xqvi</bpmn:incoming>
+    </bpmn:endEvent>
+    <bpmn:sequenceFlow id="Flow_0i7xqvi" sourceRef="user_task" targetRef="Event_07hak5r" />
+    <bpmn:userTask id="user_task" name="User Task">
+      <bpmn:extensionElements>
+        <camunda:formData>
+          <camunda:formField id="field_01" label="Field 01" type="string" />
+          <camunda:formField id="field_02" label="Field 02" type="string" />
+        </camunda:formData>
+      </bpmn:extensionElements>
+      <bpmn:incoming>Flow_142awo6</bpmn:incoming>
+      <bpmn:outgoing>Flow_0i7xqvi</bpmn:outgoing>
+    </bpmn:userTask>
+  </bpmn:process>
+  <bpmndi:BPMNDiagram id="BPMNDiagram_1">
+    <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="Collaboration_1cidyxu">
+      <bpmndi:BPMNShape id="Participant_0px403d_di" bpmnElement="Participant_0px403d" isHorizontal="true">
+        <dc:Bounds x="5" y="30" width="415" height="260" />
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNShape id="StartEvent_1_di" bpmnElement="StartEvent_1">
+        <dc:Bounds x="92" y="152" width="36" height="36" />
+        <bpmndi:BPMNLabel>
+          <dc:Bounds x="98" y="195" width="24" height="14" />
+        </bpmndi:BPMNLabel>
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNShape id="Event_07hak5r_di" bpmnElement="Event_07hak5r">
+        <dc:Bounds x="332" y="152" width="36" height="36" />
+        <bpmndi:BPMNLabel>
+          <dc:Bounds x="340" y="195" width="20" height="14" />
+        </bpmndi:BPMNLabel>
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNShape id="Activity_0c7im8g_di" bpmnElement="user_task">
+        <dc:Bounds x="180" y="130" width="100" height="80" />
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNEdge id="Flow_142awo6_di" bpmnElement="Flow_142awo6">
+        <di:waypoint x="128" y="170" />
+        <di:waypoint x="180" y="170" />
+      </bpmndi:BPMNEdge>
+      <bpmndi:BPMNEdge id="Flow_0i7xqvi_di" bpmnElement="Flow_0i7xqvi">
+        <di:waypoint x="280" y="170" />
+        <di:waypoint x="332" y="170" />
+      </bpmndi:BPMNEdge>
+    </bpmndi:BPMNPlane>
+  </bpmndi:BPMNDiagram>
+</bpmn:definitions>

package/processinstance-query.html

@@ -45,6 +45,17 @@
     </div>
 </script>
 
-<script type="text/html" data-help-name="processinstance-query">
-    <p>A node which queries to Process Instances of https://processcube.io</p>
+<script type="text/markdown" data-help-name="processinstance-query">
+Query a process instance in the ProcessCube.
+
+## Inputs
+
+: payload (Object | JSON) : Will be used as the input for the query or can be directly set as JSON.
+
+### 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/processinstance-query.js

@@ -1,35 +1,21 @@
-const process = require('process');
-const EventEmitter = require('node:events');
-
-const engine_client = require('@5minds/processcube_engine_client');
-
 module.exports = function (RED) {
     function ProcessinstanceQuery(config) {
         RED.nodes.createNode(this, config);
         var node = this;
-        var flowContext = node.context().flow;
-
-        this.engine = this.server = RED.nodes.getNode(config.engine);
-
-        const client = this.engine.getEngineClient();
-
-        var eventEmitter = flowContext.get('emitter');
-
-        if (!eventEmitter) {
-            flowContext.set('emitter', new EventEmitter());
-            eventEmitter = flowContext.get('emitter');
-        }
-
-        node.on('close', async () => {
-            client.dispose();
-            client = null;
-        });
 
         node.on('input', function (msg) {
             let query = RED.util.evaluateNodeProperty(config.query, config.query_type, node, msg);
 
+            const engine =  RED.nodes.getNode(config.engine);
+            const client = engine.engineClient;
+
+            if (!client) {
+                node.error('No engine configured.');
+                return;
+            }
+
             client.processInstances
-                .query(query, { identity: node.server.identity })
+                .query(query, { identity: engine.identity })
                 .then((matchingInstances) => {
                     msg.payload = matchingInstances;
 

package/signal-event-trigger.html

@@ -36,6 +36,18 @@
     </div>
 </script>
 
-<script type="text/html" data-help-name="signal-event-trigger">
-    <p>A node which emmits a signal event to the Engine.</p>
+<script type="text/markdown" data-help-name="signal-event-trigger">
+A node which emmits a signal event to the Engine.
+
+From the config the `signalname` 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/signal-event-trigger.js

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

package/usertask-finished-listener.html

@@ -25,20 +25,21 @@
         <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" style="display:flex; margin-bottom: 3px;">
-        <label for="node-input-multisend" style="vertical-align:top"><i class="fa fa-list-alt"></i> Send multi</label>
-        <div>
-            <input
-                type="checkbox"
-                checked
-                id="node-input-multisend"
-                style="display: inline-block; width: auto; margin: 0px 0px 0px 4px;"
-            />
-            <label style="width:auto" for="node-input-multisend">Send one output of each usertask input?</label>
-        </div>
-    </div>
 </script>
 
-<script type="text/html" data-help-name="usertask-finished-listener">
-    <p>A node which subscribes to an User Task of https://processcube.io</p>
+<script type="text/markdown" data-help-name="usertask-finished-listener">
+A node which listens for finished usertasks in the ProcessCube.
+
+## Outputs
+
+: flowNodeInstanceId (string): The flow node instance id of the finished usertask.
+: userTaskEvent (object): The user task event object.
+: action (string): The action of the event.
+: type (string): The type of the event.
+
+### 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/usertask-finished-listener.js

@@ -1,32 +1,25 @@
-const process = require('process');
-const EventEmitter = require('node:events');
-
-const engine_client = require('@5minds/processcube_engine_client');
-
 module.exports = function (RED) {
     function UserTaskFinishedListener(config) {
         RED.nodes.createNode(this, config);
         var node = this;
-        var flowContext = node.context().flow;
-
-        this.engine = this.server = RED.nodes.getNode(config.engine);
-
-        const client = this.engine.getEngineClient();
+        node.engine = RED.nodes.getNode(config.engine);
 
-        var eventEmitter = flowContext.get('emitter');
+        const register = async () => {
+            let currentIdentity = node.engine.identity;
 
-        if (!eventEmitter) {
-            flowContext.set('emitter', new EventEmitter());
-            eventEmitter = flowContext.get('emitter');
-        }
+            const client = node.engine.engineClient;
+    
+            if (!client) {
+                node.error('No engine configured.');
+                return;
+            }
 
-        const register = async () => {
-            let currentIdentity = node.server.identity;
             let subscription = await client.userTasks.onUserTaskFinished(
                 (userTaskFinishedNotification) => {
                     node.send({
                         payload: {
                             flowNodeInstanceId: userTaskFinishedNotification.flowNodeInstanceId,
+                            userTaskEvent: userTaskFinishedNotification,
                             action: 'finished',
                             type: 'usertask',
                         },
@@ -35,7 +28,7 @@ module.exports = function (RED) {
                 { identity: currentIdentity },
             );
 
-            node.server.registerOnIdentityChanged(async (identity) => {
+            node.engine.registerOnIdentityChanged(async (identity) => {
                 client.userTasks.removeSubscription(subscription, currentIdentity);
                 currentIdentity = identity;
 
@@ -44,6 +37,7 @@ module.exports = function (RED) {
                         node.send({
                             payload: {
                                 flowNodeInstanceId: userTaskFinishedNotification.flowNodeInstanceId,
+                                userTaskEvent: userTaskFinishedNotification,
                                 action: 'finished',
                                 type: 'usertask',
                             },
@@ -54,13 +48,13 @@ module.exports = function (RED) {
             });
 
             node.on('close', async () => {
-                client.userTasks.removeSubscription(subscription, currentIdentity);
-                client.dispose();
-                client = null;
+                if (node.engine && node.engine.engineClient && client) {
+                    client.userTasks.removeSubscription(subscription, currentIdentity);
+                }
             });
         };
 
-        if (node.server) {
+        if (node.engine) {
             register();
         }
     }

package/usertask-input.html

@@ -75,6 +75,19 @@
     </div>
 </script>
 
-<script type="text/html" data-help-name="usertask-input">
-    <p>A node which subscribes to an User Task of https://processcube.io</p>
+<script type="text/markdown" data-help-name="usertask-input">
+A node which sends a payload to a usertask in the ProcessCube.
+
+## Inputs
+
+: payload (Object) : Will be used as the input for the usertask.
+: query (String) : Will be used as the query for the usertask.
+: query_type (String) : Will be used as the type of the query for the usertask.
+: force_send_array (Boolean) : Will be used to force the payload to be sent as an array.
+: multisend (Boolean) : Will be used to send one output of each usertask input.
+
+### 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/usertask-input.js

@@ -1,53 +1,26 @@
-const process = require('process');
-const EventEmitter = require('node:events');
-
-const engine_client = require('@5minds/processcube_engine_client');
-
-function showStatus(node, msgCounter) {
-    if (msgCounter >= 1) {
-        node.status({
-            fill: 'blue',
-            shape: 'dot',
-            text: `handling tasks ${msgCounter}`,
-        });
-    } else {
-        node.status({
-            fill: 'blue',
-            shape: 'ring',
-            text: `subcribed ${msgCounter}`,
-        });
-    }
-}
-
 module.exports = function (RED) {
     function UserTaskInput(config) {
         RED.nodes.createNode(this, config);
         var node = this;
-        var msgCounter = 0;
-        var flowContext = node.context().flow;
 
-        this.engine = this.server = RED.nodes.getNode(config.engine);
-
-        const client = this.engine.getEngineClient();
+        node.on('input', function (msg) {
 
-        var eventEmitter = flowContext.get('emitter');
+            const engine = RED.nodes.getNode(config.engine);
 
-        if (!eventEmitter) {
-            flowContext.set('emitter', new EventEmitter());
-            eventEmitter = flowContext.get('emitter');
-        }
+            const client = engine.engineClient;
 
-        node.on('close', async () => {
-            client.dispose();
-            client = null;
-        });
+            if (!client) {
+                node.error('No engine configured.');
+                return;
+            }
 
-        node.on('input', function (msg) {
             let query = RED.util.evaluateNodeProperty(config.query, config.query_type, node, msg);
+
             query = {
                 ...query,
-                identity: node.server.identity,
+                identity: engine.identity,
             };
+
             client.userTasks.query(query).then((matchingFlowNodes) => {
                 if (
                     !config.force_send_array &&
@@ -67,10 +40,14 @@ module.exports = function (RED) {
                                 node.send(msg);
                             });
                         } else {
-                            msg.payload = {
-                                userTasks: matchingFlowNodes.userTasks,
-                            };
-                            node.send(msg);
+                            if (matchingFlowNodes.userTasks == 1) {
+                                msg.payload = {
+                                    userTasks: matchingFlowNodes.userTasks,
+                                };
+                                node.send(msg);    
+                            } else {
+                                node.log(`No user tasks found for query: ${JSON.stringify(query)}`); 
+                            }
                         }
                     } else {
                         msg.payload = {

package/usertask-new-listener.html

@@ -25,20 +25,21 @@
         <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" style="display:flex; margin-bottom: 3px;">
-        <label for="node-input-multisend" style="vertical-align:top"><i class="fa fa-list-alt"></i> Send multi</label>
-        <div>
-            <input
-                type="checkbox"
-                checked
-                id="node-input-multisend"
-                style="display: inline-block; width: auto; margin: 0px 0px 0px 4px;"
-            />
-            <label style="width:auto" for="node-input-multisend">Send one output of each usertask input?</label>
-        </div>
-    </div>
 </script>
 
-<script type="text/html" data-help-name="usertask-new-listener">
-    <p>A node which subscribes to an User Task of https://processcube.io</p>
+<script type="text/markdown" data-help-name="usertask-new-listener">
+A node which listens for new usertasks in the ProcessCube.
+
+## Outputs
+
+: flowNodeInstanceId (string): The flow node instance id of the new usertask.
+: userTaskEvent (string) : The user task event object.
+: action (string) : The action of the event.
+: type (string) : The type of the event.
+
+### 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/usertask-new-listener.js

@@ -1,33 +1,26 @@
-const process = require('process');
-const EventEmitter = require('node:events');
-
-const engine_client = require('@5minds/processcube_engine_client');
-
 module.exports = function (RED) {
     function UserTaskNewListener(config) {
         RED.nodes.createNode(this, config);
         var node = this;
-        var flowContext = node.context().flow;
-
-        this.engine = this.server = RED.nodes.getNode(config.engine);
-
-        const client = this.engine.getEngineClient();
+        node.engine = RED.nodes.getNode(config.engine);
 
-        var eventEmitter = flowContext.get('emitter');
+        const register = async () => {
+            const client = node.engine.engineClient;
 
-        if (!eventEmitter) {
-            flowContext.set('emitter', new EventEmitter());
-            eventEmitter = flowContext.get('emitter');
-        }
+            if (!client) {
+                node.error('No engine configured.');
+                return;
+            }
+                
+            let currentIdentity = node.engine.identity;
 
-        const register = async () => {
-            let currentIdentity = node.server.identity;
             let subscription = await client.userTasks.onUserTaskWaiting(
                 (userTaskWaitingNotification) => {
                     node.send({
                         payload: {
                             flowNodeInstanceId: userTaskWaitingNotification.flowNodeInstanceId,
-                            action: 'new',
+                            userTaskEvent: userTaskWaitingNotification,
+                            action: 'new',  
                             type: 'usertask',
                         },
                     });
@@ -35,7 +28,7 @@ module.exports = function (RED) {
                 { identity: currentIdentity },
             );
 
-            node.server.registerOnIdentityChanged(async (identity) => {
+            node.engine.registerOnIdentityChanged(async (identity) => {
                 client.userTasks.removeSubscription(subscription, currentIdentity);
                 currentIdentity = identity;
 
@@ -44,6 +37,7 @@ module.exports = function (RED) {
                         node.send({
                             payload: {
                                 flowNodeInstanceId: userTaskWaitingNotification.flowNodeInstanceId,
+                                userTaskEvent: userTaskWaitingNotification,
                                 action: 'new',
                                 type: 'usertask',
                             },
@@ -53,14 +47,14 @@ module.exports = function (RED) {
                 );
             });
 
-            node.on('close', async () => {
-                client.userTasks.removeSubscription(subscription, currentIdentity);
-                client.dispose();
-                client = null;
+            node.on('close', () => {
+                if (node.engine && node.engine.engineClient && client) {
+                    client.userTasks.removeSubscription(subscription, currentIdentity);
+                }
             });
         };
 
-        if (node.server) {
+        if (node.engine) {
             register();
         }
     }

package/usertask-output.html

@@ -45,6 +45,17 @@
     </div>
 </script>
 
-<script type="text/html" data-help-name="usertask-output">
-    <p>A node which send the result to an User Task of https://processcube.io</p>
+<script type="text/markdown" data-help-name="usertask-output">
+A node which sends the result of a usertask to the ProcessCube.
+
+## Inputs
+
+: payload (Object | JSON) : Will be used as the result for the usertask or can be directly set as JSON.
+: payload.usertask.flowNodeInstanceId (String) : The flowNodeInstanceId of the usertask that will be finished.
+
+### 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>